csv_to_object 0.0.1 → 0.0.2

data/README.md

@@ -1,6 +1,6 @@
 # CsvToObject
 
-Given 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
 
@@ -24,7 +24,7 @@ Given a file person.csv with the contents
   `0,Lindsey,Austino`  
   `1,Dodie,Egnor`
 
-  `CsvToObject::CsvToObject.new(File.open('person.csv')).to_objects` will return 
+  `CsvToObject::CsvToObject.new('[path to person.csv]').to_objects` will return 
 
   `[#<Person:0x000001021a8148 @id=0, @first_name="Lindsey", @last_name="Austino">, #<Person:0x000001021a8030 @id=1, @first_name="Dodie", @last_name="Egnor">`]
 

data/lib/csv_to_object/version.rb

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

data/lib/csv_to_object.rb

@@ -4,10 +4,16 @@ require 'CSV'
 module CsvToObject
   class CsvToObject
 
+    # Requires the path to the csv file.
     def initialize(input_path)
       @input = 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]
     def to_objects
       objects = []
       CSV.table(@input).each do |row|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: csv_to_object
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-23 00:00:00.000000000Z
+date: 2012-08-27 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2168463560 !ruby/object:Gem::Requirement
+  requirement: &2168815940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2168463560
+  version_requirements: *2168815940
 description: Takes a CSV file and returns a a collection of objects generated by that
   CSV file.
 email: