comma 0.2.2 → 0.3.0

data/.gitignore

@@ -0,0 +1,3 @@
+pkg
+.swp
+comma.gemspec

data/{README.markdown → README.rdoc}

@@ -1,14 +1,14 @@
 = COMMA
 
-[http://github.com/crafterm/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.
+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.
+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:
 
@@ -47,7 +47,7 @@ Annotated, the comma description is as follows:
       name
       description
   
-      # pages is an association returning an array, :size is called on the association results, with the header name specifed as 'Pages'
+      # pages is an association returning an array, :size is called on the association results, with the header name specified as 'Pages'
       pages :size => 'Pages'
     
       # publisher is an association returning an object, :name is called on the associated object, with the reflected header 'Name'
@@ -65,7 +65,7 @@ In the above example, any of the declarations (name, description, pages, publish
 
 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.
+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:
 
@@ -129,4 +129,5 @@ If you have any questions or suggestions for Comma, please feel free to contact
 
 == DEPENDENCIES
 
-If you're on ruby 1.8.*, you'll need to have the fastercsv gem installed
+If you're on ruby 1.8.*, the fasterCSV gem is recommended for performance reasons.
+    gem install fastercsv

data/Rakefile

@@ -0,0 +1,47 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "comma"
+    gem.summary = "Ruby Comma Seperated Values generation library"
+    gem.description = "Ruby Comma Seperated Values generation library"
+    gem.email = "crafterm@redartisan.com"
+    gem.rubyforge_project = 'comma'
+    gem.homepage = "http://github.com/crafterm/comma"
+    gem.authors = ["Marcus Crafter"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_dependency("activesupport", ">= 2.2.2")
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "comma #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.3.0

data/init.rb

@@ -0,0 +1 @@
+require 'comma'

data/lib/comma.rb

@@ -1,68 +1,39 @@
-require 'activesupport'
-require 'comma/extractors'
-
-if RUBY_VERSION =~ /^1.9/
-  require 'csv'
-  FasterCSV = CSV
-else
-  require 'fastercsv'
+# conditional loading of activesupport
+if defined? Rails and Rails.version < '2.3.5'
+  require 'activesupport' 
+else 
+  require 'active_support'
 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
+# load the right csv library
+if RUBY_VERSION >= '1.9'
+  require 'csv' 
+  FasterCSV = CSV
+else 
+  begin
+    # try faster csv
+    require 'fastercsv'
+  rescue Error => e
+    if defined? Rails
+      Rails.logger.info "FasterCSV not installed, falling back on CSV"
+    else
+      puts "FasterCSV not installed, falling back on CSV"
     end
+    require 'csv'
+    FasterCSV = CSV
   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
+require 'comma/extractors'
+require 'comma/generator'
+require 'comma/array'
+require 'comma/object'
+require 'comma/renderascsv'
+
+if defined?(ActiveRecord)
+  require 'comma/namedscope'
 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/RenderAsCSV.rb

@@ -0,0 +1,12 @@
+module RenderAsCSV
+  def self.included(base)
+    base.alias_method_chain :render, :csv
+  end
+
+  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

data/lib/comma/array.rb

@@ -0,0 +1,5 @@
+class Array
+  def to_comma(style = :default)
+    Comma::Generator.new(self, style).run(:each)
+  end
+end

data/lib/comma/generator.rb

@@ -0,0 +1,35 @@
+module Comma
+
+  class Generator
+
+    def initialize(instance, style)
+      @instance = instance
+      @style    = style
+      @options  = {}
+
+      if @style.is_a? Hash
+        @options  = @style.clone
+        @style    = @options.delete(:style) || :default
+        @filename = @options.delete(:filename)
+      end
+    end
+
+    def run(iterator_method)
+      if @filename
+        FasterCSV.open(@filename, 'w'){ |csv| append_csv(csv, iterator_method) } and return true
+      else
+        FasterCSV.generate(@options){ |csv| append_csv(csv, iterator_method) }
+      end
+    end
+
+    private
+    def append_csv(csv, iterator_method)
+      return '' if @instance.empty?
+      csv << @instance.first.to_comma_headers(@style) # REVISIT: request to optionally include headers
+      @instance.send(iterator_method) do |object|
+        csv << object.to_comma(@style)
+      end
+    end
+
+  end
+end

data/lib/comma/namedscope.rb

@@ -0,0 +1,6 @@
+class ActiveRecord::NamedScope::Scope
+  def to_comma(style = :default)
+    Comma::Generator.new(self, style).run(:find_each)
+  end
+end
+

data/lib/comma/object.rb

@@ -0,0 +1,17 @@
+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

data/spec/comma/ar_spec.rb

@@ -0,0 +1,39 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require 'active_record'
+
+describe Comma, 'generating CSV from an ActiveRecord object' do
+  before(:all) do
+    class Person < ActiveRecord::Base
+      named_scope :teenagers, :conditions => { :age => 13..19 }
+      comma do
+        name
+        age
+      end
+    end
+
+    require 'active_record/connection_adapters/abstract_adapter'
+    Column = ActiveRecord::ConnectionAdapters::Column
+  end
+
+  before do
+    Person.stub!(:columns).and_return [Column.new('age', 0, 'integer', false),
+                                       Column.new('name', nil, 'string', false) ]
+    Person.stub!(:table_exists?).and_return(true)
+  end
+
+  describe 'case' do
+    before do
+      people = [ Person.new(:age => 18, :name => 'Junior') ]
+      Person.stub!(:find_every).and_return people
+      Person.stub!(:calculate).with(:count, :all, {}).and_return people.size
+    end
+
+    it 'should extend ActiveRecord::NamedScope::Scope to add a #to_comma method which will return CSV content for objects within the scope' do
+      Person.teenagers.to_comma.should == "Name,Age\nJunior,18\n"
+    end
+
+    it 'should find in batches' do
+      Person.teenagers.to_comma
+    end
+  end
+end

data/spec/comma/comma_spec.rb

@@ -0,0 +1,204 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Comma do
+  
+  it 'should extend object to add a comma method' do
+    Object.should respond_to(:comma)
+  end
+  
+  it 'should extend object to have a to_comma method' do
+    Object.should respond_to(:to_comma)
+  end
+  
+  it 'should extend object to have a to_comma_headers method' do
+    Object.should respond_to(:to_comma_headers)
+  end
+  
+end
+
+describe Comma, 'generating CSV' do
+  
+  before do
+    @isbn = Isbn.new('123123123', '321321321')
+    @book = Book.new('Smalltalk-80', 'Language and Implementation', @isbn)
+    
+    @books = []
+    @books << @book
+  end
+  
+  it 'should extend Array to add a #to_comma method which will return CSV content for objects within the array' do
+    @books.to_comma.should == "Title,Description,Issuer,ISBN-10,ISBN-13\nSmalltalk-80,Language and Implementation,ISBN,123123123,321321321\n"
+  end
+
+  it 'should return an empty string when generating CSV from an empty array' do
+    Array.new.to_comma.should == ''
+  end
+
+  it "should change the style when specified" do
+    @books.to_comma(:brief).should == "Name,Description\nSmalltalk-80,Language and Implementation\n"
+  end
+
+  describe 'with :filename specified' do
+    before{ @books.to_comma(:filename => 'comma.csv') }
+    after{ File.delete('comma.csv') }
+
+    it "should write to the file" do
+      File.read('comma.csv').should == "Title,Description,Issuer,ISBN-10,ISBN-13\nSmalltalk-80,Language and Implementation,ISBN,123123123,321321321\n"
+    end
+  end
+
+  describe "with FasterCVS options" do
+    it "should not change when options are empty" do
+      @books.to_comma({}).should == "Title,Description,Issuer,ISBN-10,ISBN-13\nSmalltalk-80,Language and Implementation,ISBN,123123123,321321321\n"
+    end
+
+    it 'should accept the options in #to_comma and generate the appropriate CSV' do
+      @books.to_comma(:col_sep => ';', :force_quotes => true).should == "\"Title\";\"Description\";\"Issuer\";\"ISBN-10\";\"ISBN-13\"\n\"Smalltalk-80\";\"Language and Implementation\";\"ISBN\";\"123123123\";\"321321321\"\n"
+    end
+
+    it "should change the style when specified" do
+      @books.to_comma(:style => :brief, :col_sep => ';', :force_quotes => true).should == "\"Name\";\"Description\"\n\"Smalltalk-80\";\"Language and Implementation\"\n"
+    end
+  end
+end
+
+describe Comma, 'defining CSV descriptions' do
+  
+  describe 'with an unnamed description' do
+    
+    before do
+      class Foo
+        comma do; end
+      end        
+    end
+  
+    it 'should name the current description :default if no name has been provided' do
+      Foo.comma_formats.should_not be_empty
+      Foo.comma_formats[:default].should_not be_nil
+    end
+  end
+  
+  describe 'with a named description' do
+   
+    before do
+      class Bar
+        comma do; end
+        comma :detailed do; end
+      end        
+    end
+    
+    it 'should use the provided name to index the comma format' do
+      Bar.comma_formats.should_not be_empty
+      Bar.comma_formats[:default].should_not be_nil
+      Bar.comma_formats[:detailed].should_not be_nil
+    end
+  end
+end
+
+describe Comma, 'to_comma data/headers object extensions' do
+  
+  describe 'with unnamed descriptions' do
+  
+    before do
+      class Foo
+        attr_accessor :content
+        comma do; content; end
+      
+        def initialize(content)
+          @content = content
+        end
+      end
+    
+      @foo = Foo.new('content')
+    end
+  
+    it 'should return and array of data content, using the :default CSV description if none requested' do
+      @foo.to_comma.should == %w(content)
+    end
+
+    it 'should return and array of header content, using the :default CSV description if none requested' do
+      @foo.to_comma_headers.should == %w(Content)
+    end
+    
+    it 'should return the CSV representation including header and content when called on an array' do
+      Array(@foo).to_comma.should == "Content\ncontent\n"
+    end
+
+  end
+  
+  describe 'with named descriptions' do
+    
+    before do
+      class Foo
+        attr_accessor :content
+        comma :detailed do; content; end
+      
+        def initialize(content)
+          @content = content
+        end
+      end
+    
+      @foo = Foo.new('content')
+    end
+  
+    it 'should return and array of data content, using the :default CSV description if none requested' do
+      @foo.to_comma(:detailed).should == %w(content)
+    end
+
+    it 'should return and array of header content, using the :default CSV description if none requested' do
+      @foo.to_comma_headers(:detailed).should == %w(Content)
+    end
+    
+    it 'should return the CSV representation including header and content when called on an array' do
+      Array(@foo).to_comma(:detailed).should == "Content\ncontent\n"
+    end
+    
+    it 'should raise an error if the requested description is not avaliable' do
+      lambda { @foo.to_comma(:bad) }.should raise_error
+      lambda { @foo.to_comma_headers(:bad) }.should raise_error
+      lambda { Array(@foo).to_comma(:bad) }.should raise_error
+    end
+    
+  end
+
+  describe 'with block' do
+    before do
+      class Foo
+        attr_accessor :content, :created_at, :updated_at
+        comma do
+          time_to_s = lambda { |i| i && i.to_s(:db) }
+          content
+          content('Truncated Content') {|i| i && i.length > 10 ? i[0..10] : '---' }
+          created_at &time_to_s
+          updated_at &time_to_s
+        end
+        
+        def initialize(content, created_at = Time.now, updated_at = Time.now)
+          @content = content
+          @created_at = created_at
+          @updated_at = updated_at
+        end
+      end
+      
+      @time = Time.now
+      @content = 'content ' * 5
+      @foo = Foo.new @content, @time, @time
+    end
+    
+    it 'should return yielded values by block' do
+      header, foo = Array(@foo).to_comma.split("\n")
+      foo.should == [@content, @content[0..10], @time.to_s(:db), @time.to_s(:db)].join(',')
+    end
+    
+  end
+  
+  describe 'on an object with no comma declaration' do
+    
+    it 'should raise an error mentioning there is no comma description defined for that class' do
+      lambda { 'a string'.to_comma }.should raise_error('No comma format for class String defined for style default')
+      lambda { 'a string'.to_comma_headers }.should raise_error('No comma format for class String defined for style default')
+    end
+    
+  end
+  
+end

data/spec/comma/extractors_spec.rb

@@ -0,0 +1,91 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+# comma do
+#   name 'Title'
+#   description
+#   
+#   isbn :number_10 => 'ISBN-10', :number_13 => 'ISBN-13'
+# end
+
+describe Comma::HeaderExtractor do
+  
+  before do
+    @isbn = Isbn.new('123123123', '321321321')
+    @book = Book.new('Smalltalk-80', 'Language and Implementation', @isbn)
+    
+    @headers = @book.to_comma_headers
+  end
+  
+  describe 'when no parameters are provided' do
+    
+    it 'should use the method name as the header name, humanized' do
+      @headers.should include('Description')
+    end
+  end
+  
+  describe 'when given a string description as a parameter' do
+    
+    it 'should use the string value, unmodified' do
+      @headers.should include('Title')
+    end
+  end
+  
+  describe 'when an hash is passed as a parameter' do
+    
+    describe 'with a string value' do
+      
+      it 'should use the string value, unmodified' do
+        @headers.should include('ISBN-10')
+      end
+    end
+    
+    describe 'with a non-string value' do
+      
+      it 'should use the non string value converted to a string, humanized' do
+        @headers.should include('Issuer')
+      end
+    end
+    
+  end
+    
+end
+
+describe Comma::DataExtractor do
+  
+  before do
+    @isbn = Isbn.new('123123123', '321321321')
+    @book = Book.new('Smalltalk-80', 'Language and Implementation', @isbn)
+    
+    @data = @book.to_comma
+  end
+  
+  describe 'when no parameters are provided' do
+    
+    it 'should use the string value returned by sending the method name on the object' do
+      @data.should include('Language and Implementation')
+    end
+  end
+  
+  describe 'when given a string description as a parameter' do
+    
+    it 'should use the string value returned by sending the method name on the object' do
+      @data.should include('Smalltalk-80')
+    end
+  end
+  
+  describe 'when an hash is passed as a parameter' do
+    
+    describe 'with a string value' do
+      
+      it 'should use the string value, returned by sending the hash key to the object' do
+        @data.should include('123123123')
+        @data.should include('321321321')
+      end
+      
+      it 'should not fail when an associated object is nil' do
+        lambda { Book.new('Smalltalk-80', 'Language and Implementation', nil).to_comma }.should_not raise_error
+      end
+    end
+  end
+  
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,38 @@
+require 'rubygems'
+require 'spec'
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'comma'
+
+
+class Book
+  attr_accessor :name, :description, :isbn
+  
+  def initialize(name, description, isbn)
+    @name, @description, @isbn = name, description, isbn
+  end
+  
+  comma do
+    name 'Title'
+    description
+    
+    isbn :authority => :issuer
+    isbn :number_10 => 'ISBN-10'
+    isbn :number_13 => 'ISBN-13'
+  end
+  
+  comma :brief do
+    name
+    description
+  end
+end
+
+class Isbn
+  attr_accessor :number_10, :number_13
+  
+  def initialize(isbn_10, isbn_13)
+    @number_10, @number_13 = isbn_10, isbn_13
+  end
+  
+  def authority; 'ISBN'; end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: comma
 version: !ruby/object:Gem::Version 
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors: 
 - Marcus Crafter
@@ -9,18 +9,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-09 00:00:00 +11:00
+date: 2009-12-13 00:00:00 +13:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: fastercsv
-  type: :runtime
+  name: rspec
+  type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.4.0
+        version: 1.2.9
     version: 
 - !ruby/object:Gem::Dependency 
   name: activesupport
@@ -32,26 +32,40 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 2.2.2
     version: 
-description: 
+description: Ruby Comma Seperated Values generation library
 email: crafterm@redartisan.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- README.rdoc
 files: 
-- README.markdown
+- .gitignore
 - MIT-LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- init.rb
 - lib/comma.rb
+- lib/comma/RenderAsCSV.rb
+- lib/comma/array.rb
 - lib/comma/extractors.rb
+- lib/comma/generator.rb
+- lib/comma/namedscope.rb
+- lib/comma/object.rb
+- spec/comma/ar_spec.rb
+- spec/comma/comma_spec.rb
+- spec/comma/extractors_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/crafterm/comma
 licenses: []
 
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -68,10 +82,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: comma
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: Ruby Comma Seperated Values generation library
-test_files: []
-
+test_files: 
+- spec/comma/ar_spec.rb
+- spec/comma/comma_spec.rb
+- spec/comma/extractors_spec.rb
+- spec/spec_helper.rb