csv_pirate 5.0.6 → 5.0.7

data/.gitignore

@@ -61,3 +61,4 @@ pkg
 spec/csv/*
 
 log
+.rvmrc

data/.travis.yml

@@ -5,4 +5,3 @@ rvm:
   - jruby-19mode
   - rbx-19mode
   - ruby-head
-  - jruby-head

data/CHANGELOG

@@ -1,3 +1,11 @@
+Version 5.0.7 2012-12-28
+
+- BUGFIX - Corrected implementation of :bury_treasure option, which allows storage of results as an array in buried_treasure
+- BUGFIX - Corrected implementation of CsvPirate.create (v5 compatibility) to use CsvPirate::TheCapn.create
+- SPECS - Added tests for :bury_treasure option
+- SPECS - Improved tests for v5 compatibility
+- Updated Readme to not advertise deprecated usage as much.
+
 Version 5.0.6 2012-09-13
 - Added back more support for pre v5 syntax with deprecation warnings.  CsvPirate.new & create now work again. (Issue 2)
 

data/README.rdoc

@@ -1,6 +1,4 @@
-== CsvPirate
-
-{<img src="https://secure.travis-ci.org/pboling/csv_pirate.png?branch=master" alt="Build Status" />}[http://travis-ci.org/pboling/csv_pirate] <= This cake is a lie.  I am not sure why Travis is failing me.
+== CsvPirate  {<img src="https://codeclimate.com/badge.png" />}[https://codeclimate.com/github/pboling/csv_pirate] {<img src="https://secure.travis-ci.org/pboling/csv_pirate.png?branch=master" alt="Build Status" />}[http://travis-ci.org/pboling/csv_pirate] {<img src="http://api.coderwall.com/pboling/endorsecount.png" />}[http://coderwall.com/pboling]
 
 Easily create CSVs of any data that can be derived from your models.
 
@@ -22,7 +20,7 @@ Initialize method (a.k.a new()) takes a hash of parameters, and creates the blan
   #                   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
+  # :waggoner       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
@@ -105,7 +103,7 @@ Since the defaults assume an active record class you need to override some of th
       @distance = args.first[:distance]
       @spectral_type = args.first[:spectral_type]
     end
-    
+
     def star_vowels
       self.name.tr('aeiou', '*')
     end
@@ -174,7 +172,7 @@ Assuming a Make (as in manufacturers of automobiles) model like this:
                         :spyglasses     => [:all]               # Array of symbols/strings: Methods that will be chained together and called on :grub in order to get the :swag records which will become the rows of the CSV.
                         :booty          => Make.column_names    # Array of symbols/strings or nested hashes of symbols/strings: Methods to call on each object in :swag.  These become the columns of the CSV.  The method names become the CSV column headings.  Methods can be chained to dig deep (e.g. traverse several ActiveRecord associations) to get at a value for the CSV. To call instance methods that include arguments, pass a booty element of an array such as [:method_name, arg1, arg2...].
 
-                        :swab           => :counter             # Symbol: What kind of file counter to use to avoid overwtiting the CSV file, :counter is Integer, :timestamp is HHMMSS, :none is no file counter, increasing the liklihood of duplicate filenames on successive csv exports.
+                        :swab           => :counter             # Symbol: What kind of file counter to use to avoid overwriting the CSV file, :counter is Integer, :timestamp is HHMMSS, :none is no file counter, increasing the likelihood of duplicate filenames on successive csv exports.
                         :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?
@@ -213,7 +211,7 @@ What if you want the file name to be always the same and to always append to the
   Make.walk_the_plank({:chronometer => false, :gibbet => "", :aft => "", :swab => :none, :waggoner => 'data'})
   Make.blindfold(:chronometer => false, :gibbet => "", :aft => "", :swab => :none, :waggoner => 'data')
 
-All of the options to has_csv_pirate_ship are available to walk_the_plank, land_ho, and blindfold, as well as to the raw class methods CsvPirate.new and CsvPirate.create, but not neccessarily the other way around.
+All of the options to has_csv_pirate_ship are available to walk_the_plank, land_ho, and blindfold, as well as to the raw class methods CsvPirate::TheCapn.new and CsvPirate::TheCapn.create, but not necessarily the other way around.
 
 You can also customize the CSV, for example if you want to customize which columns are in the csv:
 
@@ -260,7 +258,7 @@ You can also use the raw CsvPirate class itself directly wherever you want.
 
 The following two sets of code are identical:
 
-  csv_pirate = CsvPirate.new({
+  csv_pirate = CsvPirate::TheCapn.new({
     :grub => User,
     :spyglasses => [:active,:logged_in],
     :waggoner => 'active_users_logged_in',
@@ -269,7 +267,7 @@ The following two sets of code are identical:
   })
   csv_pirate.hoist_mainstay() # creates CSV file and writes out the rows
 
-  CsvPirate.create({
+  CsvPirate::TheCapn.create({
     :grub => User,
     :spyglasses => [:active,:logged_in],
     :waggoner => 'active_users_logged_in',
@@ -280,7 +278,7 @@ The following two sets of code are identical:
 Another example using swag instead of grub:
 
   users = User.logged_out.inactive
-  csv_pirate = CsvPirate.new({
+  csv_pirate = CsvPirate::TheCapn.new({
     :swag => users,
     :waggoner => 'inactive_users_not_logged_in',
     :booty => ["id","number","login","created_at"],
@@ -294,11 +292,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::TheCapn.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::TheCapn.new({:swag => users,:waggoner => 'inactive_users_not_logged_in',:booty => ["id","number","login","created_at"],:chart => ['log','csv']})
 
 
 == Downloading the CSV

data/lib/csv_pirate.rb

@@ -42,7 +42,7 @@ module CsvPirate
 
   def self.create(*args)
     warn "[DEPRECATION] \"CsvPirate.create\" is deprecated.  Use \"CsvPirate::TheCapn.create\" instead.  Called from: #{caller.first}"
-    CsvPirate::TheCapn.new(*args)
+    CsvPirate::TheCapn.create(*args)
   end
 
 end

data/lib/csv_pirate/the_capn.rb

@@ -116,7 +116,7 @@ module CsvPirate
 
       @astrolabe = args.first[:astrolabe] || false
 
-      @bury_treasure = args.first[:astrolabe] || false
+      @bury_treasure = args.first[:bury_treasure] || false
       @buried_treasure = []
 
       #does not rely on rails humanize!

data/lib/csv_pirate/version.rb

@@ -1,6 +1,6 @@
 module CsvPirate
 
-  VERSION = "5.0.6"
+  VERSION = "5.0.7"
 
   VERSION_ARRAY = VERSION.split('.')
 

data/spec/csv_pirate/csv_pirate_spec.rb

@@ -30,27 +30,71 @@ describe CsvPirate do
     end
   end
 
-  describe "#new" do
-    it "should support the old < v5 syntax" do
-      # Similar to example from the readme
-      CsvPirate.new({
-        :swag => [Struct.new(:first_name, :last_name, :birthday).new('Joe','Smith','12/24/1805')],
-        :waggoner => 'active_users_logged_in',
-        :booty => [:first_name, :last_name],
-        :chart => ['log','csv']
-      }).class.should == CsvPirate::TheCapn
+  describe "support the old < v5 syntax" do
+    # Mapping needs to be a separate test, because testing the method call mocks the object, and breaks the actual #new
+    describe "#new mapping" do
+      it "should map to CsvPirate::TheCapn.new" do
+        CsvPirate::TheCapn.should_receive(:new)
+        # Similar to old example from the v5 readme
+        @csv_pirate = CsvPirate.new({
+          :swag => [Struct.new(:first_name, :last_name, :birthday).new('Joe','Smith','12/24/1805')],
+          :waggoner => 'active_users_logged_in',
+          :booty => [:first_name, :last_name],
+          :chart => ['log','csv'],
+          :bury_treasure => true,
+        })
+      end
+    end
+    describe "#new" do
+      before(:each) do
+        # Similar to old example from the v5 readme
+        @csv_pirate = CsvPirate.new({
+          :swag => [Struct.new(:first_name, :last_name, :birthday).new('Joe','Smith','12/24/1805')],
+          :waggoner => 'active_users_logged_in',
+          :booty => [:first_name, :last_name],
+          :chart => ['log','csv'],
+          :bury_treasure => true,
+        })
+      end
+      it "should create an instance of CsvPirate::TheCapn" do
+        @csv_pirate.class.should == CsvPirate::TheCapn
+      end
+      it "should NOT mine the data" do
+        @csv_pirate.buried_treasure.length.should == 0
+      end
     end
-  end
 
-  describe "#create" do
-    it "should support the old < v5 syntax" do
-      # Similar to example from the readme
-      CsvPirate.create({
-        :swag => [Struct.new(:first_name, :last_name, :birthday).new('Joe','Smith','12/24/1805')],
-        :waggoner => 'active_users_logged_in',
-        :booty => [:first_name, :last_name],
-        :chart => ['log','csv']
-      }).class.should == CsvPirate::TheCapn
+    # Mapping needs to be a separate test, because testing the method call mocks the object, and breaks the actual #new
+    describe "#create mapping" do
+      it "should map to CsvPirate::TheCapn.create" do
+        CsvPirate::TheCapn.should_receive(:create)
+        # Similar to old example from the v5 readme
+        @csv_pirate = CsvPirate.create({
+                                      :swag => [Struct.new(:first_name, :last_name, :birthday).new('Joe','Smith','12/24/1805')],
+                                      :waggoner => 'active_users_logged_in',
+                                      :booty => [:first_name, :last_name],
+                                      :chart => ['log','csv'],
+                                      :bury_treasure => true,
+                                    })
+      end
+    end
+    describe "#create" do
+      before(:each) do
+        # Similar to old example from the v5 readme
+        @csv_pirate = CsvPirate.create({
+          :swag => [Struct.new(:first_name, :last_name, :birthday).new('Joe','Smith','12/24/1805')],
+          :waggoner => 'active_users_logged_in',
+          :booty => [:first_name, :last_name],
+          :chart => ['log','csv'],
+          :bury_treasure => true,
+        })
+      end
+      it "should create an instance of CsvPirate::TheCapn" do
+        @csv_pirate.class.should == CsvPirate::TheCapn
+      end
+      it "should mine the data" do
+        @csv_pirate.buried_treasure.length.should == 1
+      end
     end
   end
 

data/spec/csv_pirate/the_capn_spec.rb

@@ -239,4 +239,40 @@ describe CsvPirate::TheCapn do
     end
   end
 
+  describe ":bury_treasure option" do
+    describe "when true" do
+      before(:each) do
+        # Similar to example from the readme
+        @csv_pirate = CsvPirate::TheCapn.create({
+                                                  :swag => [Struct.new(:first_name, :last_name, :birthday).new('Joe','Smith','12/24/1805')],
+                                                  :waggoner => 'active_users_logged_in',
+                                                  :booty => [:first_name, :last_name],
+                                                  :chart => ['log','csv'],
+                                                  :bury_treasure => true
+                                                })
+      end
+      it "should bury treasure in buried_treasure as array" do
+        @csv_pirate.buried_treasure.class.should == Array
+      end
+      it "should have buried treasure" do
+        @csv_pirate.buried_treasure.first.should == %w(Joe Smith)
+      end
+    end
+    describe "when false" do
+      before(:each) do
+        # Similar to example from the readme
+        @csv_pirate = CsvPirate::TheCapn.create({
+                                                  :swag => [Struct.new(:first_name, :last_name, :birthday).new('Joe','Smith','12/24/1805')],
+                                                  :waggoner => 'active_users_logged_in',
+                                                  :booty => [:first_name, :last_name],
+                                                  :chart => ['log','csv'],
+                                                  :bury_treasure => false
+                                                })
+      end
+      it "should not bury any treasure in the buried_treasure array" do
+        @csv_pirate.buried_treasure.should == []
+      end
+    end
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: csv_pirate
 version: !ruby/object:Gem::Version
-  version: 5.0.6
+  version: 5.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-13 00:00:00.000000000 Z
+date: 2012-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -182,4 +182,3 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/glowing_gas_ball.rb
 - spec/support/star.rb
-has_rdoc: