virgola 0.0.2 → 0.0.3

data/README.textile

@@ -3,12 +3,15 @@ h1. virgola
 CSV to object mapping library.
 
 h2. Author
+
 "Vicente Reig Rincón de Arellano":http://twitter.com/vicentereig
 
 
 h2. Installation
 
-  gem install virgola
+<pre lang="bash">
+  $ gem install virgola
+</pre>
 
 h2. Usage
 
@@ -21,7 +24,7 @@ Given the following CSV file
   3,"Vicente Reig",vicente@propertybase.com
 </pre>
 
-You map it to an array of Person objects.
+You map it to an array of Person objects by specifying to match columns with the `attribute` method.
 
 <pre lang="ruby">
   class Person
@@ -31,30 +34,53 @@ You map it to an array of Person objects.
     attribute :name
     attribute :email
 
-    def initialize
-      yield self if block_given?
-    end
+    after_map :do_something_after_mapping_a_row
 
-    after_map :do_something_after_map_a_row
+    protected
 
-    def ==(pip)
-      return false unless pip.is_a?(Person)
-      self.id == pip.id && self.name == pip.name && self.email == pip.email
+    def do_something_after_mapping_a_row
+      puts 'YES, victory!'
     end
+  end
+</pre>
 
-    protected
+You actually extract the data and perform the mappings using the Extraction API.
+
+<pre lang="ruby">
+  Person.parse(csv).all   # Array of Person instances mapping the guys above
+  Person.parse(csv).count # 3
+  Person.parse(csv).each { |pip|
+    # do stuff
+  }
+  Person.parse(csv).in_groups_of(100) { |pips|
+    # do stuff
+  }
+</pre>
 
-    def do_something_after_map_a_row
-      puts 'yes, victory!'
+Attributes are overridable.
+
+<pre lang="ruby">
+  class Person
+    def email
+      "<#{super}>"
     end
   end
+
+  Person.parse(csv).each do |pip|
+    puts pip.email # <chris@propertybase.com>, ...
+  end
 </pre>
 
-You can parse and map the file with the initial Extraction API:
+You can access the mappings also as instance attributes.
 
 <pre lang="ruby">
-  Person.parse(csv_contents).all   # Array of Person instances mapping the guys above
-  Person.parse(csv_contents).count # 3
-  Person.parse(csv_contents).each { |pip| # do stuff }
-  Person.parse(csv_contents).in_groups_of(100) { |pips| # do stuff }
+  class Person
+    def email
+      "<#{@email}>"
+    end
+  end
+
+  Person.parse(csv).each do |pip|
+    puts pip.email # <chris@propertybase.com>, ...
+  end
 </pre>

data/lib/virgola.rb

@@ -4,6 +4,7 @@ require 'active_model'
 require 'active_support/all'
 
 require 'virgola/version'
+require 'virgola/attribute'
 require 'virgola/attribute_methods'
 require 'virgola/extraction_methods'
 require 'virgola/csv_parser'

data/lib/virgola/attribute.rb

@@ -0,0 +1,57 @@
+class Boolean; end
+
+module Virgola
+
+  Types = [String, Float, Time, Date, DateTime, Integer, Boolean]
+
+
+  class Attribute
+    attr_accessor :name, :type, :options
+
+    def initialize(name,type=String,*args)
+      @name    = name
+      @type    = type
+      @value   = nil
+      @options = args.extract_options!
+    end
+
+    def map(mapped_object, value)
+      mapped_object.send("#{self.name}=", cast(value))
+    end
+
+    #
+    # Based on <https://github.com/jnunemaker/happymapper/blob/master/lib/happymapper/item.rb#L84>
+    #
+    def cast(value)
+      if    self.type == Float    then value.to_f
+      elsif self.type == Time     then Time.parse(value)
+      elsif self.type == Date     then Date.parse(value)
+      elsif self.type == DateTime then DateTime.parse(value)
+      elsif self.type == Boolean  then ['true', 't'].include?(value.to_s.downcase)
+      elsif self.type == Integer  then
+        # ganked from happymapper :)
+        value_to_i = value.to_i
+        if value_to_i == 0 && value != '0'
+          value_to_s = value.to_s
+          begin
+            Integer(value_to_s =~ /^(\d+)/ ? $1 : value_to_s)
+          rescue ArgumentError
+            nil
+          end
+        else
+          value_to_i
+        end
+      else
+        value
+      end
+    rescue
+      value
+    end
+
+    def ==(attribute)
+      return false unless attribute.is_a?(Attribute)
+      self.name == attribute.name
+    end
+  end
+
+end

data/lib/virgola/attribute_methods.rb

@@ -5,22 +5,6 @@
 # http://railstips.org/blog/archives/2010/08/29/building-an-object-mapper-override-able-accessors/
 #
 module Virgola
-
-  class Attribute
-    attr_accessor :name, :options, :value
-
-    def initialize(name,*args)
-      @name    = name
-      @value   = nil
-      @options = args.extract_options!
-    end
-
-    def ==(attribute)
-      return false unless attribute.is_a?(Attribute)
-      self.name == attribute.name && self.value == attribute.value
-    end
-  end
-
   module AttributeMethods
     extend  ActiveSupport::Concern
     include ActiveModel::AttributeMethods
@@ -36,7 +20,7 @@ module Virgola
 
       def attribute(name, options={})
         define_attribute_methods Array.wrap name
-        attribute = Attribute.new(name.to_sym, options)
+        attribute = Attribute.new(name.to_sym, options.delete(:type), options)
         attributes << attribute unless attributes.include?(attribute)
       end
     end
@@ -50,7 +34,6 @@ module Virgola
     end
 
     def attribute?(name)
-      binding.pry
       self.attribute(name).present?
     end
 

data/lib/virgola/csv_parser.rb

@@ -5,7 +5,7 @@ require 'csv'
 module Virgola
   class CSVParser
     def initialize(klass, contents)
-      @klass = klass
+      @klass    = klass
       @contents = contents
     end
 
@@ -18,7 +18,7 @@ module Virgola
       mapped_object = @klass.new
 
       @klass.attributes.each.with_index do |attr, index|
-        mapped_object.send("#{attr.name}=", values[index])
+        attr.map(mapped_object, values[index])
       end
       mapped_object.run_callbacks(:map)
       mapped_object

data/lib/virgola/version.rb

@@ -1,3 +1,3 @@
 module Virgola
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/virgola_attribute_type_castings.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+class PersonWithoutCasting
+  include Virgola
+
+  attribute :id    #  defaults to String
+  attribute :name  #  defaults to String
+  attribute :email #  defaults to String
+
+  def initialize
+    yield self if block_given?
+  end
+
+  after_map :do_something_after_map_a_row
+
+  def ==(pip)
+    return false unless pip.is_a?(Person)
+    self.id == pip.id && self.name == pip.name && self.email == pip.email
+  end
+
+  protected
+
+  def do_something_after_map_a_row
+
+  end
+end
+
+class Person
+  include Virgola
+
+  attribute :id,    type: Integer
+  attribute :name,  type: String # although it defaults to String
+  attribute :email, type: String
+
+  def initialize
+    yield self if block_given?
+  end
+
+  after_map :do_something_after_map_a_row
+
+  def ==(pip)
+    return false unless pip.is_a?(Person)
+    self.id == pip.id && self.name == pip.name && self.email == pip.email
+  end
+
+  protected
+
+  def do_something_after_map_a_row
+
+  end
+end
+
+CSV_INPUT = <<-CSV
+id,name,email
+1,"Chris Floess",chris@propertybase.com
+2,"Konstantin Krauss",konstantin@propertybase.com
+3,"Vicente Reig",vicente@propertybase.com
+CSV
+
+describe Virgola::Attribute do
+
+  before :each do
+    @person_parser = Person.parse(CSV_INPUT)
+    @chris   = Person.new { |p| p.id = 1; p.name = "Chris Floess";      p.email = "chris@propertybase.com"}
+    @konsti  = Person.new { |p| p.id = 2; p.name = "Konstantin Krauss"; p.email = "konstantin@propertybase.com"}
+    @vicente = Person.new { |p| p.id = 3; p.name = "Vicente Reig";      p.email = "vicente@propertybase.com"}
+    @expected_pips = [@chris, @konsti, @vicente]
+  end
+
+  it 'should match us' do
+    Person.parse(CSV_INPUT).all.should == @expected_pips
+  end
+
+
+end

data/spec/virgola_spec.rb

@@ -64,4 +64,24 @@ describe Virgola do
       @expected_pips.should include group.first
     }
   end
+
+  it 'should allow to override attribute accesors' do
+    class Person
+      def email
+        "<#{super}>"
+      end
+    end
+
+    @chris.email.should == "<chris@propertybase.com>"
+  end
+
+  it 'should allow to access instance attributes' do
+    class Person
+      def email
+        "<#{@email}>"
+      end
+    end
+
+    @chris.email.should == "<chris@propertybase.com>"
+  end
 end

data/virgola.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.name        = 'virgola'
   s.version     = Virgola::VERSION
   s.summary     = 'An attempt to make CSV parsing and mapping suck less.'
-  s.description = 'Virgola is a CSV to Ruby objects mapper.'
+  s.description = 'Virgola is a CSV to object mapper.'
   s.files       = Dir.glob("{lib,spec}/**/*") + %w[License Rakefile README.textile]
   s.required_ruby_version     = '>= 1.9.2'
   s.required_rubygems_version = '>= 1.8.11'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: virgola
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-14 00:00:00.000000000 Z
+date: 2012-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70302046764000 !ruby/object:Gem::Requirement
+  requirement: &70255741873540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -21,10 +21,10 @@ dependencies:
         version: 3.1.3
   type: :runtime
   prerelease: false
-  version_requirements: *70302046764000
+  version_requirements: *70255741873540
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &70302046763500 !ruby/object:Gem::Requirement
+  requirement: &70255741872780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -32,10 +32,10 @@ dependencies:
         version: 3.1.3
   type: :runtime
   prerelease: false
-  version_requirements: *70302046763500
+  version_requirements: *70255741872780
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70302046763000 !ruby/object:Gem::Requirement
+  requirement: &70255741872040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,8 +43,8 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70302046763000
-description: Virgola is a CSV to Ruby objects mapper.
+  version_requirements: *70255741872040
+description: Virgola is a CSV to object mapper.
 email: vicente@propertybase.com
 executables: []
 extensions: []
@@ -58,6 +58,7 @@ files:
 - README.textile
 - Rakefile
 - lib/virgola.rb
+- lib/virgola/attribute.rb
 - lib/virgola/attribute_methods.rb
 - lib/virgola/callbacks.rb
 - lib/virgola/csv_parser.rb
@@ -65,6 +66,7 @@ files:
 - lib/virgola/version.rb
 - spec/spec_helper.rb
 - spec/virgola_attribute_methods_spec.rb
+- spec/virgola_attribute_type_castings.rb
 - spec/virgola_callbacks_spec.rb
 - spec/virgola_spec.rb
 - virgola.gemspec
@@ -95,5 +97,6 @@ summary: An attempt to make CSV parsing and mapping suck less.
 test_files:
 - spec/spec_helper.rb
 - spec/virgola_attribute_methods_spec.rb
+- spec/virgola_attribute_type_castings.rb
 - spec/virgola_callbacks_spec.rb
 - spec/virgola_spec.rb