tabularasa 0.1.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008-2011 Ary Djmal
+
+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/Manifest

@@ -0,0 +1,8 @@
+MIT-LICENSE
+Manifest
+README.rdoc
+Rakefile
+init.rb
+lib/to_csv.rb
+test/test_helper.rb
+test/to_csv_test.rb

data/README.rdoc

@@ -0,0 +1,62 @@
+= to_csv plugin
+
+This simple plugin gives you the ability to call to_csv to a collection of activerecords. The builder options are the same as to_json / to_xml, except for the :include.
+
+
+== Usage
+
+  @users = User.all
+
+  #
+  # defaults are export headers and all fields
+  #
+
+  @users.to_csv
+  @users.to_csv(:only => [:last_name, :role]) # This will also set the order
+  @users.to_csv(:headers => false)
+  @users.to_csv(:except => [:last_name, :role])
+  @users.to_csv(:methods => :admin?)
+  @users.to_csv({:methods => :admin?}, {:col_sep => '\t'}) # Send csv generation options
+
+
+== Real life example
+
+In the controller where you want to export to csv, add the format.csv line (as of rails 2.1 it is not necessary to register the csv myme_type)
+
+  class UserController < ApplicationController
+    def index
+      @users = User.all
+
+      respond_to do |format|
+        format.html
+        format.xml { render :xml => @users }
+        format.csv { send_data @users.to_csv }
+      end
+    end
+  end
+
+
+== Dependencies
+
+  None if using ruby >= 1.9
+  
+  Else, install fastercsv:
+  sudo gem install fastercsv
+
+
+== Install
+
+  ./script/plugin install git://github.com/arydjmal/to_csv.git
+
+
+== Ideas
+
+I got ideas and influence from Mike Clarks recipe #35 in Rails Recipes book, some anonymous pastie, and whoever wrote to_xml/to_json builders.
+
+
+== Note
+
+Does not work on a single activerecord, ie, User.first.to_csv.
+
+
+Copyright (c) 2008-2011 Ary Djmal, released under the MIT license

data/Rakefile

@@ -0,0 +1,24 @@
+require 'rake'
+require 'rake/testtask'
+require 'rubygems'
+require 'echoe'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the to_csv plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+Echoe.new('tabularasa', '0.1.1') do |p|
+  p.description     = "This Rails gem gives you the ability to call to_csv to a collection of activerecords"
+  p.url             = "https://github.com/arydjmal/to_csv"
+  p.author          = "Ary Djmal"
+  p.email           = "arydjmal@gmail.com"
+  p.ignore_pattern  = ["tmp/*", "script/*"]
+  p.development_dependencies = []
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/init.rb

@@ -0,0 +1,7 @@
+if RUBY_VERSION >= "1.9.0"
+  require 'csv'
+else
+  require 'fastercsv'
+end
+
+require 'to_csv'

data/lib/to_csv.rb

@@ -0,0 +1,29 @@
+class Array
+  def to_csv(options = {}, csv_options = {})
+    return '' if self.empty?
+
+    klass      = self.first.class
+    attributes = self.first.attributes.keys.sort.map(&:to_sym)
+
+    if options[:only]
+      columns = Array(options[:only]) & attributes
+    else
+      columns = attributes - Array(options[:except])
+    end
+
+    columns += Array(options[:methods])
+
+    return '' if columns.empty?
+
+    writer = RUBY_VERSION >= "1.9.0" ? CSV : FasterCSV
+
+    output = writer.generate(csv_options) do |csv|
+      csv << columns.map { |column| klass.human_attribute_name(column) } unless options[:headers] == false
+      self.each do |item|
+        csv << columns.collect { |column| item.send(column) }
+      end
+    end
+
+    output
+  end
+end

data/tabularasa.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "tabularasa"
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ary Djmal"]
+  s.date = "2011-11-23"
+  s.description = "This Rails gem gives you the ability to call to_csv to a collection of activerecords"
+  s.email = "arydjmal@gmail.com"
+  s.extra_rdoc_files = ["README.rdoc", "lib/to_csv.rb"]
+  s.files = ["MIT-LICENSE", "Manifest", "README.rdoc", "Rakefile", "init.rb", "lib/to_csv.rb", "test/test_helper.rb", "test/to_csv_test.rb", "tabularasa.gemspec"]
+  s.homepage = "https://github.com/arydjmal/to_csv"
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Tabularasa", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = "tabularasa"
+  s.rubygems_version = "1.8.11"
+  s.summary = "This Rails gem gives you the ability to call to_csv to a collection of activerecords"
+  s.test_files = ["test/test_helper.rb", "test/to_csv_test.rb"]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,37 @@
+begin
+  require 'rubygems'
+  require 'test/unit'
+  require 'active_support'
+  require 'active_support/inflector'
+  if RUBY_VERSION >= "1.9.0"
+    require 'csv'
+  else
+    require 'fastercsv'
+  end
+  require File.dirname(__FILE__) + '/../lib/to_csv'
+rescue LoadError
+  puts 'to_csv tests rely on active_support, and fastercsv if ruby version < 1.9'
+end
+
+class User
+  COLUMNS = %w(id name age)
+  
+  attr_accessor *COLUMNS
+
+  def self.human_attribute_name(attribute)
+    attribute.to_s.humanize
+  end
+
+  def initialize(params={})
+    params.each { |key, value| self.send("#{key}=", value); }
+    self
+  end
+
+  def attributes
+    COLUMNS.inject({}) { |attributes, attribute| attributes.merge(attribute => send(attribute)) }
+  end
+
+  def is_old?
+    age > 40
+  end
+end

data/test/to_csv_test.rb

@@ -0,0 +1,50 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class ToCsvTest < Test::Unit::TestCase
+  def setup
+    @users = [
+      User.new(:id => 1, :name => 'Ary', :age => 25),
+      User.new(:id => 2, :name => 'Nati', :age => 22)
+    ]
+  end
+
+  def test_with_empty_array
+    assert_equal( "", [].to_csv )
+  end
+
+  def test_with_csv_options
+    assert_equal( "Age\tId\tName\n25\t1\tAry\n22\t2\tNati\n", @users.to_csv({}, :col_sep => "\t"))
+  end
+
+  def test_with_no_options
+    assert_equal( "Age,Id,Name\n25,1,Ary\n22,2,Nati\n", @users.to_csv )
+  end
+
+  def test_with_no_headers
+    assert_equal( "25,1,Ary\n22,2,Nati\n", @users.to_csv(:headers => false) )
+  end
+
+  def test_with_only
+    assert_equal( "Name\nAry\nNati\n", @users.to_csv(:only => :name) )
+  end
+
+  def test_with_empty_only
+    assert_equal( "", @users.to_csv(:only => "") )
+  end
+
+  def test_with_only_and_wrong_column_names
+    assert_equal( "Name\nAry\nNati\n", @users.to_csv(:only => [:name, :yoyo]) )
+  end
+
+  def test_with_except
+    assert_equal( "Age\n25\n22\n", @users.to_csv(:except => [:id, :name]) )
+  end
+
+  def test_with_except_and_only_should_listen_to_only
+    assert_equal( "Name\nAry\nNati\n", @users.to_csv(:except => [:id, :name], :only => :name) )
+  end
+
+  def test_with_except
+    assert_equal( "Age,Id,Name,Is old?\n25,1,Ary,false\n22,2,Nati,false\n", @users.to_csv(:methods => [:is_old?]) )
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: tabularasa
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Ary Djmal
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-23 00:00:00.000000000Z
+dependencies: []
+description: This Rails gem gives you the ability to call to_csv to a collection of
+  activerecords
+email: arydjmal@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+- lib/to_csv.rb
+files:
+- MIT-LICENSE
+- Manifest
+- README.rdoc
+- Rakefile
+- init.rb
+- lib/to_csv.rb
+- test/test_helper.rb
+- test/to_csv_test.rb
+- tabularasa.gemspec
+homepage: https://github.com/arydjmal/to_csv
+licenses: []
+post_install_message: 
+rdoc_options:
+- --line-numbers
+- --inline-source
+- --title
+- Tabularasa
+- --main
+- README.rdoc
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '1.2'
+requirements: []
+rubyforge_project: tabularasa
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: This Rails gem gives you the ability to call to_csv to a collection of activerecords
+test_files:
+- test/test_helper.rb
+- test/to_csv_test.rb