table_print 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# 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"
+end

data/Gemfile.lock

@@ -0,0 +1,20 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rcov (0.9.9)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  rcov
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Chris Doyle
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,62 @@
+= 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,
+it assumes the objects in your array all respond to the same methods.
+
+== Installation
+
+  # Install as a standalone gem
+  $ gem install table_print
+
+  # Install within rails
+  In your Gemfile: gem 'table_print'
+  $ bundle install
+
+== Usage
+
+  # Outside rails
+  $ irb
+  > require 'table_print'
+  > 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 = {}
+
+And you should see something like this:
+
+  NAME              | SUMMARY                         | TITLE
+  -----------------------------------------------------------------------
+  Michael Connelly  | Another book by Michael Con...  | The Fifth Witness
+  Manning Mardale   | From acclaimed historian Ma...  | Malcolm X
+  Tina Fey          | Worth it. -Trees                | Bossypants
+
+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.
+
+  # 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 all you care about is their mailing info
+  > tp User.limit(30), {:only => [: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>:include</b>.
+
+== 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
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests 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 history. 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.
+
+== Copyright
+
+Copyright (c) 2011 Chris Doyle. See LICENSE.txt for further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "table_print"
+  gem.homepage = "http://github.com/arches/table_print"
+  gem.license = "MIT"
+  gem.summary = %Q{Turn objects into nicely formatted columns for easy reading}
+  gem.description = %Q{TablePrint formats an object or array of objects into columns for easy reading. To do this, it assumes the objects in your array all respond to the same methods (vs pretty_print or awesome_print, who can't create columns because your objects could be entirely different).}
+  gem.email = "archslide@gmail.com"
+  gem.authors = ["Chris Doyle"]
+  # 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'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "table_print #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/table_print.rb

@@ -0,0 +1,187 @@
+# future work:
+#
+#   handle multi-level includes like 'tp User.all, :include => "blogs.title"' and ActiveRecord associations
+#   allow other output venues besides 'puts'
+#   allow fine-grained formatting
+#
+# bugs
+#
+#   handle multibyte (see https://skitch.com/arches/r3cbg/multibyte-bug)
+
+class TablePrint
+
+  MAX_FIELD_LENGTH = 30
+
+  # TODO: make options for things like MAX_FIELD_LENGTH
+  # TODO: make options for things like separator
+  # TODO: make options for things like column order
+  def initialize(options = {})
+  end
+
+  # TODO: show documentation if invoked with no arguments
+  # TODO: use *args instead of options
+  def tp(data, options = {})
+    data = wrap(data).compact
+
+    # nothing to see here
+    if data.empty?
+      return "No data."
+    end
+
+    separator = "  | "
+
+    display_methods = get_display_methods(data.first, options)
+    unless display_methods.length > 0
+      return data.inspect.to_s
+    end
+
+    # we're going to load all the data into memory so we can calculate field lengths.
+    # TODO: there has to be a better way than loading everything into memory
+    # TODO: stop checking field length once we hit the max
+    # TODO: don't check field length on fixed-width columns
+
+    field_lengths = {}
+
+    # column headers
+    display_methods.each do |m|
+      field_lengths[m] = m.to_s.length
+    end
+
+    data.each do |obj|
+      display_methods.each do |m|
+        field_value = truncate(obj.send(m).to_s)
+        field_lengths[m] = [field_lengths[m], field_value.length].max
+      end
+    end
+
+    output = []
+
+    row = []
+    display_methods.each do |m|
+      field_value = truncate(m.to_s)
+      field_length = field_lengths[m]
+      row << ("%-#{field_length}s" % field_value.upcase)
+    end
+    output << row.join(separator)
+    output << ("-" * row.join(separator).length)
+
+    data.each do |obj|
+      row = []
+      display_methods.each do |m|
+        field_value = truncate(obj.send(m).to_s)
+        field_length = field_lengths[m]
+        row << ("%-#{field_length}s" % field_value)
+      end
+      output << row.join(separator)
+    end
+
+    output.join("\n")
+  end
+
+  private
+
+  def truncate(field_value)
+    if field_value.length > MAX_FIELD_LENGTH
+      field_value = field_value[0..MAX_FIELD_LENGTH-1]
+      field_value[-3..-1] = "..."
+    end
+    field_value
+  end
+
+  def get_display_methods(data_obj, options)
+    # determine what methods we're going to use
+
+    # using options:
+    # TODO: maybe rename these a little? cascade/include are somewhat mixed with respect to rails lexicon
+    #   :except - use the default set of methods but NOT the ones passed here
+    #   :include - use the default set of methods AND the ones passed here
+    #   :only - discard the default set of methods in favor of this list
+    #   :cascade -
+    #
+    # eg
+    #
+    # tp User.limit(30) # default to using AR columns
+    # tp User.limit(30) :except => :display_name
+    # tp User.limit(30) :except => [:display_name, :created_at]
+    # tp User.limit(30) :except => [:display_name, :timestamps] # a rails convention - but this could just be a type-based filter instead of method-based?
+    # tp User.limit(30) :include => :status     # not an AR column
+    # tp User.limit(30) :except => :display_name
+    # tp User.limit(30) :except => :display_name
+    # tp User.limit(30) :except => :display_name
+    # tp User.limit(30) :except => :display_name
+    #
+    # tp User.include(:blogs).limit(30) :cascade => :blog
+    # tp User.limit(30) :include => "blog.title"  # use dot notation to traverse children
+    # TODO: how to handle multiple children? eg, a user has fifteen blogs
+    #
+    # tp [myClassInstance1, ...]  # default to using non-base methods
+    # tp [myClassInstance1, ...] :except => :blah
+    # tp [myClassInstance1, ...] :except => [:blah, :blow]
+    # tp [myClassInstance1, ...] :include => :blah
+    # tp [myClassInstance1, ...] :include => [:blah, :blow]
+    # tp [myClassInstance1, ...] :include => :blah, :except => :blow
+    # tp [myClassInstance1, ...] :only => [:one, :two, :three]
+
+    if options.has_key? :only or options.has_key? "only"
+      display_methods = clean_display_methods(data_obj, wrap(options[:only]))
+      return display_methods if display_methods.length > 0
+    end
+
+    # make all the options into arrays
+    methods_to_include = clean_display_methods(data_obj, wrap(options[:include]))
+    methods_to_except = clean_display_methods(data_obj, wrap(options[:except]))
+
+    # add/remove the includes/excludes from the defaults
+    display_methods = get_default_display_methods(data_obj)
+    display_methods.concat(methods_to_include).uniq!
+    display_methods - methods_to_except
+  end
+
+  def get_default_display_methods(data_obj)
+    # ActiveRecord
+    return data_obj.class.columns.collect { |c| c.name } if defined?(ActiveRecord) and data_obj.is_a? ActiveRecord::Base
+
+    # base types
+    # TODO: fill out this list. any way to get this programatically? do we actually want to filter out all base ruby types? important question for custom classes inheriting from base types
+    return [] if [Float, Fixnum, String, Numeric, Array, Hash].include? data_obj.class
+
+    # custom class
+    methods = data_obj.class.instance_methods - Object.instance_methods
+    methods.delete_if { |m| m[-1].chr == "=" } # don't use assignment methods
+    methods.map! { |m| m.to_s } # make any symbols into strings
+    methods
+  end
+
+  def clean_display_methods(data_obj, display_methods)
+    clean_methods = []
+    display_methods.each do |m|
+      next if m.nil?
+      next if m == ""
+      next unless data_obj.respond_to? m
+      clean_methods << m.to_s
+    end
+    clean_methods.uniq
+  end
+
+  # borrowed from rails
+  def wrap(object)
+    if object.nil?
+      []
+    elsif object.respond_to?(:to_ary)
+      object.to_ary
+    else
+      [object]
+    end
+  end
+end
+
+module Kernel
+  def tp(data, options = {})
+    start = Time.now
+    table_print = TablePrint.new
+    puts table_print.tp(data, options)
+    return Time.now - start
+  end
+
+  module_function :tp
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'table_print'
+
+class Test::Unit::TestCase
+end

data/test/test_table_print.rb

@@ -0,0 +1,159 @@
+require 'helper'
+
+class MyClass
+  attr_accessor :title, :name, :summary
+
+  def initialize(title, name, summary)
+    self.title = title
+    self.name = name
+    self.summary = summary
+  end
+
+  def self.setup
+    [["how to", "bert", "bertto"],
+     ["enemies", "ernie", "ernieenemies"],
+     ["a walk to forget", "big bird", "bigbirdforget"],
+     ["cookies", "cookie monster", "cookiemonstercookies"],
+     ["your mom", "the count", "thecountmom"],
+     ["fire!", "elmo", "elmofire!"],
+     ["eat your veggies", "michelle obama", "michelleobamaveggies"],
+     ["wakka wakka", "ellen degeneres", "ellendegenereswakka"],
+     ["peas and carrots", "the hulk", "thehulkcarrots"],
+     ["juan valdez", "camaro", "camaravaldez"],
+     ["fish fish fish", "alaska", "alaskafish"],
+     ["tracks", "sir toppem hat", "sirtoppemhattracks"],
+     ["smoking stacked", "thomas", "thomasstacked"],
+     ["cannes", "alpo", "alpocannes"],
+    ].collect { |a| MyClass.new(a[0], a[1], a[2]) }
+  end
+end
+
+class TablePrint
+  def _truncate(field_value)
+    truncate(field_value)
+  end
+
+  def _get_display_methods(data_obj, options)
+    get_display_methods(data_obj, options)
+  end
+
+  def _get_default_display_methods(data_obj)
+    get_default_display_methods(data_obj)
+  end
+
+  def _clean_display_methods(data_obj, display_methods)
+    clean_display_methods(data_obj, display_methods)
+  end
+end
+
+class OneMethod
+  def title
+  end
+end
+
+class OneAttrAccessor
+  attr_accessor :title
+end
+
+class ManyMethods
+  def title
+  end
+  def author
+  end
+  def summary
+  end
+end
+
+class TestTablePrint < Test::Unit::TestCase
+
+  # TODO: active record tests if defined?(ActiveRecord)
+
+  # Vaguely ordered from most to least granular
+
+  context '' do
+    setup do
+      @tp = TablePrint.new
+    end
+
+    context 'The default display methods for ruby base types' do
+      should 'be empty' do
+        assert_equal [], @tp._get_default_display_methods([])
+        assert_equal [], @tp._get_default_display_methods("")
+        assert_equal [], @tp._get_default_display_methods({})
+        assert_equal [], @tp._get_default_display_methods(10)
+        assert_equal [], @tp._get_default_display_methods(1.0)
+      end
+    end
+
+    context 'The truncate function' do
+      should 'let short strings pass through' do
+        assert_equal "asdf", @tp._truncate("asdf")
+      end
+
+      should 'truncate long strings with ellipses' do
+        assert_equal "123456789012345678901234567...", @tp._truncate("1234567890123456789012345678901234567890")
+      end
+    end
+
+    context 'The clean_display_methods function' do
+      should 'only give back valid methods' do
+        assert_equal [], @tp._clean_display_methods(ManyMethods.new, [""])
+        assert_equal [], @tp._clean_display_methods(ManyMethods.new, [nil])
+        assert_equal ["title"], @tp._clean_display_methods(ManyMethods.new, ["title"])
+        assert_equal ["title"], @tp._clean_display_methods(ManyMethods.new, [:title])
+        assert_equal ["title"], @tp._clean_display_methods(ManyMethods.new, ["title", "title"])
+        assert_equal ["title"], @tp._clean_display_methods(ManyMethods.new, ["title", :title])
+        assert_equal ["title"], @tp._clean_display_methods(ManyMethods.new, [:title, :title])
+        assert_equal ["title"], @tp._clean_display_methods(ManyMethods.new, ["title", "january1985"])
+      end
+    end
+
+    context 'The default display methods for a custom class with one method' do
+      should 'be that method' do
+        assert_equal ["title"], @tp._get_default_display_methods(OneMethod.new)
+      end
+    end
+
+    context 'The default display methods for a custom class with one attr_accessor' do
+      should 'only be the attr setter' do
+        assert_equal ["title"], @tp._get_default_display_methods(OneAttrAccessor.new)
+      end
+    end
+
+    context 'The display methods for a custom class using the :only option' do
+      should 'be an array containing the methods specified in the :only option' do
+        assert_equal ["title"], @tp._get_display_methods(ManyMethods.new, {:only => :title})
+        assert_equal ["title"], @tp._get_display_methods(ManyMethods.new, {:only => "title"})
+        assert_equal ["title"], @tp._get_display_methods(ManyMethods.new, {:only => [:title]})
+        assert_equal ["title"], @tp._get_display_methods(ManyMethods.new, {:only => ["title"]})
+      end
+    end
+
+    # The :include option is more for ActiveRecord. It will only affect custom classes once multi-level methods are implemented.
+    context 'The display methods for a custom class using the :include option' do
+      should "be the same as if it weren't used" do
+        assert_equal ["author", "summary", "title"], @tp._get_display_methods(ManyMethods.new, {:include => :title}).sort
+        assert_equal ["author", "summary", "title"], @tp._get_display_methods(ManyMethods.new, {:include => "title"}).sort
+        assert_equal ["author", "summary", "title"], @tp._get_display_methods(ManyMethods.new, {:include => [:title]}).sort
+        assert_equal ["author", "summary", "title"], @tp._get_display_methods(ManyMethods.new, {:include => ["title"]}).sort
+      end
+    end
+
+    context 'The display methods for a custom class using the :except option' do
+      should "not include any specified methods" do
+        assert_equal ["author", "summary"], @tp._get_display_methods(ManyMethods.new, {:except => :title}).sort
+        assert_equal ["author", "summary"], @tp._get_display_methods(ManyMethods.new, {:except => "title"}).sort
+        assert_equal ["author", "summary"], @tp._get_display_methods(ManyMethods.new, {:except => [:title]}).sort
+        assert_equal ["summary"], @tp._get_display_methods(ManyMethods.new, {:except => ["title", :author]}).sort
+      end
+    end
+
+    context 'An empty input' do
+      should 'say as much in the output' do
+        assert_equal "No data.", @tp.tp(nil)
+        assert_equal "No data.", @tp.tp([])
+        assert_equal "No data.", @tp.tp([nil])
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification 
+name: table_print
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Chris Doyle
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-11 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: shoulda
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  name: bundler
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  name: jeweler
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rcov
+  version_requirements: *id004
+description: TablePrint formats an object or array of objects into columns for easy reading. To do this, it assumes the objects in your array all respond to the same methods (vs pretty_print or awesome_print, who can't create columns because your objects could be entirely different).
+email: archslide@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/table_print.rb
+- test/helper.rb
+- test/test_table_print.rb
+has_rdoc: true
+homepage: http://github.com/arches/table_print
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Turn objects into nicely formatted columns for easy reading
+test_files: 
+- test/helper.rb
+- test/test_table_print.rb