hirb 0.3.4 → 0.3.6

data/.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |s|
   s.email       = "gabriel.horner@gmail.com"
   s.homepage    = "http://tagaholic.me/hirb/"
   s.summary     = "A mini view framework for console/irb that's easy to use, even while under its influence."
-  s.description = "Hirb provides a mini view framework for console applications and uses it to improve irb's default inspect output. Given an object or array of objects, hirb renders a view based on the object's class and/or ancestry. Hirb offers reusable views in the form of helper classes. The two main helpers, Hirb::Helpers::Table and Hirb::Helpers::Tree, provide several options for generating ascii tables and trees. Using Hirb::Helpers::AutoTable, hirb has useful default views for at least ten popular database gems i.e. Rails' ActiveRecord::Base. Other than views, hirb offers a smart pager and a console menu. The smart pager only pages when the output exceeds the current screen size. The menu is used in conjunction with tables to offer two dimensional menus."
-  s.required_rubygems_version = ">= 1.3.6"
+  s.description = "Hirb provides a mini view framework for console applications and uses it to improve ripl(irb)'s default inspect output. Given an object or array of objects, hirb renders a view based on the object's class and/or ancestry. Hirb offers reusable views in the form of helper classes. The two main helpers, Hirb::Helpers::Table and Hirb::Helpers::Tree, provide several options for generating ascii tables and trees. Using Hirb::Helpers::AutoTable, hirb has useful default views for at least ten popular database gems i.e. Rails' ActiveRecord::Base. Other than views, hirb offers a smart pager and a console menu. The smart pager only pages when the output exceeds the current screen size. The menu is used in conjunction with tables to offer two dimensional menus."
+  s.required_rubygems_version = ">= 1.3.5"
   s.rubyforge_project = 'tagaholic'
   s.add_development_dependency 'bacon', '>= 1.1.0'
   s.add_development_dependency 'mocha'

data/CHANGELOG.rdoc

@@ -1,3 +1,14 @@
+== 0.3.6
+* Tweak ripl support
+* Allow override of :hirb_number thanks to asanghi.
+* Fix Hirb.add_view to work with class which inherits Hash
+
+== 0.3.5
+* Add ripl support
+* Fix Formatter#determine_output_class for IO and Hash
+* Remove :output_method option for Hirb.enable
+* Allow rubygems 1.3.5
+
 == 0.3.4
 * Added auto format of array-like objects i.e. ActiveRecord::Relation and Set.
 * Fixed bug when Hirb::Console#table is used without Hirb enabled.

data/README.rdoc

@@ -2,7 +2,7 @@ To read a linked version of this README, {click here}[http://tagaholic.me/hirb/d
 
 == Description
 
-Hirb provides a mini view framework for console applications and uses it to improve irb's default inspect output.
+Hirb provides a mini view framework for console applications and uses it to improve ripl(irb)'s default inspect output.
 Given an object or array of objects, hirb renders a view based on the object's class and/or ancestry. Hirb offers reusable
 views in the form of helper classes. The two main helpers, Hirb::Helpers::Table and Hirb::Helpers::Tree, provide several options
 for generating ascii tables and trees. Using Hirb::Helpers::AutoTable, hirb has useful default views for at least ten popular database gems
@@ -14,7 +14,7 @@ only pages when the output exceeds the current screen size. The menu is used in
 
 Install the gem with:
 
-    sudo gem install hirb
+    gem install hirb
 
 == View Tutorials
 
@@ -25,7 +25,7 @@ Install the gem with:
 
 To print ascii tables from an array of arrays, hashes or any objects:
 
-  puts Hirb::Helper::AutoTable.render(ARRAY_OF_OBJECTS)
+  puts Hirb::Helpers::AutoTable.render(ARRAY_OF_OBJECTS)
 
 Hirb will intelligently pick up on field names from an array of hashes and create properly-aligned
 fields from an array of arrays. See
@@ -159,14 +159,14 @@ views for certain classes, put them under lib/hirb/views. Please submit views fo
 number of users.
 
 == Limitations
-If using Wirble, you should call Hirb after it since they both override irb's default output.
+If using Wirble and irb, you should call Hirb after it since they both override irb's default output.
 
 == Motivation
 Table code from http://gist.github.com/72234 and {my console app's needs}[http://github.com/cldwalker/tag-tree].
 
 == Credits
 * Chrononaut for vertical table helper.
-* crafterm, spastorino, xaviershay, bogdan and joshua for patches.
+* crafterm, spastorino, xaviershay, bogdan, asanghi and joshua for patches.
 
 == Bugs/Issues
 Please report them {on github}[http://github.com/cldwalker/hirb/issues].

data/lib/hirb/formatter.rb

@@ -2,6 +2,8 @@ module Hirb
   # A Formatter object formats an output object (using Formatter.format_output) into a string based on the views defined
   # for its class and/or ancestry.
   class Formatter
+    TO_A_EXCEPTIONS = [Hash, IO]
+
     class<<self
       # This config is used by Formatter.format_output to lazily load dynamic views defined with Hirb::DynamicView.
       # This hash has the same format as Formatter.config.
@@ -75,7 +77,8 @@ module Hirb
     end
 
     def determine_output_class(output)
-      output.respond_to?(:to_a) ? Array(output)[0].class : output.class
+      output.respond_to?(:to_a) && !TO_A_EXCEPTIONS.any? {|e| output.is_a?(e) } ?
+        Array(output)[0].class : output.class
     end
 
     def call_output_method(output_method, output)

data/lib/hirb/helpers/table.rb

@@ -128,7 +128,7 @@ module Hirb
     @rows = set_rows(rows)
     @headers = set_headers
     if @options[:number]
-      @headers[:hirb_number] = "number"
+      @headers[:hirb_number] ||= "number"
       @fields.unshift :hirb_number
     end
     Helpers::Table.last_table = self

data/lib/hirb/version.rb

@@ -1,3 +1,3 @@
 module Hirb
-  VERSION = '0.3.4'
+  VERSION = '0.3.6'
 end

data/lib/hirb/view.rb

@@ -72,18 +72,15 @@ module Hirb
       # or as options to this method. In addition to the config keys mentioned in Hirb, options also take the following keys:
       # ==== Options:
       # * config_file: Name of config file(s) that are merged into existing config
-      # * output_method: Specify an object's class and instance method (separated by a period) to be realiased with
-      #   hirb's view system. The instance method should take a string to be output. Default is IRB::Irb.output_value
-      #   if using irb.
       # Examples:
       #   Hirb.enable
-      #   Hirb.enable :formatter=>false, :output_method=>"Mini.output"
+      #   Hirb.enable :formatter=>false
       def enable(options={}, &block)
         Array(options.delete(:config_file)).each {|e|
           @new_config_file = true
           Hirb.config_files << e
         }
-        enable_output_method(options.delete(:output_method))
+        enable_output_method unless @output_method
         merge_or_load_config options
         resize(config[:width], config[:height])
         @enabled = true
@@ -97,7 +94,7 @@ module Hirb
       # Disable's Hirb's output and revert's irb's output method if irb exists.
       def disable
         @enabled = false
-        unalias_output_method(@output_method) if @output_method
+        disable_output_method if @output_method
         false
       end
 
@@ -177,41 +174,30 @@ module Hirb
       end
 
       #:stopdoc:
-      def enable_output_method(meth)
-        if (meth ||= Object.const_defined?(:IRB) ? "IRB::Irb.output_value" : false) && !@output_method
-          @output_method = meth
-          alias_output_method(@output_method)
+      def enable_output_method
+        if defined? Ripl
+          @output_method = true
+          require 'ripl/hirb'
+        elsif defined? IRB
+          @output_method = true
+          ::IRB::Irb.class_eval do
+            alias_method :non_hirb_view_output, :output_value
+            def output_value #:nodoc:
+              Hirb::View.view_or_page_output(@context.last_value) || non_hirb_view_output
+            end
+          end
         end
       end
 
-      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
-        ]
+      def disable_output_method
+        if defined?(IRB) && !defined? Ripl
+          ::IRB::Irb.send :alias_method, :output_value, :non_hirb_view_output
+        end
         @output_method = nil
       end
 
-      def alias_output_method(output_method)
-        klass, klass_method = output_method.split(".")
-        eval %[
-          ::#{klass}.class_eval do
-            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) ||
-                  non_hirb_view_output
-              end
-            else
-              def #{klass_method}(output_string) #:nodoc:
-                Hirb::View.view_output(output_string) || Hirb::View.page_output(output_string.inspect, true) ||
-                  non_hirb_view_output(output_string)
-              end
-            end
-          end
-        ]
+      def view_or_page_output(str)
+        view_output(str) || page_output(str.inspect, true)
       end
 
       def render_output(output, options={})

data/lib/ripl/hirb.rb

@@ -0,0 +1,15 @@
+require 'hirb'
+
+module Ripl::Hirb
+  def before_loop
+    super
+    Hirb.enable(Ripl.config[:hirb] || {})
+  end
+
+  def format_result(result)
+    return super if !Hirb::View.enabled?
+    Hirb::View.view_or_page_output(result) || super
+  end
+end
+
+Ripl::Shell.send :include, Ripl::Hirb

data/test/formatter_test.rb

@@ -53,24 +53,34 @@ describe "Formatter" do
   describe "formatter methods:" do
     before_all { eval "module ::Dooda; end" }
 
-    it "add_view sets formatter config" do
+    it "#add_view sets formatter config" do
       @formatter = set_formatter
       @formatter.add_view ::Dooda, :class=>"DoodaView"
       @formatter.klass_config(::Dooda).should == {:class=>"DoodaView"}
     end
 
-    it "add_view overwrites existing formatter config" do
+    it "#add_view overwrites existing formatter config" do
       @formatter = set_formatter "Dooda"=>{:class=>"DoodaView"}
       @formatter.add_view ::Dooda, :class=>"DoodaView2"
       @formatter.klass_config(::Dooda).should == {:class=>"DoodaView2"}
     end
 
-    it "parse_console_options passes all options except for formatter options into :options" do
+    it "#parse_console_options passes all options except for formatter options into :options" do
       @formatter = set_formatter
       options = {:class=>'blah', :method=>'blah', :output_method=>'blah', :blah=>'blah'}
       expected_options = {:class=>'blah', :method=>'blah', :output_method=>'blah', :options=>{:blah=>'blah'}}
       @formatter.parse_console_options(options).should == expected_options
     end
+
+    it "#determine_output_class bypasses exceptions for to_a" do
+      @formatter.determine_output_class(STDOUT).should == IO
+      @formatter.determine_output_class({:a=>1}).should == Hash
+    end
+
+    it "#determine_output_class bypasses subclasses of exceptions for to_a" do
+      class Hash2 < Hash; end
+      @formatter.determine_output_class(Hash2[1=>2]).should == Hash2
+    end
   end
 
   describe "format_output" do
@@ -124,7 +134,7 @@ describe "Formatter" do
       require 'set'
       view_output Set.new(['dude'])
     end
-    
+
     it "formats with options option" do
       eval "module ::Blahify; def self.render(*args); end; end"
       enable_with_output "String"=>{:class=>"Blahify", :options=>{:fields=>%w{a b}}}

data/test/table_test.rb

@@ -361,6 +361,19 @@ describe "Table" do
       table([['a','b'], ['c', 'd']], :number=>true).should == expected_table
     end
 
+    it "number option renders with header that can be overridden" do
+      expected_table = <<-TABLE.unindent
+      +----+---+---+
+      | SR | 0 | 1 |
+      +----+---+---+
+      | 1  | a | b |
+      | 2  | c | d |
+      +----+---+---+
+      2 rows in set
+      TABLE
+      table([['a','b'], ['c', 'd']], :number=>true, :headers => {:hirb_number => "SR"}).should == expected_table
+    end
+
     it "description option false renders" do
       expected_table = <<-TABLE.unindent
       +---+---+

data/test/view_test.rb

@@ -92,13 +92,6 @@ describe "View" do
       Hirb.config_files.include?('test_file').should == true
     end
 
-    it "with output_method option realiases output_method" do
-      eval %[module ::Mini; extend self; def output(str); puts(str.inspect); end; end]
-      Hirb.enable :output_method=>"Mini.output", :output=>{"Symbol"=>{:output_method=>lambda {|e| e.to_s }}}
-      capture_stdout { ::Mini.output(:yoyo) }.should == "yoyo\n"
-      capture_stdout { ::Mini.output('blah') }.should == "\"blah\"\n"
-    end
-
     it "with ignore_errors enable option" do
       Hirb.enable :ignore_errors => true
       View.stubs(:render_output).raises(Exception, "Ex mesg")

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: hirb
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 31
   prerelease: false
   segments: 
   - 0
   - 3
-  - 4
-  version: 0.3.4
+  - 6
+  version: 0.3.6
 platform: ruby
 authors: 
 - Gabriel Horner
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-13 00:00:00 -04:00
+date: 2011-01-08 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -76,7 +76,7 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id004
-description: Hirb provides a mini view framework for console applications and uses it to improve irb's default inspect output. Given an object or array of objects, hirb renders a view based on the object's class and/or ancestry. Hirb offers reusable views in the form of helper classes. The two main helpers, Hirb::Helpers::Table and Hirb::Helpers::Tree, provide several options for generating ascii tables and trees. Using Hirb::Helpers::AutoTable, hirb has useful default views for at least ten popular database gems i.e. Rails' ActiveRecord::Base. Other than views, hirb offers a smart pager and a console menu. The smart pager only pages when the output exceeds the current screen size. The menu is used in conjunction with tables to offer two dimensional menus.
+description: Hirb provides a mini view framework for console applications and uses it to improve ripl(irb)'s default inspect output. Given an object or array of objects, hirb renders a view based on the object's class and/or ancestry. Hirb offers reusable views in the form of helper classes. The two main helpers, Hirb::Helpers::Table and Hirb::Helpers::Tree, provide several options for generating ascii tables and trees. Using Hirb::Helpers::AutoTable, hirb has useful default views for at least ten popular database gems i.e. Rails' ActiveRecord::Base. Other than views, hirb offers a smart pager and a console menu. The smart pager only pages when the output exceeds the current screen size. The menu is used in conjunction with tables to offer two dimensional menus.
 email: gabriel.horner@gmail.com
 executables: []
 
@@ -113,6 +113,7 @@ files:
 - lib/hirb/views/rails.rb
 - lib/hirb/views.rb
 - lib/hirb.rb
+- lib/ripl/hirb.rb
 - test/auto_table_test.rb
 - test/console_test.rb
 - test/dynamic_view_test.rb
@@ -158,12 +159,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 23
+      hash: 17
       segments: 
       - 1
       - 3
-      - 6
-      version: 1.3.6
+      - 5
+      version: 1.3.5
 requirements: []
 
 rubyforge_project: tagaholic