philiprehberger-csv_builder 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: de54b4bae8142b3836493b3297627a4f6da7ecc17529cf650521bfa989068324
+  data.tar.gz: 3ab9cc18882a0a7ecf9dd9a8ac6ec81507488c37ff57de1f0ce37a057680a8a7
+SHA512:
+  metadata.gz: e059bd4aac2698b14995b49fbf5465d9bddb89f7e89404b75d03df6dfd80bce00ff4631fc96c0ac9ee01615971d565f45f4115b1820cc6826e3868008c6f7499
+  data.tar.gz: 96b72fa4660690b33e60f20b7a41f88de010e861cf60c83aca89063a156d3cff3659a22b4ced074b4f6f423741c33194ffa891daa7590eea9579025c7d891eb0

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+# Changelog
+
+All notable changes to this gem will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2026-03-22
+
+### Added
+- Initial release
+- Declarative column definition DSL
+- Custom transform blocks for computed columns
+- CSV string generation via `to_csv`
+- File output via `to_file`
+- Support for hash records with symbol and string keys
+- Proper CSV escaping for values with commas and quotes

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 philiprehberger
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,105 @@
+# philiprehberger-csv_builder
+
+[![Tests](https://github.com/philiprehberger/rb-csv-builder/actions/workflows/ci.yml/badge.svg)](https://github.com/philiprehberger/rb-csv-builder/actions/workflows/ci.yml)
+[![Gem Version](https://badge.fury.io/rb/philiprehberger-csv_builder.svg)](https://rubygems.org/gems/philiprehberger-csv_builder)
+[![License](https://img.shields.io/github/license/philiprehberger/rb-csv-builder)](LICENSE)
+
+Declarative CSV builder with column mapping and streaming output
+
+## Requirements
+
+- Ruby >= 3.1
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem "philiprehberger-csv_builder"
+```
+
+Or install directly:
+
+```bash
+gem install philiprehberger-csv_builder
+```
+
+## Usage
+
+```ruby
+require "philiprehberger/csv_builder"
+
+records = [
+  { name: 'Alice', email: 'alice@example.com', active: true },
+  { name: 'Bob', email: 'bob@example.com', active: false }
+]
+
+builder = Philiprehberger::CsvBuilder.build(records) do
+  column :name
+  column :email
+end
+
+puts builder.to_csv
+# name,email
+# Alice,alice@example.com
+# Bob,bob@example.com
+```
+
+### Custom Transforms
+
+```ruby
+builder = Philiprehberger::CsvBuilder.build(records) do
+  column :name
+  column :email
+  column(:status) { |r| r[:active] ? 'Active' : 'Inactive' }
+end
+
+puts builder.to_csv
+# name,email,status
+# Alice,alice@example.com,Active
+# Bob,bob@example.com,Inactive
+```
+
+### File Output
+
+```ruby
+builder = Philiprehberger::CsvBuilder.build(records) do
+  column :name
+  column :email
+end
+
+builder.to_file('output.csv')
+```
+
+### Headers
+
+```ruby
+builder = Philiprehberger::CsvBuilder.build(records) do
+  column :name
+  column :email
+end
+
+builder.headers  # => ["name", "email"]
+```
+
+## API
+
+| Method | Description |
+|--------|-------------|
+| `CsvBuilder.build(records, &block)` | Build a CSV using the column DSL |
+| `Builder#column(name, &block)` | Define a column with optional transform |
+| `Builder#to_csv` | Generate CSV as a string |
+| `Builder#to_file(path)` | Write CSV to a file |
+| `Builder#headers` | Return column header names |
+
+## Development
+
+```bash
+bundle install
+bundle exec rspec      # Run tests
+bundle exec rubocop    # Check code style
+```
+
+## License
+
+MIT

data/lib/philiprehberger/csv_builder/builder.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'csv'
+require_relative 'column'
+
+module Philiprehberger
+  module CsvBuilder
+    # DSL builder for constructing CSV output from records
+    class Builder
+      # @return [Array<Column>] the defined columns
+      attr_reader :columns
+
+      # @return [Array] the source records
+      attr_reader :records
+
+      # @param records [Array] the source records
+      def initialize(records)
+        @records = records
+        @columns = []
+      end
+
+      # Define a column
+      #
+      # @param name [Symbol, String] the column name
+      # @yield [record] optional block to transform the value
+      # @yieldparam record [Object] the source record
+      # @return [self]
+      def column(name, &block)
+        @columns << Column.new(name, &block)
+        self
+      end
+
+      # Return the header row
+      #
+      # @return [Array<String>]
+      def headers
+        @columns.map(&:header)
+      end
+
+      # Generate the CSV as a string
+      #
+      # @return [String]
+      def to_csv
+        CSV.generate do |csv|
+          csv << headers
+          @records.each do |record|
+            csv << @columns.map { |col| col.extract(record) }
+          end
+        end
+      end
+
+      # Write the CSV to a file
+      #
+      # @param path [String] the output file path
+      # @return [void]
+      def to_file(path)
+        File.write(path, to_csv)
+      end
+    end
+  end
+end

data/lib/philiprehberger/csv_builder/column.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Philiprehberger
+  module CsvBuilder
+    # Represents a single column definition in a CSV builder
+    class Column
+      # @return [Symbol] the column name
+      attr_reader :name
+
+      # @return [Proc, nil] optional transform block
+      attr_reader :transform
+
+      # @param name [Symbol, String] the column name (also used as the record key)
+      # @param transform [Proc, nil] optional block to transform the value
+      def initialize(name, &transform)
+        @name = name.to_sym
+        @transform = block_given? ? transform : nil
+      end
+
+      # Extract the value for this column from a record
+      #
+      # @param record [Hash, Object] the source record
+      # @return [String] the extracted and converted value
+      def extract(record)
+        value = if @transform
+                  @transform.call(record)
+                elsif record.is_a?(Hash)
+                  record[@name] || record[@name.to_s]
+                elsif record.respond_to?(@name)
+                  record.send(@name)
+                end
+
+        value.to_s
+      end
+
+      # Return the header label for this column
+      #
+      # @return [String]
+      def header
+        @name.to_s
+      end
+    end
+  end
+end

data/lib/philiprehberger/csv_builder/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Philiprehberger
+  module CsvBuilder
+    VERSION = '0.1.0'
+  end
+end

data/lib/philiprehberger/csv_builder.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative 'csv_builder/version'
+require_relative 'csv_builder/column'
+require_relative 'csv_builder/builder'
+
+module Philiprehberger
+  module CsvBuilder
+    class Error < StandardError; end
+
+    # Build a CSV from records using a declarative DSL
+    #
+    # @param records [Array] the source records
+    # @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)
+      raise Error, 'A block is required' unless block
+
+      builder = Builder.new(records)
+      builder.instance_eval(&block)
+      builder
+    end
+  end
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: philiprehberger-csv_builder
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Philip Rehberger
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-03-22 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.
+email:
+- me@philiprehberger.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/philiprehberger/csv_builder.rb
+- 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
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/philiprehberger/rb-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
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Declarative CSV builder with column mapping and streaming output
+test_files: []