exportable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c8fd477c8ee9f17a65df411e7528b5b23f67bf71
+  data.tar.gz: 07c54ba2aed4aead783feb5aa3e078274ab5da0b
+SHA512:
+  metadata.gz: 2c4db4467f13f0dd88789b19f7c7bfea31478f8cfe802a0ad7abe7415e32945257c49ef67623620e050b57909817dbac1eba546506205f7d28883548dc4ac71d
+  data.tar.gz: da18dc818b4616b0054a4cb72ba51fa3e8f0c451bc4fdd3ed434d10d207698bd3bc854b694d854928aec043b40d5a2cbbca678e73454c7cf04d9600abef1ab58

data/.gitignore

@@ -0,0 +1,7 @@
+.bundle/
+log/*.log
+pkg/
+spec/dummy/db/*.sqlite3
+spec/dummy/db/*.sqlite3-journal
+spec/dummy/log/*.log
+spec/dummy/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+# Declare your gem's dependencies in exportable.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use a debugger
+# gem 'byebug', group: [:development, :test]

data/Gemfile.lock

@@ -0,0 +1,144 @@
+PATH
+  remote: .
+  specs:
+    exportabe (0.1.0)
+      activerecord (>= 4.0)
+      spreadsheet
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.0.1)
+      actionpack (= 5.0.1)
+      nio4r (~> 1.2)
+      websocket-driver (~> 0.6.1)
+    actionmailer (5.0.1)
+      actionpack (= 5.0.1)
+      actionview (= 5.0.1)
+      activejob (= 5.0.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.0.1)
+      actionview (= 5.0.1)
+      activesupport (= 5.0.1)
+      rack (~> 2.0)
+      rack-test (~> 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.0.1)
+      activesupport (= 5.0.1)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activejob (5.0.1)
+      activesupport (= 5.0.1)
+      globalid (>= 0.3.6)
+    activemodel (5.0.1)
+      activesupport (= 5.0.1)
+    activerecord (5.0.1)
+      activemodel (= 5.0.1)
+      activesupport (= 5.0.1)
+      arel (~> 7.0)
+    activesupport (5.0.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (7.1.4)
+    builder (3.2.2)
+    concurrent-ruby (1.0.4)
+    database_cleaner (1.5.3)
+    diff-lcs (1.2.5)
+    erubis (2.7.0)
+    globalid (0.3.7)
+      activesupport (>= 4.1.0)
+    i18n (0.7.0)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mail (2.6.4)
+      mime-types (>= 1.16, < 4)
+    method_source (0.8.2)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mini_portile2 (2.1.0)
+    minitest (5.10.1)
+    nio4r (1.2.1)
+    nokogiri (1.7.0.1)
+      mini_portile2 (~> 2.1.0)
+    rack (2.0.1)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (5.0.1)
+      actioncable (= 5.0.1)
+      actionmailer (= 5.0.1)
+      actionpack (= 5.0.1)
+      actionview (= 5.0.1)
+      activejob (= 5.0.1)
+      activemodel (= 5.0.1)
+      activerecord (= 5.0.1)
+      activesupport (= 5.0.1)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 5.0.1)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.2)
+      activesupport (>= 4.2.0, < 6.0)
+      nokogiri (~> 1.6)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (5.0.1)
+      actionpack (= 5.0.1)
+      activesupport (= 5.0.1)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (12.0.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-rails (3.5.2)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    ruby-ole (1.2.12)
+    spreadsheet (1.1.4)
+      ruby-ole (>= 1.0)
+    sprockets (3.7.1)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.0)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.3.13)
+    thor (0.19.4)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    websocket-driver (0.6.4)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  database_cleaner
+  exportabe!
+  rails (>= 4.0)
+  rspec-rails
+  sqlite3
+
+BUNDLED WITH
+   1.12.5

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Sunil Antony
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,104 @@
+# Exportable
+Exportable will help you in exporting Rails ActiveRecord models in to different output formats including CSV, XLS etc with just a one liner hook in your model. This Gem is tested against Rails 4 and 5 versions. Support for more output formats will be coming soon.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'exportable'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install exportable
+```
+
+## Usage
+Just add a one liner hook 'exportable' in your model and your model will be provided 
+with class level export methods.
+
+```ruby
+class Article < ApplicationRecord
+  exportable
+end
+```
+
+You can then use export methods on the model with supporting formats (:csv, :xls) and field options. 
+
+```ruby
+Article.export(:csv)
+Article.export(:csv, only: [:title, :user_id])
+```
+You can also call export methods on model scopes or ActiveRecord::Relation Object.
+```ruby
+Article.where(staus: 'published').export(:csv)
+```
+
+There are also format specific export methods
+
+```ruby
+Article.export_csv
+Article.export_xls header: false
+```
+
+These methods will provide a string in sepcified format which you can write directly to a file or stream through Rails controller.
+
+```ruby
+File.open('output.xls', 'wb') {|f| f.write Article.export(:xls) }
+```
+or in controller
+```ruby
+send_data Article.export(:csv), filename: 'output.csv
+```
+
+
+Following options are available for hook method and export methods. Please note that options in export methods will always take higher precedence.
+
+###:only
+
+  By default all the fields in model will be exported. You can controll the fields to export using 'only' option.
+
+```ruby
+Article.export_csv only: [:title, :published_on, :status]
+```
+
+###:except
+
+Omit exportable fields with 'except' option
+
+```ruby
+Article.export_csv except: [:status]
+```
+
+###:header
+
+By default exporting adds header row. Omit header by option 'header: false'
+
+###:methods
+
+ Exporting not only limited to model attributes. You can also add custom model methods to exportable fields.
+```ruby
+Article.export methods: [:user_name]
+```
+Note: *If your model method contains query to association please be carefull to eager load association.*
+```ruby
+Article.includes(:user).export methods: [:user_name]   
+```
+## Testing
+ This plugin uses Rspec for testing. Go to gem folder and run:
+ 
+ ```bash
+ $ rspec
+ ```
+ 
+
+## Contributing
+More output formats are always welcome. 
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,31 @@
+begin
+  require 'bundler/setup'
+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    = 'Exportable'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+
+
+
+

data/bin/test

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+$: << File.expand_path(File.expand_path('../../test', __FILE__))
+
+require 'bundler/setup'
+require 'rails/test_unit/minitest_plugin'
+
+Rails::TestUnitReporter.executable = 'bin/test'
+
+Minitest.run_via[:rails] = true
+
+require "active_support/testing/autorun"

data/exportable.gemspec

@@ -0,0 +1,27 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+# Maintain your gem's version:
+require "exportable/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = 'exportable'
+  s.version     = Exportable::VERSION
+  s.authors     = ['Sunil Antony']
+  s.email       = ['chackoantonydaniel@gmail.com']
+  s.homepage    = 'https://github.com/chackoantony/exportable'
+  s.summary     = "Exporting Rails ActiveRecord models."
+  s.description = 'Exportable will help you in exporting ActiveRecord models in to different output formats including CSV, XLS etc.'
+  s.license     = "MIT"
+  s.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  s.bindir        = "exe"
+  s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.test_files = Dir["spec/**/*"]
+  s.add_dependency 'activerecord', ['>= 4.0']
+  s.add_dependency 'spreadsheet'
+  s.add_development_dependency 'rails', ['>= 4.0']
+  s.add_development_dependency 'sqlite3'
+  s.add_development_dependency 'rspec-rails'
+  s.add_development_dependency 'database_cleaner'
+end

data/lib/exportable.rb

@@ -0,0 +1,23 @@
+# Core module for the Gem
+module Exportable
+  extend ActiveSupport::Autoload
+  mattr_accessor :formats
+  self.formats = []
+
+  autoload :ClassMethods
+  autoload :ExportMethods
+  autoload :Utils
+
+  autoload_under 'export_methods' do
+    autoload :CsvExporter
+    autoload :XlsExporter
+  end
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  include Exportable
+end

data/lib/exportable/class_methods.rb

@@ -0,0 +1,9 @@
+module Exportable
+  # This module holds Model level hook methods
+  module ClassMethods
+    def exportable(options = {})
+      @options = options
+      extend(ExportMethods)
+    end
+  end
+end

data/lib/exportable/export_methods.rb

@@ -0,0 +1,14 @@
+module Exportable
+  # This module serves as a container for export modules
+  module ExportMethods
+    include CsvExporter
+    include XlsExporter
+
+    def export(format, options = {})
+      unless Exportable.formats.include?(format.to_sym)
+        raise ArgumentError, "Unsupported output format '#{format}'"
+      end
+      send("export_#{format}", options)
+    end
+  end
+end

data/lib/exportable/export_methods/csv_exporter.rb

@@ -0,0 +1,33 @@
+module Exportable
+  module ExportMethods
+    # Module to handle only CSV exporting
+    module CsvExporter
+      include Exportable::Utils
+
+      Exportable.formats << :csv
+
+      def export_csv(options = {})
+        export_options = get_export_options(self, @options.merge(options))
+        Exporter.new(self).export(export_options)
+      end
+
+      # Exporter class for CSV Exporter
+      class Exporter
+        require 'csv'
+
+        def initialize(model)
+          @model = model
+        end
+
+        def export(options)
+          CSV.generate do |csv|
+            csv << options[:fields].map(&:to_s) if options[:header]
+            @model.where(nil).find_each do |record|
+              csv << options[:fields].map { |attr| record.send(attr).to_s }
+            end
+          end
+        end
+      end
+    end
+  end
+end