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

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Nate Berkopec
+
+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,76 @@
+# cbuilder
+
+Cbuilder is an ultralight (< 100 LOC) CSV builder/template handler inspired by dhh's excellent
+Jbuilder. The goal is a simple DSL for creating CSV files that's better than creating
+massive custom arrays.
+
+If you're doing any more than 4-5 columns, generating CSV files can be a real pain. 
+God forbid you're not simply outputting the attributes of a simple array, and need
+helpers or other niceties.
+
+You don't need to re-invent the wheel with CSV. Cbuilder weighs in at less than 100 LOC.
+
+Have you ever found yourself doing this?
+
+```ruby
+  Customer Name,Products Purchased, Product Names 
+  <% @orders.each do |order|%>
+  <%= order.customer.name %>,<%= products_count(order) %>,<%= product_names(order.products) %>,...
+  <% end %>
+```
+
+What if you could do this instead?
+
+```ruby
+  Cbuilder.encode do |csv|
+    csv.set_collection!(@orders) do |order|
+      csv.col 'Customer Name',        order.customer.name
+      csv.col 'Products Purchased',   products_count(order)
+      csv.col 'Product Names',        product_names(order.products)
+    end
+  end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cbuilder'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cbuilder
+
+## Usage
+
+Just drop into your Rails Gemfile and start adding templates with *.csv.cbuilder.
+
+If you'd like the CSV to be downloaded as an attachment, add the following to your
+controller action:
+
+```ruby
+  response.headers["Content-Disposition"] = 'attachment; filename="my_spreadsheet.csv'
+```
+
+## TODO
+
+* Test Ruby 1.8 support
+* Test use as a partial
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Credits
+
+![http://i.imgur.com/Jd7pg.jpg](http://i.imgur.com/Jd7pg.jpg)
+
+Cbuilder was built by [Craft Coffee](http://craftcoffee.com)

data/Rakefile

@@ -0,0 +1,6 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+task :test do
+  system 'bundle exec ruby test/cbuilder_test.rb'
+end

data/cbuilder.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |gem|
+  gem.name          = "cbuilder"
+  gem.version       = "0.0.1"
+  gem.authors       = ["Nate Berkopec"]
+  gem.email         = ["nate.berkopec@gmail.com"]
+  gem.summary       = "Create CSV structures with a Builder-style DSL"
+  gem.homepage      = "http://github.com/nateberkopec/cbuilder"
+
+  gem.add_dependency 'activesupport', '>= 3.0.0'
+  
+  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"]
+end

data/lib/cbuilder.rb

@@ -0,0 +1,74 @@
+require 'active_support/basic_object'
+require 'active_support/core_ext/array/access'
+require 'active_support/core_ext/enumerable'
+require 'csv'
+
+class Cbuilder < ActiveSupport::BasicObject
+  #Yields a builder and automatically turns the result into a CSV file
+  def self.encode(*args)
+    cbuilder = new(*args)
+    yield cbuilder
+    cbuilder.target!
+  end
+
+  def initialize
+    @attributes, @headers = ::Array.new, ::Array.new
+  end
+
+  def set!(column, value)
+    @headers.push column unless @headers.include?(column)
+    @attributes.push value
+  end
+  alias_method :col, :set!
+
+  def set_collection!(collection)
+    @collection = collection
+    @attributes = if ::Kernel::block_given?
+      _map_collection(collection) { |element| if ::Proc.new.arity == 2 then yield self, element else yield element end }
+    else
+      collection
+    end
+  end
+  
+  # Encodes the current builder as CSV.
+  def target!
+    if ::RUBY_VERSION > '1.9'
+      ::CSV.generate do |csv|
+        csv << @headers # header row
+        @attributes.each do |element| # body rows
+          csv << (element.nil? ? '' : element)
+        end
+      end
+    else
+      FasterCSV.generate do |csv|
+        csv << @headers # pop header row
+        @attributes.each do |element| # body rows
+          csv << (element.nil? ? '' : element)
+        end
+      end
+    end
+  end
+
+  private
+    def _evaluate_for(element, values)
+      values.map { |value| element.send(value)}
+    end
+
+    def _map_collection(collection)
+      collection.each.map do |element|
+        _scope { yield element }
+      end
+    end
+
+    def _scope
+      parent_attributes = @attributes
+      @attributes = ::Array.new
+      yield
+      @attributes
+    ensure
+      @attributes= parent_attributes
+    end
+
+end
+
+require 'cbuilder_template' if defined? ActionView::Template

data/lib/cbuilder_template.rb

@@ -0,0 +1,29 @@
+class CbuilderTemplate < Cbuilder
+  def initialize(context, *args)
+    @context = context
+    super(*args)
+  end
+
+  def partial!(options, locals = {})
+    case options
+    when Hash
+      options[:locals] ||= {}
+      options[:locals].merge!(:csv => self)
+      @context.render(options.reverse_merge(:formats => [:csv]))
+    else
+      @context.render(:partial => options, :locals => locals.merge(:csv => self), :formats => [:csv])
+    end
+  end
+end
+
+class CbuilderHandler
+  cattr_accessor :default_format
+  self.default_format = Mime::CSV
+
+  def self.call(template)
+    %{__already_defined = defined?(csv); csv||=CbuilderTemplate.new(self); #{template.source}
+      csv.target! unless __already_defined}
+  end
+end
+
+ActionView::Template.register_template_handler :cbuilder, CbuilderHandler

data/test/cbuilder_test.rb

@@ -0,0 +1,71 @@
+require 'test/unit'
+require 'active_support/test_case'
+
+require 'cbuilder'
+
+class CbuilderTest < ActiveSupport::TestCase
+
+  @@orders = [
+              Struct.new(:number, :name).new(1138, 'Joe Schmo'),
+              Struct.new(:number, :name).new(6875309, 'Nate Berkopec')
+            ]
+
+  test "single column" do
+    csv = Cbuilder.encode do |csv|
+      csv.set_collection!(@@orders) do |order|
+        csv.col 'Order Number', order.number
+      end
+    end
+
+    assert_equal ["Order Number"], CSV.parse(csv)[0]
+    assert_equal ["1138"], CSV.parse(csv)[1]
+  end
+
+  test "single col with nil value" do
+    csv = Cbuilder.encode do |csv|
+      csv.set_collection!(@@orders) do |order|
+        csv.col 'Order Number', nil
+      end
+    end
+
+    assert CSV.parse(csv)[0] == ["Order Number"]
+    assert_equal [], CSV.parse(csv)[1]
+  end
+
+  test "multiple cols" do
+    csv = Cbuilder.encode do |csv|
+      csv.set_collection!(@@orders) do |order|
+        csv.col "Order Number",  order.number 
+        csv.col "Name",          order.name
+      end
+    end
+    
+    CSV.parse(csv).tap do |parsed|
+      assert_equal ["1138", "Joe Schmo"], parsed[1]
+      assert_equal ["6875309", "Nate Berkopec"], parsed[2]
+    end
+  end
+
+  test "protects commas" do
+    orders = [Struct.new(:number, :name).new(1138, 'Joe, Schmo')]
+    csv = Cbuilder.encode do |csv|
+      csv.set_collection!(orders) do |order|
+        csv.col "Name", order.name
+      end
+    end
+
+    assert_equal ["Joe, Schmo"], CSV.parse(csv)[1]
+  end
+
+  test "escaping quotes" do
+    orders = [Struct.new(:number, :name).new(1138, %{"Joe Schmo"})]
+    csv = Cbuilder.encode do |csv|
+      csv.set_collection!(orders) do |order|
+        csv.col "Name", order.name
+      end
+    end
+
+    assert_equal [%{"Joe Schmo"}], CSV.parse(csv)[1]
+  end
+
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: cbuilder
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Nate Berkopec
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: 
+email:
+- nate.berkopec@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- cbuilder.gemspec
+- lib/cbuilder.rb
+- lib/cbuilder_template.rb
+- test/cbuilder_test.rb
+homepage: http://github.com/nateberkopec/cbuilder
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Create CSV structures with a Builder-style DSL
+test_files:
+- test/cbuilder_test.rb