Chrononaut-hirb 0.2.1

data/test/test_helper.rb

@@ -0,0 +1,47 @@
+require 'rubygems'
+require 'test/unit'
+require 'context' #gem install jeremymcanally-context -s http://gems.github.com
+require 'matchy' #gem install jeremymcanally-matchy -s http://gems.github.com
+require 'mocha'
+$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 reset_config
+    Hirb::View.instance_eval "@config = nil"
+  end
+end
+
+class String
+  def unindent(num=nil)
+    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/tree_test.rb

@@ -0,0 +1,167 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class Hirb::Helpers::TreeTest < Test::Unit::TestCase
+  def tree(*args)
+    Hirb::Helpers::Tree.render(*args)
+  end
+  
+  context "basic tree" do
+    test "with hash nodes renders" do
+      expected_tree = <<-TREE.unindent(6)
+      0.0
+          1.1
+              2.2
+              3.2
+          4.1
+      TREE
+      tree([{:level=>0, :value=>'0.0'}, {:level=>1, :value=>'1.1'}, {:level=>2, :value=>'2.2'},{:level=>2, :value=>'3.2'},
+         {:level=>1, :value=>'4.1'}]).should == expected_tree
+    end
+  
+    test "with array nodes renders" do
+      expected_tree = <<-TREE.unindent(6)
+      0.0
+          1.1
+              2.2
+              3.2
+          4.1
+      TREE
+      tree([[0, "0.0"], [1, "1.1"], [2, "2.2"], [2, "3.2"], [1, "4.1"]]).should == expected_tree
+    end
+    
+    test "with non-string values renders" do
+      expected_tree = <<-TREE.unindent(6)
+      0.0
+          1.1
+              2.2
+              3.2
+          4.1
+      TREE
+      tree([[0,0.0],[1,1.1],[2,2.2],[2,3.2],[1,4.1]]).should == expected_tree
+    end
+
+    test "with indent option renders" do
+      expected_tree = <<-TREE.unindent(6)
+      0.0
+        1.1
+          2.2
+          3.2
+        4.1
+      TREE
+      tree([[0, "0.0"], [1, "1.1"], [2, "2.2"], [2, "3.2"], [1, "4.1"]], :indent=>2).should == expected_tree
+    end
+
+    test "with limit option renders" do
+      expected_tree = <<-TREE.unindent(6)
+      0.0
+          1.1
+          4.1
+      TREE
+      tree([[0, "0.0"], [1, "1.1"], [2, "2.2"], [2, "3.2"], [1, "4.1"]], :limit=>1).should == expected_tree
+    end
+
+    test "with description option renders" do
+      expected_tree = <<-TREE.unindent(6)
+      0.0
+          1.1
+              2.2
+              3.2
+          4.1
+      
+      5 nodes in tree
+      TREE
+      tree([[0, "0.0"], [1, "1.1"], [2, "2.2"], [2, "3.2"], [1, "4.1"]], :description=>true).should == expected_tree
+    end
+
+    test "with type directory renders" do
+      expected_tree = <<-TREE.unindent
+      0.0
+      |-- 1.1
+      |   |-- 2.2
+      |   `-- 3.2
+      `-- 4.1
+      TREE
+      tree([[0, "0.0"], [1, "1.1"], [2, "2.2"], [2, "3.2"], [1, "4.1"]], :type=>:directory).should == expected_tree
+    end
+
+    test "with type directory and multiple children per level renders" do
+      expected_tree = <<-TREE.unindent
+      0.0
+      |-- 1.1
+      |   |-- 2.2
+      |   |   `-- 3.3
+      |   `-- 4.2
+      |       `-- 5.3
+      `-- 6.1
+      TREE
+      tree([[0,'0.0'], [1,'1.1'], [2,'2.2'],[3,'3.3'],[2,'4.2'],[3,'5.3'],[1,'6.1']], :type=>:directory).should == expected_tree
+    end
+
+    test "with type number renders" do
+      expected_tree = <<-TREE.unindent(6)
+      1. 0
+          1. 1
+              1. 2
+              2. 3
+          2. 4 
+      TREE
+      tree([[0,'0'],[1,'1'],[2,'2'],[2,'3'],[1,'4']], :type=>:number)
+    end
+  end
+
+  def mock_node(value, value_method)
+    children = []
+    value,children = *value if value.is_a?(Array)
+    mock(value_method=>value, :children=>children.map {|e| mock_node(e, value_method)})
+  end
+
+  context "parent_child_tree" do
+    test "with name value renders" do
+      expected_tree = <<-TREE.unindent
+      0.0
+      |-- 1.1
+      |-- 2.1
+      |   `-- 3.2
+      `-- 4.1
+      TREE
+      root = mock_node(['0.0', ['1.1', ['2.1', '3.2'], '4.1']], :name)
+      Hirb::Helpers::ParentChildTree.render(root, :type=>:directory).should == expected_tree
+    end
+    
+    test "with object_id value renders" do
+      expected_tree = <<-TREE.unindent
+      0.0
+      |-- 1.1
+      |-- 2.1
+      |   `-- 3.2
+      `-- 4.1
+      TREE
+      root = mock_node(['0.0', ['1.1', ['2.1', '3.2'], '4.1']], :object_id)
+      Hirb::Helpers::ParentChildTree.render(root, :type=>:directory).should == expected_tree
+    end
+
+    test "with value_method option renders" do
+      expected_tree = <<-TREE.unindent
+      0.0
+      |-- 1.1
+      |-- 2.1
+      |   `-- 3.2
+      `-- 4.1
+      TREE
+      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
+  end
+
+  test "tree with parentless nodes renders ParentlessNodeError" do
+    assert_raises(Hirb::Helpers::Tree::ParentlessNodeError) { tree([[0, "0.0"], [2, '1.2']], :validate=>true) }
+  end
+  
+  test "tree with hash nodes missing level raises MissingLevelError" do
+    assert_raises(Hirb::Helpers::Tree::Node::MissingLevelError) { tree([{:value=>'ok'}]) }
+  end
+
+  test "tree with hash nodes missing level raises MissingValueError" do
+    assert_raises(Hirb::Helpers::Tree::Node::MissingValueError) { tree([{:level=>0}]) }
+  end
+end

data/test/util_test.rb

@@ -0,0 +1,56 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+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

data/test/view_test.rb

@@ -0,0 +1,116 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+module Hirb
+  class ViewTest < Test::Unit::TestCase
+    def formatter_config
+      View.formatter.config
+    end
+    
+    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 "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
+
+    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
+
+    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 "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 "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 "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 "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

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification 
+name: Chrononaut-hirb
+version: !ruby/object:Gem::Version 
+  version: 0.2.1
+platform: ruby
+authors: 
+- Gabriel Horner
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-20 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+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: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- CHANGELOG.rdoc
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- lib/hirb.rb
+- lib/hirb/console.rb
+- lib/hirb/formatter.rb
+- lib/hirb/hash_struct.rb
+- 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/import_object.rb
+- lib/hirb/menu.rb
+- lib/hirb/pager.rb
+- lib/hirb/util.rb
+- lib/hirb/view.rb
+- lib/hirb/views/activerecord_base.rb
+- test/console_test.rb
+- test/formatter_test.rb
+- test/hirb_test.rb
+- test/import_test.rb
+- test/menu_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
+has_rdoc: true
+homepage: http://github.com/cldwalker/hirb
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: tagaholic
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: A mini view framework for console/irb that's easy to use, even while under its influence.
+test_files: 
+- test/console_test.rb
+- test/formatter_test.rb
+- test/hirb_test.rb
+- test/import_test.rb
+- test/menu_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