csv_shaper 0.0.2 → 0.0.3

data/.travis.yml

@@ -0,0 +1,2 @@
+rvm:
+  - 1.9.3

data/README.md

@@ -4,6 +4,8 @@ Beautiful DSL for creating CSV output in Ruby & Rails.
 
 Creating CSV files in Ruby is painful! CSV Shaper makes life easier! It's ideal for converting database backed models with attrbiutes into CSV output. It can be used without Rails, but works great with ActiveRecord models and even comes with support for it's own template handling.
 
+[![Build Status](https://secure.travis-ci.org/paulspringett/csv_shaper.png?branch=master)](http://travis-ci.org/paulspringett/csv_shaper)
+
 ### Example Usage
 
 ```ruby
@@ -50,11 +52,15 @@ csv_string = CsvShaper::Shaper.encode do |csv|
 end
 ```
 
-If you're using it in Rails 3.0+ you are already inside the block so you can just call the `csv` object.
+### Usage in Rails 3.0+
+
+If you're using it in Rails 3.0+ you are already inside the `encode` block so you can just call the `csv` object directly.
 
 Create a Rails view, set the content-type to `csv` and the handler to `shaper`, like so
 
     index.csv.shaper
+    
+then just start defining your headers and rows as per the examples.
 
 ### Headers
 
@@ -142,4 +148,50 @@ csv.rows @users do |csv, user|
 end
 ```
 
+### Don't worry about missing cells
+
+There's no need to pad missing cells with `nil`
+
+This Ruby code will produce the CSV output below
+
+```ruby
+csv.headers :name, :age, :gender
+
+csv.row do |csv|
+  csv.cell :name, 'Paul'
+  # no age cell
+  csv.cell :gender, 'M'
+end
+
+csv.row do |csv|
+  csv.cell :name 'Joe'
+  csv.cell :age, 34
+  # no gender cell
+end
+```
+
+```
+Name,Age,Gender
+Paul,,M
+Joe,34,
+```
+
+### Further Rails integration
+
+Customise the filename of the CSV download by defining a `@filename` instance variable in your controller action.
+
+```ruby
+respond_to :html, :csv
+
+def index
+  @users = User.all
+  @filename = "All users - #{Date.today.to_formatted_s(:db)}.csv"
+end
+```
+
+##### Hat tips
+
+* [Jbuilder](https://github.com/rails/jbuilder/) for inspiration for the DSL
+* [CSV Builder](https://github.com/econsultancy/csv_builder) for headers and custom filenames
+
 Copyright (c) Paul Springett 2012

data/Rakefile

@@ -3,3 +3,5 @@ require 'bundler/gem_tasks'
 
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new('spec')
+
+task default: :spec

data/csv_shaper.gemspec

@@ -23,6 +23,6 @@ Gem::Specification.new do |gem|
   gem.version       = CsvShaper::VERSION
 
   gem.add_dependency 'activesupport', '>= 3.0.0'
-
   gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rake'
 end

data/lib/csv_shaper/version.rb

@@ -1,3 +1,3 @@
 module CsvShaper
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/csv_shaper.rb

@@ -1,4 +1,3 @@
-require 'blankslate'
 require 'active_support/ordered_hash'
 require 'active_support/inflector'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: csv_shaper
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70296967507100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,15 +21,10 @@ dependencies:
         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
+  version_requirements: *70296967507100
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70296967506200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -37,12 +32,18 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  version_requirements: *70296967506200
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70296967505200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70296967505200
 description: ! "\n    Creating CSV files in Ruby is painful! CSV Shaper makes life
   easier! It's\n    ideal for converting database backed models with attrbiutes into
   CSV output.\n    It can be used without Rails, but works great with ActiveRecord
@@ -54,6 +55,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
@@ -92,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.16
 signing_key: 
 specification_version: 3
 summary: Beautiful DSL for creating CSV output in Ruby & Rails