csv-omg 1.0.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.2@csv-omg

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in csv-omg.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Gert Goet, ThinkCreate
+
+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,70 @@
+Overview [![stillmaintained](http://stillmaintained.com/eval/csv-omg.png)](http://stillmaintained.com/eval/csv-omg)
+========
+
+CsvOmg (formerly known as [csvmapper](https://github.com/thinkcreate/csvmapper)) easily lets you map CSV to objects. Inspired by [happymapper](https://github.com/jnunemaker/happymapper).
+Please check out the example below and included tests to see how it works.
+
+
+Examples
+-----
+
+    module Shop
+      class Product
+        include CsvOmg
+
+        column :name,           'product_name'
+        column :uid,            'product_uid',    Integer
+        column :description,    2
+        column(:price_in_cents, 'product_price',  Float){|float| (float * 100).round }
+
+      end
+    end
+
+    csv =<<-CSV.gsub(/^ +/,'')
+      product_uid,product_name,product_description,product_price
+      1200,Ham,like you never tasted before,19.99
+    CSV
+
+    p1 = Shop::Product.parse(csv).first
+    p1.price_in_cents   # 1999
+
+Requirements
+------------
+
+[FasterCSV](https://rubygems.org/gems/fastercsv)
+
+Installation
+------------
+
+    $ gem install csv-omg
+
+Author
+------
+
+Gert Goet (eval) :: gert@thinkcreate.nl :: @gertgoet
+
+License
+------
+
+(The MIT license)
+
+Copyright (c) 2011 Gert Goet, ThinkCreate
+
+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/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib' << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end

data/csv-omg.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "csv-omg/version"
+
+Gem::Specification.new do |s|
+  s.name        = "csv-omg"
+  s.version     = CsvOmg::Version
+  s.date        = Time.now.strftime('%Y-%m-%d')
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Gert Goet"]
+  s.email       = ["gert@thinkcreate.nl"]
+  s.homepage    = "http://github.com/eval/csv-omg"
+  s.summary     = %q{Easily map CSV to objects}
+  s.description = <<desc
+CsvOmg easily lets you map CSV to objects. Inspired by happymapper.
+desc
+
+  s.rubyforge_project = "csv-omg"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency('fastercsv', '~>1.5.4')
+
+  s.add_development_dependency('test-spec', '~>0.10.0')
+  s.add_development_dependency('rr', '~>1.0.2')
+  s.add_development_dependency('activerecord', '~>3.0.6')
+  s.add_development_dependency('sqlite3', '~>1.3.3')
+end

data/lib/csv-omg.rb

@@ -0,0 +1,92 @@
+require 'fastercsv'
+
+module CsvOmg
+  
+  class Column < Struct.new(:attr, :source, :type, :conversion);end
+  
+  def self.included(base)
+    base.instance_variable_set("@_columns", {})
+    base.instance_variable_set("@_parser_options", {
+                                :headers      => true, 
+                                :skip_blanks  => true
+                              })
+    base.extend ClassMethods
+  end
+  
+  module ClassMethods
+    
+    def parse(contents, parser_opts={})
+      @_parser_options.merge!(parser_opts)
+      
+      instances = []
+      parser = FasterCSV.new(contents, @_parser_options)
+      
+      parser.each do |line|
+        instance = new
+        
+        @_columns.values.each do |column|
+          raw_value = line[column[:source]]
+          
+          value = column_value(raw_value, column[:type], column[:conversion])
+          
+          instance.send("#{column.attr.to_s}=", value)
+        end
+        instances << instance
+      end
+      instances
+    end
+    
+    def column(attr, *args, &block)
+      attr = attr.to_s
+      type = args.delete(([String, Float, Integer, Date, DateTime] & args).first) || String
+      source = args.first || attr
+      
+      @_columns[attr] = Column.new(attr, source, type, block)
+      
+      create_accessor(attr)
+    end
+    
+    private
+    def column_value(raw_value, type, conversion)
+      value = begin
+        case type.to_s
+        when 'Date'
+          Date.parse(raw_value) rescue ''
+        when 'DateTime'
+          DateTime.parse(raw_value) rescue ''
+        when 'Float'
+          Float(raw_value)    rescue 0.0
+        when 'Integer'
+          Integer(raw_value)  rescue 0
+        else
+          raw_value.to_s
+        end
+      end
+      
+      conversion ? conversion.call(value) : value
+    end
+    
+    def create_getter(name)
+      class_eval <<-EOS, __FILE__, __LINE__
+        def #{name}
+          @#{name}
+        end
+      EOS
+    end
+
+    def create_setter(name)
+      class_eval <<-EOS, __FILE__, __LINE__
+        def #{name}=(value)
+          @#{name} = value
+        end
+      EOS
+    end
+
+    def create_accessor(name)
+      unless respond_to?('column_names') && column_names.include?(name)
+        create_getter(name)
+        create_setter(name)
+      end
+    end
+  end
+end

data/lib/csv-omg/version.rb

@@ -0,0 +1,3 @@
+module CsvOmg
+  Version = VERSION = "1.0.0"
+end

data/test/csv_omg_test.rb

@@ -0,0 +1,183 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+
+shared_context 'CsvOmg' do
+  
+  it 'should respond to parse' do
+    @klass.should.respond_to(:parse)
+  end
+  
+  context '#parse' do
+    before { @collection = @klass.parse(@csv)}
+    it 'returns array of instances of correct class' do
+      @collection.class.should  == Array
+      @collection.first.class.should == @klass
+    end
+  end
+  
+  context 'instances' do
+    before{ @instance = @klass.new }
+    
+    specify 'have a getter for every column' do
+      @instance_expectations.each do |expectations|
+        expectations.each do |name, value|
+          @instance.should.respond_to(name.to_s)
+        end
+      end
+    end
+    
+    specify 'have a setter for every column' do
+      @instance_expectations.each do |expectations|
+        expectations.each do |name, value|
+          @instance.should.respond_to("#{name}=")
+        end
+      end
+    end
+    
+    context 'returned by #parse' do
+      
+      before { @instances = @klass.parse(@csv).first(@instance_expectations.size)}
+      
+      specify 'have the correct types and values' do
+        @instance_expectations.each_with_index do |expectations, ix|
+          expectations.each do |name, value|
+            var = @instances[ix].send("#{name}")
+          
+            var.class.should == value.class
+            var.should == value
+          end
+        end
+      end
+    end
+  end
+end
+
+module Shop
+  class Product
+    include CsvOmg
+    
+    column(:category, 'product_category', Integer)
+    column(:created_on, 2, Date)
+    column(:price, 'product_price', Float)
+    column(:naam, 'name'){|name| "Mr. #{name}"}
+  end
+end
+
+context 'simple class' do
+  before{
+    @klass  = Shop::Product
+    @csv =<<-CSV.gsub(/^ +/,'')
+      name,product_price,created,non_used_column,product_category
+      Brown,1000.0,13-12-2008,garbage,1
+      Pink,2000.0,14-12-2008,garbage2,2
+    CSV
+
+    @instance_expectations = [
+                                {
+                                  :price  => 1000.0,
+                                  :created_on => Date.parse('13-12-2008'),
+                                  :naam   => 'Mr. Brown',
+                                  :category => 1
+                                },
+                                {
+                                  :naam   => 'Mr. Pink',
+                                  :price  => 2000.0,
+                                  :created_on => Date.parse('14-12-2008'),
+                                  :category => 2
+                                }
+                              ]
+  }
+  behaves_like 'CsvOmg'
+  
+end
+
+class Transaction
+  include CsvOmg
+  
+  # Price Paid,Stock Symbol,Regulator,Name,City,FDIC Number,Transaction Type,State,Program,Pricing Mechanism,Type of Institution,Total Assets,Date,OTS Number,Description
+  
+  column :symbol, 'Stock Symbol'
+  column(:price_in_cents, 'Price Paid') {|raw| raw.to_f * 100 rescue 0.0 }
+  column :description, 'Description'
+  column :ots,  'OTS Number'
+  column :fdic, 'FDIC Number', Integer
+end
+
+context 'some more csv' do
+  before {
+    @klass = Transaction
+    @csv  = File.open(File.dirname(__FILE__) + '/fixtures/large.csv').read
+
+    @instance_expectations = [
+                        {
+                          :symbol  =>  'STT',
+                          :price_in_cents =>  200000000000.0,
+                          :description  =>  'Preferred Stock w/Warrants',
+                          :ots  => '',
+                          :fdic => 1111435
+                        },
+                        {
+                          :symbol  =>  'C',
+                          :price_in_cents =>  2500000000000.0,
+                          :description  =>  'Preferred Stock w/Warrants',
+                          :ots  => '',
+                          :fdic => 1951350
+                        }
+                    ]
+  }
+  
+  behaves_like 'CsvOmg'
+end
+
+require 'active_record'
+require 'sqlite3'
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database  => ":memory:")
+
+ActiveRecord::Migration.verbose = false
+ActiveRecord::Schema.define do
+  create_table :ar_products do |t|
+    t.column :name, :string
+    t.column :price, :float
+    
+    t.timestamps
+  end
+end
+
+class ARProduct < ActiveRecord::Base
+  include CsvOmg
+  
+  attr_protected :name
+  
+  column :name
+  column :price, 'product_price', Float
+  column :uid, 'product_uid', Integer
+  column(:created_at, 'product_created', DateTime)
+  
+end
+
+context 'active record class' do
+  DBColumn = ActiveRecord::ConnectionAdapters::Column
+  before {
+    # stub(ARProduct).table_exists?{ true }
+    # stub(ARProduct).columns { [
+    #                             DBColumn.new("name",  nil, "string", false),
+    #                             DBColumn.new("price", nil, "float", false)
+    #                           ] }
+    
+    @klass = ARProduct
+    @csv =<<-CSV.gsub(/^ +/,'')
+      name,product_price,product_created,product_uid,product_category
+      naam,1000.0,13-12-2008 13:00,1200,1
+      line2,2000.0,14-12-2008 14:00,1201,2
+    CSV
+
+    @instance_expectations = [{
+                                :name => 'naam', 
+                                :price => 1000.0, 
+                                :uid => 1200, 
+                                :created_at => DateTime.parse('13-12-2008 13:00')}
+                              ]
+  }
+  behaves_like 'CsvOmg'
+end

data/test/fixtures/large.csv

@@ -0,0 +1,5 @@
+Price Paid,Stock Symbol,Regulator,Name,City,FDIC Number,Transaction Type,State,Program,Pricing Mechanism,Type of Institution,Total Assets,Date,OTS Number,Description
+2000000000.00,STT,Federal Reserve,"State 
+Street Corporation",Boston,1111435,Purchase,MA,CPP,Par,holding company,276290703000.00,2008-10-28,,Preferred Stock w/Warrants
+25000000000.00,C,Federal Reserve,Citigroup Inc.,New York,1951350,Purchase,NY,CPP,Par,holding company,1306041994000.00,2008-10-28,,Preferred Stock w/Warrants
+25000000000.00,WFC,Federal Reserve,Wells Fargo & Company,San Francisco,1120754,Purchase,CA,CPP,Par,holding company,569241620000.00,2008-10-28,,Preferred Stock w/Warrants

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'test/spec'
+require 'rr'
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'csv-omg')
+
+class Test::Unit::TestCase
+  include RR::Adapters::TestUnit
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: csv-omg
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: !!null 
+platform: ruby
+authors:
+- Gert Goet
+autorequire: !!null 
+bindir: bin
+cert_chain: []
+date: 2011-04-08 00:00:00.000000000 +02:00
+default_executable: !!null 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fastercsv
+  requirement: &22794760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.4
+  type: :runtime
+  prerelease: false
+  version_requirements: *22794760
+- !ruby/object:Gem::Dependency
+  name: test-spec
+  requirement: &22794260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: *22794260
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: &22793800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :development
+  prerelease: false
+  version_requirements: *22793800
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &22793340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.6
+  type: :development
+  prerelease: false
+  version_requirements: *22793340
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &22792880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+  type: :development
+  prerelease: false
+  version_requirements: *22792880
+description: ! 'CsvOmg easily lets you map CSV to objects. Inspired by happymapper.
+
+'
+email:
+- gert@thinkcreate.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- csv-omg.gemspec
+- lib/csv-omg.rb
+- lib/csv-omg/version.rb
+- test/csv_omg_test.rb
+- test/fixtures/large.csv
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/eval/csv-omg
+licenses: []
+post_install_message: !!null 
+rdoc_options: []
+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: '0'
+requirements: []
+rubyforge_project: csv-omg
+rubygems_version: 1.5.0
+signing_key: !!null 
+specification_version: 3
+summary: Easily map CSV to objects
+test_files: []