crafterm-comma 0.1.3 → 0.1.4

data/README.markdown

@@ -4,7 +4,7 @@
 
 == DESCRIPTION:
 
-Comma is a CSV (ie. comma separated values) generation extension for Ruby objects, that lets you seamlessly define a CSV output format via a small DSL. Comma works well on pure Ruby objects with attributes, as well as complex ones such as ActiveRecord objects with associations, extensions, etc. It doesnt distinguish between attributes, methods, associations, extensions, etc - they all are considered equal and invoked identically via the Comma DSL description.
+Comma is a CSV (ie. comma separated values) generation extension for Ruby objects, that lets you seamlessly define a CSV output format via a small DSL. Comma works well on pure Ruby objects with attributes, as well as complex ones such as ActiveRecord objects with associations, extensions, etc. It doesn't distinguish between attributes, methods, associations, extensions, etc - they all are considered equal and invoked identically via the Comma DSL description. Multiple different CSV output descriptions can also be defined.
 
 When multiple objects in an Array are converted to CSV, the output includes generation of a header row reflected from names of the properties requested, or specified via the DSL.
 
@@ -32,7 +32,8 @@ An example Comma CSV enabled ActiveRecord class:
         pages :size => 'Pages'
         publisher :name
         isbn :number_10 => 'ISBN-10', :number_13 => 'ISBN-13'
-      
+        blurb 'Summary'
+        
       end
 
     end
@@ -54,13 +55,60 @@ Annotated, the comma description is as follows:
     
       # isbn is an association returning an object, :number_10 and :number_13 are called on the object with the specified headers 'ISBN-10' and 'ISBN-13'
       isbn :number_10 => 'ISBN-10', :number_13 => 'ISBN-13'
+      
+      # blurb is an attribute of Book, with the header being specified directly as 'Summary'
+      blurb 'Summary'
     
     end
   
-In the above example, any of the declarations (name, description, pages, publisher, isbn, etc), could be methods, attributes, associations, etc - no distinction during configuration is required, as everything is invoked via Ruby's #send method.
+In the above example, any of the declarations (name, description, pages, publisher, isbn, blurb, etc), could be methods, attributes, associations, etc - no distinction during configuration is required, as everything is invoked via Ruby's #send method.
+
+You can get the CSV representation of any object by calling the to_comma method, optionally providing a CSV description name to use.
 
 Object values are automatically converted to strings via to_s allowing you to reuse any existing to_s methods on your objects (instead of having to call particular properties or define CSV specific output methods). Header names are also automatically humanized when reflected (eg. replacing _ characters with whitespace). The 'isbn' example above shows how multiple values can be added to the CSV output.
 
+Multiple CSV descriptions can also be specified for the same class, eg:
+
+    class Book < ActiveRecord::Base
+
+      # ================
+      # = Associations =
+      # ================
+      has_many   :pages
+      has_one    :isbn
+      belongs_to :publisher
+
+      # ===============
+      # = CSV support =
+      # ===============
+      comma do
+
+        name
+        description
+
+        pages :size => 'Pages'
+        publisher :name
+        isbn :number_10 => 'ISBN-10', :number_13 => 'ISBN-13'
+        blurb 'Summary'
+    
+      end
+      
+      comma :brief do
+      
+        name
+        description
+        blurb 'Summary'
+        
+      end
+
+    end
+    
+You can specify which output format you would like to use via an optional parameter to to_comma:
+
+    Book.limited(10).to_comma(:brief)
+
+Specifying no description name to to_comma is equivalent to specifying :default as the description name.
+
 When used with Rails (ie. add 'comma' as a gem dependency), Comma automatically adds support for rendering CSV output in your controllers:
 
     class BooksController < ApplicationController
@@ -72,5 +120,5 @@ When used with Rails (ie. add 'comma' as a gem dependency), Comma automatically
       end
 
     end
-
+    
 If you have any questions or suggestions for Comma, please feel free to contact me at crafterm@redartisan.com, all feedback welcome!

data/lib/comma/extractors.rb

@@ -23,7 +23,7 @@ module Comma
         case arg
         when Hash
           arg.each do |k, v|
-            @results << v.to_s.humanize
+            @results << ((v.is_a? String) ? v : v.to_s.humanize)
           end
         when Symbol
           @results << arg.to_s.humanize

data/lib/comma.rb

@@ -3,25 +3,31 @@ require 'fastercsv'
 require 'comma/extractors'
 
 class Array
-  def to_comma
+  def to_comma(style = :default)
     FasterCSV.generate do |csv|
-      csv << first.to_comma_headers
+      csv << first.to_comma_headers(style)
       each do |object| 
-        csv << object.to_comma
+        csv << object.to_comma(style)
       end
     end
   end
 end
 
 class Object
-  def self.comma(&block)
-    define_method :to_comma do
-      Comma::DataExtractor.new(self, &block).results
-    end
-
-    define_method :to_comma_headers do
-      Comma::HeaderExtractor.new(self, &block).results
-    end
+  class_inheritable_accessor :comma_formats
+  
+  def self.comma(style = :default, &block)
+    (self.comma_formats ||= {})[style] = block
+  end
+  
+  def to_comma(style = :default)
+    raise "No comma format defined for style #{style}" unless self.comma_formats[style]
+    Comma::DataExtractor.new(self, &self.comma_formats[style]).results
+  end
+  
+  def to_comma_headers(style = :default)
+    raise "No comma format defined for style #{style}" unless self.comma_formats[style]
+    Comma::HeaderExtractor.new(self, &self.comma_formats[style]).results
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: crafterm-comma
 version: !ruby/object:Gem::Version 
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors: 
 - Marcus Crafter