cldwalker-hirb 0.2.1 → 0.2.2

data/CHANGELOG.rdoc

@@ -1,3 +1,9 @@
+== 0.2.2
+* Added a friendlier default (a vertical table) to incorrectly configured tables.
+* Added vertical table helper thanks to chrononaut.
+* Added detection of :select option from ActiveRecord queries in ActiveRecordTable helper.
+* Added handling anything that responds to :to_a in AutoTable helper.
+
 == 0.2.1
 * Fixed typo in Hirb::Console.view
 

data/README.rdoc

@@ -149,6 +149,9 @@ If using Wirble, you should call Hirb after it since they both override irb's de
 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.
+
 == Bugs/Issues
 Please report them {on github}[http://github.com/cldwalker/hirb/issues].
 

data/VERSION.yml

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

data/lib/hirb/helpers.rb

@@ -2,6 +2,6 @@ module Hirb
   module Helpers #:nodoc:
   end
 end
-%w{table object_table active_record_table auto_table tree parent_child_tree}.each do |e|
+%w{table object_table active_record_table auto_table tree parent_child_tree vertical_table}.each do |e|
   require "hirb/helpers/#{e}"
 end

data/lib/hirb/helpers/active_record_table.rb

@@ -11,6 +11,16 @@ class Hirb::Helpers::ActiveRecordTable < Hirb::Helpers::ObjectTable
         fields = rows.first.class.column_names
         fields.map {|e| e.to_sym }
       end
+    if query_used_select?(rows)
+      selected_columns = rows.first.attributes.keys
+      sorted_columns = rows.first.class.column_names.dup.delete_if {|e| !selected_columns.include?(e) }
+      sorted_columns += (selected_columns - sorted_columns)
+      options[:fields] = sorted_columns.map {|e| e.to_sym}
+    end
     super(rows, options)
   end
+
+  def self.query_used_select?(rows) #:nodoc:
+    rows.first.attributes.keys.sort != rows.first.class.column_names.sort
+  end
 end

data/lib/hirb/helpers/auto_table.rb

@@ -2,6 +2,7 @@
 class Hirb::Helpers::AutoTable
   # Same options as Hirb::Helpers::Table.render.
   def self.render(output, options={})
+    output = output.to_a if !output.is_a?(Array) && output.respond_to?(:to_a)
     klass = if ((output.is_a?(Array) && output[0].is_a?(ActiveRecord::Base)) or output.is_a?(ActiveRecord::Base) rescue false)
       Hirb::Helpers::ActiveRecordTable
     elsif (output.is_a?(Array) && !(output[0].is_a?(Hash) || output[0].is_a?(Array)))

data/lib/hirb/helpers/table.rb

@@ -43,6 +43,7 @@ class Hirb::Helpers::Table
     # [:number]  When set to true, numbers rows by adding a :hirb_number column as the first column. Default is false.
     # [: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.
     # Examples:
     #    Hirb::Helpers::Table.render [[1,2], [2,3]]
     #    Hirb::Helpers::Table.render [[1,2], [2,3]], :field_lengths=>{0=>10}
@@ -50,7 +51,11 @@ class Hirb::Helpers::Table
     #    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={})
-      new(rows,options).render
+      options.delete(:vertical) ? Hirb::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. **"
+      Hirb::Helpers::VerticalTable.render(rows, options)
     end
   end
   
@@ -90,15 +95,23 @@ class Hirb::Helpers::Table
     body = []
     unless @rows.length == 0
       setup_field_lengths
-      body += @headers ? render_header : [render_border]
+      body += render_header
       body += render_rows
-      body << render_border
+      body += render_footer
     end
     body << render_table_description
     body.join("\n")
   end
-  
+
   def render_header
+    @headers ? render_table_header : [render_border]
+  end
+
+  def render_footer
+    [render_border]
+  end
+
+  def render_table_header
     title_row = '| ' + @fields.map {|f|
       format_cell(@headers[f], @field_lengths[f])
     }.join(' | ') + ' |'

data/lib/hirb/helpers/vertical_table.rb

@@ -0,0 +1,31 @@
+class Hirb::Helpers::VerticalTable < Hirb::Helpers::Table
+
+  # Renders a vertical table using the same options as Hirb::Helpers::Table.render except for :field_lengths,
+  # :vertical and :max_width which aren't used.
+  def self.render(rows, options={})
+    new(rows, options).render
+  end
+
+  #:stopdoc:
+  def setup_field_lengths
+    @field_lengths = default_field_lengths
+  end
+
+  def render_header; []; end
+  def render_footer; []; end
+
+  def render_rows
+    i = 0
+    longest_header = @headers.values.sort_by {|e| e.length}.last.length
+    stars = "*" * [(longest_header + (longest_header / 2)), 3].max
+    @rows.map do |row|
+      row = "#{stars} #{i+1}. row #{stars}\n" +
+      @fields.map {|f|
+        "#{@headers[f].rjust(longest_header)}: #{row[f]}"
+      }.join("\n")
+      i+= 1
+      row
+    end
+  #:startdoc:
+  end
+end

data/test/active_record_table_test.rb

@@ -0,0 +1,35 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class Hirb::Helpers::ActiveRecordTableTest < Test::Unit::TestCase
+  context "activerecord table" do
+    test "with no select renders" do
+      expected_table = <<-TABLE.unindent
+      +-----+-------+
+      | age | name  |
+      +-----+-------+
+      | 7   | rufus |
+      | 101 | alf   |
+      +-----+-------+
+      2 rows in set
+      TABLE
+      @pets = [stub(:name=>'rufus', :age=>7, :attributes=>{"name"=>'rufus', 'age'=>7}, :class=>stub(:column_names=>%w{age name})),
+        stub(:name=>'alf', :age=>101)]
+      Hirb::Helpers::ActiveRecordTable.render(@pets).should == expected_table
+    end
+
+    test "with select renders" do
+      expected_table = <<-TABLE.unindent
+      +-------+
+      | name  |
+      +-------+
+      | rufus |
+      | alf   |
+      +-------+
+      2 rows in set
+      TABLE
+      @pets = [stub(:name=>'rufus', :age=>7, :attributes=>{'name'=>'rufus'}, :class=>stub(:column_names=>%w{age name})),
+        stub(:name=>'alf', :age=>101)]
+      Hirb::Helpers::ActiveRecordTable.render(@pets).should == expected_table
+    end
+  end
+end

data/test/auto_table_test.rb

@@ -0,0 +1,20 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class Hirb::Helpers::AutoTableTest < Test::Unit::TestCase
+  context "auto table" do
+    test "converts nonarrays to arrays and renders" do
+      require 'set'
+      expected_table = <<-TABLE.unindent
+      +-------+
+      | value |
+      +-------+
+      | 1     |
+      | 2     |
+      | 3     |
+      +-------+
+      3 rows in set
+      TABLE
+      Hirb::Helpers::AutoTable.render(::Set.new([1,2,3])).should == expected_table
+    end
+  end
+end

data/test/object_table_test.rb

@@ -0,0 +1,49 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class Hirb::Helpers::ObjectTableTest < Test::Unit::TestCase
+  context "object table" do
+    before(:all) {
+      @pets = [stub(:name=>'rufus', :age=>7, :to_s=>'rufus'), stub(:name=>'alf', :age=>101, :to_s=>'alf')]
+    }
+    test "renders" do
+      expected_table = <<-TABLE.unindent
+      +-------+-----+
+      | name  | age |
+      +-------+-----+
+      | rufus | 7   |
+      | alf   | 101 |
+      +-------+-----+
+      2 rows in set
+      TABLE
+      Hirb::Helpers::ObjectTable.render(@pets, :fields=>[:name, :age]).should == expected_table
+    end
+    
+    test "with no options defaults to to_s field" do
+      expected_table = <<-TABLE.unindent
+      +-------+
+      | value |
+      +-------+
+      | rufus |
+      | alf   |
+      +-------+
+      2 rows in set
+      TABLE
+      Hirb::Helpers::ObjectTable.render(@pets).should == expected_table
+    end
+
+    test "renders simple arrays" do
+      expected_table = <<-TABLE.unindent
+      +-------+
+      | value |
+      +-------+
+      | 1     |
+      | 2     |
+      | 3     |
+      | 4     |
+      +-------+
+      4 rows in set
+      TABLE
+      Hirb::Helpers::ObjectTable.render([1,2,3,4]).should == expected_table
+    end
+  end  
+end

data/test/table_test.rb

@@ -42,7 +42,7 @@ class Hirb::Helpers::TableTest < Test::Unit::TestCase
       TABLE
       table([{'a'=>1, 'b'=>2}, {'a'=>3, 'b'=>4}]).should == expected_table
     end
-    
+
     test "with array only rows renders" do
       expected_table = <<-TABLE.unindent
       +---+---+
@@ -55,11 +55,13 @@ class Hirb::Helpers::TableTest < Test::Unit::TestCase
       TABLE
       table([[1,2], [3,4]]).should == expected_table
     end
-    
-    test "with too many fields raises error" do
-      assert_raises(Hirb::Helpers::Table::TooManyFieldsForWidthError) { table([Array.new(70, 'AAA')]) }
+
+    test "with too many fields defaults to vertical table" do
+      rows = [Array.new(25, "A"* 10)]
+      Hirb::Helpers::VerticalTable.expects(:render).with(rows, anything)
+      capture_stderr { table(rows)}.should =~ /Error/
     end
-    
+
     test "with no rows renders" do
       table([]).should == "0 rows in set"
     end
@@ -248,72 +250,21 @@ class Hirb::Helpers::TableTest < Test::Unit::TestCase
       TABLE
       table([['a','b'], ['c', 'd']], :number=>true).should == expected_table
     end
-  end
-  
-  context "object table" do
-    before(:all) {
-      @pets = [stub(:name=>'rufus', :age=>7, :to_s=>'rufus'), stub(:name=>'alf', :age=>101, :to_s=>'alf')]
-    }
-    test "renders" do
-      expected_table = <<-TABLE.unindent
-      +-------+-----+
-      | name  | age |
-      +-------+-----+
-      | rufus | 7   |
-      | alf   | 101 |
-      +-------+-----+
-      2 rows in set
-      TABLE
-      Hirb::Helpers::ObjectTable.render(@pets, :fields=>[:name, :age]).should == expected_table
-    end
-    
-    test "with no options defaults to to_s field" do
-      expected_table = <<-TABLE.unindent
-      +-------+
-      | value |
-      +-------+
-      | rufus |
-      | alf   |
-      +-------+
-      2 rows in set
-      TABLE
-      Hirb::Helpers::ObjectTable.render(@pets).should == expected_table
-    end
 
-    test "renders simple arrays" do
+    test "vertical option renders vertical table" do
       expected_table = <<-TABLE.unindent
-      +-------+
-      | value |
-      +-------+
-      | 1     |
-      | 2     |
-      | 3     |
-      | 4     |
-      +-------+
-      4 rows in set
-      TABLE
-      Hirb::Helpers::ObjectTable.render([1,2,3,4]).should == expected_table
-    end
-  end
-  
-  context "activerecord table" do
-    before(:all) {
-      @pets = [stub(:name=>'rufus', :age=>7, :class=>mock(:column_names=>[:age, :name])), stub(:name=>'alf', :age=>101)]
-    }
-    test "renders" do
-      expected_table = <<-TABLE.unindent
-      +-----+-------+
-      | age | name  |
-      +-----+-------+
-      | 7   | rufus |
-      | 101 | alf   |
-      +-----+-------+
+      *** 1. row ***
+      a: 1
+      b: 2
+      *** 2. row ***
+      a: 3
+      b: 4
       2 rows in set
       TABLE
-      Hirb::Helpers::ActiveRecordTable.render(@pets).should == expected_table
+      table([{:a=>1, :b=>2}, {:a=>3, :b=>4}], :vertical=>true).should == expected_table
     end
   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/test_helper.rb

@@ -24,6 +24,17 @@ class Test::Unit::TestCase
     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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: cldwalker-hirb
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors: 
 - Gabriel Horner
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-20 00:00:00 -07:00
+date: 2009-06-29 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -39,17 +39,21 @@ files:
 - lib/hirb/helpers/parent_child_tree.rb
 - lib/hirb/helpers/table.rb
 - lib/hirb/helpers/tree.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/activerecord_base.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
@@ -83,11 +87,14 @@ 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/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