Railsのcsvダウンロードで直面する数々の問題を解決したらgemができた 〜csb gemの紹介〜

class PostsController < ApplicationController
  def index
    @posts = Post.all
  end
end

require 'csv'

CSV.generate do |csv|
  column_names = %w[投稿日 カテゴリ タイトル 本文]
  csv << column_names
  @posts.each do |post|
    column_values = [
      l(post.created_at.to_date),
      post.category.name,
      post.title,
      post.content,
    ]
    csv << column_values
  end
end

gem 'csb'

$ bundle install

= link_to 'CSVダウンロード', posts_path(format: :csv)

def index
  @posts = Post.preload(:category)
end

# csv.itemsにレコードを入れます（each可能であればActiveRecord::Relation以外のオブジェクトを入れることも出来ます）
csv.items = @posts

# 以下で各カラムを定義しています
csv.cols.add('投稿日') { |post| l(post.created_at.to_date) } # ブロックの場合引数にはレコードが渡ってきます
csv.cols.add('カテゴリー') { |post| post.category.name }
csv.cols.add('タイトル', :title) # 単純なメソッド呼び出しだけの場合はシンボルで書けます
csv.cols.add('本文', :content)

csv.items = @posts.find_each
csv.cols.add('投稿日') { |post| l(post.created_at.to_date) }
csv.cols.add('カテゴリー') { |post| post.category.name }
csv.cols.add('タイトル', :title)
csv.cols.add('本文', :content)

csv.items = @posts.find_each.lazy.map(&:decorate)
csv.cols.add('投稿日') { |post| l(post.created_at.to_date) }
csv.cols.add('カテゴリー') { |post| post.category.name }
csv.cols.add('タイトル', :decorated_title)
csv.cols.add('本文', :content)

csv.items = @posts
csv.cols.add('固定文字列', 'Dummy') # 第二引数をシンボルではなく文字列にするとそのまま文字列として出力されます。
csv.cols.add('空文字列') # 第二引数を省略すると空文字となります。`csv.cols.add('空文字列', '')` と書くのと同じ。
csv.cols.add('複数カラム', :col1) # 同名カラムを複数定義することも可能です。（定義順に出力されます）
csv.cols.add('複数カラム', :col2)

Csb.configure do |config|
  config.utf8_bom = true # default: false
end

csv.items = @posts
csv.filename = "posts_#{Time.current.to_i}.csv"

# ...

csv = Csb::Builder.new(items: posts)
csv.cols.add('投稿日') { |post| l(post.created_at.to_date) }
csv.cols.add('カテゴリー') { |post| post.category.name }
csv.cols.add('タイトル', :decorated_title)
csv.cols.add('本文', :content)
IO.write('posts.csv', csv.build) # csv.buildでcsv文字列が生成されます

def self.csb_cols
  Csb::Cols.new do |cols|
    cols.add('タイトル', :title)
    cols.add('本文', :content)
    cols.add('画像') { |post| post.image&.url }
  end
end

csv.items = @posts
csv.cols = Post.csb_cols

# requireすることでcol_pairs, as_tableメソッドが追加で定義されます
require 'csb/testing'

# 行単位でのテスト
context '画像が添付されている場合' do
  let(:image) { build(:image, url: 'https://example.test/example.jpg') }
  let(:post) { build(:post, title: 'Testing', content: 'hogehoge', image: image) }

  it '画像カラムにURLが出力されること' do
    expect(Post.csb_cols.col_pairs(post)).to eq [
      ['タイトル', 'Testing'],
      ['本文', 'hogehoge'],
      ['画像', 'https://example.test/example.jpg'],
    ]
  end
end

context '画像が添付されていない場合' do
  let(:post) { build(:post, title: 'Testing', content: 'hogehoge', image: nil) }

  it '画像カラムが空となること' do
    expect(Post.csb_cols.col_pairs(post)).to eq [
      ['タイトル', 'Testing'],
      ['本文', 'hogehoge'],
      ['画像', ''],
    ]
  end
end

# csv全体でのテスト
describe '.csb_cols' do
  let(:image) { build(:image, url: 'https://example.test/example.jpg') }
  let(:items) do
    [
      build(:post, title: 'Testing1', content: 'hogehoge', image: image),
      build(:post, title: 'Testing2', content: 'fugafuga', image: nil),
    ]
  end

  it '画像有無に関係なくcsv出力されること' do
    expect(Post.csb_cols.as_table(items)).to eq [
      ['タイトル', '本文', '画像'],
      ['Testing1', 'hogehoge', 'https://example.test/example.jpg'],
      ['Testing2', 'fugafuga', nil]
    ]
  end
end

Csb.configure do |config|
  # デフォルトはfalseとなっているので注意してください。
  config.utf8_bom = true # default: false

  # 基本はデフォルトのままtrueでいいかと思いますが、大量データ配信が一切不要の場合はfalseとするほうがviewで発生するエラーに気付きやすいです。
  config.streaming = false # default: true

  # 何も設定しない場合、Bugsnag等のエラー検知ツールを入れていたとしてもストリーミング配信中のエラーは通知されないので注意が必要です。
  config.after_streaming_error = ->(error) do # default: nil
    Rails.logger.error(error)
    Bugsnag.notify(error)
  end
end