csv 3.3.5 → 3.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f77fe04292e17f436f9c5838bb3cbd6aa4297b807478c127321323fc4ad27c28
-  data.tar.gz: 63ecf6ce80dcfa3b7eb24d0f3947455eb223d1c44a32b58b4d084b29efad8961
+  metadata.gz: d2a1d74b0246a143f03c2e786ea5484cb3e5aebe370453141a9d69539eae900b
+  data.tar.gz: d8bb00a2e6842e28ca6b443e416f8f03186b098dcc81fde6ba5429eed138a755
 SHA512:
-  metadata.gz: f9ffbf24700b4ab0eb35a2cb8086e82e36825558c14b646ae00374cb3e80f7195ebb3c9ac08d11b011ffa0cc10ae607a79e24d68b793b54c50d2dd1e8bd5ec16
-  data.tar.gz: 628a0b0c0963d69686845172d84fbbdf1cebb9fc6839e052054f9e7c112bbcb96743a63e8cf5d1a6df8a9299f03ab3b8d81a9b814fb6d0f222e444b9f0282a5d
+  metadata.gz: 3d26ab99eb2708d787022832ca171def6ef4647183667be03831d9a91c5320545146adac9e5471e92637e6e905c27c06499739fc5e510541c026c15388b9e316
+  data.tar.gz: f8e7b076653e2e3f04503db617e94f14c66064aa1a8ff790a342c018eb6c598eb84127b0818e0ed8f2688ec6404b163c80e6c58cbf7d3c9411583ad8cd2cd0bd

data/NEWS.md

@@ -1,5 +1,43 @@
 # News
 
+## 3.3.6 - 2026-07-27
+
+### Improvements
+
+  * `CSV::Row#to_h`: Added support for block.
+    * GH-356
+    * Patch by Vlad
+
+  * Ensured using `path_or_io` for parameter name that accepts path or
+    IO.
+    * GH-358
+    * Patch by Yuto Urushima
+
+  * Changed to not using enumerator in `CSV`.
+    * GH-361
+    * GH-363
+    * Reported by Cas Donoghue
+
+### Fixes
+
+  * Fixed a bug that `\r` in unquoted fields are rejected when row
+    separator doesn't contain `\r`
+    * GH-60
+    * GH-346
+    * Patch by Jas
+
+  * Fixed a typo in documentation.
+    * GH-350
+    * Patch by tmr111116
+
+### Thanks
+
+  * Jas
+  * tmr111116
+  * Vlad
+  * Yuto Urushima
+  * Cas Donoghue
+
 ## 3.3.5 - 2025-06-01
 
 ### Improvements
@@ -10,7 +48,7 @@
 
 ### Thanks
 
-  *  Petrik de Heus
+  * Petrik de Heus
 
 ## 3.3.4 - 2025-04-13
 

data/README.md

@@ -52,4 +52,4 @@ Please do not submit issues and PRs that aim to introduce RuboCop in this reposi
 
 The gem is available as open source under the terms of the [2-Clause BSD License](https://opensource.org/licenses/BSD-2-Clause).
 
-See LICENSE.txt for details.
+See [LICENSE.txt](LICENSE.txt) for details.

data/lib/csv/parser.rb

@@ -181,7 +181,7 @@ class CSV
       end
 
       def eos?
-        @scanner.eos?
+        @last_scanner and @scanner.eos?
       end
 
       def keep_start
@@ -444,6 +444,11 @@ class CSV
       end
     end
 
+    def eof?
+      return false if @scanner.nil?
+      @scanner.eos?
+    end
+
     def use_headers?
       @use_headers
     end
@@ -675,7 +680,7 @@ class CSV
     def prepare_unquoted
       return if @quote_character.nil?
 
-      no_unquoted_values = "\r\n".encode(@encoding)
+      no_unquoted_values = Regexp.escape(@row_separator).encode(@encoding)
       no_unquoted_values << @escaped_first_column_separator
       unless @liberal_parsing
         no_unquoted_values << @escaped_quote_character

data/lib/csv/row.rb

@@ -637,6 +637,7 @@ class CSV
 
     # :call-seq:
     #   row.to_h -> hash
+    #   row.to_h {|key, value| ... } -> hash
     #
     # Returns the new \Hash formed by adding each header-value pair in +self+
     # as a key-value pair in the \Hash.
@@ -650,11 +651,34 @@ class CSV
     #   table = CSV.parse(source, headers: true)
     #   row = table[0]
     #   row.to_h # => {"Name"=>"Foo"}
+    #
+    # If a block is given, will call it with (key, value) arguments and use result as a hash entry:
+    #   source = "Name,Value\nfoo,1\nbar,2\nbaz,3\n"
+    #   table = CSV.parse(source, headers: true)
+    #   row = table[0]
+    #   row.to_h { |key, value| [key, "#{key}-#{value}"] } # => {"Name"=>"Name-foo", "Value"=>"Value-1"}
     def to_h
       hash = {}
-      each do |key, _value|
-        hash[key] = self[key] unless hash.key?(key)
+
+      if block_given?
+        each do |key, _value|
+          result = yield(key, self[key])
+          result_array = Array.try_convert(result)
+          raise TypeError, "wrong element type #{result.class} (expected array)" if result_array.nil?
+          raise ArgumentError, "wrong array length (expected 2, was #{result_array.size})" unless result_array.size == 2
+
+          key, value = result_array
+          next if hash.key?(key)
+
+          key.freeze if key.is_a?(String) && !key.frozen?
+          hash[key] = value
+        end
+      else
+        each do |key, _value|
+          hash[key] = self[key] unless hash.key?(key)
+        end
       end
+
       hash
     end
     alias_method :to_hash, :to_h

data/lib/csv/version.rb

@@ -2,5 +2,5 @@
 
 class CSV
   # The version of the installed library.
-  VERSION = "3.3.5"
+  VERSION = "3.3.6"
 end

data/lib/csv.rb

@@ -1377,7 +1377,7 @@ class CSV
     # * Arguments <tt>**options</tt> must be keyword options.
     #   See {Options for Parsing}[#class-CSV-label-Options+for+Parsing].
     # * This method optionally accepts an additional <tt>:encoding</tt> option
-    #   that you can use to specify the Encoding of the data read from +path+ or +io+.
+    #   that you can use to specify the Encoding of the data read from +path_or_io+.
     #   You must provide this unless your data is in the encoding
     #   given by <tt>Encoding::default_external</tt>.
     #   Parsing will use this to determine how to parse the data.
@@ -1386,9 +1386,9 @@ class CSV
     #     encoding: 'UTF-32BE:UTF-8'
     #   would read +UTF-32BE+ data from the file
     #   but transcode it to +UTF-8+ before parsing.
-    def foreach(path, mode="r", **options, &block)
-      return to_enum(__method__, path, mode, **options) unless block_given?
-      open(path, mode, **options) do |csv|
+    def foreach(path_or_io, mode="r", **options, &block)
+      return to_enum(__method__, path_or_io, mode, **options) unless block_given?
+      open(path_or_io, mode, **options) do |csv|
         csv.each(&block)
       end
     end
@@ -1582,7 +1582,7 @@ class CSV
     # * Arguments <tt>**options</tt> must be keyword options.
     #   See {Options for Generating}[#class-CSV-label-Options+for+Generating].
     # * This method optionally accepts an additional <tt>:encoding</tt> option
-    #   that you can use to specify the Encoding of the data read from +path+ or +io+.
+    #   that you can use to specify the Encoding of the data read from +path_or_io+.
     #   You must provide this unless your data is in the encoding
     #   given by <tt>Encoding::default_external</tt>.
     #   Parsing will use this to determine how to parse the data.
@@ -1644,11 +1644,11 @@ class CSV
     # Raises an exception if the argument is not a \String object or \IO object:
     #   # Raises TypeError (no implicit conversion of Symbol into String)
     #   CSV.open(:foo)
-    def open(filename_or_io, mode="r", **options)
+    def open(path_or_io, mode="r", **options)
       # wrap a File opened with the remaining +args+ with no newline
       # decorator
       file_opts = {}
-      may_enable_bom_detection_automatically(filename_or_io,
+      may_enable_bom_detection_automatically(path_or_io,
                                              mode,
                                              options,
                                              file_opts)
@@ -1661,11 +1661,11 @@ class CSV
       options.delete(:replace)
       options.delete_if {|k, _| /newline\z/.match?(k)}
 
-      if filename_or_io.is_a?(StringIO)
-        f = create_stringio(filename_or_io.string, mode, **file_opts)
+      if path_or_io.is_a?(StringIO)
+        f = create_stringio(path_or_io.string, mode, **file_opts)
       else
         begin
-          f = File.open(filename_or_io, mode, **file_opts)
+          f = File.open(path_or_io, mode, **file_opts)
         rescue ArgumentError => e
           raise unless /needs binmode/.match?(e.message) and mode == "r"
           mode = "rb"
@@ -1901,10 +1901,10 @@ class CSV
 
     #
     # :call-seq:
-    #   read(source, **options) -> array_of_arrays
-    #   read(source, headers: true, **options) -> csv_table
+    #   read(path_or_io, **options) -> array_of_arrays
+    #   read(path_or_io, headers: true, **options) -> csv_table
     #
-    # Opens the given +source+ with the given +options+ (see CSV.open),
+    # Opens the given +path_or_io+ with the given +options+ (see CSV.open),
     # reads the source (see CSV#read), and returns the result,
     # which will be either an \Array of Arrays or a CSV::Table.
     #
@@ -1919,22 +1919,22 @@ class CSV
     #   path = 't.csv'
     #   File.write(path, string)
     #   CSV.read(path, headers: true) # => #<CSV::Table mode:col_or_row row_count:4>
-    def read(path, **options)
-      open(path, **options) { |csv| csv.read }
+    def read(path_or_io, **options)
+      open(path_or_io, **options) { |csv| csv.read }
     end
 
     # :call-seq:
-    #   CSV.readlines(source, **options)
+    #   CSV.readlines(path_or_io, **options)
     #
     # Alias for CSV.read.
-    def readlines(path, **options)
-      read(path, **options)
+    def readlines(path_or_io, **options)
+      read(path_or_io, **options)
     end
 
     # :call-seq:
-    #   CSV.table(source, **options)
+    #   CSV.table(path_or_io, **options)
     #
-    # Calls CSV.read with +source+, +options+, and certain default options:
+    # Calls CSV.read with +path_or_io+, +options+, and certain default options:
     # - +headers+: +true+
     # - +converters+: +:numeric+
     # - +header_converters+: +:symbol+
@@ -1946,25 +1946,25 @@ class CSV
     #   path = 't.csv'
     #   File.write(path, string)
     #   CSV.table(path) # => #<CSV::Table mode:col_or_row row_count:4>
-    def table(path, **options)
+    def table(path_or_io, **options)
       default_options = {
         headers:           true,
         converters:        :numeric,
         header_converters: :symbol,
       }
       options = default_options.merge(options)
-      read(path, **options)
+      read(path_or_io, **options)
     end
 
     ON_WINDOWS = /mingw|mswin/.match?(RUBY_PLATFORM)
     private_constant :ON_WINDOWS
 
     private
-    def may_enable_bom_detection_automatically(filename_or_io,
+    def may_enable_bom_detection_automatically(path_or_io,
                                                mode,
                                                options,
                                                file_opts)
-      if filename_or_io.is_a?(StringIO)
+      if path_or_io.is_a?(StringIO)
         # Support to StringIO was dropped for Ruby 2.6 and earlier without BOM support:
         # https://github.com/ruby/stringio/pull/47
         return if RUBY_VERSION < "2.7"
@@ -2110,8 +2110,6 @@ class CSV
       strip: strip,
     }
     @parser = nil
-    @parser_enumerator = nil
-    @eof_error = nil
 
     @writer_options = {
       encoding: @encoding,
@@ -2327,7 +2325,7 @@ class CSV
   attr_reader :encoding
 
   # :call-seq:
-  #   csv.line_no -> integer
+  #   csv.lineno -> integer
   #
   # Returns the count of the rows parsed or generated.
   #
@@ -2430,24 +2428,13 @@ class CSV
   end
 
   def eof?
-    return false if @eof_error
-    begin
-      parser_enumerator.peek
-      false
-    rescue MalformedCSVError => error
-      @eof_error = error
-      false
-    rescue StopIteration
-      true
-    end
+    parser.eof?
   end
   alias_method :eof, :eof?
 
   # Rewinds the underlying IO object and resets CSV's lineno() counter.
   def rewind
     @parser = nil
-    @parser_enumerator = nil
-    @eof_error = nil
     @writer.rewind if @writer
     @io.rewind
   end
@@ -2687,13 +2674,7 @@ class CSV
   #     p row
   #   end
   def each(&block)
-    return to_enum(__method__) unless block_given?
-    begin
-      while true
-        yield(parser_enumerator.next)
-      end
-    rescue StopIteration
-    end
+    parser.parse(&block)
   end
 
   # :call-seq:
@@ -2801,15 +2782,10 @@ class CSV
   #   # Raises IOError (not opened for reading)
   #   csv.shift
   def shift
-    if @eof_error
-      eof_error, @eof_error = @eof_error, nil
-      raise eof_error
-    end
-    begin
-      parser_enumerator.next
-    rescue StopIteration
-      nil
+    parser.parse do |row|
+      return row
     end
+    nil
   end
   alias_method :gets,     :shift
   alias_method :readline, :shift
@@ -2971,10 +2947,6 @@ class CSV
                           fields_converter: parser_fields_converter)
   end
 
-  def parser_enumerator
-    @parser_enumerator ||= parser.parse
-  end
-
   def writer
     @writer ||= Writer.new(@io, writer_options)
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: csv
 version: !ruby/object:Gem::Version
-  version: 3.3.5
+  version: 3.3.6
 platform: ruby
 authors:
 - James Edward Gray II
@@ -71,7 +71,7 @@ licenses:
 - Ruby
 - BSD-2-Clause
 metadata:
-  changelog_uri: https://github.com/ruby/csv/releases/tag/v3.3.5
+  changelog_uri: https://github.com/ruby/csv/releases/tag/v3.3.6
 rdoc_options:
 - "--main"
 - README.md
@@ -88,7 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 4.0.16
 specification_version: 4
 summary: CSV Reading and Writing
 test_files: []