active_export 0.3.0 → 0.4.0

data/README.md

@@ -1,8 +1,11 @@
-# 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
 
-ActiveExport generate from ActiveRecord or others to CSV String or CSV file.
+[![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)
 
-You can write the logic of generating CSV to a YAML file.
+ActiveExport generate CSV/XML/YAML String or CSV/XML/YAML file.
+
+You can write the logic of generating csv or xml, yaml to a YAML file.
 
 Another Support:
 
@@ -10,14 +13,39 @@ Another Support:
   * 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:
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'active_export'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_export
+
+Generate the config initializer file and `default.yml`
+
+    $ rails g active_export:install
+
+## Example
 
 ````ruby
 ActiveExport::Csv.export(Book.scoped, source_name, namespace)
+# => csv string
+# "Title","AuthorName","Price(in tax)","Published"
+# "Ruby","Bob","28","2012-08-01"
+# "Rails","Alice","18","2012-07-01"
 ````
 
-YAML file
-<pre>
+  Price(in tax) `28` is `(book.price * 1.095).ceil.to_i` result.
+
+YAML file:
+
+````
 namespace:
   label_prefix: 'book'
   methods:
@@ -25,7 +53,7 @@ namespace:
     - author.name
     - price: '(price * 1.095).ceil.to_i'
     - created_at.strftime('%Y-%m-%d')
-</pre>
+````
 
 Write the same way without the ActiveExport:
 
@@ -44,76 +72,76 @@ CSV.generate do |csv|
 end
 ````
 
-## Installation
+## Usage
 
-Add this line to your application's Gemfile:
+```ruby
+# Exporting Csv String
+ActiveExport::Csv.export(Book.scoped, source_name, namespace)
 
-    gem 'active_export'
+# Exporting Csv File
+ActiveExport::Csv.export_file(Book.scoped, source_name, namespace, filename)
 
-And then execute:
+# Exporting Xml String
+ActiveExport::Xml.export(Book.scoped, source_name, namespace)
 
-    $ bundle
+# Exporting Xml File
+ActiveExport::Xml.export_file(Book.scoped, source_name, namespace, filename)
 
-Or install it yourself as:
+# Exporting Yaml String
+ActiveExport::Yaml.export(Book.scoped, source_name, namespace)
 
-    $ gem install active_export
+# Exporting Yaml File
+ActiveExport::Yaml.export_file(Book.scoped, source_name, namespace, filename)
+```
 
-## Usage
+## ActiveExport::Csv
+
+Support 2 methods:
+
+  * `export(data, source_name, namespace, options = {})` ... Generate Csv string
+  * `export_file(data, source_name, namespace, filename, options = {})` ... Generate Csv file
 
-Add initalizers `active_export.rb`
+options:
 
-    touch config/initializers/active_export.rb
+  * `: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.
 
-Write configuration code to `active_export.rb`
+features:
 
-````ruby
-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
-````
+  * Support encoding
 
-Create `active_export.yml` And write csv export method
+## ActiveExport::Xml
 
-    touch config/active_export.yml
+Support 2 methods:
 
-Write Csv generate logic to `active_export.yml`
+  * `ActiveExport::Xml.export(Book.scoped, source_name, namespace)` ... Generate Xml string
+  * `ActiveExport::Xml.export_file(Book.scoped, source_name, namespace, filename)` ... Generate Xml file
 
-<pre>
-namespace_1:
-  label_prefix: 'book'
-  methods:
-    - method
-    - method
-    ...
-namespace_2:
-  label_prefix: ...
-  ...
-</pre>
+options:
 
-Call Export method
+  * TODO
 
-    ActiveExport::Csv.export(Book.scoped, :default, :namespace_1)
-    ActiveExport::Csv.export_file(Book.scoped, :default, :namespace_1, filename)
+features:
 
-## ActiveExport::Csv
+  * Support encoding
+
+## ActiveExport::Yaml
 
 Support 2 methods:
 
-  * `export(data, source_name, namespace, options = {})` ... Generate Csv string
-  * `export_file(data, source_name, namespace, filename, options = {})` ... Generate Csv file
+  * `ActiveExport::Yaml.export(Book.scoped, source_name, namespace)` ... Generate Yaml string
+  * `ActiveExport::Yaml.export_file(Book.scoped, source_name, namespace, filename)` ... Generate Yaml file
 
 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.
+  * TODO
+
+features:
+
+  * exporting i18n labels
 
 ## YAML file format
 
@@ -123,8 +151,29 @@ namespace:
   methods:
     - method_name
     - label_name: method_name
+  # If using Xml export
+  xml_format:
+    encoding: 'UTF-8'
+    header: |
+      <?xml version="1.0" encoding="UTF-8"?>
+      <records>
+    footer: |
+      </records>
+    body: |
+      <record>
+        <name>%%label_name%%</name>
+      </record>
+
+namespace_2:
+  label_prefix: ...
+  ...
+````
 </pre>
 
+### xml_format:
+
+TODO
+
 ### I18n field priority
 
 1. `active_export.#{source_name}.#{namespace}.(label_prefix_)#{key}`

data/active_export.gemspec

@@ -4,8 +4,8 @@ require File.expand_path('../lib/active_export/version', __FILE__)
 Gem::Specification.new do |gem|
   gem.authors       = ["kengos"]
   gem.email         = ["kengo@kengos.jp"]
-  gem.description   = %q{Export to CSV from ActiveRecord collections.}
-  gem.summary       = %q{Export to CSV from ActiveRecord collections.}
+  gem.description   = %q{Export to CSV/YAML/XML from ActiveRecord collections. }
+  gem.summary       = %q{Export to CSV/YAML/XML from ActiveRecord collections.}
   gem.homepage      = "https://github.com/kengos/active_export"
 
   gem.files         = `git ls-files`.split($\)

data/lib/active_export.rb

@@ -11,7 +11,7 @@ module ActiveExport
 
   class << self
     # @example
-    #   ActiveExportconfigure do |config|
+    #   ActiveExport.configure do |config|
     #     # ActiveExport export configuration files.
     #     config.sources = { default: Rails.root.join('config', 'active_export.yml') }
     #

data/lib/active_export/version.rb

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

data/lib/generators/active_export/install_generator.rb

@@ -0,0 +1,17 @@
+# coding: utf-8
+
+# @see http://asciicasts.com/episodes/218-making-generators-in-rails-3
+module ActiveExport
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc "Copy ActiveExport default files"
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_initializers
+        copy_file 'config.rb', 'config/initializers/active_export.rb'
+        copy_file 'default.yml', 'config/active_export/default.yml'
+      end
+
+    end
+  end
+end

data/lib/generators/active_export/templates/config.rb

@@ -0,0 +1,26 @@
+# coding: utf-8
+
+ActiveExport.configure do |config|
+  # ActiveExport export configuration files.
+  config.sources = {
+    default: Rails.root.join('config', 'active_export', 'default.yml')
+    # xml: Rails.root.join('config', 'active_export', 'xml.yml')
+  }
+
+  # @see CSV.new options 
+  #config.default_csv_optoins = { col_sep: ',', row_sep: "\n", force_quotes: true }
+
+  # @see http://api.rubyonrails.org/classes/ActiveRecord/Batches.html#method-i-find_in_batches
+  #default_find_in_batches_options = {} # default
+
+  # Value where the result is set if null or blank or true, false
+  # loading i18n label from active_export.default_value_labels[:nil or :blank or :true or :false]
+  #default_value_label_scope = [:default_value_labels]
+
+  # true ... ActiveExport no cached yml data. Every time load yml file.
+  # false ... ActiveExport cached yml data.
+  #config.always_reload = false # default
+
+  # true ... not found sources[:source_name] to raise error
+  #config.no_source_raise_error = false # default
+end

data/lib/generators/active_export/templates/default.yml

@@ -0,0 +1,21 @@
+# Using Xml export, you need write `xml_format:`
+# Example:
+# 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>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_export
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-20 00:00:00.000000000 Z
+date: 2012-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -27,7 +27,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
-description: Export to CSV from ActiveRecord collections.
+description: ! 'Export to CSV/YAML/XML from ActiveRecord collections. '
 email:
 - kengo@kengos.jp
 executables: []
@@ -50,6 +50,9 @@ files:
 - lib/active_export/version.rb
 - lib/active_export/xml.rb
 - lib/active_export/yaml.rb
+- lib/generators/active_export/install_generator.rb
+- lib/generators/active_export/templates/config.rb
+- lib/generators/active_export/templates/default.yml
 - spec/active_export/base_spec.rb
 - spec/active_export/csv_spec.rb
 - spec/active_export/rails_support_spec.rb
@@ -94,7 +97,7 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Export to CSV from ActiveRecord collections.
+summary: Export to CSV/YAML/XML from ActiveRecord collections.
 test_files:
 - spec/active_export/base_spec.rb
 - spec/active_export/csv_spec.rb