Unknown converter name is silently accepted and later fails with "undefined method 'arity' for nil"

Offen
#386 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Anfängerfreundlichkeit
57/100
Issue-Typ
Bug
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Tech-Stack
ruby
Bereich
backend

Rechercherichtung

Start with lib/csv/fields_converter.rb, especially FieldsConverter#add_converter, where named converters are looked up and added. Add coverage for unknown names passed through CSV#convert, converters:, and header_converters:, then update the documented behavior of CSV#convert and CSV#header_convert; done means invalid names raise a clear ArgumentError when added and the relevant tests pass.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

When an unknown converter name is passed to converters: / header_converters: (or to CSV#convert / CSV#header_convert), csv accepts it silently and stores nil as the converter. The mistake only shows up later, when the first field is converted, as:

NoMethodError: undefined method 'arity' for nil

The message does not mention converters at all, so it is hard to tell that the cause is a typo in a converter name, or a name that only exists in a newer csv. For example, header_converters: :symbol_raw (added in csv 3.2.3) fails this way on Ruby 3.1.0 (csv 3.2.2).

The current behavior is documented in the RDoc of CSV#convert and CSV#header_convert ("Raises a parse-time exception ... NoMethodError"), so this may be known. I'd still like to propose a clearer error.

Reproduction

require "csv"

data = "A,B\n1,2\n"

csv = CSV.new(data, headers: true, header_converters: :bogus) # no error here
p csv.header_converters # => [nil]
csv.read                # => NoMethodError: undefined method 'arity' for nil

CSV.parse_line("1,2", converters: [:integer, :bogus])
# => NoMethodError: undefined method 'arity' for nil

csv = CSV.new(data)
p csv.convert(:bogus)   # => [nil]
csv.read                # => NoMethodError: undefined method 'arity' for nil

# String names are not accepted either (only Symbol keys match):
CSV.parse_line("1,2", converters: "integer")
# => NoMethodError: undefined method 'arity' for nil

# With no data rows, the bad name is never noticed:
CSV.parse("", headers: true, header_converters: :bogus) # => #<CSV::Table ...>

Versions

The same result on every version I tried:

Ruby csv CSV.new(..., header_converters: :bogus) #header_converters read
3.0.0 3.1.9 no error [nil] NoMethodError (arity for nil)
3.1.0 3.2.2 no error [nil] NoMethodError
3.2.0 3.2.6 no error [nil] NoMethodError
3.4.0 3.3.2 no error [nil] NoMethodError
4.0.0 3.3.5 no error [nil] NoMethodError
master (4.1.0dev) 3.3.7 no error [nil] NoMethodError
master (4.1.0dev) main (afbee5e) no error [nil] NoMethodError

converters: :bogus, [:downcase, :bogus], "downcase", CSV#convert(:bogus), CSV#header_convert(:bogus), String#parse_csv(converters: :bogus) and CSV.parse_line all behave the same way.

Cause

CSV::FieldsConverter#add_converter looks the name up in CSV::Converters / CSV::HeaderConverters and appends the result without checking it, so an unknown name appends nil:

https://github.com/ruby/csv/blob/v3.3.7/lib/csv/fields_converter.rb#L34-L42

The nil is only used when a field is converted:

https://github.com/ruby/csv/blob/v3.3.7/lib/csv/fields_converter.rb#L65

Expected (proposal)

How about raising ArgumentError with the name when the converter is added? For example:

ArgumentError: unknown converter name: :bogus (not in CSV::HeaderConverters)

Since the converters given by the converters: / header_converters: options are already built in CSV.new, this would make CSV.new (and CSV#convert / CSV#header_convert) fail right away, and the message points at the problem.

One compatibility note: code that passes an unknown name but never converts a field (e.g. empty input) currently works and would start raising. I think that is acceptable because such code is already broken for any non-empty input, but I'd like to hear your opinion.

Possible fix

diff --git a/lib/csv/fields_converter.rb b/lib/csv/fields_converter.rb
--- a/lib/csv/fields_converter.rb
+++ b/lib/csv/fields_converter.rb
@@ -37,6 +37,10 @@ class CSV
           combo.each do |sub_name|
             add_converter(sub_name)
           end
+        when nil
+          message = "unknown converter name: #{name.inspect} " +
+                    "(not in CSV::#{@builtin_converters_name})"
+          raise ArgumentError, message
         else        # individual named converter
           @converters << combo
         end

plus tests for CSV#convert(:nosuch), converters: [:integer, :nosuch] and header_converters: :nosuch, and an update of the RDoc of CSV#convert / CSV#header_convert. With this change the whole test suite passes on Ruby master. I can open a pull request if this direction is OK.

🤖 Generated with Claude Code

Vorherrschende Sprache
Ruby
Sterne
220
Forks
139
Ø Merge
1 T. 1 Std.
Gemergte PRs (30 T.)
2

Entwicklungsumgebung

Dieses Projekt bietet weder Dev-Container noch Dockerfile noch Beitragsleitfaden – die Einrichtung liegt bei Ihnen. Beginnen Sie mit der README; die allgemeinen Schritte stehen in unserem Leitfaden für den ersten Beitrag.

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus ruby/csv

Alle Issues in ruby/csv

Ähnliche Issues

Weitere Issues zu Ruby

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.