conformist 0.1.3 → 0.2.0

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## 0.2.0 / 2012-08-18
+
+* `Conformist::Schema#confrom` takes option to skip first row.
+* Removed deprecated classes and warnings.
+
 ## 0.1.3 / 2012-02-09
 
 * Column indexes are implicitly incremented when the index argument is omitted. Implicit indexing is all or nothing.
@@ -29,7 +34,7 @@
 ## 0.0.2 / 2011-04-28
 
 * Column#values_in will be nil if the index is out of range rather than an empty string. This is consistent with CSV
-* Fixed 1.8.7 and JRuby dependancies. Gemspec will not let you specify dependancies based on the version of Ruby. Everyone gets it
+* Fixed 1.8.7 and JRuby dependencies. Gemspec will not let you specify dependencies based on the version of Ruby. Everyone gets it
 
 ## 0.0.1 / 2011-04-27
 

data/README.md

@@ -8,7 +8,7 @@ Bend CSVs to your will with declarative schemas. Map one or many columns, prepro
 
 ## Quick and Dirty Examples
 
-Open a CSV file and declare a schema. A schema compromises of columns. A column takes an arbitary name followed by its position in the input. A column may be derived from multiple positions.
+Open a CSV file and declare a schema. A schema compromises of columns. A column takes an arbitrary name followed by its position in the input. A column may be derived from multiple positions.
 
 ``` ruby
 require 'conformist'
@@ -177,6 +177,15 @@ CSV.open('~/file.csv').responds_to? :each # => true
 [[], [], []].responds_to? :each           # => true
 ```
 
+#### Header Row
+
+`#conform` takes an option to skip the first row of input. Given a typical CSV document,
+the first row is the header row and irrelevant for enumeration.
+
+``` ruby
+schema.conform CSV.open('~/file_with_headers.csv'), :skip_first => true
+```
+
 #### Enumerator
 
 `#conform` is lazy, returning an [Enumerator](http://www.ruby-doc.org/core-1.9.3/Enumerator.html). Input is not parsed until you call `#each`, `#map` or any method defined in [Enumerable](http://www.ruby-doc.org/core-1.9.3/Enumerable.html). That means schemas can be assigned now and evaluated later. `#each` has the lowest memory footprint because it does not build a collection.
@@ -326,7 +335,7 @@ See CHANGELOG.md for a full list of changes.
 * MRI 1.8.7
 * JRuby 1.6.5
 
-## Dependancies
+## Dependencies
 
 No explicit dependencies, although `CSV` and `Spreadsheet` are commonly used.
 

data/conformist.gemspec

@@ -11,20 +11,11 @@ Gem::Specification.new do |s|
   s.homepage             = "https://github.com/tatey/conformist"
   s.summary              = %q{Bend CSVs to your will with declarative schemas.}
   s.description          = %q{Bend CSVs to your will with declarative schemas.}
-  s.post_install_message = <<-EOS
-********************************************************************************
-
-  Upgrading from <= 0.0.3? You should be aware of breaking changes. See
-  https://github.com/tatey/conformist and skip to "Upgrading from 0.0.3 to 
-  0.1.1" to learn more. Conformist will raise helpful messages where necessary.
-
-********************************************************************************  
-EOS
 
   s.rubyforge_project = "conformist"
 
   s.required_ruby_version = '>= 1.8.7'
-  
+
   s.add_development_dependency 'minitest'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'spreadsheet'

data/lib/conformist.rb

@@ -1,6 +1,5 @@
 require 'forwardable'
 
-require 'conformist/base'
 require 'conformist/builder'
 require 'conformist/column'
 require 'conformist/hash_struct'
@@ -11,15 +10,11 @@ module Conformist
     require 'generator'
     Enumerator = Generator
   end
-  
+
   def self.extended base
     base.extend Schema
   end
-  
-  def self.foreach *args, &block
-    raise "`Conformist.foreach` has been removed, use something like `[MySchema1.conform(file1), MySchema2.conform(file2)].each(&block)` instead (#{caller.first})"
-  end
-  
+
   def self.new *args, &block
     Class.new { include Schema }.new *args, &block
   end

data/lib/conformist/column.rb

@@ -1,13 +1,13 @@
 module Conformist
   class Column
     attr_accessor :name, :indexes, :preprocessor
-        
+
     def initialize name, *indexes, &preprocessor
       self.name         = name
       self.indexes      = indexes
       self.preprocessor = preprocessor
     end
-    
+
     def values_in enumerable
       values = Array(enumerable).values_at(*indexes).map do |value|
         if value.respond_to? :strip
@@ -15,8 +15,8 @@ module Conformist
         else
           value
         end
-      end    
-      values = values.first if values.size == 1  
+      end
+      values = values.first if values.size == 1
       if preprocessor
         preprocessor.call values
       else

data/lib/conformist/hash_struct.rb

@@ -1,31 +1,31 @@
 module Conformist
   class HashStruct
     extend Forwardable
-    
+
     attr_accessor :attributes
-        
+
     def_delegators :attributes, :[], :[]=, :fetch, :key?
-    
+
     def initialize attributes = {}
       self.attributes = attributes
     end
-    
+
     def merge other
       self.class.new.tap do |instance|
         instance.attributes = attributes.merge other
       end
     end
-    
+
     def == other
       other.class == self.class && attributes == other.attributes
     end
-    
+
   protected
-  
+
     def respond_to_missing? method, include_private
       key?(method) || super
     end
-    
+
     def method_missing method, *args, &block
       fetch(method) { super }
     end

data/lib/conformist/schema.rb

@@ -4,23 +4,19 @@ module Conformist
       base.send :include, InstanceExtensions
       base.send :include, Methods
     end
-    
+
     def self.extended base
       base.extend ClassExtensions
       base.extend Methods
     end
-    
+
     module ClassExtensions
       def inherited base
         base.builder = builder.dup
         base.columns = columns.dup
       end
-      
-      def load *args
-        raise "``#{self.class}.load` has been removed, use something like `#{self.class}.conform(file).each(&block)` instead (#{caller.first})"
-      end
     end
-    
+
     module InstanceExtensions
       def initialize super_schema = nil, &block
         if super_schema
@@ -32,7 +28,7 @@ module Conformist
         end
       end
     end
-    
+
     module Methods
       def builder
         @builder ||= Builder
@@ -55,13 +51,15 @@ module Conformist
         @columns = value
       end
 
-      def conform enumerables
+      def conform enumerables, options = {}
+        options = options.dup
         Enumerator.new do |yielder|
           enumerables.each do |enumerable|
+            next if options.delete :skip_first
             yielder.yield builder.call(self, enumerable)
           end
         end
-      end      
+      end
     end
   end
 end

data/lib/conformist/version.rb

@@ -1,3 +1,3 @@
 module Conformist
-  VERSION = '0.1.3'
+  VERSION = '0.2.0'
 end

data/test/fixtures/citizens.csv

@@ -0,0 +1,5 @@
+Name,Age,Gender
+Aaron,21,Male
+Bec,30,Female
+Charlie,50,Male
+Debbie,26,Female

data/test/schemas/citizens.rb

@@ -0,0 +1,7 @@
+class Citizens
+  extend Conformist
+
+  column :name, 0
+  column :age, 1
+  column :gender, 2
+end

data/test/schemas/fcc.rb

@@ -1,6 +1,6 @@
 class FCC
   extend Conformist
-     
+
   column :name, 10, 11 do |values|
     "#{values[0].upcase}, #{values[-1]}"
   end

data/test/unit/conformist/column_test.rb

@@ -4,42 +4,42 @@ class Conformist::ColumnTest < MiniTest::Unit::TestCase
   def stub_row
     ('a'..'d').to_a
   end
-  
+
   def test_name
     column = Column.new :foo
     assert_equal :foo, column.name
   end
-  
+
   def test_one_index
     column = Column.new :foo, 0
     assert_equal 'a', column.values_in(stub_row)
   end
-  
+
   def test_preprocess_with_one_index
     column = Column.new(:foo, 0) { |value| value.upcase }
     assert_equal 'A', column.values_in(stub_row)
   end
-  
+
   def test_many_indexes
     column = Column.new :foo, 1, 2, 3
     assert_equal ['b', 'c', 'd'], column.values_in(stub_row)
   end
-  
+
   def test_preprocess_with_many_indexes
     column = Column.new(:foo, 1, 2, 3) { |values| values.reverse }
     assert_equal ['d', 'c', 'b'], column.values_in(stub_row)
   end
-  
+
   def test_virtual
     column = Column.new(:foo) { 'a' }
     assert_equal 'a', column.values_in(stub_row)
   end
-  
+
   def test_strip_whitespace
     column = Column.new :foo, 0
     assert_equal 'a', column.values_in(['  a  '])
   end
-  
+
   def test_array
     mock   = MiniTest::Mock.new
     mock.expect :to_a, ['a']
@@ -48,7 +48,7 @@ class Conformist::ColumnTest < MiniTest::Unit::TestCase
     assert_equal 'a', column.values_in('a')
     assert_equal 'a', column.values_in(mock)
   end
-  
+
   def test_nil
     column = Column.new :foo, 0
     assert_nil column.values_in([])

data/test/unit/conformist/hash_struct_test.rb

@@ -5,7 +5,7 @@ class Conformist::HashStructTest < MiniTest::Unit::TestCase
     assert_equal({:a => 1}, HashStruct.new({:a => 1}).attributes)
     assert_empty HashStruct.new.attributes
   end
-  
+
   def test_delegates
     hash = HashStruct.new
     assert hash.respond_to?(:[])
@@ -13,7 +13,7 @@ class Conformist::HashStructTest < MiniTest::Unit::TestCase
     assert hash.respond_to?(:fetch)
     assert hash.respond_to?(:key?)
   end
-  
+
   def test_equality
     hash1 = HashStruct.new :a => 1
     hash2 = HashStruct.new :a => 1
@@ -23,7 +23,7 @@ class Conformist::HashStructTest < MiniTest::Unit::TestCase
     assert_equal hash1, hash2
     refute_equal hash1, hash3
   end
-  
+
   def test_merge
     hash1 = HashStruct.new
     hash2 = hash1.merge :a => 1
@@ -31,13 +31,13 @@ class Conformist::HashStructTest < MiniTest::Unit::TestCase
     refute_equal 1, hash1[:a]
     assert_equal 1, hash2[:a]
   end
-  
+
   def test_readers_with_method_missing
     hash = HashStruct.new :a => 1, :c_d => 1
     assert_equal 1, hash.a
     assert_equal 1, hash.c_d
   end
-  
+
   if respond_to? :respond_to_missing? # Compatible with 1.9
     def test_readers_with_respond_to_missing
       hash = HashStruct.new :a => 1, :c_d => 1

data/test/unit/conformist/schema_test.rb

@@ -17,7 +17,7 @@ class Conformist::SchemaTest < MiniTest::Unit::TestCase
     end
     assert_equal 2, anonymous.columns.size
   end
-  
+
   def test_builder_reader
     assert_equal Builder, Class.new { extend Schema }.builder
   end
@@ -58,6 +58,12 @@ class Conformist::SchemaTest < MiniTest::Unit::TestCase
     assert definition.conform([]).respond_to?(:map)
   end
 
+  def test_conform_skip_first
+    definition = Class.new { extend Schema }
+    definition.column :a, 0
+    assert_equal HashStruct.new({:a => 'value'}), definition.conform(['header', 'value'], :skip_first => true).first
+  end
+
   def test_conform_calls_builders_call_method
     definition = Class.new { extend Schema }
     definition.builder = lambda { |definition, value| value }
@@ -72,10 +78,4 @@ class Conformist::SchemaTest < MiniTest::Unit::TestCase
     assert_equal [0, 1], child1.columns
     assert_equal [0, 2], child2.columns
   end
-  
-  def test_load
-    assert_raises RuntimeError do
-      Class.new { extend Schema }.load
-    end
-  end
 end

data/test/unit/conformist_test.rb

@@ -7,13 +7,7 @@ class ConformistTest < MiniTest::Unit::TestCase
     assert definition.respond_to?(:columns)
     assert definition.respond_to?(:conform)
   end
-  
-  def test_foreach
-    assert_raises RuntimeError do
-      Conformist.foreach
-    end
-  end
-  
+
   def test_new
     assert Conformist.new.class.include?(Schema)
   end

data/test/unit/integration_test.rb

@@ -1,6 +1,7 @@
 require 'csv'
 require 'helper'
 require 'schemas/acma'
+require 'schemas/citizens'
 require 'schemas/fcc'
 require 'spreadsheet'
 
@@ -22,19 +23,25 @@ class IntegrationTest < MiniTest::Unit::TestCase
     last       = enumerable.to_a.last
     assert_equal HashStruct.new(:name=>'CRAFERS', :callsign=>'ADS10', :latitude=>'34 58 57S'), last
   end
-  
+
+  def test_class_with_csv_including_headers
+    enumerable = Citizens.conform open_csv('citizens.csv'), :skip_first => true
+    first      = enumerable.to_a.first
+    assert_equal HashStruct.new(:name => 'Aaron', :age => '21', :gender => 'Male'), first
+  end
+
   def test_inherited_class_with_csv
     enumerable = ACMA::Digital.conform open_csv('acma.csv')
     last       = enumerable.to_a.last
     assert_equal HashStruct.new(:name=>'CRAFERS', :callsign=>'ADS10', :latitude=>'34 58 57S', :signal_type => 'digital'), last
   end
-  
+
   def test_class_with_psv
     enumerable = FCC.conform open_csv('fcc.txt', :col_sep => '|')
     last       = enumerable.to_a.last
     assert_equal HashStruct.new(:name => 'LOS ANGELES, CA', :callsign => 'KVTU-LP', :latitude => '34 13 38.00 N', :signtal_type => 'digital'), last
   end
-  
+
   def test_instance_with_spreadsheet
     book       = Spreadsheet.open fixture('states.xls')
     sheet      = book.worksheet 0
@@ -43,7 +50,7 @@ class IntegrationTest < MiniTest::Unit::TestCase
     last       = enumerable.to_a.last
     assert_equal HashStruct.new(:state => 'QLD'), last
   end
-  
+
   def test_instance_with_array_of_arrays
     data = Array.new.tap do |d|
       d << ['NSW', 'New South Wales', 'Sydney']
@@ -60,7 +67,7 @@ class IntegrationTest < MiniTest::Unit::TestCase
     last = enumerable.to_a.last
     assert_equal HashStruct.new(:state => 'QLD, Queensland', :capital => 'Brisbane'), last
   end
-  
+
   def test_inherited_instance_with_array_of_arrays
     data = Array.new.tap do |d|
       d << ['NSW', 'New South Wales', 'Sydney']

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: conformist
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-09 00:00:00.000000000 Z
+date: 2012-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70317078761180 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70317078761180
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70317078759240 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70317078759240
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: spreadsheet
-  requirement: &70317078758780 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +53,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70317078758780
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Bend CSVs to your will with declarative schemas.
 email:
 - tate@tatey.com
@@ -60,19 +75,19 @@ files:
 - Rakefile
 - conformist.gemspec
 - lib/conformist.rb
-- lib/conformist/base.rb
 - lib/conformist/builder.rb
 - lib/conformist/column.rb
 - lib/conformist/hash_struct.rb
 - lib/conformist/schema.rb
 - lib/conformist/version.rb
 - test/fixtures/acma.csv
+- test/fixtures/citizens.csv
 - test/fixtures/fcc.txt
 - test/fixtures/states.xls
 - test/helper.rb
 - test/schemas/acma.rb
+- test/schemas/citizens.rb
 - test/schemas/fcc.rb
-- test/unit/conformist/base_test.rb
 - test/unit/conformist/builder_test.rb
 - test/unit/conformist/column_test.rb
 - test/unit/conformist/hash_struct_test.rb
@@ -81,11 +96,7 @@ files:
 - test/unit/integration_test.rb
 homepage: https://github.com/tatey/conformist
 licenses: []
-post_install_message: ! "********************************************************************************\n\n
-  \ Upgrading from <= 0.0.3? You should be aware of breaking changes. See\n  https://github.com/tatey/conformist
-  and skip to \"Upgrading from 0.0.3 to \n  0.1.1\" to learn more. Conformist will
-  raise helpful messages where necessary.\n\n********************************************************************************
-  \ \n"
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -103,21 +114,22 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2607692248856246044
+      hash: -2869076359774702419
 requirements: []
 rubyforge_project: conformist
-rubygems_version: 1.8.11
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Bend CSVs to your will with declarative schemas.
 test_files:
 - test/fixtures/acma.csv
+- test/fixtures/citizens.csv
 - test/fixtures/fcc.txt
 - test/fixtures/states.xls
 - test/helper.rb
 - test/schemas/acma.rb
+- test/schemas/citizens.rb
 - test/schemas/fcc.rb
-- test/unit/conformist/base_test.rb
 - test/unit/conformist/builder_test.rb
 - test/unit/conformist/column_test.rb
 - test/unit/conformist/hash_struct_test.rb

data/lib/conformist/base.rb

@@ -1,7 +0,0 @@
-module Conformist
-  module Base
-    def self.included base
-      raise "`include Conformist::Base` has been removed, `extend Conformist` instead (#{caller.first})"
-    end
-  end  
-end

data/test/unit/conformist/base_test.rb

@@ -1,9 +0,0 @@
-require 'helper'
-
-class Conformist::BuilderTest < MiniTest::Unit::TestCase
-  def test_included
-    assert_raises RuntimeError do
-      Class.new { include Base }
-    end
-  end
-end