hirb 0.2.5 → 0.2.6

data/CHANGELOG.rdoc

@@ -1,3 +1,9 @@
+== 0.2.6
+* Added :description option and added proc ability to :children_method option for helpers.
+* Bug fix for no ENV['HOME'] on Windows.
+* Bug fix on unaliasing output_method.
+* Bug fix on multiple renders of vertical table.
+
 == 0.2.5
 * Added ability to use Hirb.enable with non-irb ruby shells.
 * Helper configs now recursively merge when inheriting from others via :ancestor option.

data/Rakefile

@@ -21,7 +21,7 @@ begin
     s.summary = "A mini view framework for console/irb that's easy to use, even while under its influence."
     s.description = "Hirb currently provides a mini view framework for console applications, designed to improve irb's default output.  Hirb improves console output by providing a smart pager and auto-formatting output. The smart pager detects when an output exceeds a screenful and thus only pages output as needed. Auto-formatting adds a view to an output's class. This is helpful in separating views from content (MVC anyone?). The framework encourages reusing views by letting you package them in classes and associate them with any number of output classes."
     s.email = "gabriel.horner@gmail.com"
-    s.homepage = "http://github.com/cldwalker/hirb"
+    s.homepage = "http://tagaholic.me/hirb/"
     s.authors = ["Gabriel Horner"]
     s.rubyforge_project = 'tagaholic'
     s.has_rdoc = true

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 0
 :minor: 2
-:patch: 5
+:patch: 6

data/lib/hirb.rb

@@ -41,7 +41,8 @@ module Hirb
     end
     # Default is config/hirb.yml or ~/hirb.yml in that order.
     def config_file
-      @config_file ||= File.exists?('config/hirb.yml') ? 'config/hirb.yml' : File.expand_path(File.join(ENV["HOME"],".hirb.yml"))
+      @config_file ||= File.exists?('config/hirb.yml') ? 'config/hirb.yml' :
+        File.expand_path(File.join(ENV["HOME"] || ".", ".hirb.yml"))
     end
 
     #:stopdoc:

data/lib/hirb/helpers/parent_child_tree.rb

@@ -5,7 +5,7 @@ class Hirb::Helpers::ParentChildTree < Hirb::Helpers::Tree
     # ==== Options:
     # [:value_method] Method 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 to call to obtain a node's children. Default is :children.
+    # [: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
@@ -16,7 +16,8 @@ class Hirb::Helpers::ParentChildTree < Hirb::Helpers::Tree
 
     def build_node(node, level) #:nodoc:
       @nodes << {:value=>node.send(@value_method), :level=>level}
-      node.send(@children_method).each {|e| build_node(e, level + 1)}
+      children = @children_method.is_a?(Proc) ? @children_method.call(node) : node.send(@children_method)
+      children.each {|e| build_node(e, level + 1)}
     end
   end
-end
+end

data/lib/hirb/helpers/table.rb

@@ -46,6 +46,7 @@ module Hirb
     #            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.
     # [:all_fields] When set to true, renders fields in all rows. Valid only in rows that are hashes. Default is false.
+    # [:description] When set to true, renders row count description at bottom. Default is true.
     # Examples:
     #    Hirb::Helpers::Table.render [[1,2], [2,3]]
     #    Hirb::Helpers::Table.render [[1,2], [2,3]], :field_lengths=>{0=>10}
@@ -53,7 +54,7 @@ module Hirb
     #    Hirb::Helpers::Table.render [{:age=>10, :weight=>100}, {:age=>80, :weight=>500}], :headers=>{:weight=>"Weight(lbs)"}
     #    Hirb::Helpers::Table.render [{:age=>10, :weight=>100}, {:age=>80, :weight=>500}], :filters=>{:age=>[:to_f]}
     def render(rows, options={})
-      options.delete(:vertical) ? Helpers::VerticalTable.render(rows, options) : new(rows, options).render
+      options[:vertical] ? Helpers::VerticalTable.render(rows, options) : new(rows, options).render
     rescue TooManyFieldsForWidthError
       $stderr.puts "", "** Error: Too many fields for the current width. Configure your width " +
         "and/or fields to avoid this error. Defaulting to a vertical table. **"
@@ -63,8 +64,7 @@ module Hirb
   
   #:stopdoc:
   def initialize(rows, options={})
-    @options = options
-    @options[:filters] ||= {}
+    @options = {:description=>true, :filters=>{}}.merge(options)
     @fields = set_fields(rows)
     @rows = setup_rows(rows)
     @headers = @fields.inject({}) {|h,e| h[e] = e.to_s; h}
@@ -113,7 +113,7 @@ module Hirb
       body += render_rows
       body += render_footer
     end
-    body << render_table_description
+    body << render_table_description if @options[:description]
     body.join("\n")
   end
 

data/lib/hirb/view.rb

@@ -25,11 +25,11 @@ module Hirb
         return puts("Already enabled.") if @enabled
         @enabled = true
         Hirb.config_file = options.delete(:config_file) if options[:config_file]
-        output_method = "IRB::Irb.output_value" if Object.const_defined?(:IRB)
-        output_method = options.delete(:output_method) if options[:output_method]
+        @output_method = "IRB::Irb.output_value" if Object.const_defined?(:IRB)
+        @output_method = options.delete(:output_method) if options[:output_method]
         load_config(Util.recursive_hash_merge(options, HashStruct.block_to_hash(block)))
         resize(config[:width], config[:height])
-        alias_output_method(output_method) if output_method
+        alias_output_method(@output_method) if @output_method
         true
       end
 
@@ -41,11 +41,8 @@ module Hirb
       # Disable's Hirb's output and revert's irb's output method if irb exists.
       def disable
         @enabled = false
-        if Object.const_defined?(:IRB)
-          ::IRB::Irb.class_eval do
-            alias :output_value :non_hirb_view_output
-          end
-        end
+        unalias_output_method(@output_method) if @output_method
+        false
       end
 
       # Toggles pager on or off. The pager only works while Hirb::View is enabled.
@@ -111,11 +108,20 @@ module Hirb
       end
 
       #:stopdoc:
+      def unalias_output_method(output_method)
+        klass, klass_method = output_method.split(".")
+        eval %[
+          ::#{klass}.class_eval do
+            alias_method :#{klass_method}, :non_hirb_view_output
+          end
+        ]
+      end
+
       def alias_output_method(output_method)
         klass, klass_method = output_method.split(".")
         eval %[
           ::#{klass}.class_eval do
-            alias :non_hirb_view_output :#{klass_method}
+            alias_method :non_hirb_view_output, :#{klass_method}
             if '#{klass}' == "IRB::Irb"
               def #{klass_method} #:nodoc:
                 Hirb::View.view_output(@context.last_value) || Hirb::View.page_output(@context.last_value.inspect, true) ||

data/test/hirb_test.rb

@@ -2,7 +2,7 @@ require File.join(File.dirname(__FILE__), 'test_helper')
 
 class HirbTest < Test::Unit::TestCase
   before(:each) {Hirb.instance_eval "@config = nil"}
-  
+
   test "config converts yaml when config file exists" do
     yaml_data = {:blah=>'blah'}
     File.stubs('exists?').returns(true)
@@ -20,4 +20,11 @@ class HirbTest < Test::Unit::TestCase
     Hirb.expects(:read_config_file)
     Hirb.config(true)
   end
+
+  test "config_file sets correctly when no ENV['HOME']" do
+    Hirb.config_file = nil
+    home = ENV.delete('HOME')
+    Hirb.config_file.class.should == String
+    ENV["HOME"] = home
+  end
 end

data/test/table_test.rb

@@ -266,6 +266,18 @@ class Hirb::Helpers::TableTest < Test::Unit::TestCase
       table([['a','b'], ['c', 'd']], :number=>true).should == expected_table
     end
 
+    test "description option false renders" do
+      expected_table = <<-TABLE.unindent
+      +---+---+
+      | 0 | 1 |
+      +---+---+
+      | a | b |
+      | c | d |
+      +---+---+
+      TABLE
+      table([['a','b'], ['c', 'd']], :description=>false).should == expected_table
+    end
+
     test "vertical option renders vertical table" do
       expected_table = <<-TABLE.unindent
       *** 1. row ***
@@ -279,6 +291,21 @@ class Hirb::Helpers::TableTest < Test::Unit::TestCase
       table([{:a=>1, :b=>2}, {:a=>3, :b=>4}], :vertical=>true).should == expected_table
     end
 
+    test "vertical option renders vertical table successively" do
+      expected_table = <<-TABLE.unindent
+      *** 1. row ***
+      a: 1
+      b: 2
+      *** 2. row ***
+      a: 3
+      b: 4
+      2 rows in set
+      TABLE
+      options = {:vertical=>true}
+      table([{:a=>1, :b=>2}, {:a=>3, :b=>4}], options).should == expected_table
+      table([{:a=>1, :b=>2}, {:a=>3, :b=>4}], options).should == expected_table
+    end
+
     test "all_fields option renders all fields" do
       expected_table = <<-TABLE.unindent
       +---+---+---+

data/test/tree_test.rb

@@ -151,6 +151,18 @@ class Hirb::Helpers::TreeTest < Test::Unit::TestCase
       root = mock_node(['0.0', ['1.1', ['2.1', '3.2'], '4.1']], :blah)
       Hirb::Helpers::ParentChildTree.render(root, :type=>:directory, :value_method=>:blah).should == expected_tree
     end
+
+    test "with children_method proc option renders" do
+      expected_tree = <<-TREE.unindent
+      1
+      |-- 2
+      |-- 3
+      |-- 4
+      `-- 5
+      TREE
+      Hirb::Helpers::ParentChildTree.render(1, :type=>:directory,
+        :children_method=>lambda {|e| e == 1 ? (2..5).to_a : []}, :value_method=>:to_s)
+    end
   end
 
   test "tree with parentless nodes renders ParentlessNodeError" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: hirb
 version: !ruby/object:Gem::Version 
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors: 
 - Gabriel Horner
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-01 00:00:00 -04:00
+date: 2009-09-17 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -62,7 +62,7 @@ files:
 - test/util_test.rb
 - test/view_test.rb
 has_rdoc: true
-homepage: http://github.com/cldwalker/hirb
+homepage: http://tagaholic.me/hirb/
 licenses: []
 
 post_install_message: