csv_shaper 0.1.0 → 0.1.1

data/.gitignore

@@ -2,6 +2,7 @@
 *.rbc
 .bundle
 .config
+.rvmrc
 .yardoc
 Gemfile.lock
 InstalledFiles

data/README.md

@@ -2,7 +2,7 @@
 
 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.
+Creating CSV files in Ruby is painful! CSV Shaper makes life easier! It's ideal for converting database backed models with attributes into CSV output. It can be used without Rails, but works great with ActiveRecord models and even comes with support for its own template handling.
 
 [![Build Status](https://secure.travis-ci.org/paulspringett/csv_shaper.png?branch=master)](http://travis-ci.org/paulspringett/csv_shaper)
 
@@ -12,7 +12,7 @@ Annotated source: http://paulspringett.github.com/csv_shaper/
 
 ```ruby
 csv_string = CsvShaper::Shaper.encode do |csv|
-  csv.header :name, :age, :gender, :pet_names
+  csv.headers :name, :age, :gender, :pet_names
   
   csv.rows @users do |csv, user|
     csv.cells :name, :age, :gender
@@ -56,9 +56,23 @@ end
 
 ### 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.
+When using it in Rails your view template is rendered 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
+In Rails the example at the top of the README would simply be:
+
+```ruby
+csv.headers :name, :age, :gender, :pet_names
+
+csv.rows @users do |csv, user|
+  csv.cells :name, :age, :gender
+  
+  if user.pets.any?
+    csv.cell :pet_names
+  end
+end
+```
+
+Create a Rails view, set the content-type to `csv` and the handler to `shaper`. For the view of the `index` action the filename would be:
 
     index.csv.shaper
     
@@ -103,6 +117,8 @@ This would create headers like so:
 Full name,Age,Region
 ```
 
+The mappings are useful for pretty-ing up the names when creating the CSV. When creating cells below you should still use the column names, not the mapping names. eg. `:name` not `'Full name'`
+
 ### Rows & Cells
 
 CSV Shaper allows you to define rows and cells in a variety of ways.
@@ -122,22 +138,34 @@ end
 csv.row @user, :name, :age, :location
 ```
 
-This will call the column names (name, age...) on @user and assign them to the correct cells.
+This will call the column names (name, age...) on `@user` and assign them to the correct cells. The output from the above Ruby might look like:
+
+```
+Paul,27,United Kingdom
+```
 
 #### Passing a model to a block
 
 ```ruby
-csv.row @user, do |csv, user|
+csv.row @user do |csv, user|
   csv.cells :name, :age
   if user.show_gender?
     csv.cell :gender
   end
 
-  csv.cell :exported_at, Time.now
+  csv.cell :exported_at, Date.today.to_formatted_s(:db)
 end
 ```
 
-Any calls here to `cell` or `cells` without a value are called on the model (`user`), otherwise the second parameter is assigned.
+Any calls here to `cell` without a second argument are called on the model (`user`), otherwise the second parameter is used as a static value.
+
+The `cells` method only takes a list of Symbols that are called as methods on the model (`user`).
+
+The output from the above Ruby might look like:
+ 
+```
+Paul,27,Male,2012-07-25
+```
 
 ### Multiple Rows
 
@@ -191,6 +219,15 @@ def index
 end
 ```
 
+### Contributing
+
+1. Fork it
+2. Create a semantically named feature branch
+3. Write your feature
+4. Add some tests for it
+5. Commit your changes & push to GitHub (do not change the gem's version number)
+6. Submit a pull request with relevant details
+
 ##### Hat tips
 
 * [Jbuilder](https://github.com/rails/jbuilder/) for inspiration for the DSL

data/lib/csv_shaper/version.rb

@@ -1,3 +1,3 @@
 module CsvShaper
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/csv_shaper_template.rb

@@ -27,7 +27,7 @@ class CsvShaperHandler
       unless defined?(ActionMailer) && defined?(ActionMailer::Base) && controller.is_a?(ActionMailer::Base)
         @filename ||= "\#{controller.action_name}.csv"
         controller.response.headers["Content-Type"] ||= 'text/csv'
-        controller.response.headers['Content-Disposition'] = "attachment; filename='\#{@filename}'"
+        controller.response.headers['Content-Disposition'] = "attachment; filename=\\\"\#{@filename}\\\""
       end
 
       CsvShaperTemplate.encode(self) do |csv|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: csv_shaper
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-23 00:00:00.000000000 Z
+date: 2012-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70169242549620 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70169242549620
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70169242545580 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70169242545580
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70169242544220 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +53,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70169242544220
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 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
@@ -95,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.16
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Beautiful DSL for creating CSV output in Ruby & Rails
@@ -106,4 +121,3 @@ test_files:
 - spec/header_spec.rb
 - spec/row_spec.rb
 - spec/spec_helper.rb
-has_rdoc: