as_csv 1.0.0

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+spec/dummy/db/*.sqlite3
+spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/dummy/.sass-cache

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm: 1.9.3
+script: bundle exec rspec

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,107 @@
+PATH
+  remote: .
+  specs:
+    as_csv (0.0.1.pre)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (3.2.11)
+      actionpack (= 3.2.11)
+      mail (~> 2.4.4)
+    actionpack (3.2.11)
+      activemodel (= 3.2.11)
+      activesupport (= 3.2.11)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.11)
+      activesupport (= 3.2.11)
+      builder (~> 3.0.0)
+    activerecord (3.2.11)
+      activemodel (= 3.2.11)
+      activesupport (= 3.2.11)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.11)
+      activemodel (= 3.2.11)
+      activesupport (= 3.2.11)
+    activesupport (3.2.11)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.4)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    hike (1.2.1)
+    i18n (0.6.1)
+    journey (1.0.4)
+    json (1.7.6)
+    mail (2.4.4)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.19)
+    multi_json (1.5.0)
+    polyglot (0.3.3)
+    rack (1.4.3)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (3.2.11)
+      actionmailer (= 3.2.11)
+      actionpack (= 3.2.11)
+      activerecord (= 3.2.11)
+      activeresource (= 3.2.11)
+      activesupport (= 3.2.11)
+      bundler (~> 1.0)
+      railties (= 3.2.11)
+    railties (3.2.11)
+      actionpack (= 3.2.11)
+      activesupport (= 3.2.11)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (10.0.3)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.1)
+    rspec-rails (2.12.2)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.7)
+    thor (0.16.0)
+    tilt (1.3.3)
+    treetop (1.4.12)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.35)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  as_csv!
+  rails (~> 3.2)
+  rspec-rails (~> 2.12)
+  sqlite3

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Daniel Fone
+
+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,166 @@
+# AsCSV
+
+This gem allows you to expose CSV in your apps as you'd expose JSON or XML.
+
+Rails is not strictly required, but currently the magic only works with rails 3.x.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'as_csv'
+
+## Basic Usage
+
+Simply add `respond_to :csv` in a controller
+
+```ruby
+class WidgetsController < ApplicationController
+  respond_to :xml, :json, :csv
+
+  def index
+    respond_with Widget.all
+  end
+
+  def show
+    respond_with Widget.find(params[:id])
+  end
+
+end
+```
+
+Alternatively:
+
+```ruby
+class WidgetsController < ApplicationController
+  def index
+    respond_to do |format|
+      format.csv { render csv: Widget.all }
+    end
+  end
+
+  def show
+    respond_to do |format|
+      format.csv { render csv: Widget.find(params[:id]) }
+    end
+  end
+end
+```
+
+By default, you don't need to change your models at all.
+
+```ruby
+class Widget < ActiveRecord::Base
+  # attributes :code, :description, :name
+end
+```
+```
+> puts Widget.all.to_csv
+id,name,description,code
+1,widget-1,widget-description-1,1001
+2,widget-2,widget-description-2,1002
+3,widget-3,widget-description-3,1003
+4,widget-4,widget-description-4,1004
+ => nil
+
+> puts Widget.where(code: [1001, 1002]).to_csv
+id,name,description,code
+1,widget-1,widget-description-1,1001
+2,widget-2,widget-description-2,1002
+
+> puts Widget.first.to_csv
+id,name,description,code
+1,widget-1,widget-description-1,1001
+ => nil 
+```
+
+Behind the scenes, any classes that `include ActiveModel::Serialization` will expose their `attributes` with `to_csv`.
+
+## Advanced Usage
+
+### Customizing the CSV
+
+To change what's included in the CSV, define an `as_csv` method. This method must return a Hash.
+
+```ruby
+class Widget < ActiveRecord::Base
+  # attributes :code, :description, :name
+
+  def as_csv(options={})
+    attributes.slice('name', 'code')
+  end
+
+end
+```
+```
+> puts Widget.all.to_csv
+name,code
+widget-1,1001
+widget-2,1002
+widget-3,1003
+widget-4,1004
+ => nil 
+>
+```
+
+You can also accept options:
+
+```ruby
+class WidgetsController < ApplicationController
+  respond_to :csv
+
+  def index
+    respond_with Widget.all, style: :short
+  end
+end
+```
+```ruby
+class Widget < ActiveRecord::Base
+  attr_accessible :code, :description, :name
+
+  def as_csv(options={})
+    if options[:style] == :short
+      attributes.slice('name', 'code')
+    else
+      attributes
+    end
+  end
+
+end
+```
+
+### Heterogenous Arrays
+You can render any Array of objects that respond to `as_csv`.
+
+```ruby
+class Foo < ActiveRecord::Base
+  # attributes: name, description, code
+end
+```
+```ruby
+class Bar < ActiveRecord::Base
+  # attributes: name, description, barcode
+end
+```
+```
+> puts (Foo.all + Bar.all).to_csv
+name,description,code,barcode
+foo1,foo1-description,111,
+foo2,foo2-description,222,
+bar1,bar1-description,,acb12345
+bar2,bar2-description,,xyz98765
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Ensure you've got development dependencies: (`bundle`)
+4. Ensure existing tests run: (`bundle exec rspec`)
+5. Make your changes, including new specs
+6. Commit your changes (`git commit -am 'Add some feature'`)
+7. Push to the branch (`git push origin my-new-feature`)
+8. Create new Pull Request
+
+[![Build Status](https://travis-ci.org/danielfone/as_csv.png)](https://travis-ci.org/danielfone/as_csv)
+[![Dependency Status](https://gemnasium.com/danielfone/as_csv.png)](https://gemnasium.com/danielfone/as_csv)

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/as_csv.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'as_csv/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "as_csv"
+  gem.version       = AsCSV::VERSION
+  gem.authors       = ["Daniel Fone"]
+  gem.email         = ["daniel@fone.net.nz"]
+  gem.description   = %q{Instant CSV support for Rails}
+  gem.summary       = %q{Instant CSV support for Rails}
+  gem.homepage      = "https://github.com/danielfone/as_csv"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "rails", "~> 3.2"
+  gem.add_development_dependency "rspec-rails", "~> 2.12"
+  gem.add_development_dependency "sqlite3"
+end

data/lib/as_csv/action_renderer.rb

@@ -0,0 +1,5 @@
+if defined? ActionController::Renderers
+  ActionController::Renderers.add :csv do |obj, options|
+    obj.respond_to?(:to_csv) ? obj.to_csv(options) : obj
+  end
+end

data/lib/as_csv/active_model.rb

@@ -0,0 +1,11 @@
+if defined? ActiveModel::Serialization
+  module ActiveModel::Serialization
+    def as_csv(options={})
+      attributes
+    end
+
+    def to_csv(*args)
+      [self].to_csv(*args)
+    end
+  end
+end

data/lib/as_csv/core_ext/array.rb

@@ -0,0 +1,7 @@
+class Array
+  def to_csv_with_builder(opts={})
+    AsCSV::CSVBuilder.new(self, opts).to_csv || to_csv_without_builder
+  end
+  alias_method :to_csv_without_builder, :to_csv
+  alias_method :to_csv, :to_csv_with_builder
+end

data/lib/as_csv/csv_builder.rb

@@ -0,0 +1,46 @@
+module AsCSV
+  class CSVBuilder
+    attr_reader :records, :options
+
+    def initialize(records, options={})
+      @records = [*records]
+      @options = options
+    end
+
+    def to_csv
+      rows.collect { |row| CSV.generate_line row }.join if valid?
+    end
+
+    def rows
+      @rows ||= [headers] + data_rows if valid?
+    end
+
+    def headers
+      @headers ||= csv_hashes.collect(&:keys).flatten.uniq if valid?
+    end
+
+    def data_rows
+      @data_rows ||= csv_hashes.collect { |csv_hash| data_row csv_hash } if valid?
+    end
+
+    def valid?
+      csv_hashes.any? && validate_hashes!
+    end
+
+    private
+
+      def validate_hashes!
+        csv_hashes.each do |hash|
+          raise TypeError, "expected as_csv to return Hash" unless hash.is_a? Hash
+        end
+      end
+
+      def csv_hashes
+        @csv_hashes ||= records.collect { |r| r.as_csv(options) if r.respond_to? :as_csv }.compact
+      end
+
+      def data_row(csv_hash)
+        headers.collect { |header| csv_hash[header] }
+      end
+  end  
+end

data/lib/as_csv/version.rb

@@ -0,0 +1,3 @@
+module AsCSV
+  VERSION = "1.0.0"
+end

data/lib/as_csv.rb

@@ -0,0 +1,6 @@
+require "csv"
+require "as_csv/version"
+require "as_csv/csv_builder"
+require "as_csv/core_ext/array"
+require "as_csv/active_model"
+require "as_csv/action_renderer"

data/spec/controllers/render_widgets_controller_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe RenderWidgetsController, :widgets_controllers do
+  exercise_controller
+end

data/spec/controllers/respond_with_widgets_controller_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe RespondWithWidgetsController, :widgets_controllers do
+  exercise_controller
+end

data/spec/core_ext/array_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe Array do
+  it { should respond_to(:to_csv) }
+  it { should respond_to(:to_csv_with_builder) }
+  it { should respond_to(:to_csv_without_builder) }
+
+  context 'with objects responding to `as_csv`' do
+    before { subject << stub(:foo, as_csv: {header: 'value'})}
+
+    specify do
+      AsCSV::CSVBuilder.any_instance.should_receive(:to_csv).and_call_original
+      subject.should_not_receive(:to_csv_without_builder)
+      subject.to_csv
+    end
+  end
+
+  context 'without objects responding to `as_csv`' do
+    before { subject << 1 }
+
+    specify do
+      AsCSV::CSVBuilder.any_instance.should_receive(:to_csv).and_call_original
+      subject.should_receive(:to_csv_without_builder)
+      subject.to_csv
+    end
+  end
+
+end