csv 3.1.5 → 3.2.0

data/lib/csv/version.rb

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

data/lib/csv/writer.rb

@@ -43,8 +43,10 @@ class CSV
 
       row = @fields_converter.convert(row, nil, lineno) if @fields_converter
 
+      i = -1
       converted_row = row.collect do |field|
-        quote(field)
+        i += 1
+        quote(field, i)
       end
       line = converted_row.join(@column_separator) + @row_separator
       if @output_encoding
@@ -100,6 +102,33 @@ class CSV
       end
     end
 
+    def prepare_force_quotes_fields(force_quotes)
+      @force_quotes_fields = {}
+      force_quotes.each do |name_or_index|
+        case name_or_index
+        when Integer
+          index = name_or_index
+          @force_quotes_fields[index] = true
+        when String, Symbol
+          name = name_or_index.to_s
+          if @headers.nil?
+            message = ":headers is required when you use field name " +
+                      "in :force_quotes: " +
+                      "#{name_or_index.inspect}: #{force_quotes.inspect}"
+            raise ArgumentError, message
+          end
+          index = @headers.index(name)
+          next if index.nil?
+          @force_quotes_fields[index] = true
+        else
+          message = ":force_quotes element must be " +
+                    "field index or field name: " +
+                    "#{name_or_index.inspect}: #{force_quotes.inspect}"
+          raise ArgumentError, message
+        end
+      end
+    end
+
     def prepare_format
       @column_separator = @options[:column_separator].to_s.encode(@encoding)
       row_separator = @options[:row_separator]
@@ -109,7 +138,17 @@ class CSV
         @row_separator = row_separator.to_s.encode(@encoding)
       end
       @quote_character = @options[:quote_character]
-      @force_quotes = @options[:force_quotes]
+      force_quotes = @options[:force_quotes]
+      if force_quotes.is_a?(Array)
+        prepare_force_quotes_fields(force_quotes)
+        @force_quotes = false
+      elsif force_quotes
+        @force_quotes_fields = nil
+        @force_quotes = true
+      else
+        @force_quotes_fields = nil
+        @force_quotes = false
+      end
       unless @force_quotes
         @quotable_pattern =
           Regexp.new("[\r\n".encode(@encoding) +
@@ -147,16 +186,18 @@ class CSV
         encoded_quote_character
     end
 
-    def quote(field)
+    def quote(field, i)
       if @force_quotes
         quote_field(field)
+      elsif @force_quotes_fields and @force_quotes_fields[i]
+        quote_field(field)
       else
         if field.nil?  # represent +nil+ fields as empty unquoted fields
           ""
         else
           field = String(field)  # Stringify fields
           # represent empty fields as empty quoted fields
-          if (@quote_empty and field.empty?) or @quotable_pattern.match?(field)
+          if (@quote_empty and field.empty?) or (field.valid_encoding? and @quotable_pattern.match?(field))
             quote_field(field)
           else
             field  # unquoted field

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: csv
 version: !ruby/object:Gem::Version
-  version: 3.1.5
+  version: 3.2.0
 platform: ruby
 authors:
 - James Edward Gray II
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-17 00:00:00.000000000 Z
+date: 2021-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -54,19 +54,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.4.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.4.3
 description: The CSV library provides a complete interface to CSV files and data.
   It offers tools to enable you to read and write to and from Strings or IO objects,
   as needed.
@@ -79,31 +79,40 @@ extra_rdoc_files:
 - LICENSE.txt
 - NEWS.md
 - README.md
+- doc/csv/recipes/filtering.rdoc
+- doc/csv/recipes/generating.rdoc
+- doc/csv/recipes/parsing.rdoc
+- doc/csv/recipes/recipes.rdoc
 files:
 - LICENSE.txt
 - NEWS.md
 - README.md
-- doc/col_sep.rdoc
-- doc/converters.rdoc
-- doc/empty_value.rdoc
-- doc/field_size_limit.rdoc
-- doc/force_quotes.rdoc
-- doc/header_converters.rdoc
-- doc/headers.rdoc
-- doc/liberal_parsing.rdoc
-- doc/nil_value.rdoc
-- doc/quote_char.rdoc
-- doc/quote_empty.rdoc
-- doc/return_headers.rdoc
-- doc/row_sep.rdoc
-- doc/skip_blanks.rdoc
-- doc/skip_lines.rdoc
-- doc/strip.rdoc
-- doc/unconverted_fields.rdoc
-- doc/write_converters.rdoc
-- doc/write_empty_value.rdoc
-- doc/write_headers.rdoc
-- doc/write_nil_value.rdoc
+- doc/csv/arguments/io.rdoc
+- doc/csv/options/common/col_sep.rdoc
+- doc/csv/options/common/quote_char.rdoc
+- doc/csv/options/common/row_sep.rdoc
+- doc/csv/options/generating/force_quotes.rdoc
+- doc/csv/options/generating/quote_empty.rdoc
+- doc/csv/options/generating/write_converters.rdoc
+- doc/csv/options/generating/write_empty_value.rdoc
+- doc/csv/options/generating/write_headers.rdoc
+- doc/csv/options/generating/write_nil_value.rdoc
+- doc/csv/options/parsing/converters.rdoc
+- doc/csv/options/parsing/empty_value.rdoc
+- doc/csv/options/parsing/field_size_limit.rdoc
+- doc/csv/options/parsing/header_converters.rdoc
+- doc/csv/options/parsing/headers.rdoc
+- doc/csv/options/parsing/liberal_parsing.rdoc
+- doc/csv/options/parsing/nil_value.rdoc
+- doc/csv/options/parsing/return_headers.rdoc
+- doc/csv/options/parsing/skip_blanks.rdoc
+- doc/csv/options/parsing/skip_lines.rdoc
+- doc/csv/options/parsing/strip.rdoc
+- doc/csv/options/parsing/unconverted_fields.rdoc
+- doc/csv/recipes/filtering.rdoc
+- doc/csv/recipes/generating.rdoc
+- doc/csv/recipes/parsing.rdoc
+- doc/csv/recipes/recipes.rdoc
 - lib/csv.rb
 - lib/csv/core_ext/array.rb
 - lib/csv/core_ext/string.rb
@@ -117,6 +126,7 @@ files:
 - lib/csv/writer.rb
 homepage: https://github.com/ruby/csv
 licenses:
+- Ruby
 - BSD-2-Clause
 metadata: {}
 post_install_message: 
@@ -129,14 +139,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.0.pre1
+rubygems_version: 3.3.0.dev
 signing_key: 
 specification_version: 4
 summary: CSV Reading and Writing

data/doc/col_sep.rdoc

@@ -1,45 +0,0 @@
-====== Option +col_sep+
-
-Specifies the \String field separator to be used
-for both parsing and generating.
-The \String will be transcoded into the data's \Encoding before use.
-
-Default value:
-  CSV::DEFAULT_OPTIONS.fetch(:col_sep) # => "," (comma)
-
-For examples in this section:
-  ary = ['a', 'b', 'c']
-
-Using the default:
-  str = CSV.generate_line(line)
-  str # => "a,b,c\n"
-  ary = CSV.parse_line(str)
-  ary # => ["a", "b", "c"]
-
-Using +:+ (colon):
-  col_sep = ':'
-  str = CSV.generate_line(ary, col_sep: col_sep)
-  str # => "a:b:c\n"
-  ary = CSV.parse_line(str, col_sep: col_sep)
-  ary # => [["a", "b", "c"]]
-
-Using +::+ (two colons):
-  col_sep = '::'
-  str = CSV.generate_line(ary, col_sep: col_sep)
-  str # => "a::b::c\n"
-  ary = CSV.parse_line(str, col_sep: col_sep)
-  ary # => [["a", "b", "c"]]
-
----
-
-Raises an exception if given the empty \String:
-  col_sep = ''
-  # Raises ArgumentError (:col_sep must be 1 or more characters: "")
-  CSV.parse_line("a:b:c\n", col_sep: col_sep)
-
-Raises an exception if the given value is not String-convertible:
-  col_sep = BasicObject.new
-  # Raises NoMethodError (undefined method `to_s' for #<BasicObject:>)
-  CSV.generate_line(line, col_sep: col_sep)
-  # Raises NoMethodError (undefined method `to_s' for #<BasicObject:>)
-  CSV.parse(str, col_sep: col_sep)

data/doc/converters.rdoc

@@ -1,45 +0,0 @@
-====== Option +converters+
-
-Specifies a single field converter name or \Proc,
-or an \Array of field converter names and Procs.
-
-See {Field Converters}[#class-CSV-label-Field+Converters]
-
-Default value:
-  CSV::DEFAULT_OPTIONS.fetch(:converters) # => nil
-
-The value may be a single field converter name:
-  str = '1,2,3'
-  # Without a converter
-  ary = CSV.parse_line(str)
-  ary # => ["1", "2", "3"]
-  # With built-in converter :integer
-  ary = CSV.parse_line(str, converters: :integer)
-  ary # => [1, 2, 3]
-
-The value may be an \Array of field converter names:
-  str = '1,3.14159'
-  # Without converters
-  ary = CSV.parse_line(str)
-  ary # => ["1", "3.14159"]
-  # With built-in converters
-  ary = CSV.parse_line(str, converters: [:integer, :float])
-  ary # => [1, 3.14159]
-
-The value may be a \Proc custom converter:
-  str = ' foo  ,  bar  ,  baz  '
-  # Without a converter
-  ary = CSV.parse_line(str)
-  ary # => [" foo  ", "  bar  ", "  baz  "]
-  # With a custom converter
-  ary = CSV.parse_line(str, converters: proc {|field| field.strip })
-  ary # => ["foo", "bar", "baz"]
-
-See also {Custom Converters}[#class-CSV-label-Custom+Converters]
-
----
-
-Raises an exception if the converter is not a converter name or a \Proc:
-  str = 'foo,0'
-  # Raises NoMethodError (undefined method `arity' for nil:NilClass)
-  CSV.parse(str, converters: :foo)

data/doc/header_converters.rdoc

@@ -1,31 +0,0 @@
-====== Option +header_converters+
-
-Specifies a \String converter name or an \Array of converter names.
-
-Default value:
-  CSV::DEFAULT_OPTIONS.fetch(:header_converters) # => nil
-
-Identical in functionality to option {converters}[#class-CSV-label-Option+converters]
-except that:
-- The converters apply only to the header row.
-- The built-in header converters are +:downcase+ and +:symbol+.
-
-Examples:
-  str = <<-EOT
-  foo,0
-  bar,1
-  baz,2
-  EOT
-  headers = ['Name', 'Value']
-  # With no header converter
-  csv = CSV.parse(str, headers: headers)
-  csv.headers # => ["Name", "Value"]
-  # With header converter :downcase
-  csv = CSV.parse(str, headers: headers, header_converters: :downcase)
-  csv.headers # => ["name", "value"]
-  # With header converter :symbol
-  csv = CSV.parse(str, headers: headers, header_converters: :symbol)
-  csv.headers # => [:name, :value]
-  # With both
-  csv = CSV.parse(str, headers: headers, header_converters: [:downcase, :symbol])
-  csv.headers # => [:name, :value]

data/doc/quote_char.rdoc

@@ -1,32 +0,0 @@
-====== Option +quote_char+
-
-Specifies the character (\String of length 1) used used to quote fields
-in both parsing and generating.
-This String will be transcoded into the data's \Encoding before use.
-
-Default value:
-  CSV::DEFAULT_OPTIONS.fetch(:quote_char) # => "\"" (backslash)
-
-This is useful for an application that incorrectly uses <tt>'</tt> (single-quote)
-to quote fields, instead of the correct <tt>"</tt> (double-quote).
-
-Using the default:
-  ary = ['a', 'b', '"c"', 'd']
-  str = CSV.generate_line(ary)
-  str # => "a,b,\"\"\"c\"\"\",d\n"
-  ary = CSV.parse_line(str)
-  ary # => ["a", "b", "\"c\"", "d"]
-
-Using <tt>'</tt> (single-quote):
-  quote_char = "'"
-  ary = ['a', 'b', '\'c\'', 'd']
-  str = CSV.generate_line(ary, quote_char: quote_char)
-  str # => "a,b,'''c''',d\n"
-  ary = CSV.parse_line(str, quote_char: quote_char)
-  ary # => [["a", "b", "'c'", "d"]]
-
----
-
-Raises an exception if the \String length is greater than 1:
-  # Raises ArgumentError (:quote_char has to be nil or a single character String)
-  CSV.new('', quote_char: 'xx')