hirb 0.2.8 → 0.2.9

data/CHANGELOG.rdoc

@@ -1,5 +1,10 @@
+== 0.2.9
+* Added newline filtering and :no_newlines option for table helper.
+* Added default filters for hashes that have hash values.
+* Bug fix for deprecated to_a call.
+
 == 0.2.8
-* Added callbacks to Hirb::Helper::Table.
+* Added callbacks to Hirb::Helpers::Table.
 * Added :change_fields option to Hirb::Helpers::Table.
 * Added terminal size detection for jruby.
 * Bug fix for paging long outputs.

data/VERSION.yml

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

data/lib/hirb/helpers/auto_table.rb

@@ -2,14 +2,15 @@
 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)
+    options[:_original_class] = output.class
+    output = Array(output)
+    klass = if (output[0].is_a?(ActiveRecord::Base) rescue false)
       Hirb::Helpers::ActiveRecordTable
-    elsif (output.is_a?(Array) && !(output[0].is_a?(Hash) || output[0].is_a?(Array)))
+    elsif !(output[0].is_a?(Hash) || output[0].is_a?(Array))
       Hirb::Helpers::ObjectTable
     else
       Hirb::Helpers::Table
     end
     klass.render(output, options)
   end
-end
+end

data/lib/hirb/helpers/table.rb

@@ -23,6 +23,35 @@ module Hirb
 #   +-----+--------+
 #
 # By default, the fields/columns are the keys of the first hash.
+#
+# === Custom Callbacks
+# Callback methods can be defined to add your own options that modify rows right before they are rendered.
+# Here's an example that allows for searching with a :query option:
+#   module Query
+#     # Searches fields given a query hash
+#     def query_callback(rows, options)
+#       return rows unless options[:query]
+#       options[:query].map {|field,query|
+#         rows.select {|e| e[field].to_s =~ /#{query}/i }
+#       }.flatten.uniq
+#     end
+#   end
+#   Hirb::Helpers::Table.send :include, Query
+#
+#   >> puts Hirb::Helpers::Table.render [{:name=>'batman'}, {:name=>'robin'}], :query=>{:name=>'rob'}
+#   +-------+
+#   | name  |
+#   +-------+
+#   | robin |
+#   +-------+
+#   1 row in set
+#
+# Callback methods:
+# * must be defined in Helpers::Table and end in '_callback'.
+# * should expect rows and a hash of render options. Rows will be an array of hashes.
+# * are expected to return an array of hashes.
+# * are invoked in alphabetical order.
+# For a thorough example, see {Boson::Pipe}[http://github.com/cldwalker/boson/blob/master/lib/boson/pipe.rb].
 #--
 # derived from http://gist.github.com/72234
  class Helpers::Table
@@ -42,16 +71,19 @@ module Hirb
     # [:max_width] The maximum allowed width of all fields put together. This option is enforced except when the field_lengths option is set.
     #              This doesn't count field borders as part of the total.
     # [:number]  When set to true, numbers rows by adding a :hirb_number column as the first column. Default is false.
-    # [:change_fields] A hash to change old field names to new field names. This is useful when wanting to change auto-generated keys to
-    #                  more user-friendly names i.e. for array of arrays.
+    # [:change_fields] A hash to change old field names to new field names. This can also be an array of new names but only for array rows.
+    #                  This is useful when wanting to change auto-generated keys to more user-friendly names i.e. for array rows.
     # [: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.
     # [:description] When set to true, renders row count description at bottom. Default is true.
+    # [:no_newlines] When set to true, stringifies newlines so they don't disrupt tables. Default is false for vertical tables
+    #                and true for anything else.
     # Examples:
     #    Hirb::Helpers::Table.render [[1,2], [2,3]]
     #    Hirb::Helpers::Table.render [[1,2], [2,3]], :field_lengths=>{0=>10}
+    #    Hirb::Helpers::Table.render [['a',1], ['b',2]], :change_fields=>%w{letters numbers}
     #    Hirb::Helpers::Table.render [{:age=>10, :weight=>100}, {:age=>80, :weight=>500}]
     #    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]}
@@ -66,7 +98,8 @@ module Hirb
   
   #:stopdoc:
   def initialize(rows, options={})
-    @options = {:description=>true, :filters=>{}, :change_fields=>{}}.merge(options)
+    @options = {:description=>true, :filters=>{}, :change_fields=>{}, :no_newlines=>true}.merge(options)
+    @options[:change_fields] = array_to_indices_hash(@options[:change_fields]) if @options[:change_fields].is_a?(Array)
     @fields = set_fields(rows)
     @rows = setup_rows(rows)
     @headers = @fields.inject({}) {|h,e| h[e] = e.to_s; h}
@@ -235,7 +268,14 @@ module Hirb
     field_lengths
   end
 
+  def set_filter_defaults(rows)
+    if @options[:_original_class] == Hash && @fields[1] && rows.any? {|e| e[@fields[1]].is_a?(Hash) }
+      (@options[:filters] ||= {})[@fields[1]] ||= :inspect
+    end
+  end
+
   def filter_values(rows)
+    set_filter_defaults(rows)
     rows.map {|row|
       new_row = {}
       @fields.each {|f|
@@ -254,6 +294,7 @@ module Hirb
     rows.each {|row|
       @fields.each {|f|
         row[f] = row[f].to_s || ''
+        row[f].gsub!("\n", '\n') if @options[:no_newlines]
       }
     }
   end

data/lib/hirb/helpers/vertical_table.rb

@@ -3,7 +3,7 @@ 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
+    new(rows, {:no_newlines=>false}.merge(options)).render
   end
 
   #:stopdoc:

data/test/auto_table_test.rb

@@ -16,5 +16,32 @@ class Hirb::Helpers::AutoTableTest < Test::Unit::TestCase
       TABLE
       Hirb::Helpers::AutoTable.render(::Set.new([1,2,3])).should == expected_table
     end
+
+    test "converts hash with any value hashes to inspected values" do
+      expected_table = <<-TABLE.unindent
+      +---+---------+
+      | 0 | 1       |
+      +---+---------+
+      | c | "ok"    |
+      | a | {:b=>1} |
+      +---+---------+
+      2 rows in set
+      TABLE
+      Hirb::Helpers::AutoTable.render({:a=>{:b=>1}, :c=>'ok'}).should == expected_table
+    end
+
+    test "doesn't convert hash with value hashes if filter exists for value" do
+      expected_table = <<-TABLE.unindent
+      +------+-------+
+      | name | value |
+      +------+-------+
+      | c    | ok    |
+      | a    | b1    |
+      +------+-------+
+      2 rows in set
+      TABLE
+      Hirb::Helpers::AutoTable.render({:a=>{:b=>1}, :c=>'ok'}, :change_fields=>['name', 'value'],
+       :filters=>{'value'=>:to_s}).should == expected_table
+    end
   end
 end

data/test/table_test.rb

@@ -80,6 +80,19 @@ class Hirb::Helpers::TableTest < Test::Unit::TestCase
       TABLE
       table([{:name=>"ｱｲｳｴｵｶｷ"}, {:name=>"ｸｹｺｻｼｽｾｿﾀﾁﾂﾃ"}, {:name=>"Tata l'asticote"}, {:name=>"toto létoile PAOLI"}]).should == expected_table
     end
+
+    test "with newlines renders with newlines stringified" do
+      expected_table = <<-TABLE.unindent
+      +-----+---+
+      | a   | b |
+      +-----+---+
+      | 1#{'\n'} | 2 |
+      | 3   | 4 |
+      +-----+---+
+      2 rows in set
+      TABLE
+      table([{'a'=>"1\n", 'b'=>2}, {'a'=>3, 'b'=>4}]).should == expected_table
+    end
   end
 
   context "table with" do
@@ -291,6 +304,20 @@ class Hirb::Helpers::TableTest < Test::Unit::TestCase
       table([{:a=>1, :b=>2}, {:a=>3, :b=>4}], :vertical=>true).should == expected_table
     end
 
+    test "vertical option renders vertical table with newlines" do
+      expected_table = <<-TABLE.unindent
+      *** 1. row ***
+      a: 1
+      b: 2
+      *** 2. row ***
+      a: 3
+      b: 4
+      and one
+      2 rows in set
+      TABLE
+      table([{:a=>1, :b=>2}, {:a=>3, :b=>"4\nand one"}], :vertical=>true).should == expected_table
+    end
+
     test "vertical option renders vertical table successively" do
       expected_table = <<-TABLE.unindent
       *** 1. row ***

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: hirb
 version: !ruby/object:Gem::Version 
-  version: 0.2.8
+  version: 0.2.9
 platform: ruby
 authors: 
 - Gabriel Horner
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-07 00:00:00 -05:00
+date: 2009-11-19 00:00:00 -05:00
 default_executable: 
 dependencies: []