visionmedia-terminal-table 1.0.4 → 1.0.5

data/History.rdoc

@@ -1,4 +1,10 @@
 
+=== 1.0.5 / 2009-03-14
+
+* Allowing nil to be passed to table for headings
+* Revised doc to show that rows can be splatted now
+* Misc refactoring
+
 === 1.0.3 / 2009-01-15
 
 * Moved yield or eval to Terminal::Table initialize where it belongs

data/Manifest

@@ -1,19 +1,22 @@
+examples/examples.rb
 History.rdoc
-Rakefile
-README.rdoc
-lib/terminal-table.rb
-lib/terminal-table/core_ext.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/version.rb
-lib/terminal-table/import.rb
-spec/spec_helper.rb
+lib/terminal-table.rb
+Manifest
+Rakefile
+README.rdoc
+spec/cell_spec.rb
 spec/core_ext_spec.rb
+spec/import_spec.rb
+spec/spec_helper.rb
 spec/table_spec.rb
-spec/cell_spec.rb
 tasks/docs.rake
 tasks/gemspec.rake
 tasks/spec.rake
+terminal-table.gemspec
 Todo.rdoc
-Manifest

data/README.rdoc

@@ -7,16 +7,16 @@ Simple, feature rich ASCII table generator.
 
 * Fast
 * Simple
-* With or without headings
-* Alignment of headings, cells, or columns
-* Easy modification of table chars (+, -, |)
+* Optional headings
+* Alignment of columns, headings, or cells
+* Easy modification of table strings (+, -, |)
 
 == Examples:
 
    require 'rubygems'
    require 'terminal-table/import'
    
-   puts table(['a', 'b'], [[1, 2], [3, 4]])
+   puts table(['a', 'b'], [1, 2], [3, 4])
    
    t = table ['a', 'b']
    t << [1, 2]
@@ -45,14 +45,14 @@ Simple, feature rich ASCII table generator.
    rows << ['Comments',   20]
    rows << ['Ruby',       70]
    rows << ['JavaScript', 30]
-   puts table([nil, 'Lines'], rows)
+   puts table([nil, 'Lines'], *rows)
    
    rows = []
    rows << ['Lines',      100]
    rows << ['Comments',   20]
    rows << ['Ruby',       70]
    rows << ['JavaScript', 30]
-   puts table(nil, rows)
+   puts table(nil, *rows)
 
 == Results:
 
@@ -106,7 +106,7 @@ Simple, feature rich ASCII table generator.
 
 (The MIT License)
 
-Copyright (c) 2008 TJ Holowaychuk <tj@vision-media.ca>
+Copyright (c) 2008-2009 TJ Holowaychuk <tj@vision-media.ca>
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -4,7 +4,7 @@ require 'rake'
 require 'echoe'
 require './lib/terminal-table.rb'
 
-Echoe.new("terminal-table", Terminal::Table::VERSION::STRING) do |p|
+Echoe.new("terminal-table", Terminal::Table::VERSION) do |p|
   p.author = "TJ Holowaychuk"
   p.email = "tj@vision-media.ca"
   p.summary = "Simple,"

data/Todo.rdoc

@@ -5,6 +5,8 @@
 
 == Minor:
 
+* Programmatically add seperator rows
+* Arbitrary dimensions
 * Add multi-column sorting
 * Change; pre-create Cell and Heading objects to clean up Table a bit
 

data/examples/examples.rb

@@ -0,0 +1,57 @@
+
+$:.unshift File.dirname(__FILE__) + '/../lib'
+require 'terminal-table/import'
+
+puts
+puts table(['a', 'b'], [1, 2], [3, 4])
+
+puts
+t = table ['a', 'b']
+t << [1, 2]
+t << [3, 4]
+puts t
+
+puts
+user_table = table do |t|
+  t.headings = 'First Name', 'Last Name', 'Email'
+  t << %w( TJ Holowaychuk tj@vision-media.ca )
+  t << %w( Bob Someone bob@vision-media.ca )
+  t << %w( Joe Whatever bob@vision-media.ca )
+end
+puts user_table
+
+puts
+user_table = table do
+  self.headings = 'First Name', 'Last Name', 'Email'
+  add_row ['TJ',  'Holowaychuk', ['tj@vision-media.ca', :right]]
+  add_row ['Bob', 'Someone',     'bob@vision-media.ca']
+  add_row ['Joe', 'Whatever',    'joe@vision-media.ca']
+  align_column 1, :center
+end
+puts user_table
+
+rows = []
+rows << ['Lines',      100]
+rows << ['Comments',   20]
+rows << ['Ruby',       70]
+rows << ['JavaScript', 30]
+puts table([nil, 'Lines'], *rows)
+
+rows = []
+rows << ['Lines',      100]
+rows << ['Comments',   20]
+rows << ['Ruby',       70]
+rows << ['JavaScript', 30]
+puts table(nil, *rows)
+
+
+Terminal::Table::X = '='
+Terminal::Table::Y = '!'
+Terminal::Table::I = '*'
+
+rows = []
+rows << [nil,  nil, nil]
+rows << [nil, ':)', nil]
+rows << [nil,  nil, nil]
+puts table(nil, *rows)
+

data/lib/terminal-table.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2008 TJ Holowaychuk
+# Copyright (c) 2008-2009 TJ Holowaychuk <tj@vision-media.ca>
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the

data/lib/terminal-table/cell.rb

@@ -3,24 +3,14 @@ module Terminal
   class Table
     class Cell
       
-      DEFAULT_ALIGNMENT = :left
-      
       attr_accessor :value, :alignment
       
-      def initialize render_length, initial = nil
-        @render_length = render_length
-        case initial
-        when Hash
-          @value = initial[:value]
-          @alignment = initial[:align] unless initial[:align].nil?
-        when
-          @value = initial
-          @alignment = DEFAULT_ALIGNMENT
-        end
+      def initialize width, value = nil, alignment = :left
+        @width, @alignment, @value = width, alignment, value
       end
       
       def render
-        " #{value.to_s} ".align alignment, @render_length + 2
+        " #{value.to_s} ".align alignment, @width + 2
       end
       alias :to_s :render
       

data/lib/terminal-table/core_ext.rb

@@ -7,17 +7,15 @@ class String
   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 do |v, i|
-      result << yield(v, i)
-    end
+    each_with_index { |v, i| result << yield(v, i) } 
     result
   end
   alias :collect_with_index :map_with_index
@@ -38,4 +36,5 @@ class Object
       end
     end
   end
+  
 end

data/lib/terminal-table/heading.rb

@@ -2,7 +2,9 @@
 module Terminal
   class Table
     class Heading < Cell
-      DEFAULT_ALIGNMENT = :center
+      def initialize width, value = nil, alignment = :center
+        super
+      end
     end
   end
 end

data/lib/terminal-table/import.rb

@@ -8,7 +8,7 @@ module Kernel
   #
   # === Examples:
   #    
-  #    puts table(['a', 'b'], [[1, 2], [3, 4]])
+  #    puts table(['a', 'b'], [1, 2], [3, 4])
   #    
   #    # OR
   #
@@ -44,10 +44,10 @@ module Kernel
   #   rows << ['Comments',   20]
   #   rows << ['Ruby',       70]
   #   rows << ['JavaScript', 30]
-  #   puts table(nil, rows)
+  #   puts table(nil, *rows)
   #
   
-  def table headings = [], rows = [], &block
-    table = Terminal::Table.new :headings => headings, :rows => rows, &block
+  def table headings = [], *rows, &block
+    Terminal::Table.new :headings => headings.to_a, :rows => rows, &block
   end
 end

data/lib/terminal-table/table.rb

@@ -46,8 +46,8 @@ module Terminal
     # Generates a ASCII table.
   
     def initialize options = {}, &block
-      @headings = options.delete(:headings) || []
-      @rows = options.delete(:rows) || [] 
+      @headings = options.fetch :headings, []
+      @rows = options.fetch :rows, []
       yield_or_eval &block if block_given?
     end
     
@@ -56,12 +56,19 @@ module Terminal
     # instance in order to output it to the terminal.
   
     def render
-      sep = seperator
-      s = sep + "\n" 
-      s << Y + headings.collect_with_index { |h, i| Heading.new(length_of_column(i), h).render }.join(Y) + Y if has_headings?
-      s << "\n" + sep + "\n" if has_headings?
-      s << rows.collect { |row| Y + row.collect_with_index { |c, i| Cell.new(length_of_column(i), c).render }.join(Y) + Y }.join("\n")
-      s << "\n" + sep + "\n"
+      buffer = seperator << "\n" 
+      if has_headings?
+        buffer << Y + headings.map_with_index do |heading, i| 
+          Heading.new(length_of_column(i), *heading).render 
+        end.join(Y) + Y
+        buffer << "\n#{seperator}\n"
+      end
+      buffer << rows.map do |row| 
+        Y + row.map_with_index do |cell, i|
+          Cell.new(length_of_column(i), *cell).render 
+        end.join(Y) + Y 
+      end.join("\n")
+      buffer << "\n#{seperator}\n"
     end
     alias :to_s :render
     
@@ -69,7 +76,9 @@ module Terminal
     # Create a seperator based on colum lengths.
     
     def seperator
-      I + columns.collect_with_index { |col, i| X * (length_of_column(i) + 2) }.join(I) + I 
+      I + columns.collect_with_index do |col, i| 
+        X * (length_of_column(i) + 2) 
+      end.join(I) + I 
     end
     
     ##
@@ -91,28 +100,28 @@ module Terminal
     # Return +n+ column.
     
     def column n
-      rows.collect { |row| row[n] }.compact 
+      rows.map { |row| row[n] }.compact 
     end
     
     ##
     # Return +n+ column including headings.
     
     def column_with_headings n
-      headings_with_rows.collect { |row| row[n] }.compact  
+      headings_with_rows.map { |row| row[n] }.compact  
     end
     
     ##
     # Return columns.
     
     def columns 
-      (0..number_of_columns-1).collect { |n| column n } 
+      (0..number_of_columns-1).map { |n| column n } 
     end
     
     ##
     # Return the largest cell found within column +n+.
     
     def largest_cell_in_column n
-      column_with_headings(n).sort_by { |c| Cell.new(0, c).length }.last
+      column_with_headings(n).sort_by { |cell| Cell.new(0, *cell).length }.last
     end
     
     ##
@@ -126,26 +135,19 @@ module Terminal
     # Return total number of columns available.
      
     def number_of_columns
-      if rows[0]
-        rows[0].length 
-      else
-        raise Error, 'Your table needs some rows'
-      end 
+      return rows.first.length unless rows.empty?
+      raise Error, 'your table needs some rows.'
     end
     
     ##
     # Align column +n+ to +alignment+ of :center, :left, or :right.
     
     def align_column n, alignment
-      column(n).each_with_index do |c, i|
-        unless c.is_a? Hash
-          @rows[i][n] = { :value => c, :align => alignment }
-        end
+      column(n).each_with_index do |col, i|
+        @rows[i][n] = [col, alignment] unless col.is_a? Array
       end
     end
     
-    private
-    
     ##
     # Return headings combined with rows.
     

data/lib/terminal-table/version.rb

@@ -1,9 +1,6 @@
 
 module Terminal
   class Table
-    module VERSION #:nodoc:
-      MAJOR, MINOR, TINY = [1, 0, 4]
-      STRING = [MAJOR, MINOR, TINY].join '.'
-    end
+    VERSION = '1.0.5'
   end
 end

data/spec/cell_spec.rb

@@ -3,16 +3,16 @@ describe Terminal::Table do
   
   Cell = Terminal::Table::Cell
   
-  it "should initialize with a string" do
-    cell = Cell.new 0, 'Foo'
-    cell.value.should == 'Foo'
+  it "should default alignment to the left" do
+    cell = Cell.new 0, 'foo'
+    cell.value.should == 'foo'
     cell.alignment.should == :left
   end
-  
-  it "should initialize with a hash" do
-    cell = Cell.new 0, :value => 'Bar', :align => :right
-    cell.value.should == 'Bar'
-    cell.alignment.should == :right    
+
+  it "should override alignment" do
+    cell = Cell.new 0, 'foo', :center
+    cell.value.should == 'foo'
+    cell.alignment.should == :center
   end
   
 end

data/spec/core_ext_spec.rb

@@ -1,7 +1,7 @@
 
 describe String do
+  
   describe "#align" do
-    
     it "should center" do
       'foo'.align(:center, 10).should == '   foo    '
     end
@@ -13,6 +13,6 @@ describe String do
     it "should align right" do
       'foo'.align(:right, 10).should == '       foo'
     end
-    
   end
-end
+  
+end

data/spec/import_spec.rb

@@ -0,0 +1,13 @@
+
+require 'terminal-table/import'
+
+describe Kernel 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)
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -5,4 +5,4 @@ class String
   def deindent
     gsub /^ */, ''
   end
-end
+end

data/spec/table_spec.rb

@@ -59,6 +59,10 @@ describe Terminal::Table do
     @table << ['a', 1]
     @table.seperator.should == '+------+-----+'
   end
+  
+  it "should bitch and complain when you have no rows" do
+    lambda { @table.render }.should raise_error(Terminal::Table::Error)
+  end
       
   it "should render properly" do
     @table.headings = ['Char', 'Num']
@@ -148,8 +152,8 @@ describe Terminal::Table do
   end
   
   it "should allow alignment of headings and cells" do
-    @table.headings = ['Characters', { :value => 'Nums', :align => :right }]
-    @table << [{ :value => 'a', :align => :center }, 1]
+    @table.headings = ['Characters', ['Nums', :right ]]
+    @table << [['a', :center ], 1]
     @table << ['b', 222222222222222]
     @table << ['c', 3]
     @table.render.should == <<-EOF.deindent
@@ -166,7 +170,7 @@ describe Terminal::Table do
   
   it "should align columns, but allow specifics to remain" do
     @table.headings = ['Just some characters', 'Num']
-    @table.rows = [[{ :value => 'a', :align => :left }, 1], ['b', 2], ['c', 3]]
+    @table.rows = [[['a', :left], 1], ['b', 2], ['c', 3]]
     @table.align_column 0, :center
     @table.align_column 1, :right
     @table.render.should == <<-EOF.deindent

data/terminal-table.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{terminal-table}
-  s.version = "1.0.4"
+  s.version = "1.0.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["TJ Holowaychuk"]
-  s.date = %q{2009-01-15}
+  s.date = %q{2009-03-14}
   s.description = %q{Simple,}
   s.email = %q{tj@vision-media.ca}
-  s.extra_rdoc_files = ["README.rdoc", "lib/terminal-table.rb", "lib/terminal-table/core_ext.rb", "lib/terminal-table/cell.rb", "lib/terminal-table/heading.rb", "lib/terminal-table/table.rb", "lib/terminal-table/version.rb", "lib/terminal-table/import.rb", "tasks/docs.rake", "tasks/gemspec.rake", "tasks/spec.rake"]
-  s.files = ["History.rdoc", "Rakefile", "README.rdoc", "lib/terminal-table.rb", "lib/terminal-table/core_ext.rb", "lib/terminal-table/cell.rb", "lib/terminal-table/heading.rb", "lib/terminal-table/table.rb", "lib/terminal-table/version.rb", "lib/terminal-table/import.rb", "spec/spec_helper.rb", "spec/core_ext_spec.rb", "spec/table_spec.rb", "spec/cell_spec.rb", "tasks/docs.rake", "tasks/gemspec.rake", "tasks/spec.rake", "Todo.rdoc", "Manifest", "terminal-table.gemspec"]
+  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/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/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_helper.rb", "spec/table_spec.rb", "tasks/docs.rake", "tasks/gemspec.rake", "tasks/spec.rake", "terminal-table.gemspec", "Todo.rdoc"]
   s.has_rdoc = true
   s.homepage = %q{http://github.com/visionmedia/terminal-table}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Terminal-table", "--main", "README.rdoc"]
@@ -24,11 +24,8 @@ Gem::Specification.new do |s|
     s.specification_version = 2
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<echoe>, [">= 0"])
     else
-      s.add_dependency(%q<echoe>, [">= 0"])
     end
   else
-    s.add_dependency(%q<echoe>, [">= 0"])
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: visionmedia-terminal-table
 version: !ruby/object:Gem::Version 
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors: 
 - TJ Holowaychuk
@@ -9,18 +9,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-15 00:00:00 -08:00
+date: 2009-03-14 00:00:00 -07:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: echoe
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
+dependencies: []
+
 description: Simple,
 email: tj@vision-media.ca
 executables: []
@@ -28,38 +20,40 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- README.rdoc
-- lib/terminal-table.rb
-- lib/terminal-table/core_ext.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/version.rb
-- lib/terminal-table/import.rb
+- lib/terminal-table.rb
+- README.rdoc
 - tasks/docs.rake
 - tasks/gemspec.rake
 - tasks/spec.rake
 files: 
+- examples/examples.rb
 - History.rdoc
-- Rakefile
-- README.rdoc
-- lib/terminal-table.rb
-- lib/terminal-table/core_ext.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/version.rb
-- lib/terminal-table/import.rb
-- spec/spec_helper.rb
+- lib/terminal-table.rb
+- Manifest
+- Rakefile
+- README.rdoc
+- spec/cell_spec.rb
 - spec/core_ext_spec.rb
+- spec/import_spec.rb
+- spec/spec_helper.rb
 - spec/table_spec.rb
-- spec/cell_spec.rb
 - tasks/docs.rake
 - tasks/gemspec.rake
 - tasks/spec.rake
-- Todo.rdoc
-- Manifest
 - terminal-table.gemspec
+- Todo.rdoc
 has_rdoc: true
 homepage: http://github.com/visionmedia/terminal-table
 post_install_message: