csvision 0.1.0 → 0.2.0

data/README.md

@@ -1,5 +1,7 @@
 # CSVision
 
+[![Build Status](https://secure.travis-ci.org/cloverinteractive/csvision.png?branch=master)](http://travis-ci.org/cloverinteractive/csvision)
+
 Convert a Hash into a CSV the easy way.
 
 ## Installation
@@ -18,20 +20,20 @@ Or install it yourself as:
 
 ## Usage
 
-CSVision has no prerequisites other than ruby itself, which is pretty cool just include the `CSVision` module into your app and you'll be good to go.
+CSVision has no prerequisites other than ruby itself, which is pretty cool just include the `csvision` gem in your app and you'll be good to go.
 
 ### Hash
 
-CSVision adds to `Hash` the `to_csv` method, anything that inherits from `Hash` will inherit this method as well, you do not need to open `Hash` and include `CSVision` in it, just add it anywhere in your code.
+CSVision adds to `Hash` the `to_csv` method, anything that inherits from `Hash` will inherit this method as well, you do not need to open `Hash` and include `CSVision` in it, just require the library in your code.
 
 ```ruby
-include CSVision
+require 'csvision'
 sample = { :name => 'foo', :last_name => 'bar', :age => 10 }
 sample.to_csv #=> "\"last_name\",\"name\",\"age\"\n\"bar\",\"foo\",\"10\""
 ```
 ### Rails
 
-CSVision adds the Rails the methods:
+CSVision adds the following methods to Rails:
 
 1. `to_csv` at the model instance
 2. `to_csv` at the model class
@@ -53,11 +55,147 @@ CSVision lets you customize the way your CSV is formed, you can use any of the f
 3. `:delimeter` this set the field delimeter and it defaults to `"`
 4. `:separator` this set the field separator and it defults to `,`
 
+That's good and all but, you never want to just convert a single object to csv but collections instead, so imagine this model instead:
+
+```ruby
+class User < ActiveRecord::Base
+  add_csvision :csv_headers => %w/street_cred nickname incognito/, :body => lambda { |u| [ u.street_cred, u.nickname, u.incognito ] }
+
+  scope :flunky, where( 'points <= 5' )
+
+  def incognito
+    nickname.reverse
+  end
+
+  def street_cred
+    points * 100 + ( nickname_cred )
+  end
+
+  private
+  def nickname_cred
+    nickname.unpack( 'U' * nickname.length ).sum # good nickname equals more street cred
+  end
+end
+```
+
+You can use the `:headers` option to set your header names, and the `:body` option to specify the methods or properties from the option you want
+called in your csv, this gives you flexibility to choose how your csv is formed and from what it is formed, so this is an example of how this works.
+
+```ruby
+5.times { |i| User.create( :nickname => "user#{ i * 3 }", :points => i * 5 ) }
+puts User.to_csv
+```
+
+this will print:
+
+```
+"street_cred","nickname","incognito"
+"495","user0","0resu"
+"998","user3","3resu"
+"1501","user6","6resu"
+"2004","user9","9resu"
+"2546","user12","21resu"
+```
+
+You can chain active record calls and even scopes in to your mix, so consider:
+
+```ruby
+5.times { |i| User.create( :nickname => "user#{ i * 3 }", :points => i *5 ) }
+puts User.flunky.to_csv
+```
+will print:
+
+```
+"street_cred","nickname","incognito"
+"495","user0","0resu"
+"998","user3","3resu"
+"1501","user6","6resu"
+```
+
+Lastly, with the exception of `:except` and `:only` which will be ignore because you're setting the body manually all other option work:
+
+```ruby
+5.times { |i| User.create( :nickname => "user#{ i * 3 }", :points => i *5 ) }
+puts User.to_csv( :headers => false )
+```
+
+Will print:
+
+```
+"495","user0","0resu"
+"998","user3","3resu"
+"1501","user6","6resu"
+"2004","user9","9resu"
+"2546","user12","21resu"
+```
+
+### Outside of Rails
+
+Anything that inherits from `Hash` will `respond_to? :to_csv` however if you want to use this in any other regular class make sure you do the following:
+
+1. Create a `Hash` attribute named `attributes`.
+2. You'll need to have a class `count` and `find_each` methods if you want support for setting the `body`.
+3. `include CSVision` in your class.
+
+```ruby
+class SampleStack
+  include CSVision
+  attr_accessor :attributes, :count
+
+  add_csvision :csv_headers => %w/price name/, :body => lambda { |s| [ s[:name], s[:price] ] }
+
+  def initialize( attributes={}, inventory = [] )
+    @attributes = attributes
+    @@inventory = inventory
+  end
+
+  def self.count
+    @@inventory.size
+  end
+
+  def self.find_each( opts={} )
+    @@inventory.each do |item|
+      yield item
+    end
+  end
+end
+```
+
+After wards imagine the following:
+
+```ruby
+sample_stack = SampleStack.new( :foo => 'foo', :bar => 'bar' )
+puts sample_stack.to_csv
+```
+
+Will print:
+
+```
+"foo","bar"
+"foo","bar"
+```
+
+But more importantly `to_csv` at the class level will:
+
+```ruby
+inventory = [ { :name => 'beer', :price => 9 }, { :name => 'milk', :price => 5 }, { :name => 'tuna', :price => 3 } ]
+sample_stack = SampleStack.new({ :name => 'groceries'}, inventory)
+puts SampleStack.to_csv
+```
+
+Prints:
+
+```
+"price","name"
+"beer","9"
+"milk","5"
+"tuna","3"
+```
+
 ## TODO:
 
-1. Allow users to set their own list of parameters
-2. Add support for other ORM's
-3. Rails 3.x responder.
+1. Add support for other ORM's
+2. Rails 3.x responder.
 
 
 ## Contributing

data/csvision.gemspec

@@ -19,7 +19,6 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'activerecord'
   gem.add_development_dependency 'activesupport'
   gem.add_development_dependency 'sqlite3'
-  gem.add_development_dependency 'mocha'
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'turn', '0.8.2'
 end

data/lib/csvision.rb

@@ -2,6 +2,10 @@ require "csvision/version"
 require "csvision/csv_helper"
 
 module CSVision
-  ::ActiveRecord::Base.send( :extend, CSVHelper ) if defined? ::ActiveRecord::Base
-  ::Hash.send( :include, CSVHelper::InstanceMethods )
+  def self.included(base)
+    base.extend CSVHelper
+  end
 end
+
+ActiveRecord::Base.send( :include, CSVision ) if defined? ActiveRecord::Base
+Hash.send( :include, CSVision::CSVHelper::InstanceMethods )

data/lib/csvision/csv_helper.rb

@@ -1,38 +1,43 @@
 module CSVision
-  def self.included(base)
-    base.extend CSVHelper
-  end
-
   module CSVHelper
     def add_csvision(options={})
       return if included_modules.include? InstanceMethods
-      cattr_accessor :csv_except, :csv_only, :csv_delimeter, :csv_separator, :csv_headers
+      cattr_accessor :csv_except, :csv_only, :csv_delimeter, :csv_separator, :csv_headers, :body
 
       self.csv_only       = options[:only]
       self.csv_except     = options[:except]
       self.csv_delimeter  = options[:delimeter] || '"'
       self.csv_separator  = options[:separator] || ','
+      self.csv_headers    = options[:csv_headers]
+      self.body           = options[:body]
 
       include InstanceMethods
       extend  ClassMethods
     end
 
     module ClassMethods
-      def to_csv(options={})
-        options[:headers] ||= true
-        headers, csv_array  = nil, []
+      def to_csv(options={ :headers => true, :batch_size => 100 })
+        options[:delimeter]   ||= csv_delimeter
+        options[:separator]   ||= csv_separator
+        options[:batch_size]  ||= 100
 
-        self.find_each(:batch_size => options[:batch_size]) do |object|
-          headers   ||= object.csvize( object.attributes.only( *csv_only ).keys,     options ) if csv_only    && !csv_only.empty?
-          headers   ||= object.csvize( object.attributes.except( *csv_except ).keys, options ) if csv_except  && !csv_except.empty?
+        unless self.count < 1
+          headers, csv_array  = nil, []
+          self.find_each :batch_size => options[:batch_size] do |object|
+            unless self.body
+              headers ||= object.csvize( object.attributes.only( *csv_only ).keys,     options ) if csv_only    && !csv_only.empty?
+              headers ||= object.csvize( object.attributes.except( *csv_except ).keys, options ) if csv_except  && !csv_except.empty?
 
-          csv_array << object.to_csv( options.merge(:headers => false) )
-        end
-        content = csv_array.join("\n")
+              csv_array << object.to_csv( options.merge(:headers => false) )
+            else
+              values    = self.body.call object
+              headers ||= object.csvize( self.csv_headers, options ) if self.csv_headers
+              csv_array << object.csvize( values, options )
+            end
+          end
 
-        if options[:headers]
-          headers + "\n" + content
-        else
+          content = csv_array.join("\n")
+          return headers + "\n" + content if options[:headers]
           content
         end
       end
@@ -61,7 +66,7 @@ module CSVision
         @csv += csvize(values, options)
       end
 
-      def csvize(values, options)
+      def csvize(values, options={})
         delimeter = options[:delimeter] || csv_delimeter
         separator = options[:separator] || csv_separator
 

data/lib/csvision/version.rb

@@ -1,3 +1,3 @@
 module CSVision
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/test/app/models/sample_stack.rb

@@ -0,0 +1,21 @@
+class SampleStack
+  include CSVision
+  attr_accessor :attributes
+
+  add_csvision :csv_headers => %w/price name/, :body => lambda { |s| [ s[:name], s[:price] ] }
+
+  def initialize( attributes={}, inventory = [] )
+    @attributes = attributes
+    @@inventory = inventory
+  end
+
+  def self.count
+    @@inventory.size
+  end
+
+  def self.find_each( opts={} )
+    @@inventory.each do |item|
+      yield item
+    end
+  end
+end

data/test/app/models/user.rb

@@ -0,0 +1,18 @@
+class User < ActiveRecord::Base
+  add_csvision :csv_headers => %w/street_cred nickname incognito/, :body => lambda { |u| [ u.street_cred, u.nickname, u.incognito ] }
+
+  scope :flunky, where( 'points <= 5' )
+
+  def incognito
+    nickname.reverse
+  end
+
+  def street_cred
+    points * 100 + ( nickname_cred )
+  end
+
+  private
+  def nickname_cred
+    nickname.unpack( 'U' * nickname.length ).sum # good nickname equals more street cred
+  end
+end

data/test/db/schema.rb

@@ -8,4 +8,9 @@ ActiveRecord::Schema.define do
     t.datetime "created_at"
     t.datetime "updated_at"
   end
+
+  create_table "users", :force => true do |t|
+    t.string  "nickname"
+    t.integer "points"
+  end
 end

data/test/outside_of_rails_test.rb

@@ -0,0 +1,44 @@
+require 'test_helper'
+
+class OutsideOfRails < ActiveSupport::TestCase
+  EXPECTED_CSV = <<-CSV
+"price","name"
+"beer","9"
+"milk","5"
+"tuna","3"
+CSV
+
+  EXPECTED_CSV_WITHOUT_HEADERS = <<-CSV
+"beer","9"
+"milk","5"
+"tuna","3"
+CSV
+
+  def setup
+    assert @inventory = [
+      { :name => 'beer', :price => 9 },
+      { :name => 'milk', :price => 5 },
+      { :name => 'tuna', :price => 3 } ]
+  end
+
+  test "can use csvsion on POROS" do
+    assert sample_stack = SampleStack.new( :foo => 'foo', :bar => 'bar' )
+    assert sample_stack.respond_to?( :to_csv )
+    assert csv = sample_stack.to_csv( :headers => false )
+    assert_match /foo/, csv
+    assert_match /bar/, csv
+  end
+
+  test "can make use of class methods" do
+    assert sample_stack = SampleStack.new({ :name => 'groceries'}, @inventory)
+    assert SampleStack.respond_to?( :to_csv )
+    assert csv = SampleStack.to_csv
+    assert_equal EXPECTED_CSV.chomp, csv
+  end
+
+  test "can use option filters on POROS" do
+    assert sample_stack = SampleStack.new({ :name => 'groceries'}, @inventory)
+    assert csv = SampleStack.to_csv( :headers => false )
+    assert_equal EXPECTED_CSV_WITHOUT_HEADERS.chomp, csv
+  end
+end

data/test/test_helper.rb

@@ -1,14 +1,12 @@
 require 'rubygems'
 require 'bundler/setup'
-require 'csvision'
 require 'test/unit'
 require 'active_record'
 require 'active_support'
 require 'active_support/dependencies'
+require 'csvision'
 require 'turn'
 
-include CSVision
-
 TEST_PATH = File.expand_path( File.join File.dirname( __FILE__ ) )
 config = YAML::load( IO.read( File.join TEST_PATH, 'config', 'database.yml' ) )['test']['sqlite']
 
@@ -19,3 +17,10 @@ ActiveRecord::Base.silence do
   ActiveRecord::Migration.verbose = false
   load File.join( TEST_PATH, 'db','schema.rb' )
 end
+
+class ActiveSupport::TestCase
+  def teardown
+    User.delete_all
+    Product.delete_all
+  end
+end

data/test/user_test.rb

@@ -0,0 +1,47 @@
+require 'test_helper'
+
+class UserTest < ActiveSupport::TestCase
+  EXPECTED_CSV = <<-CSV
+"street_cred","nickname","incognito"
+"495","user0","0resu"
+"998","user3","3resu"
+"1501","user6","6resu"
+"2004","user9","9resu"
+"2546","user12","21resu"
+CSV
+
+  EXPECTED_CSV_WITH_SCOPE = <<-CSV
+"street_cred","nickname","incognito"
+"495","user0","0resu"
+"998","user3","3resu"
+"1501","user6","6resu"
+CSV
+
+  EXPECTED_CSV_WITHOUT_HEADERS = <<-CSV
+"495","user0","0resu"
+"998","user3","3resu"
+"1501","user6","6resu"
+"2004","user9","9resu"
+"2546","user12","21resu"
+CSV
+
+  def setup
+    5.times { |i| assert User.create( :nickname => "user#{ i * 3}", :points => i * 5 ) }
+  end
+
+  test "can call to_csv directly from model" do
+    assert User.respond_to?(:to_csv)
+    assert csv = User.to_csv
+    assert_equal EXPECTED_CSV.chomp, csv
+  end
+
+  test "can chain scopes into the csv call" do
+    assert csv = User.flunky.to_csv
+    assert EXPECTED_CSV_WITH_SCOPE.chomp, csv
+  end
+
+  test "can pass options to t_csv" do
+    assert csv = User.to_csv( :headers => false )
+    assert_equal EXPECTED_CSV_WITHOUT_HEADERS.chomp, csv
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: csvision
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Enrique Vidal
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-04-10 00:00:00 Z
+date: 2012-04-14 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activerecord
@@ -60,7 +60,7 @@ dependencies:
   type: :development
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: mocha
+  name: rake
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
@@ -73,24 +73,10 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: rake
-  prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: turn
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -102,7 +88,7 @@ dependencies:
         - 2
         version: 0.8.2
   type: :development
-  version_requirements: *id006
+  version_requirements: *id005
 description: Gives Hash the ability to be turned into csv files
 email: 
 - enrique@cloverinteractive.com
@@ -123,11 +109,15 @@ files:
 - lib/csvision/csv_helper.rb
 - lib/csvision/version.rb
 - test/app/models/product.rb
+- test/app/models/sample_stack.rb
+- test/app/models/user.rb
 - test/config/database.yml
 - test/csvision_test.rb
 - test/db/schema.rb
+- test/outside_of_rails_test.rb
 - test/product_test.rb
 - test/test_helper.rb
+- test/user_test.rb
 homepage: http://cloverinteractive.github.com/csvision/
 licenses: []
 
@@ -163,8 +153,13 @@ specification_version: 3
 summary: Adds support to hashes to be turned into csv
 test_files: 
 - test/app/models/product.rb
+- test/app/models/sample_stack.rb
+- test/app/models/user.rb
 - test/config/database.yml
 - test/csvision_test.rb
 - test/db/schema.rb
+- test/outside_of_rails_test.rb
 - test/product_test.rb
 - test/test_helper.rb
+- test/user_test.rb
+has_rdoc: