smarter_csv 1.14.0 → 1.14.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f7308ee39fc18fb93f23273b32559ae83139375bfc84c975a1b6cf048368a5e
-  data.tar.gz: a50d9ea0b40bf28adc829613d8d0b2744018b708453b96cc339653688a1c1f40
+  metadata.gz: 4b6c0ad6a61721dac33f4ef31cf34da3cdd221804aaa45ff8e49cf7b5894b539
+  data.tar.gz: 8c1307aa7a74fc4f434eec362519dcb4392774aa35f563fc2674d542f6b4ea62
 SHA512:
-  metadata.gz: baf9bad5261b6ab75d4d49fc7b0044536a9977955ef01d38b9d9431478649be8481a378a4b988b6091b7f2c5ba5f6c2a8899dfc2143f2bd11c834386453024d1
-  data.tar.gz: 7283acb30cbdde33c463f369a619cc93235ea2931153babdcaedabe468cf50e198ab0264e9c70ee166a81cc072b44ab874d89e4de835379495155784b7a31035
+  metadata.gz: 8b7cef2ec65c990d3f6c8b05acaefa328952e70571c5868293531ac51c44fd13306dfad5e976f786eb61d206214bc7eae91cf8c2e00023a26c75d689769ed684
+  data.tar.gz: e204946071d76d264b0c8206b1d9170eb7b5c89bb25f22975322fbdc0c4d52869f4b7cf06245d5143298c6d3a89b8c2bc6aa6529fc32f0895e57e1d2ddef97d1

data/.rubocop.yml

@@ -58,6 +58,9 @@ Style/ClassMethods:
 Style/ConditionalAssignment:
   Enabled: false
 
+Style/CommentAnnotation:
+  Enabled: false
+
 Style/CommentedKeyword:
   Enabled: false
 
@@ -76,6 +79,9 @@ Style/Encoding:
 Style/EvalWithLocation:
   Enabled: false
 
+Style/EvenOdd:
+  Enabled: false
+
 Style/FormatString:
   Enabled: false
 
@@ -94,9 +100,15 @@ Style/IfUnlessModifier:
 Style/InverseMethods:
   Enabled: false
 
+Style/Lambda:
+  Enabled: false
+
 Style/NestedTernaryOperator:
   Enabled: false
 
+Style/OptionalBooleanParameter:
+  Enabled: false
+
 Style/PreferredHashMethods:
   Enabled: false
 
@@ -115,6 +127,9 @@ Style/SafeNavigation:
 Style/SlicingWithRange:
   Enabled: false
 
+Style/SoleNestedConditional:
+  Enabled: false
+
 Style/SpecialGlobalVars: # DANGER: unsafe rule!!
   Enabled: false
 
@@ -135,8 +150,13 @@ Style/SymbolArray:
 Style/SymbolProc: # old Ruby versions can't do this
   Enabled: false
 
+Style/TrailingCommaInArrayLiteral:
+  Enabled: false
+  EnforcedStyleForMultiline: consistent_comma
+
 Style/TrailingCommaInHashLiteral:
   Enabled: false
+  EnforcedStyleForMultiline: consistent_comma
 
 Style/TrailingUnderscoreVariable:
   Enabled: false

data/CHANGELOG.md

@@ -1,6 +1,15 @@
 
 # SmarterCSV 1.x Change Log
 
+## 1.14.2 (2025-04-10)
+ * bugfix: SmarterCSV::Writer fixing corner case with `quote_headers: true`
+ * new option: `header_converter` allows to programatically modify the headers
+
+## 1.14.1 (2025-04-09)
+ * bugfix: SmarterCSV::Writer empty hash results in a blank line ([issue 299](https://github.com/tilo/smarter_csv/issues/299))
+ * bugfix: SmarterCSV::Writer need to automatically quote problematic headers ([issue #300](https://github.com/tilo/smarter_csv/issues/300))
+ * new option: `quote_headers` allows to explicitly quote all headers
+
 ## 1.14.0 (2025-04-07)
  * adding advanced configuration options for writing CSV files. ([issue 297](https://github.com/tilo/smarter_csv/issues/297) thanks to Robert Reiz, [issue 296](https://github.com/tilo/smarter_csv/issues/296))
 

data/README.md

@@ -47,9 +47,11 @@ Or install it yourself as:
     
 # Articles
   * [Parsing CSV Files in Ruby with SmarterCSV](https://tilo-sloboda.medium.com/parsing-csv-files-in-ruby-with-smartercsv-6ce66fb6cf38)
+  * [CSV Writing with SmarterCSV](https://tilo-sloboda.medium.com/csv-writing-with-smartercsv-26136d47ad0c)
   * [Processing 1.4 Million CSV Records in Ruby, fast ](https://lcx.wien/blog/processing-14-million-csv-records-in-ruby/)
   * [Faster Parsing CSV with Parallel Processing](http://xjlin0.github.io/tech/2015/05/25/faster-parsing-csv-with-parallel-processing) by [Jack lin](https://github.com/xjlin0/)
-  * [The original post](http://www.unixgods.org/Ruby/process_csv_as_hashes.html) that started SmarterCSV
+  * The original [Stackoverflow Question](https://stackoverflow.com/questions/7788618/update-mongodb-with-array-from-csv-join-table/7788746#7788746) that inspired SmarterCSV
+  * [The original post](http://www.unixgods.org/Ruby/process_csv_as_hashes.html) for SmarterCSV
 
 # [ChangeLog](./CHANGELOG.md)
 

data/docs/basic_write_api.md

@@ -62,14 +62,14 @@ The simplified interface takes a block:
 ### Full Interface
 
       ```
-        writer = SmarterCSV::Writer.new(file_path, options)
+        csv_writer = SmarterCSV::Writer.new(file_path, options)
 
         MyModel.find_in_batches(batch_size: 100) do |batch|
           batch.pluck(:name, :description, :instructor).each do |record|
             csv_writer << record
           end
 
-        writer.finalize
+        csv_writer.finalize
       ```
 
 ## Advanced Features: Customizing the Output Format
@@ -141,7 +141,7 @@ You can also use the special keyword `:_all` to define transformations that are
         value_converters: {        
           disable_auto_quoting: true, # ⚠️ Important: turn off auto-quoting because we're messing with it below
           active: ->(v) { !!v ? 'YES' : 'NO' },
-          _all: ->(k, v) { v.is_a?(String) ? "\"#{v}\"" : v } # only double-quote string fields
+          _all: ->(_k, v) { v.is_a?(String) ? "\"#{v}\"" : v } # only double-quote string fields
         }  
       }
 ```

data/docs/options.md

@@ -28,10 +28,15 @@
      |                             |           | ⚠️ This disables automatic header detection!                    |
      | :map_headers                |    {}     | Similar to `headers`, but also maps each desired key to a user-specified value that is uesd as the header. | 
      |                             |           | ⚠️ This disables automatic header detection!                    |
+     | :value_converters           |    nil    | allows to define lambdas to programmatically modify values       |
+     |                             |           | * either for specific `key` names                                |
+     |                             |           | * or using `_all` for all fields                                |
+     | :header_converter           |    nil    | allows to define one lambda to programmatically modify the headers |
      | :discover_headers           |   true    | Automatically detects all keys in the input before writing the header |
      |                             |           | Do not manually set this to `false`. ⚠️                         |
      |                             |           | But you can set this to `true` when using `map_headers` option. |
      | :disable_auto_quoting       |  false    | To manually disable auto-quoting of special characters. ⚠️ Be careful with this! |
+     | :quote_headers              |  false    | To force quoting all headers (only needed in rare cases)        |
 
 
 ## CSV Reading

data/lib/smarter_csv/parser.rb

@@ -110,7 +110,7 @@ module SmarterCSV
       end
 
       # Replace double quotes with a single quote
-      field.gsub!("#{quote * 2}", quote)
+      field.gsub!((quote * 2).to_s, quote)
 
       field
     end

data/lib/smarter_csv/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SmarterCSV
-  VERSION = "1.14.0"
+  VERSION = "1.14.2"
 end

data/lib/smarter_csv/writer.rb

@@ -29,6 +29,7 @@ module SmarterCSV
   #   quote_char : defaults to "
   #   discover_headers : defaults to true
   #   headers : defaults to []
+  #   quote_headers: defaults to false
   #   force_quotes: defaults to false
   #   map_headers: defaults to {}, can be a hash of key -> value mappings
   #   value_converters: optional hash of key -> lambda to control serialization
@@ -48,14 +49,16 @@ module SmarterCSV
       @col_sep = options[:col_sep] || ','
       @quote_char = options[:quote_char] || '"'
       @force_quotes = options[:force_quotes] == true
+      @quote_headers = options[:quote_headers] == true
       @disable_auto_quoting = options[:disable_auto_quoting] == true
       @value_converters = options[:value_converters] || {}
       @map_all_keys = @value_converters.has_key?(:_all)
       @mapped_keys = @value_converters.keys - [:_all]
+      @header_converter = options[:header_converter]
 
       @discover_headers = true
       if options.has_key?(:discover_headers)
-        @discover_headers = options[:discover_headers] == true # ⚠️ this option should not be exposed
+        @discover_headers = options[:discover_headers] == true
       else
         @discover_headers = !(options.has_key?(:map_headers) || options.has_key?(:headers))
       end
@@ -87,10 +90,14 @@ module SmarterCSV
 
     def finalize
       mapped_headers = @headers.map { |header| @map_headers[header] || header }
-      mapped_headers = mapped_headers.map { |x| escape_csv_field(x) } if @force_quotes
+
+      mapped_headers = @headers.map { |header| @header_converter.call(header) } if @header_converter
+
+      force_quotes = @quote_headers || @force_quotes
+      mapped_headers = mapped_headers.map { |x| escape_csv_field(x, force_quotes) }
 
       @temp_file.rewind
-      @output_file.write(mapped_headers.join(@col_sep) + @row_sep)
+      @output_file.write(mapped_headers.join(@col_sep) + @row_sep) unless mapped_headers.empty?
       @output_file.write(@temp_file.read)
       @output_file.flush
       @output_file.close
@@ -117,10 +124,10 @@ module SmarterCSV
         # then apply general mapping rules
         value = map_all_values(header, value) if @map_all_keys
 
-        escape_csv_field(value) # for backwards compatibility
+        escape_csv_field(value, @force_quotes) # for backwards compatibility
       end
 
-      @temp_file.write ordered_row.join(@col_sep) + @row_sep
+      @temp_file.write(ordered_row.join(@col_sep) + @row_sep) unless ordered_row.empty?
     end
 
     def map_value(key, value)
@@ -131,13 +138,13 @@ module SmarterCSV
       @value_converters[:_all].call(key, value)
     end
 
-    def escape_csv_field(field)
+    def escape_csv_field(field, force_quotes = false)
       str = field.to_s
-      return str if @disable_auto_quoting
+      return str if @disable_auto_quoting && !force_quotes
 
       # double-quote fields if we force that, or if the field contains the comma, new-line, or quote character
       contains_special_char = str.to_s.match(@quote_regex)
-      if @force_quotes || contains_special_char
+      if force_quotes || contains_special_char
         str = str.gsub(@quote_char, @quote_char * 2) if contains_special_char # escape double-quote
 
         "\"#{str}\""

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smarter_csv
 version: !ruby/object:Gem::Version
-  version: 1.14.0
+  version: 1.14.2
 platform: ruby
 authors:
 - Tilo Sloboda
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-04-07 00:00:00.000000000 Z
+date: 2025-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print