table_print 0.2.3 → 1.0.0.rc3

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rvmrc

@@ -4,7 +4,7 @@
 # development environment upon cd'ing into the directory
 
 # First we specify our desired <ruby>[@<gemset>], the @gemset name is optional.
-environment_id="ruby-1.9.2-p290@table_print"
+environment_id="ruby-1.8.7-p358"
 
 #
 # Uncomment the following lines if you want to verify rvm version per project

data/.travis.yml

@@ -3,3 +3,8 @@ rvm:
   - 1.8.7
   - 1.9.2
   - 1.9.3
+  - jruby-18mode
+  - jruby-19mode
+  - rbx-18mode
+  - rbx-19mode
+  - ree

data/Gemfile

@@ -1,13 +1,14 @@
-source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
+source :rubygems
+
+gemspec :name => 'table_print'
+
+gem 'bundler', "~> 1.1"
 
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
 group :development do
-  gem "shoulda", ">= 0"
-  gem "bundler", "~> 1.0.0"
-  gem "jeweler", "~> 1.5.2"
-  gem "rcov", ">= 0"
+  gem 'relish'
 end
+
+group :test do
+  gem 'cat', "~> 0.2.1"
+end
+

data/README.rdoc

@@ -1,5 +1,8 @@
 = table_print
 
+{<img src="https://secure.travis-ci.org/arches/table_print.png" />}[http://travis-ci.org/arches/table_print]
+
+
 Turn objects into nicely formatted columns for easy reading
 
 TablePrint formats an object or array of objects into columns for easy reading. To do this,
@@ -19,15 +22,16 @@ it assumes the objects in your array all respond to the same methods.
   # Outside rails
   $ irb
   > require 'table_print'
-  > tp array_of_objects, options = {}
+  > tp array_of_objects, options
 
   # Inside rails, the gem has already been required by your Gemfile so all you need to do is
   $ rails c
-  > tp array_of_objects, options = {}
+  > tp array_of_objects, options
 
 You should see something like this:
 
-  NAME              | SUMMARY                         | TITLE
+  > tp Book.all
+  AUTHOR            | SUMMARY                         | TITLE
   -----------------------------------------------------------------------
   Michael Connelly  | Another book by Michael Con...  | The Fifth Witness
   Manning Mardale   | From acclaimed historian Ma...  | Malcolm X
@@ -35,63 +39,112 @@ You should see something like this:
 
 TablePrint tries to use sensible defaults to choose the columns to show. If you're inspecting ActiveRecord objects, it
 uses the ActiveRecord column names. You can customize the output to show fewer columns, or show other methods you've written
-on your model.
+on your model. Use symbols or strings to reference the columns.
 
-  # Maybe you story a user's hourly rate but you want to see their yearly income
-  > tp User.limit(30), {:include => :yearly_income, :except => :hourly_rate}
+  # Maybe you store a user's hourly rate but you want to see their yearly income
+  tp User.limit(30), :include => :yearly_income, :except => :hourly_rate
 
   # Maybe all you care about is their mailing info
-  > tp User.limit(30), {:only => [:address, :city, :state, :zip]}
+  tp User.limit(30), :address, 'city', 'state', :zip
 
-If you're not using ActiveRecord, the TablePrint default is to show all the methods on your object. Thus, the <b>:include</b>
-option is useless at the moment. You are still able to use <b>:only</b> and <b>:except</b>.
+If you're not using ActiveRecord, the TablePrint default is to show all the methods defined directly on your object (nothing
+from superclasses/mixins).
 
 You can reference nested objects with the method chain required to reach them. Say you had some users who wrote books, and those
 books had photos.
 
-  > tp array_of_objects, :only => ["name", "books.title", "books.photos.caption"]
-
-  NAME              | BOOKS > TITLE     | BOOKS > PHOTOS > CAPTION
+  > tp Author.limit(3), "name", "books.title", "books.photos.caption"
+  NAME              | BOOKS.TITLE       | BOOKS.PHOTOS.CAPTION
   -------------------------------------------------------------------------
-  Michael Connelly  |                   |
-                    | The Fifth Witness |
-                    |                   | Susan was running, fast, away...
+  Michael Connelly  | The Fifth Witness | Susan was running, fast, away...
                     |                   | Along came a spider.
                     | Malcolm X         |
-                    | Bossypants        |
-                    |                   | Yes! Yes! A thousand times ye...
+                    | Bossypants        | Yes! Yes! A thousand times ye...
                     |                   | Don't see many like you aroun...
   Carrot Top        |                   |
-  Milton Greene     |                   |
-                    | How I Learned     |
-                    |                   | Once upon a time, I was a sma...
+  Milton Greene     | How I Learned     | Once upon a time, I was a sma...
                     |                   | Lemons are yellow, limes are ...
                     |                   | Never as a woman her age. I l...
-                    | Desperados        |
-                    |                   | Avast.
+                    | Desperados        | Avast.
                     |                   | Giraffes lived a peaceful exi...
 
 
 === Column options
 
 Pass options to individual columns through the options hash by using the display method as the hash key. Eg, if you wanted
-to rename the <b>pay_rate</b> column to <b>Special User Payment Teir</b>,
+a skinny email column, set the width explicitly:
+
+  tp User.all, :email => {:width => 12}
+
+Available column options:
+
+* *display_method* - string/symbol/proc - used to populate the column. Can be a method name or a proc. See below.
+* *formatters* - array of objects - each will be called in turn as the cells are printed. Must define a 'format' method. See below.
+* *time_format* - string - passed to strftime[http://www.ruby-doc.org/core-1.9.3/Time.html#method-i-strftime], only affects time columns
+* *width* - integer - how wide you want your column. Currently cannot exceed max_width.
+
+==== Display method
+
+Columns are named after hash keys. To rename a column, use the name you want as the key, and pass the method as an option.
+
+  tp User.all, :active => {:display_method => :active_in_the_past_six_months} # the User class defines active_in_the_past_six_months method
+
+==== Lambdas
+
+You can pass a proc as the display_method for a column:
 
-  tp User.all, :pay_rate => {:name => "Special User Payment Teir"}
+  tp User.all, :email, :monthly_payment, :yearly_payment => lambda{|u| u.monthly_payment * 12}
 
-Columns have other options, including:
+Or if you want to pass other options along with the lambda:
 
-<b>name</b>: Use this in the column header instead of the name of the display method.
+  tp User.all, :yearly_payment => {:display_method => lambda{|u| u.monthly_payment * 12}, :width => 10}
 
-<b>max_field_length:</b> <i>(default: 30)</i> Field lengths are determined based on the data in the column. Setting your own max
-will ensure that the column is as skinny as possible, but never above the number you provide.
+==== Column formatters
 
-<b>field_length:</b> Useful for very large data sets, this option will explicitly set the column width regardless of the data
-it contains. The max_field_length option takes precedence over field_length - ie, field_length can't be longer than max_field_length.
+Similar to a lambda column, you can use a column formatter to reuse code across prints. Any object with a 'format' method
+can be used to filter a column. This could also be used for coloring output.
 
+  class NoNewlineFormatter
+    def format(value)
+      value.to_s.gsub(/\r\n/, " ")
+    end
+  end
+
+  tp User.all, :bio => {:formatters => [NoNewlineFormatter.new]} # strip newlines from user bios
+
+
+=== Config
+
+Use `tp.set` and `tp.clear` to set options on a class-by-class basis.
+
+  tp.set User, :id, :email # now whenever you print users, the only columns shown will be id and email
+  
+  > tp User.first
+  ID | EMAIL
+  ----------------
+  1  | foo@bar.com
+
+  # the config sets a 'baseline' for each print. You can still include/except columns:
+  > tp User.first, :except => :email
+  ID
+  --
+  17
+
+  # you can still provide a specific set of columns:
+  > tp User.first, :first_name
+  FIRST_NAME
+  ----------
+  Phooey
+
+  tp.clear User # back to square one - print all the columns we can find
+
+You can also set individual options:
+
+  tp.set :max_width, 10 # columns won't exceed 10 characters
+  tp.set :time_format, "%Y" # date columns will only show the year
 
 == Contributing to table_print
- 
+
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
 * Fork the project
@@ -102,5 +155,5 @@ it contains. The max_field_length option takes precedence over field_length - ie
 
 == Copyright
 
-Copyright (c) 2011 Chris Doyle. See LICENSE.txt for further details.
+Copyright (c) 2012 Chris Doyle. See LICENSE.txt for further details.
 

data/Rakefile

@@ -22,25 +22,25 @@ Jeweler::Tasks.new do |gem|
   # Include your dependencies below. Runtime dependencies are required when using your gem,
   # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
   #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
-  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'cucumber'
 end
 Jeweler::RubygemsDotOrgTasks.new
 
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.test_files = Dir.glob("test/**/test_*.rb")
-  test.verbose = true
-end
+require 'rspec/core/rake_task'
+
+desc 'Default: run specs and cucumber features.'
+task :default => [:spec, :cucumber]
 
-require 'rcov/rcovtask'
-Rcov::RcovTask.new do |test|
-  test.libs << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
 end
 
-task :default => :test
+require "cucumber/rake/task"
+desc 'Run cucumber features'
+Cucumber::Rake::Task.new(:cucumber) do |task|
+  task.cucumber_opts = ["features"]
+end
 
 begin
   require 'rdoc/task'

data/VERSION

@@ -1 +1 @@
-0.2.3
+1.0.0.rc3

data/features/adding_columns.feature

@@ -0,0 +1,48 @@
+Feature: Adding columns
+  Scenario: With the :include option
+    Given a class named Foo
+    Given Foo has attributes herp, blog
+
+    Given a class named Foo::Blog
+    Given Foo::Blog has attributes title, author
+    Given Foo::Blog has a class method named foo with lambda{"just testing!"}
+    Given Foo::Blog has a method named two_args with lambda{|a, b| "Called with #{a}, #{b}"}
+
+    When I instantiate a Foo with {:herp => "derp"}
+    When I instantiate a Foo::Blog with {:title => "post!", :author => 'Ryan'} and assign it to foo.blog
+    And table_print Foo, {:include => ["blog.author", "blog.title"]}
+    Then the output should contain
+    """
+    HERP | BLOG.AUTHOR | BLOG.TITLE
+    -------------------------------
+    derp | Ryan        | post!
+    """
+
+  Scenario: Providing a named proc
+    Given a class named Blog
+
+    Given Blog has attributes title, author
+
+    When I instantiate a Blog with {:title => "post!", :author => 'Ryan'}
+    And table_print Blog, {:wombat => {:display_method => lambda{|blog| blog.author.gsub(/[aeiou]/, "").downcase}}}
+    Then the output should contain
+    """
+    WOMBAT
+    ------
+    ryn
+    """
+  Scenario: Providing a named proc without saying 'display_method', eg :foo => lambda{}
+    Given a class named Blog
+
+    Given Blog has attributes title, author
+
+    When I instantiate a Blog with {:title => "post!", :author => 'Ryan'}
+    And table_print Blog, {:wombat => lambda{|blog| blog.author.gsub(/[aeiou]/, "").downcase}}
+    Then the output should contain
+    """
+    WOMBAT
+    ------
+    ryn
+    """
+  Scenario: Using a proc as a filter (ie, overriding an existing column with a proc)
+

data/features/configuring_output.feature

@@ -0,0 +1,57 @@
+Feature: Configuring output
+  Scenario: Setting a (max? or specific?) width for all columns
+  Scenario: Setting a specific width for an individual column
+    Given a class named Blog
+
+    Given Blog has attributes title, author
+
+    When I instantiate a Blog with {:title => "post!", :author => 'Ryan'}
+    And table_print Blog, {:include => {:author => {:width => 10}}}
+    Then the output should contain
+    """
+    TITLE | AUTHOR    
+    ------------------
+    post! | Ryan
+    """
+  Scenario: Specifying configuration on a per-object basis
+    Given a class named Blog
+
+    Given Blog has attributes title, author
+
+    When I instantiate a Blog with {:title => "post!", :author => 'Ryan'}
+    And configure Blog with :title
+    And table_print Blog
+    Then the output should contain
+    """
+    TITLE
+    -----
+    post!
+    """
+  Scenario: Specifying configuration on a per-object basis with an included column
+    Given a class named Blog
+
+    Given Blog has attributes title, author
+
+    When I instantiate a Blog with {:title => "post!", :author => 'Ryan'}
+    And configure Blog with {:include => {:foobar => lambda{|b| b.title}}}
+    And table_print Blog
+    Then the output should contain
+    """
+    TITLE | AUTHOR | FOOBAR
+    -----------------------
+    post! | Ryan   | post!
+    """
+  Scenario: Applying a formatter
+  Scenario: Setting a column name
+    Given a class named Blog
+
+    Given Blog has attributes title, author
+
+    When I instantiate a Blog with {:title => "post!", :author => 'Ryan'}
+    And table_print Blog, {:wombat => {:display_method => :author}}
+    Then the output should contain
+    """
+    WOMBAT
+    ------
+    Ryan
+    """

data/features/excluding_columns.feature

@@ -0,0 +1,28 @@
+Feature: Excluding columns
+  Scenario: With the :except option
+    Given a class named Blog
+
+    Given Blog has attributes title, author
+
+    When I instantiate a Blog with {:title => "post!", :author => 'Ryan'}
+    And table_print Blog, {:except => :title}
+    Then the output should contain
+    """
+    AUTHOR
+    ------
+    Ryan
+    """
+
+  Scenario: By specifying columns
+    Given a class named Blog
+
+    Given Blog has attributes title, author, url
+
+    When I instantiate a Blog with {:title => "post!", :author => 'Ryan', :url => "http://google.com"}
+    And table_print Blog, [:author, :url]
+    Then the output should contain
+    """
+    AUTHOR | URL              
+    --------------------------
+    Ryan   | http://google.com
+    """

data/features/sensible_defaults.feature

@@ -0,0 +1,86 @@
+Feature: Sensible defaults
+
+  By default, table_print shows all "getter" methods defined on your object itself. This includes anything except:
+
+  * Methods defined in an object's parent class
+  * Methods defined in an object's included modules
+  * Methods whose name ends with an equals sign (ie, setter methods)
+  * Methods with an arity > 0 (ie, methods that take arguments)
+
+  Scenario: A simple object
+    Given a class named Foo
+    Given Foo has attributes herp
+    Given Foo has a method named derp with lambda{"hurrrrr"}
+
+    Given a class named Foo::Blog
+    Given Foo::Blog has attributes title, author
+    Given Foo::Blog has a class method named foo with lambda{"just testing!"}
+    Given Foo::Blog has a method named two_args with lambda{|a, b| "Called with #{a}, #{b}"}
+
+    When I instantiate a Foo::Blog with {:title => "First post!", :author => 'Ryan'}
+    And table_print Foo::Blog
+    Then the output should contain
+    """
+    TITLE       | AUTHOR
+    --------------------
+    First post! | Ryan
+    """
+
+  Scenario: An array of objects
+    Given a class named Post
+    Given Post has attributes title, author
+    Given Post has a class method named foo with lambda{"just testing!"}
+    Given Post has a method named two_args with lambda{|a, b| "Called with #{a}, #{b}"}
+
+    Given a class named Blog
+    Given Blog has attributes posts
+    
+    When I instantiate a Blog with {:posts => []}
+    When I instantiate a Post with {:title => "First post!", :author => 'Ryan'} and add it to blog.posts
+    When I instantiate a Post with {:title => "Second post!", :author => 'Ryan'} and add it to blog.posts
+    When I instantiate a Post with {:title => "Third post!", :author => 'Ryan'} and add it to blog.posts
+    And table_print blog.posts
+    Then the output should contain
+    """
+    TITLE        | AUTHOR
+    ---------------------
+    First post!  | Ryan  
+    Second post! | Ryan  
+    Third post!  | Ryan
+    """
+
+  Scenario: Nested objects
+    Given a class named Comment
+    Given Comment has attributes id, username, body
+
+    Given a class named Blog
+    Given Blog has attributes id, comments
+
+    Given I instantiate a Blog with {:id => 1, :comments => []}
+    And I instantiate a Comment with {:id => 1, :username => 'chris', :body => 'once upon a time'} and add it to blog.comments
+    And I instantiate a Comment with {:id => 2, :username => 'joe', :body => 'once upon a time'} and add it to blog.comments
+    When I table_print Blog, [:id, "comments.id", "comments.username"]
+    Then the output should contain
+    """
+    ID | COMMENTS.ID | COMMENTS.USERNAME
+    ------------------------------------
+    1  | 1           | chris            
+       | 2           | joe
+    """
+
+  Scenario: An object with column info (like an ActiveRecord object)
+    Given a class named ColumnInfo
+    Given ColumnInfo has attributes name
+    
+    Given a class named Blog
+    Given Blog has attributes title, author
+    Given Blog has a class method named columns with lambda{[Sandbox::ColumnInfo.new(:name => :title)]}
+
+    When I instantiate a Blog with {:title => "First post!", :author => 'Ryan'}
+    And table_print Blog
+    Then the output should contain
+    """
+    TITLE      
+    -----------
+    First post!
+    """