philiprehberger-csv_builder 0.1.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9befa4c64115384c05f950d6f3c4e73ddf4e3e364d88408cbbe75358924ecfde
-  data.tar.gz: 1e93bbf0bff87dacb53e57b0be7c3e457d955d38a39d0144dbbd0124f6c0def1
+  metadata.gz: bc5cd28c86059cae0603624ace5e07a070875268b942adf798d664755e028e91
+  data.tar.gz: 5cc96a1439b056f18e53cb2eb8af749ee2be05c74fcae55bd1aa31fb694a2016
 SHA512:
-  metadata.gz: 0336bf8d47213dbc2b5a8811671968c42d62025338d6872f9d88a95a7976b753c09bc49eecab612b6a7e48819792c835126786f7f1626db6e47b5139a9273625
-  data.tar.gz: 3a307cfb11ad03e23526497a853e3411175c2e50a1893d6bca4e7b2addbf1a8e4a0af52d5e9f1561daa18af514989c09e92bf278ca78169d69d3040eaff70ab7
+  metadata.gz: 867447e6eb9146acaa103b6167683745ca589f2d5cc59e78de72b9cf8191e956e6f639a2cc313b7c2d6e8249bb841e0ee3f3ced92e61fef4f18d8aba4ab2afbe
+  data.tar.gz: 9464cab4f2cc762d16458a066a2268dff54bbfb72a897e9188837e5b34a78b490b9cf11018d63cb5ba43ffb10880465bbd792dd1cd405d038e158e85585dcabf

data/CHANGELOG.md

@@ -7,6 +7,26 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.3.0] - 2026-04-09
+
+### Added
+- Record sorting via `sort_by` DSL method with `:asc`/`:desc` direction support
+
+## [0.2.0] - 2026-04-03
+
+### Added
+- Custom CSV delimiters via `delimiter:` option
+- Custom quote character via `quote_char:` option
+- Column header aliasing via `header:` option on columns
+- Record filtering via `filter`
+- Auto-incrementing row numbers via `row_number`
+- Streaming output via `to_io`
+
+## [0.1.5] - 2026-03-31
+
+### Added
+- Add GitHub issue templates, dependabot config, and PR template
+
 ## [0.1.4] - 2026-03-31
 
 ### Changed

data/README.md

@@ -71,6 +71,128 @@ end
 builder.to_file('output.csv')
 ```
 
+### Custom Delimiters
+
+```ruby
+builder = Philiprehberger::CsvBuilder.build(records, delimiter: "\t") do
+  column :name
+  column :email
+end
+
+puts builder.to_csv
+# name	email
+# Alice	alice@example.com
+# Bob	bob@example.com
+```
+
+You can also set a custom quote character:
+
+```ruby
+builder = Philiprehberger::CsvBuilder.build(records, quote_char: "'") do
+  column :name
+  column :email
+end
+```
+
+### Column Aliases
+
+```ruby
+builder = Philiprehberger::CsvBuilder.build(records) do
+  column :name, header: 'Full Name'
+  column :email, header: 'Email Address'
+  column(:status, header: 'Active?') { |r| r[:active] ? 'Yes' : 'No' }
+end
+
+puts builder.to_csv
+# Full Name,Email Address,Active?
+# Alice,alice@example.com,Yes
+# Bob,bob@example.com,No
+```
+
+### Filtering
+
+```ruby
+builder = Philiprehberger::CsvBuilder.build(records) do
+  column :name
+  column :email
+  filter { |r| r[:active] }
+end
+
+puts builder.to_csv
+# name,email
+# Alice,alice@example.com
+```
+
+Multiple filters are combined with AND logic:
+
+```ruby
+builder = Philiprehberger::CsvBuilder.build(records) do
+  column :name
+  filter { |r| r[:active] }
+  filter { |r| r[:name].start_with?('A') }
+end
+```
+
+### Row Numbers
+
+```ruby
+builder = Philiprehberger::CsvBuilder.build(records) do
+  column :name
+  column :email
+  row_number
+end
+
+puts builder.to_csv
+# #,name,email
+# 1,Alice,alice@example.com
+# 2,Bob,bob@example.com
+```
+
+Customize the header label:
+
+```ruby
+row_number(header: 'Row')
+```
+
+### Sorting
+
+```ruby
+builder = Philiprehberger::CsvBuilder.build(records) do
+  column :name
+  column :email
+  sort_by { |r| r[:name] }
+end
+```
+
+Sort descending:
+
+```ruby
+builder = Philiprehberger::CsvBuilder.build(records) do
+  column :name
+  sort_by(direction: :desc) { |r| r[:name] }
+end
+```
+
+### Streaming
+
+```ruby
+File.open('output.csv', 'w') do |file|
+  builder = Philiprehberger::CsvBuilder.build(records) do
+    column :name
+    column :email
+  end
+
+  builder.to_io(file)
+end
+```
+
+Works with any IO object, including `StringIO`:
+
+```ruby
+io = StringIO.new
+builder.to_io(io)
+```
+
 ### Headers
 
 ```ruby
@@ -86,10 +208,14 @@ builder.headers  # => ["name", "email"]
 
 | Method | Description |
 |--------|-------------|
-| `CsvBuilder.build(records, &block)` | Build a CSV using the column DSL |
-| `Builder#column(name, &block)` | Define a column with optional transform |
+| `CsvBuilder.build(records, delimiter:, quote_char:, &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`) |
+| `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_io(io)` | Stream CSV to any IO object |
 | `Builder#headers` | Return column header names |
 
 ## Development

data/lib/philiprehberger/csv_builder/builder.rb

@@ -14,19 +14,63 @@ module Philiprehberger
       attr_reader :records
 
       # @param records [Array] the source records
-      def initialize(records)
+      # @param delimiter [String] the column separator (default: ",")
+      # @param quote_char [String] the quote character (default: '"')
+      def initialize(records, delimiter: ',', quote_char: '"')
         @records = records
         @columns = []
+        @filters = []
+        @row_number_header = nil
+        @delimiter = delimiter
+        @quote_char = quote_char
+        @sort_by = nil
+        @sort_direction = :asc
+      end
+
+      # Sort records before CSV output
+      #
+      # @param direction [Symbol] :asc (default) or :desc
+      # @yield [record] block returning the sort key
+      # @yieldparam record [Object] the source record
+      # @return [self]
+      # @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)
+
+        @sort_by = block
+        @sort_direction = direction
+        self
       end
 
       # Define a column
       #
       # @param name [Symbol, String] the column name
+      # @param header [String, nil] optional custom header label
       # @yield [record] optional block to transform the value
       # @yieldparam record [Object] the source record
       # @return [self]
-      def column(name, &)
-        @columns << Column.new(name, &)
+      def column(name, header: nil, &block)
+        @columns << Column.new(name, header: header, &block)
+        self
+      end
+
+      # Add a filter to exclude records
+      #
+      # @yield [record] block that returns true to include the record
+      # @yieldparam record [Object] the source record
+      # @return [self]
+      def filter(&block)
+        @filters << block
+        self
+      end
+
+      # Add an auto-incrementing row number as the first column
+      #
+      # @param header [String] the header label for the row number column
+      # @return [self]
+      def row_number(header: '#')
+        @row_number_header = header
         self
       end
 
@@ -34,17 +78,33 @@ module Philiprehberger
       #
       # @return [Array<String>]
       def headers
-        @columns.map(&:header)
+        base = @columns.map(&:header)
+        @row_number_header ? [@row_number_header] + base : base
+      end
+
+      # Return the filtered records
+      #
+      # @return [Array]
+      def filtered_records
+        result = @records
+        @filters.each do |f|
+          result = result.select(&f)
+        end
+        if @sort_by
+          result = result.sort_by(&@sort_by)
+          result = result.reverse if @sort_direction == :desc
+        end
+        result
       end
 
       # Generate the CSV as a string
       #
       # @return [String]
       def to_csv
-        CSV.generate do |csv|
+        CSV.generate(**csv_options) do |csv|
           csv << headers
-          @records.each do |record|
-            csv << @columns.map { |col| col.extract(record) }
+          filtered_records.each_with_index do |record, index|
+            csv << build_row(record, index)
           end
         end
       end
@@ -56,6 +116,35 @@ module Philiprehberger
       def to_file(path)
         File.write(path, to_csv)
       end
+
+      # Stream CSV to any IO object
+      #
+      # @param io [IO, StringIO] the IO object to write to
+      # @return [void]
+      def to_io(io)
+        csv = CSV.new(io, **csv_options)
+        csv << headers
+        filtered_records.each_with_index do |record, index|
+          csv << build_row(record, index)
+        end
+      end
+
+      private
+
+      # @return [Hash] CSV library options
+      def csv_options
+        { col_sep: @delimiter, quote_char: @quote_char }
+      end
+
+      # Build a single row array for the given record
+      #
+      # @param record [Object] the source record
+      # @param index [Integer] zero-based row index
+      # @return [Array]
+      def build_row(record, index)
+        row = @columns.map { |col| col.extract(record) }
+        @row_number_header ? [index + 1] + row : row
+      end
     end
   end
 end

data/lib/philiprehberger/csv_builder/column.rb

@@ -11,9 +11,11 @@ module Philiprehberger
       attr_reader :transform
 
       # @param name [Symbol, String] the column name (also used as the record key)
+      # @param header [String, nil] optional custom header label
       # @param transform [Proc, nil] optional block to transform the value
-      def initialize(name, &transform)
+      def initialize(name, header: nil, &transform)
         @name = name.to_sym
+        @custom_header = header
         @transform = block_given? ? transform : nil
       end
 
@@ -37,7 +39,7 @@ module Philiprehberger
       #
       # @return [String]
       def header
-        @name.to_s
+        @custom_header || @name.to_s
       end
     end
   end

data/lib/philiprehberger/csv_builder/version.rb

@@ -2,6 +2,6 @@
 
 module Philiprehberger
   module CsvBuilder
-    VERSION = '0.1.4'
+    VERSION = '0.3.0'
   end
 end

data/lib/philiprehberger/csv_builder.rb

@@ -11,14 +11,16 @@ module Philiprehberger
     # 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: '"')
     # @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, &block)
+    def self.build(records, delimiter: ',', quote_char: '"', &block)
       raise Error, 'A block is required' unless block
 
-      builder = Builder.new(records)
+      builder = Builder.new(records, delimiter: delimiter, quote_char: quote_char)
       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.1.4
+  version: 0.3.0
 platform: ruby
 authors:
 - Philip Rehberger
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-03-31 00:00:00.000000000 Z
+date: 2026-04-09 00:00:00.000000000 Z
 dependencies: []
 description: Build CSV files from record collections using a declarative DSL with
   column definitions, custom transforms, and file output support.
@@ -25,11 +25,11 @@ files:
 - lib/philiprehberger/csv_builder/builder.rb
 - lib/philiprehberger/csv_builder/column.rb
 - lib/philiprehberger/csv_builder/version.rb
-homepage: https://github.com/philiprehberger/rb-csv-builder
+homepage: https://philiprehberger.com/open-source-packages/ruby/philiprehberger-csv_builder
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/philiprehberger/rb-csv-builder
+  homepage_uri: https://philiprehberger.com/open-source-packages/ruby/philiprehberger-csv_builder
   source_code_uri: https://github.com/philiprehberger/rb-csv-builder
   changelog_uri: https://github.com/philiprehberger/rb-csv-builder/blob/main/CHANGELOG.md
   bug_tracker_uri: https://github.com/philiprehberger/rb-csv-builder/issues