csv_madness 0.0.4 → 0.0.9

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4f4f9b06af750b458f7eb43b10053dfce2b60a69cc55ea4410d4466c72680f0c
+  data.tar.gz: 23ddbf472f0b52973769e21eb72939622bee0e5b13e43e8c292ae28203106145
+SHA512:
+  metadata.gz: 1e44f1666c4118cf68a16f254ea5ad8808f9a0036b346755d187c74baf24a65cff718323d81741cd5478b036fcea3518daa3b2b5f72f6de2bf89b3b435392de8
+  data.tar.gz: b44d0fa470ec59317f5a93b0e73d1ec6a032f300083734e2b0aef27b2077b51303dce1b504e77102e6cfb5f79cc2c229d136d4a5d7eca049402bb88e740e711a

data/CHANGELOG.markdown

@@ -1,17 +1,35 @@
+Changelog
+=========
+
+0.0.6
+-----
+
+* CsvMadness::Builder added (easily generate spreadsheets from an array of objects)
+
+
+0.0.5
+-----
+
+* Splitting spreadsheets, creating blank copies of spreadsheets, adding/removing records.
+* Convert records to hashes/arrays.
+* Created a dependency on `fun_with_testing`.
+* CsvMadness.version
+
+
 0.0.4
-=====
+-----
 
 * Fixed serious bug for default column names.  record.middle_name instead of record.middlename
 * Spreadsheet can be re-read from file by calling @sheet.reload_spreadsheet(opts)
 
 
 0.0.3
-=====
+-----
 
 * Feature:  can add and drop columns from spreadsheets
 
 
 0.0.2
-=====
+-----
 
 * Aw, hell.  I don't remember.

data/Gemfile

@@ -6,12 +6,14 @@ source "http://rubygems.org"
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 
-gem "fun_with_files"
-
 group :development do
-  gem "shoulda", ">= 0"
-  gem "rdoc", "~> 3.12"
-  gem "bundler", "~> 1.3.0"
-  gem "jeweler", "~> 1.8.4"
-  gem "debugger"
+  # gem "shoulda", ">= 3.5"
+  # gem "rdoc", "~> 3.12"
+  # gem "bundler", "~> 1.5"
+  # gem "jeweler", "~> 2"
+  gem "fun_with_testing"
+  # gem "debugger"
 end
+
+gem "csv"
+gem 'fun_with_gems', '~> 0.0', ">= 0.0.7"

data/README.rdoc

@@ -7,150 +7,191 @@ CSV Madness tries to remove what little pain is left from Ruby's CSV class.  Loa
 
 == Why should I use it?
 
-I like brief code and I cannot lie.  
+I like brief code and I cannot lie.
 
 
 == Examples
 
 CsvMadness makes some assumptions about your CSV file.  It does assume headers, for example.  
 
-The simplest case is when your columns are nicely named.  For example, if you have a csv file named <tt>~/data/people.csv</tt>:
+The simplest case is when your columns are nicely named.  For example, if you have a csv file named `~/data/people.csv`:
+
+    "id","fname","lname","age","born"
+    "1","Mary","Moore","27","1986-04-08 15:06:10"
+    "2","Bill","Paxton","39","1974-02-22"
+    "3","Charles","Darwin","72",""
+    "4","Chuck","Norris","57","1901-03-02"
 
-<code>
-"id","fname","lname","age","born"
-"1","Mary","Moore","27","1986-04-08 15:06:10"
-"2","Bill","Paxton","39","1974-02-22"
-"3","Charles","Darwin","72",""
-"4","Chuck","Norris","57","1901-03-02"
-</code>
 
 ... then you can write code like so:
 
-'''require 'csv_madness'
-sheet = CsvMadness.load( "~/data/people.csv" )
-sheet.columns   # => [:id, :fname, :lname, :age, :born]
-sheet.records.map(&:id) # => ["1", "2", "3", "4"]
-sheet.set_column_type(:id, :float)
-sheet.records.map(&:id) # => [1.0, 2.0, 3.0, 4.0]
-sheet.alter_column(:id) do |id|
-  id + rand() - 0.5
-end    
+    require 'csv_madness'
+    
+    sheet = CsvMadness.load( "~/data/people.csv" )
+    sheet.columns   # => [:id, :fname, :lname, :age, :born]
+    sheet.records.map(&:id) # => ["1", "2", "3", "4"]
+    sheet.set_column_type(:id, :float)
+    sheet.records.map(&:id) # => [1.0, 2.0, 3.0, 4.0]
+    sheet.alter_column(:id) do |id|
+      id + rand() - 0.5
+    end    
+
+    sheet.records.map(&:id) # => [0.7186, 2.30134, 2.90132, 4.30124]  (your results may vary)
+    mary = sheet[0]
 
-sheet.records.map(&:id) # => [0.7186, 2.30134, 2.90132, 4.30124]  (your results may vary)
-mary = sheet[0]
+    "#{mary.lname}, #{mary.fname} (#{mary.id})"  # => "Moore, Mary (1)"
 
-"#{mary.lname}, #{mary.fname} (#{mary.id})"  # => "Moore, Mary (1)"
-'''
 
 If you're not satisfied with your column names, you can send your own, in the column order.  An index can also be provided, which will allow you to use <tt>.fetch()</tt> to find specific records quickly:
 
-'''require 'csv_madness'
-sheet = CsvMadness.load( "~/data/people.csv", 
-                         columns: [:uid, :first_name, :last_name, :years_on_planet, :birthday],
-                         index: :uid )
+    require 'csv_madness'
+    sheet = CsvMadness.load( "~/data/people.csv", 
+                             columns: [:uid, :first_name, :last_name, :years_on_planet, :birthday],
+                             index: :uid )
+
+    sheet.fetch("2").years_on_planet      # => "39"
 
-sheet.fetch("2").years_on_planet      # => "39"
-'''
 
 **Note:** you can provide multiple indexes as an array.  However many columns you index, you'll run into trouble if the index isn't unique for each record.  (that may change in the future)
 
 
 It's useful to clean up your files.  Say you have:
 
-""""id","fname","lname","age","  born  "
-"1 ","Mary  ","Moore","27","1986-04-08 15:06:10"
-"","  Bill ","Paxton",,"  Feb. 22, 1974  "
-,"Charles "," Darwin","72 ",
-"4","Chuck","Norris",,"  2 March 1901   "
-"""
+    "id","fname","lname","age","  born  "
+    "1 ","Mary  ","Moore","27","1986-04-08 15:06:10"
+    "","  Bill ","Paxton",,"  Feb. 22, 1974  "
+    "3","Charles "," Darwin","72 "
+    "4","Chuck","Norris",,"  2 March 1901   "
+
 
 Ick.  Missing IDs, inconsistent date formats, leading and trailing whitespace...  We can fix this.
 
-"""require 'csv_madness'
-sheet = CsvMadness.load( "~/data/people.csv" )
-sheet.alter_cells do |cell, record|
-  (cell || "").strip
-end   # removes leading and trailing whitespace, and turns nils into ""
-
-sheet.set_column_type(:id, :integer, nil)  # the last argument provides a default for blank records.
-
-# assumes the missing ids can be filled in sequentially.
-# While .alter_column() does take a blank as a second argument, 
-# that's not what we want here.  If a blank is provided, your 
-# code will never see the records with blank entries.
-sheet.alter_column(:id) do |id, record|
-  @count ||= 1
-  if id.nil?
-    id = @count
-    @count += 1
-  else
-    @count = id + 1
-  end
+    require 'csv_madness'
+    
+    sheet = CsvMadness.load( "~/data/people.csv" )
+    
+    # remove leading and trailing whitespace, and turns nils into ""
+    sheet.alter_cells do |cell, record|
+      (cell || "").strip
+    end
+
+    # the last argument provides a default for blank records.
+    sheet.set_column_type(:id, :integer, nil)
+
+    # assumes the missing ids can be filled in sequentially.
+    # While .alter_column() does take a default (second argument),
+    # which will fill in the blank cells, 
+    # that's not what we want here.  
+    # 
+    # If a blank is provided, your 
+    # code will never see the records with blank entries.
+    sheet.alter_column(:id) do |id, record|
+      @count ||= 1
+      if id.nil?
+        id = @count
+        @count += 1
+      else
+        @count = id + 1
+      end
   
-  id
-end
+      id
+    end
+
+    sheet.column(:id)    #  => [1, 2, 3, 4]
+
+    # Reformat a column of dates.
+    require 'time'
+    sheet.alter_column(:born) do |date_string|
+      begin
+        Time.parse( date_string ).strftime("%Y-%m-%d")
+      rescue ArgumentError
+        ""
+      end
+    end
+
+    sheet.column(:date)    #  => ["1986-04-08", "1974-02-22", "", "1901-03-02"] 
+
+    # The same thing can be accomplished more simply by saying <tt>sheet.set_column_type(:date)</tt>. 
+    # Even better, record.date is then a Time object
+
+    # Now calculate everyone's age (ignoring and overriding the existing data)
+    sheet.alter_column(:age) do |age, record|
+      if record.blank?(:born)
+        ""
+      else
+        ((Time.now - Time.parse(record.born)) / 365.25 / 24 / 60 / 60).to_i  # not production-worthy code
+      end
+    end
+
+    # save the cleaned data for the next stage of your process
+    sheet.write_to_file( "~/data/people.clean.csv", force_quotes: true )
 
-sheet.records.map(&:id)    #  => [1, 2, 3, 4] 
+You could do something similar to clean and standardize phone numbers, detect and delete/complete invalid emails, etc.
 
-require 'time'
-sheet.alter_column(:born) do |date_string|
-  begin
-    Time.parse( date_string ).strftime("%Y-%m-%d")
-  rescue ArgumentError
-    ""
-  end
-end
 
-sheet.records.map(&:date)    #  => ["1986-04-08", "1974-02-22", "", "1901-03-02"] 
+=== Adding, removing, and renaming columns ===
 
-# The same thing can be accomplished more simply by saying <tt>sheet.set_column_type(:date)</tt>. 
-# Even better, record.date is then a Time object
 
-# Now calculate everyone's age (ignoring and overriding the existing data)
-sheet.alter_column(:age) do |age, record|
-  if record.blank?(:born)
-    ""
-  else
-    ((Time.now - Time.parse(record.born)) / 365.25 / 24 / 60 / 60).to_i  # not production-worthy code
-  end
-end
+    # Add 72 years to the date born.
+    sheet.set_column_type( :born, :date )  # replace date strings with Time objects
 
-sheet.write_to_file( "~/data/people.clean.csv", force_quotes: true ) # save the cleaned data for the next stage of your process
-"""
+    sheet.add_column( :expected_death_date ) do |date, record|
+      record.born + ( 72 * 365 * 24 * 60 * 60 )
+    end
 
-You could do something similar to clean and standardize phone numbers, detect and delete/complete invalid emails, etc.
+    puts sheet[0].expected_death_date     # should be in 2058
 
+    # But that's just morbid, so we drop the column
+    sheet.drop_column( :expected_death_date )
 
-=== Adding, removing, and renaming columns ===
+    # Or, if you think you need the information, but need to be a bit more euphemistic about it
+    sheet.rename_column( :expected_death_date, :expiration_date )
 
-# Add 72 years to the date born.
-sheet.set_column_type( :born, :date )  # replace date strings with Time objects
 
-sheet.add_column( :expected_death_date ) do |date, record|
-  record.born + ( 72 * 365 * 24 * 60 * 60 )
-end
+=== Using columns ===
 
-puts sheet[0].expected_death_date     # should be in 2058
 
-# But that's just morbid, so we drop the column
-sheet.drop_column( :expected_death_date )
 
-# Or, if you think you need the information, but need to be a bit more euphemistic about it
-sheet.rename_column( :expected_death_date, :expiration_date )
+    sheet.set_column_type( :id, :integer )
 
-=== Using columns ===
 
-sheet.set_column_type( :id, :integer )
+    # Returns each record's id as an array of integers
+    sheet.column( :id ).max      #  ==> 4
 
 
-# Returns each record's id, as an array
-sheet.column( :id ).max      #  ==> 4
+=== Builder ===
 
+You have an array of objects.  You want to write them to a spreadsheet.
 
+    sb = CsvMadness::Builder.new do |sb|
+      sb.column( :id )
+      sb.column( :addressee,      "addressee_custom" )
+      sb.column( :street,         "primary_address.street_address" )
+      sb.column( :street2,        "primary_address.supplemental_address_1" )
+      sb.column( :city,           "primary_address.city" )
+      sb.column( :state_code,     "primary_address.state_code" )
+      sb.column( :formatted_zip,  "primary_address.formatted_zip" )
+      sb.column( :phone,          "phones.first.phone" )
+      sb.column( :contact,        "congregation_fieldset.congregation_leader" )
+      sb.column( :email,          "emails.first.email" )
+      sb.column( :greeting ) do |contact|
+        if contact.business?
+          "To our friends at #{contact.organization_name},"
+        elsif contact.person?
+          "Dear #{ contact.title } #{ contact.last_name }"
+        end
+      end
+      
+    end
 
+    sheet = sb.build( [address1, address2, address3...] )
+    
+    outfile = FunWith::Files::FilePath.home.join( "Documents", "addresses", "address_records.csv" )
+    sheet.write_to_file( outfile )
 
+=== Documentation is incomplete ===
 
-There are lots of other features, but they'll take time to test and document.
+There are other features, but they'll take time to test and document.
 
 
 

data/Rakefile

@@ -1,70 +1,89 @@
 # encoding: utf-8
+require 'fun_with_gems'
+require_relative File.join( "lib", "csv_madness" )
+self.extend( FunWith::Gems::Rakefile)
 
-require 'rubygems'
-require 'bundler'
+rakefile_setup CsvMadness
 
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-
-require 'rake'
-
-require 'jeweler'
+gem_specification do |gem|
+    # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+    # dependencies defined in Gemfile
+      gem.name = "csv_madness"
+      gem.homepage = "http://github.com/darthschmoo/csv_madness"
+      gem.license = "MIT"
+      gem.summary = "CSV Madness turns your CSV rows into happycrazy objects."
+      gem.description = "CSV Madness removes what little pain is left from Ruby's CSV class.  Load a CSV file, and get back an array of objects with customizable getter/setter methods."
+      gem.email = "keeputahweird@gmail.com"
+      gem.authors = ["Bryce Anderson"]
 
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "csv_madness"
-  gem.homepage = "http://github.com/darthschmoo/csv_madness"
-  gem.license = "MIT"
-  gem.summary = %Q{CSV Madness turns your CSV rows into happycrazy objects.}
-  gem.description = %Q{CSV Madness removes what little pain is left from Ruby's CSV class.  Load a CSV file, and get back an array of objects with customizable getter/setter methods.}
-  gem.email = "keeputahweird@gmail.com"
-  gem.authors = ["Bryce Anderson"]
-  # dependencies defined in Gemfile
-  gem.files = [ "./lib/csv_madness/data_accessor_module.rb", 
-                "./lib/csv_madness/record.rb", 
-                "./lib/csv_madness/sheet.rb", 
-                "./lib/csv_madness.rb", 
-                "./Gemfile",
-                "./VERSION",
-                "./README.rdoc",
-                "./Rakefile",
-                "./CHANGELOG.markdown",
-                "./test/csv/simple.csv",
-                "./test/helper.rb",
-                "./test/test_csv_madness.rb",
-                "./test/test_sheet.rb" ]
+      # dependencies defined in Gemfile
+      gem.files = Dir.glob( File.join( ".", "lib", "**", "*.rb" ) ) +
+                  Dir.glob( File.join( ".", "test", "**", "*" ) ) +
+                  %w( Gemfile Rakefile LICENSE.txt README.rdoc VERSION CHANGELOG.markdown ) 
+                  # csv_madness.gemspec )
 end
 
-Jeweler::RubygemsDotOrgTasks.new
+setup_gem_boilerplate
 
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
-
-# require 'rcov/rcovtask'
-# Rcov::RcovTask.new do |test|
-#   test.libs << 'test'
+#
+#
+# require 'rubygems'
+# require 'bundler'
+#
+# begin
+#   Bundler.setup(:default, :development)
+# rescue Bundler::BundlerError => e
+#   $stderr.puts e.message
+#   $stderr.puts "Run `bundle install` to install missing gems"
+#   exit e.status_code
+# end
+#
+# require 'rake'
+#
+# require 'jeweler'
+#
+# Jeweler::Tasks.new do |gem|
+#   # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+#   gem.name = "csv_madness"
+#   gem.homepage = "http://github.com/darthschmoo/csv_madness"
+#   gem.license = "MIT"
+#   gem.summary = "CSV Madness turns your CSV rows into happycrazy objects."
+#   gem.description = "CSV Madness removes what little pain is left from Ruby's CSV class.  Load a CSV file, and get back an array of objects with customizable getter/setter methods."
+#   gem.email = "keeputahweird@gmail.com"
+#   gem.authors = ["Bryce Anderson"]
+#
+#   # dependencies defined in Gemfile
+#   gem.files = Dir.glob( File.join( ".", "lib", "**", "*.rb" ) ) +
+#               Dir.glob( File.join( ".", "test", "**", "*" ) ) +
+#               %w( Gemfile Rakefile LICENSE.txt README.rdoc VERSION CHANGELOG.markdown csv_madness.gemspec )
+#
+# end
+#
+# Jeweler::RubygemsDotOrgTasks.new
+#
+# require 'rake/testtask'
+# Rake::TestTask.new(:test) do |test|
+#   test.libs << 'lib' << 'test'
 #   test.pattern = 'test/**/test_*.rb'
 #   test.verbose = true
-#   test.rcov_opts << '--exclude "gems/*"'
 # end
-
-task :default => :test
-
-require 'rdoc/task'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "csv_madness #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+#
+# # require 'rcov/rcovtask'
+# # Rcov::RcovTask.new do |test|
+# #   test.libs << 'test'
+# #   test.pattern = 'test/**/test_*.rb'
+# #   test.verbose = true
+# #   test.rcov_opts << '--exclude "gems/*"'
+# # end
+#
+# task :default => :test
+#
+# require 'rdoc/task'
+# Rake::RDocTask.new do |rdoc|
+#   version = File.exist?('VERSION') ? File.read('VERSION') : ""
+#
+#   rdoc.rdoc_dir = 'rdoc'
+#   rdoc.title = "csv_madness #{version}"
+#   rdoc.rdoc_files.include('README*')
+#   rdoc.rdoc_files.include('lib/**/*.rb')
+# end

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.0.9

data/lib/csv_madness/builder.rb

@@ -0,0 +1,100 @@
+module CsvMadness
+  class Builder
+    attr_accessor :label
+    
+    def initialize( &block )
+      @columns = {}
+      @column_syms = []
+
+      @module = Module.new   # for extending
+      self.extend( @module )
+      yield self if block_given?
+    end
+
+    def column( sym, method_path = nil, &block )
+      warn( "#{sym} already defined. Overwriting." ) if @column_syms.include?( sym )
+      
+      @column_syms << sym
+      @columns[sym] = if block_given?
+                        block
+                      elsif method_path
+                        method_path
+                      else
+                        Proc.new(&sym)
+                      end
+    end
+
+    # Three :on_error values:
+    #    :print  => Put an error message in the cell instead of a value
+    #    :raise  => Raise the error, halting the process
+    #    :ignore => Hand back an empty cell
+    # 
+    # Although ideally it should be configurable by column...   
+    def build( objects, opts = { :on_error => :print } )
+      spreadsheet = CsvMadness::Sheet.new( @column_syms )
+
+      for object in objects
+        STDOUT << "."
+        record = {}
+        for sym in @column_syms
+          record[sym] = build_cell( object, sym, opts )
+        end
+
+        spreadsheet.add_record( record )  # hash form
+      end
+
+      spreadsheet
+    end
+
+    def build_cell( object, sym, opts = { :on_error => :print } )
+      column = @columns[sym]
+
+      case column
+      when String
+        build_cell_by_pathstring( object, column, opts )
+      when Proc
+        build_cell_by_proc( object, column, opts )
+      else
+        "no idea what to do"
+      end
+    end
+
+    def def( method_name, &block )
+      @module.send( :define_method, method_name, &block )
+    end
+
+    protected
+    def build_cell_by_pathstring( object, str, opts )
+      handle_cell_build_error( :build_cell_by_pathstring, opts ) do
+        for method in str.split(".").map(&:to_sym)
+          object = object.send(method)
+        end
+
+        object
+      end
+    end
+
+    def build_cell_by_proc( object, proc, opts )
+      handle_cell_build_error( :build_cell_by_proc, opts ) do
+        proc.call(object)
+      end
+    end
+    
+    def handle_cell_build_error( caller, opts, &block )
+      begin
+        yield
+      end
+    rescue Exception => e
+      case opts[:on_error]
+      when nil, :print
+        puts "error #{e.message} #{caller}" if opts[:verbose]
+        "ERROR: #{e.message} (#{caller}())"
+      when :raise
+        puts "Re-raisinge error #{e.message}.  Set opts[:on_error] to :print or :ignore if you want Builder to continue on errors."
+        raise e
+      when :ignore
+        ""
+      end
+    end
+  end
+end