csv_pirate 2.4.4 → 3.1.0

data/CHANGELOG

@@ -1,3 +1,9 @@
+Version 2.5.1 2009-10-01
+- Fixed bug with handling of Rails.root & RAILS_ROOT
+
+Version 2.5.0 2009-10-01
+- Added northwest_passage to create all the directories in :chart
+
 Version 2.4.1 2009-10-01
 - Fixed critical typo
 

data/README.rdoc

@@ -5,30 +5,33 @@ Easily create CSVs of any data that can be derived from your models.
 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!
 
+My goal is to have it do EVERYTHING it possibly can for me, since almost every project I do needs CSV exports.
+
 CsvPirate only works for commissions of swag OR grub!
 
 Initialize method (a.k.a new()) takes a hash of params:
 
   # CsvPirate only works for commissions of swag OR grub!
-  # :swag         the ARrr collection of swag to work on (optional)
-  # :grub         the ARrr class that the spyglasses will be used on (optional)
-  # :spyglasses   named scopes in your model that will refine the rows in the CSV according to conditions of the spyglasses,
-  #                 and order them according to the order of the spyglasses (optional)
-  # :booty        booty (columns/methods) on your model that you want printed in the CSV, also used to create the figurehead (CSV header)
-  # :chart        name of directory where you want to hide your loot
-  # :wagonner     name of document where you will give detailed descriptions of the loot
-  # :aft          filename extention ('.csv')
-  # :shrouds      CSV column separator, default is ','. For tsv, tab-delimited, "\t"
-  # :chronometer  keeps track of when you hunt for treasure
-  # :gibbet       filename spacer after the date, and before the iterative counter/timestamp.  MuST contain a '.'
-  # :swab         can be :counter, :timestamp, or :none
+  # :swag           the ARrr collection of swag to work on (optional)
+  # :grub           the ARrr class that the spyglasses will be used on (optional)
+  # :spyglasses     named scopes in your model that will refine the rows in the CSV according to conditions of the spyglasses,
+  #                   and order them according to the order of the spyglasses (optional)
+  # :booty          booty (columns/methods) on your model that you want printed in the CSV, also used to create the figurehead (CSV header)
+  # :chart          array of directory names (relative to rails root if using rails) which will be the filepath where you want to hide your loot
+  # :wagonner       name of document where you will give detailed descriptions of the loot
+  # :aft            filename extention ('.csv')
+  # :shrouds        CSV column separator, default is ','. For tsv, tab-delimited, "\t"
+  # :chronometer    keeps track of when you hunt for treasure
+  # :gibbet         filename spacer after the date, and before the iterative counter/timestamp.  MuST contain a '.'
+  # :swab           can be :counter, :timestamp, or :none
   #   :counter - default, each successive run will create a new file using a counter
   #   :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
+  # :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
   #   :clear - do not use :counter or :timestamp, and instead overwrite the file
   #   :dirty - do not use :counter, or :timestamp, or :overwrite.  Just keep adding on.
-  # There are others too, check the source for a complete picture!
+  # :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)?
+  # check the source to see if there anything else hiding in there!
 
 The create method has the same parameters, and actually creates the CSV.
 
@@ -71,6 +74,13 @@ Plugin using Git:
   ruby script/plugin install git://github.com/pboling/csv_pirate.git
 
 
+== Upgrading
+
+  In older versions :chart was a string which indicated where you wanted to hide the loot (write the csv file)
+  Now it must be an array of directory names.  So if you want your loot in "log/csv/pirates/model_name", then chart is:
+  ['log','csv','pirates','model_name']
+  CsvPirate ensures that whatever you choose as your chart exists in the filesystem, and creates the directories if need be.
+
 == Example & Usage
 
 Assuming a Make (as in manufacturers of automobiles) model like this:
@@ -152,7 +162,7 @@ The following two sets of code are identical:
     :spyglasses => [:active,:logged_in],
     :waggoner => 'active_users_logged_in',
     :booty => ["id","number","login","created_at"],
-    :chart => 'log/csv/'
+    :chart => ['log','csv']
   })
   csv_pirate.hoist_mainstay() # creates CSV file and writes out the rows
 
@@ -161,7 +171,7 @@ The following two sets of code are identical:
     :spyglasses => [:active,:logged_in],
     :waggoner => 'active_users_logged_in',
     :booty => ["id","number","login","created_at"],
-    :chart => 'log/csv/'
+    :chart => ['log','csv']
   })# creates CSV file and writes out the rows
 
 Another example using swag instead of grub:
@@ -171,7 +181,7 @@ Another example using swag instead of grub:
     :swag => users,
     :waggoner => 'inactive_users_not_logged_in',
     :booty => ["id","number","login","created_at"],
-    :chart => 'log/csv/'
+    :chart => ['log','csv']
   })
   csv_pirate.hoist_mainstay()
 
@@ -181,11 +191,11 @@ Then if you want to get your hands on the loot immediately:
 
 For those who can't help but copy/paste into console and then edit:
 
-  csv_pirate = CsvPirate.new({:grub => User,:spyglasses => [:active,:logged_in],:waggoner => 'active_users_logged_in',:booty => ["id","number","login","created_at"],:chart => 'log/csv/'})
+  csv_pirate = CsvPirate.new({:grub => User,:spyglasses => [:active,:logged_in],:waggoner => 'active_users_logged_in',:booty => ["id","number","login","created_at"],:chart => ['log','csv']})
 
 OR
 
-  csv_pirate = CsvPirate.new({:swag => users,:waggoner => 'inactive_users_not_logged_in',:booty => ["id","number","login","created_at"],:chart => 'log/csv/'})
+  csv_pirate = CsvPirate.new({:swag => users,:waggoner => 'inactive_users_not_logged_in',:booty => ["id","number","login","created_at"],:chart => ['log','csv']})
 
 
 == Downloading the CSV
@@ -257,7 +267,7 @@ You have a VehicleModel class and the same Make class as up above:
 
 Then to create the CSV:
 
-  a = VehicleModel.walk_the_plank
+  a = VehicleModel.blindfold
 
 Then check the output from the console:
 

data/VERSION.yml

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

data/csv_pirate.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{csv_pirate}
-  s.version = "2.4.4"
+  s.version = "3.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Peter Boling"]

data/lib/csv_pirate.rb

@@ -15,7 +15,7 @@ class CsvPirate
   MOP_HEADS = [:clean, :dirty]
 
   attr_accessor :waggoner         #filename
-  attr_accessor :chart            #directory, default is ('log/')
+  attr_accessor :chart            #directory, default is (['log','csv'])
   attr_accessor :aft              #extension, default is ('.csv')
   attr_accessor :gibbet           #part of the filename after waggoner and date, before swabbie and aft
   attr_accessor :chronometer
@@ -56,7 +56,7 @@ class CsvPirate
   # :spyglasses     named scopes in your model that will refine the rows in the CSV according to conditions of the spyglasses,
   #                   and order them according to the order of the spyglasses (optional)
   # :booty          booty (columns/methods) on your model that you want printed in the CSV, also used to create the figurehead (CSV header)
-  # :chart          name of directory where you want to hide your loot
+  # :chart          array of directory names (relative to rails root if using rails) which will be the filepath where you want to hide your loot
   # :wagonner       name of document where you will give detailed descriptions of the loot
   # :aft            filename extention ('.csv')
   # :shrouds        CSV column separator, default is ','. For tsv, tab-delimited, "\t"
@@ -92,13 +92,15 @@ class CsvPirate
     @gibbet = args.first[:gibbet] || '.export'
     raise ArgumentError, ":gibbet is #{args.first[:gibbet].inspect}, and does not contain a '.' character, which is required for iterative filenames" if args.first[:gibbet].nil? || !args.first[:gibbet].include?('.')
 
-    @waggoner = args.first[:waggoner] || "#{self.grub}"
+    @waggoner = args.first[:waggoner] || "#{self.grub || self.swag}"
     raise ArgumentError, ":waggoner is #{args.first[:waggoner].inspect}, and must be a string at least one character long" if args.first[:waggoner].nil? || args.first[:waggoner].length < 1
 
     @booty = args.first[:booty] || []
-    raise ArgumentError, ":booty is #{args.first[:booty].inspect}, and must be an array of methods to call on a class for CSV data" if args.first[:booty].nil? || args.first[:booty].empty?
+    raise ArgumentError, ":booty is #{args.first[:booty].inspect}, and must be an array of methods to call on a class for CSV data" if args.first[:booty].nil? || !args.first[:booty].is_a?(Array) || args.first[:booty].empty?
+
+    @chart = args.first[:chart] || ['log','csv']
+    raise ArgumentError, ":chart is #{args.first[:chart].inspect}, and must be an array of directory names, which will become the filepath for the csv file" if args.first[:chart].nil? || !args.first[:chart].is_a?(Array) || args.first[:booty].empty?
 
-    @chart = args.first[:chart] || 'log/'
     @aft = args.first[:aft] || '.csv'
     @chronometer = args.first[:chronometer] || Date.today
 
@@ -112,7 +114,7 @@ class CsvPirate
 
     # Initialize doesn't write anything to a CSV, 
     #   but does create the traverse_board and opens the waggoner for reading / writing
-    Dir.mkdir(self.traverse_board) if !self.astrolabe && Dir.glob(self.traverse_board).empty?
+    self.northwest_passage unless self.astrolabe
 
     # This will contain the text of the csv from this particular execution
     @maroon = ""
@@ -232,28 +234,11 @@ class CsvPirate
     end
   end
 
-  def traverse_board
-    #If we have rails environment then we use rails root, otherwise self.chart stands on its own as a relative path
-    "#{defined?(Rails) ? Rails.root + '/' : defined?(RAILS_ROOT) ? RAILS_ROOT + '/' : ''}#{self.chart}"
-  end
-  
-  def sand_glass
-    "#{self.chronometer.respond_to?(:strftime) ? '.' + self.chronometer.strftime("%Y%m%d") : ''}"
-  end
-  
   #complete file path
   def poop_deck
     "#{self.analemma}#{self.swabbie}#{self.aft}"
   end
 
-  def merchantman
-    "#{self.waggoner}#{self.sand_glass}#{self.gibbet}"
-  end
-
-  def analemma
-    "#{self.traverse_board}#{self.merchantman}"
-  end
-
   # Swabs the poop_deck if the mop is clean. (!)
   def swab_poop_deck
     self.rhumb_lines.truncate(0) if self.swab == :none && self.mop == :clean && File.size(self.poop_deck) > 0
@@ -274,6 +259,34 @@ class CsvPirate
 
   protected
 
+  def traverse_board
+    #If we have rails environment then we use rails root, otherwise self.chart stands on its own as a relative path
+    "#{self.north_pole}#{self.chart.join('/')}/"
+  end
+
+  def sand_glass
+    "#{self.chronometer.respond_to?(:strftime) ? '.' + self.chronometer.strftime("%Y%m%d") : ''}"
+  end
+
+  def merchantman
+    "#{self.waggoner}#{self.sand_glass}#{self.gibbet}"
+  end
+
+  def analemma
+    "#{self.traverse_board}#{self.merchantman}"
+  end
+
+  def north_pole
+    "#{defined?(Rails) ? "#{Rails.root}/" : defined?(RAILS_ROOT) ? "#{RAILS_ROOT}/" : ''}"
+  end
+
+  def northwest_passage
+    self.chart.length.times do |i|
+      north_star = self.north_pole + self.chart[0..i].join('/')
+      Dir.mkdir(north_star) if Dir.glob(north_star).empty?
+    end
+  end
+
   def lantern
     "#{self.analemma}.*"
   end
@@ -372,7 +385,7 @@ class CsvPirate
   #   :spyglasses => is the column to load ("find_by_#{booty}") the ARrr object for each row on the first CSV
   #                  (swag OR spyglasses can be specified, but code defers to swag if provided)
   #   :waggoner   => where the capn's loot was stashed (filename)
-  #   :chart      => directory where capn's waggoner is located
+  #   :chart      => array of directory names where capn's waggoner is located
   #   :astrolabe  => true (file is opened at top of file in read only mode when true)
   # The first_mate hash is:
   #   :grub       => is the class on which to make booty [method] calls, or 
@@ -382,23 +395,23 @@ class CsvPirate
   #   :spyglasses => is the column to load ("find_by_#{booty}") the ARrr object for each row on the second CSV (if grub is a class)
   #   :booty      => is the methods to call on the ARrr object for each row on the second CSV
   #   :waggoner   => where to stash the first mate's loot (filename)
-  #   :chart      => directory where first mate's waggoner is located
+  #   :chart      => array of directory names where first mate's waggoner is located
   #   :astrolabe  => false (false is the default for astrolabe, so we could leave it off the first_mate)
   #
   # Example:
-#   capn      = {:grub => User,:spyglasses => [:inactive],:booty => ['id','login','status'],:waggoner => 'orig',:chart => 'log/csv/',:astrolabe => false}
+#   capn      = {:grub => User,:spyglasses => [:inactive],:booty => ['id','login','status'],:waggoner => 'orig',:chart => ['log','csv'],:astrolabe => false}
 #   make_orig = CsvPirate.new(capn)
 #   make_orig.hoist_mainstay
 #   make_orig.weigh_anchor
 #
-#   first_mate = {:grub => 'account',:booty => ["id","number","name","created_at"],:waggoner => 'fake',:chart => 'log/csv/'}
+#   first_mate = {:grub => 'account',:booty => ["id","number","name","created_at"],:waggoner => 'fake',:chart => ['log','csv']}
 #  OR
 #   # for same class, we re-use the object loaded from first CSV and make the booty [method] calls on it
-#   first_mate = {:grub => User,:booty => ["id","login","visits_count"],:waggoner => 'fake',:chart => 'log/csv/'}
+#   first_mate = {:grub => User,:booty => ["id","login","visits_count"],:waggoner => 'fake',:chart => ['log','csv']}
 #  OR
-#   first_mate = {:grub => Account,:spyglasses => 'id',:swag=>'user_id',:booty => ["id","name","number"],:waggoner => 'fake',:chart => 'log/csv/'}
+#   first_mate = {:grub => Account,:spyglasses => 'id',:swag=>'user_id',:booty => ["id","name","number"],:waggoner => 'fake',:chart => ['log','csv']}
 #  AND
-#   capn       = {:grub => User,:spyglasses => 'login',:swag => 1,:waggoner => 'orig',:chart => 'log/csv/',:astrolabe => true}
+#   capn       = {:grub => User,:spyglasses => 'login',:swag => 1,:waggoner => 'orig',:chart => ['log','csv'],:astrolabe => true}
 #   after_mutiny = CsvPirate.mutiny(capn, first_mate)
 #
   def self.mutiny(capn, first_mate)

data/lib/ninth_bit/pirate_ship.rb

@@ -6,7 +6,7 @@ module NinthBit
       def has_csv_pirate_ship(options = {})
         raise ArgumentError, "must provide required options" if options.blank?
 
-        options[:chart]         ||= 'log/'
+        options[:chart]         ||= ['log','csv']
         options[:aft]           ||= '.csv'
         options[:gibbet]        ||= '.export'
         #Needs to be defined at runtime, doesn't make sense here
@@ -30,7 +30,8 @@ module NinthBit
         raise ArgumentError, ":mop is #{options[:mop].inspect}, but must be one of #{CsvPirate::MOP_HEADS.inspect}" unless CsvPirate::MOP_HEADS.include?(options[:mop])
         raise ArgumentError, ":gibbet is #{options[:gibbet].inspect}, and does not contain a '.' character, which is required for iterative filenames" if options[:gibbet].nil? || !options[:gibbet].include?('.')
         raise ArgumentError, ":waggoner is #{options[:waggoner].inspect}, and must be a string at least one character long" if options[:waggoner].nil? || options[:waggoner].length < 1
-        raise ArgumentError, ":booty is #{options[:booty].inspect}, and must be an array of methods to call on a class for CSV data" if options[:booty].nil? || options[:booty].empty?
+        raise ArgumentError, ":booty is #{options[:booty].inspect}, and must be an array of methods to call on a class for CSV data" if 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?
 
         extend ClassMethods unless (class << self; included_modules; end).include?(ClassMethods)
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: csv_pirate
 version: !ruby/object:Gem::Version 
-  version: 2.4.4
+  version: 3.1.0
 platform: ruby
 authors: 
 - Peter Boling