exportable 0.1.0

data/spec/dummy/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  # For details on the DSL available within this file, see http://guides.rubyonrails.org/routing.html
+end

data/spec/dummy/config/secrets.yml

@@ -0,0 +1,22 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key is used for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+# You can use `rails secret` to generate a secure secret key.
+
+# Make sure the secrets in this file are kept private
+# if you're sharing your code publicly.
+
+development:
+  secret_key_base: 4ce50fce1f44058e3c8533978f8d1483506808dcf9e6356effc7c0884aa25d779d0dbb5fcd84a5dff4f6d52e9f3cadc25865563ff15b514500f2cee84d080883
+
+test:
+  secret_key_base: 9d583a8db24b65f37d926d8608addce41ad44748c1f6365cab5fb70eb9d3d91bcdc55b4d4b03cd518a9f8f513dd960783e381475bede97812916472b38bcceb2
+
+# Do not keep production secrets in the repository,
+# instead read values from the environment.
+production:
+  secret_key_base: <%= ENV["SECRET_KEY_BASE"] %>

data/spec/dummy/config/spring.rb

@@ -0,0 +1,6 @@
+%w(
+  .ruby-version
+  .rbenv-vars
+  tmp/restart.txt
+  tmp/caching-dev.txt
+).each { |path| Spring.watch(path) }

data/spec/dummy/db/migrate/20170107183658_create_exportable_models.rb

@@ -0,0 +1,17 @@
+class CreateExportableModels < ActiveRecord::Migration[5.0]
+  def change
+    create_table :exportable_models do |t|
+      t.string :field_string
+      t.binary :field_binary
+      t.date :field_date
+      t.datetime :field_datetime
+      t.decimal :field_decimal
+      t.float :field_float
+      t.integer :field_integer
+      t.bigint :field_bigint
+      t.text :field_text
+      t.time :field_time
+      t.timestamps
+    end
+  end
+end

data/spec/dummy/db/schema.rb

@@ -0,0 +1,30 @@
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema.define(version: 20170107183658) do
+
+  create_table "exportable_models", force: :cascade do |t|
+    t.string   "field_string"
+    t.binary   "field_binary"
+    t.date     "field_date"
+    t.datetime "field_datetime"
+    t.decimal  "field_decimal"
+    t.float    "field_float"
+    t.integer  "field_integer"
+    t.bigint   "field_bigint"
+    t.text     "field_text"
+    t.time     "field_time"
+    t.datetime "created_at",     null: false
+    t.datetime "updated_at",     null: false
+  end
+
+end

data/spec/exportable/class_methods_spec.rb

@@ -0,0 +1,15 @@
+require "spec_helper"
+
+
+describe Exportable::ClassMethods, type: :model do
+  
+  before(:each) do
+    ExportableModel.create!(field_string: "sample string", field_text: "sample text", field_date: Date.today )
+  end
+  
+  it "adds 'exportable' method to model" do
+    expect(ExportableModel.respond_to? 'exportable').to be_truthy 
+  end
+
+
+end

data/spec/exportable/csv_exporter_spec.rb

@@ -0,0 +1,69 @@
+require "spec_helper"
+
+describe 'Export CSV' do
+
+  before(:each) do
+    ExportableModel.create!(field_string: "sample string", field_text: "sample text", field_date: Date.today )
+  end
+
+  it "responds to export_csv" do
+    ExportableModel.class_eval{ exportable }
+    expect(ExportableModel.respond_to? 'export_csv').to be_truthy 
+  end
+
+  it "exports csv data" do
+    ExportableModel.class_eval{ exportable }
+    csv = CSV.parse(ExportableModel.export_csv, headers: true)
+    expect(csv.first['field_string']).to eq 'sample string' 
+  end
+
+  it "exports properly encode data" do
+    ExportableModel.class_eval{ exportable }
+    ExportableModel.create!(field_string: "sample st,ring")
+    csv = CSV.parse(ExportableModel.export_csv, headers: true)
+    expect(csv[-1]['field_string']).to eq 'sample st,ring' 
+  end
+
+  it "exports csv data with 'only' option" do
+    ExportableModel.class_eval{ exportable only: [:field_string] }
+    csv = CSV.parse(ExportableModel.export_csv, headers: true)
+    expect(csv.headers).not_to include('field_text')  
+  end
+
+  it "exports csv data with 'except' option" do
+    ExportableModel.class_eval{ exportable except: [:field_string] }
+    csv = CSV.parse(ExportableModel.export_csv, headers: true)
+    expect(csv.headers).not_to include('field_string')  
+  end
+
+  it "exports csv data with 'header' option" do
+    ExportableModel.class_eval{ exportable header: false }
+    csv = CSV.parse(ExportableModel.export_csv, headers: true)
+    expect(csv.headers).not_to include('field_string')  
+  end
+
+  it "exports csv data with 'methods' option" do
+    ExportableModel.class_eval do  
+      exportable methods: [:title]
+      def title
+        field_string.upcase
+      end
+    end
+    csv = CSV.parse(ExportableModel.export_csv, headers: true)    
+    expect(csv.headers).to include('title')  
+  end
+
+  it "has option preference on utility method" do
+    ExportableModel.class_eval{ exportable only: [:field_string]}
+    csv = CSV.parse(ExportableModel.export_csv(only: [:field_string, :field_text]), headers: true)    
+    expect(csv.headers).to include('field_text')  
+  end
+
+  it 'validates arguments' do
+    ExportableModel.class_eval{ exportable only: :field_string}
+    expect{ExportableModel.export_csv}.to raise_error(ArgumentError)
+    ExportableModel.class_eval{ exportable only: [:field_string]}
+    expect{ExportableModel.export_csv methods: :title}.to raise_error(ArgumentError) 
+  end 
+
+end 

data/spec/exportable/export_methods_spec.rb

@@ -0,0 +1,31 @@
+require "spec_helper"
+
+
+describe Exportable::ExportMethods, type: :model do
+  
+  before(:each) do
+    ExportableModel.create!(field_string: "sample string", field_text: "sample text", field_date: Date.today )
+    ExportableModel.class_eval{ exportable }
+  end
+  
+  it "adds 'export' method to model" do
+    expect(ExportableModel.respond_to? 'export').to be_truthy 
+  end
+
+  describe '.export' do 
+    it 'generates output format string on model' do
+      csv = CSV.parse(ExportableModel.export(:csv), headers: true)
+      expect(csv.first['field_string']).to eq 'sample string' 
+    end
+
+    it 'generates output format string on model with options' do
+      csv = CSV.parse(ExportableModel.export(:csv, only: [:field_string]), headers: true)
+      expect(csv.headers).not_to include('field_text')  
+    end
+
+    it 'raise error on invalid output format' do
+      expect{ExportableModel.export(:xml)}.to raise_error(ArgumentError) 
+    end
+  end   
+
+end

data/spec/exportable/xls_exporter_spec.rb

@@ -0,0 +1,56 @@
+require "spec_helper"
+
+describe 'Export XLS' do
+
+  before(:each) do
+    ExportableModel.create!(field_string: "sample string", field_text: "sample text", 
+      field_date: Date.today )
+  end
+
+  it "responds to export_csv" do
+    ExportableModel.class_eval{ exportable }
+    expect(ExportableModel.respond_to? 'export_xls').to be_truthy 
+  end
+
+  it "exports csv data" do
+    ExportableModel.class_eval{ exportable }
+    sheet = write_xls
+    expect(sheet.row(1)[1]).to eq 'sample string'
+  end
+  
+  it "exports csv data with 'only' option" do
+    ExportableModel.class_eval{ exportable only: [:field_string] }
+    sheet = write_xls
+    expect(sheet.row(0)).not_to include('field_text')  
+  end
+
+  it "exports csv data with 'except' option" do
+    ExportableModel.class_eval{ exportable except: [:field_string] }
+    sheet = write_xls
+    expect(sheet.row(0)).not_to include('field_string')  
+  end
+
+  it "exports csv data with 'header' option" do
+    ExportableModel.class_eval{ exportable header: false }
+    sheet = write_xls
+    expect(sheet.row(0)).not_to include('field_string')  
+  end
+
+  it "exports csv data with 'methods' option" do
+    ExportableModel.class_eval do  
+      exportable methods: [:title]
+      def title
+        field_string.upcase
+      end
+    end
+    sheet = write_xls
+    expect(sheet.row(0)).to include('title')  
+  end
+
+  it "has option preference on utility method" do
+    ExportableModel.class_eval{ exportable only: [:field_string]}
+    sheet = write_xls only: [:field_string, :field_text]
+    expect(sheet.row(0)).to include('field_text')  
+  end
+
+end 

data/spec/spec_helper.rb

@@ -0,0 +1,128 @@
+# 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.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+ENV["RAILS_ENV"] = "test"
+
+require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+Dir[File.dirname(__FILE__) + '/support/**/*.rb'].each {|f| require f}
+require 'database_cleaner'
+
+
+RSpec.configure do |config|
+
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.around(:each) do |example|
+    DatabaseCleaner.cleaning do
+      example.run
+    end
+  end
+
+end
+
+
+
+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
+  config.include Helper::XlsHelper 
+end

data/spec/support/helper.rb

@@ -0,0 +1,12 @@
+module Helper
+	module XlsHelper
+		DATA_DIR = 'spec/data'
+
+		def write_xls( options = {} )
+			File.open("#{DATA_DIR}/test.xls", 'wb') {|f| f.write ExportableModel.export_xls options}
+      book = Spreadsheet.open("#{DATA_DIR}/test.xls")
+      File.delete("#{DATA_DIR}/test.xls") 
+      book.worksheet 0
+		end
+	end
+end

metadata

@@ -0,0 +1,228 @@
+--- !ruby/object:Gem::Specification
+name: exportable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sunil Antony
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: spreadsheet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Exportable will help you in exporting ActiveRecord models in to different
+  output formats including CSV, XLS etc.
+email:
+- chackoantonydaniel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README.md
+- Rakefile
+- bin/test
+- exportable.gemspec
+- lib/exportable.rb
+- lib/exportable/class_methods.rb
+- lib/exportable/export_methods.rb
+- lib/exportable/export_methods/csv_exporter.rb
+- lib/exportable/export_methods/xls_exporter.rb
+- lib/exportable/utils.rb
+- lib/exportable/version.rb
+- lib/tasks/exportable_tasks.rake
+- spec/dummy/Rakefile
+- spec/dummy/app/models/application_record.rb
+- spec/dummy/app/models/exportable_model.rb
+- spec/dummy/bin/bundle
+- spec/dummy/bin/rails
+- spec/dummy/bin/rake
+- spec/dummy/bin/setup
+- spec/dummy/bin/update
+- spec/dummy/config.ru
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/cable.yml
+- spec/dummy/config/database.yml
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/application_controller_renderer.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/cookies_serializer.rb
+- spec/dummy/config/initializers/filter_parameter_logging.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/new_framework_defaults.rb
+- spec/dummy/config/initializers/session_store.rb
+- spec/dummy/config/initializers/wrap_parameters.rb
+- spec/dummy/config/locales/en.yml
+- spec/dummy/config/puma.rb
+- spec/dummy/config/routes.rb
+- spec/dummy/config/secrets.yml
+- spec/dummy/config/spring.rb
+- spec/dummy/db/development.sqlite3
+- spec/dummy/db/migrate/20170107183658_create_exportable_models.rb
+- spec/dummy/db/schema.rb
+- spec/dummy/db/test.sqlite3
+- spec/dummy/log/development.log
+- spec/dummy/log/test.log
+- spec/exportable/class_methods_spec.rb
+- spec/exportable/csv_exporter_spec.rb
+- spec/exportable/export_methods_spec.rb
+- spec/exportable/xls_exporter_spec.rb
+- spec/spec_helper.rb
+- spec/support/helper.rb
+homepage: https://github.com/chackoantony/exportable
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Exporting Rails ActiveRecord models.
+test_files:
+- spec/support/helper.rb
+- spec/dummy/db/schema.rb
+- spec/dummy/db/migrate/20170107183658_create_exportable_models.rb
+- spec/dummy/db/test.sqlite3
+- spec/dummy/db/development.sqlite3
+- spec/dummy/Rakefile
+- spec/dummy/bin/bundle
+- spec/dummy/bin/update
+- spec/dummy/bin/rake
+- spec/dummy/bin/setup
+- spec/dummy/bin/rails
+- spec/dummy/config/database.yml
+- spec/dummy/config/puma.rb
+- spec/dummy/config/locales/en.yml
+- spec/dummy/config/boot.rb
+- spec/dummy/config/application.rb
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/secrets.yml
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/application_controller_renderer.rb
+- spec/dummy/config/initializers/wrap_parameters.rb
+- spec/dummy/config/initializers/session_store.rb
+- spec/dummy/config/initializers/new_framework_defaults.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/cookies_serializer.rb
+- spec/dummy/config/initializers/filter_parameter_logging.rb
+- spec/dummy/config/routes.rb
+- spec/dummy/config/cable.yml
+- spec/dummy/config/spring.rb
+- spec/dummy/log/development.log
+- spec/dummy/log/test.log
+- spec/dummy/config.ru
+- spec/dummy/app/models/exportable_model.rb
+- spec/dummy/app/models/application_record.rb
+- spec/exportable/class_methods_spec.rb
+- spec/exportable/csv_exporter_spec.rb
+- spec/exportable/export_methods_spec.rb
+- spec/exportable/xls_exporter_spec.rb
+- spec/spec_helper.rb