csv_rails 0.4.1 → 0.5.0

data/README.rdoc

@@ -21,19 +21,63 @@ to your Gemfile and then run
         respond_to do |format|
           format.html { @users = @users.all }
           format.json { render json: @users }
-          format.csv{ render csv: @users, :fields => [:id, :name, :age], :encoding => 'SJIS' }
+          format.csv{ render csv: @users, fields: [:id, :name, :age], encoding: 'SJIS', without_header: true }
         end
       end
 
 
 == Usage
 
-If you want formatted created_at in the csv you should write like this
+If you want formatted attribute, CsvRails call "#{attribute}_as_csv". For example, you wish formatted created_at then you write like this. 
 
     class User < ActiveRecord::Base
       def created_at_as_csv
         created_at.strftime("%F %H:%M")
       end
     end
-    
+
+CsvRails define a singleton method Array.to_csv, and the method accept fields option. The fields option can not only database fields also method and method chain.
+
+    class User < ActiveRecord::Base
+      has_many :memberships
+      has_many :groups, through: :memberships
+
+      def ok
+        "OK"
+      end
+    end
+
+    class UsersController < ApplicationController
+      def index
+        @users = User.all
+
+        respond_to do |format|
+          format.csv{ render csv: @users, fields: [:ok, :"groups.first.name"], encoding: 'SJIS' }
+        end
+      end
+
+If you do not use :header option, header is using :fields and I18n transfer.
+    # config/locales/ja.yml
+    ja:
+      activerecord:
+        attributes:
+          group: &groupmodel
+            name: グループ名
+          user:
+            id: ID
+            name: 名前
+            age: 年齢
+            ok: OK
+            groups:
+              first:
+                <<: *groupmodel
+
+    # app/controllers/user_controller.rb
+    def index
+      @users = User.where("id < 1").all
+      respond_to do |format|
+        format.csv{ render csv: @users, fields: [:ok, :"groups.first.name"], encoding: 'SJIS' } #=> "OK,グループ名"
+      end
+    end
+
 Copyright (c) 2012 yalab, released under the MIT license

data/lib/csv_rails/active_record.rb

@@ -0,0 +1,44 @@
+require 'csv'
+module CsvRails
+  module ActiveRecord
+    def self.included(base)
+      base.extend ClassMethods
+      ::ActiveRecord::Relation.send(:include, ClassMethods)
+      base.send(:include, InstanceMethods)
+    end
+
+    module ClassMethods
+      def to_csv(opts={})
+        fields = if opts[:fields]
+                   opts.delete(:fields)
+                 elsif respond_to?(:attribute_names)
+                   attribute_names
+                 elsif self.is_a?(::ActiveRecord::Relation)
+                   @klass.new.attribute_names
+                 else
+                   new.attribute_names
+                 end
+        header = fields.map{|f| human_attribute_name(f) }
+        all.to_csv(opts.update(:fields => fields, :header => header))
+      end
+
+      def csv_header(names)
+        names.map{|n| human_attribute_name(n) }
+      end
+    end
+
+    module InstanceMethods
+      def to_csv_ary(fields=nil, opts={})
+        fields = attribute_names unless fields
+        fields.map{|field|
+          field.to_s.split(".").inject(self){|object, f|
+            next unless object
+            convert_method = "#{f}_as_csv"
+            method = respond_to?(convert_method) ? convert_method : f
+            object.send(f)
+          }
+        }
+      end
+    end
+  end
+end

data/lib/csv_rails/array.rb

@@ -7,20 +7,24 @@ module CsvRails
     end
 
     module InstanceMethods
+      # ==== Options
+      # * <tt>:fields</tt> - target field names
+      # * <tt>:header</tt> - header
+      # * <tt>:without_header</tt> - total_count
+      # * <tt>:encoding</tt> - encoding
       def to_csv(opts={})
-        return "" if length < 1
-        first = self.first
-        fields = opts.delete(:fields) || first.class.attribute_names
+        fields = opts[:fields]
+        header = if opts[:header]
+                   opts.delete(:header)
+                 elsif (klass = first.class).respond_to?(:csv_header)
+                   klass.csv_header(fields)
+                 else
+                   fields
+                 end
         csv = CSV.generate do |_csv|
-          unless opts[:without_header]
-            _csv << if first.class.respond_to?(:human_attribute_name)
-                     fields.map{|f| first.class.human_attribute_name(f) }
-                   else
-                     fields
-                   end
-          end
+          _csv << header unless opts[:without_header]
           each do |element|
-             _csv << element.to_csv_ary(fields, opts)
+            _csv << element.to_csv_ary(fields, opts)
           end
         end
         opts[:encoding] ? csv.encode(opts[:encoding]) : csv

data/lib/csv_rails/version.rb

@@ -1,3 +1,3 @@
 module CsvRails
-  VERSION = "0.4.1"
+  VERSION = "0.5.0"
 end

data/lib/csv_rails.rb

@@ -1,6 +1,7 @@
-require File.expand_path('../active_record/acts/csv', __FILE__)
-require File.expand_path('../csv_rails/array', __FILE__)
-ActiveRecord::Base.send(:include, ActiveRecord::Acts::Csv)
+require 'csv_rails/array'
+require 'csv_rails/active_record'
+
+ActiveRecord::Base.send(:include, CsvRails::ActiveRecord)
 Array.send(:include, CsvRails::Array)
 
 ActionController::Renderers.add :csv do |obj, options|

data/test/csv_rails/active_record_test.rb

@@ -0,0 +1,91 @@
+# -*- coding: utf-8 -*-
+require 'test_helper'
+class CsvRails::ActiveRecordTest < ActiveSupport::TestCase
+  setup do
+    @user = User.create(:name => 'yalab', :age => '29', :secret => 'password')
+    @group = Group.create(:name => 'ruby')
+    @user.groups << @group
+  end
+
+  test "#to_csv_ary without params" do
+    assert_equal @user.attributes.length, @user.to_csv_ary.length
+    assert_equal @user.attributes.values[0..-2], @user.to_csv_ary[0..-2]
+  end
+
+  test "#to_csv_ary with field params" do
+    fields = [:name, :age]
+    assert_equal fields.map{|f| @user[f] }, @user.to_csv_ary(fields)
+  end
+
+  test "#to_csv_ary use method not a database field" do
+    assert_equal [@user.one], @user.to_csv_ary([:one])
+  end
+
+  test "#to_csv_ary can use association" do
+    assert_equal [@user.name, @group.name], @user.memberships.first.to_csv_ary([:"user.name", :"group.name"])
+  end
+
+  test "#to_csv_ary ignore empty association" do
+    name = 'noman'
+    assert_equal [name, nil], User.new(:name => 'noman').to_csv_ary([:name, :"groups.first.name"])
+  end
+
+  test "#updated_at_as_csv" do
+    assert_equal @user.updated_at.strftime("%F %H:%M"), @user.updated_at_as_csv
+  end
+
+  test ".to_csv without params" do
+    csv = CSV.parse(User.to_csv)
+    header = csv.first.map{|f| f.downcase.tr(' ', '_') }
+    header.delete("updated_at")
+    line = csv.last
+    header.each.with_index do |field, index|
+      assert_equal @user[field].to_s, line[index]
+    end
+  end
+
+  test ".to_csv can use fields option" do
+    fields = [:id, :name]
+    row = CSV.parse(User.to_csv(:fields => fields)).last
+    assert_equal fields.map{|f| @user[f].to_s }, row
+  end
+
+  test ".to_csv without_header" do
+    fields = [:id, :name]
+    row = CSV.parse(User.to_csv(:fields => fields, :without_header => true)).first
+    assert_not_equal fields.map{|f| User.human_attribute_name(f) }, row
+  end
+
+  test ".to_csv header use human_attribute_name" do
+    fields = [:id, :name, :one]
+    header = CSV.parse(User.to_csv(:fields => fields)).first
+    assert_equal fields.map{|f| User.human_attribute_name(f) }, header
+  end
+
+  test ".to_csv with scoped" do
+    User.create(:name => 'atsushi', :age => 45, :secret => 'none')
+    assert_equal 1, CSV.parse(User.where("age > 39").to_csv(:without_header => true)).length
+  end
+
+  test ".to_csv accept encoding" do
+    I18n.locale = :ja
+    assert_equal "名前".encode('SJIS'), CSV.parse(User.to_csv(:fields => [:name], :encoding => 'SJIS')).first.first
+    I18n.locale = :en
+  end
+
+  test ".csv_header with association" do
+    I18n.locale = :ja
+    assert_equal [User.human_attribute_name(:name), Group.human_attribute_name(:name)], User.csv_header([:name, :"groups.first.name"])
+    I18n.locale = :en
+  end
+
+  test ".to_csv with association" do
+    I18n.locale = :ja
+    csv =<<-EOS.gsub(/^\s+/, '')
+      #{User.human_attribute_name(:name)},#{Group.human_attribute_name(:name)}
+      #{@user.name},#{@group.name}
+    EOS
+    assert_equal csv, User.includes(:groups).to_csv(:fields => [:name, :"groups.first.name"])
+    I18n.locale = :en
+  end
+end

data/test/csv_rails/array_test.rb

@@ -0,0 +1,14 @@
+# -*- coding: utf-8 -*-
+require 'test_helper'
+
+class CsvRails::ArrayTest < ActiveSupport::TestCase
+  test ".to_csv with header option" do
+    header = ['foo', 'bar']
+    assert_equal  header.join(','), [].to_csv(:header => header).chomp
+  end
+
+  test ".to_csv accept encoding" do
+    name = "名前"
+    assert_equal name.encode('SJIS'), [].to_csv(:header => [name], :encoding => 'SJIS').chomp
+  end
+end

data/test/dummy/app/controllers/users_controller.rb

@@ -1,17 +1,17 @@
 class UsersController < ApplicationController
   def index
-    @users = User
+    @users = User.includes(:groups)
     respond_to do |format|
       format.html
-      format.csv { render csv: @users, fields: [:id, :name, :age] }
+      format.csv { render csv: @users, fields: [:id, :name, :age, :"groups.first.name"], without_header: true }
     end
   end
 
   def sjis
-    @users = User.all
+    @users = User.includes(:groups).all
     respond_to do |format|
       format.html
-      format.csv { render csv: @users, fields: [:id, :name, :age], :encoding => 'SJIS'}
+      format.csv { render csv: @users, fields: [:id, :name, :age, :"groups.first.name"], encoding: 'SJIS' }
     end
   end
 end

data/test/dummy/app/models/group.rb

@@ -0,0 +1,4 @@
+class Group < ActiveRecord::Base
+  has_many :memberships
+  has_many :users, through: :memberships
+end

data/test/dummy/app/models/membership.rb

@@ -0,0 +1,4 @@
+class Membership < ActiveRecord::Base
+  belongs_to :user
+  belongs_to :group
+end

data/test/dummy/app/models/user.rb

@@ -1,4 +1,7 @@
 class User < ActiveRecord::Base
+  has_many :memberships
+  has_many :groups, through: :memberships
+
   def updated_at_as_csv
     self.updated_at.strftime("%F %H:%M")
   end

data/test/dummy/config/application.rb

@@ -27,7 +27,7 @@ module Dummy
 
     # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
     # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
-    # config.i18n.default_locale = :de
+    config.i18n.default_locale = :ja
 
     # Configure the default encoding used in templates for Ruby 1.9.
     config.encoding = "utf-8"

data/test/dummy/config/locales/ja.yml

@@ -1,7 +1,12 @@
 ja:
   activerecord:
     attributes:
+      group: &groupmodel
+        name: グループ名
       user:
         id: ID
         name: 名前
         age: 年齢
+        groups:
+          first:
+            <<: *groupmodel

data/test/dummy/db/migrate/20120328072253_create_groups.rb

@@ -0,0 +1,13 @@
+class CreateGroups < ActiveRecord::Migration
+  def self.up
+    create_table :groups do |t|
+      t.string :name
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :groups
+  end
+end

data/test/dummy/db/migrate/20120328072740_create_memberships.rb

@@ -0,0 +1,14 @@
+class CreateMemberships < ActiveRecord::Migration
+  def self.up
+    create_table :memberships do |t|
+      t.references :user
+      t.references :group
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :memberships
+  end
+end

data/test/dummy/db/schema.rb

@@ -11,7 +11,20 @@
 #
 # It's strongly recommended to check this file into your version control system.
 
-ActiveRecord::Schema.define(:version => 20120323112247) do
+ActiveRecord::Schema.define(:version => 20120328072740) do
+
+  create_table "groups", :force => true do |t|
+    t.string   "name"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "memberships", :force => true do |t|
+    t.integer  "user_id"
+    t.integer  "group_id"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
 
   create_table "users", :force => true do |t|
     t.string   "name"