vibedeck-comma 0.4.2

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', @options){ |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/named_scope.rb

@@ -0,0 +1,5 @@
+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_attribute :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/lib/comma/render_as_csv.rb

@@ -0,0 +1,57 @@
+if defined?(ActionController::Renderers) && ActionController::Renderers.respond_to?(:add)
+  ActionController::Renderers.add :csv do |obj, options|
+    filename = options[:filename] || 'data'
+    send_data obj.to_comma, :type => Mime::CSV, :disposition => "attachment; filename=#{filename}.csv"
+  end
+else
+  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].present?
+
+      content  = options.delete(:csv)
+      style    = options.delete(:style) || :default
+      filename = options.delete(:filename)
+
+      headers.merge!(
+        'Content-Transfer-Encoding' => 'binary',
+        'Content-Type'              => 'text/csv; charset=utf-8'
+      )
+      filename_header_value = "attachment"
+      filename_header_value += "; filename=\"#{filename}\"" if filename.present?
+      headers.merge!('Content-Disposition' => filename_header_value)
+
+      @performed_render = false
+
+      render_stream :status => 200,
+                    :content => Array(content),
+                    :style => style
+    end
+
+    protected
+
+    def render_stream(options)
+      status  = options[:status]
+      content = options[:content]
+      style   = options[:style]
+
+      # If Rails 2.x
+      if defined? Rails and (Rails.version.split('.').map(&:to_i) <=> [2,3,5]) < 0
+        render :status => status, :text => Proc.new { |response, output|
+          output.write FasterCSV.generate_line(content.first.to_comma_headers(style))
+          content.each { |line| output.write FasterCSV.generate_line(line.to_comma(style)) }
+        }
+      else # If Rails 3.x
+        self.status = status
+        self.response_body = proc { |response, output|
+          output.write FasterCSV.generate_line(content.first.to_comma_headers(style))
+          content.each { |line| output.write FasterCSV.generate_line(line.to_comma(style)) }
+        }
+      end
+    end
+  end
+  #credit : http://ramblingsonrails.com/download-a-large-amount-of-data-in-csv-from-rails
+end

data/spec/comma/ar_spec.rb

@@ -0,0 +1,38 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+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,217 @@
+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
+    after{ File.delete('comma.csv') }
+
+    it "should write to the file" do
+      @books.to_comma(:filename => 'comma.csv')
+      File.read('comma.csv').should == "Title,Description,Issuer,ISBN-10,ISBN-13\nSmalltalk-80,Language and Implementation,ISBN,123123123,321321321\n"
+    end
+
+    it "should accept FasterCSV options" do
+      @books.to_comma(:filename => 'comma.csv', :col_sep => ';', :force_quotes => true)
+      File.read('comma.csv').should == "\"Title\";\"Description\";\"Issuer\";\"ISBN-10\";\"ISBN-13\"\n\"Smalltalk-80\";\"Language and Implementation\";\"ISBN\";\"123123123\";\"321321321\"\n"
+    end
+
+  end
+
+  describe "with FasterCSV 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
+          content
+          content('Truncated Content') {|i| i && i.length > 10 ? i[0..10] : '---' }
+          created_at { |i| i && i.to_s(:db) }
+          updated_at { |i| i && i.to_s(:db) }
+          created_at 'Created Custom Label' do |i| i && i.to_s(:short) end
+          updated_at 'Updated at Custom Label' do |i| i && i.to_s(:short) end
+        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), @time.to_s(:short), @time.to_s(:short)].join(',')
+    end
+
+    it 'should return headers with custom labels from block' do
+      header, foo = Array(@foo).to_comma.split("\n")
+      header.should == ['Content', 'Truncated Content', 'Created at', 'Updated at', 'Created Custom Label', 'Updated at Custom Label'].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