rails-exporter 0.0.9 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 81bb6b6cc49c8bdb659aa048e5fbdbfcb226f0d0
-  data.tar.gz: bdd1d68b1922c5656ee4b5a49a7164654be1728c
+SHA256:
+  metadata.gz: ddc19215c259d345b4cb6d45de77f894f8c731563ac66d00700afe8005592e47
+  data.tar.gz: 3dfa2dc4afea2746d777cb4ac9d73ca62547f31f6ffbf3a3c4231440b83329b9
 SHA512:
-  metadata.gz: 96b68fad1cdee09a587e91da4c92b9209b087adb3cae473b8b68027fa3cad3d0db61588ba7184122356fd0549f494e34ebbd43a64d31067d5db573225718946b
-  data.tar.gz: 570d1740faea715a4074654c6418641a7c92930c11ac6a00d386c9f99883677cb1d222306dc399f270eec6b24b03b534675d7f175c0bef5d60aa0a66c6ff55c5
+  metadata.gz: fe2062f3eff5c10224ad5a34e768af44b0941881fca429dd689f00c7bbfc3f801816f0ca483a57623b7195dab990a274b80ae1ca0e75df1ccb68840284ea3e47
+  data.tar.gz: ad1580cf514598006306bbf65789563c9544f58ff79ba8b734f06ba475e33cbe308b121fdb5227b4b63dad1dd6edfe2300eb82415ff81c62d4a32c30a0dba35f

data/README.md

@@ -1,16 +1,16 @@
 # Rails Exporter 
 
-Rails Exporter (XML, XLS, CSV)
+Rails Exporter (CSV, XML, XLS, XSLX)
 
 ## How to install
 
-Add it to your **Gemfile**: 
+Add it to your `Gemfile`: 
 ```ruby
 gem 'rails-exporter'
 ```
 
 Run the following command to install it:
-```sh
+```shell
 $ bundle install
 $ rails generate rails_exporter:install
 ```
@@ -19,7 +19,7 @@ $ rails generate rails_exporter:install
 
 You can generate exporters `app/exporters/example_exporter.rb`
 
-```sh
+```bash
 $ rails generate rails_exporter:exporter example
 ```
 
@@ -33,6 +33,7 @@ class ExampleExporter < RailsExporter::Base
     column :email
     column :price => :currency
     column :is_admin => :boolean
+    column :any_time => :time
     column :birthday => :date
     column :created_at => :datetime
     column(:account) {|record| record.account.name}
@@ -52,17 +53,37 @@ end
 ### How to use
 
 You can call `export_to` from **Array** or **ActiveRecord::Relation** objects: 
-```erb
+```ruby
     records = MyModel.all
-    records.export_to(:csv) # or MyModelExporter.export_to_csv(records)
+    records.export_to(:csv) # or MyModelExporter.export_to_csv(records) 
     
     records = [MyModel.first, MyModel.last]
     records.export_to(:xml) # or MyModelExporter.export_to_xml(records)
+    
+    ## With context :simple
+    # records.export_to(:csv, :simple)
+    # or MyModelExporter.export_to_csv(records, :simple)
+
+    ## CSV Custom Params
+    # records.export_to(:csv, params: {col_sep: ','}))
 ```
 
+### Avaliable Types
+
+You can call `RailsExporter::Base.file_types` to list all supported file types:
+```ruby
+RailsExporter::Base.file_types.each do |type|
+  puts type
+end
+```
+
+### I18n Configuration
+
+Modify you `config/locales/exporters.en.yml`
+
 ### Controller Example
 
-```erb
+```ruby
 class UsersController < ApplicationController
   def index
     @users = User.all
@@ -71,12 +92,16 @@ class UsersController < ApplicationController
       format.csv { send_data @users.export_to(:csv) }
       format.xml { send_data @users.export_to(:xml) }
       format.xls { send_data @users.export_to(:xls) }
+      format.xlsx { send_data @users.export_to(:xlsx) }
     end
   end
 end
 ```
 
+### MimeTypes
+
 Declare XLS as a new mimetype in `config/initializers/mime_types`:
-```erb
-    Mime::Type.register "application/xls", :xls
+```ruby
+    Mime::Type.register "application/vnd.ms-excel", :xls
+    Mime::Type.register "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", :xlsx
 ```

data/Rakefile

@@ -4,20 +4,21 @@ rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
-# require 'rdoc/task'
-#
-# RDoc::Task.new(:rdoc) do |rdoc|
-#   rdoc.rdoc_dir = 'rdoc'
-#   rdoc.title    = 'RailsExporter'
-#   rdoc.options << '--line-numbers'
-#   rdoc.rdoc_files.include('README.rdoc')
-#   rdoc.rdoc_files.include('lib/**/*.rb')
-# end
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RailsExporter'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
 
-APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+APP_RAKEFILE = File.expand_path("../spec/test_app/Rakefile", __FILE__)
 load 'rails/tasks/engine.rake'
 load 'rails/tasks/statistics.rake'
-Bundler::GemHelper.install_tasks
+# Bundler::GemHelper.install_tasks
+require 'bundler/gem_tasks'
 
 # require 'rake/testtask'
 # Rake::TestTask.new(:test) do |t|

data/config/locales/exporters.en.yml

@@ -1,6 +1,9 @@
 en:
   exporters:
     spreadsheet_name: 'Spreadsheet'
+    time_format: "%I:%M %P"
+    date_format: "%m/%d/%Y"
+    datetime_format: "%m/%d/%Y, %I:%M %P"
     example:
       name: 'Name'
     another_example:

data/lib/rails_exporter/base.rb

@@ -8,7 +8,7 @@ module RailsExporter
 
     class << self
       def file_types
-        [:csv, :xls, :xml]
+        [:csv, :xls, :xlsx, :xml]
       end
 
       # def method_missing(m, *args, &block)

data/lib/rails_exporter/engine.rb

@@ -1,4 +1,9 @@
 module RailsExporter
   class Engine < ::Rails::Engine
+    engine_name "rails_exporter"
+
+    config.generators do |g|
+      g.test_framework :rspec
+    end
   end
 end

data/lib/rails_exporter/exporter.rb

@@ -1,5 +1,9 @@
 require 'builder'
 require 'spreadsheet'
+require 'rubyXL'
+require 'rubyXL/convenience_methods/font'
+require 'rubyXL/convenience_methods/workbook'
+require 'rubyXL/convenience_methods/worksheet'
 
 module RailsExporter
   module Exporter
@@ -9,8 +13,9 @@ module RailsExporter
     end
 
     module ClassMethods
-      def export_to_csv(records, context=:default)
-        CSV.generate({:col_sep => ';', :force_quotes => true}) do |csv|
+      def export_to_csv(records, context=:default, params: nil)
+        custom_params = {col_sep: ';', force_quotes: true}.merge(params || {})
+        CSV.generate(custom_params) do |csv|
           # HEADER
           csv << get_columns(context).map do |attr|
             attr_name(attr)
@@ -22,9 +27,10 @@ module RailsExporter
         end
       end
 
-      def export_to_xml(records, context=:default)
+      def export_to_xml(records, context=:default, params: nil)
+        #TODO: custom params
         #File XML
-        xml = Builder::XmlMarkup.new(:indent => 2)
+        xml = Builder::XmlMarkup.new(indent: 2)
         #Format
         xml.instruct! :xml, :encoding => "UTF-8"
         xml.records do
@@ -42,7 +48,8 @@ module RailsExporter
         end
       end
 
-      def export_to_xls(records, context=:default)
+      def export_to_xls(records, context=:default, params: nil)
+        #TODO: custom params
         #FILE
         file_contents = StringIO.new
         #CHARSET
@@ -68,6 +75,28 @@ module RailsExporter
         file_contents.string.force_encoding('binary')
       end
 
+      def export_to_xlsx(records, context=:default, params: nil)
+        #TODO: custom params
+        #NEW document/spreadsheet
+        workbook = RubyXL::Workbook.new
+        worksheet = workbook[0]
+        # worksheet = workbook.add_worksheet(I18n.t(:spreadsheet_name, default: ['Spreadsheet'], scope: [:exporters]))
+        worksheet.sheet_name = I18n.t(:spreadsheet_name, default: ['Spreadsheet'], scope: [:exporters])
+        #HEADER FORMAT
+        worksheet.change_row_bold(0, true)
+        #HEADER (ROW=0)
+        get_columns(context).each_with_index do |attr, i|
+          worksheet.add_cell(0, i, attr_name(attr))
+        end
+        #ROWS
+        records.each_with_index do |record, row_index|
+          values = get_values(record, context)
+          values.each_with_index {|value, col_index| worksheet.add_cell(row_index+1, col_index, value)}
+        end
+        #RETURN STRING
+        workbook.stream.string.force_encoding('binary')
+      end
+
       private
       def get_columns(context)
         self.send(:columns, context) || []
@@ -94,12 +123,17 @@ module RailsExporter
           ActionController::Base.helpers.number_to_currency(value)
         elsif type==:boolean
           (value==true or value=='true' or value=='1') ? 'S' : 'N'
+        elsif type==:time
+          locale_format = I18n.t(:time_format, default: ['%H:%M:%S'], scope: [:exporters])
+          (I18n.l(value, format: locale_format) rescue value).to_s
         elsif type==:date
-          (I18n.l(value, format: '%d/%m/%Y') rescue value).to_s
+          locale_format = I18n.t(:date_format, default: ['%d/%m/%Y'], scope: [:exporters])
+          (I18n.l(value, format: locale_format) rescue value).to_s
         elsif type==:datetime
-          (I18n.l(value, format: '%d/%m/%Y %H:%i:%s') rescue value).to_s
+          locale_format = I18n.t(:datetime_format, default: ['%d/%m/%Y %H:%M:%S'], scope: [:exporters])
+          (I18n.l(value, format: locale_format) rescue value).to_s
         else
-          (I18n.l(value) rescue value)
+          (I18n.l(value) rescue value).to_s
         end
       end
 

data/lib/rails_exporter/helper.rb

@@ -3,20 +3,20 @@ require 'rails_exporter/base'
 module RailsExporter
   module Helper
 
-    define_method "export_to" do |ext, context=:default|
-      exec_method(ext, context)
+    define_method "export_to" do |ext, context=:default, params: nil|
+      exec_method(ext, context, params: params)
     end
 
     private
     def get_obj_class
       (self.first.class rescue nil)
     end
-    def exec_method(ext, context)
+    def exec_method(ext, context, params: nil)
       klass = get_obj_class
       exporter_klass = "#{klass.name}_exporter".classify.constantize
       # RailsExporter::Base.file_types
       if exporter_klass and exporter_klass.respond_to?("export_to_#{ext}")
-        exporter_klass.send("export_to_#{ext}", self, context)
+        exporter_klass.send("export_to_#{ext}", self, context, params: params)
       end
     end
   end

data/lib/rails_exporter/version.rb

@@ -1,3 +1,3 @@
 module RailsExporter
-  VERSION = "0.0.9"
+  VERSION = "0.1.1"
 end

data/spec/rails_exporter/base_spec.rb

@@ -0,0 +1,11 @@
+require 'rails_helper'
+
+RSpec.describe RailsExporter::Base do
+
+  describe '.file_types' do
+    it 'return the supported file types' do
+      expect(RailsExporter::Base.file_types).to eq([:csv, :xls, :xlsx, :xml])
+    end
+  end
+
+end

data/spec/rails_exporter/engine_spec.rb

@@ -0,0 +1,5 @@
+require 'rails_helper'
+
+RSpec.describe RailsExporter::Engine do
+
+end

data/spec/rails_exporter/exporter_spec.rb

@@ -0,0 +1,9 @@
+require 'rails_helper'
+
+RSpec.describe RailsExporter::Exporter do
+
+  describe '.export_to_csv' do
+
+  end
+
+end

data/spec/rails_exporter/helper_spec.rb

@@ -0,0 +1,5 @@
+require 'rails_helper'
+
+RSpec.describe RailsExporter::Helper do
+
+end

data/spec/rails_exporter_spec.rb

@@ -0,0 +1,7 @@
+require 'rails_helper'
+
+describe RailsExporter do
+  it 'have version number' do
+    expect(RailsExporter::VERSION).not_to be_nil
+  end
+end

data/spec/rails_helper.rb

@@ -0,0 +1,66 @@
+require 'simplecov'
+
+SimpleCov.start do
+  add_group 'Files', ['rails_exporter', 'lib/rails_exporter']
+  add_filter ['spec','rails-exporter']
+end
+
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+require 'spec_helper'
+ENV['RAILS_ENV'] ||= 'test'
+require File.expand_path('../../spec/test_app/config/environment', __FILE__)
+# Prevent database truncation if the environment is production
+abort("The Rails environment is running in production mode!") if Rails.env.production?
+require 'rspec/rails'
+# Add additional requires below this line. Rails is not loaded until this point!
+
+# Requires supporting ruby files with custom matchers and macros, etc, in
+# spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
+# run as spec files by default. This means that files in spec/support that end
+# in _spec.rb will both be required and run as specs, causing the specs to be
+# run twice. It is recommended that you do not name files matching this glob to
+# end with _spec.rb. You can configure this pattern with the --pattern
+# option on the command line or in ~/.rspec, .rspec or `.rspec-local`.
+#
+# The following line is provided for convenience purposes. It has the downside
+# of increasing the boot-up time by auto-requiring all files in the support
+# directory. Alternatively, in the individual `*_spec.rb` files, manually
+# require only the support files necessary.
+#
+Dir[Rails.root.join('spec/support/**/*.rb')].each { |f| require f }
+
+# Checks for pending migration and applies them before tests are run.
+# If you are not using ActiveRecord, you can remove this line.
+ActiveRecord::Migration.maintain_test_schema!
+ActiveJob::Base.queue_adapter = :test
+
+RSpec.configure do |config|
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  # config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  config.use_transactional_fixtures = true
+
+  # RSpec Rails can automatically mix in different behaviours to your tests
+  # based on their file location, for example enabling you to call `get` and
+  # `post` in specs under `spec/controllers`.
+  #
+  # You can disable this behaviour by removing the line below, and instead
+  # explicitly tag your specs with their type, e.g.:
+  #
+  #     RSpec.describe UsersController, :type => :controller do
+  #       # ...
+  #     end
+  #
+  # The different available types are documented in the features, such as in
+  # https://relishapp.com/rspec/rspec-rails/docs
+  config.infer_spec_type_from_file_location!
+
+  # Filter lines from Rails gems in backtraces.
+  config.filter_rails_from_backtrace!
+  # arbitrary gems may also be filtered via:
+  # config.filter_gems_from_backtrace("gem name")
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,100 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end