arydjmal / to_csv

This Rails plugin gives you the ability to call to_csv to a collection of activerecords (Array). The builder options are the same as to_json / to_xml, except for the :include.

This URL has Read+Write access

to_csv /
name age message
file MIT-LICENSE Wed Jun 11 12:46:07 -0700 2008 first commit [arydjmal]
file README.rdoc Tue Dec 23 14:04:46 -0800 2008 removed ability to call methods of associations... [arydjmal]
file init.rb Tue Jul 29 14:02:13 -0700 2008 changed csv library to fastercsv, compatible wi... [arydjmal]
directory lib/ Thu Jul 30 07:31:39 -0700 2009 changed the old to_a to Array() due to deprecat... [bastien]
directory test/ Mon Feb 16 10:23:08 -0800 2009 user object#attributes instead of class#columns [Ary Djmal]
README.rdoc

to_csv plugin

This simple plugin gives you the ability to call to_csv to a collection of activerecords. The builder options are the same as to_json / to_xml, except for the :include.

Usage

  @users = User.all

  #
  # defaults are export headers and all fields
  #

  @users.to_csv
  @users.to_csv(:only => [:last_name, :role])
  @users.to_csv(:headers => false)
  @users.to_csv(:except => [:last_name, :role])
  @users.to_csv(:except => :role, :methods => :admin?)

Real life example

In the controller where you want to export to csv, add the format.csv line (as of rails 2.1 it is not necessary to register the csv myme_type)

        class UserController < ApplicationController

                def index
                        @users = User.all

                        respond_to do |format|
                                format.html
                                format.xml { render :xml => @users }
                                format.csv { send_data @users.to_csv }
                        end
                end

                def show...
                def new...
                def edit...
                def create...
                def update...
                def destroy...

        end

Dependencies

        sudo gem install fastercsv

Install

        ./script/plugin install git://github.com/arydjmal/to_csv.git

Ideas

I got ideas and influence from Mike Clarks recipe #35 in Rails Recipes book, some anonymous pastie, and whoever wrote to_xml/to_json builders.

Note

Does not work on a single activerecord, ie, User.first.to_csv.

Copyright © 2008 Ary Djmal, released under the MIT license