active_export 0.1.0 → 0.2.0

data/README.md

@@ -1,19 +1,44 @@
 # ActiveExport
 
-Export to csv from ActiveRecord or others
+ActiveExport generate from ActiveRecord or others to CSV String or CSV file.
 
-You do not need to write the dirty code to output the csv in your controller, model or others.
+You can write the logic of generating CSV to a YAML file.
 
-In your controller:
+Another Support:
+
+  * csv label adapt i18n.
+  * when the value of csv data is null or blank or true or false, change another label<br>
+  ex) nil to '', blank to 'empty', true to 'Yes', false to 'No'<br>
+
+Example:
 
 ````ruby
-ActiveExport::Csv.export(Book.all, source_name, namespace)
+ActiveExport::Csv.export(Book.scoped, source_name, namespace)
+````
+
+YAML file
+<pre>
+namespace:
+  label_prefix: 'book'
+  methods:
+    - name
+    - author.name
+    - price: '(price * 1.095).ceil.to_i'
+    - created_at.strftime('%Y-%m-%d')
+</pre>
+
+Write the same way without the ActiveExport:
 
-# it means
+````ruby
 CSV.generate do |csv|
   csv << ['Title', 'Author', 'Price(in Tax)', 'Published Date']
     Book.all.each do |book|
-      csv << [book.name, (book.author.try(:name) || ''), book.price, book.created_at.strftime('%Y%m%d')]
+      csv_data = []
+      csv_data << book.name.blank? ? '' : book.name
+      csv_data << book.author ? book.author.name : ''
+      csv_data << (book.price * 1.095).ceil.to_i
+      csv_data << book.created_at.blank? ? '' : book.created_at.strftime('%Y-%m-%d')
+      csv << csv_data
     end
   end
 end
@@ -37,106 +62,68 @@ Or install it yourself as:
 
 Add initalizers `active_export.rb`
 
-Create `active_export.yml` And write csv export method
-
-[YAML file format][yaml-file-format]
+    touch config/initializers/active_export.rb
 
-Use `ActiveExport::Csv.export(data, source_name, namespace)` in your controller or others.
-
-## Example
-
-ActiveRecord:
+Write configuration code to `active_export.rb`
 
 ````ruby
-class Book < ActiveRecord::Base
-  belongs_to :author
-end
-
-class Author < ActiveRecord::Base
+ActiveExportconfigure do |config|
+  config.sources = { default: Rails.root.join('config', 'active_export.yml') }
+  # config.default_csv_optoins = { col_sep: ',', row_sep: "\n", force_quotes: true }
+  # config.default_find_in_batches_options = {} # default
+  # config.default_value_label_scope = [:default_value_labels] # default
+  # config.always_reload = false # default
+  # config.no_source_raise_error = false # default
 end
 ````
 
-Book records:
-
-| id | name | author_id | price | created_at |
-|:--:|:----:|:---------:|:-----:|:----------:|
-|  1 | Ruby |         1 |    50 | 2012/08/01 00:00:00 UTC |
-|  2 | Java |         2 |    30 | 2012/08/02 00:00:00 UTC |
-
-Author records:
+Create `active_export.yml` And write csv export method
 
-| id |  name |
-|:--:|:-----:|
-|  1 |   Bob |
-|  2 | Alice |
+    touch config/active_export.yml
 
-`en.yml`:
+Write Csv generate logic to `active_export.yml`
 
 <pre>
-activerecord:
-  attributes:
-    book:
-      name: 'Title'
-      price: 'Price(in Tax)'
-      created_at: 'Published Date'
-    author:
-      name: 'Author'
+namespace_1:
+  label_prefix: 'book'
+  methods:
+    - method
+    - method
+    ...
+namespace_2:
+  label_prefix: ...
+  ...
 </pre>
 
-`config/initializers/active_export.rb`:
+Call Export method
 
-````ruby
-ActiveExportconfigure do |config|
-  config.sources = { default: Rails.root.join('config', 'active_export.yml') }
-  ## option fields
-  # config.default_csv_optoins = { col_sep: ',', row_sep: "\n", force_quotes: true }
-  # config.always_reload = false # default
-  # config.no_source_raise_error = false # default
-end
-````
+    ActiveExport::Csv.export(Book.scoped, :default, :namespace_1)
+    ActiveExport::Csv.export_file(Book.scoped, :default, :namespace_1, filename)
 
-`config/active_export.yml`:
+## ActiveExport::Csv
 
-````
-book:
-  label_prefix: 'book'
-  methods:
-    - name
-    - author.name
-    - price
-    - created_at: creaetd_at.strftime('%Y/%m/%d')
-````
+Support 2 methods:
 
-In your controller or others:
+  * `export(data, source_name, namespace, options = {})` ... Generate Csv string
+  * `export_file(data, source_name, namespace, filename, options = {})` ... Generate Csv file
 
-````ruby
-ActiveExport::Csv.export(Book.all, :default, :book)
-# => CSV string
-# "Title","Author","Price(in Tax)","Published Date"
-# "Ruby","Bob","50","2012/08/01"
-# "Java","Alice","20","2012/08/02"
-````
+options:
+
+  * `:eval_methods` ... override export method from YAML file.
+  * `:label_keys` ... override csv header label from YAML file.
+  * `:label_prefix` ... override csv header label prefix from YAML file.
+  * `:csv_options` ... Csv generate options.
+  * `:header` ... false to not export Csv header labels.
 
 ## YAML file format
 
-```
-[namespace]:
-  label_prefix: [label_prefix]
+<pre>
+namespace:
+  label_prefix: label_prefix
   methods:
-    - [method_name]
-    - [label_name]: [method_name]
-    - ...
-```
-
-### Method_name examples
-
-```
-book:
-  - "author.name" # call [instance].author.name
-  - "price > 0" # call [instance].price > 0 # => true or false
-  - "price.to_f / 2.0" # call [instance].price.to_f / 2.0
-  - "sprintf("%#b", price)" # call sprintf("%#b", [instance].price)
-```
+    - method_name
+    - label_name: method_name
+</pre>
 
 ### I18n field priority
 
@@ -165,12 +152,23 @@ label_prefix ... "book"
 source_name ... "default"
 namespace ... "book_1"
 
-1. "active_export.default.book_1.book_name"
-2. "activerecord.attributes.book.name"
-3. "activemode.attributes.book.name"
-4. "book_name".humanize # => Book name
+1. `active_export.default.book_1.book_name`
+2. `activerecord.attributes.book.name`
+3. `activemode.attributes.book.name`
+4. `book_name`.humanize # => Book name
 </pre>
 
+
+### methods examples
+
+```
+book:
+  - "author.name" # call [instance].author.name
+  - "price > 0" # call [instance].price > 0 # => true or false
+  - "price.to_f / 2.0" # call [instance].price.to_f / 2.0
+  - "sprintf("%#b", price)" # call sprintf("%#b", [instance].price)
+```
+
 ## Contributing
 
 1. Fork it

data/lib/active_export/base.rb

@@ -5,15 +5,16 @@ require 'active_support'
 
 module ActiveExport
   class Base
-    attr_accessor :source_name, :namespace, :label_prefix, :source, :label_keys, :eval_methods
+    attr_accessor :source_name, :namespace, :label_prefix, :source, :label_keys, :eval_methods, :options
     attr_reader :config
     def initialize(source_name, namespace, options = {})
       @source_name = source_name.to_sym
       @namespace = namespace.to_sym
       @config = ::ActiveExport.configuration
-      @label_keys = options.has_key?(:label_keys) ? options[:label_keys] : nil
-      @eval_methods = options.has_key?(:eval_methods) ? options[:eval_methods] : nil
-      @label_prefix = options.has_key?(:label_prefix) ? options[:label_prefix] : nil
+      @label_keys = options.has_key?(:label_keys) ? options.delete(:label_keys) : nil
+      @eval_methods = options.has_key?(:eval_methods) ? options.delete(:eval_methods) : nil
+      @label_prefix = options.has_key?(:label_prefix) ? options.delete(:label_prefix) : nil
+      @options = options
     end
 
     class << self
@@ -90,7 +91,7 @@ module ActiveExport
     def source
       @source ||= ::ActiveExport[self.source_name][self.namespace]
     rescue => e
-      raise e if config.no_source_raise_error = true
+      raise e if self.config.no_source_raise_error
       return {}
     end
 

data/lib/active_export/configuration.rb

@@ -2,10 +2,17 @@
 
 module ActiveExport
   class Configuration
+    # YAML file list
     attr_accessor :sources
+    # Default options export CSV
     attr_accessor :default_csv_options
+    # Default options using `find_in_batches`
+    attr_accessor :default_find_in_batches_options
+    # Set true, no cached YAML file data
     attr_accessor :always_reload
+    # Export data default labels when value is nil or blank or true or false
     attr_accessor :default_value_label_scope
+    # Set true, if selected source file does not exists, ActiveExport raise error
     attr_accessor :no_source_raise_error
 
     def initialize
@@ -14,6 +21,7 @@ module ActiveExport
       @always_reload = false
       @default_value_label_scope = [:default_value_labels]
       @no_source_raise_error = false
+      @default_find_in_batches_options = {}
     end
   end
 end

data/lib/active_export/csv.rb

@@ -4,6 +4,7 @@ require 'csv'
 
 module ActiveExport
   class Csv < ::ActiveExport::Base
+    # Generate Csv String
     # @param [Array, ActiveRecord::Relation] data
     # @param [Symbol, String] source
     # @param [Symobl, String] namespace
@@ -12,26 +13,54 @@ module ActiveExport
     # @option options [Array] :label_keys
     # @option options [String] :label_prefix
     # @option options [Hash] :csv_options (see http://ruby-doc.org/stdlib-1.9.2/libdoc/csv/rdoc/CSV.html)
+    # @return [String] Csv String
     # @exmaple
     #   AcriveExport::Csv.export(data, :source, :namespace)
     def self.export(data, source, namespace, options = {})
-      new(source, namespace, options).export(data, options)
+      new(source, namespace, options).export(data)
     end
 
-    def export(data, options = {})
-      return '' if data.length <= 0 && eval_methods.nil?
-      csv_options = self.config.default_csv_options.merge( options[:csv_options] || {} )
+    # Generate Csv File
+    # @param [Array, ActiveRecord::Relation] data
+    # @param [Symbol, String] source YAML File alias name (see ActiveExport::Configuration#sources)
+    # @param [Symbol, String] namespace YAML File namespace
+    # @param [String, Filepath] filename Csv File name
+    # @param [Hash] options ({}) (see .export)
+    def self.export_file(data, source, namespace, filename, options = {})
+      new(source, namespace, options).export_file(data, filename)
+    end
 
-      each_method_name = data.respond_to?(:find_each) ? 'find_each' : 'each'
-      # 1.9.2
+    def export(data)
       CSV.generate(csv_options) do |csv|
-        csv << generate_header
-        data.send(each_method_name) do |f|
-          csv << generate_value(f)
+        csv << generate_header if header?
+        export_data(data, csv)
+      end
+    end
+
+    def export_file(data, filename)
+      File.atomic_write(filename) do |file|
+        CSV.open(file, "wb", csv_options) do |csv|
+          csv << generate_header if header?
+          export_data(data, csv)
         end
       end
+      filename
     end
 
+    # Export data to exporter
+    # @param [Array, ActiveRecord::Relation] data Export target data
+    # @param [CSV, Array, String] exporter CSV class or Array class, or String class (should support '<<' accessor)
+    def export_data(data, exporter)
+      if data.respond_to?(:find_in_batches) && data.respond_to?(:orders) && data.orders.blank? && data.respond_to?(:taken) && data.taken.blank?
+        data.find_in_batches(find_in_batches_options) do |group|
+          group.each{|f| exporter << generate_value(f) }
+        end
+      else
+        data.each{|f| exporter << generate_value(f) }
+      end
+    end
+
+    protected
     def generate_header
       self.label_keys.inject([]) {|result, key|
         result << translate(key_name(key))
@@ -44,5 +73,17 @@ module ActiveExport
         result << convert(v)
       }
     end
+
+    def find_in_batches_options
+      self.config.default_find_in_batches_options.merge( self.options[:find_in_batches_options] || {} )
+    end
+
+    def csv_options
+      self.config.default_csv_options.merge( self.options[:csv_options] || {} )
+    end
+
+    def header?
+      { header: true }.merge(self.options)[:header]
+    end
   end
 end

data/lib/active_export/version.rb

@@ -1,3 +1,3 @@
 module ActiveExport
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/spec/active_export/base_spec.rb

@@ -4,19 +4,11 @@ require 'spec_helper'
 
 describe ActiveExport::Base do
   before {
-    @default_locale = I18n.locale
-    I18n.locale = :en
-
     ActiveExport.configure do |config|
       config.sources = { default: fixture_file('csv_1.yml') }
     end
   }
 
-  after {
-    I18n.backend.reload!
-    I18n.locale = @default_locale
-  }
-
   let(:active_export) { ActiveExport::Base.new('default', 'book_2') }
   it { active_export.source_name = :default }
   it { active_export.namespace = :book_2 }
@@ -59,6 +51,10 @@ describe ActiveExport::Base do
 
   describe "#source" do
     before {
+      ActiveExport.configure do |config|
+        config.sources = {  }
+        config.no_source_raise_error = true
+      end
       active_export.source_name = :not_found
     }
     it { expect { active_export.source }.to raise_error RuntimeError }
@@ -85,9 +81,7 @@ describe ActiveExport::Base do
     context "active_export" do
       before do
         I18n.backend.store_translations :en, active_export: {
-          default: {
-            book: { author_name: 'author_name' }
-          }
+          default: { book: { author_name: 'author_name' } }
         }
       end
       it { should == 'author_name' }

data/spec/active_export/csv_spec.rb

@@ -3,16 +3,6 @@
 require 'spec_helper'
 
 describe ActiveExport::Csv do
-  before {
-    @default_locale = I18n.locale
-    I18n.locale = :en
-  }
-
-  after {
-    I18n.backend.reload!
-    I18n.locale = @default_locale
-  }
-
   describe ".export" do
     let(:author_1) { Author.create!(name: 'author_1') }
     let(:author_2) { Author.create!(name: 'author_2') }
@@ -37,19 +27,85 @@ describe ActiveExport::Csv do
       }
     end
 
-    context "add some options" do
+    context "add csv_options" do
       let(:csv_options) {
         { force_quotes: false, col_sep: ':'}
       }
-      subject { ActiveExport::Csv.export(Book.order('id DESC').all, :default, :book_1, csv_options: csv_options) }
+      subject { ActiveExport::Csv.export(Book.scoped, :default, :book_1, csv_options: csv_options) }
       it {
         should == <<-EOS
 Book name:Author name:Book price
-book_2:author_2:38
 book_1:author_1:58
+book_2:author_2:38
+        EOS
+      }
+    end
+
+    context "header false" do
+      subject { ActiveExport::Csv.export(Book.scoped, :default, :book_1, header: false) }
+      it {
+        should == <<-EOS
+"book_1","author_1","58"
+"book_2","author_2","38"
         EOS
       }
     end
+
+  end
+
+  describe ".export_file" do
+    let(:filename) { Rails.root.join('tmp', 'test.csv') }
+    before {
+      ActiveExport.configure do |config|
+        config.sources = { default: fixture_file('csv_1.yml') }
+        config.default_csv_options = { col_sep: ',', row_sep: "\n", force_quotes: true }
+      end
+
+      FileUtils.rm(filename) if FileTest.exist?(filename)
+      ActiveExport::Csv.export_file(Book.scoped, :default, :book_1, Rails.root.join('tmp', 'test.csv'))
+    }
+    after {
+      FileUtils.rm(filename) if FileTest.exist?(filename)
+    }
+
+    it { File.read(filename).split("\n").first.should eql %Q("Book name","Author name","Book price") }
+  end
+
+  describe "#export_data" do
+    let(:csv_exporter) { ActiveExport::Csv.new(:default, :book_1) }
+    let!(:book_1) { Book.create!(name: 'book_1', author: nil, price: 58) }
+    let!(:book_2) { Book.create!(name: 'book_2', author: nil, price: 58) }
+    let!(:book_3) { Book.create!(name: 'book_2', author: nil, price: 58) }
+
+    it "should not call find_in_batches when has order" do
+      obj = Book.order('id ASC')
+      obj.should_not_receive(:find_in_batches)
+      obj.should_receive(:each)
+      csv_exporter.send(:export_data, obj, [])
+    end
+
+
+    it "should not call find_in_batches when has limit" do
+      obj = Book.limit(1)
+      obj.should_not_receive(:find_in_batches)
+      obj.should_receive(:each)
+      csv_exporter.send(:export_data, obj, [])
+    end
+
+    it "should not call find_in_batches when specified obj is not ActiveRecord::Relation" do
+      obj = [Book.first]
+      obj.should_not_receive(:find_in_batches)
+      obj.should_receive(:each)
+      csv_exporter.send(:export_data, obj, [])
+    end
+
+    it "should call find_in_batches" do
+      obj = Book.scoped
+      obj.should_receive(:find_in_batches).with({batch_size: 1})
+      obj.should_not_receive(:each)
+      csv_exporter.stub(:find_in_batches_options).and_return({batch_size: 1})
+      csv_exporter.send(:export_data, obj, [])
+    end
   end
 
   describe ".generate_value" do
@@ -63,7 +119,7 @@ book_1:author_1:58
         default_value_labels: { nil: 'not found', blank: 'Blank', true: 'Yes!', false: 'No!' }
       }
     }
-    subject { csv_exporter.generate_value(book_1) }
+    subject { csv_exporter.send(:generate_value, book_1) }
     it { should eql ['book_1', 'author_1', '1000', 'not found', 'Yes!', 'No!'] }
   end
 
@@ -71,11 +127,8 @@ book_1:author_1:58
     let(:label_keys) { %w(name author.name price) }
     let(:csv_exporter) { ActiveExport::Csv.new(:default, :book_1, label_keys: label_keys, label_prefix: 'book') }
 
-    subject { csv_exporter.generate_header }
-
-    context "no language file" do
-      it { should eql ['Book name', 'Author name', 'Book price'] }
-    end
+    subject { csv_exporter.send(:generate_header) }
+    it { should eql ['Book name', 'Author name', 'Book price'] }
 
     context "translate" do
       before do

data/spec/spec_helper.rb

@@ -21,9 +21,13 @@ RSpec.configure do |config|
 
   config.before(:each) do
     DatabaseCleaner.start
+    @default_locale = I18n.locale
+    I18n.locale = :en
   end
 
   config.after(:each) do
+    I18n.backend.reload!
+    I18n.locale = @default_locale
     DatabaseCleaner.clean
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_export
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-14 00:00:00.000000000 Z
+date: 2012-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport