rails_csv_renderer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 660d1de18d4f98f836f8ece40ad26cfa0a39a075
+  data.tar.gz: 71d8cf91962e28da4c43efee012d2720db554217
+SHA512:
+  metadata.gz: 874f2818485fe8e655fb0c5d4b161407b7e837777e47431272271a698b9d89d2c43292908b69b7d92dfa9699fcbe8d7f52b9124647344fca52433c4903e76cab
+  data.tar.gz: 032513b1c958d5d2effcec6732fc1ea66fc1f0836a5fcae397673531a8bc934095e39caf37d994ae63f733aa9b485faab92396c1ae5c8e56374a30c21eecf68a

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

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

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Dennis Sheleh
+
+MIT License
+
+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,86 @@
+# rails_csv_renderer
+
+Custom CSV renderer for ActiveRecord collections
+
+## Rails & Ruby Versions Supported
+
+*Rails:* 4.x
+
+*Ruby:* 2.x
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rails_csv_renderer'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails_csv_renderer
+
+## Usage
+
+The rails_csv_renderer allows you to render any collection as CSV data. Result CSV includes all columns of model with localized column's names
+
+```ruby
+class ReportsController < ApplicationController
+  def index
+    @reports = Report.all
+
+    respond_to do |format|
+      format.csv  { render csv: @reports }
+    end
+  end
+end
+```
+
+Will render a CSV file similar to:
+
+<table>
+  <tr>
+    <th>Title</th><th>Content</th><th>Created at</th><th>Updated at</th>
+  </tr>
+  <tr>
+    <td>House report</td><td>Report about house devices</td><td>2014-07-14 01:00:42 UTC</td><td>2014-07-14 01:00:42 UTC</td>
+  </tr>
+  <tr>
+    <td>Work report</td><td>Report about work devices</td><td>2014-07-14 12:42:42 UTC</td><td>2014-07-14 12:42:42 UTC</td>
+  </tr>
+</table>
+
+### Localize column's names
+
+If you have translations for model's attributes under scope [:activerecord, :attributes, \*model_name\*] names of columns will be
+automatically translated.
+
+### Customize CSV
+
+To customize your CSV file you should add next methods to model **csv_header**(class method), **csv_row**.
+
+**csv_header** should return array with column's titles.
+
+**csv_row** should return array with values for columns.
+
+```ruby
+class Cat < ActiveRecord::Base
+  def self.csv_header
+    ["ID", "Cat's name"]
+  end
+
+  def csv_row
+    [id, name]
+  end
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/rails_csv_renderer/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/lib/rails_csv_renderer/renderable.rb

@@ -0,0 +1,62 @@
+require 'active_record'
+require 'csv'
+
+module RailsCsvRenderer
+  module Renderable
+    # Converts an collection of active records to CSV formatted string
+    # Options is configuration set for generated CSV file
+
+    def to_custom_csv(options = {})
+      csv_options = default_csv_options.merge(options)
+
+      if is_active_record?
+        if !(model.respond_to?(:csv_header) || model.respond_to?(:csv_row)) || model.class_variable_defined?(:@@dynamic_generated_csv_methods)
+          define_csv_methods(options)
+        end
+      end
+
+      CSV.generate(csv_options) do |csv|
+        if is_active_record?
+          csv << model.csv_header
+          self.each do |obj|
+            csv << obj.csv_row
+          end
+        else
+          csv << self if respond_to?(:to_csv)
+        end
+      end
+    end
+
+    private
+
+    def define_csv_methods(options)
+      columns = model.column_names
+
+      model.class_variable_set(:@@dynamic_generated_csv_methods, true)
+      model.class_eval(%Q{
+        class << self
+          def csv_header
+            ["#{ columns.map { |column_name| model.human_attribute_name(column_name) }.join('", "') }"]
+          end
+        end
+      })
+      model.class_eval(%Q{
+        def csv_row
+         [#{ columns.join(', ') }]
+       end
+      })
+    end
+
+    def is_active_record?
+      is_a?(ActiveRecord::Relation) || (present? && first.is_a?(ActiveRecord::Base))
+    end
+
+    def model
+      @model ||= is_a?(ActiveRecord::Relation) ? klass : first.class
+    end
+
+    def default_csv_options
+      { encoding: 'utf-8' }
+    end
+  end
+end

data/lib/rails_csv_renderer/renderer.rb

@@ -0,0 +1,14 @@
+require 'rails_csv_renderer/renderable'
+require 'action_controller/metal/renderers'
+
+module RailsCsvRenderer
+  class Renderer
+    def initialize!
+      ActionController::Renderers.add :csv do |obj, options|
+        filename = options[:filename] || "#{ Rails.application.class.parent_name }-report-#{ Time.current }.csv"
+        csv.extend RailsCsvRenderer::Renderable
+        data = csv.to_custom_csv(options[:csv_options])
+        send_data data, type: Mime::CSV, disposition: "attachment; filename=#{filename}"
+    end
+  end
+end

data/lib/rails_csv_renderer/version.rb

@@ -0,0 +1,3 @@
+module RailsCsvRenderer
+  VERSION = "0.1.0"
+end

data/lib/rails_csv_renderer.rb

@@ -0,0 +1,3 @@
+require "rails_csv_renderer/renderer"
+
+RailsCsvRenderer::Renderer.initialize!

data/rails_csv_renderer.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails_csv_renderer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails_csv_renderer"
+  spec.version       = RailsCsvRenderer::VERSION
+  spec.authors       = ["Dennis Sheleh"]
+  spec.email         = ["den.sheleh@gmail.com"]
+  spec.summary       = %q{Add custom csv renderer for Rails application}
+  spec.description   = %q{Add custom csv renderer for Rails application}
+  spec.homepage      = "http://github.com/den-sheleh/rails_csv_renderer"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'rails', '>= 4.0'
+
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'sqlite3'
+end

data/spec/lib/renderable_spec.rb

@@ -0,0 +1,88 @@
+# -*- encoding: utf-8 -*-
+require './spec/spec_helper'
+
+describe RailsCsvRenderer::Renderable do
+  before(:all) do
+    Person.create(first_name: 'John', last_name: 'Smith')
+    Person.create(first_name: 'Adam', last_name: 'Kowalczyk')
+    Person.create(first_name: 'Dennis', last_name: 'Menace')
+    Cat.create(name: 'Kitty')
+  end
+
+  let(:renderable_collection) { collection.extend RailsCsvRenderer::Renderable }
+
+  context 'object is a ' do
+
+    context 'nil' do
+      let(:collection) { nil }
+
+      it 'returns an empty string' do
+        expect(renderable_collection.to_custom_csv).to eql("")
+      end
+    end
+
+    context 'empty array' do
+      let(:collection) { Array.new }
+
+      it 'returns an empty string' do
+        expect(renderable_collection.to_custom_csv).to eql("\n")
+      end
+    end
+
+    context 'object is not an instance of AR class' do
+      let(:collection) { [1, 2, 3] }
+
+      it 'includes a csv of the collection' do
+        expect(renderable_collection.to_custom_csv).to eql("1,2,3\n")
+      end
+    end
+
+    context 'colection of Active Records' do
+      context 'empty ActiveRelation' do
+        let(:collection) { Person.where(first_name: 'qwerty') }
+
+        it 'includes header' do
+          expect(renderable_collection.to_custom_csv).to eql "Id,Full name\n"
+        end
+      end
+
+      context 'with elements' do
+        let(:collection) { Person.all }
+
+        context 'with localized name of atributes' do
+          before { I18n.locale = :ru }
+          after { I18n.locale = :en }
+
+          it 'includes localized column names in header' do
+            expect(renderable_collection.to_custom_csv).to eql "ID,Полное имя\n1,John Smith\n2,Adam Kowalczyk\n3,Dennis Menace\n"
+          end
+        end
+
+        context 'with csv options' do
+          it 'includes columns and methods with configured separators' do
+            options = { col_sep: "\t", row_sep: "\r\n" }
+            expect(renderable_collection.to_custom_csv(options)).to eql "Id\tFull name\r\n1\tJohn Smith\r\n2\tAdam Kowalczyk\r\n3\tDennis Menace\r\n"
+          end
+        end
+
+        context 'with undefined configuration methods' do
+          let(:owner) { Person.last }
+          let(:collection) { Cat.all }
+
+          it 'includes csv with all model columns' do
+            owner.cats << Cat.first
+            expect(renderable_collection.to_custom_csv).to eql "Id,Name,Person\n1,Kitty,#{ owner.id }\n"
+          end
+        end
+      end
+
+      context 'object is array of ActiveRecords' do
+        let(:collection) { [Person.first] }
+
+        it 'includes a csv of the collection' do
+          expect(renderable_collection.to_custom_csv).to eql "Id,Full name\n1,John Smith\n"
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'i18n'
+require 'rspec'
+require 'rails_csv_renderer/renderable'
+
+if defined? I18n
+  I18n.enforce_available_locales = false
+  I18n.load_path << File.expand_path('../support/locales/ru.yml', __FILE__)
+end
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }

data/spec/support/cat.rb

@@ -0,0 +1,4 @@
+class Cat < ActiveRecord::Base
+  validates_presence_of :name
+  belongs_to :person
+end

data/spec/support/create_db.rb

@@ -0,0 +1,15 @@
+require 'active_record'
+
+ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:')
+
+ActiveRecord::Schema.define(version: 1) do
+  create_table :people, force: true do |t|
+    t.string :first_name
+    t.string :last_name
+  end
+
+  create_table :cats, force: true do |t|
+    t.string :name
+    t.integer :person_id
+  end
+end

data/spec/support/locales/ru.yml

@@ -0,0 +1,14 @@
+ru:
+  activerecord:
+    attributes:
+      person:
+        id: ID
+        first_name: Имя
+        last_name: Фамилия
+        full_name: Полное имя
+        cats: Коты
+      cat:
+        id: ID
+        name: Кличка
+        person_id: ID хозяина
+

data/spec/support/person.rb

@@ -0,0 +1,18 @@
+class Person < ActiveRecord::Base
+  validates_presence_of :first_name, :last_name
+  has_many :cats
+
+  def full_name
+    "#{ first_name} #{ last_name }"
+  end
+
+  class << self
+    def csv_header
+      [human_attribute_name(:id), human_attribute_name(:full_name)]
+    end
+  end
+
+  def csv_row
+    [id, full_name]
+  end
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: rails_csv_renderer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dennis Sheleh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  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: rspec
+  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: 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'
+description: Add custom csv renderer for Rails application
+email:
+- den.sheleh@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rails_csv_renderer.rb
+- lib/rails_csv_renderer/renderable.rb
+- lib/rails_csv_renderer/renderer.rb
+- lib/rails_csv_renderer/version.rb
+- rails_csv_renderer.gemspec
+- spec/lib/renderable_spec.rb
+- spec/spec_helper.rb
+- spec/support/cat.rb
+- spec/support/create_db.rb
+- spec/support/locales/ru.yml
+- spec/support/person.rb
+homepage: http://github.com/den-sheleh/rails_csv_renderer
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Add custom csv renderer for Rails application
+test_files:
+- spec/lib/renderable_spec.rb
+- spec/spec_helper.rb
+- spec/support/cat.rb
+- spec/support/create_db.rb
+- spec/support/locales/ru.yml
+- spec/support/person.rb