csv_shaper 0.0.3 → 0.1.0

data/.groc.json

@@ -0,0 +1,4 @@
+{
+  "glob": ["lib/*.rb", "lib/csv_shaper/*.rb", "README.md"],
+  "github": true
+}

data/README.md

@@ -6,6 +6,8 @@ Creating CSV files in Ruby is painful! CSV Shaper makes life easier! It's ideal
 
 [![Build Status](https://secure.travis-ci.org/paulspringett/csv_shaper.png?branch=master)](http://travis-ci.org/paulspringett/csv_shaper)
 
+Annotated source: http://paulspringett.github.com/csv_shaper/
+
 ### Example Usage
 
 ```ruby

data/lib/csv_shaper/encoder.rb

@@ -1,6 +1,12 @@
 require 'csv'
 
 module CsvShaper
+  # Encoder
+  # Takes a Header and Array of Rows and converts them to a valid CSV formatted String
+  # Example:
+  # ```
+  # CsvShaper::Encoder.new(@header, @rows).to_csv
+  # ```
   class Encoder
     def initialize(header, rows = [])
       if header.nil?
@@ -26,7 +32,7 @@ module CsvShaper
     
     private
     
-    # Internal: make use of CSV#values_at to pad out the
+    # Internal: make use of `CSV#values_at` to pad out the
     # cells into the correct columns for the headers
     #
     # Returns an Array of Arrays

data/lib/csv_shaper/header.rb

@@ -1,20 +1,20 @@
 module CsvShaper
-  
   # Header
   # Handles creating and mapping of the headers
   # Examples:
-  #   # assign the headers from the attributes of a class
-  #   csv.headers User
+  # ``` 
+  # # assign the headers from the attributes of a class
+  # csv.headers User
   # 
-  #   # assigns headers normally
-  #   csv.headers :name, :age, :location
+  # # assigns headers normally
+  # csv.headers :name, :age, :location
   # 
-  #   # pass a block
-  #   csv.headers do |csv|
-  #     csv.columns :name, :age, :location
-  #     csv.mappings name: 'Full name, location: 'Region'
-  #   end
-  #
+  # # pass a block
+  # csv.headers do |csv|
+  #   csv.columns :name, :age, :location
+  #   csv.mappings name: 'Full name, location: 'Region'
+  # end
+  # ```
   class Header
     attr_reader :klass, :mappings, :mapped_columns
 
@@ -22,14 +22,11 @@ module CsvShaper
       @mappings = {}
       @columns = []
 
-      # csv.headers do |head|
       if block_given?
         yield self
       elsif args.any?
-        # csv.headers User
         if (@klass = args.first.respond_to?(:attribute_names) && args.first)
           columns(*@klass.attribute_names)
-        # csv.headers :name, :age, :location
         else
           columns(*args)
         end
@@ -40,9 +37,10 @@ module CsvShaper
     # of Symbol column names. Union join the existing column
     # names with those passed
     # Example:
-    #   header.columns :name, :age, :location
-    #
-    #   args - Array of Symbol arguments passed
+    # ```
+    # header.columns :name, :age, :location
+    # ```
+    # `args` - Array of Symbol arguments passed
     #
     # Returns as Array of Symbols
     def columns(*args)
@@ -52,9 +50,10 @@ module CsvShaper
     # Public: Define mappings of the Symbol column names
     # to nicer, human names
     # Example:
-    #   header.mappings name: 'Full name', age: 'Age of person'
-    #
-    #   hash - Hash of mappings where the key is the column name to map
+    # ```
+    # header.mappings name: 'Full name', age: 'Age of person'
+    # ```
+    # `hash` - Hash of mappings where the key is the column name to map
     #          and the value is the human readable value
     #
     # Returns a Hash of mappings

data/lib/csv_shaper/row.rb

@@ -4,36 +4,32 @@ module CsvShaper
   # Handles creating of cells within a row and
   # assigning of the model's values to cells
   # Examples:
-  #   # pass a model to the row
-  #   csv.row @model do |csv, model|
-  #     ...
-  #   end
+  # ```
+  # # pass a model to the row
+  # csv.row @model do |csv, model|
+  #   ...
+  # end
   # 
-  #   # create an empty row instance
-  #   csv.row do |csv|
-  #     ...
-  #   end
+  # # create an empty row instance
+  # csv.row do |csv|
+  #   ...
+  # end
   # 
-  #   # create a row with prefilled cells from a model
-  #   # note no block is passed
-  #   csv.row @model, :name, :age, :location
-  #
+  # # create a row with prefilled cells from a model
+  # # note no block is passed
+  # csv.row @model, :name, :age, :location
+  # ```
   class Row
     attr_reader :model, :cells
     
     def initialize(*args)
       @cells = ActiveSupport::OrderedHash.new
 
-      # csv.row @user do |csv, user|
       if args.one? && block_given?
         @model = args.first
         yield self, @model
-      
-      # csv.row do |csv|
       elsif args.empty? && block_given?
         yield self
-      
-      # csv.row @user, :name, :age, :location
       elsif args.length > 1
         @model = args.shift
         args.each { |col| cell(col) }
@@ -44,7 +40,7 @@ module CsvShaper
     
     # Public: assign the given Array of args to cells in this Row
     #
-    #   args - Array of the arguments passed (expected to be Symbols)
+    # `args` - Array of the arguments passed (expected to be Symbols)
     #
     # Returns an Array of the Cells in this row
     def cells(*args)
@@ -57,8 +53,8 @@ module CsvShaper
     # call that method on the @model and assign it to a column of
     # the same name. Otherwise a value will need to be passed also
     #
-    #   column - Symbol of the column to add to value to
-    #   value - data to assign to the cell (default: nil)
+    # `column` - Symbol of the column to add to value to
+    # `value` - data to assign to the cell (default: nil)
     #
     # Returns an Array of the Row's cells
     def cell(column, value = nil)
@@ -72,6 +68,5 @@ module CsvShaper
       
       @cells
     end
-    
   end
 end

data/lib/csv_shaper/shaper.rb

@@ -1,4 +1,6 @@
 module CsvShaper
+  # Shaper
+  # Core CsvShaper class. Delegates header and row generating.
   class Shaper
     attr_reader :header, :rows
     
@@ -10,14 +12,16 @@ module CsvShaper
     # Public: creates a new instance of Shaper taps it with
     # with the given block and encodes it to a String of CSV data
     # Example:
-    #   data = CsvShaper::Shaper.encode do |csv|
-    #     csv.rows @users do |csv, user|
-    #       csv.cells :name, :age, :gender
-    #     end
+    # ```
+    # data = CsvShaper::Shaper.encode do |csv|
+    #   csv.rows @users do |csv, user|
+    #     csv.cells :name, :age, :gender
     #   end
+    # end
     #
-    #  puts data
-    #  => "Name,Age,Gender\n'Joe Bloggs',25,'M'\n'John Smith',34,'M'" 
+    # puts data
+    # => "Name,Age,Gender\n'Joe Bloggs',25,'M'\n'John Smith',34,'M'" 
+    # ```
     #
     # Returns a String
     def self.encode
@@ -44,7 +48,7 @@ module CsvShaper
     
     # Public: adds several rows to the CSV
     #
-    #   collection - an Enumerable of objects to be passed to #row
+    # `collection` - an Enumerable of objects to be passed to #row
     #
     # Returns an updated Array of Row objects
     def rows(collection = nil, &block)

data/lib/csv_shaper/version.rb

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

data/lib/csv_shaper_template.rb

@@ -1,4 +1,8 @@
+# CsvShaperTemplate
+# Rails view template class
 class CsvShaperTemplate < CsvShaper::Shaper
+  # Expected `encode` call
+  # Instantiates a new CsvShaperTemplate object and calls `to_csv` on it
   def self.encode(context)
     new(context).tap { |shaper| yield shaper }.to_csv
   end
@@ -9,10 +13,15 @@ class CsvShaperTemplate < CsvShaper::Shaper
   end
 end
 
+# CsvShaperHandler
+# Template handler for Rails
 class CsvShaperHandler
   cattr_accessor :default_format
   self.default_format = Mime::CSV
 
+  # Expected `call` class method
+  # Set response headers with filename
+  # Primarily calls CsvShaperTemplate.encode, passing through the context (self)
   def self.call(template)
     %{
       unless defined?(ActionMailer) && defined?(ActionMailer::Base) && controller.is_a?(ActionMailer::Base)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: csv_shaper
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
   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: &70296967507100 !ruby/object:Gem::Requirement
+  requirement: &70169242549620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70296967507100
+  version_requirements: *70169242549620
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70296967506200 !ruby/object:Gem::Requirement
+  requirement: &70169242545580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70296967506200
+  version_requirements: *70169242545580
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70296967505200 !ruby/object:Gem::Requirement
+  requirement: &70169242544220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70296967505200
+  version_requirements: *70169242544220
 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
@@ -55,6 +55,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .groc.json
 - .travis.yml
 - Gemfile
 - LICENSE
@@ -105,3 +106,4 @@ test_files:
 - spec/header_spec.rb
 - spec/row_spec.rb
 - spec/spec_helper.rb
+has_rdoc: