csvision 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in csvision.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Enrique Vidal
+
+MIT License
+
+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/README.md

@@ -0,0 +1,69 @@
+# CSVision
+
+Convert a Hash into a CSV the easy way.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+`gem 'csvision'`
+
+And then execute:
+
+`bundle`
+
+Or install it yourself as:
+
+`gem install csvision`
+
+## 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.
+
+### 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.
+
+```ruby
+include 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:
+
+1. `to_csv` at the model instance
+2. `to_csv` at the model class
+3. `add_csvision` at the model class
+
+A rails model might look something like this:
+
+```ruby
+class Product < ActiveRecord::Base
+  validates_presence_of :name, :permalink, :description
+  add_csvision :except => %w/updated_at created_at/
+end
+```
+
+CSVision lets you customize the way your CSV is formed, you can use any of the following options in the `add_csvision` method:
+
+1. `:only` to set only those parameters you wish to include.
+2. `:except` this does the opposite it excludes options from the list.
+3. `:delimeter` this set the field delimeter and it defaults to `"`
+4. `:separator` this set the field separator and it defults to `,`
+
+## TODO:
+
+1. Allow users to set their own list of parameters
+2. Add support for other ORM's
+3. Rails 3.x responder.
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,13 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rake'
+desc 'Default: run all tests.'
+task :default => :test
+
+require 'rake/testtask'
+Rake::TestTask.new( :test )  do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end

data/csvision.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.unshift File.expand_path("../lib", __FILE__)
+require "csvision/version"
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Enrique Vidal"]
+  gem.email         = ["enrique@cloverinteractive.com"]
+  gem.description   = %q{Gives Hash the ability to be turned into csv files}
+  gem.summary       = %q{Adds support to hashes to be turned into csv}
+  gem.homepage      = "http://cloverinteractive.github.com/csvision/"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "csvision"
+  gem.require_paths = ["lib"]
+  gem.version       = CSVision::VERSION
+
+  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/csv_helper.rb

@@ -0,0 +1,78 @@
+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
+
+      self.csv_only       = options[:only]
+      self.csv_except     = options[:except]
+      self.csv_delimeter  = options[:delimeter] || '"'
+      self.csv_separator  = options[:separator] || ','
+
+      include InstanceMethods
+      extend  ClassMethods
+    end
+
+    module ClassMethods
+      def to_csv(options={})
+        options[:headers] ||= true
+        headers, csv_array  = nil, []
+
+        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?
+
+          csv_array << object.to_csv( options.merge(:headers => false) )
+        end
+        content = csv_array.join("\n")
+
+        if options[:headers]
+          headers + "\n" + content
+        else
+          content
+        end
+      end
+    end
+
+    module InstanceMethods
+      def to_csv(options={})
+        options[:delimeter] ||= '"'
+        options[:separator] ||= ','
+        options[:headers]     = true if options[:headers].nil?
+        headers, values, rows = [], [], nil
+        @csv = ''
+
+        if self.respond_to?( :attributes ) && self.attributes.kind_of?( Hash )
+          rows    = self.attributes.only( *csv_only ).to_a      if csv_only   && !csv_only.empty?
+          rows  ||= self.attributes.except( *csv_except ).to_a  if csv_except && !csv_except.empty?
+          rows  ||= self.attributes.to_a
+        end
+
+        ( rows || self.to_a ).each do |(key, value)|
+          headers << key if options[:headers]
+          values  << value
+        end
+
+        @csv  = csvize(headers, options) + "\n" if options[:headers]
+        @csv += csvize(values, options)
+      end
+
+      def csvize(values, options)
+        delimeter = options[:delimeter] || csv_delimeter
+        separator = options[:separator] || csv_separator
+
+        values.map do |value|
+          delimeter + value.to_s + delimeter
+        end.join(separator)
+      end
+
+      def cached_csv
+        @csv
+      end
+    end
+  end
+end

data/lib/csvision/version.rb

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

data/lib/csvision.rb

@@ -0,0 +1,7 @@
+require "csvision/version"
+require "csvision/csv_helper"
+
+module CSVision
+  ::ActiveRecord::Base.send( :extend, CSVHelper ) if defined? ::ActiveRecord::Base
+  ::Hash.send( :include, CSVHelper::InstanceMethods )
+end

data/test/app/models/product.rb

@@ -0,0 +1,4 @@
+class Product < ActiveRecord::Base
+  validates_presence_of :name, :permalink, :description
+  add_csvision :except => %w/updated_at created_at/
+end

data/test/config/database.yml

@@ -0,0 +1,4 @@
+test:
+  sqlite:
+    adapter: sqlite3
+    database: ":memory:"

data/test/csvision_test.rb

@@ -0,0 +1,34 @@
+require 'test_helper'
+
+class CSVisionTest < ActiveSupport::TestCase
+  def setup
+    assert @hash_demo = ActiveSupport::OrderedHash.new
+    assert @hash_demo[:a] = 'a'
+    assert @hash_demo[:b] = 'b'
+    assert @hash_demo[:c] = 'c'
+  end
+
+  test "check plugin type" do
+    assert_kind_of Module, CSVision
+  end
+
+  test "hashes are successfully turned into csv" do
+    assert_match /[abc]\'\,/, @hash_demo.to_csv(:delimeter => "'")
+  end
+
+  test "can call get a csv cached after turned into csv once" do
+    assert_nil @hash_demo.cached_csv
+    assert_match /[abc]\'/, @hash_demo.to_csv(:delimeter => "'")
+
+    assert @hash_demo[:d] = 'd'
+    assert_not_equal @hash_demo.cached_csv, @hash_demo.to_csv
+  end
+
+  test "can create csv without headers" do
+    assert_match /[abc]\"\,/, @hash_demo.to_csv(:headers => false)
+  end
+
+  test "can set different separator and spacer" do
+    assert_match /[abc]\|/, @hash_demo.to_csv(:delimeter => '', :separator => '|')
+  end
+end

data/test/db/schema.rb

@@ -0,0 +1,11 @@
+ActiveRecord::Schema.define do
+  create_table "products", :force => true do |t|
+    t.string   "name",                                                         :null => false
+    t.text     "description",                                                  :null => false
+    t.string   "permalink",                                                    :null => false
+    t.boolean  "published",                                 :default => false, :null => false
+    t.decimal  "price",       :precision => 8, :scale => 2, :default => 0.0,   :null => false
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+end

data/test/product_test.rb

@@ -0,0 +1,34 @@
+require 'test_helper'
+
+class ProductTest < ActiveSupport::TestCase
+  def setup
+    5.times { |i| assert Product.create!( :name => "name_#{i}", :permalink => "permalink_#{i}", :description => "description_#{i}") }
+  end
+
+  test "ActiveRecord::Base objects should respond to add_csvision" do
+    assert Product.respond_to? :add_csvision
+  end
+
+  test "ActiveRecord::Base classes should respond to to_csv" do
+    assert Product.respond_to? :to_csv
+  end
+
+  test "ActiveRecord object should respond to to_csv" do
+    assert product = Product.new
+    assert product.respond_to? :to_csv
+  end
+
+  test "ActiveRecord objects can set either csv_only or csv_except" do
+    # since csv_except is set to %w/creted_at updated_at/ csv should not contain these
+    assert product = Product.new
+    assert headers = product.to_csv.split("\n").first
+    assert ! headers.include?( 'created_at' )
+    assert ! headers.include?( 'updated_at' )
+  end
+
+  test "Can create a csv from a collection of products" do
+    assert products_csv = Product.to_csv
+    assert products_csv
+    assert_match /[a-z_]+\"\,/, products_csv
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,21 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'csvision'
+require 'test/unit'
+require 'active_record'
+require 'active_support'
+require 'active_support/dependencies'
+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']
+
+ActiveRecord::Base.establish_connection config
+ActiveSupport::Dependencies.autoload_paths.unshift File.join( TEST_PATH, 'app', 'models' )
+
+ActiveRecord::Base.silence do
+  ActiveRecord::Migration.verbose = false
+  load File.join( TEST_PATH, 'db','schema.rb' )
+end

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification 
+name: csvision
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Enrique Vidal
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-04-10 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        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 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 59
+        segments: 
+        - 0
+        - 8
+        - 2
+        version: 0.8.2
+  type: :development
+  version_requirements: *id006
+description: Gives Hash the ability to be turned into csv files
+email: 
+- enrique@cloverinteractive.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- csvision.gemspec
+- lib/csvision.rb
+- lib/csvision/csv_helper.rb
+- lib/csvision/version.rb
+- test/app/models/product.rb
+- test/config/database.yml
+- test/csvision_test.rb
+- test/db/schema.rb
+- test/product_test.rb
+- test/test_helper.rb
+homepage: http://cloverinteractive.github.com/csvision/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Adds support to hashes to be turned into csv
+test_files: 
+- test/app/models/product.rb
+- test/config/database.yml
+- test/csvision_test.rb
+- test/db/schema.rb
+- test/product_test.rb
+- test/test_helper.rb