collection2csv 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 43ae44a7c263e2b23ab48ec1fe14f2953be6b780
-  data.tar.gz: 7def884e570400c259567f02d658dbf737277157
+  metadata.gz: 2a03592303be2e3e37bc565307258beff0c0676d
+  data.tar.gz: 4f9aa3248e6ae78e160d63c02a6e8037ed1f23f5
 SHA512:
-  metadata.gz: 1882a29a6ff91646cda97de146fd0843f069f6ebf510dbe55813563c76e079cf93f938e38d755fceada81faaf1c7c765354ec7c3533aba33afa3d7d20af5c8b3
-  data.tar.gz: 69649b2bdd4534f9343791007be068b48b55b2908a2077cab4b5c70d529682125c7b7855ef9d328e1e7fe674513110af4351cfccb00f50828761c54b2bc4ed51
+  metadata.gz: 1294c69e6506a36223dc725ab176737fed4169d78aabfa7ccd773660321c9ca7122949f051377629142e776535682f04488afc38f394f4bb36666032853085c9
+  data.tar.gz: 9e3dcbee2cb5512aec40caeb3b85a26081c292c6888a887a572bbee523ab3c42933d9659513c47f63b9f31e6791c649e3b8ee252034a5682a9c212cb2bf60c33

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+/gemfiles/*.lock

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -1,8 +1,26 @@
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.4
-  - 2.1.5
-  - 2.2.1
-before_install: gem install bundler -v 1.10.6
+  - 2.2.5
+  - 2.3.1
+  - ruby-head
+
+before_install: gem install bundler
+
+before_script:
+  - cd spec/dummy_app
+  - bundle exec rake db:create db:migrate
+  - cd ../../
+
+
+cache: bundler
+
+
+gemfile:
+  - gemfiles/rails_4.0.gemfile
+  - gemfiles/rails_4.1.gemfile
+  - gemfiles/rails_4.2.gemfile
+  - gemfiles/rails_5.0.gemfile
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/Appraisals

@@ -0,0 +1,23 @@
+appraise "rails-4.0" do
+  gem "rails", "4.0"
+  gem "sqlite3"
+  gem "database_cleaner"
+  end
+
+appraise "rails-4.1" do
+  gem "rails", "4.1"
+  gem "sqlite3"
+  gem "database_cleaner"
+end
+
+appraise "rails-4.2" do
+  gem "rails", "4.2"
+  gem "sqlite3"
+  gem "database_cleaner"
+end
+
+appraise "rails-5.0" do
+  gem "rails", "5.0"
+  gem "sqlite3"
+  gem "database_cleaner"
+end

data/Gemfile

@@ -1,4 +1,4 @@
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in collection2csv.gemspec
-gemspec
+gemspec

data/README.md

@@ -26,14 +26,27 @@ Or install it yourself as:
 
 Use the collection_download helper like any other regular tag helper :
 
-	<%= collection_download(@collection) %>
+    <%= collection_download(@activerecord_collection) %>
+
+    eg: <%= collection_download(@users) %>
 
 In order to select a particular columns use column names as follows
 
-	<%= collection_download(@collection,'column_name1,column_name2') %>
+    <%= collection_download(@activerecord_collection, {columns: ['id','name']}) %>
+
+    eg: <%= collection_download(@users, {columns: ['id','name']}) %>
+
+Download link text can be provided as follows
+
+    <%= collection_download(@activerecord_collection, {link_text: 'export'}) %>
 
-Note: @collection is a ActiveRecord Collection
+    eg: <%= collection_download(@users, {link_text: 'export'}) %>
 
+Supports Associations
+
+    <%= collection_download(@activerecord_collection, {columns: ['id','name'], associations: {association_name: ['id','name']}}) %>
+
+    eg: <%= collection_download(@users, {columns: ['id','name'], associations: {book: ['name', 'author']}}) %>
 
 ## Contributing
 
@@ -42,5 +55,4 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/ethira
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,4 +1,19 @@
+require "rubygems"
+require "bundler/setup"
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
-RSpec::Core::RakeTask.new
-task :default => :spec
+require "appraisal"
+
+RSpec::Core::RakeTask.new(:spec)
+
+if !ENV["APPRAISAL_INITIALIZED"] && !ENV["TRAVIS"]
+  task :default do
+    system('bundle exec rake appraisal spec')
+  end
+  task :test do
+    system('bundle exec rake appraisal spec')
+  end
+else
+  task :default => :spec
+  task :test => :spec
+end

data/app/controllers/collection2csv_controller.rb

@@ -1,27 +1,9 @@
 require 'csv'
+require 'collection2csv/convertor'
 class Collection2csvController < ApplicationController
+
   def convert
-    klass =  params[:klass].constantize
-    if params[:column_names].present?
-      column_names = params[:column_names].split(',').to_a
-    else
-      column_names = klass.column_names
-    end
-    collection = klass.find(params[:ids])
-    respond_to do |format|
-      format.csv { send_data to_csv(collection,column_names)  ,:filename => "#{klass}_#{DateTime.now.to_formatted_s(:db)}.csv"
-		 }
-    end
+    send_data Collection2csv::Convertor.new(params).perform, filename: "#{params[:klass]}_#{DateTime.now.to_formatted_s(:db)}.csv"
   end
 
-  private
-
-  def to_csv(collection,column_names)
-    CSV.generate do |csv|
-      csv << column_names.map(&:humanize)
-      collection.each do |product|
-	csv << product.attributes.values_at(*column_names)
-      end
-    end
-  end
-end
+end

data/app/helpers/collection_to_csv_helper.rb

@@ -1,8 +1,11 @@
 module CollectionToCsvHelper
-  def collection_download(collection,column_names={})
+  def collection_download(collection,options={})
+    column_names = options[:columns].presence
+    associations = options[:associations].presence
+    link_text = options[:link_text].presence || 'Download'
     klass =  collection.try(:first).class
-    raise "#{collection} is not a ActiveRecord collection" unless klass.ancestors.include?(ActiveRecord::Base)
+    raise(RuntimeError, "#{collection} is not a ActiveRecord collection") unless klass.ancestors.include?(ActiveRecord::Base)
     collection_ids = collection.map(&:id)
-    link_to "Download" , collection2csv_path(ids: collection_ids,klass: klass,format: "csv",column_names: column_names)
+    link_to link_text , collection2csv_path(ids: collection_ids,klass: klass,format: "csv",column_names: column_names,associations: associations)
   end
 end

data/collection2csv.gemspec

@@ -23,12 +23,14 @@ Gem::Specification.new do |spec|
   end
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.test_files    = `git ls-files -- Appraisals {spec,gemfiles}/*`.split("\n")
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-  spec.required_ruby_version = '>= 1.9.3'
+  spec.required_ruby_version = '>= 2.0.0'
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency "appraisal"
 
 end

data/gemfiles/rails_4.0.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "4.0"
+gem "sqlite3"
+gem "database_cleaner"
+
+gemspec :path => "../"

data/gemfiles/rails_4.1.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "4.1"
+gem "sqlite3"
+gem "database_cleaner"
+
+gemspec :path => "../"

data/gemfiles/rails_4.2.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "4.2"
+gem "sqlite3"
+gem "database_cleaner"
+
+gemspec :path => "../"

data/gemfiles/rails_5.0.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "5.0"
+gem "sqlite3"
+gem "database_cleaner"
+
+gemspec :path => "../"

data/lib/collection2csv.rb

@@ -1,12 +1,11 @@
 require "collection2csv/version"
+require "collection2csv/convertor"
 
 module Collection2csv
   class Engine < Rails::Engine
   	initializer "Collection2csv.load_app_instance_data" do |app|
-      
-        config.app_root = app.root
-      end
-    
+      config.app_root = app.root
+    end
   end
 end
 

data/lib/collection2csv/convertor.rb

@@ -0,0 +1,104 @@
+require 'csv'
+module Collection2csv
+  class Convertor
+    def initialize(params)
+      @klass =  params[:klass].constantize
+      @column_names_from_params = params[:column_names].presence
+      @associations_from_params = params[:associations].presence
+      @column_names =  @column_names_from_params || @klass.column_names
+      @associations =  @associations_from_params || {}
+      @association_class_names = {}
+      @association_column_names = []
+      @primary_ids = params[:ids]
+    end
+
+    def perform
+      validate
+      download
+    end
+
+    private
+
+    def validate
+      validate_columns if @column_names_from_params.present?
+      validate_associations if @associations_from_params.present?
+    end
+
+    def download
+      @collections = @klass.includes(@associations.try(:keys)).find(@primary_ids)
+      to_csv(@collections,@column_names,@associations)
+    end
+
+    def validate_columns
+      false_columns = @column_names - @klass.column_names
+      raise_error(false_columns,'column',@klass.name) unless false_columns.empty?
+    end
+
+    def raise_error(false_entities, pluralizer, source = nil)
+      msg = construct_error_msg(false_entities, pluralizer)
+      msg << ' in ' if source.present?
+      raise msg + source
+    end
+
+    def construct_error_msg(false_entities,pluralizer)
+      false_entities.join(', ') + ' ' + pluralizer.pluralize(false_entities.count) + ' not found'
+    end
+
+    def validate_associations
+      unless @associations.empty?
+        get_association_class_names
+        validate_association_column_names
+      end
+    end
+
+    def validate_association_keys
+      non_associative_keys = @associations.keys - @klass.reflections.keys
+      raise_error(non_associative_keys,'association') unless non_associative_keys.empty?
+    end
+
+    def get_association_class_names
+      @klass.reflect_on_all_associations.each  do |association|
+        @association_class_names["#{association.name}"] = association.options[:class_name].presence || association.name.to_s.camelize
+      end
+    end
+
+    def validate_association_column_names
+      @associations.each do |association_key , association_value|
+        false_columns = association_value - @association_class_names[association_key.to_s].constantize.column_names
+        raise_error(false_columns,'column',association_key) unless false_columns.empty?
+      end
+    end
+
+    def generate_header
+      @header = @column_names.map(&:camelize)
+      @header += association_column_names
+    end
+
+    def association_column_names
+      @associations.each do | association_key, association_value |
+        association_value.each { |column_name| @association_column_names << "#{association_key}_#{column_name}" }
+      end
+      @association_column_names.map(&:camelize)
+    end
+
+    def generate_column_data(collection)
+      data = collection.attributes.values_at(*@column_names)
+      data = @associations.empty? ?  data : generate_column_data_for_association(collection, data)
+    end
+
+    def generate_column_data_for_association(collection, data)
+      @associations.each do  |association_key , association_value |
+        obj = collection.public_send(association_key)
+        data += obj.present? ? obj.attributes.values_at(*association_value) : Array.new(association_value.count,"")
+      end
+      data
+    end
+
+    def to_csv(collections,column_names,associations)
+      CSV.generate do |csv|
+        csv << generate_header
+        @collections.each { |collection| csv << generate_column_data(collection) }
+      end
+    end
+  end
+end

data/lib/collection2csv/version.rb

@@ -1,3 +1,3 @@
 module Collection2csv
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: collection2csv
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - ethiraj
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-14 00:00:00.000000000 Z
+date: 2016-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -39,7 +39,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  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: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -60,7 +74,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - ".travis.yml"
+- Appraisals
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -72,7 +88,12 @@ files:
 - bin/setup
 - collection2csv.gemspec
 - config/routes.rb
+- gemfiles/rails_4.0.gemfile
+- gemfiles/rails_4.1.gemfile
+- gemfiles/rails_4.2.gemfile
+- gemfiles/rails_5.0.gemfile
 - lib/collection2csv.rb
+- lib/collection2csv/convertor.rb
 - lib/collection2csv/version.rb
 homepage: https://github.com/ethirajsrinivasan/collection2csv
 licenses:
@@ -87,7 +108,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -95,8 +116,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Download ActiveRecord collection as csv
-test_files: []
+test_files:
+- Appraisals