hirb 0.1.2 → 0.2.2

data/test/test_helper.rb

@@ -7,6 +7,37 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'hirb'
 
 class Test::Unit::TestCase
+  # set these to avoid invoking stty multiple times which doubles test suite running time
+  ENV["LINES"] = ENV["COLUMNS"] = "20"
+  def reset_terminal_size
+    ENV["LINES"] = ENV["COLUMNS"] = "20"
+  end
+
+  def capture_stdout(&block)
+    original_stdout = $stdout
+    $stdout = fake = StringIO.new
+    begin
+      yield
+    ensure
+      $stdout = original_stdout
+    end
+    fake.string
+  end
+
+  def capture_stderr(&block)
+    original_stderr = $stderr
+    $stderr = fake = StringIO.new
+    begin
+      yield
+    ensure
+      $stderr = original_stderr
+    end
+    fake.string
+  end
+
+  def reset_config
+    Hirb::View.instance_eval "@config = nil"
+  end
 end
 
 class String
@@ -14,4 +45,14 @@ class String
     regex = num ? /^\s{#{num}}/ : /^\s*/
     gsub(regex, '').chomp
   end
+end
+
+# mocks IRB for View + Pager
+module ::IRB
+  class Irb
+    def initialize(context)
+      @context = context
+    end
+    def output_value; end
+  end
 end

data/test/util_test.rb

@@ -1,21 +1,56 @@
 require File.join(File.dirname(__FILE__), 'test_helper')
 
-class Hirb::UtilTest < Test::Unit::TestCase
-  test "any_const_get returns nested class" do
-    Hirb::Util.any_const_get("Test::Unit").should == ::Test::Unit
-  end
-  
-  test "any_const_get returns nil for invalid class" do
-    Hirb::Util.any_const_get("Basdfr").should == nil
-  end
-  
-  test "any_const_get returns class when given class" do
-    Hirb::Util.any_const_get(String).should == String
-  end
-  
-  test "recursive_hash_merge merges" do
-    expected_hash = {:output=>{:fields=>["f1", "f2"], :method=>"blah"}, :key1=>"hash1", :key2=>"hash2"}
-    Hirb::Util.recursive_hash_merge({:output=>{:fields=>%w{f1 f2}}, :key1=>'hash1'},
-      {:output=>{:method=>'blah'}, :key2=>'hash2'}).should == expected_hash
+module Hirb
+  class UtilTest < Test::Unit::TestCase
+    test "any_const_get returns nested class" do
+      Util.any_const_get("Test::Unit").should == ::Test::Unit
+    end
+    
+    test "any_const_get returns nil for invalid class" do
+      Util.any_const_get("Basdfr").should == nil
+    end
+    
+    test "any_const_get returns class when given class" do
+      Util.any_const_get(String).should == String
+    end
+    
+    test "recursive_hash_merge merges" do
+      expected_hash = {:output=>{:fields=>["f1", "f2"], :method=>"blah"}, :key1=>"hash1", :key2=>"hash2"}
+      Util.recursive_hash_merge({:output=>{:fields=>%w{f1 f2}}, :key1=>'hash1'},
+        {:output=>{:method=>'blah'}, :key2=>'hash2'}).should == expected_hash
+    end
+
+    test "choose_from_array specifies range with -" do
+      Util.choose_from_array([1,2,3,4], '1-2,4').should == [1,2,4]
+    end
+
+    test "choose_from_array specifies range with .." do
+      Util.choose_from_array([1,2,3,4], '1 .. 2,4').should == [1,2,4]
+    end
+
+    test "choose_from_array chooses all with *" do
+      Util.choose_from_array([1,2,3,4], '*').should == [1,2,3,4]
+    end
+
+    test "choose_from_array ignores non-numerical input" do
+      Util.choose_from_array([1,2,3,4], 'a,2').should == [2]
+    end
+
+    test "choose_from_array ignores 0" do
+      Util.choose_from_array([1,2,3,4], '0,2').should == [2]
+    end
+
+    test "choose_from_array returns empty when empty input" do
+      Util.choose_from_array([1,2,3,4], "\n").should == []
+    end
+
+    test "choose_from_array returns empty with an invalid range" do
+      Util.choose_from_array([1,2,3,4], "5").should == []
+    end
+
+    test "capture_stdout" do
+      string = "sweetness man"
+      Util.capture_stdout { puts string }.should == string + "\n"
+    end
   end
-end
+end

data/test/view_test.rb

@@ -1,169 +1,116 @@
 require File.join(File.dirname(__FILE__), 'test_helper')
 
-# mocks IRB for testing
-module ::IRB
-  class Irb
-    def initialize(context)
-      @context = context
-    end
-    def output_value; end
-  end
-end
-
-class Hirb::ViewTest < Test::Unit::TestCase
-  def set_config(value)
-    Hirb::View.output_config = value
-    Hirb::View.reset_cached_output_config
-  end
-  
-  def output_config
-    Hirb::View.config[:output]
-  end
-  
-  test "output_class_options merges ancestor options" do
-    set_config "String"=>{:args=>[1,2]}, "Object"=>{:method=>:object_output, :ancestor=>true}, "Kernel"=>{:method=>:default_output}
-    expected_result = {:method=>:object_output, :args=>[1, 2], :ancestor=>true}
-    Hirb::View.output_class_options(String).should == expected_result
-  end
-  
-  test "output_class_options doesn't ancestor options" do
-    set_config "String"=>{:args=>[1,2]}, "Object"=>{:method=>:object_output}, "Kernel"=>{:method=>:default_output}
-    expected_result = {:args=>[1, 2]}
-    Hirb::View.output_class_options(String).should == expected_result
-  end
-  
-  test "output_class_options returns hash when nothing found" do
-    Hirb::View.load_config
-    Hirb::View.output_class_options(String).should == {}
-  end
-
-  context "enable" do
-    before(:each) {Hirb::View.config = {}}
-    after(:each) { Hirb::View.disable }
-    test "redefines irb output_value" do
-      Hirb::View.expects(:render_output).once
-      Hirb::View.enable
-      context_stub = stub(:last_value=>'')
-      ::IRB::Irb.new(context_stub).output_value
-    end
-  
-    test "sets default config" do
-      eval "module ::Hirb::Views::Something_Base; def self.render; end; end"
-      Hirb::View.enable
-      output_config["Something::Base"].should == {:class=>"Hirb::Views::Something_Base"}
-    end
-  
-    test "sets default config with default_options" do
-      eval "module ::Hirb::Views::Blah; def self.render; end; def self.default_options; {:ancestor=>true}; end; end"
-      Hirb::View.enable
-      output_config["Blah"].should == {:class=>"Hirb::Views::Blah", :ancestor=>true}
-    end
-  
-    test "with block sets config" do
-      class_hash = {"Something::Base"=>{:class=>"BlahBlah"}}
-      Hirb::View.enable {|c| c.output = class_hash }
-      output_config['Something::Base'].should == class_hash['Something::Base']
-    end
-  end
-
-  test "reload_config resets config to detect new Hirb::Views" do
-    Hirb::View.load_config
-    output_config.keys.include?('Zzz').should be(false)
-    eval "module ::Hirb::Views::Zzz; def self.render; end; end"
-    Hirb::View.reload_config
-    output_config.keys.include?('Zzz').should be(true)
-  end
-  
-  test "reload_config picks up local changes" do
-    Hirb::View.load_config
-    output_config.keys.include?('Dooda').should be(false)
-    Hirb::View.output_config.merge!('Dooda'=>{:class=>"DoodaView"})
-    Hirb::View.reload_config
-    output_config['Dooda'].should == {:class=>"DoodaView"}
-  end
-  
-  test "disable points output_value back to original output_value" do
-    Hirb::View.expects(:render_output).never
-    Hirb::View.enable
-    Hirb::View.disable
-    context_stub = stub(:last_value=>'')
-    ::IRB::Irb.new(context_stub).output_value
-  end
-
-  context "render_output" do
-    before(:all) { 
-      eval %[module ::Commify
-        def self.render(strings)
-          strings = [strings] unless strings.is_a?(Array)
-          strings.map {|e| e.split('').join(',')}.join("\n")
-        end
-      end]
-      Hirb::View.enable 
-    }
-    after(:all) { Hirb::View.disable }
-    
-    test "formats with config method option" do
-      eval "module ::Kernel; def commify(string); string.split('').join(','); end; end"
-      set_config "String"=>{:method=>:commify}
-      Hirb::View.render_method.expects(:call).with('d,u,d,e')
-      Hirb::View.render_output('dude')
-    end
-    
-    test "formats with config class option" do
-      set_config "String"=>{:class=>"Commify"}
-      Hirb::View.render_method.expects(:call).with('d,u,d,e')
-      Hirb::View.render_output('dude')
+module Hirb
+  class ViewTest < Test::Unit::TestCase
+    def formatter_config
+      View.formatter.config
     end
     
-    test "formats with output array" do
-      set_config "String"=>{:class=>"Commify"}
-      Hirb::View.render_method.expects(:call).with('d,u,d,e')
-      Hirb::View.render_output(['dude'])
+    test "page_output pages when view is enabled" do
+      Hirb.enable
+      View.pager.stubs(:activated_by?).returns(true)
+      View.pager.expects(:page)
+      View.page_output('blah').should be(true)
+      Hirb.disable
     end
     
-    test "formats with config options option" do
-      eval "module ::Blahify; def self.render(*args); end; end"
-      set_config "String"=>{:class=>"Blahify", :options=>{:fields=>%w{a b}}}
-      Blahify.expects(:render).with('dude', :fields=>%w{a b})
-      Hirb::View.render_output('dude')
+    test "page_output doesn't page when view is disabled" do
+      Hirb.enable
+      Hirb.disable
+      View.pager.stubs(:activated_by?).returns(true)
+      View.pager.expects(:page).never
+      View.page_output('blah').should be(false)
     end
-    
-    test "doesn't format and returns false when no format method found" do
-      Hirb::View.load_config
-      Hirb::View.render_method.expects(:call).never
-      Hirb::View.render_output(Date.today).should == false
+
+    context "enable" do
+      before(:each) { reset_config }
+      after(:each) { Hirb.disable }
+      test "redefines irb output_value" do
+        View.expects(:render_output).once
+        Hirb.enable
+        context_stub = stub(:last_value=>'')
+        ::IRB::Irb.new(context_stub).output_value
+      end
+      test "is enabled?" do
+        Hirb.enable
+        assert View.enabled?
+      end
+
+      test "works without irb" do
+        Object.stubs(:const_defined?).with(:IRB).returns(false)
+        Hirb.enable
+        assert formatter_config.size > 0
+      end
+
+      test "with config_file option sets config_file" do
+        Hirb.config_file.should_not == 'test_file'
+        Hirb.enable :config_file=> 'test_file'
+        Hirb.config_file.should == 'test_file'
+      end
     end
-    
-    test "formats with explicit class option" do
-      set_config 'String'=>{:class=>"Blahify"}
-      Hirb::View.render_method.expects(:call).with('d,u,d,e')
-      Hirb::View.render_output('dude', :class=>"Commify")
+
+    context "resize" do
+      def pager; View.pager; end
+      before(:each) { View.pager = nil; reset_config; Hirb.enable }
+      after(:each) { Hirb.disable}
+      test "changes width and height with stty" do
+        Util.expects(:command_exists?).with('stty').returns(true)
+        ENV['COLUMNS'] = ENV['LINES'] = nil # bypasses env usage
+        View.resize
+        pager.width.should_not == 10
+        pager.height.should_not == 10
+        reset_terminal_size
+      end
+
+      test "changes width and height with ENV" do
+        ENV['COLUMNS'] = ENV['LINES'] = '10' # simulates resizing
+        View.resize
+        pager.width.should == 10
+        pager.height.should == 10
+      end
+
+      test "with no environment or stty still has valid width and height" do
+        View.config[:width] = View.config[:height] = nil
+        Util.expects(:command_exists?).with('stty').returns(false)
+        ENV['COLUMNS'] = ENV['LINES'] = nil
+        View.resize
+        pager.width.is_a?(Integer).should be(true)
+        pager.height.is_a?(Integer).should be(true)
+        reset_terminal_size
+      end
     end
-    
-    test "formats with output_method option" do
-      set_config 'String'=>{:class=>"Blahify"}
-      Hirb::View.render_method.expects(:call).with('d,u,d')
-      Hirb::View.render_output('dude', :class=>"Commify", :output_method=>:chop)
+
+    test "disable points output_value back to original output_value" do
+      View.expects(:render_output).never
+      Hirb.enable
+      Hirb.disable
+      context_stub = stub(:last_value=>'')
+      ::IRB::Irb.new(context_stub).output_value
     end
 
-    test "formats output array with output_method option" do
-      set_config 'String'=>{:class=>"Blahify"}
-      Hirb::View.render_method.expects(:call).with("d,u,d\nm,a")
-      Hirb::View.render_output(['dude', 'man'], :class=>"Commify", :output_method=>:chop)
+    test "disable works without irb defined" do
+      Object.stubs(:const_defined?).with(:IRB).returns(false)
+      Hirb.enable
+      Hirb.disable
+      View.enabled?.should be(false)
     end
 
-    test "formats with block" do
-      Hirb::View.load_config
-      Hirb::View.render_method.expects(:call).with('=dude=')
-      Hirb::View.render_output('dude') {|output|
-        "=#{output}="
-      }
+    test "capture_and_render" do
+      string = 'no waaaay'
+      View.render_method.expects(:call).with(string)
+      View.capture_and_render { print string }
+    end
+    
+    test "state is toggled by toggle_pager" do
+      previous_state = View.config[:pager]
+      View.toggle_pager
+      View.config[:pager].should == !previous_state
     end
     
-    test "console_render_output merge options option" do
-      set_config "String"=>{:class=>"Commify", :options=>{:fields=>%w{f1 f2}}}
-      Commify.expects(:render).with('dude', :max_width=>10, :fields=>%w{f1 f2})
-      Hirb::View.render_output('dude', :options=>{:max_width=>10})
+    test "state is toggled by toggle_formatter" do
+      previous_state = View.config[:formatter]
+      View.toggle_formatter
+      View.config[:formatter].should == !previous_state
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: hirb
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.2.2
 platform: ruby
 authors: 
 - Gabriel Horner
@@ -9,44 +9,52 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-23 00:00:00 -04:00
+date: 2009-06-30 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
-description: A mini view framework for console/irb that's easy to use, even while under its influence.
+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.
 email: gabriel.horner@gmail.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- README.rdoc
 - LICENSE.txt
+- README.rdoc
 files: 
 - CHANGELOG.rdoc
 - LICENSE.txt
-- Rakefile
 - README.rdoc
+- Rakefile
 - VERSION.yml
-- lib/hirb
+- lib/hirb.rb
 - lib/hirb/console.rb
+- lib/hirb/formatter.rb
 - lib/hirb/hash_struct.rb
-- lib/hirb/helpers
+- lib/hirb/helpers.rb
 - lib/hirb/helpers/active_record_table.rb
 - lib/hirb/helpers/auto_table.rb
 - lib/hirb/helpers/object_table.rb
 - lib/hirb/helpers/parent_child_tree.rb
 - lib/hirb/helpers/table.rb
 - lib/hirb/helpers/tree.rb
-- lib/hirb/helpers.rb
+- lib/hirb/helpers/vertical_table.rb
 - lib/hirb/import_object.rb
+- lib/hirb/menu.rb
+- lib/hirb/pager.rb
 - lib/hirb/util.rb
 - lib/hirb/view.rb
-- lib/hirb/views
 - lib/hirb/views/activerecord_base.rb
-- lib/hirb.rb
+- test/active_record_table_test.rb
+- test/auto_table_test.rb
+- test/console_test.rb
+- test/formatter_test.rb
 - test/hirb_test.rb
 - test/import_test.rb
+- test/menu_test.rb
+- test/object_table_test.rb
+- test/pager_test.rb
 - test/table_test.rb
 - test/test_helper.rb
 - test/tree_test.rb
@@ -54,9 +62,10 @@ files:
 - test/view_test.rb
 has_rdoc: true
 homepage: http://github.com/cldwalker/hirb
+licenses: []
+
 post_install_message: 
 rdoc_options: 
-- --inline-source
 - --charset=UTF-8
 require_paths: 
 - lib
@@ -75,9 +84,22 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: tagaholic
-rubygems_version: 1.3.1
+rubygems_version: 1.3.2
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: A mini view framework for console/irb that's easy to use, even while under its influence.
-test_files: []
-
+test_files: 
+- test/active_record_table_test.rb
+- test/auto_table_test.rb
+- test/console_test.rb
+- test/formatter_test.rb
+- test/hirb_test.rb
+- test/import_test.rb
+- test/menu_test.rb
+- test/object_table_test.rb
+- test/pager_test.rb
+- test/table_test.rb
+- test/test_helper.rb
+- test/tree_test.rb
+- test/util_test.rb
+- test/view_test.rb