Skip to content

Add MissingKeys#keys #314

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tilo merged 2 commits into from
Feb 3, 2026
Merged

Add MissingKeys#keys #314

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5f9c10c
Add MissingKeys#keys
sshaw Jan 10, 2026
a00c370
Apply suggestions from code review
tilo Feb 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion lib/smarter_csv/errors.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,16 @@ class HeaderSizeMismatch < SmarterCSVException; end
class IncorrectOption < SmarterCSVException; end
class ValidationError < SmarterCSVException; end
class DuplicateHeaders < SmarterCSVException; end
class MissingKeys < SmarterCSVException; end # previously known as MissingHeaders

class MissingKeys < SmarterCSVException # previously known as MissingHeaders
attr_reader :keys

def initialize(message, keys = [])
super(message)
@keys = keys
end
end

class NoColSepDetected < SmarterCSVException; end
class KeyMappingError < SmarterCSVException; end
class MalformedCSV < SmarterCSVException; end
Expand Down
2 changes: 1 addition & 1 deletion lib/smarter_csv/header_validations.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ def check_required_headers(headers, options)
missing_keys = options[:required_keys].select { |k| !headers_set.include?(k) }

unless missing_keys.empty?
raise SmarterCSV::MissingKeys, "ERROR: missing attributes: #{missing_keys.join(',')}. Check `reader.headers` for original headers."
raise SmarterCSV::MissingKeys.new("ERROR: missing attributes: #{missing_keys.join(',')}. Check `reader.headers` for original headers.", missing_keys)
end
end
end
Expand Down
8 changes: 6 additions & 2 deletions spec/features/header_handling/invalid_headers_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,9 @@
SmarterCSV.process("#{fixture_path}/user_import.csv", options)
end.to raise_exception(
SmarterCSV::MissingKeys, "ERROR: missing attributes: employee_id. Check `reader.headers` for original headers."
)
) do |error|
expect(error.keys).to eq %i[employee_id]
Copy link
Copy Markdown
Contributor Author

@sshaw sshaw Jan 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could add to its own test

end
end

it 'raises error on missing mapped headers' do
Expand All @@ -45,7 +47,9 @@
SmarterCSV.process("#{fixture_path}/user_import.csv", options)
end.to raise_exception(
SmarterCSV::MissingKeys, /ERROR: missing attributes: email/ # it was mapped, and is now missing
)
) do |error|
expect(error.keys).to eq %i[email]
end
end
end

Expand Down
Loading