csv 3.2.5 → 3.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1abbfa01e0e5085077c3a58da0042477dfc0863cfb613f523a1cd0f6d577e0d9
-  data.tar.gz: a80f49679422de5da4543cc5359dc0105ce49be86f76333bc50a2ea75345a1b0
+  metadata.gz: 6cc7b1ce29466412d00abcdb6afe594aa953f4b88367086398a3376484ca3344
+  data.tar.gz: b8112d963f92496cc775996c4e65d5b585601210fc03a4bc86eb4bf3c20e5f7d
 SHA512:
-  metadata.gz: f71291c830c9ac8d77ec16d0acf036e633867c91370032e3f4e26aa5f4f4bfd7e2c726c9bc320c2295de34485bef14abde70de44e052e4e954466ceeeae6e9dd
-  data.tar.gz: 2f619e6608556aaeaabdbf3b3116201d9a4f43eb20b313023d153e9ae03e34a17e10919d373afdd64f39f9edaeb813871e43e4fbb3a46e2dc3fc80d47214307c
+  metadata.gz: 3c29b38c150c691b52d0be24ab3dcdf32c430f2870de3ae4b26e704368caead83b27a581324a73515a85df8dc9571ab9f5fef1e8aa16a78f2ebfe3981a036063
+  data.tar.gz: 40cc68cb5a5eae059c3924e21e4fb53ae19e3c129f4b57e2bdcab35798742616daee93cf4bf9998de5333e03b01cc7b08a11da9700f04913a45f80741542d8f5

data/NEWS.md

@@ -1,5 +1,82 @@
 # News
 
+## 3.2.7 - 2023-06-26
+
+### Improvements
+
+  * Removed an unused internal variable.
+    [GH-273](https://github.com/ruby/csv/issues/273)
+    [Patch by Mau Magnaguagno]
+
+  * Changed to use `https://` instead of `http://` in documents.
+    [GH-274](https://github.com/ruby/csv/issues/274)
+    [Patch by Vivek Bharath Akupatni]
+
+  * Added prefix to a helper module in test.
+    [GH-278](https://github.com/ruby/csv/issues/278)
+    [Patch by Luke Gruber]
+
+  * Added a documentation for `liberal_parsing: {backslash_quotes: true}`.
+    [GH-280](https://github.com/ruby/csv/issues/280)
+    [Patch by Mark Schneider]
+
+### Fixes
+
+  * Fixed a wrong execution result in documents.
+    [GH-276](https://github.com/ruby/csv/issues/276)
+    [Patch by Yuki Tsujimoto]
+
+  * Fixed a bug that the same line is used multiple times.
+    [GH-279](https://github.com/ruby/csv/issues/279)
+    [Reported by Gabriel Nagy]
+
+### Thanks
+
+  * Mau Magnaguagno
+
+  * Vivek Bharath Akupatni
+
+  * Yuki Tsujimoto
+
+  * Luke Gruber
+
+  * Mark Schneider
+
+  * Gabriel Nagy
+
+## 3.2.6 - 2022-12-08
+
+### Improvements
+
+  * `CSV#read` consumes the same lines with other methods like
+    `CSV#shift`.
+    [[GitHub#258](https://github.com/ruby/csv/issues/258)]
+    [Reported by Lhoussaine Ghallou]
+
+  * All `Enumerable` based methods consume the same lines with other
+    methods. This may have a performance penalty.
+    [[GitHub#260](https://github.com/ruby/csv/issues/260)]
+    [Reported by Lhoussaine Ghallou]
+
+  * Simplify some implementations.
+    [[GitHub#262](https://github.com/ruby/csv/pull/262)]
+    [[GitHub#263](https://github.com/ruby/csv/pull/263)]
+    [Patch by Mau Magnaguagno]
+
+### Fixes
+
+  * Fixed `CSV.generate_lines` document.
+    [[GitHub#257](https://github.com/ruby/csv/pull/257)]
+    [Patch by Sampat Badhe]
+
+### Thanks
+
+  * Sampat Badhe
+
+  * Lhoussaine Ghallou
+
+  * Mau Magnaguagno
+
 ## 3.2.5 - 2022-08-26
 
 ### Improvements

data/doc/csv/options/parsing/liberal_parsing.rdoc

@@ -1,13 +1,13 @@
 ====== Option +liberal_parsing+
 
-Specifies the boolean value that determines whether
+Specifies the boolean or hash value that determines whether
 CSV will attempt to parse input not conformant with RFC 4180,
 such as double quotes in unquoted fields.
 
 Default value:
   CSV::DEFAULT_OPTIONS.fetch(:liberal_parsing) # => false
 
-For examples in this section:
+For the next two examples:
   str = 'is,this "three, or four",fields'
 
 Without +liberal_parsing+:
@@ -17,3 +17,22 @@ Without +liberal_parsing+:
 With +liberal_parsing+:
   ary = CSV.parse_line(str, liberal_parsing: true)
   ary # => ["is", "this \"three", " or four\"", "fields"]
+
+Use the +backslash_quote+ sub-option to parse values that use
+a backslash to escape a double-quote character.  This
+causes the parser to treat <code>\"</code> as if it were
+<code>""</code>.
+
+For the next two examples:
+  str = 'Show,"Harry \"Handcuff\" Houdini, the one and only","Tampa Theater"'
+
+With +liberal_parsing+, but without the +backslash_quote+ sub-option:
+  # Incorrect interpretation of backslash; incorrectly interprets the quoted comma as a field separator.
+  ary = CSV.parse_line(str, liberal_parsing: true)
+  ary # => ["Show", "\"Harry \\\"Handcuff\\\" Houdini", " the one and only\"", "Tampa Theater"]
+  puts ary[1] # => "Harry \"Handcuff\" Houdini
+
+With +liberal_parsing+ and its +backslash_quote+ sub-option:
+  ary = CSV.parse_line(str, liberal_parsing: { backslash_quote: true })
+  ary # => ["Show", "Harry \"Handcuff\" Houdini, the one and only", "Tampa Theater"]
+  puts ary[1] # => Harry "Handcuff" Houdini, the one and only

data/doc/csv/recipes/parsing.rdoc

@@ -520,7 +520,7 @@ Apply multiple header converters by defining and registering a custom header con
 To capture unconverted field values, use option +:unconverted_fields+:
   source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
   parsed = CSV.parse(source, converters: :integer, unconverted_fields: true)
-  parsed # => [["foo", "0"], ["bar", "1"], ["baz", "2"]]
+  parsed # => [["Name", "Value"], ["foo", 0], ["bar", 1], ["baz", 2]]
   parsed.each {|row| p row.unconverted_fields }
 Output:
   ["Name", "Value"]

data/lib/csv/parser.rb

@@ -101,7 +101,7 @@ class CSV
         position = @scanner.pos
         offset = 0
         n_row_separator_chars = row_separator.size
-        # trace(__method__, :start, line, input)
+        # trace(__method__, :start, input)
         while true
           input.each_line(row_separator) do |line|
             @scanner.pos += line.bytesize
@@ -157,6 +157,7 @@ class CSV
         # trace(__method__, pattern, :done, :last, value) if @last_scanner
         return value if @last_scanner
 
+        # trace(__method__, pattern, :done, :nil) if value.nil?
         return nil if value.nil?
         while @scanner.eos? and read_chunk and (sub_value = @scanner.scan(pattern))
           # trace(__method__, pattern, :sub, sub_value)
@@ -200,7 +201,8 @@ class CSV
           # trace(__method__, :rescan, start, buffer)
           string = @scanner.string
           if scanner == @scanner
-            keep = string.byteslice(start, string.bytesize - start)
+            keep = string.byteslice(start,
+                                    string.bytesize - @scanner.pos - start)
           else
             keep = string
           end
@@ -485,7 +487,6 @@ class CSV
           message = ":quote_char has to be nil or a single character String"
           raise ArgumentError, message
         end
-        @double_quote_character = @quote_character * 2
         @escaped_quote_character = Regexp.escape(@quote_character)
         @escaped_quote = Regexp.new(@escaped_quote_character)
       end

data/lib/csv/row.rb

@@ -703,7 +703,7 @@ class CSV
     # by +index_or_header+ and +specifiers+.
     #
     # The nested objects may be instances of various classes.
-    # See {Dig Methods}[https://docs.ruby-lang.org/en/master/dig_methods_rdoc.html].
+    # See {Dig Methods}[rdoc-ref:dig_methods.rdoc].
     #
     # Examples:
     #   source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"

data/lib/csv/table.rb

@@ -890,9 +890,8 @@ class CSV
       if @mode == :row or @mode == :col_or_row  # by index
         @table.delete_if(&block)
       else                                      # by header
-        deleted = []
         headers.each do |header|
-          deleted << delete(header) if yield([header, self[header]])
+          delete(header) if yield([header, self[header]])
         end
       end
 

data/lib/csv/version.rb

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

data/lib/csv.rb

@@ -70,7 +70,7 @@
 # == What is CSV, really?
 #
 # CSV maintains a pretty strict definition of CSV taken directly from
-# {the RFC}[http://www.ietf.org/rfc/rfc4180.txt]. I relax the rules in only one
+# {the RFC}[https://www.ietf.org/rfc/rfc4180.txt]. I relax the rules in only one
 # place and that is to make using this library easier. CSV will parse all valid
 # CSV.
 #
@@ -1005,7 +1005,7 @@ class CSV
     def instance(data = $stdout, **options)
       # create a _signature_ for this method call, data object and options
       sig = [data.object_id] +
-            options.values_at(*DEFAULT_OPTIONS.keys.sort_by { |sym| sym.to_s })
+            options.values_at(*DEFAULT_OPTIONS.keys)
 
       # fetch or create the instance for this signature
       @@instances ||= Hash.new
@@ -1144,7 +1144,7 @@ class CSV
     #   File.read('t.csv') # => "Name,Value\nFOO,0\nBAR,-1\nBAZ,-2\n"
     #
     # When neither +in_string_or_io+ nor +out_string_or_io+ given,
-    # parses from {ARGF}[https://docs.ruby-lang.org/en/master/ARGF.html]
+    # parses from {ARGF}[rdoc-ref:ARGF]
     # and generates to STDOUT.
     #
     # Without headers:
@@ -1202,7 +1202,7 @@ class CSV
       # parse options for input, output, or both
       in_options, out_options = Hash.new, {row_sep: InputRecordSeparator.value}
       options.each do |key, value|
-        case key.to_s
+        case key
         when /\Ain(?:put)?_(.+)\Z/
           in_options[$1.to_sym] = value
         when /\Aout(?:put)?_(.+)\Z/
@@ -1489,12 +1489,12 @@ class CSV
     # ---
     #
     # Returns the \String generated from an
-    #   CSV.generate_lines(['foo', '0'], ['bar', '1'], ['baz', '2']) # => "foo,0\nbar,1\nbaz.2\n"
+    #   CSV.generate_lines([['foo', '0'], ['bar', '1'], ['baz', '2']]) # => "foo,0\nbar,1\nbaz,2\n"
     #
     # ---
     #
     # Raises an exception
-    #   # Raises NoMethodError (undefined method `find' for :foo:Symbol)
+    #   # Raises NoMethodError (undefined method `each' for :foo:Symbol)
     #   CSV.generate_lines(:foo)
     #
     def generate_lines(rows, **options)
@@ -2551,7 +2551,13 @@ class CSV
   #     p row
   #   end
   def each(&block)
-    parser_enumerator.each(&block)
+    return to_enum(__method__) unless block_given?
+    begin
+      while true
+        yield(parser_enumerator.next)
+      end
+    rescue StopIteration
+    end
   end
 
   # :call-seq:

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: csv
 version: !ruby/object:Gem::Version
-  version: 3.2.5
+  version: 3.2.7
 platform: ruby
 authors:
 - James Edward Gray II
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-26 00:00:00.000000000 Z
+date: 2023-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -145,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.0.dev
+rubygems_version: 3.5.0.dev
 signing_key:
 specification_version: 4
 summary: CSV Reading and Writing