useful_renderers 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a8eaac762861879e9ba676ef24d40e093ecea7ca
+  data.tar.gz: 18d301948ae29c816ef1c28a855c9ccc3b1d49e7
+SHA512:
+  metadata.gz: 62d11b80d849da88962f0dd1ab1a2ea59119af07c694dedbf0776dcf2abd108db5353e96f3751f9db7d05bae9b3dae140b6db7302545b43c9f6cd4324081c9ad
+  data.tar.gz: ca07ed5daf59ce57078f76d86d691f355ee20c2281f007ffa59a40ee876dd0a75026016e1cb6e54992270fc5e962057a6ec9d70e95788bcfa67c702827d0cd97

data/.gitignore

@@ -0,0 +1,15 @@
+.DS_Store
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format documentation

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - 2.1.1
+  - 2.1.5
+gemfile:
+  - gemfiles/Gemfile.rails-3.0.x
+  - gemfiles/Gemfile.rails-3.1.x
+  - gemfiles/Gemfile.rails-3.2.x
+  - gemfiles/Gemfile.rails-4.0.x

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ondrej Bartas
+
+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,122 @@
+# UsefulRenderers
+
+<!-- [![Build Status](https://travis-ci.org/beerlington/render_csv.png?branch=master)](https://travis-ci.org/beerlington/render_csv)
+[![Gem Version](https://badge.fury.io/rb/render_csv.png)](http://badge.fury.io/rb/render_csv)
+[![Code Climate](https://codeclimate.com/github/beerlington/render_csv.png)](https://codeclimate.com/github/beerlington/render_csv)
+[![Dependency Status](https://gemnasium.com/beerlington/render_csv.png)](https://gemnasium.com/beerlington/render_csv)
+ -->
+Rails renderers
+
+- CSV renderer for ActiveRecord collections
+- ZIP renderer fo collection of File objects
+
+Big thanks to @beerlington and his [render_csv](https://github.com/beerlington/render_csv) gem.
+
+## Rails & Ruby Versions Supported
+
+*Rails:* 3.0.x - 4.0.x
+
+*Ruby:* 1.9.3, 2.0.0 and 2.1.0
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'useful_renderers'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install useful_renderers
+
+
+## What is it?
+
+The CSV renderer allows you to render any collection as CSV data.
+
+```ruby
+class LocationsController < ApplicationController
+  def index
+    @locations = Location.all
+
+    respond_to do |format|
+      format.csv  { render csv: @locations }
+    end
+  end
+end
+```
+
+Will render a CSV file similar to:
+
+<table>
+  <tr>
+    <th>name</th><th>address</th><th>city</th><th>state</th><th>zip</th><th>created_at</th><th>updated_at</th>
+  </tr>
+  <tr>
+    <td>Pete's House</td><td>555 House Ln</td><td>Burlington</td><td>VT</td><td>05401</td><td>2011-07-26 03:12:44 UTC</td><td>2011-07-26 03:12:44 UTC</td>
+  </tr>
+  <tr>
+    <td>Sebastians's House</td><td>123 Pup St</td><td>Burlington</td><td>VT</td><td>05401</td><td>2011-07-26 03:30:44 UTC</td><td>2011-07-26 03:30:44 UTC</td>
+  </tr>
+  <tr>
+    <td>Someone Else</td><td>999 Herp Derp</td><td>Burlington</td><td>VT</td><td>05401</td><td>2011-07-26 03:30:44 UTC</td><td>2011-07-26 03:30:44 UTC</td>
+  </tr>
+</table>
+
+## Usage Options
+
+There are a few options you can use to customize which columns are included in the CSV file
+
+### Exclude columns
+
+```ruby
+respond_to do |format|
+  format.csv  { render csv: @locations, except: [:id] }
+end
+```
+
+### Limit columns
+
+```ruby
+respond_to do |format|
+  format.csv  { render csv: @locations, only: [:address, :zip] }
+end
+```
+
+### Add methods as columns
+
+```ruby
+respond_to do |format|
+  format.csv  { render csv: @locations, add_methods: [:method1, :method2] }
+end
+```
+
+### Add methods as columns and exclude columns
+
+```ruby
+respond_to do |format|
+  format.csv  { render csv: @locations, except: [:id], add_methods: [:method1, :method2] }
+end
+```
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/useful_renderers/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
+# render_csv
+
+Rails CSV renderer for ActiveRecord collections
+
+## Copyright
+
+Copyright © 2011-2014 Peter Brown. See LICENSE.txt for render_csv.
+Copyright © 2014 Ondrej Bartas for implementation ZIP and updates of render_csv.

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/gemfiles/Gemfile.rails-3.0.x

@@ -0,0 +1,6 @@
+source :rubygems
+
+gem 'rails', '~> 3.0.0'
+gem 'rspec-rails', '~> 2.11.0'
+gem 'sqlite3-ruby', :require => 'sqlite3'
+gem 'json', '~> 1.6.5'

data/gemfiles/Gemfile.rails-3.1.x

@@ -0,0 +1,6 @@
+source :rubygems
+
+gem 'rails', '~> 3.1.0'
+gem 'rspec-rails', '~> 2.11.0'
+gem 'sqlite3'
+gem 'json', '~> 1.6.5'

data/gemfiles/Gemfile.rails-3.2.x

@@ -0,0 +1,6 @@
+source :rubygems
+
+gem 'rails', '~> 3.2.0'
+gem 'rspec-rails', '~> 2.11.0'
+gem 'sqlite3'
+gem 'json', '~> 1.6.5'

data/gemfiles/Gemfile.rails-4.0.x

@@ -0,0 +1,6 @@
+source :rubygems
+
+gem 'rails', '~> 4.0.0'
+gem 'rspec-rails', '~> 2.11'
+gem 'sqlite3'
+gem 'json', '~> 1.7'

data/lib/useful_renderers.rb

@@ -0,0 +1,26 @@
+require "useful_renderers/version"
+require 'useful_renderers/csv_renderable'
+require 'useful_renderers/zip_renderable'
+require 'action_controller/metal/renderers'
+
+module UsefulRenderers
+  class RenderUsefulRailtie < ::Rails::Railtie
+    config.after_initialize do
+
+      ActionController.add_renderer :csv do |csv, options|
+        filename = options[:filename] || options[:template]
+        csv.extend UsefulRenderers::CsvRenderable
+        data = csv.respond_to?(:to_csv) ? csv.to_csv(options) : csv
+        send_data data, type: Mime::CSV, disposition: "attachment; filename=#{filename}.csv"
+      end
+
+      ActionController.add_renderer :csv do |csv, options|
+        filename = options[:filename] || options[:template]
+        csv.extend UsefulRenderers::ZipRenderable
+        data = csv.respond_to?(:to_zip) ? csv.to_csv(options) : csv
+        send_data data, type: Mime::Zip, disposition: "attachment; filename=#{filename}.zip"
+      end
+
+    end
+  end
+end

data/lib/useful_renderers/csv_renderable.rb

@@ -0,0 +1,38 @@
+require 'csv'
+
+module UsefulRenderers
+  module CsvRenderable
+
+    # Converts an array to CSV formatted string
+    # Options include:
+    # :only => [:col1, :col2] # Specify which columns to include
+    # :except => [:col1, :col2] # Specify which columns to exclude
+    # :add_methods => [:method1, :method2] # Include addtional methods that aren't columns
+
+    def to_csv(options = {})
+      klass = first.class
+      return '' if empty?
+      return join(',') unless klass.respond_to? :column_names
+
+      columns = klass.column_names
+      columns &= options[:only].map(&:to_s)        if options[:only]
+      columns -= options[:except].map(&:to_s)      if options[:except]
+      columns += options[:add_methods].map(&:to_s) if options[:add_methods]
+
+      headers = columns.dup
+      headers.map!{|col| klass.human_attribute_name col } if options[:translate]
+
+      csv_options = {
+        encoding: 'utf-8',
+        headers: headers,
+        write_headers: true
+      }
+
+      CSV.generate(csv_options) do |row|
+        self.each do |obj|
+          row << columns.map { |c| obj.send(c) }
+        end
+      end
+    end
+  end
+end

data/lib/useful_renderers/version.rb

@@ -0,0 +1,3 @@
+module UsefulRenderers
+  VERSION = "0.0.1"
+end

data/lib/useful_renderers/zip_renderable.rb

@@ -0,0 +1,25 @@
+require 'rubygems'
+require 'zip'
+
+module UsefulRenderers
+  module ZipRenderable
+
+    # You need to call this on collection of File objects
+    # or objects which provides :read & :path method
+
+    def to_zip(*)
+      return '' if empty?
+      return '' unless first.respond_to?(:path) && first.respond_to?(:read)
+
+      stringio = Zip::OutputStream.write_buffer do |zio|
+        self.each do |obj|
+          filename = File.basename(obj.path)
+          zio.put_next_entry(filename)
+          zio.write obj.read
+        end
+      end
+      stringio.rewind
+      stringio.sysread
+    end
+  end
+end

data/spec/fixtures/test.txt

@@ -0,0 +1 @@
+FooBar

data/spec/lib/csv_renderable_spec.rb

@@ -0,0 +1,82 @@
+require './spec/spec_helper'
+
+describe UsefulRenderers::CsvRenderable do
+  let(:csv_renderable_array) { array.extend UsefulRenderers::CsvRenderable }
+
+  context 'object is an array' do
+
+    context 'array is empty' do
+      let(:array) { Array.new }
+
+      it 'returns an empty string' do
+        expect(csv_renderable_array.to_csv).to eql('')
+      end
+    end
+
+    context 'object is not an instance of AR class' do
+      let(:array) { [1, 2, 3] }
+
+      it 'returns a csv of the array' do
+        expect(csv_renderable_array.to_csv).to eql('1,2,3')
+      end
+    end
+  end
+
+  context 'object is an ActiveRecord object' do
+    let(:sebastian) { Dog.create!(name: "O'Connor", age: 3, weight: 76.8) }
+    let(:ruby)      { Dog.create!(name: 'Ruby', age: 3, weight: 68.2) }
+    let(:shelby)    { Dog.create!(name: 'Shelby', age: 5, weight: 64.0) }
+    let(:array)     { [sebastian, ruby, shelby] }
+
+    context 'options is blank' do
+      it 'returns all columns' do
+        expect(csv_renderable_array.to_csv)
+          .to eql "id,name,age,weight\n1,O'Connor,3,76.8\n2,Ruby,3,68.2\n3,Shelby,5,64.0\n"
+      end
+    end
+
+    context 'options with :only param' do
+      it 'returns only columns specified' do
+        options = { only: [:name, :age] }
+
+        expect(csv_renderable_array.to_csv(options))
+          .to eql "name,age\nO'Connor,3\nRuby,3\nShelby,5\n"
+      end
+    end
+
+    context 'options with :exclude param' do
+      it 'excludes columns specified' do
+        options = { except: [:age] }
+
+        expect(csv_renderable_array.to_csv(options))
+          .to eql "id,name,weight\n7,O'Connor,76.8\n8,Ruby,68.2\n9,Shelby,64.0\n"
+      end
+    end
+
+    context 'options with :add_methods' do
+      it 'includes specified method values' do
+        options = { add_methods: [:human_age] }
+
+        expect(csv_renderable_array.to_csv(options))
+          .to eql "id,name,age,weight,human_age\n10,O'Connor,3,76.8,25\n11,Ruby,3,68.2,25\n12,Shelby,5,64.0,33\n"
+      end
+    end
+
+    context 'options with :expect and :add_methods' do
+      it 'includes method values with other options' do
+        options = { except: [:id, :name], add_methods: [:human_age] }
+
+        expect(csv_renderable_array.to_csv(options))
+          .to eql "age,weight,human_age\n3,76.8,25\n3,68.2,25\n5,64.0,33\n"
+      end
+    end
+
+    context 'options with :translate' do
+      it 'translate header with human_attribute_name' do
+        options = { only: [:id, :name], translate: true }
+        expect(csv_renderable_array.to_csv(options))
+          .to eql "Id,Dog name\n16,O'Connor\n17,Ruby\n18,Shelby\n"
+      end
+    end
+  end
+end

data/spec/lib/zip_renderable_spec.rb

@@ -0,0 +1,47 @@
+require './spec/spec_helper'
+
+describe UsefulRenderers::ZipRenderable do
+  let(:zip_renderable_array) { array.extend UsefulRenderers::ZipRenderable }
+
+  context 'object is an array' do
+    context 'array is empty' do
+      let(:array) { Array.new }
+
+      it 'returns an empty string' do
+        expect(zip_renderable_array.to_zip).to eql('')
+      end
+    end
+
+    context 'array contains object without filename method' do
+      let(:file)  { double(read: '') }
+      let(:array) { [file] }
+
+      it 'returns an empty string' do
+        expect(zip_renderable_array.to_zip).to eql('')
+      end
+    end
+
+    context 'array contains object without read method' do
+      let(:file)  { double(filename: '') }
+      let(:array) { [file] }
+
+      it 'returns an empty string' do
+        expect(zip_renderable_array.to_zip).to eql('')
+      end
+    end
+  end
+
+  context 'object is an File object' do
+    let(:filename) { File.join(File.dirname(__FILE__),'..', 'fixtures','test.txt') }
+    let(:file)  { File.open(filename, 'r:utf-8') }
+    let(:array) { [file] }
+
+    it 'returns zip with file' do
+      expect(zip_renderable_array.to_zip).to include('test.txt')
+    end
+
+    it 'does not return zip with other file' do
+      expect(zip_renderable_array.to_zip).not_to include('other.txt')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,46 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rails/all'
+require 'rspec/rails'
+require 'useful_renderers'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+end
+
+ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:')
+
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :dogs, force: true do |t|
+    t.string  :name
+    t.integer :age
+    t.float   :weight
+  end
+end
+
+class Dog < ActiveRecord::Base
+  validates_presence_of :name, :age, :weight
+
+  def human_age
+    if age <= 2
+      (age * 10.5).to_i
+    else
+      (2 * 10.5 + (age - 2) * 4).to_i
+    end
+  end
+end
+
+translations = {
+  activerecord: {
+    attributes: {
+      dog: {
+        name: 'Dog name'
+      }
+    }
+  }
+}
+I18n.backend.store_translations(:en, translations)

data/useful_renderers.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'useful_renderers/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "useful_renderers"
+  spec.version       = UsefulRenderers::VERSION
+  spec.authors       = ["Ondrej Bartas"]
+  spec.email         = ["ondrej@bartas.cz"]
+  spec.summary       = 'Adds a custom CSV and ZIP renderer to Rails applications'
+  spec.description   = 'Adds a custom CSV and ZIP renderer to Rails applications'
+  spec.homepage      = ""
+  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', '>= 3.0'
+  spec.add_dependency 'rubyzip', '>= 1.0.0'
+
+  spec.add_development_dependency 'rspec-rails', '>= 2.12'
+  spec.add_development_dependency 'sqlite3', '>= 1.3'
+  spec.add_development_dependency 'json', '>= 1.6'
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: useful_renderers
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ondrej Bartas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Adds a custom CSV and ZIP renderer to Rails applications
+email:
+- ondrej@bartas.cz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gemfiles/Gemfile.rails-3.0.x
+- gemfiles/Gemfile.rails-3.1.x
+- gemfiles/Gemfile.rails-3.2.x
+- gemfiles/Gemfile.rails-4.0.x
+- lib/useful_renderers.rb
+- lib/useful_renderers/csv_renderable.rb
+- lib/useful_renderers/version.rb
+- lib/useful_renderers/zip_renderable.rb
+- spec/fixtures/test.txt
+- spec/lib/csv_renderable_spec.rb
+- spec/lib/zip_renderable_spec.rb
+- spec/spec_helper.rb
+- useful_renderers.gemspec
+homepage: ''
+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: Adds a custom CSV and ZIP renderer to Rails applications
+test_files:
+- spec/fixtures/test.txt
+- spec/lib/csv_renderable_spec.rb
+- spec/lib/zip_renderable_spec.rb
+- spec/spec_helper.rb