hirb 0.2.7 → 0.2.8

data/CHANGELOG.rdoc

@@ -1,3 +1,10 @@
+== 0.2.8
+* Added callbacks to Hirb::Helper::Table.
+* Added :change_fields option to Hirb::Helpers::Table.
+* Added terminal size detection for jruby.
+* Bug fix for paging long outputs.
+* Bug fix to make unexpected hirb rendering errors more clear.
+
 == 0.2.7
 * 2 ruby 1.9 bug fixes.
 * Bug fix in :fields of Hirb::Helpers::ObjectTable.

data/README.rdoc

@@ -12,7 +12,7 @@ model classes as tables. Hirb also sports a nice selection menu, Hirb::Menu.
 
 Install the gem with:
 
-    sudo gem install cldwalker-hirb --source http://gems.github.com
+    sudo gem install hirb
 
 == Pager
 
@@ -151,7 +151,7 @@ app's needs}[http://github.com/cldwalker/tag-tree].
 
 == Credits
 * Chrononaut for vertical table helper.
-* crafterm and spastorino for bug fixes.
+* crafterm, spastorino and joshua for bug fixes.
 
 == Bugs/Issues
 Please report them {on github}[http://github.com/cldwalker/hirb/issues].

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 0
 :minor: 2
-:patch: 7
+:patch: 8

data/lib/hirb/helpers/active_record_table.rb

@@ -1,5 +1,5 @@
 class Hirb::Helpers::ActiveRecordTable < Hirb::Helpers::ObjectTable
-  # Rows are Rails' ActiveRecord::Base objects.
+  # Rows are Rails' ActiveRecord::Base objects. These objects should all be from one class.
   # Takes same options as Hirb::Helpers::Table.render except as noted below.
   #
   # Options:

data/lib/hirb/helpers/parent_child_tree.rb

@@ -3,21 +3,22 @@ class Hirb::Helpers::ParentChildTree < Hirb::Helpers::Tree
     # Starting with the given node, this builds a tree by recursively calling a children method.
     # Takes same options as Hirb::Helper::Table.render with some additional ones below.
     # ==== Options:
-    # [:value_method] Method to call to display as a node's value. If not given, uses :name if node
+    # [:value_method] Method or proc to call to display as a node's value. If not given, uses :name if node
     #                 responds to :name or defaults to :object_id.
     # [:children_method] Method or proc to call to obtain a node's children. Default is :children.
     def render(root_node, options={})
-      @value_method = options[:value_method] || (root_node.respond_to?(:name) ? :name : :object_id)
-      @children_method = options[:children_method] || :children
+      value_method = options[:value_method] || (root_node.respond_to?(:name) ? :name : :object_id)
+      @value_method = value_method.is_a?(Proc) ? value_method : lambda {|n| n.send(value_method) }
+      children_method = options[:children_method] || :children
+      @children_method = children_method.is_a?(Proc) ? children_method : lambda {|n| n.send(children_method)}
       @nodes = []
       build_node(root_node, 0)
       super(@nodes, options)
     end
 
     def build_node(node, level) #:nodoc:
-      @nodes << {:value=>node.send(@value_method), :level=>level}
-      children = @children_method.is_a?(Proc) ? @children_method.call(node) : node.send(@children_method)
-      children.each {|e| build_node(e, level + 1)}
+      @nodes << {:value=>@value_method.call(node), :level=>level}
+      @children_method.call(node).each {|e| build_node(e, level + 1)}
     end
   end
 end

data/lib/hirb/helpers/table.rb

@@ -42,6 +42,8 @@ module Hirb
     # [: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.
     # [:number]  When set to true, numbers rows by adding a :hirb_number column as the first column. Default is false.
+    # [:change_fields] A hash to change old field names to new field names. This is useful when wanting to change auto-generated keys to
+    #                  more user-friendly names i.e. for array of arrays.
     # [:filters] A hash of fields and the filters that each row in the field must run through. The filter converts the cell's value by applying
     #            a given proc or an array containing a method and optional arguments to it.
     # [:vertical] When set to true, renders a vertical table using Hirb::Helpers::VerticalTable. Default is false.
@@ -64,7 +66,7 @@ module Hirb
   
   #:stopdoc:
   def initialize(rows, options={})
-    @options = {:description=>true, :filters=>{}}.merge(options)
+    @options = {:description=>true, :filters=>{}, :change_fields=>{}}.merge(options)
     @fields = set_fields(rows)
     @rows = setup_rows(rows)
     @headers = @fields.inject({}) {|h,e| h[e] = e.to_s; h}
@@ -79,7 +81,7 @@ module Hirb
   end
 
   def set_fields(rows)
-    if @options[:fields]
+    fields = if @options[:fields]
       @options[:fields].dup
     else
       if rows[0].is_a?(Hash)
@@ -89,18 +91,27 @@ module Hirb
         rows[0].is_a?(Array) ? (0..rows[0].length - 1).to_a : []
       end
     end
+    @options[:change_fields].each do |oldf, newf|
+      (index = fields.index(oldf)) ? fields[index] = newf : fields << newf
+    end
+    fields
   end
 
   def setup_rows(rows)
-    rows ||= []
-    rows = [rows] unless rows.is_a?(Array)
+    rows = Array(rows)
     if rows[0].is_a?(Array)
       rows = rows.inject([]) {|new_rows, row|
         new_rows << array_to_indices_hash(row)
       }
     end
+    @options[:change_fields].each do |oldf, newf|
+      rows.each {|e| e[newf] = e.delete(oldf) if e.key?(oldf) }
+    end
     rows = filter_values(rows)
     rows.each_with_index {|e,i| e[:hirb_number] = (i + 1).to_s} if @options[:number]
+    methods.grep(/_callback$/).sort.each do |meth|
+      rows = send(meth, rows, @options.dup)
+    end
     validate_values(rows)
     rows
   end

data/lib/hirb/pager.rb

@@ -38,6 +38,7 @@ module Hirb
           save_stdout = STDOUT.clone
           STDOUT.reopen(pager)
           STDOUT.puts output
+        rescue Errno::EPIPE
         ensure
          STDOUT.reopen(save_stdout)
          save_stdout.close

data/lib/hirb/util.rb

@@ -59,8 +59,13 @@ module Hirb
     # Returns [width, height] of terminal when detected, nil if not detected.
     # Think of this as a simpler version of Highline's Highline::SystemExtensions.terminal_size()
     def detect_terminal_size
-      (ENV['COLUMNS'] =~ /^\d+$/) && (ENV['LINES'] =~ /^\d+$/) ? [ENV['COLUMNS'].to_i, ENV['LINES'].to_i] :
-        ( command_exists?('stty') ? `stty size`.scan(/\d+/).map { |s| s.to_i }.reverse : nil )
+      if (ENV['COLUMNS'] =~ /^\d+$/) && (ENV['LINES'] =~ /^\d+$/)
+        [ENV['COLUMNS'].to_i, ENV['LINES'].to_i]
+      elsif RUBY_PLATFORM =~ /java/ && command_exists?('tput')
+        [`tput cols`.to_i, `tput lines`.to_i]
+      else
+        command_exists?('stty') ? `stty size`.scan(/\d+/).map { |s| s.to_i }.reverse : nil
+      end
     rescue
       nil
     end

data/lib/hirb/view.rb

@@ -68,6 +68,10 @@ module Hirb
       # Hirb::Formatter.format_output(). Returns true if successful and false if no formatting is done or if not enabled.
       def view_output(output, options={})
         enabled? && config[:formatter] && render_output(output, options)
+      rescue Exception=>e
+        index = (obj = e.backtrace.find {|f| f =~ /^\(eval\)/}) ? e.backtrace.index(obj) : e.backtrace.length
+        $stderr.puts "Hirb Error: #{e.message}", e.backtrace.slice(0,index).map {|e| "    " + e }
+        true
       end
 
       # Captures STDOUT and renders it using render_method(). The main use case is to conditionally page captured stdout.

data/test/table_test.rb

@@ -318,8 +318,40 @@ class Hirb::Helpers::TableTest < Test::Unit::TestCase
       TABLE
       table([{:a=>1, :b=>2}, {:a=>3, :c=>4}], :all_fields=>true).should == expected_table
     end
+
+    test "change_fields option renders" do
+      expected_table = <<-TABLE.unindent
+      +------+-------+
+      | name | value |
+      +------+-------+
+      | 1    | 2     |
+      | 2    | 3     |
+      +------+-------+
+      2 rows in set
+      TABLE
+      table([[1,2],[2,3]], :change_fields=>{0=>'name', 1=>'value'}).should == expected_table
+    end
   end
   
+  test "table can detect and run callbacks" do
+    Hirb::Helpers::Table.send(:define_method, :and_one_callback) do |obj, opt|
+      obj.each {|row| row.each {|k,v| row[k] += opt[:add] } }
+      obj
+    end
+
+    expected_table = <<-TABLE.unindent
+    +---+---+
+    | a | b |
+    +---+---+
+    | 2 | 3 |
+    | 4 | 5 |
+    +---+---+
+    2 rows in set
+    TABLE
+    table([{'a'=>1, 'b'=>2}, {'a'=>3, 'b'=>4}], :add=>1).should == expected_table
+    Hirb::Helpers::Table.send(:remove_method, :and_one_callback)
+  end
+
   test "restrict_field_lengths ensures columns total doesn't exceed max width" do
     @table = Hirb::Helpers::Table.new([{:f1=>'f1', :f2=>'2', :f3=>'3', :f4=>'4'}])
     field_lengths = {:f1=>135, :f2=>45, :f3=>4, :f4=>55}

data/test/view_test.rb

@@ -22,6 +22,13 @@ module Hirb
       View.page_output('blah').should be(false)
     end
 
+    test "view_output catches unexpected errors and prints them" do
+      Hirb.enable
+      View.expects(:render_output).raises('blah')
+      capture_stderr { View.view_output([1,2,3]) }.should =~ /Hirb Error: blah/
+      Hirb.disable
+    end
+
     context "enable" do
       before(:each) { reset_config }
       after(:each) { Hirb.disable }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: hirb
 version: !ruby/object:Gem::Version 
-  version: 0.2.7
+  version: 0.2.8
 platform: ruby
 authors: 
 - Gabriel Horner
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-14 00:00:00 -04:00
+date: 2009-11-07 00:00:00 -05:00
 default_executable: 
 dependencies: []