csv_to_object 0.0.3 → 1.0.0

data/README.md

@@ -1,6 +1,6 @@
 # CsvToObject
 
-Given the path to a CSV file, will return a collection of objects. The csv file name must match the name of an object the gem can instantiate. The first line of the csv file must define attribute names. The following lines contain the data that will be assigned to those attributes
+Given the path to a CSV file, will return a collection of objects. The csv file name must match the name of an object the gem can instantiate. The first line of the csv file must define attribute names. The following lines contain the data that will be assigned to those attributes.
 
 ## Installation
 
@@ -26,29 +26,26 @@ Given a file person.csv with the contents
 
   ```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">]
+    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">]
   ```
 
 ### 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:
+CSV_to_object does not use the default header converter options provided by Ruby's CSV module. 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
 
+If this behavior is not desired, overwrite the `header_converter` method of `CsvToObject`.
+
 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
 
 1. Fork it

data/csv_to_object.gemspec

@@ -5,7 +5,7 @@ Gem::Specification.new do |gem|
   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.summary       = %q{Given the path to a CSV file, will return a collection of objects. The csv file name must match the name of an object the gem can instantiate. The first line of the csv file must define attribute names. The following lines contain the data that will be assigned to those attributes.}
   gem.homepage      = "https://github.com/SeniorServiceAmerica/csv_to_object"
 
   gem.files         = `git ls-files`.split($\)

data/lib/csv_to_object/version.rb

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

data/lib/csv_to_object.rb

@@ -14,7 +14,7 @@ module CsvToObject
     # 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. 
+    #   attribute names are strings.
     def to_objects
       objects = []
       file = File.open(@input_path)

data/spec/csv_to_object_spec.rb

@@ -1,8 +1,14 @@
 require 'spec_helper'
-require_relative '../test/lib/person.rb'
 
-describe CsvToObject do
+class Person
+  attr_reader :id, :first_name, :last_name
+
+  def initialize(args={})
+    @id,@first_name, @last_name = args["id"], args["first_name"],args["last_name"]
+  end
+end
 
+describe CsvToObject do
   before(:each) do
     @test_csv_path = 'test/csv/person.csv'
     @source_file = File.open(@test_csv_path)
@@ -27,8 +33,8 @@ describe CsvToObject do
   
   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),{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)
+    expected_paramaters.each do |object_attributes|
+      @c2o.should_receive(:new_object).with(object_attributes.to_hash)
     end
     @c2o.to_objects
   end
@@ -50,5 +56,4 @@ describe CsvToObject do
     @c2o.should_receive(:new_object).with(include_key('score_[person_id|date]')).exactly(@number_of_data_lines).times
     @c2o.to_objects
   end
-  
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: csv_to_object
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-31 00:00:00.000000000Z
+date: 2012-09-05 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2164666320 !ruby/object:Gem::Requirement
+  requirement: &2156341180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,7 +22,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2164666320
+  version_requirements: *2156341180
 description: Takes a CSV file and returns a a collection of objects generated by that
   CSV file.
 email:
@@ -44,7 +44,6 @@ files:
 - spec/csv_to_object_spec.rb
 - spec/spec_helper.rb
 - test/csv/person.csv
-- test/lib/person.rb
 homepage: https://github.com/SeniorServiceAmerica/csv_to_object
 licenses: []
 post_install_message: 
@@ -68,10 +67,11 @@ rubyforge_project:
 rubygems_version: 1.8.16
 signing_key: 
 specification_version: 3
-summary: Takes a CSV file and returns a a collection of objects generated by that
-  CSV file.
+summary: Given the path to a CSV file, will return a collection of objects. The csv
+  file name must match the name of an object the gem can instantiate. The first line
+  of the csv file must define attribute names. The following lines contain the data
+  that will be assigned to those attributes.
 test_files:
 - spec/csv_to_object_spec.rb
 - spec/spec_helper.rb
 - test/csv/person.csv
-- test/lib/person.rb

data/test/lib/person.rb

@@ -1,9 +0,0 @@
-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"]
-  end
-end