terminal-table 1.2.0 → 1.3.0

data/History.rdoc

@@ -1,4 +1,8 @@
 
+=== 1.3.0 / 2009-10-16
+
+* Major refactoring (functionality remains the same)
+
 === 1.2.0 / 2009-08-06
 
 * Added colspan support to table

data/Manifest

@@ -1,5 +1,10 @@
-examples/examples.rb
 History.rdoc
+Manifest
+README.rdoc
+Rakefile
+Todo.rdoc
+examples/examples.rb
+lib/terminal-table.rb
 lib/terminal-table/cell.rb
 lib/terminal-table/core_ext.rb
 lib/terminal-table/heading.rb
@@ -7,19 +12,13 @@ lib/terminal-table/import.rb
 lib/terminal-table/table.rb
 lib/terminal-table/table_helper.rb
 lib/terminal-table/version.rb
-lib/terminal-table.rb
-Manifest
-Rakefile
-README.rdoc
 spec/cell_spec.rb
 spec/core_ext_spec.rb
 spec/import_spec.rb
 spec/spec.opts
 spec/spec_helper.rb
-spec/table_helper_spec.rb
 spec/table_spec.rb
 tasks/docs.rake
 tasks/gemspec.rake
 tasks/spec.rake
 terminal-table.gemspec
-Todo.rdoc

data/examples/examples.rb

@@ -54,6 +54,7 @@ rows << ['JavaScript', 30]
 puts table(nil, *rows)
 
 
+$VERBOSE = nil
 Terminal::Table::X = '='
 Terminal::Table::Y = '!'
 Terminal::Table::I = '*'

data/lib/terminal-table/cell.rb

@@ -3,29 +3,50 @@ module Terminal
   class Table
     class Cell
       
-      attr_accessor :value, :alignment, :colspan
+      ##
+      # Cell width.
       
-      def initialize width, params
+      attr_reader :width
+      
+      ##
+      # Cell value.
+      
+      attr_reader :value
+      
+      ##
+      # Cell alignment.
+      
+      attr_reader :alignment
+      
+      ##
+      # Column span.
+      
+      attr_reader :colspan
+      
+      ##
+      # Initialize with _width_ and _options_.
+      
+      def initialize width, options = nil
         @width = width
-        @alignment = :left
-        @colspan = 1
-
-        if params.is_a? Hash
-          @value = params[:value]
-          @alignment = params[:alignment] unless params[:alignment].nil?
-          @colspan = params[:colspan] unless params[:colspan].nil?
-        else
-          @value = params
-        end
+        @value, options = options, {} unless Hash === options
+        @value = options.fetch :value, value
+        @alignment = options.fetch :alignment, :left
+        @colspan = options.fetch :colspan, 1
       end
       
+      ##
+      # Render the cell.
+      
       def render
-        " #{value.to_s} ".align alignment, @width + 2
+        " #{value} ".align alignment, width + 2
       end
       alias :to_s :render
       
+      ##
+      # Cell length.
+      
       def length
-        @value.to_s.length + 2
+        value.to_s.length + 2
       end
     end
   end

data/lib/terminal-table/core_ext.rb

@@ -1,32 +1,22 @@
 
 class String
-  
-  ##
-  # Align to +position+, which may be :left, :right, or :center.
-  
   def align position, length
     send position, length
   end
   alias_method :left, :ljust
   alias_method :right, :rjust
-  
 end
 
 module Enumerable
   def map_with_index &block
-    result = []
-    each_with_index { |v, i| result << yield(v, i) } 
-    result
+    vals = []
+    each_with_index { |v, i| vals << yield(v, i) } 
+    vals
   end
   alias :collect_with_index :map_with_index
 end
 
 class Object
-  
-  ##
-  # Yields or instance_eval's a +block+ depending on the arity of a block
-  # in order to support both types of block syntax for DSL's.
-  
   def yield_or_eval &block
     return unless block
     if block.arity > 0
@@ -35,5 +25,4 @@ class Object
       self.instance_eval &block
     end
   end
-  
 end

data/lib/terminal-table/import.rb

@@ -1,5 +1,4 @@
+
 require 'terminal-table'
 
-class Object
-  include Terminal::Table::TableHelper
-end
+include Terminal::Table::TableHelper

data/lib/terminal-table/table.rb

@@ -1,32 +1,5 @@
 
 module Terminal
-  
-  ##
-  # Generates an ASCII table for terminal usage.
-  #
-  # This class can be used in many ways, however ultimately you should
-  # require 'terminal-table/import' (which requires terminal-table itself) to use
-  # the Kernel helper method which is easier, and cleaner to use. View Object#table
-  # for examples.
-  #
-  # === Examples:
-  #
-  #    table = Terminal::Table.new
-  #    table.headings = ['Characters', { :value => 'Nums', :align => :right }]
-  #    table << [{ :value => 'a', :align => :center }, 1]
-  #    table << ['b', 222222222222222]
-  #    table << ['c', 3]
-  #    puts table.render     # or simply puts table
-  #
-  #    +------------+-----------------+
-  #    | Characters |            Nums |
-  #    +------------+-----------------+
-  #    |     a      | 1               |
-  #    | b          | 222222222222222 |
-  #    | c          | 3               |
-  #    +------------+-----------------+
-  #    
-  
   class Table
     
     #--
@@ -40,48 +13,55 @@ module Terminal
     
     X, Y, I = '-', '|', '+'
     
-    attr_accessor :headings, :rows
+    ##
+    # Headings array.
+    
+    attr_accessor :headings
     
     ##
-    # Generates a ASCII table.
+    # Rows array.
+    
+    attr_accessor :rows
+    
+    ##
+    # Generates a ASCII table with the given _options_.
   
     def initialize options = {}, &block
       @headings = options.fetch :headings, []
       @rows = options.fetch :rows, []
-      yield_or_eval &block if block_given?
+      yield_or_eval &block if block
     end
     
     ##
-    # Render the table. Often you will simply call _puts_ with an
-    # instance in order to output it to the terminal.
+    # Render the table.
   
     def render
       buffer = seperator << "\n" 
       if has_headings?
         buffer << Y + headings.map_with_index do |heading, i|
           width = 0
-          if heading.is_a?(Hash) and !heading[:colspan].nil?
+          if Hash === heading and not heading[:colspan].nil?
             i.upto(i + heading[:colspan] - 1) do |col|
               width += length_of_column(col)
             end
             width += (heading[:colspan] - 1) * (Y.length + 2)
           else
-            width = length_of_column(i)
+            width = length_of_column i
           end
-          Heading.new( width, heading).render
+          Heading.new(width, heading).render
         end.join(Y) + Y
         buffer << "\n#{seperator}\n"
       end
       buffer << rows.map do |row| 
         Y + row.map_with_index do |cell, i|
           width = 0
-          if cell.is_a?(Hash) and !cell[:colspan].nil?
+          if Hash === cell and not cell[:colspan].nil?
             i.upto(i + cell[:colspan] - 1) do |col|
               width += length_of_column(col)
             end
             width += (cell[:colspan] - 1) * (Y.length + 2)
           else
-            width = length_of_column(i)
+            width = length_of_column i
           end
           Cell.new(width, cell).render
         end.join(Y) + Y 
@@ -108,21 +88,21 @@ module Terminal
     alias :<< :add_row
 
     ##
-    # Weither or not any headings are present, since they are optional.
+    # Check if headings are present.
     
     def has_headings?
-      !headings.empty?
+      not headings.empty?
     end
     
     ##
-    # Return +n+ column.
+    # Return column _n_.
     
     def column n
       rows.map { |row| row[n] }.compact 
     end
     
     ##
-    # Return +n+ column including headings.
+    # Return _n_ column including headings.
     
     def column_with_headings n
       headings_with_rows.map { |row| row[n] }.compact  
@@ -132,26 +112,26 @@ module Terminal
     # Return columns.
     
     def columns 
-      (0..number_of_columns-1).map { |n| column n } 
+      (0...number_of_columns).map { |n| column n } 
     end
     
     ##
-    # Return the largest cell found within column +n+.
+    # Return the largest cell found within column _n_.
     
     def largest_cell_in_column n
-      column_with_headings(n).sort_by { |cell| Cell.new(0, cell).length }.last
+      column_with_headings(n).sort_by do |cell| 
+        Cell.new(0, cell).length 
+      end.last
     end
     
     ##
-    # Return length of column +n+.
+    # Return length of column _n_.
     
     def length_of_column n
-      largest_cell = largest_cell_in_column(n)
-      if largest_cell.is_a? Hash
-        largest_cell[:value].length# - 2
-      else
-        largest_cell.to_s.length
-      end
+      largest_cell = largest_cell_in_column n
+      Hash === largest_cell ?
+        largest_cell[:value].to_s.length :
+          largest_cell.to_s.length
     end
     
     ##
@@ -159,15 +139,15 @@ module Terminal
      
     def number_of_columns
       return rows.first.length unless rows.empty?
-      raise Error, 'your table needs some rows.'
+      raise Error, 'your table needs some rows'
     end
     
     ##
-    # Align column +n+ to +alignment+ of :center, :left, or :right.
+    # Align column _n_ to the given _alignment_ of :center, :left, or :right.
     
     def align_column n, alignment
       column(n).each_with_index do |col, i|
-        @rows[i][n] = {:value => col, :alignment => alignment} unless col.is_a? Hash
+        @rows[i][n] = { :value => col, :alignment => alignment } unless Hash === col
       end
     end
     
@@ -179,12 +159,12 @@ module Terminal
     end
     
     ##
-    # Check if +other+ is equal to self. +other+ is considered equal
+    # Check if _other_ is equal to self. _other_ is considered equal
     # if it contains the same headings and rows.
 
     def == other
-      if other.respond_to?(:headings) && other.respond_to?(:rows)
-        headings == other.headings && rows == other.rows
+      if other.respond_to? :headings and other.respond_to? :rows
+        headings == other.headings and rows == other.rows
       end
     end
   end

data/lib/terminal-table/table_helper.rb

@@ -1,50 +1,6 @@
 module Terminal
   class Table
     module TableHelper
-      ##
-      # Generates a Terminal::Table object.
-      #
-      # === Examples:
-      #    
-      #    puts table(['a', 'b'], [1, 2], [3, 4])
-      #    
-      #    # OR
-      #
-      #    t = table ['a', 'b']
-      #    t << [1, 2]
-      #    t << [3, 4]
-      #    puts t
-      #    
-      #    # OR
-      #
-      #    user_table = table do |t|
-      #      t.headings = 'First Name', 'Last Name', 'Email'
-      #      t << ['TJ',  'Holowaychuk', 'tj@vision-media.ca']
-      #      t << ['Bob', 'Someone',     'bob@vision-media.ca']
-      #      t << ['Joe', 'Whatever',    'joe@vision-media.ca']
-      #    end
-      #    puts user_table
-      #    
-      #    # OR
-      #
-      #    user_table = table do
-      #      self.headings = 'First Name', 'Last Name', 'Email'
-      #      add_row ['TJ',  'Holowaychuk', 'tj@vision-media.ca']
-      #      add_row ['Bob', 'Someone',     'bob@vision-media.ca']
-      #      add_row ['Joe', 'Whatever',    'joe@vision-media.ca']
-      #    end
-      #    puts user_table
-      #
-      #   # OR
-      #
-      #   rows = []
-      #   rows << ['Lines',      100]
-      #   rows << ['Comments',   20]
-      #   rows << ['Ruby',       70]
-      #   rows << ['JavaScript', 30]
-      #   puts table(nil, *rows)
-      #
-      
       def table headings = [], *rows, &block
         Terminal::Table.new :headings => headings.to_a, :rows => rows, &block
       end

data/lib/terminal-table/version.rb

@@ -1,6 +1,6 @@
 
 module Terminal
   class Table
-    VERSION = '1.2.0'
+    VERSION = '1.3.0'
   end
 end

data/spec/cell_spec.rb

@@ -1,7 +1,7 @@
-require File.expand_path(File.dirname(__FILE__) + "/spec_helper")
+
+require File.dirname(__FILE__) + '/spec_helper'
 
 describe Terminal::Table do
-  
   Cell = Terminal::Table::Cell
   
   it "should default alignment to the left" do
@@ -10,10 +10,9 @@ describe Terminal::Table do
     cell.alignment.should == :left
   end
 
-  it "should override alignment" do
-    cell = Cell.new 0, {:value => 'foo', :alignment => :center}
+  it "should allow overriding of alignment" do
+    cell = Cell.new 0, :value => 'foo', :alignment => :center
     cell.value.should == 'foo'
     cell.alignment.should == :center
   end
-  
 end

data/spec/core_ext_spec.rb

@@ -1,7 +1,7 @@
-require File.expand_path(File.dirname(__FILE__) + "/spec_helper")
+
+require File.dirname(__FILE__) + '/spec_helper'
 
 describe String do
-  
   describe "#align" do
     it "should center" do
       'foo'.align(:center, 10).should == '   foo    '
@@ -15,5 +15,4 @@ describe String do
       'foo'.align(:right, 10).should == '       foo'
     end
   end
-  
 end

data/spec/import_spec.rb

@@ -1,11 +1,11 @@
-require File.expand_path(File.dirname(__FILE__) + "/spec_helper")
+
+require File.dirname(__FILE__) + '/spec_helper'
 require "terminal-table/import"
 
 describe Object do
   describe "#table" do
     it "should allow creation of a terminal table" do
-      table(['foo', 'bar'], ['a', 'b'], [1, 2]).
-      should be_instance_of(Terminal::Table)
+      table(['foo', 'bar'], ['a', 'b'], [1, 2]).should be_instance_of(Terminal::Table)
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,5 +1,5 @@
 
-require File.expand_path(File.dirname(__FILE__) + "/../lib/terminal-table")
+require File.dirname(__FILE__) + '/../lib/terminal-table'
 
 class String
   def deindent

data/spec/table_spec.rb

@@ -1,4 +1,5 @@
-require File.expand_path(File.dirname(__FILE__) + "/spec_helper")
+
+require File.dirname(__FILE__) + '/spec_helper'
 
 module Terminal
   describe Table do

data/terminal-table.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{terminal-table}
-  s.version = "1.2.0"
+  s.version = "1.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["TJ Holowaychuk"]
-  s.date = %q{2009-10-10}
+  s.date = %q{2009-10-16}
   s.description = %q{Simple, feature rich ascii table generation library}
   s.email = %q{tj@vision-media.ca}
-  s.extra_rdoc_files = ["lib/terminal-table/cell.rb", "lib/terminal-table/core_ext.rb", "lib/terminal-table/heading.rb", "lib/terminal-table/import.rb", "lib/terminal-table/table.rb", "lib/terminal-table/table_helper.rb", "lib/terminal-table/version.rb", "lib/terminal-table.rb", "README.rdoc", "tasks/docs.rake", "tasks/gemspec.rake", "tasks/spec.rake"]
-  s.files = ["examples/examples.rb", "History.rdoc", "lib/terminal-table/cell.rb", "lib/terminal-table/core_ext.rb", "lib/terminal-table/heading.rb", "lib/terminal-table/import.rb", "lib/terminal-table/table.rb", "lib/terminal-table/table_helper.rb", "lib/terminal-table/version.rb", "lib/terminal-table.rb", "Manifest", "Rakefile", "README.rdoc", "spec/cell_spec.rb", "spec/core_ext_spec.rb", "spec/import_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "spec/table_helper_spec.rb", "spec/table_spec.rb", "tasks/docs.rake", "tasks/gemspec.rake", "tasks/spec.rake", "terminal-table.gemspec", "Todo.rdoc"]
+  s.extra_rdoc_files = ["README.rdoc", "lib/terminal-table.rb", "lib/terminal-table/cell.rb", "lib/terminal-table/core_ext.rb", "lib/terminal-table/heading.rb", "lib/terminal-table/import.rb", "lib/terminal-table/table.rb", "lib/terminal-table/table_helper.rb", "lib/terminal-table/version.rb", "tasks/docs.rake", "tasks/gemspec.rake", "tasks/spec.rake"]
+  s.files = ["History.rdoc", "Manifest", "README.rdoc", "Rakefile", "Todo.rdoc", "examples/examples.rb", "lib/terminal-table.rb", "lib/terminal-table/cell.rb", "lib/terminal-table/core_ext.rb", "lib/terminal-table/heading.rb", "lib/terminal-table/import.rb", "lib/terminal-table/table.rb", "lib/terminal-table/table_helper.rb", "lib/terminal-table/version.rb", "spec/cell_spec.rb", "spec/core_ext_spec.rb", "spec/import_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "spec/table_spec.rb", "tasks/docs.rake", "tasks/gemspec.rake", "tasks/spec.rake", "terminal-table.gemspec"]
   s.homepage = %q{http://github.com/visionmedia/terminal-table}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Terminal-table", "--main", "README.rdoc"]
   s.require_paths = ["lib"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: terminal-table
 version: !ruby/object:Gem::Version 
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors: 
 - TJ Holowaychuk
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-10 00:00:00 -07:00
+date: 2009-10-16 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -20,6 +20,8 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
+- README.rdoc
+- lib/terminal-table.rb
 - lib/terminal-table/cell.rb
 - lib/terminal-table/core_ext.rb
 - lib/terminal-table/heading.rb
@@ -27,14 +29,17 @@ extra_rdoc_files:
 - lib/terminal-table/table.rb
 - lib/terminal-table/table_helper.rb
 - lib/terminal-table/version.rb
-- lib/terminal-table.rb
-- README.rdoc
 - tasks/docs.rake
 - tasks/gemspec.rake
 - tasks/spec.rake
 files: 
-- examples/examples.rb
 - History.rdoc
+- Manifest
+- README.rdoc
+- Rakefile
+- Todo.rdoc
+- examples/examples.rb
+- lib/terminal-table.rb
 - lib/terminal-table/cell.rb
 - lib/terminal-table/core_ext.rb
 - lib/terminal-table/heading.rb
@@ -42,22 +47,16 @@ files:
 - lib/terminal-table/table.rb
 - lib/terminal-table/table_helper.rb
 - lib/terminal-table/version.rb
-- lib/terminal-table.rb
-- Manifest
-- Rakefile
-- README.rdoc
 - spec/cell_spec.rb
 - spec/core_ext_spec.rb
 - spec/import_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
-- spec/table_helper_spec.rb
 - spec/table_spec.rb
 - tasks/docs.rake
 - tasks/gemspec.rake
 - tasks/spec.rake
 - terminal-table.gemspec
-- Todo.rdoc
 has_rdoc: true
 homepage: http://github.com/visionmedia/terminal-table
 licenses: []

data/spec/table_helper_spec.rb

@@ -1,18 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + "/spec_helper")
-
-module Terminal
-  describe Table::TableHelper do
-    before do
-      @obj = Class.new do
-        include Table::TableHelper
-      end.new
-    end
-
-    describe "#table" do
-      it "should allow creation of a terminal table" do
-        table = @obj.table(['foo', 'bar'], ['a', 'b'], [1, 2])
-        table.should be_instance_of(Terminal::Table)
-      end
-    end
-  end
-end