philiprehberger-csv_builder 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a303ee02020135b1ce25af2882b415847487b5ee10f5b3f7fc929586150c750d
-  data.tar.gz: b7cde53364fd15eacca588c5df3ca2056a3abc40d552ba650b7fad1681f804f2
+  metadata.gz: 921263332f87142c3cfcdc4483e601a9ab51ce54cd53481988cc75b3b46eb7ed
+  data.tar.gz: fa347e0127c702eca2a1c4104ca1b5eada5c43458660884c9b6f9028753a8f80
 SHA512:
-  metadata.gz: 98272067c382b0d1a89d4400886e4162913efa72fbc6677dc3445599bcc9bdba85177894b5a89fdc9a28bd44c440279afa8a254917b208d766e3aa703e4bdc6e
-  data.tar.gz: ee0c236b83966c409af73445c43bb626330c7227964cba73054ac475b2cb3db7218f95ef4167901e9086f64c1af348f4adbc998abfdbbcc770472937fb80fa9f
+  metadata.gz: a9fcc0e96415c5b1d5b55e257963c48881ec879809b652ae7604138d524df50264577650e60bb239cf6b838b5fbae2bd03e6b76d5d6cdb0b3225528dd6a5d9a6
+  data.tar.gz: c7a65b052c99facd38baee4f16f2cca0bbd36ae5906ce6ca1302da36797c6b1b585066e096b1aec8432dacbd8d1167ab23f9cb522123e4253c3088b8643c14b4

data/CHANGELOG.md

@@ -7,6 +7,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.5.0] - 2026-04-11
+
+### Added
+- UTF-8 BOM support via `bom: true` option for Excel-compatible output
+- Custom output encoding via `encoding:` option
+
+### Fixed
+- Bug report template now requires Ruby version and gem version fields
+- Feature request template now includes "Alternatives considered" field
+
 ## [0.4.0] - 2026-04-10
 
 ### Added
@@ -65,6 +75,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Support for hash records with symbol and string keys
 - Proper CSV escaping for values with commas and quotes
 
+[0.5.0]: https://github.com/philiprehberger/rb-csv-builder/releases/tag/v0.5.0
 [0.4.0]: https://github.com/philiprehberger/rb-csv-builder/releases/tag/v0.4.0
 [0.3.0]: https://github.com/philiprehberger/rb-csv-builder/releases/tag/v0.3.0
 [0.2.0]: https://github.com/philiprehberger/rb-csv-builder/releases/tag/v0.2.0

data/README.md

@@ -197,6 +197,27 @@ end
 
 `offset` and `limit` are applied after filtering and sorting.
 
+### Excel-Compatible Output (BOM)
+
+Prepend a UTF-8 BOM so Excel opens the CSV with correct encoding:
+
+```ruby
+builder = Philiprehberger::CsvBuilder.build(records, bom: true) do
+  column :name
+  column :email
+end
+
+builder.to_file('export.csv')
+```
+
+### Custom Encoding
+
+```ruby
+builder = Philiprehberger::CsvBuilder.build(records, encoding: 'ISO-8859-1') do
+  column :name
+end
+```
+
 ### Streaming
 
 ```ruby
@@ -232,7 +253,7 @@ builder.headers  # => ["name", "email"]
 
 | Method | Description |
 |--------|-------------|
-| `CsvBuilder.build(records, delimiter:, quote_char:, &block)` | Build a CSV using the column DSL |
+| `CsvBuilder.build(records, delimiter:, quote_char:, bom:, encoding:, &block)` | Build a CSV using the column DSL |
 | `Builder#column(name, header:, &block)` | Define a column with optional alias and transform |
 | `Builder#filter(&block)` | Filter records (block returns true to include) |
 | `Builder#sort_by(direction:, &block)` | Sort records by block key (`:asc` or `:desc`) |

data/lib/philiprehberger/csv_builder/builder.rb

@@ -16,7 +16,9 @@ module Philiprehberger
       # @param records [Array] the source records
       # @param delimiter [String] the column separator (default: ",")
       # @param quote_char [String] the quote character (default: '"')
-      def initialize(records, delimiter: ',', quote_char: '"')
+      # @param bom [Boolean] prepend UTF-8 BOM (default: false)
+      # @param encoding [String] output encoding name (default: "UTF-8")
+      def initialize(records, delimiter: ',', quote_char: '"', bom: false, encoding: 'UTF-8')
         @records = records
         @columns = []
         @filters = []
@@ -28,6 +30,8 @@ module Philiprehberger
         @limit_count = nil
         @offset_count = nil
         @footer_block = nil
+        @bom = bom
+        @encoding = encoding
       end
 
       # Sort records before CSV output
@@ -39,7 +43,8 @@ module Philiprehberger
       # @raise [Error] if direction is not :asc or :desc
       def sort_by(direction: :asc, &block)
         raise Error, 'A block is required for sort_by' unless block
-        raise Error, "direction must be :asc or :desc (got #{direction.inspect})" unless %i[asc desc].include?(direction)
+        raise Error, "direction must be :asc or :desc (got #{direction.inspect})" unless %i[asc
+                                                                                            desc].include?(direction)
 
         @sort_by = block
         @sort_direction = direction
@@ -135,13 +140,15 @@ module Philiprehberger
       # @return [String]
       def to_csv
         recs = filtered_records
-        CSV.generate(**csv_options) do |csv|
+        csv_string = CSV.generate(**csv_options) do |csv|
           csv << headers
           recs.each_with_index do |record, index|
             csv << build_row(record, index)
           end
           csv << @footer_block.call(recs) if @footer_block
         end
+        csv_string = csv_string.encode(@encoding) unless @encoding == 'UTF-8'
+        @bom ? "\xEF\xBB\xBF#{csv_string}" : csv_string
       end
 
       # Write the CSV to a file
@@ -149,7 +156,7 @@ module Philiprehberger
       # @param path [String] the output file path
       # @return [void]
       def to_file(path)
-        File.write(path, to_csv)
+        File.binwrite(path, to_csv)
       end
 
       # Stream CSV to any IO object
@@ -157,6 +164,7 @@ module Philiprehberger
       # @param io [IO, StringIO] the IO object to write to
       # @return [void]
       def to_io(io)
+        io.write("\xEF\xBB\xBF") if @bom
         recs = filtered_records
         csv = CSV.new(io, **csv_options)
         csv << headers

data/lib/philiprehberger/csv_builder/version.rb

@@ -2,6 +2,6 @@
 
 module Philiprehberger
   module CsvBuilder
-    VERSION = '0.4.0'
+    VERSION = '0.5.0'
   end
 end

data/lib/philiprehberger/csv_builder.rb

@@ -13,14 +13,20 @@ module Philiprehberger
     # @param records [Array] the source records
     # @param delimiter [String] the column separator (default: ",")
     # @param quote_char [String] the quote character (default: '"')
+    # @param bom [Boolean] prepend UTF-8 BOM for Excel compatibility (default: false)
+    # @param encoding [String] output encoding name (default: "UTF-8")
     # @yield [builder] the builder instance for defining columns
     # @yieldparam builder [Builder]
     # @return [Builder] the configured builder
     # @raise [Error] if no block is given
-    def self.build(records, delimiter: ',', quote_char: '"', &block)
+    def self.build(records, delimiter: ',', quote_char: '"', bom: false, encoding: 'UTF-8', &block)
       raise Error, 'A block is required' unless block
 
-      builder = Builder.new(records, delimiter: delimiter, quote_char: quote_char)
+      builder = Builder.new(
+        records,
+        delimiter: delimiter, quote_char: quote_char,
+        bom: bom, encoding: encoding
+      )
       builder.instance_eval(&block)
       builder
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: philiprehberger-csv_builder
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Philip Rehberger
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-04-10 00:00:00.000000000 Z
+date: 2026-04-11 00:00:00.000000000 Z
 dependencies: []
 description: Build CSV files from record collections using a declarative DSL with
   column definitions, custom transforms, filtering, sorting, pagination via limit/offset,