formatador 0.2.1 → 0.2.2

data/README.rdoc

@@ -27,6 +27,33 @@ You use tags, similar to html, to set formatting options:
 * display_compact_table: Same as display_table, execpt that split lines are not drawn by default in the body of the table. If you need a split line, put a :split constant in the body array.
 * redisplay_progressbar: takes the current and total values as its first two arguments and redisplays a progressbar (until current = total and then it display_lines). An optional third argument represents the start time and will add an elapsed time counter.
 
+=== Table examples
+
+  table_data = [{:name => "Joe", :food => "Burger"}, {:name => "Bill", :food => "French fries"}]
+  Formatador.display_table(table_data)
+
+  +------+--------------+
+  | name | food         |
+  +------+--------------+
+  | Joe  | Burger       |
+  +------+--------------+
+  | Bill | French fries |
+  +------+--------------+
+
+  table_data = [
+    {:name => "Joe", :meal => {:main_dish => "Burger", :drink => "water"}, 
+    {:name => "Bill", :meal => {:main_dish => "Chicken", drink => "soda"}
+  ]
+  Formatador.display_table(table_data, [:name, :"meal.drink"])
+
+  +------+------------+
+  | name | meal.drink |
+  +------+------------+
+  | Joe  | water      |
+  +------+------------+
+  | Bill | soda       |
+  +------+------------+
+
 == Indentation
 
 By initializing a formatador object you can keep track of indentation:

data/formatador.gemspec

@@ -13,8 +13,8 @@ Gem::Specification.new do |s|
   ## If your rubyforge_project name is different, then edit it and comment out
   ## the sub! line in the Rakefile
   s.name              = 'formatador'
-  s.version           = '0.2.1'
-  s.date              = '2011-09-01'
+  s.version           = '0.2.2'
+  s.date              = '2012-05-16'
   s.rubyforge_project = 'formatador'
 
   ## Make sure your summary is short. The description may be as long

data/lib/formatador.rb

@@ -3,7 +3,7 @@ require File.join(File.dirname(__FILE__), 'formatador', 'progressbar')
 
 class Formatador
 
-  VERSION = '0.2.1'
+  VERSION = '0.2.2'
 
   STYLES = {
     :"\/"             => "0",

data/lib/formatador/progressbar.rb

@@ -4,9 +4,9 @@ class Formatador
     options = { :color => 'white', :width => 50, :new_line => true }.merge!(options)
     data = progressbar(current, total, options)
     if current < total
-      redisplay(data)
+      redisplay(data, options[:width])
     else
-      redisplay("#{data}")
+      redisplay("#{data}", options[:width])
       if options[:new_line]
         new_line
       end

data/lib/formatador/table.rb

@@ -10,54 +10,61 @@ class Formatador
   def display_compact_table(hashes, keys = nil, &block)
     headers = keys || []
     widths = {}
+
+    # Calculate Widths
     if hashes.empty? && keys
-      for key in keys
+      keys.each do |key|
         widths[key] = key.to_s.length
       end
     else
-      for hash in hashes
+      hashes.each do |hash|
         next unless hash.respond_to?(:keys)
 
-        for key in hash.keys
-          unless keys
+        (headers + hash.keys).each do |key|
+          if !keys
             headers << key
           end
-          widths[key] = [ length(key), widths[key] || 0, hash[key] && length(hash[key]) || 0].max
+          widths[key] = [ length(key), widths[key] || 0, length(calculate_datum(key, hash)) || 0].max
         end
         headers = headers.uniq
       end
     end
 
+    # Determine order of headers
     if block_given?
       headers = headers.sort(&block)
     elsif !keys
       headers = headers.sort {|x,y| x.to_s <=> y.to_s}
     end
 
+    # Display separator row
     split = "+"
     if headers.empty?
       split << '--+'
     else
-      for header in headers
+      headers.each do |header|
         widths[header] ||= length(header)
         split << ('-' * (widths[header] + 2)) << '+'
       end
     end
-
     display_line(split)
+
+    # Display data row
     columns = []
-    for header in headers
+    headers.each do |header|
       columns << "[bold]#{header}[/]#{' ' * (widths[header] - header.to_s.length)}"
     end
     display_line("| #{columns.join(' | ')} |")
     display_line(split)
 
-    for hash in hashes
+    hashes.each do |hash|
       if hash.respond_to? :keys
         columns = []
-        for header in headers
-          datum = hash[header] || ''
-          columns << "#{datum}#{' ' * (widths[header] - length(datum))}"
+        headers.each do |header|
+          datum = calculate_datum(header, hash)
+          width = widths[header] - length(datum)
+          width = width < 0 ? 0 : width
+          columns << "#{datum}#{' ' * width}"
         end
         display_line("| #{columns.join(' | ')} |")
       else
@@ -75,4 +82,17 @@ class Formatador
   def length(value)
     value.to_s.gsub(PARSE_REGEX, '').length
   end
+
+  def calculate_datum(header, hash)
+    if (splits = header.to_s.split('.')).length > 1
+      datum = nil
+      splits.each do |split|
+        d = (datum||hash)
+        datum = d[split] || d[split.to_sym] || ''
+      end
+    else
+      datum = hash[header] || ''
+    end
+    datum
+  end
 end

data/tests/basic_tests.rb

@@ -1,4 +1,4 @@
-Shindo.tests("Formatador") do
+Shindo.tests("Formatador: basics") do
 
   tests("#display_line(Formatador)").returns("    Formatador\n") do
     capture_stdout do
@@ -10,6 +10,7 @@ output = <<-OUTPUT
     one
     two
 OUTPUT
+output = Formatador.parse(output)
 
   tests("#display_lines(['one', 'two']").returns(output) do
     capture_stdout do

data/tests/table_tests.rb

@@ -1,14 +1,15 @@
-Shindo.tests("Formatador") do
+Shindo.tests("Formatador: tables") do
 
 output = <<-OUTPUT
     +---+
-    | \e[1ma\e[0m |
+    | [bold]a[/] |
     +---+
     | 1 |
     +---+
     | 2 |
     +---+
 OUTPUT
+output = Formatador.parse(output)
 
   tests("#display_table([{:a => 1}, {:a => 2}])").returns(output) do
     capture_stdout do
@@ -18,10 +19,11 @@ OUTPUT
 
 output = <<-OUTPUT
     +--------+
-    | \e[1mheader\e[0m |
+    | [bold]header[/] |
     +--------+
     +--------+
 OUTPUT
+output = Formatador.parse(output)
 
   tests("#display_table([], [:header])").returns(output) do
     capture_stdout do
@@ -31,11 +33,12 @@ OUTPUT
 
 output = <<-OUTPUT
     +--------+
-    | \e[1mheader\e[0m |
+    | [bold]header[/] |
     +--------+
     |        |
     +--------+
 OUTPUT
+output = Formatador.parse(output)
 
   tests("#display_table([{:a => 1}], [:header])").returns(output) do
     capture_stdout do
@@ -43,4 +46,36 @@ OUTPUT
     end
   end
 
-end
+
+
+output = <<-OUTPUT
+    +---+------------+
+    | [bold]a[/] | [bold]nested.key[/] |
+    +---+------------+
+    | 1 | value      |
+    +---+------------+
+OUTPUT
+output = Formatador.parse(output)
+
+  tests("#display_table([{:a => 1, :nested => {:key => 'value'}}], [:header, :'nested.key'])").returns(output) do
+    capture_stdout do
+      Formatador.display_table([{:a => 1, :nested => {:key => 'value'}}], [:a, :'nested.key'])
+    end
+  end
+
+output = <<-OUTPUT
+    +---+-----------------+
+    | [bold]a[/] | [bold]nested[/]          |
+    +---+-----------------+
+    | 1 | {:key=>"value"} |
+    +---+-----------------+
+OUTPUT
+output = Formatador.parse(output)
+
+  tests("#display_table([{:a => 1, :nested => {:key => 'value'}}])").returns(output) do
+    capture_stdout do
+      Formatador.display_table([{:a => 1, :nested => {:key => 'value'}}])
+    end
+  end
+
+end

data/tests/tests_helper.rb

@@ -3,6 +3,7 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'formatador'
 require 'rubygems'
 require 'shindo'
+require 'stringio'
 
 def capture_stdout
   old_stdout = $stdout

metadata

@@ -1,59 +1,45 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: formatador
-version: !ruby/object:Gem::Version 
-  hash: 21
+version: !ruby/object:Gem::Version
+  version: 0.2.2
   prerelease: 
-  segments: 
-  - 0
-  - 2
-  - 1
-  version: 0.2.1
 platform: ruby
-authors: 
+authors:
 - geemus (Wesley Beary)
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-09-01 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-05-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rake
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70155363939860 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: shindo
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70155363939860
+- !ruby/object:Gem::Dependency
+  name: shindo
+  requirement: &70155363961280 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: *70155363961280
 description: STDOUT text formatting
 email: geemus@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.rdoc
-files: 
+files:
 - Gemfile
 - README.rdoc
 - Rakefile
@@ -66,36 +52,30 @@ files:
 - tests/tests_helper.rb
 homepage: http://github.com/geemus/NAME
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --charset=UTF-8
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: -794223940542750498
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: formatador
-rubygems_version: 1.8.5
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 2
 summary: Ruby STDOUT text formatting
 test_files: []
-