tabularasa 0.1.6 → 0.2.0

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2008-2011 Ary Djmal
+Copyright (c) 2011 Chris Rosario
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Manifest

@@ -3,7 +3,4 @@ README.rdoc
 Rakefile
 init.rb
 lib/tabularasa.rb
-tabularasa.gemspec
-test/test_helper.rb
-test/to_csv_test.rb
 Manifest

data/README.rdoc

@@ -1,6 +1,6 @@
 = tabularasa gem
 
-This simple gem 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.
+This simple gem gives you the ability to convert an array of activerecord and/or hash objects to tabular data.
 
 
 == Usage
@@ -13,16 +13,12 @@ This simple gem gives you the ability to call to_csv to a collection of activere
 
   @users.to_csv
   @users.to_csv(:only => [:last_name, :role]) # This will also set the order
-  @users.to_csv(:headers => false)
+  @users.to_csv(:headers => ["Last Name", "Role"])
   @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
@@ -46,14 +42,9 @@ In the controller where you want to export to csv, add the format.csv line (as o
   gem install tabularasa
 
 
-== Note
-
-Does not work on a single activerecord, ie, User.first.to_csv.
-
 == Contributors
 
-* Ary Djmal (initial plugin)
-* Chris Roasario (gem conversion)
+* Chris Roasario
 
 
 Copyright (c) 2011 Chris Rosario, released under the MIT license

data/Rakefile

@@ -1,23 +1,12 @@
-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.6') do |p|
-  p.summary         = "Gives the ability to convert activerecord objects into csv"
-  p.description     = "This Rails gem gives you the ability to call to_csv to a collection of activerecords"
+Echoe.new('tabularasa', '0.2.0') do |p|
+  p.summary         = "Gives the ability to convert homogeneous activerecord and/or hash objects into csv"
+  p.description     = "This Rails gem gives you the ability to call to_csv to a collection of homogenous activerecords and/or hashes"
   p.url             = "https://github.com/callenrosario/tabularasa"
-  p.author          = ["Chris Rosario", "Ary Djmal"]
-  p.email           = "arydjmal@gmail.com"
+  p.author          = "Chris Rosario"
+  p.email           = "callenrosario@gmail.com"
   p.ignore_pattern  = ["tmp/*", "script/*"]
   p.runtime_dependencies = []
   p.development_dependencies = []

data/init.rb

@@ -1,2 +1 @@
-require 'csv'
 require 'tabularasa'

data/lib/tabularasa.rb

@@ -1,28 +1,97 @@
-class Array
-  require 'csv'
-  def to_csv(options = {}, csv_options = {})
-    return '' if self.empty?
+require 'csv'
+
+class Tabularasa
+  def initialize(rows, options = {}, &block)
+    @rows = rows
+    @keys = (options[:only] || get_keys) - (options[:exclude] || [])
+    @headers = options[:headers] || options[:only] || get_headers
+  end
 
-    klass      = self.first.class
-    attributes = self.first.attributes.keys.sort.map(&:to_sym)
+  def to_csv
+    csv_data = CSV.generate do |csv|
+      csv << @headers
+      @rows.each do |row|
+        csv << collect(row)
+      end
+    end
+    csv_data
+  end
 
-    if options[:only]
-      columns = Array(options[:only]) & attributes
-    else
-      columns = attributes - Array(options[:except])
+  private
+    def data_type(object = @rows.first)
+      return 'active_record' if object.is_a?(ActiveRecord::Base)
+      return 'hash' if object.is_a?(Hash)
+      return 'array' if object.is_a?(Array) && !object.first.is_a?(Array)
+      return 'unsupported'
     end
 
-    columns += Array(options[:methods])
 
-    return '' if columns.empty?
+    def collect(object)
+      send "collect_#{data_type}", (object)
+    end
 
-    output = CSV.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
+    def collect_active_record(object)
+      @keys.collect{|key| object[key]}
     end
 
-    output
-  end
+    def collect_hash(object)
+      @keys.collect{|key| object[key]}
+    end
+
+    def collect_array(object)
+      @keys.collect{|key| object[key]}
+    end
+
+    def collect_unsupported(object)
+      []
+    end
+
+
+    def get_keys
+      send "get_#{data_type}_keys"
+    end
+
+    def get_active_record_keys
+      @rows.first.attributes.keys
+    end
+
+    def get_hash_keys
+      @rows.first.keys
+    end
+
+    def get_array_keys
+      (0...@rows.first.size).collect{|n| n}
+    end
+
+    def get_unsupported_keys
+      []
+    end
+
+
+    def get_headers
+      send "get_#{data_type}_headers"
+    end
+
+    def get_active_record_headers
+      @rows.first.attributes.keys
+    end
+
+    def get_hash_headers
+      @rows.first.stringify_keys.keys
+    end
+
+    def get_array_headers
+      (0...@rows.first.size).collect{|n| n.to_s}
+    end
+
+    def get_unsupported_headers
+      []
+    end
+end
+
+class Array
+ def to_csv(options = {}, &block)
+   tabularasa = Tabularasa.new(self, options, &block)
+   tabularasa.to_csv
+ end
 end

data/tabularasa.gemspec

@@ -2,22 +2,21 @@
 
 Gem::Specification.new do |s|
   s.name = "tabularasa"
-  s.version = "0.1.6"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Chris Rosario, 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.authors = ["Chris Rosario"]
+  s.date = "2011-11-29"
+  s.description = "This Rails gem gives you the ability to call to_csv to a collection of homogenous activerecords and/or hashes"
+  s.email = "callenrosario@gmail.com"
   s.extra_rdoc_files = ["README.rdoc", "lib/tabularasa.rb"]
-  s.files = ["MIT-LICENSE", "README.rdoc", "Rakefile", "init.rb", "lib/tabularasa.rb", "tabularasa.gemspec", "test/test_helper.rb", "test/to_csv_test.rb", "Manifest"]
+  s.files = ["MIT-LICENSE", "README.rdoc", "Rakefile", "init.rb", "lib/tabularasa.rb", "Manifest", "tabularasa.gemspec"]
   s.homepage = "https://github.com/callenrosario/tabularasa"
   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 = "Gives the ability to convert activerecord objects into csv"
-  s.test_files = ["test/test_helper.rb", "test/to_csv_test.rb"]
+  s.summary = "Gives the ability to convert homogeneous activerecord and/or hash objects into csv"
 
   if s.respond_to? :specification_version then
     s.specification_version = 3

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: tabularasa
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
-- Chris Rosario, Ary Djmal
+- Chris Rosario
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-23 00:00:00.000000000Z
+date: 2011-11-29 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
+  homogenous activerecords and/or hashes
+email: callenrosario@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -25,10 +25,8 @@ files:
 - Rakefile
 - init.rb
 - lib/tabularasa.rb
-- tabularasa.gemspec
-- test/test_helper.rb
-- test/to_csv_test.rb
 - Manifest
+- tabularasa.gemspec
 homepage: https://github.com/callenrosario/tabularasa
 licenses: []
 post_install_message: 
@@ -58,7 +56,6 @@ rubyforge_project: tabularasa
 rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
-summary: Gives the ability to convert activerecord objects into csv
-test_files:
-- test/test_helper.rb
-- test/to_csv_test.rb
+summary: Gives the ability to convert homogeneous activerecord and/or hash objects
+  into csv
+test_files: []

data/test/test_helper.rb

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

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