csv-mapper 0.0.3 → 0.0.4

data/History.txt

@@ -1,3 +1,8 @@
+== 0.0.4 2009-08-05
+* Merged contributions from Jeffrey Chupp - http://semanticart.com
+  * Added support for "Automagical Attribute Discovery"
+  * Added Ruby 1.9 compatibility
+
 == 0.0.3 2008-12-22
 * Fixed specs to work with RSpec 1.1.9 and later where Modules aren't auto included
 

data/README.rdoc

@@ -1,10 +1,8 @@
 = README
 
-by Luke Pillow
-
 == DESCRIPTION:
 
-CsvMapper is a small library intended to simplify the common steps involved with importing CSV files to a usable form in Ruby.
+CsvMapper is a small library intended to simplify the common steps involved with importing CSV files to a usable form in Ruby.  CsvMapper is compatible with recent 1.8 versions of Ruby as well as Ruby 1.9+
 
 == EXAMPLES:
 
@@ -30,6 +28,17 @@ The following example will import a CSV file to an Array of OpenStruct[http://ru
   results.first.last_name   # Doe
   results.first.age         # 27
 
+==== Automagical Attribute Discovery Example
+  include CsvMapper
+
+  results = import('/path/to/file.csv') do
+    read_attributes_from_file
+  end
+
+  results.first.first_name  # John
+  results.first.last_name   # Doe
+  results.first.age         # 27
+
 ==== 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.
 
@@ -50,7 +59,7 @@ See CsvMapper for a more detailed description
 	
 == REQUIREMENTS:
 
-FasterCSV[http://fastercsv.rubyforge.org/]
+FasterCSV[http://fastercsv.rubyforge.org/] on pre 1.9 versions of Ruby
 
 == INSTALL:
 

data/lib/csv-mapper.rb

@@ -2,7 +2,21 @@ $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
 require 'ostruct'
-require 'fastercsv'
+
+# the following is slightly modified from Gregory Brown's
+# solution on the Ruport Blaag:
+# http://ruport.blogspot.com/2008/03/fastercsv-api-shim-for-19.html
+if RUBY_VERSION > "1.9"
+ require "csv"
+ unless defined? FCSV
+   class Object
+     FasterCSV = CSV
+     alias_method :FasterCSV, :CSV
+   end
+ end
+else
+ require "fastercsv"
+end
 
 # This module provides the main interface for importing CSV files & data to mapped Ruby objects.
 # = Usage
@@ -67,7 +81,7 @@ require 'fastercsv'
 #   other_results = import('/path/to/file.csv', :map => a_row_map)
 #
 module CsvMapper
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 
   # Create a new RowMap instance from the definition in the given block.
   def map_csv(&map_block)
@@ -82,10 +96,11 @@ module CsvMapper
   # <tt>:map</tt>:: Specify an instance of a RowMap to take presidence over a given block defintion.
   #
   def import(data, options={}, &map_block)
+    csv_data = options[:type] == :io ? data : File.new(data, 'r')
+
     config = { :type => :file_path,
-               :map => map_csv(&map_block) }.merge!(options)
-    
-    csv_data = config[:type] == :io ? data : File.new(data, 'r')
+               :map => map_csv_with_data(csv_data, &map_block) }.merge!(options)
+
     map = config[:map]
     
     results = []
@@ -107,8 +122,9 @@ module CsvMapper
     attr_reader :mapped_attributes
     
     # Create a new instance with access to an evaluation context 
-    def initialize(context, &map_block)
+    def initialize(context, csv_data = nil, &map_block)
       @context = context
+      @csv_data = csv_data
       @before_filters = []
       @after_filters = []
       @parser_options = {}
@@ -133,6 +149,26 @@ module CsvMapper
       end
     end
     
+    # Allow us to read the first line of a csv file to automatically generate the attribute names.
+    # Spaces are replaced with underscores and non-word characters are removed.
+    #
+    # Keep in mind that there is potential for overlap in using this (i.e. you have a field named
+    # files+ and one named files- and they both get named 'files').
+    #
+    # You can specify aliases to rename fields to prevent conflicts and/or improve readability and compatibility.
+    #
+    # i.e. read_attributes_from_file('files+' => 'files_plus', 'files-' => 'files_minus)
+    def read_attributes_from_file aliases = {}
+      attributes = FasterCSV.new(@csv_data, @parser_options).readline
+      @start_at_row = [ @start_at_row, 1 ].max
+      @csv_data.rewind
+      attributes.each_with_index do |name, index|
+        name.strip!
+        use_name = aliases[name] || name.gsub(/\s+/, '_').gsub(/[\W]+/, '').downcase
+        add_attribute use_name, index
+      end
+    end
+
     # Specify a hash of FasterCSV options to be used for CSV parsing
     #
     # Can be anything FasterCSV::new()[http://fastercsv.rubyforge.org/classes/FasterCSV.html#M000018] accepts
@@ -299,4 +335,10 @@ module CsvMapper
     end
     
   end
+
+  protected
+  # Create a new RowMap instance from the definition in the given block and pass the csv_data.
+  def map_csv_with_data(csv_data, &map_block) # :nodoc:
+    CsvMapper::RowMap.new(self, csv_data, &map_block)
+  end
 end

data/spec/csv-mapper_spec.rb

@@ -49,7 +49,17 @@ describe CsvMapper do
 
     results.size.should == 2
   end
-  
+
+  it "should be able to read attributes from a csv file" do
+    results = import(File.dirname(__FILE__) + '/test.csv') do
+      # we'll alias age here just as an example
+      read_attributes_from_file('Age' => 'number_of_years_old')
+    end
+    results[1].first_name.should == 'Jane'
+    results[1].last_name.should == 'Doe'
+    results[1].number_of_years_old.should == '26'
+  end
+
   it "should import non-comma delimited files" do
     piped_io = 'foo|bar|00|01'
     

data/website/index.html

@@ -35,7 +35,7 @@
     <div class="sidebar">
       <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/csv-mapper"; return false'>
         <p>Get Version</p>
-        <a href="http://rubyforge.org/projects/csv-mapper" class="numbers">0.0.1</a>
+        <a href="http://rubyforge.org/projects/csv-mapper" class="numbers">0.0.4</a>
       </div>
     </div>
     <h2>What</h2>
@@ -66,6 +66,18 @@ Bat,Man,52
   <span class="punct">[</span><span class="ident">first_name</span><span class="punct">,</span> <span class="ident">last_name</span><span class="punct">,</span> <span class="ident">age</span><span class="punct">]</span>
 <span class="keyword">end</span>
 
+<span class="ident">results</span><span class="punct">.</span><span class="ident">first</span><span class="punct">.</span><span class="ident">first_name</span>  <span class="comment"># John</span>
+<span class="ident">results</span><span class="punct">.</span><span class="ident">first</span><span class="punct">.</span><span class="ident">last_name</span>   <span class="comment"># Doe</span>
+<span class="ident">results</span><span class="punct">.</span><span class="ident">first</span><span class="punct">.</span><span class="ident">age</span>         <span class="comment"># 27</span>
+</pre></p>
+<h3>Automagical Attribute Discovery Example</h3>
+<p><pre class='syntax'>
+<span class="ident">include</span> <span class="constant">CsvMapper</span>
+
+<span class="ident">results</span> <span class="punct">=</span> <span class="ident">import</span><span class="punct">('</span><span class="string">/path/to/file.csv</span><span class="punct">')</span> <span class="keyword">do</span>
+  <span class="ident">read_attributes_from_file</span>
+<span class="keyword">end</span>
+
 <span class="ident">results</span><span class="punct">.</span><span class="ident">first</span><span class="punct">.</span><span class="ident">first_name</span>  <span class="comment"># John</span>
 <span class="ident">results</span><span class="punct">.</span><span class="ident">first</span><span class="punct">.</span><span class="ident">last_name</span>   <span class="comment"># Doe</span>
 <span class="ident">results</span><span class="punct">.</span><span class="ident">first</span><span class="punct">.</span><span class="ident">age</span>         <span class="comment"># 27</span>
@@ -106,7 +118,7 @@ rake install_gem</pre>
 <h2>Contact</h2>
 <p>Comments are welcome. Send an email to <a href="mailto:lpillow@gmail.com">Luke Pillow</a> email via the <a href="http://groups.google.com/group/csv-mapper">forum</a></p>
     <p class="coda">
-      <a href="http://www.pillowfactory.org">Luke Pillow</a>, 5th December 2008<br>
+      <a href="http://www.pillowfactory.org">Luke Pillow</a>, 5th August 2009<br>
       Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
     </p>
 </div>

data/website/index.txt

@@ -45,6 +45,20 @@ results.first.last_name   # Doe
 results.first.age         # 27
 </pre>
 
+h3. Automagical Attribute Discovery Example
+
+<pre syntax="ruby">
+include CsvMapper
+
+results = import('/path/to/file.csv') do
+  read_attributes_from_file
+end
+
+results.first.first_name  # John
+results.first.last_name   # Doe
+results.first.age         # 27
+</pre>
+
 h3. Import to ActiveRecord Example
 
 Although CSV Mapper has no dependency on ActiveRecord; it‘s easy to import a CSV file to ActiveRecord models and save them.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: csv-mapper
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - Luke Pillow
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-22 00:00:00 -06:00
+date: 2009-08-05 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -30,7 +30,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.2.1
+        version: 1.2.3
     version: 
 - !ruby/object:Gem::Dependency 
   name: hoe
@@ -42,7 +42,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.8.0
     version: 
-description: CsvMapper is a small library intended to simplify the common steps involved with importing CSV files to a usable form in Ruby.
+description: CsvMapper is a small library intended to simplify the common steps involved with importing CSV files to a usable form in Ruby.  CsvMapper is compatible with recent 1.8 versions of Ruby as well as Ruby 1.9+
 email: 
 - lpillow@gmail.com
 executables: []
@@ -82,7 +82,9 @@ files:
 - website/stylesheets/screen.css
 - website/template.html.erb
 has_rdoc: true
-homepage: by Luke Pillow
+homepage: 
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --main
@@ -104,10 +106,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: csv-mapper
-rubygems_version: 1.3.1
+rubygems_version: 1.3.4
 signing_key: 
-specification_version: 2
-summary: CsvMapper is a small library intended to simplify the common steps involved with importing CSV files to a usable form in Ruby.
+specification_version: 3
+summary: CsvMapper is a small library intended to simplify the common steps involved with importing CSV files to a usable form in Ruby
 test_files: 
 - test/test_csv-mapper.rb
 - test/test_helper.rb