sergeysazonov-simple_console_table 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Sergey Sazonov.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,68 @@
+= SimpleConsoleTable - a library capable of printing nicely formatted tables to stdout
+Copyright (C) 2009  Sergey Sazonov
+
+== Example
+=== Basic example
+
+  require 'rubygems'
+  require 'simple_console_table'
+  
+  table = SimpleConsoleTable.new
+
+  table << ['one', 'two', 'three']
+  table << ['four', 'five', 'six', 'seven']
+  
+  table.as_string
+  
+  # +--------+--------+---------+---------+
+  # |   one  |   two  |  three  |         |
+  # +--------+--------+---------+---------+
+  # |  four  |  five  |    six  |  seven  |
+  # +--------+--------+---------+---------+
+
+Use print to write the table directly to the console. Use as_string to obtain the result as a string.
+
+=== Using objects other than strings
+
+SimpleConsoleTable invokes to_s method on every object thus converting everything to strings.
+
+  class Dummy
+    def initialize(dummy_id); @dummy_id = dummy_id; end
+    def to_s; "Dummy #{@dummy_id}"; end
+  end
+
+  require 'rubygems'
+  require 'simple_console_table'
+  
+  table = SimpleConsoleTable.new
+
+  table << ['one', 2, 'three']
+  table << [true, 'five', -6.89, Dummy.new(345)]
+
+  table.as_string
+  
+  # +--------+--------+---------+-------------+
+  # |   one  |     2  |  three  |             |
+  # +--------+--------+---------+-------------+
+  # |  true  |  five  |  -6.89  |  Dummy 345  |
+  # +--------+--------+---------+-------------+
+
+=== Passing nested arrays
+
+SimpleConsoleTable invokes flatten method on every array passed to <<
+
+  require 'rubygems'
+  require 'simple_console_table'
+  
+  table = SimpleConsoleTable.new
+
+  table << [1, 2, [3, 4], [5]]
+  table << [[[[[[6, 7, 8]]], [[[[9, 10]]]]]]]
+
+  table.as_string
+  
+  # +-----+-----+-----+-----+------+
+  # |  1  |  2  |  3  |  4  |   5  |
+  # +-----+-----+-----+-----+------+
+  # |  6  |  7  |  8  |  9  |  10  |
+  # +-----+-----+-----+-----+------+

data/lib/simple_console_table.rb

@@ -0,0 +1,140 @@
+# = SimpleConsoleTable - a library capable of printing nicely formatted tables to stdout
+# Copyright (C) 2009  Sergey Sazonov
+# 
+# == Example
+# === Basic example
+# 
+#   require 'rubygems'
+#   require 'simple_console_table'
+#   
+#   table = SimpleConsoleTable.new
+# 
+#   table << ['one', 'two', 'three']
+#   table << ['four', 'five', 'six', 'seven']
+#   
+#   table.as_string
+#   
+#   # +--------+--------+---------+---------+
+#   # |   one  |   two  |  three  |         |
+#   # +--------+--------+---------+---------+
+#   # |  four  |  five  |    six  |  seven  |
+#   # +--------+--------+---------+---------+
+# 
+# Use print to write the table directly to the console. Use as_string to obtain the result as a string.
+# 
+# === Using objects other than strings
+# 
+# SimpleConsoleTable invokes to_s method on every object thus converting everything to strings.
+# 
+#   class Dummy
+#     def initialize(dummy_id); @dummy_id = dummy_id; end
+#     def to_s; "Dummy #{@dummy_id}"; end
+#   end
+# 
+#   require 'rubygems'
+#   require 'simple_console_table'
+#   
+#   table = SimpleConsoleTable.new
+# 
+#   table << ['one', 2, 'three']
+#   table << [true, 'five', -6.89, Dummy.new(345)]
+# 
+#   table.as_string
+#   
+#   # +--------+--------+---------+-------------+
+#   # |   one  |     2  |  three  |             |
+#   # +--------+--------+---------+-------------+
+#   # |  true  |  five  |  -6.89  |  Dummy 345  |
+#   # +--------+--------+---------+-------------+
+# 
+# === Passing nested arrays
+# 
+# SimpleConsoleTable invokes flatten method on every array passed to <<
+# 
+#   require 'rubygems'
+#   require 'simple_console_table'
+#   
+#   table = SimpleConsoleTable.new
+# 
+#   table << [1, 2, [3, 4], [5]]
+#   table << [[[[[[6, 7, 8]]], [[[[9, 10]]]]]]]
+# 
+#   table.as_string
+#   
+#   # +-----+-----+-----+-----+------+
+#   # |  1  |  2  |  3  |  4  |   5  |
+#   # +-----+-----+-----+-----+------+
+#   # |  6  |  7  |  8  |  9  |  10  |
+#   # +-----+-----+-----+-----+------+
+
+class SimpleConsoleTable
+
+  DEFAULT_FORMATTER = lambda do |text_to_format, column_width|
+    sprintf("  %#{column_width}.#{column_width}s  ", text_to_format)
+  end
+
+  def initialize
+    @rows = []
+    @formatter = DEFAULT_FORMATTER
+  end
+
+  # Adds row.flatten.collect { |cell_content| cell_content.to_s } to the table
+  def <<(row)
+    @rows << row.flatten.collect { |cell_content| cell_content.to_s }
+  end
+
+  # Returns an empty string if the table is empty (that is, no rows have been added).
+  # Otherwise, returns the formatted table as a string.
+  def as_string
+    return '' if @rows.empty?
+
+    column_widths = calculate_column_widths
+    formatted_rows = format_table(column_widths)
+    formatted_column_widths = formatted_rows.first.collect { |cell_content| cell_content.length }
+    row_separator = construct_row_separator(formatted_column_widths)
+
+    output = formatted_rows.collect do |row|
+      ['', row, ''].flatten.join('|')
+    end
+
+    separated_output = ([row_separator] * (output.length + 1)).zip(output).flatten
+
+    separated_output.join("\n")
+  end
+  
+  # A shortcut for puts(as_string)
+  def print
+    puts(as_string)
+  end
+
+  private
+
+  def calculate_column_widths
+    column_widths = []
+
+    @rows.each do |row|
+      row.each_with_index do |cell_content, index|
+        column_widths[index] ||= 0
+        column_widths[index] = [column_widths[index], cell_content.length].max
+      end
+    end
+
+    column_widths
+  end
+
+  def format_table(column_widths)
+    @rows.collect do |row|
+      (0...column_widths.length).collect do |column_index|
+        @formatter.call(row[column_index] || '', column_widths[column_index])
+      end
+    end
+  end
+
+  def construct_row_separator(column_widths)
+    separator = column_widths.collect do |column_width|
+      '-' * column_width
+    end.join('+')
+
+    "+#{separator}+"
+  end
+end

data/spec/simple_console_table_spec.rb

@@ -0,0 +1,73 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
+
+describe SimpleConsoleTable do
+
+  before(:each) do
+    @table = SimpleConsoleTable.new
+  end
+
+  it 'should return an empty string if the table is empty' do
+    @table.as_string.should be_empty
+  end
+
+  it 'should output a nicely formatted table' do
+    @table << ['one', 'two', 'three']
+    @table << ['four', 'five', 'six']
+
+    @table.as_string.should == <<-EOF
++--------+--------+---------+
+|   one  |   two  |  three  |
++--------+--------+---------+
+|  four  |  five  |    six  |
++--------+--------+---------+
+EOF
+  end
+
+  it 'should allow adding rows of different lengths' do
+    @table << ['one', 'two', 'three']
+    @table << ['four', 'five', 'six', 'seven']
+
+    @table.as_string.should == <<-EOF
++--------+--------+---------+---------+
+|   one  |   two  |  three  |         |
++--------+--------+---------+---------+
+|  four  |  five  |    six  |  seven  |
++--------+--------+---------+---------+
+EOF
+  end
+
+  it 'should use to_s method for values other than strings' do
+    class Dummy
+      def initialize(dummy_id); @dummy_id = dummy_id; end
+      def to_s; "Dummy #{@dummy_id}"; end
+    end
+    
+    @table << ['one', 2, 'three']
+    @table << [true, 'five', -6.89, Dummy.new(345)]
+
+    @table.as_string.should == <<-EOF
++--------+--------+---------+-------------+
+|   one  |     2  |  three  |             |
++--------+--------+---------+-------------+
+|  true  |  five  |  -6.89  |  Dummy 345  |
++--------+--------+---------+-------------+
+EOF
+  end
+
+  it 'should flatten nested arrays' do
+    @table << [1, 2, [3, 4], [5]]
+    @table << [[[[[[6, 7, 8]]], [[[[9, 10]]]]]]]
+
+    @table.as_string.should == <<-EOF
++-----+-----+-----+-----+------+
+|  1  |  2  |  3  |  4  |   5  |
++-----+-----+-----+-----+------+
+|  6  |  7  |  8  |  9  |  10  |
++-----+-----+-----+-----+------+
+EOF
+  end
+  
+  it 'should have print method for printing the table directly to the standard output' do
+    @table.should respond_to(:print)
+  end
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification 
+name: sergeysazonov-simple_console_table
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Sergey Sazonov
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-26 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: A library capable of printing nicely formatted tables to the standard output
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- lib/simple_console_table.rb
+- LICENSE
+- README.rdoc
+has_rdoc: false
+homepage: 
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A library capable of printing nicely formatted tables to the standard output
+test_files: 
+- spec/simple_console_table_spec.rb