csv_madness 0.0.4 → 0.0.6

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZGQ4MTA4MGJlYjA1MzIwOTU4NzEyODViMmFhYmYwMTA2YjQzMmY2MQ==
+  data.tar.gz: !binary |-
+    ZTRkOWNjMjYyNTNmMjA3YzMwZThlMzAyOWRjMTM0ZWYwMTQ3NWE0MA==
+SHA512:
+  metadata.gz: !binary |-
+    MzAzNTJmNjU5YmM2NjUxODY4YjRkMDkwMDc5NTQxOWIxZWRjMjRmYmU1YzFh
+    Zjg2ZjA5ZGZlZTEyNjg1NjFmNzE5NzY3NTFhNzY3ZTIyNDFhZGIzZTEzOGI5
+    ZDUzMjZjYjJkODdiM2M1M2JiMjZiMGNlMTViNWE2Yzk1ZjU1YjI=
+  data.tar.gz: !binary |-
+    MjJlYzI1YTQxMzU4NzA0MmVlNzFkYzVmNDE3NjYyMDM5YmI3Y2JmMmQyOWZk
+    OGQ0NzFhODUyMzRjNWI3ZWRlZDQ3YmQ0NGU0Zjc4ZDFmNWRkMWY4MDc4OTdi
+    YjkwY2U1MGY3MmVhNTY2NTYzYzc1ZDViZWViMTg0OTE5OGU1ZTE=

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,15 @@ 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 "fun_with_files", "~> 0.0", ">= 0.0.7"
+# gem "fun_with_version_strings", "~> 0.0"
+gem 'fun_with_gems', '~> 0.0', ">= 0.0.2"

data/README.rdoc

@@ -66,89 +66,122 @@ It's useful to clean up your files.  Say you have:
 
 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
-
-sheet.records.map(&:id)    #  => [1, 2, 3, 4] 
-
-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"] 
-
-# 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
-
-sheet.write_to_file( "~/data/people.clean.csv", force_quotes: true ) # save the cleaned data for the next stage of your process
-"""
+      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 )
 
 You could do something similar to clean and standardize phone numbers, detect and delete/complete invalid emails, etc.
 
 
 === Adding, removing, and renaming columns ===
 
-# 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
+    # 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
+
+    puts sheet[0].expected_death_date     # should be in 2058
 
-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 )
 
-# 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 )
 
-# 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 )
 
 === Using columns ===
 
-sheet.set_column_type( :id, :integer )
 
 
-# Returns each record's id, as an array
-sheet.column( :id ).max      #  ==> 4
+    sheet.set_column_type( :id, :integer )
+
+
+    # Returns each record's id as an array of integers
+    sheet.column( :id ).max      #  ==> 4
+
+
+=== Builder ===
 
+You have an array of objects.  You want to write them to a spreadsheet.
 
+```ruby
+    sb = CsvMadness::Builder.new do |sb|
+      sb.column( :id )
+      sb.column( :addressee,              "addressee_custom" )
+      sb.column( :street_address,         "primary_address.street_address" )
+      sb.column( :supplemental_address_1, "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( :leader,                 "congregation_fieldset.congregation_leader" )
+      sb.column( :denomination,           "congregation_fieldset.denomination" )
+      sb.column( :email,                  "emails.first.email" )
+    end
 
+    sheet = sb.build( [address1, address2, address3...] )
+```
 
+=== Documentation is incomplete ===
 
 There are lots of other features, but they'll take time to test and document.
 

data/Rakefile

@@ -20,24 +20,16 @@ Jeweler::Tasks.new do |gem|
   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.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 = [ "./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" ]
+  gem.files = Dir.glob( File.join( ".", "lib", "**", "*.rb" ) ) + 
+              Dir.glob( File.join( ".", "test", "**", "*" ) ) +
+              %w( Gemfile Rakefile LICENSE.txt README.rdoc VERSION CHANGELOG.markdown )
+    
 end
 
 Jeweler::RubygemsDotOrgTasks.new

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.0.6

data/lib/csv_madness.rb

@@ -1,17 +1,8 @@
 require 'csv'
-require 'fun_with_files'
+require 'fun_with_gems'
+# require 'fun_with_version_strings'
 require 'time'        # to use Time.parse to parse cells to get the date
-require 'debugger'
 
-require_relative 'csv_madness/data_accessor_module'
-require_relative 'csv_madness/sheet'
-require_relative 'csv_madness/record'
+lib_dir = __FILE__.fwf_filepath.dirname
+FunWith::Gems.make_gem_fun( "CsvMadness", :require => lib_dir.join( "csv_madness" ) )
 
-
-FunWith::Files::RootPath.rootify( CsvMadness, __FILE__.fwf_filepath.dirname.up )
-
-CsvMadness.class_eval do
-  def self.load( csv, opts = {} )
-    CsvMadness::Sheet.from( csv, opts )
-  end
-end

data/lib/csv_madness/builder.rb

@@ -0,0 +1,97 @@
+module CsvMadness
+  class Builder
+    def initialize( &block )
+      @columns = {}
+      @column_syms = []
+      @module = Module.new   # for extending
+      self.extend( @module )
+      yield self
+    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

data/lib/csv_madness/gem_api.rb

@@ -0,0 +1,12 @@
+module CsvMadness
+  module GemAPI
+    def load( csv, opts = {} )
+      CsvMadness::Sheet.from( csv, opts )
+    end
+    
+    def build( objects, &block )
+      builder = CsvMadness::Builder.new(&block)
+      builder.build( objects )
+    end
+  end
+end

data/lib/csv_madness/record.rb

@@ -8,8 +8,9 @@ module CsvMadness
   # symbol.
   class Record
     attr_accessor :csv_data
+    
     def initialize( data )
-      @csv_data = data
+      import_record_data( data )
     end
     
     def [] key
@@ -34,6 +35,10 @@ module CsvMadness
       self.class.spreadsheet.columns
     end
     
+    def self.columns
+      self.spreadsheet.columns
+    end
+    
     def self.spreadsheet= sheet
       @spreadsheet = sheet
     end
@@ -46,8 +51,40 @@ module CsvMadness
       self.columns.map{|col| self.send(col) }.to_csv( opts )
     end
     
+    def to_hash
+      self.columns.inject({}){ |hash, col| hash[col] = self.send( col ); hash }
+    end
+    
+    def to_a
+      self.to_hash.to_a
+    end
+    
     def blank?( col )
       (self.send( col.to_sym ).to_s || "").strip.length == 0
     end
+    
+    protected
+    def import_record_data( data )
+      case data
+      when Array
+        csv_data = CSV::Row.new( self.columns, data )
+      when Hash
+        fields = self.columns.map do |col|
+          data[col]
+        end
+        # for col in self.columns
+        #   fields << data[col]
+        # end
+        
+        csv_data = CSV::Row.new( self.columns, fields )
+      when CSV::Row
+        csv_data = data
+      else
+        raise "record.import_record_data() doesn't take objects of type #{data.inspect}" unless data.respond_to?(:csv_data)
+        csv_data = data.csv_data.clone
+      end
+      
+      @csv_data = csv_data
+    end
   end
 end