table_print 0.1.1 → 0.1.2

data/README.rdoc

@@ -46,6 +46,24 @@ on your model.
 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>.
 
+=== 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>,
+
+  tp User.all, :pay_rate => {:name => "Special User Payment Teir"}
+
+Columns have other options, including:
+
+<b>name</b>: Use this in the column header instead of the name of the display method.
+
+<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.
+
+<b>field_length:</b> Useful for very large data sets, this option will explicitly set the column width regardless of the data
+it contains.
+
+
 == 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

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/lib/table_print.rb

@@ -13,6 +13,16 @@
 
 class TablePrint
 
+  OBJECT_CLASSES = [String, Bignum, Regexp, ThreadError, Numeric, SystemStackError, IndexError,
+                    SecurityError, SizedQueue, IO, Range, Object, Exception, NoMethodError, TypeError, Integer, Dir,
+                    ZeroDivisionError, Kernel, RegexpError, SystemExit, NotImplementedError, Hash,
+                    Interrupt, SyntaxError, Enumerable, Struct, Class, Continuation, IOError, Proc,
+                    RangeError, Data, Thread, Array, NoMemoryError, Time, MatchData,
+                    ConditionVariable, Method, Mutex, StopIteration, Comparable, ArgumentError, Float,
+                    FloatDomainError, UnboundMethod, ThreadGroup, Precision, RuntimeError, FalseClass, Fixnum, Queue,
+                    StandardError, EOFError, LoadError, NameError, NilClass, TrueClass, MatchingData,
+                    LocalJumpError, Binding, SignalException, SystemCallError, File, ScriptError, Module, Symbol]
+
   # TODO: make options for things like MAX_FIELD_LENGTH
   # TODO: make options for things like separator
   # TODO: make options for things like column order
@@ -24,9 +34,6 @@ 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."
@@ -45,7 +52,7 @@ class TablePrint
     # TODO: don't check field length on fixed-width columns
 
     # make columns for all the display methods
-    columns = display_methods.collect { |m| Column.new(data, m, options[:column_options][m]) }
+    columns = display_methods.collect { |m| Column.new(data, m, options[m] || options[m.to_sym]) }
 
     output = [] # a list of rows.  we'll join this with newlines when we're done
 
@@ -131,7 +138,13 @@ class TablePrint
     return [] if [Float, Fixnum, String, Numeric, Array, Hash].include? data_obj.class
 
     # custom class
-    methods = data_obj.class.instance_methods - Object.instance_methods
+    methods = data_obj.class.instance_methods
+    OBJECT_CLASSES.each do |oclass|
+      if data_obj.is_a? oclass
+        methods = methods - oclass.instance_methods  # we're only interested in custom methods, not ruby core methods
+      end
+    end
+
     methods.delete_if { |m| m[-1].chr == "=" } # don't use assignment methods
     methods.map! { |m| m.to_s } # make any symbols into strings
     methods
@@ -164,12 +177,14 @@ class TablePrint
     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.options = options || {}    # could have been passed an explicit nil
       self.display_method = display_method
-      self.name = options[:name] || display_method.gsub("_", " ")
-      self.max_field_length = options[:max_field_length] || 30
+      self.name = self.options[:name] || display_method.gsub("_", " ")
+      self.max_field_length = self.options[:max_field_length] || 30
       self.max_field_length = [self.max_field_length, 1].max  # numbers less than one are meaningless
+
+      # initialization
+      self.initialize_field_length(data)
     end
 
     def formatted_header
@@ -180,24 +195,34 @@ class TablePrint
       "%-#{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
+    def initialize_field_length(data)
+      # skip all this nonsense if we've been explicitly told what to do
+      if self.options[:field_length] and self.options[:field_length] > 0
+        length = self.options[:field_length]
+      else
+        length = self.name.length # it has to at least be long enough for the column header!
+
+        start = Time.now
+        data.each do |data_obj|
+          next if data_obj.nil?
+
+          # fixed-width fields don't require the full loop
+          case data_obj.send(self.display_method)
+            when Time
+              length = data_obj.send(self.display_method).to_s.length
+              break
+            when TrueClass, FalseClass
+              length = [5, length].max
+              break
+          end
+
+          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
+          break if (Time.now - start) > 2 # assume if we loop for more than 2s that we've made it through a representative sample, and bail
+        end
       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
+      self.field_length = [length, self.max_field_length].min   # never bigger than the max
     end
 
     private
@@ -223,3 +248,5 @@ module Kernel
 
   module_function :tp
 end
+
+

data/table_print.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{table_print}
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   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.date = %q{2011-04-17}
   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 = [

data/test/test_column.rb

@@ -17,23 +17,57 @@ class TestTablePrint < Test::Unit::TestCase
   context 'Instantiating a Column' do
     context 'with a display_method' do
       setup do
-        @column = TablePrint::Column.new([], "display_method_name")
+        @column = TablePrint::Column.new([], "to_s")
       end
       should 'remember the display method' do
-        assert_equal "display_method_name", @column.display_method
+        assert_equal "to_s", @column.display_method
       end
       should 'set the name' do
-        assert_equal "display method name", @column.name
+        assert_equal "to s", @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"})
+    context 'with options including' do
+      context 'name' do
+        setup do
+          @column = TablePrint::Column.new([], "first", {:name => "test_tube"})
+        end
+
+        should 'set the name according to the options' do
+          assert_equal "test_tube", @column.name
+        end
       end
 
-      should 'set the name according to the options' do
-        assert_equal "test_tube", @column.name
+      context 'a field_length' do
+        context 'that is valid' do
+          setup do
+            @column = TablePrint::Column.new(["short"], "first", {:field_length => 20})
+          end
+
+          should 'set the field length according to the options' do
+            assert_equal 20, @column.field_length
+          end
+        end
+
+        context 'that is less than 1' do
+          setup do
+            @column = TablePrint::Column.new(["short"], "first", {:field_length => 0})
+          end
+
+          should 'ignore the field_length' do
+            assert_equal 5, @column.field_length
+          end
+        end
+
+        context 'that is bigger than the max' do
+          setup do
+            @column = TablePrint::Column.new(["short"], "first", {:field_length => 20, :max_field_length => 10})
+          end
+
+          should 'respect the max_field_length' do
+            assert_equal 10, @column.field_length
+          end
+        end
       end
     end
   end
@@ -89,6 +123,13 @@ class TestTablePrint < Test::Unit::TestCase
         assert_equal 5, TablePrint::Column.new([[false]], "first", :name => "dur").field_length
       end
     end
+
+    context 'when the column is boolean and the data is not the limiting factor' do
+      should 'be the column name length' do
+        assert_equal 7, TablePrint::Column.new([[true]], "unshift").field_length
+        assert_equal 8, TablePrint::Column.new([[false]], "unshift", :name => "durables").field_length
+      end
+    end
   end
 
 end

data/test/test_table_print.rb

@@ -60,6 +60,18 @@ class ManyMethods
   end
 end
 
+class StringInheritor < String
+  attr_accessor :title
+end
+
+class ArrayInheritor < Array
+  attr_accessor :title
+end
+
+class HashInheritor < Hash
+  attr_accessor :title
+end
+
 class TestTablePrint < Test::Unit::TestCase
 
   # TODO: active record tests if defined?(ActiveRecord)
@@ -104,6 +116,22 @@ class TestTablePrint < Test::Unit::TestCase
       should 'only be the attr setter' do
         assert_equal ["title"], @tp._get_default_display_methods(OneAttrAccessor.new)
       end
+      
+      context 'that subclasses Hash' do
+        should 'only be the attr setter' do
+          assert_equal ["title"], @tp._get_default_display_methods(HashInheritor.new)
+        end
+      end
+      context 'that subclasses Array' do
+        should 'only be the attr setter' do
+          assert_equal ["title"], @tp._get_default_display_methods(ArrayInheritor.new)
+        end
+      end
+      context 'that subclasses String' do
+        should 'only be the attr setter' do
+          assert_equal ["title"], @tp._get_default_display_methods(StringInheritor.new)
+        end
+      end
     end
 
     context 'The display methods for a custom class using the :only option' do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: table_print
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 31
   prerelease: 
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Chris Doyle
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-13 00:00:00 -07:00
+date: 2011-04-17 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency