csv_pirate 3.3.2 → 3.4.1

data/CHANGELOG

@@ -1,3 +1,11 @@
+Version 3.4.1 2009-10-12
+- :blackjack option :join is now working.
+- Added warnings, and improved Readme
+
+Version 3.4.0 2009-10-12
+- Now the auto generated columns based on the booty array print nicely, with customization options
+- You are now able to specify your own array of strings to use as the CSV header, in case you don't want to use the booty methods.
+
 Version 3.3.2 2009-10-11
 - You can now declare has_csv_pirate_ship in a model whose migration has not been run yet without making the app barf.
 - Cleaned up Gem Dependency (faster_csv)

data/README.rdoc

@@ -9,7 +9,7 @@ My goal is to have it do EVERYTHING it possibly can for me, since almost every p
 
 CsvPirate only works for commissions of swag OR grub!
 
-Initialize method (a.k.a new()) takes a hash of params:
+Initialize method (a.k.a new()) takes a hash of parameters:
 
   # CsvPirate only works for commissions of swag OR grub!
   # :swag           the ARrr collection of swag to work on (optional)
@@ -28,9 +28,13 @@ Initialize method (a.k.a new()) takes a hash of params:
   #   :timestamp - each successive run will create a new file using a HHMMSS time stamp
   #   :none - no iterative file naming convention, just use waggoner and aft
   # :mop            can be :clean or :dirty (:overwrite or :append) (only has an effect if :swab is :none) since overwriting is irrelevant for a new file
-  #   :clean - do not use :counter or :timestamp, and instead overwrite the file
-  #   :dirty - do not use :counter, or :timestamp, or :overwrite.  Just keep adding on.
+  #   :clean - do not use :swab above (:counter or :timestamp), and instead overwrite the file
+  #   :dirty - do not use :swab above (:counter, or :timestamp), and do not overwrite.  Just keep adding on.
   # :bury_treasure  should we store the csv data as it is collected in an array in Ruby form for later use (true), or just write the CSV (false)?
+  # :blackjack      Specify how you want your CSV header
+  #   {:join => '-'}    joins the method names called to get hte data for that column with '_' underscores.
+  #   {:humanize =>'-'} first joins as above, then humanizes the string
+  #   {:array => ['col1',col2','col3'] Uses the column names provided.  If the array's length is less than the booty array's length it reverts to :humanize =>'_'
   # check the source to see if there anything else hiding in there!
 
 The create method has the same parameters, and actually creates the CSV.
@@ -63,7 +67,7 @@ Gem Using Git building from source:
   git clone git://github.com/pboling/csv_pirate.git
   cd csv_pirate
   gem build csv_pirate.gemspec
-  sudo gem install csv_pirate-3.3.1.gem # (Or whatever version gets built)
+  sudo gem install csv_pirate-3.4.1.gem # (Or whatever version gets built)
 
 Then cd to your rails app to optionally freeze the gem into your app:
 
@@ -187,19 +191,23 @@ Assuming a Make (as in manufacturers of automobiles) model like this:
                         :mop            => :clean               # Symbol: If we DO end up writing to a preexisting file (by design or accident) should we overwrite (:clean) or append (:dirty)?
                         :shrouds        => ','                  # String: Delimiter for CSV.  '\t' will create a tab delimited file (tsv), '|' will create a pipe delimited file.
                         :bury_treasure  => true                 # Boolean: Should the array of objects in :swag be stored in the CsvPirate object for later inspection?
+                        :blackjack      => {:humanize => '-'}   # Hash: Specify how you want your CSV header
+                                                                #   {:join => '-'}    joins the method names called to get hte data for that column with '_' underscores.
+                                                                #   {:humanize => '-'} first joins as above, then humanizes the string
+                                                                #   {:array => ['col1',col2','col3'] Uses the column names provided in the array.  If the array provided is too short defaults to :humanize =>'_'
 
     # A customized version to create a tab delimited file for this class might look like this:
     # has_csv_pirate_ship   :spyglasses => [:factory_in_germany],
     #                       :booty      => [:id, :name],
     #                       :shrouds    => '\t'
-    #                       # kepping the rest of the options at the default values, so they don't need to be defined.
+    #                       # keeping the rest of the options at the default values, so they don't need to be defined.
   end
 
 To create a csv of the names and ids of makes with factories in germany and return the text of the export:
 
   Make.walk_the_plank  # Get it? HA! If you can't believe I wrote this whole thing JUST to be able to make jokes like that... check ma sources :)
 
-The name of the csv that comes out will be (by defualt located in log directory):
+The name of the csv that comes out will be (by default located in log directory):
 
   Make.20090930.export.13.csv
 
@@ -208,10 +216,10 @@ Where Make is the class, 20090930 is today's date, .export is the gibbet, and 13
 All of those filename parts are customizable to a degree.  For example if you want to have the date NOT be today's date you can supply your own date:
 
   Make.walk_the_plank({:chronometer => Date.parse("December 21, 2012") })
-  # Filename would be: Make.20121221.export.13.csv
+  # File name would be: Make.20121221.export.13.csv
 
   Make.walk_the_plank({:chronometer => false })
-  # Filename would be: Make.export.13.csv
+  # File name would be: Make.export.13.csv
 
 What if you want the file name to be always the same and to always append to the end of it?
   #Example: I want the file to be named "data", with no extension, both of the following accomplish that:
@@ -364,7 +372,7 @@ Then check the output from the console:
 
   a.weigh_anchor
 
-  id,name,year,makename,tiressizewidthinches
+  Id,Name,Year,Make name,Tires size width inches
   1,Cavalier,1999,Chevrolet,13
   2,Trailblazer,2006,Chevrolet,13
   3,Corvette,2010,Chevrolet,13

data/Rakefile

@@ -10,7 +10,7 @@ It works better if you are wearing a tricorne!}
     gemspec.email = "peter.boling@gmail.com"
     gemspec.homepage = "http://github.com/pboling/csv_pirate"
     gemspec.authors = ["Peter Boling"]
-    gemspec.add_dependency 'faster_csv'
+    gemspec.add_dependency 'fastercsv'
     gemspec.files = ["README.rdoc",
              "csv_pirate.gemspec",
              "init.rb",

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:patch: 2
+:patch: 1
 :major: 3
-:minor: 3
+:minor: 4

data/csv_pirate.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{csv_pirate}
-  s.version = "3.3.2"
+  s.version = "3.4.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Peter Boling"]
-  s.date = %q{2009-10-11}
+  s.date = %q{2009-10-13}
   s.description = %q{CsvPirate is the easy way to create a CSV of essentially anything in Rails, in full pirate regalia.
 It works better if you are wearing a tricorne!}
   s.email = %q{peter.boling@gmail.com}
@@ -45,11 +45,11 @@ It works better if you are wearing a tricorne!}
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<faster_csv>, [">= 0"])
+      s.add_runtime_dependency(%q<fastercsv>, [">= 0"])
     else
-      s.add_dependency(%q<faster_csv>, [">= 0"])
+      s.add_dependency(%q<fastercsv>, [">= 0"])
     end
   else
-    s.add_dependency(%q<faster_csv>, [">= 0"])
+    s.add_dependency(%q<fastercsv>, [">= 0"])
   end
 end

data/lib/csv_pirate.rb

@@ -47,6 +47,10 @@ class CsvPirate
   attr_accessor :swabbie          # value of the counter / timestamp
   attr_accessor :maroon           # text of csv
   attr_accessor :nocturnal        # basename of the filepath (i.e. filename)
+  attr_accessor :blackjack        # Hash: Specify how you want your CSV header
+                                  #   {:join => '-'}    joins the method names called to get hte data for that column with '_' underscores.
+                                  #   {:humanize => '-'} first joins as above, then humanizes the string
+                                  #   {:array => ['col1',col2','col3'] Uses the column names provided in the array.  If the array provided is too short defaults to :humanize =>'_'
 
   cattr_accessor :parlay          # verbosity on a scale of 0 - 3 (0=:none, 1=:error, 2=:info, 3=:debug, 0 being no screen output, 1 is default
 
@@ -70,6 +74,10 @@ class CsvPirate
   #   :clean - do not use :counter or :timestamp, and instead overwrite the file
   #   :dirty - do not use :counter, or :timestamp, or :overwrite.  Just keep adding on.
   # :bury_treasure  should we store the csv data as it is collected in an array in Ruby form for later use (true), or just write the CSV (false)?
+  # :blackjack      Specify how you want your CSV header
+  #   {:join => '-'}    joins the method names called to get hte data for that column with '_' underscores.
+  #   {:humanize =>'-'} first joins as above, then humanizes the string
+  #   {:array => ['col1',col2','col3'] Uses the column names provided.  If the array provided is too short defaults to :humanize =>'_'
   # See README for examples
   
   def initialize(*args)
@@ -113,6 +121,15 @@ class CsvPirate
     @bury_treasure = args.first[:astrolabe] || false
     @buried_treasure = []
 
+    #Default is different than default for has_csv_pirate because this might gem wants to be clean for use outside rails, and humanize may not always be defined for String class
+    @blackjack = args.first[:blackjack] || {:join => '_'}
+
+    #Make sure the header array is the same length as the booty columns
+    if self.blackjack.keys.first == :array && (self.blackjack.values.first.length != self.booty.length)
+      @blackjack = {:join => '_'}
+      puts "Warning: :blackjack reset to {:join => '_'} because the length of the :booty is different than the length of the array provided to :blackjack" if CsvPirate.parlance(2)
+    end
+
     # Initialize doesn't write anything to a CSV, 
     #   but does create the traverse_board and opens the waggoner for reading / writing
     self.northwest_passage unless self.astrolabe
@@ -144,6 +161,7 @@ class CsvPirate
       :spyglasses => args.first[:spyglasses],
       :booty => args.first[:booty],
       :astrolabe => args.first[:astrolabe],
+      :blackjack => args.first[:blackjack],
       :bury_treasure => args.first[:bury_treasure]
     })
     csv_pirate.hoist_mainstay()
@@ -225,8 +243,7 @@ class CsvPirate
   end
 
   def sounding(csv)
-    # create the header of the CSV (column/method names)
-    csv << self.booty
+    csv << self.block_and_tackle
     # create the data for the csv
     self.dig_for_treasure do |treasure|
       moidore = treasure.map {|x| "#{x}"}
@@ -235,6 +252,50 @@ class CsvPirate
     end
   end
 
+  # create the header of the CSV (column/method names)
+  # returns an array of strings for CSV header based on blackjack
+  def block_and_tackle
+    self.blackjack.map do |k,v|
+      case k
+        #Joining is only relevant when the booty contains a nested hash of method calls as at least one of the booty array elements
+        #Use the booty (methods) as the column headers
+        when :join then self.binnacle(v, false)
+        #Use the humanized booty (methods) as the column headers
+        when :humanize then self.binnacle(v, true)
+        when :array then v
+      end
+    end.first
+  end
+
+  #returns an array of strings for CSV header based on booty
+  def binnacle(join_value, humanize = true)
+    self.booty.map do |compass|
+      string = compass.is_a?(Hash) ?
+        self.run_through(compass, join_value) :
+        compass.is_a?(String) ?
+          compass :
+          compass.is_a?(Symbol) ?
+            compass.to_s :
+            compass.to_s
+      humanize ? string.humanize : string
+    end
+  end
+
+  #Takes a potentially nested hash element of a booty array and turns it into a string for a column header
+  # hash = {:a => {:b => {:c => {:d => {"e" => "fghi"}}}}}
+  # run_through(hash, '_')
+  # => "a_b_c_d_e_fghi"
+  # Ooooh so recursive!
+  def run_through(hash, join_value)
+    hash.map do |k,v|
+      if v.is_a?(Hash)
+        [k,run_through(v, join_value)].join(join_value)
+      else #works for Symbols and Strings
+        [k,v].join(join_value)
+      end
+    end.first
+  end
+
   #complete file path
   def poop_deck
     "#{self.analemma}#{self.swabbie}#{self.aft}"

data/lib/ninth_bit/pirate_ship.rb

@@ -25,6 +25,7 @@ module NinthBit
         # Have to protect against model definitions pre-migration, since column names will fail if
         options[:booty]         ||= check_booty ? self.column_names : []
         options[:bury_treasure] ||= true
+        options[:blackjack]     ||= {:humanize => '_'}
         options[:parlay]        ||= 1
 
         # if they provide both
@@ -38,6 +39,7 @@ module NinthBit
         raise ArgumentError, ":booty is #{options[:booty].inspect}, and must be an array of methods to call on a class for CSV data" if check_booty && (options[:booty].nil? || !options[:booty].is_a?(Array) || options[:booty].empty?)
         raise ArgumentError, ":chart is #{options[:chart].inspect}, and must be an array of directory names, which will become the filepath for the csv file" if options[:chart].nil? || !options[:chart].is_a?(Array) || options[:chart].empty?
         raise ArgumentError, ":shrouds is #{options[:shrouds].inspect}, and must be a string (e.g. ',' or '\t'), which will be used as the delimeter for the csv file" if options[:shrouds].nil? || !options[:shrouds].is_a?(String)
+        raise ArgumentError, ":blackjack is #{options[:blackjack].inspect}, and must be a hash (e.g. {:humanize => '_'}), which defines how the header of the CSV will be created" if options[:blackjack].nil? || !options[:blackjack].is_a?(Hash)
 
         extend ClassMethods unless (class << self; included_modules; end).include?(ClassMethods)
 
@@ -54,7 +56,7 @@ module NinthBit
 
       # intended for use with send_data for downloading the text of the csv:
       # send_data Make.say_your_last_words
-      # TODO: Fix say_yourr_last_words so it works! Use send_data args for real
+      # TODO: Fix say_your_last_words so it works! Use send_data args for real
       #def say_your_last_words(charset = 'utf-8', args = {})
       #  csv_pirate = self.blindfold(args)
       #  return [ csv_pirate.maroon,
@@ -109,6 +111,7 @@ module NinthBit
           :grub => args[:grub] || self.piratey_options[:grub],
           :spyglasses => args[:spyglasses] || self.piratey_options[:spyglasses],
           :booty => args[:booty] || self.piratey_options[:booty],
+          :blackjack => args[:blackjack] || self.piratey_options[:blackjack],
           :bury_treasure => args[:bury_treasure] || self.piratey_options[:bury_treasure] }
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: csv_pirate
 version: !ruby/object:Gem::Version 
-  version: 3.3.2
+  version: 3.4.1
 platform: ruby
 authors: 
 - Peter Boling
@@ -9,11 +9,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-11 00:00:00 -04:00
+date: 2009-10-13 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: faster_csv
+  name: fastercsv
   type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement