table_print 0.1.0 → 0.1.1

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/table_print.rb

@@ -3,6 +3,9 @@
 #   handle multi-level includes like 'tp User.all, :include => "blogs.title"' and ActiveRecord associations
 #   allow other output venues besides 'puts'
 #   allow fine-grained formatting
+#   on-the-fly column definitions (pass a proc as an include, eg 'tp User.all, :include => {:column_name => "Zodiac", :display_method => lambda {|u| find_zodiac_sign(u.birthday)}}')
+#   allow user to pass ActiveRelation instead of a data array? That could open up so many options!
+#   a :short_booleans method could save a little space (replace true/false with T/F or 1/0)
 #
 # bugs
 #
@@ -10,8 +13,6 @@
 
 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
@@ -23,6 +24,9 @@ class TablePrint
   def tp(data, options = {})
     data = wrap(data).compact
 
+    # TODO: need to do a better job of handling options.
+    options[:column_options] ||= {}
+
     # nothing to see here
     if data.empty?
       return "No data."
@@ -40,37 +44,26 @@ class TablePrint
     # 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
+    # make columns for all the display methods
+    columns = display_methods.collect { |m| Column.new(data, m, options[:column_options][m]) }
 
-    output = []
+    output = [] # a list of rows.  we'll join this with newlines when we're done
 
+    # column headers
     row = []
-    display_methods.each do |m|
-      field_value = truncate(m.to_s)
-      field_length = field_lengths[m]
-      row << ("%-#{field_length}s" % field_value.upcase)
+    columns.each do |column|
+      row << column.formatted_header
     end
     output << row.join(separator)
+
+    # a row of hyphens to separate the headers from the data
     output << ("-" * row.join(separator).length)
 
-    data.each do |obj|
+    # the data!
+    data.each do |data_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)
+      columns.each do |column|
+        row << column.formatted_field_value(data_obj)
       end
       output << row.join(separator)
     end
@@ -80,14 +73,6 @@ class TablePrint
 
   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
 
@@ -153,6 +138,7 @@ class TablePrint
   end
 
   def clean_display_methods(data_obj, display_methods)
+    # TODO: this should probably be inside Column
     clean_methods = []
     display_methods.each do |m|
       next if m.nil?
@@ -173,6 +159,58 @@ class TablePrint
       [object]
     end
   end
+
+  class Column
+    attr_accessor :name, :display_method, :options, :data, :field_length, :max_field_length
+
+    def initialize(data, display_method, options = {})
+      options ||= {}  # could have been passed an explicit nil
+      self.data = data  # HACK? would rather not keep pointers to the data set all over the place
+      self.display_method = display_method
+      self.name = options[:name] || display_method.gsub("_", " ")
+      self.max_field_length = options[:max_field_length] || 30
+      self.max_field_length = [self.max_field_length, 1].max  # numbers less than one are meaningless
+    end
+
+    def formatted_header
+      "%-#{self.field_length}s" % truncate(self.name.upcase)
+    end
+
+    def formatted_field_value(data_obj)
+      "%-#{self.field_length}s" % truncate(data_obj.send(self.display_method).to_s)
+    end
+
+    def field_length
+      return @field_length if defined?(@field_length) # we don't want to loop every time this is called!
+
+      # fixed-width fields don't require the full loop below
+      case data.first.send(self.display_method)
+        when Time
+          return [data.first.send(self.display_method).to_s.length, self.max_field_length].min
+        when TrueClass, FalseClass
+          return 5
+      end
+
+      length = self.name.length
+      self.data.each do |data_obj|
+        length = [length, data_obj.send(self.display_method).to_s.length].max
+        break if length >= self.max_field_length # we're never going to longer than the global max, so why keep going
+      end
+      @field_length = [length, self.max_field_length].min
+      @field_length
+    end
+
+    private
+    
+    def truncate(field_value)
+      copy = String.new(field_value)
+      if copy.length > self.max_field_length
+        copy = copy[0..self.max_field_length-1]
+        copy[-3..-1] = "..." unless self.max_field_length <= 3 # don't use ellipses when the string is tiny
+      end
+      copy
+    end
+  end
 end
 
 module Kernel
@@ -180,7 +218,7 @@ module Kernel
     start = Time.now
     table_print = TablePrint.new
     puts table_print.tp(data, options)
-    return Time.now - start
+    Time.now - start
   end
 
   module_function :tp

data/table_print.gemspec

@@ -0,0 +1,65 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{table_print}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Chris Doyle"]
+  s.date = %q{2011-04-13}
+  s.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).}
+  s.email = %q{archslide@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/table_print.rb",
+    "table_print.gemspec",
+    "test/helper.rb",
+    "test/test_column.rb",
+    "test/test_table_print.rb"
+  ]
+  s.homepage = %q{http://github.com/arches/table_print}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.5.2}
+  s.summary = %q{Turn objects into nicely formatted columns for easy reading}
+  s.test_files = [
+    "test/helper.rb",
+    "test/test_column.rb",
+    "test/test_table_print.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/test/test_column.rb

@@ -0,0 +1,94 @@
+require 'helper'
+
+class TablePrint
+  class Column
+    def _truncate(field_value)
+      truncate(field_value)
+    end
+  end
+end
+
+class TestTablePrint < Test::Unit::TestCase
+
+  # TODO: active record tests if defined?(ActiveRecord)
+
+  # Vaguely ordered from most to least granular
+
+  context 'Instantiating a Column' do
+    context 'with a display_method' do
+      setup do
+        @column = TablePrint::Column.new([], "display_method_name")
+      end
+      should 'remember the display method' do
+        assert_equal "display_method_name", @column.display_method
+      end
+      should 'set the name' do
+        assert_equal "display method name", @column.name
+      end
+    end
+
+    context 'with a column name in the options' do
+      setup do
+        @column = TablePrint::Column.new([], "display_method_name", {:name => "test_tube"})
+      end
+
+      should 'set the name according to the options' do
+        assert_equal "test_tube", @column.name
+      end
+    end
+  end
+
+  context 'The truncate function' do
+    should 'let short strings pass through' do
+      assert_equal "asdf", TablePrint::Column.new([], "")._truncate("asdf")
+    end
+
+    should 'truncate long strings with ellipses' do
+      assert_equal "123456789012345678901234567...", TablePrint::Column.new([], "")._truncate("1234567890123456789012345678901234567890")
+    end
+
+    context 'when given a max length in the options' do
+      should 'truncate long strings with ellipses' do
+        assert_equal "1234567...", TablePrint::Column.new([], "", :max_field_length => 10)._truncate("1234567890123456789012345678901234567890")
+      end
+    end
+
+    context 'when the max length is tiny' do
+      should 'truncate long strings without ellipses' do
+        assert_equal "1", TablePrint::Column.new([], "", :max_field_length => -10)._truncate("1234567890123456789012345678901234567890")
+        assert_equal "1", TablePrint::Column.new([], "", :max_field_length => 0)._truncate("1234567890123456789012345678901234567890")
+        assert_equal "1", TablePrint::Column.new([], "", :max_field_length => 1)._truncate("1234567890123456789012345678901234567890")
+        assert_equal "12", TablePrint::Column.new([], "", :max_field_length => 2)._truncate("1234567890123456789012345678901234567890")
+        assert_equal "123", TablePrint::Column.new([], "", :max_field_length => 3)._truncate("1234567890123456789012345678901234567890")
+        assert_equal "1...", TablePrint::Column.new([], "", :max_field_length => 4)._truncate("1234567890123456789012345678901234567890")
+      end
+    end
+  end
+
+  context 'The field length function' do
+    should 'find the maximum width of the data' do
+      assert_equal 11, TablePrint::Column.new(["hello there"], "to_s").field_length
+    end
+
+    context 'when the data is longer than the max_field_length' do
+      should 'equal the max field length' do
+        assert_equal 5, TablePrint::Column.new(["hello there"], "to_s", :max_field_length => 5).field_length
+      end
+    end
+
+    context 'when the column name is longer than the data' do
+      should 'reflect the column name length' do
+        assert_equal 4, TablePrint::Column.new(["he"], "to_s", :max_field_length => 5).field_length
+        assert_equal 12, TablePrint::Column.new(["hello"], "to_s", :name => "foobar THIS!").field_length
+      end
+    end
+
+    context 'when the column is boolean and the data is the limiting factor' do
+      should 'always be 5' do
+        assert_equal 5, TablePrint::Column.new([[true]], "first", :name => "dur").field_length
+        assert_equal 5, TablePrint::Column.new([[false]], "first", :name => "dur").field_length
+      end
+    end
+  end
+
+end

data/test/test_table_print.rb

@@ -29,10 +29,6 @@ class MyClass
 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
@@ -85,16 +81,6 @@ class TestTablePrint < Test::Unit::TestCase
       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, [""])

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: table_print
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Chris Doyle
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-11 00:00:00 -07:00
+date: 2011-04-13 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -96,7 +96,9 @@ files:
 - Rakefile
 - VERSION
 - lib/table_print.rb
+- table_print.gemspec
 - test/helper.rb
+- test/test_column.rb
 - test/test_table_print.rb
 has_rdoc: true
 homepage: http://github.com/arches/table_print
@@ -134,4 +136,5 @@ specification_version: 3
 summary: Turn objects into nicely formatted columns for easy reading
 test_files: 
 - test/helper.rb
+- test/test_column.rb
 - test/test_table_print.rb