SmarterCSV::Writer bugfix for quote_headers:true

Author: tilo

CHANGELOG.md

@@ -1,6 +1,9 @@
 
 # SmarterCSV 1.x Change Log
 
+## 1.14.2 (2025-04-10)
+ * bugfix: SmarterCSV::Writer fixing corner case with `quote_headers: true`
+
 ## 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))

lib/smarter_csv/version.rb

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

lib/smarter_csv/writer.rb

@@ -90,6 +90,7 @@ def <<(data)
     def finalize
       mapped_headers = @headers.map { |header| @map_headers[header] || header }
       force_quotes = @quote_headers || @force_quotes
+
       mapped_headers = mapped_headers.map { |x| escape_csv_field(x, force_quotes) }
 
       @temp_file.rewind
@@ -136,7 +137,7 @@ def map_all_values(key, value)
 
     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)

spec/smarter_csv/writer_spec.rb

@@ -384,6 +384,25 @@
         end
       end
 
+      context 'when force_quotes is true, even with auto-quoting disabled' do
+        let(:options) do
+          {
+            force_quotes: true,
+            disable_auto_quoting: true, # works even then
+          }
+        end
+
+        it 'quotes all the headers and data fields' do
+          writer = SmarterCSV::Writer.new(file_path, options)
+          writer << data
+          writer.finalize
+          output = File.read(file_path)
+
+          expect(output).to include("\"name\",\"age\",\"city\"#{row_sep}")
+          expect(output).to include("\"John\",\"30\",\"New York\"#{row_sep}")
+        end
+      end
+
       context 'when quote_headers is true' do
         let(:options) { {quote_headers: true} }
 
@@ -446,6 +465,7 @@
     describe 'when doing advanced mapping' do
       let(:options) do
         {
+          quote_headers: true,
           disable_auto_quoting: true, # ⚠️ Important: turn off auto-quoting because we're messing with it below
           value_converters: {
             active: ->(v) { v ? '✅' : '❌' },
@@ -470,7 +490,7 @@
         writer.finalize
 
         output = File.read(file_path)
-        expect(output).to include("name,age,active,balance#{row_sep}")
+        expect(output).to include("\"name\",\"age\",\"active\",\"balance\"#{row_sep}")
         expect(output).to include("\"Alice\",42,\"✅\",\"$234.24\"#{row_sep}")
         expect(output).to include("\"Joe\",53,\"❌\",\"$32100\"#{row_sep}")
       end