CSV renderer for Rails 3 and 4
Ruby Logos
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
gemfiles
lib
spec
.gitignore
.rspec
.travis.yml
CHANGELOG.md
CONTRIBUTING.md
Gemfile
LICENSE.txt
README.md
Rakefile
render_csv.gemspec

README.md

render_csv

Build Status Gem Version Code Climate Dependency Status

Rails CSV renderer for ActiveRecord collections

Project Status - May 2015

I am no longer maintaining this project. I have not been able to get it working predictably in newer versions of Rails or in production environments. If you want to add CSV rendering support to your Rails application, I do not recommend installing this gem.

Rails & Ruby Versions Supported

Rails: 3.0.x - 4.0.x

Ruby: 1.9.3, 2.0.0 and 2.1.0

Installation

The gem is hosted at rubygems.org

What is it?

The CSV renderer allows you to render any collection as CSV data.

class LocationsController < ApplicationController
  def index
    @locations = Location.all

    respond_to do |format|
      format.csv  { render csv: @locations }
    end
  end
end

Will render a CSV file similar to:

nameaddresscitystatezipcreated_atupdated_at
Pete's House555 House LnBurlingtonVT054012011-07-26 03:12:44 UTC2011-07-26 03:12:44 UTC
Sebastians's House123 Pup StBurlingtonVT054012011-07-26 03:30:44 UTC2011-07-26 03:30:44 UTC
Someone Else999 Herp DerpBurlingtonVT054012011-07-26 03:30:44 UTC2011-07-26 03:30:44 UTC

Usage Options

There are a few options you can use to customize which columns are included in the CSV file

Exclude columns

respond_to do |format|
  format.csv  { render csv: @locations, except: [:id] }
end

Limit columns

respond_to do |format|
  format.csv  { render csv: @locations, only: [:address, :zip] }
end

Add methods as columns

respond_to do |format|
  format.csv  { render csv: @locations, add_methods: [:method1, :method2] }
end

Add methods as columns and exclude columns

respond_to do |format|
  format.csv  { render csv: @locations, except: [:id], add_methods: [:method1, :method2] }
end

Copyright

Copyright © 2011-2014 Peter Brown. See LICENSE.txt for further details.