hirb 0.2.2 → 0.2.3

data/CHANGELOG.rdoc

@@ -1,3 +1,7 @@
+== 0.2.3
+* Added UTF-8 support for Ruby 1.8.x
+* Added :all_fields option to Table helper.
+
 == 0.2.2
 * Added a friendlier default (a vertical table) to incorrectly configured tables.
 * Added vertical table helper thanks to chrononaut.

data/VERSION.yml

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

data/lib/hirb.rb

@@ -1,6 +1,11 @@
 current_dir = File.dirname(__FILE__)
 $:.unshift(current_dir) unless $:.include?(current_dir) || $:.include?(File.expand_path(current_dir))
+
+# Needed by Hirb::String to handle multibyte characters
+$KCODE = 'u' if RUBY_VERSION < '1.9'
+
 require 'hirb/util'
+require 'hirb/string'
 require 'hirb/hash_struct'
 require 'hirb/helpers'
 require 'hirb/view'

data/lib/hirb/helpers/table.rb

@@ -24,7 +24,8 @@
 # By default, the fields/columns are the keys of the first hash.
 #--
 # derived from http://gist.github.com/72234
-class Hirb::Helpers::Table
+module Hirb
+ class Helpers::Table
   BORDER_LENGTH = 3 # " | " and "-+-" are the borders
   class TooManyFieldsForWidthError < StandardError; end
 
@@ -44,6 +45,7 @@ class Hirb::Helpers::Table
     # [: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.
+    # [:all_fields] When set to true, renders fields in all rows. Valid only in rows that are hashes. Default is false.
     # Examples:
     #    Hirb::Helpers::Table.render [[1,2], [2,3]]
     #    Hirb::Helpers::Table.render [[1,2], [2,3]], :field_lengths=>{0=>10}
@@ -51,11 +53,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={})
-      options.delete(:vertical) ? Hirb::Helpers::VerticalTable.render(rows, options) : new(rows, options).render
+      options.delete(:vertical) ? 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)
+      Helpers::VerticalTable.render(rows, options)
     end
   end
   
@@ -63,8 +65,7 @@ class Hirb::Helpers::Table
   def initialize(rows, options={})
     @options = options
     @options[:filters] ||= {}
-    @fields = @options[:fields] ? @options[:fields].dup : ((rows[0].is_a?(Hash)) ? rows[0].keys.sort {|a,b| a.to_s <=> b.to_s} :
-      rows[0].is_a?(Array) ? (0..rows[0].length - 1).to_a : [])
+    @fields = set_fields(rows)
     @rows = setup_rows(rows)
     @headers = @fields.inject({}) {|h,e| h[e] = e.to_s; h}
     if @options.has_key?(:headers)
@@ -76,7 +77,20 @@ class Hirb::Helpers::Table
       @fields.unshift :hirb_number
     end
   end
-  
+
+  def set_fields(rows)
+    if @options[:fields]
+      @options[:fields].dup
+    else
+      if rows[0].is_a?(Hash)
+        keys = @options[:all_fields] ? rows.map {|e| e.keys}.flatten.uniq : rows[0].keys
+        keys.sort {|a,b| a.to_s <=> b.to_s}
+      else
+        rows[0].is_a?(Array) ? (0..rows[0].length - 1).to_a : []
+      end
+    end
+  end
+
   def setup_rows(rows)
     rows ||= []
     rows = [rows] unless rows.is_a?(Array)
@@ -123,13 +137,13 @@ class Hirb::Helpers::Table
   end
   
   def format_cell(value, cell_width)
-    text = value.length > cell_width ? 
+    text = String.size(value) > cell_width ?
       (
-      (cell_width < 5) ? value.slice(0,cell_width) : value.slice(0, cell_width - 3) + '...'
+      (cell_width < 5) ? String.slice(value, 0, cell_width) : String.slice(value, 0, cell_width - 3) + '...'
       ) : value
-    sprintf("%-#{cell_width}s", text)
+    String.ljust(text, cell_width)
   end
-  
+
   def render_rows
     @rows.map do |row|
       row = '| ' + @fields.map {|f|
@@ -148,7 +162,7 @@ class Hirb::Helpers::Table
     if @options[:field_lengths]
       @field_lengths.merge!(@options[:field_lengths])
     else
-      table_max_width = @options.has_key?(:max_width) ? @options[:max_width] : Hirb::View.width
+      table_max_width = @options.has_key?(:max_width) ? @options[:max_width] : View.width
       restrict_field_lengths(@field_lengths, table_max_width) if table_max_width
     end
   end
@@ -200,10 +214,10 @@ class Hirb::Helpers::Table
 
   # find max length for each field; start with the headers
   def default_field_lengths
-    field_lengths = @headers ? @headers.inject({}) {|h,(k,v)| h[k] = v.length; h} : {}
+    field_lengths = @headers ? @headers.inject({}) {|h,(k,v)| h[k] = String.size(v); h} : {}
     @rows.each do |row|
       @fields.each do |field|
-        len = row[field].length
+        len = String.size(row[field])
         field_lengths[field] = len if len > field_lengths[field].to_i
       end
     end
@@ -239,3 +253,4 @@ class Hirb::Helpers::Table
   end
   #:startdoc:
 end
+end

data/lib/hirb/helpers/vertical_table.rb

@@ -16,12 +16,12 @@ class Hirb::Helpers::VerticalTable < Hirb::Helpers::Table
 
   def render_rows
     i = 0
-    longest_header = @headers.values.sort_by {|e| e.length}.last.length
+    longest_header = Hirb::String.size @headers.values.sort_by {|e| Hirb::String.size(e) }.last
     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]}"
+        "#{Hirb::String.rjust(@headers[f], longest_header)}: #{row[f]}"
       }.join("\n")
       i+= 1
       row

data/lib/hirb/pager.rb

@@ -71,8 +71,8 @@ module Hirb
     def slice!(output, inspect_mode=false) #:nodoc:
       effective_height = @height - 2 # takes into account pager prompt
       if inspect_mode
-        sliced_output = output.slice(0, @width * effective_height)
-        output.replace output.slice(@width * effective_height..-1)
+        sliced_output = String.slice(output, 0, @width * effective_height)
+        output.replace String.slice(output, @width * effective_height, String.size(output))
         sliced_output
       else
         # could use output.scan(/[^\n]*\n?/) instead of split
@@ -84,11 +84,11 @@ module Hirb
 
     # Determines if string should be paged based on configured width and height.
     def activated_by?(string_to_page, inspect_mode=false)
-      inspect_mode ? (string_to_page.size > @height * @width) : (string_to_page.count("\n") > @height)
+      inspect_mode ? (String.size(string_to_page) > @height * @width) : (string_to_page.count("\n") > @height)
     end
 
     def resize(width, height) #:nodoc:
-      @width, @height = Hirb::View.determine_terminal_size(width, height)
+      @width, @height = View.determine_terminal_size(width, height)
     end
   end
 end

data/lib/hirb/string.rb

@@ -0,0 +1,43 @@
+module Hirb
+  # Provides string helpers to deal with UTF-8 and ruby 1.8.x
+  module String
+    extend self
+    # :stopdoc:
+    if RUBY_VERSION < '1.9'
+      def size(string)
+        string.scan(/./).length
+      end
+
+      def ljust(string, desired_length)
+        leftover = desired_length - size(string)
+        leftover > 0 ? string + " " * leftover : string
+      end
+
+      def rjust(string, desired_length)
+        leftover = desired_length - size(string)
+        leftover > 0 ? " " * leftover + string : string
+      end
+
+      def slice(string, start, finish)
+        string.scan(/./).slice(start, finish).join('')
+      end
+    else
+      def size(string)
+        string.length
+      end
+
+      def ljust(string, desired_length)
+        string.ljust(desired_length)
+      end
+
+      def rjust(string, desired_length)
+        string.rjust(desired_length)
+      end
+
+      def slice(*args)
+        string.slice(*args)
+      end
+    end
+    #:startdoc:
+  end
+end

data/test/formatter_test.rb

@@ -12,17 +12,17 @@ class FormatterTest < Test::Unit::TestCase
     test "klass_config merges ancestor options" do
       set_formatter "String"=>{:args=>[1,2]}, "Object"=>{:method=>:object_output, :ancestor=>true}, "Kernel"=>{:method=>:default_output}
       expected_result = {:method=>:object_output, :args=>[1, 2], :ancestor=>true}
-      @formatter.klass_config(String).should == expected_result
+      @formatter.klass_config(::String).should == expected_result
     end
 
     test "klass_config doesn't merge ancestor options" do
       set_formatter "String"=>{:args=>[1,2]}, "Object"=>{:method=>:object_output}, "Kernel"=>{:method=>:default_output}
       expected_result = {:args=>[1, 2]}
-      @formatter.klass_config(String).should == expected_result
+      @formatter.klass_config(::String).should == expected_result
     end
 
     test "klass_config returns hash when nothing found" do
-      set_formatter.klass_config(String).should == {}
+      set_formatter.klass_config(::String).should == {}
     end
 
     test "reload detects new Hirb::Views" do

data/test/table_test.rb

@@ -65,6 +65,21 @@ class Hirb::Helpers::TableTest < Test::Unit::TestCase
     test "with no rows renders" do
       table([]).should == "0 rows in set"
     end
+
+    test "renders utf8" do
+      expected_table = <<-TABLE.unindent
+      +--------------------+
+      | name               |
+      +--------------------+
+      | ｱｲｳｴｵｶｷ            |
+      | ｸｹｺｻｼｽｾｿﾀﾁﾂﾃ       |
+      | Tata l'asticote    |
+      | toto létoile PAOLI |
+      +--------------------+
+      4 rows in set
+      TABLE
+      table([{:name=>"ｱｲｳｴｵｶｷ"}, {:name=>"ｸｹｺｻｼｽｾｿﾀﾁﾂﾃ"}, {:name=>"Tata l'asticote"}, {:name=>"toto létoile PAOLI"}]).should == expected_table
+    end
   end
 
   context "table with" do
@@ -263,6 +278,19 @@ class Hirb::Helpers::TableTest < Test::Unit::TestCase
       TABLE
       table([{:a=>1, :b=>2}, {:a=>3, :b=>4}], :vertical=>true).should == expected_table
     end
+
+    test "all_fields option renders all fields" do
+      expected_table = <<-TABLE.unindent
+      +---+---+---+
+      | a | b | c |
+      +---+---+---+
+      | 1 | 2 |   |
+      | 3 |   | 4 |
+      +---+---+---+
+      2 rows in set
+      TABLE
+      table([{:a=>1, :b=>2}, {:a=>3, :c=>4}], :all_fields=>true).should == expected_table
+    end
   end
   
   test "restrict_field_lengths ensures columns total doesn't exceed max width" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: hirb
 version: !ruby/object:Gem::Version 
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors: 
 - Gabriel Horner
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-30 00:00:00 -04:00
+date: 2009-07-08 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -43,6 +43,7 @@ files:
 - lib/hirb/import_object.rb
 - lib/hirb/menu.rb
 - lib/hirb/pager.rb
+- lib/hirb/string.rb
 - lib/hirb/util.rb
 - lib/hirb/view.rb
 - lib/hirb/views/activerecord_base.rb