csv_madness 0.0.6 → 0.0.9

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZGQ4MTA4MGJlYjA1MzIwOTU4NzEyODViMmFhYmYwMTA2YjQzMmY2MQ==
-  data.tar.gz: !binary |-
-    ZTRkOWNjMjYyNTNmMjA3YzMwZThlMzAyOWRjMTM0ZWYwMTQ3NWE0MA==
+SHA256:
+  metadata.gz: 4f4f9b06af750b458f7eb43b10053dfce2b60a69cc55ea4410d4466c72680f0c
+  data.tar.gz: 23ddbf472f0b52973769e21eb72939622bee0e5b13e43e8c292ae28203106145
 SHA512:
-  metadata.gz: !binary |-
-    MzAzNTJmNjU5YmM2NjUxODY4YjRkMDkwMDc5NTQxOWIxZWRjMjRmYmU1YzFh
-    Zjg2ZjA5ZGZlZTEyNjg1NjFmNzE5NzY3NTFhNzY3ZTIyNDFhZGIzZTEzOGI5
-    ZDUzMjZjYjJkODdiM2M1M2JiMjZiMGNlMTViNWE2Yzk1ZjU1YjI=
-  data.tar.gz: !binary |-
-    MjJlYzI1YTQxMzU4NzA0MmVlNzFkYzVmNDE3NjYyMDM5YmI3Y2JmMmQyOWZk
-    OGQ0NzFhODUyMzRjNWI3ZWRlZDQ3YmQ0NGU0Zjc4ZDFmNWRkMWY4MDc4OTdi
-    YjkwY2U1MGY3MmVhNTY2NTYzYzc1ZDViZWViMTg0OTE5OGU1ZTE=
+  metadata.gz: 1e44f1666c4118cf68a16f254ea5ad8808f9a0036b346755d187c74baf24a65cff718323d81741cd5478b036fcea3518daa3b2b5f72f6de2bf89b3b435392de8
+  data.tar.gz: b44d0fa470ec59317f5a93b0e73d1ec6a032f300083734e2b0aef27b2077b51303dce1b504e77102e6cfb5f79cc2c229d136d4a5d7eca049402bb88e740e711a

data/Gemfile

@@ -15,6 +15,5 @@ group :development do
   # 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"
+gem "csv"
+gem 'fun_with_gems', '~> 0.0', ">= 0.0.7"

data/README.rdoc

@@ -7,62 +7,62 @@ 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.
 
@@ -163,27 +163,35 @@ You could do something similar to clean and standardize phone numbers, detect an
 
 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" )
+      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,62 +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 = "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 )
-    
+      # 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.6
+0.0.9

data/lib/csv_madness/builder.rb

@@ -1,11 +1,14 @@
 module CsvMadness
   class Builder
+    attr_accessor :label
+    
     def initialize( &block )
       @columns = {}
       @column_syms = []
+
       @module = Module.new   # for extending
       self.extend( @module )
-      yield self
+      yield self if block_given?
     end
 
     def column( sym, method_path = nil, &block )

data/lib/csv_madness/data_accessor_module.rb

@@ -1,44 +1,79 @@
+# Each record within the spreadsheet is extended by a module with accessor functions
+# which allow the user to treat column names as methods.  When columns are added, dropped, or re-ordered,
+# the accessor module needs to be updated to reflect the change.
 class DataAccessorModule < Module
+  # mapping : keys = column symbol
+  #           values = column index
+  attr_accessor :column_accessors_map
+  
   def initialize( mapping )
-    @column_accessors = []
-    remap_accessors( mapping )
+    puts "Got mapping #{mapping.inspect}"
+    @column_accessors_map = mapping
+    remap_accessors
   end
   
-  def install_column_accessors( column, index )
-    @column_accessors << column
-    eval <<-EOF
-      self.send( :define_method, :#{column} ) do
-        self.csv_data[#{index}]
+  def install_column_accessors( *columns )
+    for column in columns.flatten
+      unless is_valid_ruby_method?( column )
+        warn( "#{column.inspect} is not a valid ruby method" )
+        require "data_accessor_module"    # TODO:  WTF?
+        column = "csv_column_#{index}"
+        warn( "   ----> renaming to #{column.inspect}" )
       end
+    
+      if self.respond_to?( column )
+        puts "Column already has accessors"
+      else
+        eval <<-EOF
+            self.send( :define_method, :#{column} ) do
+              self.csv_data[ self.column_accessors_map[ :#{column} ] ]
+            end
       
-      self.send( :define_method, :#{column}= ) do |val|
-        self.csv_data[#{index}] = val
+            self.send( :define_method, :#{column}= ) do |val|
+              self.csv_data[ self.column_accessors_map[ :#{column} ] ] = val
+            end
+        EOF
       end
-    EOF
+    end
   end
   
-  def remove_column_accessors( column )
-    self.send( :remove_method, column )
-    self.send( :remove_method, :"#{column}=" )
+  # But if instead of hardcoding the index, the index was pulled from the spreadsheet mapping...
+  # a titch slower to look up?  But a change to the mapping automatically updates the method
+  def remove_column_accessors( *columns )
+    for column in columns.flatten
+      for method_sym in [column, :"#{column}="]
+        self.send( :remove_method, method_sym ) if self.respond_to?( method_sym )
+      end
+    end
   end
   
   def remove_all_column_accessors
-    @column_accessors ||= []    
+    # 2016-11-24 : was this necessary for anything
+    # @column_accessors ||= []
+    remove_column_accessors( @column_accessors_map.keys )
+  end
+  
+  # Partly obsoleted.  
+  def remap_accessors( *args )
+    # 
     
-    for sym in @column_accessors
-      remove_column_accessors( sym )
+    
+    remove_all_column_accessors
+    
+    if args.length == 1
+      debugger
+      @column_accessors_map = args.first
     end
     
-    @column_accessors = []    
+    install_column_accessors( @column_accessors_map.keys )
   end
   
-  def remap_accessors( mapping )
-    remove_all_column_accessors
-    
-    @mapping = mapping
+  # Symbol.inspect doesn't output " quotes when given a sym 
+  # that expresses a valid method name or a valid identifier.
+  def is_valid_ruby_method?( str_or_sym )
+    sym = str_or_sym.to_sym
+    test_string = sym.inspect
     
-    for column, index in @mapping
-      install_column_accessors( column, index )
-    end
+    test_string.match( /^:[@"]/ ).nil?   
   end
 end

data/lib/csv_madness/exceptions.rb

@@ -0,0 +1,16 @@
+module CsvMadness
+  class LoadError < RuntimeError
+  end
+  
+  class ColumnError < ArgumentError
+  end
+  
+  class ForbiddenColumnNameError < ColumnError
+  end
+  
+  class MissingColumnError < ColumnError
+  end
+  
+  class ColumnExistsError < ColumnError
+  end
+end

data/lib/csv_madness/record.rb

@@ -8,8 +8,10 @@ module CsvMadness
   # symbol.
   class Record
     attr_accessor :csv_data
+    attr_reader   :column_accessors_map
     
-    def initialize( data )
+    def initialize( data, mapping )
+      @column_accessors_map = mapping            # holds a reference to its spreadsheet's overall mapping
       import_record_data( data )
     end