csv_rails 0.5.2 → 0.6.0

data/README.rdoc

@@ -2,6 +2,11 @@
 
 CsvRails provides a simple way of download csv in Rails 3.
 
+== Supported versions
+Ruby 1.9 (1.8 not supported)
+Rails 3
+ActiveRecord or Mongoid
+
 == Install
 
 To use CsvRails simply add the line

data/lib/csv_rails/active_model.rb

@@ -0,0 +1,44 @@
+require 'csv'
+module CsvRails
+  module ActiveModel
+    module ClassMethods
+      def to_csv(opts={})
+        fields = opts[:fields] || csv_fields
+        header = csv_header(fields, opts.delete(:i18n_scope))
+        all.to_a.to_csv(opts.update(:fields => fields, :header => header))
+      end
+
+      def csv_header(fields, scope=nil)
+        fields.map{|f|
+          if scope
+            I18n.t("#{scope}.#{f}", :default => human_attribute_name(f))
+          else
+            human_attribute_name(f)
+          end
+        }
+      end
+
+      def csv_fields
+        if self.is_a?(::ActiveRecord::Relation)
+          @klass.attribute_names
+        else
+          attribute_names
+        end
+      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 = object.respond_to?(convert_method) ? convert_method : f
+            object.send(method)
+          }
+        }
+      end
+    end
+  end
+end

data/lib/csv_rails/active_record.rb

@@ -1,48 +1,17 @@
-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 = opts[:fields] || csv_fields
-        scope = opts.delete(:i18n_scope)
-        header = fields.map{|f|
-          if scope
-            I18n.t("#{scope}.#{f}", :default => human_attribute_name(f))
-          else
-            human_attribute_name(f)
-          end
-        }
-        all.to_csv(opts.update(:fields => fields, :header => header))
-      end
-
-      def csv_fields
-        if respond_to?(:attribute_names)
-          attribute_names
-        elsif self.is_a?(::ActiveRecord::Relation)
-          @klass.new.attribute_names
-        else
-          new.attribute_names
-        end
+      base.extend(CsvRails::ActiveModel::ClassMethods)
+      base.send(:include, CsvRails::ActiveModel::InstanceMethods)
+      ::ActiveRecord::Relation.send(:include, CsvRails::ActiveModel::ClassMethods)
+      unless base.respond_to?(:attribute_names)
+        base.extend(ClassMethods) # for rails 3.0.12
       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 = object.respond_to?(convert_method) ? convert_method : f
-            object.send(method)
-          }
-        }
+    module ClassMethods
+      def attribute_names
+        column_names.map(&:to_sym)
       end
     end
   end

data/lib/csv_rails/array.rb

@@ -3,38 +3,43 @@ module CsvRails
   module Array
     def self.included(base)
       base.send(:remove_method, :to_csv)
-      base.send(:include, CsvRails::Array::InstanceMethods)
     end
 
-    module InstanceMethods
-      # ==== Options
-      # * <tt>:fields</tt> - target field names
-      # * <tt>:header</tt> - header
-      # * <tt>:without_header</tt> - total_count
-      # * <tt>:encoding</tt> - encoding
-      # * <tt>:i18n_scope</tt> - i18n scope
-      def to_csv(opts={})
-        fields = opts[:fields]
-        header = if opts[:header]
-                   opts.delete(:header)
-                 elsif (klass = first.class).respond_to?(:csv_fields)
-                   klass.csv_fields
-                 else
-                   scopes = ['csv_rails']
-                   scopes << opts[:i18n_scope] if opts[:i18n_scope]
-                   fields.map{|f|
-                     defaults = scopes.map{|s| "#{s}.#{f}".to_sym }.push(f.to_s)
-                     I18n.t(defaults.shift, :default => defaults)
-                   } if fields
-                 end
-        csv = CSV.generate do |_csv|
-          _csv << header if header && !opts[:without_header]
-          each do |element|
-            _csv << element.to_csv_ary(fields, opts)
-          end
+    # ==== Options
+    # * <tt>:fields</tt> - target field names
+    # * <tt>:header</tt> - header
+    # * <tt>:without_header</tt> - total_count
+    # * <tt>:encoding</tt> - encoding
+    # * <tt>:i18n_scope</tt> - i18n scope
+    def to_csv(opts={})
+      klass = first.class
+      fields = if opts[:fields]
+                 opts.delete(:fields)
+               elsif klass.respond_to?(:csv_fields)
+                 klass.csv_fields
+               else
+                 []
+               end
+
+      header = if opts[:header]
+                 opts.delete(:header)
+               elsif klass.respond_to?(:csv_header)
+                 klass.csv_header(fields, opts.delete(:i18n_scope))
+               else
+                 scopes = ['csv_rails']
+                 scopes << opts[:i18n_scope] if opts[:i18n_scope]
+                 fields.map{|f|
+                   defaults = scopes.map{|s| "#{s}.#{f}".to_sym }.push(f.to_s)
+                   I18n.t(defaults.shift, :default => defaults)
+                 }
+               end
+      csv = CSV.generate do |_csv|
+        _csv << header if header && !opts[:without_header]
+        each do |element|
+          _csv << element.to_csv_ary(fields, opts)
         end
-        opts[:encoding] ? csv.encode(opts[:encoding]) : csv
       end
+      opts[:encoding] ? csv.encode(opts[:encoding]) : csv
     end
   end
 end

data/lib/csv_rails/mongoid.rb

@@ -0,0 +1,17 @@
+module CsvRails
+  module Mongoid
+    def self.included(base)
+      base.send(:include, CsvRails::ActiveModel::InstanceMethods)
+      base.const_get(:ClassMethods).tap{|klass|
+        klass.send(:include, CsvRails::ActiveModel::ClassMethods)
+        klass.send(:include, ClassMethods)
+      }
+    end
+
+    module ClassMethods
+      def attribute_names
+        fields.keys.map(&:to_sym)
+      end
+    end
+  end
+end

data/lib/csv_rails/version.rb

@@ -1,3 +1,3 @@
 module CsvRails
-  VERSION = "0.5.2"
+  VERSION = "0.6.0"
 end

data/lib/csv_rails.rb

@@ -1,9 +1,18 @@
 require 'csv_rails/array'
-require 'csv_rails/active_record'
+require 'csv_rails/active_model'
 
-ActiveRecord::Base.send(:include, CsvRails::ActiveRecord)
 Array.send(:include, CsvRails::Array)
 
+if defined?(ActiveRecord)
+  require 'csv_rails/active_record'
+  ActiveRecord::Base.send(:include, CsvRails::ActiveRecord)
+end
+
+if defined?(Mongoid)
+  require 'csv_rails/mongoid'
+  Mongoid::Document.send(:include, CsvRails::Mongoid)
+end
+
 ActionController::Renderers.add :csv do |obj, options|
   filename = options[:filename] || File.basename(request.path)
   send_data obj.to_csv(options), :type => Mime::CSV,

data/test/csv_rails/active_record_test.rb

@@ -85,8 +85,8 @@ class CsvRails::ActiveRecordTest < ActiveSupport::TestCase
 
   test ".to_csv with i18n option" do
     I18n.locale = :ja
-    translated = [:id, :name].map{|f| I18n.t("csv_rails.#{f}") }.join(',')
-    assert_match /^#{translated}/, User.where('id < 1').to_csv(:i18n_scope => 'csv_rails')
+    translated = [:id].map{|f| I18n.t("csv_rails.#{f}") }.join(',')
+    assert_match /^#{translated},#{User.human_attribute_name(:name)}/, User.where('id < 1').to_csv(:i18n_scope => 'csv_rails')
     I18n.locale = :en
   end
 

data/test/csv_rails/array_test.rb

@@ -36,11 +36,17 @@ class CsvRails::ArrayTest < ActiveSupport::TestCase
 
   test ".to_csv only it includes ActiveRecord instance" do
     assert_nothing_raised do
-      [User.create(:name => 'satomicchy')].to_csv
+          assert_match /^#{I18n.t("csv_rails.id")},#{User.human_attribute_name(:name)}/, [User.create(:name => 'satomicchy')].to_csv(:i18n_scope => 'csv_rails')
     end
   end
 
   test ".to_csv using empty array" do
-    assert_equal "", [].to_csv
+    assert_equal "\n", [].to_csv
+  end
+
+  test ".to_csv only it includes Mongoid instance" do
+    post = Post.create(:title => 'this is csv_rails', :body => "line\nline\nline\n")
+
+    assert_equal " type,\"\",タイトル,本文\n#{post._type},#{post._id},#{post.title},\"#{post.body}\"\n", [post].to_csv
   end
 end

data/test/csv_rails/mongoid_test.rb

@@ -0,0 +1,21 @@
+# -*- coding: utf-8 -*-
+require 'test_helper'
+
+class CsvRails::MongoidTest < ActiveSupport::TestCase
+  setup do
+    Post.create(:title => 'title', :body => "foobar") if Post.where(:title => 'title').length < 1
+  end
+
+  teardown do
+    I18n.locale = :en
+  end
+
+  test ".to_csv" do
+    assert_equal "Title,Body\ntitle,foobar\n", Post.where(:title => 'title').to_csv(:fields => [:title, :body])
+  end
+
+  test ".to_csv with ja locale" do
+    I18n.locale = :ja
+    assert_equal "タイトル,本文\ntitle,foobar\n", Post.where(:title => 'title').to_csv(:fields => [:title, :body])
+  end
+end

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

@@ -0,0 +1,5 @@
+class Post
+  include Mongoid::Document
+  field :title, type: String
+  field :body,  type: String
+end

data/test/dummy/config/application.rb

@@ -1,6 +1,7 @@
 require File.expand_path('../boot', __FILE__)
 
 require 'rails/all'
+require 'mongoid'
 
 Bundler.require
 require "csv_rails"

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

@@ -1,7 +1,6 @@
 ja:
   csv_rails:
     id: あいでぃー
-    name: なまえ
   activerecord:
     attributes:
       group: &groupmodel
@@ -18,3 +17,8 @@ ja:
       user/groups:
         first:
           <<: *groupmodel
+  mongoid:
+    attributes:
+      post:
+        title: タイトル
+        body: 本文

data/test/dummy/config/mongoid.yml

@@ -0,0 +1,7 @@
+development: &dev
+  host: localhost
+  database: csv_rails
+
+test:
+  <<: *dev
+