active_export 0.2.0 → 0.3.0

data/.gitignore

@@ -5,6 +5,6 @@
 _yardoc
 doc/
 coverage
-tmp
+tmp/*
 log/*
 Gemfile.lock

data/.travis.yml

@@ -0,0 +1,12 @@
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - ruby-head
+  - rbx-19mode
+gemfile:
+  - spec/gemfiles/Gemfile.rails.3.0
+  - spec/gemfiles/Gemfile.rails.3.1
+  - spec/gemfiles/Gemfile.rails.3.2
+branches:
+  only:
+    - master

data/Gemfile

@@ -5,7 +5,7 @@ gemspec
 
 group :development, :test do
   gem 'rake',           '~> 0.9.2.2', :require => false
-  gem 'rails', ">= #{ENV['RAILS'] || '3.0.0'}"
+  gem 'rails', ">= 3.0.0"
 
   gem 'yard'
   gem 'rdiscount'

data/README.md

@@ -1,4 +1,4 @@
-# ActiveExport
+# ActiveExport [![Build Status](https://secure.travis-ci.org/kengos/active_export.png?branch=master)](http://travis-ci.org/kengos/active_export)[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/kengos/active_export)
 
 ActiveExport generate from ActiveRecord or others to CSV String or CSV file.
 

data/lib/active_export/base.rb

@@ -18,6 +18,30 @@ module ActiveExport
     end
 
     class << self
+      # Generate Csv String
+      # @param [Array, ActiveRecord::Relation] data
+      # @param [Symbol, String] source
+      # @param [Symobl, String] namespace
+      # @param [Hash] options ({})
+      # @option options [Array] :eval_methods
+      # @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
+      def export(data, source, namespace, options = {})
+        new(source, namespace, options).export(data)
+      end
+
+      # 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 export_file(data, source, namespace, filename, options = {})
+        new(source, namespace, options).export_file(data, filename)
+      end
+
       def translate(key, scope = [])
         defaults = [
           :"active_export.#{scope.join('.')}.#{key.to_s.gsub('.', '_')}",
@@ -46,6 +70,19 @@ module ActiveExport
       end
     end
 
+    # Export data to exporter
+    # @param [Array, ActiveRecord::Relation] data Export target data
+    # @param [Object] Object needs to 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
+
     # Convert value for export string
     # @todo refactor me
     def convert(value)
@@ -98,5 +135,24 @@ module ActiveExport
     def translate(key, scope = nil)
       self.class.translate(key, scope || default_scope)
     end
+
+    protected
+
+    def generate_header
+      self.label_keys.inject([]) {|result, key|
+        result << translate(key_name(key))
+      }
+    end
+
+    def generate_value(row)
+      self.eval_methods.inject([]){|result, f|
+        v = row.send(:eval, f) rescue nil
+        result << convert(v)
+      }
+    end
+
+    def find_in_batches_options
+      self.config.default_find_in_batches_options.merge( self.options[:find_in_batches_options] || {} )
+    end
   end
 end

data/lib/active_export/csv.rb

@@ -4,32 +4,6 @@ require 'csv'
 
 module ActiveExport
   class Csv < ::ActiveExport::Base
-    # Generate Csv String
-    # @param [Array, ActiveRecord::Relation] data
-    # @param [Symbol, String] source
-    # @param [Symobl, String] namespace
-    # @param [Hash] options ({})
-    # @option options [Array] :eval_methods
-    # @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)
-    end
-
-    # 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
-
     def export(data)
       CSV.generate(csv_options) do |csv|
         csv << generate_header if header?
@@ -38,7 +12,7 @@ module ActiveExport
     end
 
     def export_file(data, filename)
-      File.atomic_write(filename) do |file|
+      File.atomic_write(filename.to_s) do |file|
         CSV.open(file, "wb", csv_options) do |csv|
           csv << generate_header if header?
           export_data(data, csv)
@@ -47,36 +21,7 @@ module ActiveExport
       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))
-      }
-    end
-
-    def generate_value(row)
-      self.eval_methods.inject([]){|result, f|
-        v = row.send(:eval, f) rescue nil
-        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] || {} )

data/lib/active_export/version.rb

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

data/lib/active_export/xml.rb

@@ -0,0 +1,41 @@
+# coding: utf-8
+
+module ActiveExport
+  class Xml < ::ActiveExport::Base
+    # @return [String] XML style string
+    def export(data)
+      str = ''
+      str << source[:xml_format][:header]
+      [].tap {|o| export_data(data, o)}.inject([]) do |result, f|
+        result << {}.tap{|o|
+          self.label_keys.each_with_index {|k, i| o[k] = f[i] }
+        }
+      end.each do |f|
+        str << binding(f)
+      end
+      str << source[:xml_format][:footer]
+      str
+    end
+
+    def export_file(data, filename)
+      File.atomic_write(filename.to_s) do |file|
+        file.write export(data)
+      end
+    end
+
+    protected
+
+    # @params [Hash] values Format: { label_1: value_1, ... }
+    def binding(values)
+      result_string = binding_source.dup
+      values.each_pair do |k,v|
+        result_string.gsub!("%%#{k}%%", v)
+      end
+      result_string
+    end
+
+    def binding_source
+      @xml_body ||= source[:xml_format][:body]
+    end
+  end
+end

data/lib/active_export/yaml.rb

@@ -0,0 +1,24 @@
+# coding: utf-8
+
+require 'yaml'
+
+module ActiveExport
+  class Yaml < ::ActiveExport::Base
+    # @return [String] YAML style string
+    # @memo output format(i want)
+    # - 
+    #  - label: value
+    #  - label: value
+    def export(data)
+      [].tap {|o|
+        export_data(data, o)
+      }.to_yaml
+    end
+
+    def export_file(data, filename)
+      File.atomic_write(filename.to_s) do |file|
+        file.write export(data)
+      end
+    end
+  end
+end

data/lib/active_export.rb

@@ -6,6 +6,8 @@ require 'erb'
 module ActiveExport
   autoload :Base, 'active_export/base'
   autoload :Csv, 'active_export/csv'
+  autoload :Yaml, 'active_export/yaml'
+  autoload :Xml, 'active_export/xml'
 
   class << self
     # @example

data/spec/active_export/base_spec.rb

@@ -74,6 +74,43 @@ describe ActiveExport::Base do
     end
   end
 
+  describe "#export_data" do
+    let(:csv_exporter) { ActiveExport::Base.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 ".translate" do
     let(:i18n_key) { 'author.name' }
     subject { ActiveExport::Base.translate('author.name', [:default, :book]) }

data/spec/active_export/csv_spec.rb

@@ -71,43 +71,6 @@ book_2:author_2:38
     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
     let(:author_1) { Author.create!(name: 'author_1') }
     let!(:book_1) { Book.create!(name: 'book_1', author: author_1, price: 1000) }

data/spec/active_export/xml_spec.rb

@@ -0,0 +1,50 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+describe ActiveExport::Xml do
+  before {
+    ActiveExport.configure do |config|
+      config.sources = { xml: fixture_file('xml.yml') }
+    end
+  }
+
+  let(:author_1) { Author.create!(name: 'author_1') }
+  let(:author_2) { Author.create!(name: 'author_2') }
+  let!(:book_1) { Book.create!(name: 'book_1', author: author_1, price: 58) }
+  let!(:book_2) { Book.create!(name: 'book_2', author: author_2, price: 38) }
+
+  let(:expect_string) {
+    <<-EOS
+<?xml version="1.0" encoding="UTF-8"?>
+<records>
+<book>
+  <name>book_1</name>
+  <author_name>author_1</author_name>
+  <price>63.51</price>
+</book>
+<book>
+  <name>book_2</name>
+  <author_name>author_2</author_name>
+  <price>41.61</price>
+</book>
+</records>
+    EOS
+  }
+  describe ".export" do
+    subject { ActiveExport::Xml.export(Book.scoped, :xml, :book_1) }
+    it { should == expect_string }
+  end
+
+  describe ".export_file" do
+    let(:xml_file) { Rails.root.join('tmp', 'test.xml') }
+    before {
+      FileUtils.rm yaml_file if FileTest.exist?(xml_file)
+      ActiveExport::Xml.export_file(Book.scoped, :xml, :book_1, xml_file)
+    }
+    after {
+      FileUtils.rm xml_file if FileTest.exist?(xml_file)
+    }
+    it { File.read(xml_file).should == expect_string }
+  end
+end

data/spec/active_export/yaml_spec.rb

@@ -0,0 +1,41 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+describe ActiveExport::Yaml do
+  before {
+    ActiveExport.configure do |config|
+      config.sources = { default: fixture_file('csv_1.yml') }
+    end
+  }
+
+  describe ".export" do
+    let(:author_1) { Author.create!(name: 'author_1') }
+    let(:author_2) { Author.create!(name: 'author_2') }
+    let!(:book_1) { Book.create!(name: 'book_1', author: author_1, price: 58) }
+    let!(:book_2) { Book.create!(name: 'book_2', author: author_2, price: 38) }
+
+    let(:yaml_string) { ActiveExport::Yaml.export(Book.order('id DESC').all, :default, :book_2) }
+    subject { YAML.load(yaml_string) }
+    its([0]) { should == ["book_2", "author_2", "42"] }
+    its([1]) { should == ["book_1", "author_1", "64"] }
+  end
+
+  describe ".export_file" do
+    let(:author_1) { Author.create!(name: 'author_1') }
+    let(:author_2) { Author.create!(name: 'author_2') }
+    let!(:book_1) { Book.create!(name: 'book_1', author: author_1, price: 58) }
+    let!(:book_2) { Book.create!(name: 'book_2', author: author_2, price: 38) }
+    let(:yaml_file) { Rails.root.join('tmp', 'test.yml') }
+    before {
+      FileUtils.rm yaml_file if FileTest.exist?(yaml_file)
+      ActiveExport::Yaml.export_file(Book.scoped, :default, :book_2, yaml_file)
+    }
+    after {
+      FileUtils.rm yaml_file if FileTest.exist?(yaml_file)
+    }
+    subject { YAML.load(File.read(yaml_file)) }
+    its([0]) { should == ["book_1", "author_1", "64"] }
+    its([1]) { should == ["book_2", "author_2", "42"] }
+  end
+end

data/spec/fixtures/xml.yml

@@ -0,0 +1,19 @@
+book_1:
+  label_prefix: 'book'
+  methods:
+    - name
+    - author.name
+    - price: 'price * 1.095'
+  xml_format:
+    encoding: 'UTF-8'
+    header: |
+      <?xml version="1.0" encoding="UTF-8"?>
+      <records>
+    footer: |
+      </records>
+    body: |
+        <book>
+          <name>%%name%%</name>
+          <author_name>%%author.name%%</author_name>
+          <price>%%price%%</price>
+        </book>

data/spec/gemfiles/Gemfile.rails.3.0

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+group :test do
+  gem 'rails', "3.0.16"
+
+  gem 'sqlite3'
+  gem 'rspec-rails'
+  gem 'factory_girl_rails'
+  gem 'database_cleaner'
+end

data/spec/gemfiles/Gemfile.rails.3.1

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+group :test do
+  gem 'rails', "3.1.7"
+
+  gem 'sqlite3'
+  gem 'rspec-rails'
+  gem 'factory_girl_rails'
+  gem 'database_cleaner'
+end

data/spec/gemfiles/Gemfile.rails.3.2

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+group :test do
+  gem 'rails', "3.2.8"
+
+  gem 'sqlite3'
+  gem 'rspec-rails'
+  gem 'factory_girl_rails'
+  gem 'database_cleaner'
+end

data/spec/spec_helper.rb

@@ -1,4 +1,8 @@
-require 'tapp'
+begin
+  require 'tapp'
+rescue Exception
+end
+
 require 'rails/rails_support'
 require 'rspec'
 require 'rspec/rails'

data/tasks/yard.rake

@@ -1,6 +1,11 @@
-require 'yard'
-require 'yard/rake/yardoc_task'
+begin
 
-YARD::Rake::YardocTask.new do |t|
-  t.files   = ['lib/**/*.rb']
+  require 'yard'
+  require 'yard/rake/yardoc_task'
+
+  YARD::Rake::YardocTask.new do |t|
+    t.files   = ['lib/**/*.rb']
+  end
+
+rescue Exception
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_export
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-19 00:00:00.000000000 Z
+date: 2012-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -35,6 +35,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - .yardopts
 - Gemfile
 - Guardfile
@@ -47,12 +48,20 @@ files:
 - lib/active_export/configuration.rb
 - lib/active_export/csv.rb
 - lib/active_export/version.rb
+- lib/active_export/xml.rb
+- lib/active_export/yaml.rb
 - spec/active_export/base_spec.rb
 - spec/active_export/csv_spec.rb
 - spec/active_export/rails_support_spec.rb
+- spec/active_export/xml_spec.rb
+- spec/active_export/yaml_spec.rb
 - spec/active_export_spec.rb
 - spec/factories/book.rb
 - spec/fixtures/csv_1.yml
+- spec/fixtures/xml.yml
+- spec/gemfiles/Gemfile.rails.3.0
+- spec/gemfiles/Gemfile.rails.3.1
+- spec/gemfiles/Gemfile.rails.3.2
 - spec/rails/model/author.rb
 - spec/rails/model/book.rb
 - spec/rails/model/book_category.rb
@@ -61,6 +70,7 @@ files:
 - spec/rails/schema.rb
 - spec/spec_helper.rb
 - tasks/yard.rake
+- tmp/.gitkeep
 homepage: https://github.com/kengos/active_export
 licenses: []
 post_install_message: 
@@ -89,9 +99,15 @@ test_files:
 - spec/active_export/base_spec.rb
 - spec/active_export/csv_spec.rb
 - spec/active_export/rails_support_spec.rb
+- spec/active_export/xml_spec.rb
+- spec/active_export/yaml_spec.rb
 - spec/active_export_spec.rb
 - spec/factories/book.rb
 - spec/fixtures/csv_1.yml
+- spec/fixtures/xml.yml
+- spec/gemfiles/Gemfile.rails.3.0
+- spec/gemfiles/Gemfile.rails.3.1
+- spec/gemfiles/Gemfile.rails.3.2
 - spec/rails/model/author.rb
 - spec/rails/model/book.rb
 - spec/rails/model/book_category.rb