README.rdoc in csv_pirate-5.0.4 vs README.rdoc in csv_pirate-5.0.6.pre1
- old
+ new
@@ -1,7 +1,9 @@
== 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.
+
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 Ruby, in full pirate regalia.
It works better if you are wearing a tricorne! Now compatible with Ruby 1.8.7 & 1.9.2, and Rails 2 & 3!
@@ -9,11 +11,11 @@
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 parameters:
+Initialize method (a.k.a new()) takes a hash of parameters, and creates the blank CSV file, and the instance can be modified prior to writing out to CSV:
# 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,
@@ -35,50 +37,23 @@
# :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 (this is the default)
# {: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! There are a few new options in the 4.0.0 release, which are as yet undocumented.
-The create method has the same parameters, and actually creates the CSV.
+Check the source to see if there anything else hiding in there! (HINT: There a bunch more undocumented options)
+The create method has the same parameters, and actually writes the data to the CSV.
+
Avast! Here be pirates! To brush up on pirate coding naming conventions:
http://www.privateerdragons.com/pirate_dictionary.html
-== On The Web
+== Install
-Source:
- http://github.com/pboling/csv_pirate
-
-Release Announcement:
- http://galtzo.blogspot.com/2009/03/csv-pirate.html
-
-
-== Install as a RubyGem from source
-
[sudo] gem install csv_pirate
-Gem Using Git building from source:
-
- mkdir -p ~/src
- cd ~/src
- git clone git://github.com/pboling/csv_pirate.git
- cd csv_pirate
- gem build csv_pirate.gemspec
- sudo gem install csv_pirate-5.0.4.gem # (Or whatever version gets built)
-
-== Install as a Plugin
-
-Plugin using Git:
-
- ruby script/plugin install git://github.com/pboling/csv_pirate.git
-
-== Install as a Git Submodule (plugin)
-
- git submodule add git://github.com/pboling/csv_pirate.git vendor/plugins/csv_pirate
-
== Upgrading
From version prior to 5.0
NinthBit::PirateShip::ActMethods has been deprecated in favor of CsvPirate::PirateShip::ActMethods.
@@ -417,14 +392,10 @@
== Tests
The tests are run with rspec. The test suite is expanding. Currently there is ample coverage of basic functionality.
-You will need these gems to run specs:
-
- gem install jeweler cucumber test-unit rspec
-
If on a Ruby prior to Ruby 1.9 you will also need the fastercsv gem
To run tests cd to where ever you have csv_pirate installed, and do:
rake spec
@@ -447,17 +418,24 @@
* Start a feature/bugfix branch
* Commit and push until you are happy with your contribution
* Make sure to add tests, rspec preferred, for it. This is important so I don't break it in a future version unintentionally.
* Please try not to mess with the Rakefile, version, or change log. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+== On The Web
+Source:
+ http://github.com/pboling/csv_pirate
+
+Release Announcement:
+ http://galtzo.blogspot.com/2009/03/csv-pirate.html
+
== Thanks
Thanks go to:
* 9thBit LLC (http://www.9thBit.net) - Peter Boling, author of CsvPirate, runs the joint.
* Sagebit LLC (http://www.sagebit.com) - Sagebit has been very supportive of my open source efforts, thanks Ben!
* TimePerks LLC (http://www.timeperks.com) - Many useful enhancements were requested and paid for by TimePerks
----------------------------------------------------------------------------------
Author: Peter Boling, peter.boling at gmail dot com
- Copyright (c) 2009-2011 Peter H. Boling of 9thBit LLC, released under the MIT license. See LICENSE for details.
+ Copyright (c) 2008-2012 Peter H. Boling of 9thBit LLC, released under the MIT license. See LICENSE for details.