rails-exporter 0.0.11 → 0.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1d1230f2b09a65e5db6ad197f70c45eb8cd2f3ca
-  data.tar.gz: a09035502c85a8ba441d78fa7cd079cddbd4ea3c
+SHA256:
+  metadata.gz: dbf6c483c1bb4010ab215a8942027c2c114ce76f7b8fc541a4cf39871754308d
+  data.tar.gz: 0c40e99735364d5d5073b8f1a60f59d2465940efd303a9dd42e761367d875218
 SHA512:
-  metadata.gz: b09006248b1ec00a72a9b70d77230d41fc7940d08ac6c941e58b54b1b27b22367dc7d4ee01452145c752c08ea7922cdb09aae4cd9acac0b3f55cba410d7f6f46
-  data.tar.gz: 7ac22910f3524f86f628caf26fecc4929963d33e4ef4e36f9387928f2238a3cb3049733135c327dca2d2ecee0391ffe7a3897de1792dfaf0106142fa2ee41666
+  metadata.gz: 8c8bd85da0cc10ee446af85a1eac8d098246e20655f93c61eef85d0cd4c55dbbec92104920f5393f7ccccc8d9e467017ebaf1aca75641b2a67e7da2ff689c468
+  data.tar.gz: 912658d5a451fe9620ab569381d656e3f9f0f0ce6cec3563d9689586da81139a6cefabac6ae490b8f3efebefe233f9a3f83b81a5cd7a05295499831e36af8c21

data/README.md

@@ -4,13 +4,13 @@ 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
 ```
 
@@ -53,12 +53,16 @@ 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)
 ```
 
 ### Avaliable Types
@@ -66,7 +70,7 @@ You can call `export_to` from **Array** or **ActiveRecord::Relation** objects:
 You can call `RailsExporter::Base.file_types` to list all supported file types:
 ```ruby
 RailsExporter::Base.file_types.each do |type|
- puts type
+  puts type
 end
 ```
 
@@ -76,7 +80,7 @@ Modify you `config/locales/exporters.en.yml`
 
 ### Controller Example
 
-```erb
+```ruby
 class UsersController < ApplicationController
   def index
     @users = User.all
@@ -90,10 +94,11 @@ class UsersController < ApplicationController
   end
 end
 ```
+
 ### MimeTypes
 
 Declare XLS as a new mimetype in `config/initializers/mime_types`:
-```erb
+```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/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,6 +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

data/lib/rails_exporter/version.rb

@@ -1,3 +1,3 @@
 module RailsExporter
-  VERSION = "0.0.11"
+  VERSION = "0.0.13"
 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

data/spec/test_app/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/spec/test_app/app/assets/config/manifest.js

@@ -0,0 +1,4 @@
+
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css

data/spec/test_app/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/test_app/app/assets/javascripts/cable.js

@@ -0,0 +1,13 @@
+// Action Cable provides the framework to deal with WebSockets in Rails.
+// You can generate new channels where WebSocket features live using the `rails generate channel` command.
+//
+//= require action_cable
+//= require_self
+//= require_tree ./channels
+
+(function() {
+  this.App || (this.App = {});
+
+  App.cable = ActionCable.createConsumer();
+
+}).call(this);

data/spec/test_app/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/test_app/app/channels/application_cable/channel.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/spec/test_app/app/channels/application_cable/connection.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/spec/test_app/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+end

data/spec/test_app/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end