cldwalker-hirb 0.1.0 → 0.1.1

data/CHANGELOG.rdoc

@@ -0,0 +1,5 @@
+== 0.1.1
+* Fixed bug when rendering table with many fields.
+
+== 0.1.0
+* Initial release

data/README.rdoc

@@ -1,11 +1,11 @@
 == Description
 
 Hirb currently provides a mini view framework for console applications, designed with irb in mind.
-This framework is activated by one method, which given the output of a console application, renders
-a configured view based on the output's class. The framework encourages reusing views by letting you
-package them in classes and associate them with any number of output classes.  Hirb comes with table
-views (see Hirb::Helpers::Table) which work out of the box with any output class, especially Rails'
-model classes.
+Given the output of a console application, it renders a view if there is one configured, based on
+the output's class. The framework encourages reusing views by letting you package them in classes
+and associate them with any number of output classes.  Hirb comes with table views (see
+Hirb::Helpers::Table) which work out of the box with any output class, especially Rails' model
+classes.
 
 == Install
 
@@ -157,7 +157,7 @@ it will be automatically loaded with no configuration. Something to think about
 sharing views with others.
 
   # Create yaml view class
-  irb>> class Hirb::Views::Hash; def self.render(output); output.to_yaml; end ;end
+  irb>> class Hirb::Views::Hash; def self.render(output, options={}); output.to_yaml; end ;end
   =>nil
   # Just reload since no configuration is necessary
   irb>>Hirb::View.reload_config
@@ -169,7 +169,7 @@ often want view classes that can be reused with multiple outputs. For this case,
 use the Hirb::Helpers namespace.
   
   # Create yaml view class
-  irb>> class Hirb::Helpers::Yaml; def self.render(output); output.to_yaml; end ;end
+  irb>> class Hirb::Helpers::Yaml; def self.render(output, options={}); output.to_yaml; end ;end
   =>nil
 
   # Configure view and reload it
@@ -185,7 +185,7 @@ them at startup by passing Hirb::View.enable a block:
   # In .irbrc
   require 'hirb'
   # View class needs to come before enable()
-  class Hirb::Helpers::Yaml; def self.render(output); output.to_yaml; end ;end
+  class Hirb::Helpers::Yaml; def self.render(output, options={}); output.to_yaml; end ;end
   Hirb::View.enable {|conf| conf.output = {"Hash"=>{:class=>"Hirb::Helpers::Yaml"}} }
   
 Or by creating a config file at config/hirb.yml or ~/.hirb.yml:
@@ -199,15 +199,26 @@ Or by creating a config file at config/hirb.yml or ~/.hirb.yml:
   # In .irbrc
   require 'hirb'
   # View class needs to come before enable()
-  class Hirb::Helpers::Yaml; def self.render(output); output.to_yaml; end ;end
+  class Hirb::Helpers::Yaml; def self.render(output, options={}); output.to_yaml; end ;end
   Hirb::View.enable
 
+== Contributing Views
+If you have views of your own you'd like to share, fork Hirb and put your views under
+the Hirb::Helpers namespace and the view files under lib/hirb/helpers/.
+
 == Limitations
 Although Hirb preserves Wirble colorizing irb's default echo mode, it doesn't colorize its own views.
 This is mainly because colorizing caused table classes to render incorrectly. If you can get tables
 and colors to work nicely, please fork. To colorize your Hirb output:
   Hirb::View.render_method = lambda {|output| puts Wirble::Colorize.colorize(output) }
 
+== Motivation
+Table code from http://gist.github.com/72234 and {my console
+app}[http://github.com/cldwalker/tag-tree].
+
+== Links
+* http://tagaholic.me/2009/03/13/hirb-irb-on-the-good-stuff.html
+
 == Todo
 * Create tree views.
 * Possibly add non-view irb goodies ie command manager.

data/Rakefile

@@ -25,7 +25,7 @@ begin
     s.authors = ["Gabriel Horner"]
     s.has_rdoc = true
     s.extra_rdoc_files = ["README.rdoc", "LICENSE.txt"]
-    s.files = FileList["Rakefile", "VERSION.yml", "README.rdoc", "LICENSE.txt", "{bin,lib,test}/**/*"]
+    s.files = FileList["[A-Z]*", "{bin,lib,test}/**/*"]
   end
 
 rescue LoadError

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 0
 :minor: 1
-:patch: 0
+:patch: 1

data/lib/hirb/helpers/active_record_table.rb

@@ -10,7 +10,7 @@ class Hirb::Helpers::ActiveRecordTable < Hirb::Helpers::ObjectTable
       begin
         fields = rows.first.attribute_names
         fields.unshift(fields.delete('id')) if fields.include?('id')
-        fields
+        fields.map {|e| e.to_sym }
       end
     super(rows, options)
   end

data/lib/hirb/helpers/table.rb

@@ -26,6 +26,7 @@
 # derived from http://gist.github.com/72234
 class Hirb::Helpers::Table
   DEFAULT_MAX_WIDTH = 150
+  class TooManyFieldsForWidthError < StandardError; end
   class << self
     attr_accessor :max_width
     
@@ -38,6 +39,7 @@ class Hirb::Helpers::Table
     #                  length than it's truncated and has a ... appended to it. Fields that aren't specified here have no maximum allowed
     #                  length.
     # [:max_width] The maximum allowed width of all fields put together. This option is enforced except when the field_lengths option is set.
+    #              This doesn't count field borders as part of the total.
     # Examples:
     #    Hirb::Helpers::Table.render [[1,2], [2,3]]
     #    Hirb::Helpers::Table.render [[1,2], [2,3]], :field_lengths=>{0=>10}
@@ -99,7 +101,7 @@ class Hirb::Helpers::Table
   def format_cell(value, cell_width)
     text = value.length > cell_width ? 
       (
-      (cell_width < 3) ? value.slice(0,cell_width) : value.slice(0, cell_width - 3) + '...'
+      (cell_width < 5) ? value.slice(0,cell_width) : value.slice(0, cell_width - 3) + '...'
       ) : value
     sprintf("%-#{cell_width}s", text)
   end
@@ -122,21 +124,25 @@ class Hirb::Helpers::Table
     if @options[:field_lengths]
       @field_lengths.merge!(@options[:field_lengths])
     else
-      max_width = @options[:max_width] || Hirb::Helpers::Table.max_width || DEFAULT_MAX_WIDTH
-      restrict_field_lengths(@field_lengths, max_width)
+      table_max_width = Hirb::Helpers::Table.max_width || DEFAULT_MAX_WIDTH
+      table_max_width = @options[:max_width] if @options.has_key?(:max_width)
+      restrict_field_lengths(@field_lengths, table_max_width)
     end
   end
   
   # Simple algorithm which given a max width, allows smaller fields to be displayed while
-  # restricting longer fields at a new_long_field_length.
+  # restricting longer fields at an average_long_field_length.
   def restrict_field_lengths(field_lengths, max_width)
     total_length = field_lengths.values.inject {|t,n| t += n}
-    if total_length > max_width
+    if max_width && total_length > max_width
+      min_field_length = 3
+      raise TooManyFieldsForWidthError if @fields.size > max_width.to_f / min_field_length
       average_field_length = total_length / @fields.size.to_f
-      long_lengths, short_lengths = field_lengths.values.partition {|e| e > average_field_length}
-      new_long_field_length = (max_width - short_lengths.inject {|t,n| t += n}) / long_lengths.size
+      long_lengths = field_lengths.values.select {|e| e > average_field_length}
+      total_long_field_length = (long_lengths.inject {|t,n| t += n}) * max_width/total_length
+      average_long_field_length = total_long_field_length / long_lengths.size
       field_lengths.each {|f,length|
-        field_lengths[f] = new_long_field_length if length > new_long_field_length
+        field_lengths[f] = average_long_field_length if length > average_long_field_length
       }
     end
   end

data/lib/hirb/view.rb

@@ -41,7 +41,8 @@ module Hirb
       # and returns true. Returns false if no formatter found.
       # ==== Options:
       # [:method] Specifies a global (Kernel) method to do the formatting.
-      # [:class] Specifies a class to do the formatting, using its render() class method.
+      # [:class] Specifies a class to do the formatting, using its render() class method. The render() method's arguments are the output and 
+      #          an options hash.
       # [:options] Options to pass the formatter method or class.
       def render_output(output, options={}, &block)
         if block && block.arity > 0

data/test/table_test.rb

@@ -55,6 +55,10 @@ class Hirb::Helpers::TableTest < Test::Unit::TestCase
       table([[1,2], [3,4]]).should == expected_table
     end
     
+    test "with too many fields raises error" do
+      assert_raises(Hirb::Helpers::Table::TooManyFieldsForWidthError) { table([Array.new(70, 'AAA')]) }
+    end
+    
     test "with no rows renders" do
       table([]).should == "0 rows in set"
     end
@@ -137,27 +141,39 @@ class Hirb::Helpers::TableTest < Test::Unit::TestCase
   
     test "max_width option renders" do
       expected_table = <<-TABLE.unindent
-      +---------------------+---+------------+
-      | a                   | b | c          |
-      +---------------------+---+------------+
-      | AAAAAAAAAAAAAAAA... | 2 | CCCCCCCCCC |
-      +---------------------+---+------------+
+      +--------------------------+---+------------+
+      | a                        | b | c          |
+      +--------------------------+---+------------+
+      | AAAAAAAAAAAAAAAAAAAAA... | 2 | CCCCCCCCCC |
+      +--------------------------+---+------------+
       1 row in set
   TABLE
       table([{:a=> "A" * 50, :b=>2, :c=>"C"*10}], :max_width=>30).should == expected_table
     end
-  
+
+    test "max_width option nil renders full table" do
+      expected_table = <<-TABLE.unindent
+      +----------------------------------------------------+---+------------+
+      | a                                                  | b | c          |
+      +----------------------------------------------------+---+------------+
+      | AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA | 2 | CCCCCCCCCC |
+      +----------------------------------------------------+---+------------+
+      1 row in set
+  TABLE
+      table([{:a=> "A" * 50, :b=>2, :c=>"C"*10}], :max_width=>nil).should == expected_table
+    end
+    
     test "global max_width renders" do
       expected_table = <<-TABLE.unindent
-      +---------------------+---+------------+
-      | a                   | b | c          |
-      +---------------------+---+------------+
-      | AAAAAAAAAAAAAAAA... | 2 | CCCCCCCCCC |
-      +---------------------+---+------------+
+      +--------------------------+---+------------+
+      | a                        | b | c          |
+      +--------------------------+---+------------+
+      | AAAAAAAAAAAAAAAAAAAAA... | 2 | CCCCCCCCCC |
+      +--------------------------+---+------------+
       1 row in set
   TABLE
       Hirb::Helpers::Table.max_width = 30
-      table([{:a=> "A" * 50, :b=>2, :c=>"C"*10}]).should == expected_table    
+      table([{:a=> "A" * 50, :b=>2, :c=>"C"*10}]).should == expected_table
       Hirb::Helpers::Table.max_width = Hirb::Helpers::Table::DEFAULT_MAX_WIDTH
     end
 
@@ -239,4 +255,9 @@ class Hirb::Helpers::TableTest < Test::Unit::TestCase
       Hirb::Helpers::ActiveRecordTable.render(@pets).should == expected_table
     end
   end
+  
+  test "restrict_field_lengths handles many fields" do
+    @table = Hirb::Helpers::Table.new([{:field1=>'f1', :field2=>'f2', :field3=>'f3'}])
+    @table.restrict_field_lengths({:field1=>10, :field2=>15, :field3=>100}, 10)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: cldwalker-hirb
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Gabriel Horner
@@ -9,11 +9,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-12 00:00:00 -07:00
+date: 2009-03-15 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
-description: A mini view framework for irb that's easy to use, even while under its influence.
+description: A mini view framework for console/irb that's easy to use, even while under its influence.
 email: gabriel.horner@gmail.com
 executables: []
 
@@ -23,10 +23,11 @@ extra_rdoc_files:
 - README.rdoc
 - LICENSE.txt
 files: 
+- CHANGELOG.rdoc
+- LICENSE.txt
 - Rakefile
-- VERSION.yml
 - README.rdoc
-- LICENSE.txt
+- VERSION.yml
 - lib/hirb
 - lib/hirb/console.rb
 - lib/hirb/hash_struct.rb
@@ -74,6 +75,6 @@ rubyforge_project:
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: A mini view framework for irb that's easy to use, even while under its influence.
+summary: A mini view framework for console/irb that's easy to use, even while under its influence.
 test_files: []