flexible_csv 0.2.1

data/CHANGELOG.rdoc

@@ -0,0 +1,12 @@
+= FlexibleCsv CHANGELOG
+ 
+== Version 0.1
+ * First try
+ * Super lame tests, but they work
+ * Minimal documentation
+ 
+== Version 0.2
+ * Significant rewrite of Parser class, removed Row class and leveraging FasterCSV's Row class
+
+== Version 0.2.1
+ * Added documentation about using Adapter classes

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2009 Chris Powers, The Killswitch Collective
+http://killswitchcollective.com
+ 
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+ 
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+ 
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,84 @@
+= FlexibleCsv
+
+<em>Chris Powers, The Killswitch Collective (http://killswitchcollective.com/blog/authors/chris_powers)</em>
+
+The FlexibleCsv gem uses the FasterCSV gem to parse user created CSV files that may not have standard headers. For example, you know there's an email address column somewhere in there, but it may be called "Email" or "Email Address" or "email-address", and it might be in the first column, but it might be in the third.
+
+== Examples
+
+These CSV data snippets have the same data but are formatted much differently. Using FlexibleCsv to map possible column names to data nodes, these differences become negligible.
+  
+  require 'flexible_csv'
+  
+  # Arbitrary CSV data
+  csv_data1 = %Q{Full Name, Email Address\nJohn Doe, john@doe.com}
+  csv_data2 = %Q{Email, Name\njohn@doe.com, John Doe}
+  
+  parser = FlexibleCsv.new do |csv|
+    csv.column :full_name, "Name", "Full Name", "Client Name"
+    csv.column :email, "Email", "Email Address"
+  end
+    
+  parser.parse(csv_data1).each do |row|
+    puts row.full_name #=> 'John Doe'
+    puts row.email     #=> 'john@doe.com'
+  end
+  
+  parser.parse(csv_data2).each do |row|
+    puts row.full_name #=> 'John Doe'
+    puts row.email     #=> 'john@doe.com'
+  end
+
+== Using Adapters
+
+What if simply mapping header names to values is not enough? What if you need more translation logic? Instead of baking in complex rule functionality into FlexibleCsv, I am strongly suggesting users use their own adapter classes to wrap up this logic.
+
+For example, let's say that some of your CSV files have a column for each contact's full name, but other have a separate column for first and last name:
+
+  require 'flexible_csv'
+
+  # Arbitrary CSV data
+  csv_data1 = %Q{Full Name\nJohn Doe}
+  csv_data2 = %Q{First Name, Last Name\nJohn,Doe}
+
+  parser = FlexibleCsv.new do |csv|
+    csv.column :full_name, "Name", "Full Name", "Client Name"
+    csv.column :first_name, "First Name", "First"
+    csv.column :last_name, "Last Name", "Last", "Surname"
+  end
+
+  class CsvAdapter
+    def initialize(row)
+      @row = row
+    end
+    
+    def full_name
+      row.full_name || "#{row.first_name} #{row.last_name}"
+    end
+    
+    def last_name
+      row.last_name || row.full_name.split(' ').last
+    end
+    
+    def first_name
+      row.first_name || row.full_name.split(' ').first
+    end
+    
+    def method_missing(method_name, *args)
+      row.send(method_name, *args)
+    end
+  end
+
+  parser.parse(csv_data1).each do |row|
+    ad_row = CsvAdapter.new(row)
+    puts ad_row.full_name  #=> 'John Doe'
+    puts ad_row.first_name #=> 'John'
+    puts ad_row.last_name  #=> 'Doe'
+  end
+
+  parser.parse(csv_data2).each do |row|
+    ad_row = CsvAdapter.new(row)
+    puts ad_row.full_name  #=> 'John Doe'
+    puts ad_row.first_name #=> 'John'
+    puts ad_row.last_name  #=> 'Doe'
+  end

data/lib/flexible_csv.rb

@@ -0,0 +1,81 @@
+class FlexibleCsv
+  require 'faster_csv'
+  require 'hacks.rb'
+  
+  # a Hash where the key is the method name, and the value is the array of possible headers
+  attr_reader :column_hash
+  
+  def initialize
+    @column_hash = {}
+    yield self
+  end
+  
+  # Developed by Chris Powers, Killswitch Collective on 02/17/2009
+  #
+  # <b>Description:</b> Parses a CSV data source, either a String or an IO object
+  #
+  # <b>Arguments:</b> CSV formatted String or IO of CSV file
+  #
+  # <b>Returns:</b> Parser object
+  #
+  # <em>Syntax: @parser = @flexible_csv.parse(File.open('path/to/file.csv'))</em>
+  def parse(data)
+    Parser.new(data, self)
+  end
+  
+  # Developed by Chris Powers, Killswitch Collective on 02/17/2009
+  #
+  # <b>Description:</b> 
+  #
+  # <b>Arguments:</b> The hash key / method name and any number of possible header labels as strings
+  #
+  # <b>Returns:</b> nil
+  #
+  # <em>Syntax: csv.column :name, "Full Name", "Name", "Client Name"</em>
+  def column(id, *args)
+    @column_hash[id] = args.map {|item| clean_up(item) }
+    nil
+  end
+  
+  # Developed by Chris Powers, Killswitch Collective on 02/17/2009
+  #
+  # <b>Description:</b> Helper method to remove whitespace, capitalization and punctuation
+  #
+  # <b>Arguments:</b> a string
+  #
+  # <b>Returns:</b> a formatted string
+  #
+  # <em>Syntax: clean_up "My Column!" #=> 'mycolumn'</em>
+  def clean_up(str)
+    str.to_s.downcase.gsub(/[^a-z0-9]/, '')
+  end
+  
+  # Wrapper class around the FasterCSV object
+  class Parser
+    
+    def initialize(data, csv_parent)
+      column_headers = []
+      
+      fcsv = FasterCSV.new(data.is_a?(String) ? data : data.read, :headers => true)
+
+      # reformat headers to remove punctuation, capitalization and white space
+      # Change header labels to the key used in the column config
+      fcsv.header_convert do |field| 
+        f = csv_parent.clean_up(field)
+        csv_parent.column_hash.each_pair do |k,v|
+          f = k.to_s and break if v.include?(f)
+        end
+        f
+      end
+      
+      @table = fcsv.read
+    end
+    
+    # proxy other methods to the @table object
+    def method_missing(method_name, *args, &block)
+      @table.send(method_name, *args, &block)
+    end
+    
+  end
+  
+end

data/lib/hacks.rb

@@ -0,0 +1,6 @@
+class FasterCSV::Row
+  # allows for hash access by virtual attributes
+  def method_missing(method_name, *args)
+    self[method_name] || self[method_name.to_s] || super
+  end
+end

data/test/flexible_csv.rspec

@@ -0,0 +1,36 @@
+require 'rubygems'
+require 'spec'
+require 'activesupport'
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'flexible_csv.rb')
+
+describe FlexibleCsv do
+  
+  before :each do
+    @csv_data1 = %Q{Full Name, Email Address\nJohn Doe, john@doe.com\nJane Doe, jane@doe.com}
+    @csv_data2 = %Q{First Name, Last Name, Email\nJohn, Doe, john@doe.com\nJane, Doe, jane@doe.com}
+    
+    @parser = FlexibleCsv.new do |csv|
+      csv.column :full_name, "Name", "Full Name", "Client Name"
+      csv.column :first_name, "First Name", "First"
+      csv.column :last_name, "Last Name", "Last"
+      csv.column :email, "Email", "Email Address"
+    end
+  end
+  
+  it "should work with example 1" do
+    @parser.parse(@csv_data1).each do |row|
+      row["full_name"].should_not be_blank
+      row["email"].should_not be_blank
+    end
+  end
+  
+  it "should work with example 2" do
+    @parser.parse(@csv_data2).each do |row|
+      row.first_name.should_not be_blank
+      row.last_name.should_not be_blank
+      row.email.should_not be_blank
+    end
+  end
+  
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: flexible_csv
+version: !ruby/object:Gem::Version 
+  version: 0.2.1
+platform: ruby
+authors: 
+- Chris Powers
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-17 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: fastercsv
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.3
+    version: 
+description: 
+email: chris@killswitchcollective.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.rdoc
+- CHANGELOG.rdoc
+- LICENSE
+- lib/flexible_csv.rb
+- lib/hacks.rb
+- test/flexible_csv.rspec
+has_rdoc: true
+homepage: http://killswitchcollective.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: The FlexibleCsv gem uses the FasterCSV gem to parse user created CSV files that may not have standard headers.
+test_files: []
+