rgarner-csv-mapper 0.7.0 → 0.8.0

data/README.rdoc

@@ -35,6 +35,22 @@ The following example will import a CSV file to an Array of Struct[http://www.ru
   results.first.last_name   # Doe
   results.first.age         # 27
 
+==== Named Columns Example
+Columns which aren't mentioned won't appear in the results.
+
+  # Don't mention first name
+  results = CsvMapper.import('/path/to/file_with_header_row.csv') do
+    named_columns
+
+    surname('last_name')
+    age
+  end
+
+  results.first.surname     # Doe
+  results.first.age         # 27
+  results.first.first_name  # nil
+  results.first.last_name   # nil
+
 ==== Import to ActiveRecord Example
 Although CsvMapper has no dependency on ActiveRecord; it's easy to import a CSV file to ActiveRecord models and save them.
 

data/Rakefile

@@ -10,7 +10,7 @@ begin
     gem.email = "rgarner@zephyros-systems.co.uk"
     gem.homepage = "http://github.com/rgarner/csv-mapper"
     gem.authors = ["Luke Pillow", "Russell Garner"]
-    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "rspec", ">= 2.0.0"
     gem.add_dependency "fastercsv"  
     gem.extra_rdoc_files << "History.txt"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
@@ -20,13 +20,13 @@ rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
 end
 
-require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new(:spec) do |spec|
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.libs << 'lib' << 'spec'
-  spec.spec_files = FileList['spec/**/*_spec.rb']
+  spec.pattern = 'spec/**/*_spec.rb'
 end
 
-Spec::Rake::SpecTask.new(:rcov) do |spec|
+RSpec::Core::RakeTask.new(:rcov) do |spec|
   spec.libs << 'lib' << 'spec'
   spec.pattern = 'spec/**/*_spec.rb'
   spec.rcov = true
@@ -36,8 +36,8 @@ task :spec => :check_dependencies
 
 task :default => :spec
 
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
+require 'rdoc/task'
+RDoc::Task.new do |rdoc|
   version = File.exist?('VERSION') ? File.read('VERSION') : ""
 
   rdoc.rdoc_dir = 'rdoc'

data/VERSION

@@ -1 +1 @@
-0.7.0
+0.8.0

data/lib/csv-mapper/row_map.rb

@@ -184,8 +184,14 @@ module CsvMapper
     end
 
     def iterate_headers
-      attributes = FasterCSV.new(@csv_data, @parser_options).readline
       @start_at_row = [ @start_at_row, 1 ].max
+
+      csv = FasterCSV.new(@csv_data, @parser_options)
+
+      # Header is for now assumed to be one row above data
+      (@start_at_row - 1).times { csv.readline } if @start_at_row > 1
+
+      attributes = csv.readline
       @csv_data.rewind
       attributes.each_with_index { |name, index| yield name, index }
     end

data/lib/csv-mapper.rb

@@ -45,7 +45,8 @@ end
 # 
 # ===== The Basics
 # * +map_to+ - Override the default Struct target. Accepts a class and an optional hash of default attribute names and values.
-# * +start_at_row+ - Specify what row to begin parsing at.  Use this to skip headers.
+# * +named_columns+ - Enables named columns mode. Headers are required. See "Named Column Mappings" below.
+# * +start_at_row+ - Specify what row to begin parsing at.  Use this to skip headers. When +named_columns+ is used, headers are assumed to be one line above this row.
 # * +before_row+ - Accepts an Array of method name symbols or lambdas to be invoked before parsing each row.
 # * +after_row+ - Accepts an Array of method name symbols or lambdas to be invoked after parsing each row.
 # * +delimited_by+ - Accepts a character to be used to delimit columns. Use this to specify pipe-delimited files.
@@ -70,6 +71,13 @@ end
 # Attribute mapping declarations and "modifiers" may be chained
 #   foo.at(4).map :some_transform
 #
+# === Named Columns Mappings
+# When +named_columns+ is called, column names will be read from one row above +start_at_row+.  This allows
+# you to map cell properties to named columns in the CSV.  For example:
+#   surname('Last Name') # Where 'Last Name' is the name of a column in the CSV
+#
+# Columns which go unmentioned will be omitted from the results.
+#
 # === Create Reusable Mappings
 # The +import+ method accepts an instance of RowMap as an optional mapping parameter.  
 # The easiest way to create an instance of a RowMap is by using +map_csv+.

data/spec/csv-mapper_spec.rb

@@ -2,47 +2,48 @@ require File.dirname(__FILE__) + '/spec_helper.rb'
 
 describe CsvMapper do
   describe "included" do
-    before(:each) do    
+    before(:each) do
       @mapped_klass = Class.new do
-         include CsvMapper
-         def upcase_name(row, index)
-           row[index].upcase
-         end
-       end
+        include CsvMapper
+
+        def upcase_name(row, index)
+          row[index].upcase
+        end
+      end
       @mapped = @mapped_klass.new
     end
 
     it "should allow the creation of CSV mappings" do
       mapping = @mapped.map_csv do
-        start_at_row 2      
+        start_at_row 2
       end
-    
+
       mapping.should be_instance_of(CsvMapper::RowMap)
       mapping.start_at_row.should == 2
     end
-  
+
     it "should import a CSV IO" do
       io = 'foo,bar,00,01'
-      results = @mapped.import(io, :type => :io) do 
+      results = @mapped.import(io, :type => :io) do
         first
         second
       end
-    
+
       results.should be_kind_of(Enumerable)
       results.should have(1).things
       results[0].first.should == 'foo'
       results[0].second.should == 'bar'
     end
-  
+
     it "should import a CSV File IO" do
       results = @mapped.import(File.dirname(__FILE__) + '/test.csv') do
         start_at_row 1
         [first_name, last_name, age]
       end
-    
+
       results.size.should == 3
-    end 
-  
+    end
+
     it "should stop importing at a specified row" do
       results = @mapped.import(File.dirname(__FILE__) + '/test.csv') do
         start_at_row 1
@@ -65,64 +66,64 @@ describe CsvMapper do
 
     it "should import non-comma delimited files" do
       piped_io = 'foo|bar|00|01'
-    
+
       results = @mapped.import(piped_io, :type => :io) do
         delimited_by '|'
         [first, second]
       end
-    
+
       results.should have(1).things
       results[0].first.should == 'foo'
       results[0].second.should == 'bar'
     end
-    
+
     it "should allow named tranformation mappings" do
       def upcase_name(row)
         row[0].upcase
       end
-      
+
       results = @mapped.import(File.dirname(__FILE__) + '/test.csv') do
         start_at_row 1
-        
+
         first_name.map :upcase_name
       end
-      
+
       results[0].first_name.should == 'JOHN'
     end
   end
-  
+
   describe "extended" do
     it "should allow the creation of CSV mappings" do
       mapping = CsvMapper.map_csv do
-        start_at_row 2      
+        start_at_row 2
       end
-    
+
       mapping.should be_instance_of(CsvMapper::RowMap)
       mapping.start_at_row.should == 2
     end
-  
+
     it "should import a CSV IO" do
       io = 'foo,bar,00,01'
-      results = CsvMapper.import(io, :type => :io) do 
+      results = CsvMapper.import(io, :type => :io) do
         first
         second
       end
-    
+
       results.should be_kind_of(Enumerable)
       results.should have(1).things
       results[0].first.should == 'foo'
       results[0].second.should == 'bar'
     end
-  
+
     it "should import a CSV File IO" do
       results = CsvMapper.import(File.dirname(__FILE__) + '/test.csv') do
         start_at_row 1
         [first_name, last_name, age]
       end
-    
+
       results.size.should == 3
-    end 
-  
+    end
+
     it "should stop importing at a specified row" do
       results = CsvMapper.import(File.dirname(__FILE__) + '/test.csv') do
         start_at_row 1
@@ -144,40 +145,58 @@ describe CsvMapper do
     end
 
     describe "Adding only certain attributes by name or alias" do
-      before :all do
-        @results = CsvMapper.import(File.dirname(__FILE__) + '/test_with_empty_column_names.csv') do
-          named_columns
-          surname('Last Name')
-          age.map { |row, index| row[index].to_i }
+      context "A file with headers and empty column names" do
+        before :all do
+          @results = CsvMapper.import(File.dirname(__FILE__) + '/test_with_empty_column_names.csv') do
+            named_columns
+            surname('Last Name')
+            age.map { |row, index| row[index].to_i }
+          end
         end
-      end
 
-      it "should have Last name aliased as surname" do
-        @results[1].surname.should == 'Doe'
-      end
+        it "should have Last name aliased as surname" do
+          @results[1].surname.should == 'Doe'
+        end
 
-      it "should transform age to 26 (a Fixnum)" do
-        @results[1].age.should == 26
-      end
+        it "should transform age to 26 (a Fixnum)" do
+          @results[1].age.should == 26
+        end
 
-      it "should not have First Name at all" do
-        lambda { @results[1].first_name }.should raise_error(NoMethodError)
-      end
+        it "should not have First Name at all" do
+          lambda { @results[1].first_name }.should raise_error(NoMethodError)
+        end
 
-      it "should raise IndexError when adding non-existent fields" do
-        lambda {
-          @results = CsvMapper.import(File.dirname(__FILE__) + '/test_with_empty_column_names.csv') do
-            add_attributes_by_name('doesnt_exist')
-          end
-        }.should raise_error(IndexError)
+        it "should raise IndexError when adding non-existent fields" do
+          lambda {
+            @results = CsvMapper.import(File.dirname(__FILE__) + '/test_with_empty_column_names.csv') do
+              add_attributes_by_name('doesnt_exist')
+            end
+          }.should raise_error(IndexError)
+        end
+
+        it "should raise IndexError when adding non-existent aliases" do
+          lambda {
+            @results = CsvMapper.import(File.dirname(__FILE__) + '/test_with_empty_column_names.csv') do
+              my_new_field('doesnt_exist')
+            end
+          }.should raise_error(IndexError)
+        end
       end
 
-      it "should raise IndexError when adding non-existent aliases" do
-        lambda {
-          @results = CsvMapper.import(File.dirname(__FILE__) + '/test_with_empty_column_names.csv') do
-            my_new_field('doesnt_exist')
+      context "A crazy not-really CSV file with some lines to ignore at the top" do
+        before :all do
+          @results = CsvMapper.import(File.dirname(__FILE__) + '/test_with_pushed_down_header.csv') do
+            start_at_row 5
+            named_columns
+            surname('Last Name')
+            age.map { |row, index| row[index].to_i }
           end
-        }.should raise_error(IndexError)
+        end
+
+        it "should transform age to 26" do
+          @results[1].age.should == 26
+        end
+
       end
     end
 
@@ -191,26 +210,26 @@ describe CsvMapper do
 
     it "should import non-comma delimited files" do
       piped_io = 'foo|bar|00|01'
-    
+
       results = CsvMapper.import(piped_io, :type => :io) do
         delimited_by '|'
         [first, second]
       end
-    
+
       results.should have(1).things
       results[0].first.should == 'foo'
       results[0].second.should == 'bar'
     end
-    
+
     it "should not allow transformation mappings" do
       def upcase_name(row)
         row[0].upcase
       end
-      
-      (lambda do 
+
+      (lambda do
         results = CsvMapper.import(File.dirname(__FILE__) + '/test.csv') do
           start_at_row 1
-        
+
           first_name.map :upcase_name
         end
       end).should raise_error(Exception)

data/spec/spec_helper.rb

@@ -1,9 +1,3 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'csv-mapper'
-require 'spec'
-require 'spec/autorun'
-
-Spec::Runner.configure do |config|
-  
-end

data/spec/test_with_pushed_down_header.csv

@@ -0,0 +1,8 @@
+"Some data"
+
+This is a test file whose header line starts at the 0-indexed 4th row and the data starts at the 5th.  I know. It's not a CSV as such, but they exist...
+
+First Name, Last Name, Age,,,
+John,Doe,27,,,
+Jane,Doe,26,unnamed_value,,
+Bat,Man,52,,,

metadata

@@ -1,66 +1,50 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: rgarner-csv-mapper
-version: !ruby/object:Gem::Version 
-  hash: 3
-  prerelease: false
-  segments: 
-  - 0
-  - 7
-  - 0
-  version: 0.7.0
+version: !ruby/object:Gem::Version
+  version: 0.8.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Luke Pillow
 - Russell Garner
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-08-27 00:00:00 +01:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rspec
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2155992480 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 13
-        segments: 
-        - 1
-        - 2
-        - 9
-        version: 1.2.9
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: fastercsv
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2155992480
+- !ruby/object:Gem::Dependency
+  name: fastercsv
+  requirement: &2156007300 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
-description: CSV Mapper makes it easy to import data from CSV files directly to a collection of any type of Ruby object. The simplest way to create mappings is declare the names of the attributes in the order corresponding to the CSV file column order.
+  prerelease: false
+  version_requirements: *2156007300
+description: CSV Mapper makes it easy to import data from CSV files directly to a
+  collection of any type of Ruby object. The simplest way to create mappings is declare
+  the names of the attributes in the order corresponding to the CSV file column order.
 email: rgarner@zephyros-systems.co.uk
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - History.txt
 - LICENSE
 - README.rdoc
-files: 
-- .gitignore
+files:
 - History.txt
 - LICENSE
 - README.rdoc
@@ -76,42 +60,31 @@ files:
 - spec/spec_helper.rb
 - spec/test.csv
 - spec/test_with_empty_column_names.csv
-has_rdoc: true
+- spec/test_with_pushed_down_header.csv
 homepage: http://github.com/rgarner/csv-mapper
 licenses: []
-
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
-require_paths: 
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+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 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.16
 signing_key: 
 specification_version: 3
-summary: rgarner-CsvMapper is a fork of a small library intended to simplify the common steps involved with importing CSV files to a usable form in Ruby. It has support for null column names. When this is merged, this gem will be removed.
-test_files: 
-- spec/csv-mapper/attribute_map_spec.rb
-- spec/csv-mapper/row_map_spec.rb
-- spec/csv-mapper_spec.rb
-- spec/spec_helper.rb
+summary: rgarner-CsvMapper is a fork of a small library intended to simplify the common
+  steps involved with importing CSV files to a usable form in Ruby. It has support
+  for null column names. When this is merged, this gem will be removed.
+test_files: []

data/.gitignore

@@ -1,4 +0,0 @@
-pkg/*
-doc/*
-.idea/*
-*.gemspec