jeffleeismyhero-render_csv 2.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dd71cef27aadeeaa0b23e8e2dd0351954fdffac2
+  data.tar.gz: 755f0d8b9925d4472ffbb68ca318d7d30f9c6ace
+SHA512:
+  metadata.gz: bd18388cc7de7f1ba789cf9a1f88c322d1f1a1eba7604a8c2046b78bb2eb155910942c3131d04523aa3d73530a4e88e7eaed7040b19043b9b272ef1edcc6e137
+  data.tar.gz: 2c356fe2931b947fab9ac4b0fcc4f6a44347d291b5aebdce6e1614145885e2a7f5ed5fe34c32c8bf5a522a077597d7fecc6c7528749f3453df607ad0d48e6e32

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - 2.1.1
+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/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Changelog
+
+## 2.1.0
+
+ * Support for custom header row
+
+## 2.1.0 (Beta)
+
+ * Support rendering objects that already respond to `to_csv`
+
+## 2.0.0
+
+  * Removes support for Ruby 1.8.7.
+  * Moves renderer into an after_initialize block so the Rails app is
+    loaded before it tries to register itself. Should fix intermittent
+    issues with it not working in production environments.
+  * Use Ruby's CSV library instead of manually building strings.
+  * Does not extend the array class anymore
+
+## 1.0.0
+
+  * Initial Release

data/CONTRIBUTING.md

@@ -0,0 +1,8 @@
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Peter Brown
+
+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,100 @@
+# render_csv
+
+[![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 CSV renderer for ActiveRecord collections
+
+## Rails & Ruby Versions Supported
+
+*Rails:* 3.0.x - 4.0.x
+
+*Ruby:* 1.9.3, 2.0.0 and 2.1.0
+
+## Installation
+
+The gem is hosted at [rubygems.org](https://rubygems.org/gems/render_csv)
+
+## 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
+```
+
+### Specify a custom header row
+
+```ruby
+respond_to do |format|
+  format.csv  { render csv: @locations, header: 'Address', 'Zip Code', only: [:address, :zip] }
+end
+```
+
+## Copyright
+
+Copyright © 2011-2014 Peter Brown. See LICENSE.txt for
+further details.

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/render_csv.rb

@@ -0,0 +1,15 @@
+module RenderCsv
+  class RenderCsvRailtie < ::Rails::Railtie
+    config.after_initialize do
+      require 'render_csv/csv_renderable'
+      require 'action_controller/metal/renderers'
+
+      ActionController.add_renderer :csv do |csv, options|
+        filename = options[:filename] || options[:template]
+        csv.extend RenderCsv::CsvRenderable unless csv.respond_to?(:to_csv)
+        data = csv.to_csv(options)
+        send_data data, type: Mime::CSV, disposition: "attachment; filename=#{filename}.csv"
+      end
+    end
+  end
+end

data/lib/render_csv/csv_renderable.rb

@@ -0,0 +1,28 @@
+require 'csv'
+
+module RenderCsv
+  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
+    # :header => ['Col1', 'Col2'] # Explicitly set the header
+    def to_csv(options = {})
+      return '' if empty?
+      return join(',') unless first.class.respond_to? :column_names
+
+      columns = first.class.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]
+
+      CSV.generate(encoding: 'utf-8') do |row|
+        row << options[:header] ||= columns
+        self.each do |obj|
+          row << columns.map { |c| obj.send(c) }
+        end
+      end
+    end
+  end
+end

data/lib/render_csv/version.rb

@@ -0,0 +1,3 @@
+module RenderCsv
+  VERSION = "2.1.1"
+end

data/render_csv.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/render_csv/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Peter Brown"]
+  gem.email         = ["github@lette.us"]
+  gem.description   = "Adds a custom CSV renderer to Rails applications"
+  gem.summary       = "Adds a custom CSV renderer to Rails applications"
+  gem.homepage      = "http://github.com/beerlington/render_csv"
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "jeffleeismyhero-render_csv"
+  gem.require_paths = ["lib"]
+  gem.version       = RenderCsv::VERSION
+
+  gem.add_dependency('rails', '>= 3.0')
+
+  gem.add_development_dependency('rspec-rails', '>= 2.12')
+  gem.add_development_dependency('sqlite3', '>= 1.3')
+  gem.add_development_dependency('json', '>= 1.6')
+
+end

data/spec/lib/csv_renderable_spec.rb

@@ -0,0 +1,77 @@
+require './spec/spec_helper'
+
+describe RenderCsv::CsvRenderable do
+  let(:csv_renderable_array) { array.extend RenderCsv::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: "Sebastian 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,Sebastian 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\nSebastian O'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,Sebastian 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,Sebastian 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 :header param' do
+      it 'returns header specified' do
+        options = { header: ['Name', 'Age'], only: [:name, :age] }
+
+        expect(csv_renderable_array.to_csv(options)).to eql "Name,Age\nSebastian O'Connor,3\nRuby,3\nShelby,5\n"
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,36 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rails/all'
+require 'rspec/rails'
+require 'render_csv/csv_renderable'
+
+# 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|
+  config.color = true
+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

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: jeffleeismyhero-render_csv
+version: !ruby/object:Gem::Version
+  version: 2.1.1
+platform: ruby
+authors:
+- Peter Brown
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-27 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: 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'
+description: Adds a custom CSV renderer to Rails applications
+email:
+- github@lette.us
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CHANGELOG.md
+- CONTRIBUTING.md
+- 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/render_csv.rb
+- lib/render_csv/csv_renderable.rb
+- lib/render_csv/version.rb
+- render_csv.gemspec
+- spec/lib/csv_renderable_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/beerlington/render_csv
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Adds a custom CSV renderer to Rails applications
+test_files:
+- spec/lib/csv_renderable_spec.rb
+- spec/spec_helper.rb
+has_rdoc: