csv_to_object 0.0.2 → 0.0.3

data/README.md

@@ -24,9 +24,30 @@ Given a file person.csv with the contents
   `0,Lindsey,Austino`  
   `1,Dodie,Egnor`
 
-  `CsvToObject::CsvToObject.new('[path to person.csv]').to_objects` will return 
+  ```ruby
+    csv_path = 'tmp/person.csv'
+    CsvToObject::CsvToObject.new(csv.path).to_objects
+    [#<Person:0x000001021a8148 @id=0, @first_name="Lindsey", @last_name="Austino">,
+     #<Person:0x000001021a8030 @id=1, @first_name="Dodie", @last_name="Egnor">]
+  ```
 
-  `[#<Person:0x000001021a8148 @id=0, @first_name="Lindsey", @last_name="Austino">, #<Person:0x000001021a8030 @id=1, @first_name="Dodie", @last_name="Egnor">`]
+### Attribute Names
+
+CSV_to_object does not use the default header converter options. When converting the first line of the csv file into attribute names, the following conversions are applied:
+
+* Encoded using CSV::CharacterEncoding
+* Downcased
+* Spaces are replaced with underscores
+
+When passed to the target object.new() method, attribute names are strings, not symbols. For example, the instantiation of the Person object above would be:
+
+  ```ruby
+    Person.new({"id" => 0, "first_name" => "Lindsey", "last_name" => "Austino"})
+  ```
+
+So if you are looking for specific hash keys in `initialize()`, use strings not symbols.
+
+If this behavior is not desired, you could overwrite the `header_converter` method of `CsvToObject`.
 
 ## Contributing
 

data/csv_to_object.gemspec

@@ -2,8 +2,8 @@
 require File.expand_path('../lib/csv_to_object/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.authors       = ["Ian Whitney"]
-  gem.email         = ["ian@ianwhitney.com"]
+  gem.authors       = ["Ian Whitney", "Davin Lagerroos"]
+  gem.email         = ["iwhitney@ssa-i.org", "dlagerroos@ssa-i.org"]
   gem.description   = %q{Takes a CSV file and returns a a collection of objects generated by that CSV file.}
   gem.summary       = %q{Takes a CSV file and returns a a collection of objects generated by that CSV file.}
   gem.homepage      = "https://github.com/SeniorServiceAmerica/csv_to_object"

data/lib/csv_to_object/version.rb

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

data/lib/csv_to_object.rb

@@ -6,30 +6,36 @@ module CsvToObject
 
     # Requires the path to the csv file.
     def initialize(input_path)
-      @input = File.open(input_path)
+      @input_path = File.open(input_path)
     end
     
     # Converts the data lines of the csv file to objects.
     # Objects have the class of the name of the csv file.
     # The first line of the csv file defines the attribute names for the data lines.
-    # 
     #   person.csv => [person objects]
+    #   attribute names are downcased and have spaces replaced with _.
+    #   attribute names are strings. 
     def to_objects
       objects = []
-      CSV.table(@input).each do |row|
+      file = File.open(@input_path)
+      CSV.table(file, {header_converters: header_converter}).each do |row|
         objects << new_object(row.to_hash)
       end
       objects
     end
     
     private
-        
+    
+    def header_converter
+      lambda { |h| h.encode(CSV::ConverterEncoding).downcase.gsub(/\s+/, "_") }
+    end
+    
     def new_object(attrs)
       @object ? @object.new(attrs) : object_to_create().new(attrs)
     end
     
     def object_to_create()
-      class_name = File.basename(@input.path).gsub('.csv','').capitalize
+      class_name = File.basename(@input_path).gsub('.csv','').capitalize
       @object = Object::const_get(class_name)
     end
   end

data/spec/csv_to_object_spec.rb

@@ -7,6 +7,10 @@ describe CsvToObject do
     @test_csv_path = 'test/csv/person.csv'
     @source_file = File.open(@test_csv_path)
     @c2o = CsvToObject::CsvToObject.new(@test_csv_path)
+    @number_of_data_lines = (@source_file.count - 1)
+    @source_file.rewind
+    @attribute_names = @source_file.first
+    @source_file.rewind
   end
 
   it "returns an array" do
@@ -18,11 +22,11 @@ describe CsvToObject do
   end
   
   it "returns as many objects as there are data lines in the csv file" do
-    @c2o.to_objects.count.should == (@source_file.count - 1)
+    @c2o.to_objects.count.should == @number_of_data_lines
   end
   
   it "instantiate objects defined by its source file name, using the data line as parameters" do
-    expected_paramaters = CSV.table(File.open(@test_csv_path))
+    expected_paramaters = CSV.table(File.open(@test_csv_path),{header_converters: lambda { |h| h.encode(CSV::ConverterEncoding).downcase.gsub(/\s+/, "_") }})
     expected_paramaters.each do |x|
       @c2o.should_receive(:new_object).with(x.to_hash)
     end
@@ -31,7 +35,20 @@ describe CsvToObject do
   
   it "should use the data line to populate attributes" do
     @c2o.to_objects.first.id.should == 0    
-    @c2o.to_objects.first.first_name.should == "Lindsey"
+    @c2o.to_objects.first.first_name.should == "Billie Lindsey"
     @c2o.to_objects.first.last_name.should == "Austino"
   end
+  
+  it "replaces spaces in attribute names with underscores" do
+    @attribute_names.include?('last name').should == true
+    @c2o.should_receive(:new_object).with(include_key('last_name')).exactly(@number_of_data_lines).times
+    @c2o.to_objects
+  end
+
+  it "downcases attribute names and does not remove non-word characters" do
+    @attribute_names.include?('SCORE_[person_id|date]').should == true
+    @c2o.should_receive(:new_object).with(include_key('score_[person_id|date]')).exactly(@number_of_data_lines).times
+    @c2o.to_objects
+  end
+  
 end

data/spec/spec_helper.rb

@@ -17,3 +17,9 @@ RSpec.configure do |config|
   #     --seed 1234
   config.order = 'random'
 end
+
+RSpec::Matchers.define :include_key do |expected|
+  match do |actual|
+    actual.keys.include?(expected)
+  end
+end

data/test/csv/person.csv

@@ -1,11 +1,11 @@
-id,first_name,last_name
-0,Lindsey,Austino
-1,Dodie,Egnor
-2,Tommie,Mclauglin
-3,Aletha,Vettel
-4,Matilda,Osornio
-5,Robby,Kloke
-6,Forest,Neall
-7,Sherrie,Licon
-8,Elroy,Bergren
-9,Darlene,Guialdo
+id,first_name,last name,SCORE_[person_id|date]
+0,Billie Lindsey,Austino,[0|2012-01-01]
+1,Dodie,Egnor,[0|2012-01-01]
+2,Tommie,Mclauglin,[0|2012-01-01]
+3,Aletha,Vettel,[0|2012-01-01]
+4,Matilda,Osornio,[0|2012-01-01]
+5,Robby,Kloke,[0|2012-01-01]
+6,Forest,Neall,[0|2012-01-01]
+7,Sherrie,Licon,[0|2012-01-01]
+8,Elroy,Bergren,[0|2012-01-01]
+9,Darlene,Guialdo,[0|2012-01-01]

data/test/lib/person.rb

@@ -2,8 +2,8 @@ class Person
   attr_reader :id, :first_name, :last_name
 
   def initialize(args={})
-    @id = args[:id]
-    @first_name = args[:first_name]
-    @last_name = args[:last_name]
+    @id = args["id"]
+    @first_name = args["first_name"]
+    @last_name = args["last_name"]
   end
 end

metadata

@@ -1,19 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: csv_to_object
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
 - Ian Whitney
+- Davin Lagerroos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-27 00:00:00.000000000Z
+date: 2012-08-31 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2168815940 !ruby/object:Gem::Requirement
+  requirement: &2164666320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,11 +22,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2168815940
+  version_requirements: *2164666320
 description: Takes a CSV file and returns a a collection of objects generated by that
   CSV file.
 email:
-- ian@ianwhitney.com
+- iwhitney@ssa-i.org
+- dlagerroos@ssa-i.org
 executables: []
 extensions: []
 extra_rdoc_files: []