to_csv_rails 0.1 → 0.2

data/README.md

@@ -0,0 +1,61 @@
+to\_csv\_rails
+============
+
+to\_csv\_rails implements a to_csv method on your Arrays. It makes exporting records to csv a simple task, even when using responders.
+
+## Installation
+
+Simply add this to your Gemfile:
+
+    gem 'to_csv_rails'
+
+Them run:
+
+    bundle install
+
+## Usage
+
+Considering that you have a model called User. Here are some examples.
+
+### Exporting all fields
+
+    User.all.to_csv
+
+### Exporting only id and name
+
+    User.all.to_csv(:only => [:id, :name])
+
+### Exporting everything except id
+
+    User.all.to_csv(:except => [:id])
+
+### Adding headers
+
+    User.all.to_csv(:headers => [:id, :name])
+
+## Usage with responders
+
+On a Rails application it's very common to use responders when you want to display the same data but with a different format.
+
+Considering again that your model is User and that you have a controller called UsersController generated by scaffold. Change:
+
+    def index
+      @users = User.all
+
+      respond_to do |format|
+        format.html # index.html.erb
+        format.json { render json: @users }
+      end
+    end
+
+To:
+
+    def index
+      @users = User.all
+
+      respond_to do |format|
+        format.html # index.html.erb
+        format.json { render json: @users }
+        format.csv { render csv: @users }
+      end
+    end    

data/lib/to_csv_rails.rb

@@ -14,4 +14,11 @@ else
 end
 
 require "to_csv_rails/version"
-require "to_csv_rails/array.rb"
+require "to_csv_rails/array.rb"
+
+if defined?(ActionController::Renderers) && ActionController::Renderers.respond_to?(:add)
+  ActionController::Renderers.add :csv do |csv, options|
+    self.content_type ||= Mime::CSV
+    self.response_body = csv.respond_to?(:to_csv) ? csv.to_csv : csv
+  end
+end

data/lib/to_csv_rails/version.rb

@@ -1,3 +1,3 @@
 module ToCsvRails
-  VERSION = "0.1"
+  VERSION = "0.2"
 end

data/test/test_csv.rb

@@ -11,14 +11,14 @@ class CsvTest < Test::Unit::TestCase
 
     data = User.all
     
-    assert_equal data.to_csv_rails,
+    assert_equal data.to_csv,
       "#{user1.id},User 1,user1@email.com\n#{user2.id},User 2,user2@email.com\n"
   end
 
   def test_export_with_empty_data
     data = User.all
 
-    assert_equal data.to_csv_rails,
+    assert_equal data.to_csv,
       ""
   end
 
@@ -28,7 +28,7 @@ class CsvTest < Test::Unit::TestCase
 
     data = User.all
 
-    assert_equal data.to_csv_rails(:only => [:name]),
+    assert_equal data.to_csv(:only => [:name]),
       "User 1\nUser 2\n"
   end
 
@@ -38,7 +38,7 @@ class CsvTest < Test::Unit::TestCase
 
     data = User.all
 
-    assert_equal data.to_csv_rails(:except => [:id, :name]),
+    assert_equal data.to_csv(:except => [:id, :name]),
       "user1@email.com\nuser2@email.com\n"
   end
 
@@ -48,7 +48,7 @@ class CsvTest < Test::Unit::TestCase
 
     data = User.all
 
-    assert_equal data.to_csv_rails(:headers => [:id, :name, :email]),
+    assert_equal data.to_csv(:headers => [:id, :name, :email]),
       "id,name,email\n#{user1.id},User 1,user1@email.com\n#{user2.id},User 2,user2@email.com\n"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: to_csv_rails
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.2'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-29 00:00:00.000000000 Z
+date: 2012-12-30 00:00:00.000000000 Z
 dependencies: []
 description: An to_csv implementation focused on making it easier for Rails developers
   to export data to CSV format.
@@ -23,9 +23,9 @@ files:
 - lib/to_csv_rails/version.rb
 - lib/to_csv_rails.rb
 - Rakefile
+- README.md
 - test/test_csv.rb
 - test/test_helper.rb
-- to_csv_rails-0.1.gem
 - to_csv_rails.gemspec
 homepage: http://fernandomarcelo.com/
 licenses: []