virgola 0.0.1

data/.gitignore

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

data/.rvmrc

@@ -0,0 +1,47 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional.
+environment_id="ruby-1.9.3-p0@virgola"
+
+#
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficicent compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+#
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments" \
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]] ; then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create  "$environment_id"
+fi
+
+#
+# If you use an RVM gemset file to install a list of gems (*.gems), you can have
+# it be automatically loaded. Uncomment the following and adjust the filename if
+# necessary.
+#
+# filename=".gems"
+# if [[ -s "$filename" ]] ; then
+#   rvm gemset import "$filename" | grep -v already | grep -v listed | grep -v complete | sed '/^$/d'
+# fi
+
+#
+# If you use bundler and would like to run bundle each time you enter the
+# directory, you can uncomment the following code.
+#
+#   # Ensure that Bundler is installed. Install it if it is not.
+#   if ! command -v bundle >/dev/null; then
+#      printf "The rubygem 'bundler' is not installed. Installing it now.\n"
+#      gem install bundler
+#   fi
+#
+#   # Bundle while reducing excess noise.
+#   printf "Bundling your gems. This may take a few minutes on a fresh clone.\n"
+#   bundle | grep -v '^Using ' | grep -v ' is complete' | sed '/^$/d'
+#
+

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'rspec'
+  gem 'rake'
+  gem 'pry'
+end

data/Gemfile.lock

@@ -0,0 +1,46 @@
+PATH
+  remote: .
+  specs:
+    virgola (0.0.1)
+      activemodel (= 3.1.3)
+      activesupport (= 3.1.3)
+      bundler (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (3.1.3)
+      activesupport (= 3.1.3)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activesupport (3.1.3)
+      multi_json (~> 1.0)
+    builder (3.0.0)
+    coderay (1.0.5)
+    diff-lcs (1.1.3)
+    i18n (0.6.0)
+    method_source (0.7.0)
+    multi_json (1.0.4)
+    pry (0.9.8.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.7)
+      slop (>= 2.4.4, < 3)
+    rake (0.9.2.2)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    slop (2.4.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pry
+  rake
+  rspec
+  virgola!

data/License

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Vicente Reig Rincón de Arellano
+
+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.rdoc

@@ -0,0 +1,46 @@
+= virgola
+
+CSV to object mapping library.
+
+== Usage
+
+Given the following CSV file
+
+  id,name,email
+  1,"Chris Floess",chris@propertybase.com
+  2,"Konstantin Krauss",konstantin@propertybase.com
+  3,"Vicente Reig",vicente@propertybase.com
+
+You map it to an array of Person objects.
+
+  class Person
+    include Virgola
+
+    attribute :id
+    attribute :name
+    attribute :email
+
+    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
+      puts 'yes, victory!'
+    end
+  end
+
+You can parse and map the file with the initial Extraction API:
+
+  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 }

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/virgola/attribute_methods.rb

@@ -0,0 +1,61 @@
+# encoding: UTF-8
+
+#
+# Overridable accessors as of Nunemaker.
+# 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
+
+    included do
+      attribute_method_suffix '', '=', '?'
+    end
+
+    module ClassMethods
+      def attributes
+        @attributes ||= []
+      end
+
+      def attribute(name, options={})
+        define_attribute_methods Array.wrap name
+        attribute = Attribute.new(name.to_sym, options)
+        attributes << attribute unless attributes.include?(attribute)
+      end
+    end
+
+    def attribute(name)
+      instance_variable_get "@#{name}"
+    end
+
+    def attribute=(name, value)
+      instance_variable_set "@#{name}", value
+    end
+
+    def attribute?(name)
+      binding.pry
+      self.attribute(name).present?
+    end
+
+    def attributes
+      self.class.attributes
+    end
+  end
+end

data/lib/virgola/callbacks.rb

@@ -0,0 +1,18 @@
+# encoding: UTF-8
+module Virgola
+  module Callbacks
+    extend ActiveSupport::Concern
+
+    # ActiveModel::Callbacks is just a Ruby module, not a ActiveSupport::Concern module.
+    included do
+      extend  ActiveModel::Callbacks
+      include ActiveModel::Validations::Callbacks
+
+      define_model_callbacks :map,   only: [:after]
+    end
+
+    module ClassMethods
+      include ActiveModel::Callbacks
+    end
+  end
+end

data/lib/virgola/csv_parser.rb

@@ -0,0 +1,27 @@
+# encoding: UTF-8
+
+require 'csv'
+
+module Virgola
+  class CSVParser
+    def initialize(klass, contents)
+      @klass = klass
+      @contents = contents
+    end
+
+    def extract(csv)
+      result_set = CSV.parse(csv*"\n")
+      result_set.collect { |result_set_row| map(result_set_row) }
+    end
+
+    def map(values)
+      mapped_object = @klass.new
+
+      @klass.attributes.each.with_index do |attr, index|
+        mapped_object.send("#{attr.name}=", values[index])
+      end
+      mapped_object.run_callbacks(:map)
+      mapped_object
+    end
+  end
+end

data/lib/virgola/extraction_methods.rb

@@ -0,0 +1,32 @@
+# encoding: UTF-8
+module Virgola::ExtractionMethods
+  extend ActiveSupport::Concern
+
+  def count
+    @contents.size-1
+  end
+
+  def all
+    self.in_groups_of(@contents.size)
+  end
+
+  def each
+    self.in_groups_of(1) { |group|
+      yield group.first
+    }
+  end
+
+  def in_groups_of(batch_size=1000)
+    all_groups = []
+
+    (0..self.count).step(batch_size) { |batch_start|
+      batch_offset = batch_start + batch_size
+      batch_offset = @contents.size if batch_offset >= @contents.size
+
+      group = self.extract(@contents[batch_start+1, batch_offset])
+      (block_given? && group.present?) ? (yield group) : (all_groups += group)
+    }
+
+    all_groups
+  end
+end

data/lib/virgola/version.rb

@@ -0,0 +1,3 @@
+module Virgola
+  VERSION = "0.0.1"
+end

data/lib/virgola.rb

@@ -0,0 +1,27 @@
+# encoding: UTF-8
+# TODO: split them into smaller requires
+require 'active_model'
+require 'active_support/all'
+
+require 'virgola/version'
+require 'virgola/attribute_methods'
+require 'virgola/extraction_methods'
+require 'virgola/csv_parser'
+require 'virgola/callbacks'
+
+module Virgola
+  extend  ActiveSupport::Concern
+
+  include Virgola::AttributeMethods
+  include Virgola::Callbacks
+
+  class CSVParser
+    include Virgola::ExtractionMethods
+  end
+
+  module ClassMethods
+    def parse(csv)
+      @parser = CSVParser.new self, csv.strip.split("\n")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'rspec'
+require File.expand_path('../../lib/virgola', __FILE__)

data/spec/virgola_attribute_methods_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+class Person
+  include Virgola::AttributeMethods
+
+  attribute :id,   match: 'refno'
+  attribute :name, match: 'givenname'
+end
+
+describe Virgola do
+
+  before :all do
+    @person = Person.new
+  end
+
+  it 'should respond to the id method' do
+    @person.should respond_to :id
+    @person.should respond_to :name
+  end
+
+end

data/spec/virgola_callbacks_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+module DummyMapper
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def parse(csv)
+      true
+    end
+  end
+
+  def map
+    true
+  end
+end
+
+class Person
+  include Virgola::Callbacks, DummyMapper
+
+  after_map :do_something_after_map_a_row
+
+  protected
+
+  def do_something_after_map_a_row
+    true
+  end
+end
+
+describe Virgola do
+
+  before :all do
+    @person = Person.new
+  end
+
+  it 'should process callbacks after mapping' do
+    @person.should_receive :do_something_after_map_a_row
+    @person.run_callbacks(:map)
+  end
+end

data/spec/virgola_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+class Person
+  include Virgola
+
+  attribute :id
+  attribute :name
+  attribute :email
+
+  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 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 count three people' do
+    @person_parser.count.should == 3
+  end
+
+  it 'should extract three people' do
+    people = @person_parser.all
+    people.should include @chris
+    people.should include @konsti
+    people.should include @vicente
+  end
+
+  it 'should extract three people in three iterations' do
+    @person_parser.each { |person|
+      @expected_pips.should include person
+    }
+  end
+
+  it 'should extract three people in three batches' do
+    @person_parser.in_groups_of(1) { |group|
+      @expected_pips.should include group.first
+    }
+  end
+end

data/virgola.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "virgola/version"
+
+Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
+  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.files       = Dir.glob("{lib,spec}/**/*") + %w[License Rakefile README.rdoc]
+  s.required_ruby_version     = '>= 1.9.2'
+  s.required_rubygems_version = '>= 1.8.11'
+
+  s.author            = 'Vicente Reig Rincón de Arellano'
+  s.email             = 'vicente.reig@gmail.com'
+  s.homepage          = 'http://github.com/vicentereig/virgola'
+
+  s.add_dependency('activesupport', '3.1.3')
+  s.add_dependency('activemodel',   '3.1.3')
+  s.add_dependency('bundler',       '~> 1.0')
+
+  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"]
+
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: virgola
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Vicente Reig Rincón de Arellano
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70151194729640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 3.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *70151194729640
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: &70151194728980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 3.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *70151194728980
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70151194728200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70151194728200
+description: Virgola is a CSV to Ruby objects mapper.
+email: vicente.reig@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- License
+- README.rdoc
+- Rakefile
+- lib/virgola.rb
+- lib/virgola/attribute_methods.rb
+- lib/virgola/callbacks.rb
+- lib/virgola/csv_parser.rb
+- lib/virgola/extraction_methods.rb
+- lib/virgola/version.rb
+- spec/spec_helper.rb
+- spec/virgola_attribute_methods_spec.rb
+- spec/virgola_callbacks_spec.rb
+- spec/virgola_spec.rb
+- virgola.gemspec
+homepage: http://github.com/vicentereig/virgola
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.8.11
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.16
+signing_key: 
+specification_version: 3
+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_callbacks_spec.rb
+- spec/virgola_spec.rb