csb 0.16.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd0789e534f43fca7c3b34921ca5aa2c151a8385237a4f1509222a3bcf76852f
-  data.tar.gz: cce9f025f3fdaba91ea2e201585ac914d81191d99100eb971ba4266dd8e46111
+  metadata.gz: f05cd902f17175e076c30da2f46b027e9306a8027c535a592bb6b177e6075247
+  data.tar.gz: 863d4f9abbdf7489a78494065c6b6f50f3cef74865e692002d8f0214f5a2b3d4
 SHA512:
-  metadata.gz: 160a693da16312599fe0f905be34c5086e5a54dc85234ac46fe5e758dd505d550830048aa98f3b9c31d0bd99d5827fd2affe1db8cd3a6cfa859f3d93fdca37f9
-  data.tar.gz: d9d703f251f3c29009c94002af15fcd6a0a6df80e268d241d9227c6ca8ef1e7a25f77a954e8c42a4fc26ecc91c2a199755aa552b178fd10384d2843503186e3c
+  metadata.gz: 2733b58f2e976bc92affbc510392949f12795d7d78f417fcee413255724f3d313088731869f0ed3179cc5ba6674cfb96133ae21fd44870d283004f26e6262d39
+  data.tar.gz: 1c7231a8a755593232e033d503d16951b2d39c998ce010c2063317460582cc9ae08a4a665594c2ddd2f38f514a293567ca968dbcd8cfdf0b373cce0a0c8aa5ee

data/.gitignore

@@ -12,3 +12,6 @@
 Gemfile.lock
 /vendor/bundle
 .vscode/settings.json
+
+# Local-only Japanese skill drafts (not distributed)
+skills/**/*-ja.md

data/README.md

@@ -174,6 +174,18 @@ Csb.configure do |config|
 end
 ```
 
+## Agent skill
+
+This gem ships an [agent skill](skills/csb/) (`SKILL.md`) so AI coding agents (e.g. Claude Code) understand how to use csb. Install it into your project with [apm (Agent Package Manager)](https://github.com/microsoft/apm):
+
+```sh
+apm install aki77/csb/skills/csb
+```
+
+apm deploys the skill to each agent's directory (e.g. `.claude/skills/`) and locks the version in its lockfile.
+
+Alternatively, if your project already pulls csb in via Bundler, the [bundler-skills](https://github.com/aki77/bundler-skills) plugin auto-syncs this skill on `bundle install` — keeping the skill version locked to the gem version.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/aki77/csb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/csb.gemspec

@@ -20,7 +20,9 @@ Gem::Specification.new do |spec|
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|\.claude)/}) }
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features|\.claude)/}) || f.match(%r{^skills/.*-ja\.md$})
+    end
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }

data/lib/csb/version.rb

@@ -1,3 +1,3 @@
 module Csb
-  VERSION = '0.16.0'
+  VERSION = '0.17.0'
 end

data/skills/csb/SKILL.md

@@ -0,0 +1,150 @@
+---
+name: csb
+description: "Generate streaming, Excel-friendly CSV downloads in Rails with the csb gem. Use when implementing a CSV export/download, writing a `.csv.csb` template, building CSV via Csb::Builder, or testing column definitions. Not for parsing CSV."
+---
+
+# csb
+
+A simple, streaming CSV template engine for Ruby on Rails (the name is short for **CSV builder**). Use it to generate Excel-friendly, memory-safe CSV downloads with column definitions that are easy to read and unit-test.
+
+## When to use csb
+
+Reach for csb when building a CSV **download/export** in Rails. It replaces the naive hand-written `CSV.generate` in a view, which has recurring problems csb solves:
+
+| Problem with hand-written CSV | csb solution |
+| --- | --- |
+| Garbled in Excel (UTF-8 without BOM) | Optional UTF-8 BOM output |
+| Memory / timeout on large datasets | Row-by-row streaming download |
+| Headers and values defined far apart | Each column's header + value on one line |
+| Export logic buried in a view, hard to test | Extract column defs to a model and unit-test |
+
+Out of scope: **parsing** CSV (use the `csv` stdlib directly).
+
+## Approach 1: Template handler (the common case)
+
+Controller — just assign the records (an `ActiveRecord::Relation` is fine, no `.to_a` needed):
+
+```ruby
+# app/controllers/reports_controller.rb
+def index
+  @reports = Report.preload(:categories)
+end
+```
+
+View — `app/views/reports/index.csv.csb` (note the `.csv.csb` extension):
+
+```ruby
+csv.items = @reports
+
+# Each column: header + value defined together.
+csv.cols.add('Update date') { |r| l(r.updated_at.to_date) } # block receives the record
+csv.cols.add('Categories') { |r| r.categories.pluck(:name).join(' ') }
+csv.cols.add('Content', :content) # Symbol -> calls the method on the record
+csv.cols.add('Static', 'dummy')   # String  -> output verbatim
+csv.cols.add('Empty')             # no value -> empty column
+csv.cols.add('Dup', :col1)        # the same header may be added more than once;
+csv.cols.add('Dup', :col2)        # columns are output in definition order
+```
+
+A link like `link_to 'Download CSV', reports_path(format: :csv)` triggers the streaming download automatically.
+
+### Large datasets
+
+Pass an Enumerator so streaming starts immediately instead of loading every record first:
+
+```ruby
+csv.items = @reports.find_each
+# With a decorator (e.g. Draper), kept lazy:
+csv.items = @reports.find_each.lazy.map(&:decorate)
+```
+
+### Per-view overrides
+
+```ruby
+csv.filename = "reports_#{Time.current.to_i}.csv"
+csv.streaming = false
+csv.csv_options = { col_sep: "\t" }
+```
+
+## Approach 2: Direct generation (outside a request)
+
+For background jobs or anywhere outside a controller, use `Csb::Builder`:
+
+```ruby
+csv = Csb::Builder.new(items: items)
+csv.cols.add('Update date') { |r| l(r.updated_at.to_date) }
+csv.cols.add('Categories') { |r| r.categories.pluck(:name).join(' ') }
+csv.cols.add('Content', :content)
+csv.build # => returns the CSV string
+
+# File.write('reports.csv', csv.build)
+```
+
+## Testing column definitions
+
+Extract the column definitions into a model method so they can be unit-tested apart from the view:
+
+```ruby
+# app/views/articles/index.csv.csb
+csv.items = @articles
+csv.cols = Article.csb_cols
+
+# app/models/article.rb
+def self.csb_cols
+  Csb::Cols.new do |cols|
+    cols.add('Update date') { |r| I18n.l(r.updated_at.to_date) }
+    cols.add('Categories') { |r| r.categories.pluck(:name).join(' ') }
+    cols.add('Title', :title)
+  end
+end
+```
+
+```ruby
+# spec/models/article_spec.rb
+require 'csb/testing' # adds col_pairs and as_table
+
+# One record, header/value pairs:
+expect(Article.csb_cols.col_pairs(article)).to eq [
+  ['Update date', '2020-01-01'],
+  ['Categories', 'test rspec'],
+  ['Title', 'Testing'],
+]
+
+# Whole table (header row + value rows):
+expect(Article.csb_cols.as_table(articles)).to eq [
+  ['Update date', 'Categories', 'Title'],
+  ['2020-01-01', 'test rspec', 'Testing'],
+  ['2020-02-01', 'rails gem', 'Rails 6.2'],
+]
+```
+
+## Configuration
+
+`config/initializers/csb.rb`:
+
+```ruby
+Csb.configure do |config|
+  config.utf8_bom = true              # default: false. Set true so Excel opens without mojibake.
+  config.streaming = false            # default: true
+  config.csv_options = { col_sep: "\t" } # default: {}
+
+  # Called when an error is raised during streaming. WITHOUT this, mid-stream
+  # errors are silently swallowed and won't reach tools like Bugsnag.
+  config.after_streaming_error = ->(error) do # default: nil
+    Rails.logger.error(error)
+    Bugsnag.notify(error)
+  end
+
+  # Error classes to ignore (not re-raise) during streaming, e.g. when the
+  # client disconnects before the download finishes.
+  config.ignore_class_names = %w[Puma::ConnectionError] # default: %w[Puma::ConnectionError]
+end
+```
+
+## Pitfalls
+
+- The view must use the `.csv.csb` extension.
+- Trigger the download with `format: :csv` (e.g. `link_to 'Download', reports_path(format: :csv)`).
+- The `cols.add` value rules: block → receives the record; `Symbol` → calls that method; `String` → literal; omitted → empty cell.
+- Streaming errors are swallowed unless you set `config.after_streaming_error` — set it if you rely on error reporting.
+- For big tables, pass `find_each` (an Enumerator), not a fully-loaded array, to keep streaming memory-safe.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: csb
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.17.0
 platform: ruby
 authors:
 - aki77
@@ -111,6 +111,7 @@ files:
 - lib/csb/template.rb
 - lib/csb/testing.rb
 - lib/csb/version.rb
+- skills/csb/SKILL.md
 homepage: https://github.com/aki77/csb
 licenses:
 - MIT