philiprehberger-csv_builder 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 921263332f87142c3cfcdc4483e601a9ab51ce54cd53481988cc75b3b46eb7ed
-  data.tar.gz: fa347e0127c702eca2a1c4104ca1b5eada5c43458660884c9b6f9028753a8f80
+  metadata.gz: fbaf1a09bda94dd3fff6302860abacf5ad60eb1376520f145f984da9ec8fb7b1
+  data.tar.gz: 625b0af93c07cc624d51a2aed8239c5bebd465981bea6cdc7b9ef91433a2c645
 SHA512:
-  metadata.gz: a9fcc0e96415c5b1d5b55e257963c48881ec879809b652ae7604138d524df50264577650e60bb239cf6b838b5fbae2bd03e6b76d5d6cdb0b3225528dd6a5d9a6
-  data.tar.gz: c7a65b052c99facd38baee4f16f2cca0bbd36ae5906ce6ca1302da36797c6b1b585066e096b1aec8432dacbd8d1167ab23f9cb522123e4253c3088b8643c14b4
+  metadata.gz: 562365a1e93a6d9386a31630011021186ecf45029f6764e05fa594ccd872dcbe0a932477897c469dade5a95a2ca02d0d9c7f2a656b48210ff5d4c71c6d7ff9cf
+  data.tar.gz: 7805ee034ea1c75bf1e8ccbea4854d1bbaab80ddbc0def7b7ba30b0be301280bfec22d8b9450e34da4e43fb9943b627c0a11a1397cd9fe5c1b04ded3a441f843

data/CHANGELOG.md

@@ -7,6 +7,28 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.7.0] - 2026-04-15
+
+### Added
+- `Builder#write_to(path, mode:)` for writing CSV with an explicit file mode
+- `Builder#append_to(path)` shorthand that appends data rows (no header, no BOM) to an existing file
+- `row_sep:` option on `CsvBuilder.build` for custom line separators (e.g. `"\r\n"`)
+- `empty_value:` option on `CsvBuilder.build` to replace `nil` / empty values with a placeholder
+- `Builder#to_s` alias for `to_csv` (enables string interpolation)
+- `Builder#to_a` returns the CSV as `[headers, *rows, footer?]`
+
+### Fixed
+- `Column#extract` no longer silently drops `false` and `0` values when looking up symbol keys in a hash record (hash lookup now uses `Hash#key?` instead of `||`)
+
+## [0.6.0] - 2026-04-14
+
+### Added
+- `CsvBuilder.tsv` shorthand for tab-separated output
+- `CsvBuilder.psv` shorthand for pipe-separated output
+- `Builder#validate` registers a validation block; raises `CsvBuilder::ValidationError` on failure
+- `Builder#transform_header` registers a proc applied to all column headers during rendering
+- `Builder#total(column, &block)` shorthand for adding a footer row with computed total
+
 ## [0.5.0] - 2026-04-11
 
 ### Added
@@ -75,6 +97,8 @@ 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.7.0]: https://github.com/philiprehberger/rb-csv-builder/releases/tag/v0.7.0
+[0.6.0]: https://github.com/philiprehberger/rb-csv-builder/releases/tag/v0.6.0
 [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

data/README.md

@@ -94,6 +94,82 @@ builder = Philiprehberger::CsvBuilder.build(records, quote_char: "'") do
 end
 ```
 
+### TSV and PSV Output
+
+Use the `tsv` and `psv` shorthands instead of passing `delimiter:` manually:
+
+```ruby
+# Tab-separated
+builder = Philiprehberger::CsvBuilder.tsv(records) do
+  column :name
+  column :email
+end
+
+puts builder.to_csv
+# name	email
+# Alice	alice@example.com
+
+# Pipe-separated
+builder = Philiprehberger::CsvBuilder.psv(records) do
+  column :name
+  column :email
+end
+
+puts builder.to_csv
+# name|email
+# Alice|alice@example.com
+```
+
+Both accept the same options as `build` (e.g. `bom:`, `encoding:`).
+
+### Row Validation
+
+Register one or more validation blocks. Rows are checked before `to_csv`, `to_file`, or `to_io`. If any block returns falsy or raises, a `CsvBuilder::ValidationError` is raised:
+
+```ruby
+builder = Philiprehberger::CsvBuilder.build(records) do
+  column :name
+  column :email
+  validate { |row| row[:email].include?('@') }
+end
+
+builder.to_csv  # raises ValidationError if any email is missing '@'
+```
+
+### Header Transforms
+
+Apply a transformation to all column headers during rendering:
+
+```ruby
+builder = Philiprehberger::CsvBuilder.build(records) do
+  column :first_name
+  column :last_name
+  transform_header { |h| h.upcase }
+end
+
+builder.headers  # => ["FIRST_NAME", "LAST_NAME"]
+```
+
+### Total Rows
+
+Add a footer row with a computed total for a named column:
+
+```ruby
+builder = Philiprehberger::CsvBuilder.build(records) do
+  column :name
+  column :amount
+  total :amount
+end
+
+# Outputs a footer row: ,60.0
+```
+
+Pass a block for custom aggregation:
+
+```ruby
+total(:amount) { |values| values.max }
+```
+
 ### Column Aliases
 
 ```ruby
@@ -238,6 +314,62 @@ io = StringIO.new
 builder.to_io(io)
 ```
 
+### Writing and Appending
+
+`write_to` accepts an explicit open mode so you can overwrite or append:
+
+```ruby
+# Overwrite (default behaviour, same as to_file)
+builder.write_to('output.csv')
+
+# Append data rows only (no header, no BOM) to an existing file
+builder.append_to('output.csv')
+
+# Or explicitly
+builder.write_to('output.csv', mode: 'ab')
+```
+
+`append_to` is handy for combining multiple builders into one file while keeping a single header row.
+
+### Custom Line Separator
+
+Use `row_sep:` to switch between Unix (`\n`, default), Windows (`\r\n`) or any other line ending:
+
+```ruby
+builder = Philiprehberger::CsvBuilder.build(records, row_sep: "\r\n") do
+  column :name
+  column :email
+end
+```
+
+### Custom Empty Value
+
+Replace `nil` and empty string values with a placeholder:
+
+```ruby
+records = [{ name: 'Alice', email: nil }]
+
+builder = Philiprehberger::CsvBuilder.build(records, empty_value: 'N/A') do
+  column :name
+  column :email
+end
+
+puts builder.to_csv
+# name,email
+# Alice,N/A
+```
+
+### String and Array Conversion
+
+```ruby
+# to_s is an alias for to_csv (handy for string interpolation)
+puts "CSV:\n#{builder}"
+
+# to_a returns [headers, *rows, footer?] for programmatic use
+builder.to_a
+# => [["name", "email"], ["Alice", "alice@example.com"], ["Bob", "bob@example.com"]]
+```
+
 ### Headers
 
 ```ruby
@@ -253,16 +385,25 @@ builder.headers  # => ["name", "email"]
 
 | Method | Description |
 |--------|-------------|
-| `CsvBuilder.build(records, delimiter:, quote_char:, bom:, encoding:, &block)` | Build a CSV using the column DSL |
+| `CsvBuilder.build(records, delimiter:, quote_char:, row_sep:, bom:, encoding:, empty_value:, &block)` | Build a CSV using the column DSL |
+| `CsvBuilder.tsv(records, **options, &block)` | Shorthand for tab-separated output |
+| `CsvBuilder.psv(records, **options, &block)` | Shorthand for pipe-separated output |
 | `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`) |
+| `Builder#validate(&block)` | Register a row validation block; raises `ValidationError` on failure |
+| `Builder#transform_header(&block)` | Register a proc applied to all column headers |
+| `Builder#total(column, &block)` | Add a footer row with computed total for the named column |
 | `Builder#footer(&block)` | Append a computed footer row (block receives filtered records) |
 | `Builder#limit(n)` | Cap output to N rows |
 | `Builder#offset(n)` | Skip first N filtered/sorted records |
 | `Builder#row_number(header:)` | Add auto-incrementing row number column |
 | `Builder#to_csv` | Generate CSV as a string |
-| `Builder#to_file(path)` | Write CSV to a file |
+| `Builder#to_s` | Alias for `to_csv` (enables string interpolation) |
+| `Builder#to_a` | Return CSV as an array of row arrays (headers + data + footer) |
+| `Builder#to_file(path)` | Write CSV to a file (overwrites) |
+| `Builder#write_to(path, mode:)` | Write CSV with an explicit file mode (`'wb'` default, `'ab'` to append body only) |
+| `Builder#append_to(path)` | Append data rows (no header, no BOM) to an existing CSV file |
 | `Builder#to_io(io)` | Stream CSV to any IO object |
 | `Builder#headers` | Return column header names |
 

data/lib/philiprehberger/csv_builder/builder.rb

@@ -16,22 +16,29 @@ module Philiprehberger
       # @param records [Array] the source records
       # @param delimiter [String] the column separator (default: ",")
       # @param quote_char [String] the quote character (default: '"')
+      # @param row_sep [String] the line separator (default: "\n")
       # @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')
+      # @param empty_value [String] placeholder for nil/empty values (default: "")
+      def initialize(records, delimiter: ',', quote_char: '"', row_sep: "\n",
+                     bom: false, encoding: 'UTF-8', empty_value: '')
         @records = records
         @columns = []
         @filters = []
+        @validations = []
         @row_number_header = nil
         @delimiter = delimiter
         @quote_char = quote_char
+        @row_sep = row_sep
         @sort_by = nil
         @sort_direction = :asc
         @limit_count = nil
         @offset_count = nil
         @footer_block = nil
+        @header_transform = nil
         @bom = bom
         @encoding = encoding
+        @empty_value = empty_value
       end
 
       # Sort records before CSV output
@@ -79,6 +86,46 @@ module Philiprehberger
         self
       end
 
+      # Register a validation block for rows
+      #
+      # @yield [row] block that validates the row hash
+      # @yieldparam row [Hash] column-name to value mapping
+      # @return [self]
+      def validate(&block)
+        @validations << block
+        self
+      end
+
+      # Register a proc applied to all column headers during rendering
+      #
+      # @yield [name] block that transforms a header name
+      # @yieldparam name [String] the original header label
+      # @return [self]
+      def transform_header(&block)
+        @header_transform = block
+        self
+      end
+
+      # Shorthand for adding a footer row with a computed total for the named column
+      #
+      # @param column_name [Symbol, String] the column to total
+      # @yield [values] optional block to compute the total (receives array of numeric values)
+      # @return [self]
+      def total(column_name, &block)
+        col_name = column_name.to_sym
+        @footer_block = lambda do |recs|
+          columns.map do |col|
+            if col.name == col_name
+              values = recs.map { |r| col.extract(r, empty_value: @empty_value).to_f }
+              block ? block.call(values) : values.sum
+            else
+              ''
+            end
+          end
+        end
+        self
+      end
+
       # Define a column
       #
       # @param name [Symbol, String] the column name
@@ -115,6 +162,7 @@ module Philiprehberger
       # @return [Array<String>]
       def headers
         base = @columns.map(&:header)
+        base = base.map { |h| @header_transform.call(h) } if @header_transform
         @row_number_header ? [@row_number_header] + base : base
       end
 
@@ -138,8 +186,10 @@ module Philiprehberger
       # Generate the CSV as a string
       #
       # @return [String]
+      # @raise [ValidationError] if any row fails validation
       def to_csv
         recs = filtered_records
+        validate_rows!(recs) unless @validations.empty?
         csv_string = CSV.generate(**csv_options) do |csv|
           csv << headers
           recs.each_with_index do |record, index|
@@ -151,6 +201,13 @@ module Philiprehberger
         @bom ? "\xEF\xBB\xBF#{csv_string}" : csv_string
       end
 
+      # Alias for {#to_csv} so instances behave nicely with string interpolation.
+      #
+      # @return [String]
+      def to_s
+        to_csv
+      end
+
       # Write the CSV to a file
       #
       # @param path [String] the output file path
@@ -159,13 +216,41 @@ module Philiprehberger
         File.binwrite(path, to_csv)
       end
 
+      # Write the CSV to a file with an explicit mode. Useful for appending
+      # to existing files or combining multiple builders into one file.
+      #
+      # When appending (`mode: 'ab'` / `'a'`), the header row and BOM from
+      # subsequent writes are suppressed so the file keeps a single header.
+      #
+      # @param path [String] the output file path
+      # @param mode [String] file open mode (default: "wb")
+      # @return [void]
+      def write_to(path, mode: 'wb')
+        appending = mode.start_with?('a')
+        if appending
+          File.open(path, mode) { |f| write_body_rows(f) }
+        else
+          to_file(path)
+        end
+      end
+
+      # Append data rows (no header, no BOM) to an existing CSV file.
+      #
+      # @param path [String] the output file path
+      # @return [void]
+      def append_to(path)
+        write_to(path, mode: 'ab')
+      end
+
       # Stream CSV to any IO object
       #
       # @param io [IO, StringIO] the IO object to write to
       # @return [void]
+      # @raise [ValidationError] if any row fails validation
       def to_io(io)
         io.write("\xEF\xBB\xBF") if @bom
         recs = filtered_records
+        validate_rows!(recs) unless @validations.empty?
         csv = CSV.new(io, **csv_options)
         csv << headers
         recs.each_with_index do |record, index|
@@ -174,11 +259,59 @@ module Philiprehberger
         csv << @footer_block.call(recs) if @footer_block
       end
 
+      # Return the CSV as an array of row arrays (headers + data + footer).
+      #
+      # @return [Array<Array>]
+      # @raise [ValidationError] if any row fails validation
+      def to_a
+        recs = filtered_records
+        validate_rows!(recs) unless @validations.empty?
+        rows = [headers]
+        recs.each_with_index { |record, index| rows << build_row(record, index) }
+        rows << @footer_block.call(recs) if @footer_block
+        rows
+      end
+
       private
 
       # @return [Hash] CSV library options
       def csv_options
-        { col_sep: @delimiter, quote_char: @quote_char }
+        { col_sep: @delimiter, quote_char: @quote_char, row_sep: @row_sep }
+      end
+
+      # Write only the data rows (and footer) to the given IO. Used by
+      # {#write_to} / {#append_to} so subsequent appends don't duplicate
+      # the header row.
+      #
+      # @param io [IO] the IO object to write to
+      # @return [void]
+      def write_body_rows(io)
+        recs = filtered_records
+        validate_rows!(recs) unless @validations.empty?
+        csv = CSV.new(io, **csv_options)
+        recs.each_with_index { |record, index| csv << build_row(record, index) }
+        csv << @footer_block.call(recs) if @footer_block
+      end
+
+      # Validate all rows against registered validation blocks
+      #
+      # @param recs [Array] the filtered records
+      # @return [void]
+      # @raise [ValidationError] if any row fails validation
+      def validate_rows!(recs)
+        recs.each_with_index do |record, index|
+          row_hash = @columns.to_h do |col|
+            [col.name, col.extract(record, empty_value: @empty_value)]
+          end
+          @validations.each do |v|
+            result = v.call(row_hash)
+            raise ValidationError, "Row #{index + 1} failed validation" unless result
+          rescue ValidationError
+            raise
+          rescue StandardError => e
+            raise ValidationError, "Row #{index + 1} failed validation: #{e.message}"
+          end
+        end
       end
 
       # Build a single row array for the given record
@@ -187,7 +320,7 @@ module Philiprehberger
       # @param index [Integer] zero-based row index
       # @return [Array]
       def build_row(record, index)
-        row = @columns.map { |col| col.extract(record) }
+        row = @columns.map { |col| col.extract(record, empty_value: @empty_value) }
         @row_number_header ? [index + 1] + row : row
       end
     end

data/lib/philiprehberger/csv_builder/column.rb

@@ -22,17 +22,25 @@ module Philiprehberger
       # Extract the value for this column from a record
       #
       # @param record [Hash, Object] the source record
+      # @param empty_value [String] placeholder for nil / missing values
       # @return [String] the extracted and converted value
-      def extract(record)
+      def extract(record, empty_value: '')
         value = if @transform
                   @transform.call(record)
                 elsif record.is_a?(Hash)
-                  record[@name] || record[@name.to_s]
+                  if record.key?(@name)
+                    record[@name]
+                  else
+                    record[@name.to_s]
+                  end
                 elsif record.respond_to?(@name)
                   record.send(@name)
                 end
 
-        value.to_s
+        return empty_value if value.nil?
+
+        str = value.to_s
+        str.empty? ? empty_value : str
       end
 
       # Return the header label for this column

data/lib/philiprehberger/csv_builder/version.rb

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

data/lib/philiprehberger/csv_builder.rb

@@ -7,28 +7,52 @@ require_relative 'csv_builder/builder'
 module Philiprehberger
   module CsvBuilder
     class Error < StandardError; end
+    class ValidationError < Error; end
 
     # Build a CSV from records using a declarative DSL
     #
     # @param records [Array] the source records
     # @param delimiter [String] the column separator (default: ",")
     # @param quote_char [String] the quote character (default: '"')
+    # @param row_sep [String] the line separator (default: "\n")
     # @param bom [Boolean] prepend UTF-8 BOM for Excel compatibility (default: false)
     # @param encoding [String] output encoding name (default: "UTF-8")
+    # @param empty_value [String] string used to represent nil/empty values (default: "")
     # @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: '"', bom: false, encoding: 'UTF-8', &block)
+    def self.build(records, delimiter: ',', quote_char: '"', row_sep: "\n",
+                   bom: false, encoding: 'UTF-8', empty_value: '', &block)
       raise Error, 'A block is required' unless block
 
       builder = Builder.new(
         records,
-        delimiter: delimiter, quote_char: quote_char,
-        bom: bom, encoding: encoding
+        delimiter: delimiter, quote_char: quote_char, row_sep: row_sep,
+        bom: bom, encoding: encoding, empty_value: empty_value
       )
       builder.instance_eval(&block)
       builder
     end
+
+    # Shorthand for tab-separated output
+    #
+    # @param records [Array] the source records
+    # @param options [Hash] additional options passed to .build
+    # @yield [builder] the builder instance for defining columns
+    # @return [Builder] the configured builder
+    def self.tsv(records, **options, &)
+      build(records, **options, delimiter: "\t", &)
+    end
+
+    # Shorthand for pipe-separated output
+    #
+    # @param records [Array] the source records
+    # @param options [Hash] additional options passed to .build
+    # @yield [builder] the builder instance for defining columns
+    # @return [Builder] the configured builder
+    def self.psv(records, **options, &)
+      build(records, **options, delimiter: '|', &)
+    end
   end
 end

metadata

@@ -1,18 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: philiprehberger-csv_builder
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Philip Rehberger
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-04-11 00:00:00.000000000 Z
+date: 2026-04-15 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,
-  computed footer rows, row numbers, streaming output, and custom delimiters.
+  computed footer rows, row numbers, streaming output, custom delimiters and line
+  separators, TSV/PSV shorthands, row validation, header transforms, total rows, append-to-file
+  support, and custom empty-value placeholders.
 email:
 - me@philiprehberger.com
 executables: []