comma 0.2.2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Marcus Crafter
+
+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.markdown

@@ -0,0 +1,132 @@
+= COMMA
+
+[http://github.com/crafterm/comma](http://github.com/crafterm/comma)
+
+== 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.
+
+CSV can be a bit of a boring format - the motivation behind Comma was to have a CSV extension that was simple, flexible, and would treat attributes, methods, associations, etc, all the same without the need for any complex configuration, and also work on Ruby objects, not just ActiveRecord or other base class derivatives.
+
+An example Comma CSV enabled ActiveRecord class:
+
+    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
+
+    end
+
+Annotated, the comma description is as follows:
+
+    # starts a Comma description block, generating 2 methods #to_comma and #to_comma_headers for this class.
+    comma do
+
+      # name, description are attributes of Book with the header being reflected as 'Name', 'Description'
+      name
+      description
+  
+      # pages is an association returning an array, :size is called on the association results, with the header name specifed as 'Pages'
+      pages :size => 'Pages'
+    
+      # publisher is an association returning an object, :name is called on the associated object, with the reflected header 'Name'
+      publisher :name
+    
+      # 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, 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.
+
+You can pass options for FasterCVS, e.g.
+
+    Book.limited(10).to_comma(:style => :brief, :col_sep => ';', :force_quotes => true)
+
+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
+
+      def index
+        respond_to do |format|
+          format.csv { render :csv => Book.limited(50) }
+        end
+      end
+
+    end
+    
+If you have any questions or suggestions for Comma, please feel free to contact me at crafterm@redartisan.com, all feedback welcome!
+
+== DEPENDENCIES
+
+If you're on ruby 1.8.*, you'll need to have the fastercsv gem installed

data/lib/comma.rb

@@ -0,0 +1,68 @@
+require 'activesupport'
+require 'comma/extractors'
+
+if RUBY_VERSION =~ /^1.9/
+  require 'csv'
+  FasterCSV = CSV
+else
+  require 'fastercsv'
+end
+
+class Array
+  def to_comma(style = :default)
+    options = {}
+
+    if style.is_a? Hash
+      options = style
+      style = options.delete(:style)||:default
+    end
+
+    FasterCSV.generate(options) do |csv|
+      return "" if empty?
+      csv << first.to_comma_headers(style) # REVISIT: request to optionally include headers
+      each do |object| 
+        csv << object.to_comma(style)
+      end
+    end
+  end
+end
+
+class Object
+  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 for class #{self.class} defined for style #{style}" unless self.comma_formats and self.comma_formats[style]
+    Comma::DataExtractor.new(self, &self.comma_formats[style]).results
+  end
+  
+  def to_comma_headers(style = :default)
+    raise "No comma format for class #{self.class} defined for style #{style}" unless self.comma_formats and self.comma_formats[style]
+    Comma::HeaderExtractor.new(self, &self.comma_formats[style]).results
+  end
+end
+
+if defined?(ActionController)
+  module RenderAsCSV
+
+    def self.included(base)
+      base.send :include, InstanceMethods
+      base.alias_method_chain :render, :csv
+    end
+
+    module InstanceMethods
+      def render_with_csv(options = nil, extra_options = {}, &block)
+        return render_without_csv(options, extra_options, &block) unless options.is_a?(Hash) and options[:csv]
+        data = options.delete(:csv)
+        style = options.delete(:style) || :default
+        send_data Array(data).to_comma(style), options.merge(:type => :csv)
+      end
+    end
+
+  end
+
+  ActionController::Base.send :include, RenderAsCSV
+end

data/lib/comma/extractors.rb

@@ -0,0 +1,75 @@
+module Comma
+
+  class Extractor
+
+    def initialize(instance, &block)
+      @instance = instance
+      @block = block
+      @results = []
+    end
+
+    def results
+      instance_eval &@block
+      @results
+    end
+
+    def id(*args)
+      method_missing(:id, *args)
+    end
+  end
+
+  class HeaderExtractor < Extractor
+
+    def method_missing(sym, *args, &block)
+      @results << sym.to_s.humanize if args.blank?
+
+      args.each do |arg|
+        case arg
+        when Hash
+          arg.each do |k, v|
+            @results << ((v.is_a? String) ? v : v.to_s.humanize)
+          end
+        when Symbol
+          @results << arg.to_s.humanize
+        when String
+          @results << arg
+        else
+          raise "Unknown header symbol #{arg.inspect}"
+        end
+      end
+    end
+  end
+
+  class DataExtractor < Extractor
+
+    def method_missing(sym, *args, &block)
+      if args.blank?
+        result = block ? yield(@instance.send(sym)) : @instance.send(sym)
+        @results << result.to_s
+      end
+
+      args.each do |arg|
+        case arg
+        when Hash
+          arg.each do |k, v|
+            if block
+              @results << (@instance.send(sym).nil? ? '' : yield(@instance.send(sym).send(k)).to_s )
+            else
+              @results << (@instance.send(sym).nil? ? '' : @instance.send(sym).send(k).to_s )
+            end
+          end
+        when Symbol
+          if block
+            @results << (@instance.send(sym).nil? ? '' : yield(@instance.send(sym).send(arg)).to_s)
+          else
+            @results << ( @instance.send(sym).nil? ? '' : @instance.send(sym).send(arg).to_s )
+          end
+        when String
+          @results << (block ? yield(@instance.send(sym)) : @instance.send(sym)).to_s
+        else
+          raise "Unknown data symbol #{arg.inspect}"
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: comma
+version: !ruby/object:Gem::Version 
+  version: 0.2.2
+platform: ruby
+authors: 
+- Marcus Crafter
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-09 00:00:00 +11:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: fastercsv
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.4.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.2.2
+    version: 
+description: 
+email: crafterm@redartisan.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.markdown
+- MIT-LICENSE
+- lib/comma.rb
+- lib/comma/extractors.rb
+has_rdoc: true
+homepage: http://github.com/crafterm/comma
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Ruby Comma Seperated Values generation library
+test_files: []
+