hirb 0.3.6 → 0.4.0

data/CHANGELOG.rdoc

@@ -1,3 +1,7 @@
+== 0.4.0
+* Add unicode table helper thanks to janlelis
+* Make pager compatible with full width characters
+
 == 0.3.6
 * Tweak ripl support
 * Allow override of :hirb_number thanks to asanghi.

data/README.rdoc

@@ -16,6 +16,10 @@ Install the gem with:
 
     gem install hirb
 
+For people using full-width unicode characters, install {hirb-unicode}[https://github.com/miaout17/hirb-unicode]:
+
+    gem install hirb-unicode
+
 == View Tutorials
 
 * To create and configure views, see Hirb::View or {here if on the web}[http://tagaholic.me/hirb/doc/classes/Hirb/View.html].
@@ -34,8 +38,8 @@ fields from an array of arrays. See
 == Rails Example
 
 Let's load and enable the view framework:
-  $ script/console
-  Loading local environment (Rails 2.3.5)
+  $ rails console
+  Loading local environment (Rails 3.0.3)
   >> require 'hirb'
   => true
   >> Hirb.enable
@@ -102,6 +106,15 @@ tables/views for any output object:
   >> extend Hirb::Console
   => main
 
+  # Create a unicode table
+  >> table [[:a, :b, :c]], :unicode => true
+  ┌───┬───┬───┐
+  │ 0 │ 1 │ 2 │
+  ├───┼───┼───┤
+  │ a ╎ b ╎ c │
+  └───┴───┴───┘
+  1 row in set
+
   # Create a table of Dates comparing them with different formats.
   >> table [Date.today, Date.today.next_month], :fields=>[:to_s, :ld, :ajd, :amjd, :asctime]
   +------------+--------+-----------+-------+--------------------------+
@@ -120,7 +133,7 @@ If these console methods weren't convenient enough, try:
 
   # Imports view() to all objects.
   >> require 'hirb/import_object'
-  =>true
+  => true
   # Yields same table as above examples.
   >> [Date.today, Date.today.next_month].view :class=>:object_table,
     :fields=>[:to_s, :ld, :ajd, :amjd, :asctime]
@@ -135,7 +148,7 @@ Although views by default are printed to STDOUT, they can be easily modified to
 
   # Doesn't write to file because Symbol doesn't have a view and thus defaults to irb's echo mode.
   >> :blah
-  =>:blah
+  => :blah
 
   # Go back to printing Hirb views to STDOUT.
   >> Hirb::View.reset_render_method
@@ -166,6 +179,7 @@ Table code from http://gist.github.com/72234 and {my console app's needs}[http:/
 
 == Credits
 * Chrononaut for vertical table helper.
+* janlelis for unicode table helper.
 * crafterm, spastorino, xaviershay, bogdan, asanghi and joshua for patches.
 
 == Bugs/Issues

data/lib/bond/completions/hirb.rb

@@ -4,7 +4,7 @@ complete(:methods=>%w{Hirb::View.enable Hirb.enable}) {
 complete(:methods=>%w{Hirb::Helpers::Table.render table}) {
   %w{fields headers max_fields max_width resize number change_fields}+
   %w{filters header_filter filter_any filter_classes vertical all_fields}+
-  %w{description escape_special_chars table_class hide_empty}
+  %w{description escape_special_chars table_class hide_empty unicode}
 }
 complete(:method=>"Hirb::Helpers::Tree.render") {
   %w{type validate indent limit description multi_line_nodes value_method children_method}

data/lib/hirb/helpers.rb

@@ -12,6 +12,7 @@ module Hirb
   end
 end
 
-%w{table object_table auto_table tree parent_child_tree vertical_table}.each do |e|
+%w{table object_table auto_table tree parent_child_tree vertical_table
+  unicode_table}.each do |e|
   require "hirb/helpers/#{e}"
-end
+end

data/lib/hirb/helpers/table.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 require 'hirb/helpers/table/filters'
 require 'hirb/helpers/table/resizer'
 
@@ -62,6 +63,14 @@ module Hirb
   MIN_FIELD_LENGTH = 3
   class TooManyFieldsForWidthError < StandardError; end
 
+  CHARS = {
+    :top => {:left => '+', :center => '+', :right => '+', :horizontal => '-',
+      :vertical => {:outside => '|', :inside => '|'} },
+    :middle => {:left => '+', :center => '+', :right => '+', :horizontal => '-'},
+    :bottom => {:left => '+', :center => '+', :right => '+', :horizontal => '-',
+      :vertical => {:outside => '|', :inside => '|'} }
+  }
+
   class << self
     
     # Main method which returns a formatted table.
@@ -86,6 +95,7 @@ module Hirb
     #                 Default Hirb::Helpers::Table.filter_any().
     # [*:filter_classes*] Hash which maps classes to filters. Default is Hirb::Helpers::Table.filter_classes().
     # [*:vertical*] When set to true, renders a vertical table using Hirb::Helpers::VerticalTable. Default is false.
+    # [*:unicode*] When set to true, renders a unicode table using Hirb::Helpers::UnicodeTable. 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.
     # [*:escape_special_chars*] When set to true, escapes special characters \n,\t,\r so they don't disrupt tables. Default is false for
@@ -99,9 +109,10 @@ module Hirb
     #    Hirb::Helpers::Table.render [{:age=>10, :weight=>100}, {:age=>80, :weight=>500}], :filters=>{:age=>[:to_f]}
     def render(rows, options={})
       options[:vertical] ? Helpers::VerticalTable.render(rows, options) :
+      options[:unicode]  ? Helpers::UnicodeTable.render(rows, options) :
       new(rows, options).render
     rescue TooManyFieldsForWidthError
-      $stderr.puts "", "** Error: Too many fields for the current width. Configure your width " +
+      $stderr.puts "", "** Hirb Warning: Too many fields for the current width. Configure your width " +
         "and/or fields to avoid this error. Defaulting to a vertical table. **"
       Helpers::VerticalTable.render(rows, options)
     end
@@ -117,6 +128,10 @@ module Hirb
   end
   self.filter_classes = { Array=>:comma_join, Hash=>:inspect }
 
+  def chars
+    self.class.const_get(:CHARS)
+  end
+
   #:stopdoc:
   attr_accessor :width, :max_fields, :field_lengths, :fields
   def initialize(rows, options={})
@@ -198,22 +213,26 @@ module Hirb
   end
 
   def render_header
-    @headers ? render_table_header : [render_border]
+    @headers ? render_table_header : [render_border(:top)]
   end
 
   def render_footer
-    [render_border]
+    [render_border(:bottom)]
   end
 
   def render_table_header
-    title_row = '| ' + @fields.map {|f|
-      format_cell(@headers[f], @field_lengths[f])
-    }.join(' | ') + ' |'
-    [render_border, title_row, render_border]
+    title_row = chars[:top][:vertical][:outside] + ' ' +
+      @fields.map {|f| format_cell(@headers[f], @field_lengths[f]) }.
+      join(' ' + chars[:top][:vertical][:inside] +' ') +
+      ' ' + chars[:top][:vertical][:outside]
+    [render_border(:top), title_row, render_border(:middle)]
   end
   
-  def render_border
-    '+-' + @fields.map {|f| '-' * @field_lengths[f] }.join('-+-') + '-+'
+  def render_border(which)
+    chars[which][:left] + chars[which][:horizontal] +
+      @fields.map {|f| chars[which][:horizontal] * @field_lengths[f] }.
+      join(chars[which][:horizontal] + chars[which][:center] + chars[which][:horizontal]) +
+      chars[which][:horizontal] + chars[which][:right]
   end
   
   def format_cell(value, cell_width)
@@ -226,9 +245,9 @@ module Hirb
 
   def render_rows
     @rows.map do |row|
-      row = '| ' + @fields.map {|f|
+      row = chars[:bottom][:vertical][:outside] + ' ' + @fields.map {|f|
         format_cell(row[f], @field_lengths[f])
-      }.join(' | ') + ' |'
+      }.join(' ' +chars[:bottom][:vertical][:inside] + ' ') + ' ' + chars[:bottom][:vertical][:outside]
     end
   end
   

data/lib/hirb/helpers/unicode_table.rb

@@ -0,0 +1,15 @@
+# -*- encoding : utf-8 -*-
+class Hirb::Helpers::UnicodeTable < Hirb::Helpers::Table
+  CHARS = {
+    :top => {:left => '┌', :center => '┬', :right => '┐', :horizontal => '─',
+      :vertical => {:outside => '│', :inside => '│'} },
+    :middle => {:left => '├', :center => '┼', :right => '┤', :horizontal => '─'},
+    :bottom => {:left => '└', :center => '┴', :right => '┘', :horizontal => '─',
+      :vertical => {:outside => '│', :inside => '╎'} }
+  }
+
+  # Renders a unicode table
+  def self.render(rows, options={})
+    new(rows, options).render
+  end
+end

data/lib/hirb/pager.rb

@@ -73,7 +73,7 @@ module Hirb
       effective_height = @height - 2 # takes into account pager prompt
       if inspect_mode
         sliced_output = String.slice(output, 0, @width * effective_height)
-        output.replace String.slice(output, @width * effective_height, String.size(output))
+        output.replace String.slice(output, char_count(sliced_output), String.size(output))
         sliced_output
       else
         # could use output.scan(/[^\n]*\n?/) instead of split
@@ -88,6 +88,16 @@ module Hirb
       inspect_mode ? (String.size(string_to_page) > @height * @width) : (string_to_page.count("\n") > @height)
     end
 
+    if String.method_defined? :chars
+      def char_count(string) #:nodoc:
+        string.chars.count
+      end
+    else
+      def char_count(string) #:nodoc:
+        String.size(string)
+      end
+    end
+
     def resize(width, height) #:nodoc:
       @width, @height = View.determine_terminal_size(width, height)
     end

data/lib/hirb/version.rb

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

data/test/table_test.rb

@@ -70,7 +70,7 @@ describe "Table" do
     it "with too many fields defaults to vertical table" do
       rows = [Array.new(25, "A"* 10)]
       Helpers::VerticalTable.expects(:render).with(rows, anything)
-      capture_stderr { table(rows)}.should =~ /Error/
+      capture_stderr { table(rows)}.should =~ /Warning:/
     end
 
     it "with no rows renders" do
@@ -439,6 +439,19 @@ describe "Table" do
       table([{:a=>'', :b=>2}, {:a=>3, :b=>nil}], :hide_empty=>true, :vertical=>true).should == expected_table
     end
 
+    it "unicode option renders" do
+      expected_table = <<-TABLE.unindent
+      ┌───┬───┐
+      │ a │ b │
+      ├───┼───┤
+      │ 1 ╎ 2 │
+      │ 3 ╎ 4 │
+      └───┴───┘
+      2 rows in set
+      TABLE
+      table([{:a=>1, :b=>2}, {:a=>3, :b=>4}], :unicode => true).should == expected_table
+    end
+
     it "all_fields option renders all fields" do
       expected_table = <<-TABLE.unindent
       +---+---+---+

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: hirb
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 15
   prerelease: false
   segments: 
   - 0
-  - 3
-  - 6
-  version: 0.3.6
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Gabriel Horner
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-08 00:00:00 -05:00
+date: 2011-02-22 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -97,6 +97,7 @@ files:
 - lib/hirb/helpers/table/resizer.rb
 - lib/hirb/helpers/table.rb
 - lib/hirb/helpers/tree.rb
+- lib/hirb/helpers/unicode_table.rb
 - lib/hirb/helpers/vertical_table.rb
 - lib/hirb/helpers.rb
 - lib/hirb/import_object.rb