render_csv 0.0.0 → 0.0.1

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/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,109 @@
+PATH
+  remote: .
+  specs:
+    render_csv (0.0.1)
+      rails (>= 3.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.2.6)
+      actionpack (= 3.2.6)
+      mail (~> 2.4.4)
+    actionpack (3.2.6)
+      activemodel (= 3.2.6)
+      activesupport (= 3.2.6)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.1)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.3)
+    activemodel (3.2.6)
+      activesupport (= 3.2.6)
+      builder (~> 3.0.0)
+    activerecord (3.2.6)
+      activemodel (= 3.2.6)
+      activesupport (= 3.2.6)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.6)
+      activemodel (= 3.2.6)
+      activesupport (= 3.2.6)
+    activesupport (3.2.6)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.0)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    hike (1.2.1)
+    i18n (0.6.0)
+    journey (1.0.4)
+    json (1.6.7)
+    mail (2.4.4)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.19)
+    multi_json (1.3.6)
+    polyglot (0.3.3)
+    rack (1.4.1)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rails (3.2.6)
+      actionmailer (= 3.2.6)
+      actionpack (= 3.2.6)
+      activerecord (= 3.2.6)
+      activeresource (= 3.2.6)
+      activesupport (= 3.2.6)
+      bundler (~> 1.0)
+      railties (= 3.2.6)
+    railties (3.2.6)
+      actionpack (= 3.2.6)
+      activesupport (= 3.2.6)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.10.0)
+      rspec-core (~> 2.10.0)
+      rspec-expectations (~> 2.10.0)
+      rspec-mocks (~> 2.10.0)
+    rspec-core (2.10.1)
+    rspec-expectations (2.10.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.10.1)
+    rspec-rails (2.10.1)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec (~> 2.10.0)
+    sprockets (2.1.3)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.6)
+    thor (0.15.4)
+    tilt (1.3.3)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.33)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  json (~> 1.6.5)
+  render_csv!
+  rspec-rails (~> 2.10.0)
+  sqlite3 (~> 1.3.6)

data/README.md

@@ -0,0 +1,88 @@
+# render_csv
+
+Rails 3 CSV renderer for ActiveRecord collections
+
+## 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 to render_csv
+
+* 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.
+
+## Copyright
+
+Copyright (c) 2011-2012 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/lib/render_csv/version.rb

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

data/render_csv.gemspec

@@ -0,0 +1,23 @@
+# -*- 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 3 applications"
+  gem.summary       = "Adds a custom CSV renderer to Rails 3 applications"
+  gem.homepage      = "http://github.com/beerlington/render_csv"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "render_csv"
+  gem.require_paths = ["lib"]
+  gem.version       = RenderCsv::VERSION
+
+  gem.add_dependency('rails', '>= 3.0')
+
+  gem.add_development_dependency('rspec-rails', '~> 2.10.0')
+  gem.add_development_dependency('sqlite3', '~> 1.3.6')
+  gem.add_development_dependency('json', '~> 1.6.5')
+
+end

data/spec/lib/array_spec.rb

@@ -0,0 +1,73 @@
+require './spec/spec_helper'
+
+describe Array do
+  let(:sebastian) { Dog.create!(:name => 'Sebastian', :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] }
+
+  it 'should return an empty string if array is empty' do
+    [].to_csv.should eql('')
+  end
+
+  it 'should return return a csv of the array if it is not an AR class' do
+    [1,2,3].to_csv.should eql('1,2,3')
+  end
+
+  it 'should return a all columns with no option' do
+    csv = ["id,name,age,weight"]
+    csv << ["#{sebastian.id},Sebastian,3,76.8"]
+    csv << ["#{ruby.id},Ruby,3,68.2"]
+    csv << ["#{shelby.id},Shelby,5,64.0"]
+
+    array.to_csv.should eql(csv.join("\n"))
+  end
+
+  it 'should include only columns specified' do
+    csv = ["name,age"]
+    csv << ["Sebastian,3"]
+    csv << ["Ruby,3"]
+    csv << ["Shelby,5"]
+
+    options = {:only => [:name, :age] }
+
+    array.to_csv(options).should eql(csv.join("\n"))
+
+  end
+
+  it 'should exclude columns specified' do
+    csv = ["id,name,weight"]
+    csv << ["#{sebastian.id},Sebastian,76.8"]
+    csv << ["#{ruby.id},Ruby,68.2"]
+    csv << ["#{shelby.id},Shelby,64.0"]
+
+    options = {:except => [:age] }
+
+    array.to_csv(options).should eql(csv.join("\n"))
+  end
+
+  it 'should include method values when specified' do
+    csv = ["id,name,age,weight,human_age"]
+    csv << ["#{sebastian.id},Sebastian,3,76.8,25"]
+    csv << ["#{ruby.id},Ruby,3,68.2,25"]
+    csv << ["#{shelby.id},Shelby,5,64.0,33"]
+
+    options = {:add_methods => [:human_age] }
+
+    array.to_csv(options).should eql(csv.join("\n"))
+
+  end
+
+  it 'should include method values with other options' do
+    csv = ["age,weight,human_age"]
+    csv << ["3,76.8,25"]
+    csv << ["3,68.2,25"]
+    csv << ["5,64.0,33"]
+
+    options = {:except => [:id,:name], :add_methods => [:human_age] }
+
+    array.to_csv(options).should eql(csv.join("\n"))
+
+  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 'rspec'
+require 'active_record'
+require 'render_csv'
+
+# 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_enabled = 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

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: render_csv
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,89 +9,94 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-07-30 00:00:00.000000000Z
+date: 2012-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70359766159360 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70359766159360
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: &70359766158760 !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *70359766158760
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: &70359766158260 !ruby/object:Gem::Requirement
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.6.0
+        version: 2.10.0
   type: :development
   prerelease: false
-  version_requirements: *70359766158260
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: &70359766157780 !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :development
-  prerelease: false
-  version_requirements: *70359766157780
+        version: 2.10.0
 - !ruby/object:Gem::Dependency
-  name: jeweler
-  requirement: &70359766157260 !ruby/object:Gem::Requirement
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.6.4
+        version: 1.3.6
   type: :development
   prerelease: false
-  version_requirements: *70359766157260
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.6
 - !ruby/object:Gem::Dependency
-  name: rcov
-  requirement: &70359766156760 !ruby/object:Gem::Requirement
+  name: json
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.6.5
   type: :development
   prerelease: false
-  version_requirements: *70359766156760
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.5
 description: Adds a custom CSV renderer to Rails 3 applications
-email: github@lette.us
+email:
+- github@lette.us
 executables: []
 extensions: []
-extra_rdoc_files:
-- LICENSE.txt
-- README.rdoc
+extra_rdoc_files: []
 files:
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
 - lib/render_csv.rb
 - lib/render_csv/extension.rb
-- LICENSE.txt
-- README.rdoc
+- lib/render_csv/version.rb
+- render_csv.gemspec
+- spec/lib/array_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/beerlington/render_csv
-licenses:
-- MIT
+licenses: []
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -104,17 +109,22 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2383263138295080423
+      hash: 3585876132328497061
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 3585876132328497061
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.6
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Provides CSV rendering support to Rails 3 applications
-test_files: []
+summary: Adds a custom CSV renderer to Rails 3 applications
+test_files:
+- spec/lib/array_spec.rb
+- spec/spec_helper.rb

data/README.rdoc

@@ -1,19 +0,0 @@
-= render_csv
-
-Description goes here.
-
-== Contributing to render_csv
- 
-* 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.
-
-== Copyright
-
-Copyright (c) 2011 Peter Brown. See LICENSE.txt for
-further details.
-