console_table 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6d6584806bd70be8c861b3f31cab09d40dd7aaea
-  data.tar.gz: b14fa23bff85071edfb100410e7058935837aec5
+  metadata.gz: 319bf461a967b3098c88d16ed370e6b32cfe0a11
+  data.tar.gz: 82ac42a1dcc1680f982ddafa7a9613a28a7a0d42
 SHA512:
-  metadata.gz: 4b325157fe823b192c90a2f55966e79f3540a446bc903776221fea12a201d10abe2f72ced458be2f4ec92f1ba7f82cb61afa2f073b9db9ee1c1e77322b797b8d
-  data.tar.gz: 533d3190d9c667094541be8a7dd3bf1092253932491da7c382ed0b02c86452bf08d4a2bd7be68e256a2c5fb87730b68219dcdf5903003313fb9e9fc53980dd3a
+  metadata.gz: 1c0bdfbc856c1f7e04a7b9a3adfc3d259472947293a8812637395d233f1bc14ce68bc0e1730312012c4fd87765cb66e07ace95a74c7d27ab2c0f790ce552802b
+  data.tar.gz: 64a60d6b7571dcabee14970cc6b9bef3768c2bbcf9663c7d03378ea26085c8b466f7e28a0e56d666b709f92a2d9c562ef844fc6be7e1bb9b33871d99a4cfd6ad

data/README.md

@@ -1,3 +1,7 @@
+#NOTE: I just pulled this code out of a skunkworks project into a gem, readme and tests coming soon.  Would not recommend this gem for any critical-path work at this time
+
+---
+
 # ConsoleTable
 
 TODO: Write a gem description

data/console_table.gemspec

@@ -1,11 +1,10 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'console_table/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "console_table"
-  spec.version       = "0.0.2"
+  spec.version       = "0.0.3"
   spec.authors       = ["Rod Hilton"]
   spec.email         = ["consoletable@rodhilton.com"]
   spec.summary       = %q{Simplifies printing tables of information to commandline consoles}
@@ -19,6 +18,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency 'rake', '~> 0'
+  spec.add_development_dependency 'simplecov', '~> 0.9'
 
   spec.add_runtime_dependency 'colorize', '~> 0.7'
 end

data/lib/console_table.rb

@@ -1,60 +1,61 @@
+require 'colorize'
+
 class ConsoleTable
-  
-  def self.define(layout, options, &block)
+
+  def self.define(layout, options={}, &block)
     table = ConsoleTable.new(layout, options)
-    table.print_header()
+    table.print_header
     block.call(table)
-    table.print_footer()
+    table.print_footer
   end
 
   def initialize(column_layout, options={})
     @original_column_layout = column_layout
     @left_margin = options[:left_margin] || 0
     @right_margin = options[:right_margin] || 0
-
-    @count = 0
-
+    @out = options[:output] || $stdout
     @title = options[:title]
 
     @footer_lines = []
 
-    calc_column_widths()
     @headings_printed = false
+    @count = 0
 
-    Signal.trap('SIGWINCH', proc { calc_column_widths() })
+    calc_column_widths
+    Signal.trap('SIGWINCH', proc { calc_column_widths })
   end
 
   def print_header()
-    $stdout.print " " * @left_margin
-    $stdout.print "=" * @working_width
-    $stdout.print "\n"
+    @out.print " " * @left_margin
+    @out.print "=" * @working_width
+    @out.print "\n"
 
     if not @title.nil? and @title.length <= @working_width
-      $stdout.print " "*@left_margin
+      @out.print " "*@left_margin
       left_side = (@working_width - @title.uncolorize.length)/2
       right_side = (@working_width - @title.uncolorize.length) - left_side
-      $stdout.print " "*left_side
-      $stdout.print @title
-      $stdout.print " "*right_side
-      $stdout.print "\n"
+      @out.print " "*left_side
+      @out.print @title
+      @out.print " "*right_side
+      @out.print "\n"
     end
   end
 
   def print_headings()
     @headings_printed = true
-    $stdout.print " "*@left_margin
+    @out.print " "*@left_margin
 
     @column_widths.each_with_index do |column, i|
       justify = column[:justify] || :left
       title = column[:title].strip
-      $stdout.print format(column[:size], title, false, justify).bold
-      $stdout.print " " if i < @column_widths.size-1
+      @out.print format(column[:size], title, false, justify)
+      @out.print " " if i < @column_widths.size-1
     end
-    $stdout.print "\n"
+    @out.print "\n"
 
-    $stdout.print " " * @left_margin
-    $stdout.print "-" * @working_width
-    $stdout.print "\n"
+    @out.print " " * @left_margin
+    @out.print "-" * @working_width
+    @out.print "\n"
   end
 
   def add_footer(line)
@@ -65,33 +66,33 @@ class ConsoleTable
   end
 
   def print_footer()
-    should_print_footer = @footer_lines.length > 0 && @footer_lines.any?{|l| l.uncolorize.length <= @working_width}
+    should_print_footer = @footer_lines.length > 0 && @footer_lines.any? { |l| l.uncolorize.length <= @working_width }
 
-    if(should_print_footer)
-      $stdout.print " " * @left_margin
-      $stdout.print "-" * @working_width
-      $stdout.print "\n"
+    if should_print_footer
+      @out.print " " * @left_margin
+      @out.print "-" * @working_width
+      @out.print "\n"
     end
 
     @footer_lines.each do |line|
       if line.uncolorize.length <= @working_width
-        $stdout.print " " * @left_margin
-        $stdout.print " " * (@working_width - line.uncolorize.length)
-        $stdout.print line
-        $stdout.print "\n"
+        @out.print " " * @left_margin
+        @out.print " " * (@working_width - line.uncolorize.length)
+        @out.print line
+        @out.print "\n"
       end
     end
 
-    $stdout.print " " * @left_margin
-    $stdout.print "=" * @working_width
-    $stdout.print "\n"
+    @out.print " " * @left_margin
+    @out.print "=" * @working_width
+    @out.print "\n"
   end
 
   def print_plain(to_print)
-    $stdout.print " "*@left_margin
+    @out.print " "*@left_margin
 
     if to_print.is_a? String
-      $stdout.print format(@working_width, normalize(to_print))
+      @out.print format(@working_width, normalize(to_print))
     elsif to_print.is_a? Hash
       color = to_print[:color] || :default
       background = to_print[:background] || :default
@@ -100,23 +101,23 @@ class ConsoleTable
       justify = to_print[:justify] || :left
       mode = to_print[:mode] || :default
 
-      formatted=format(@working_width, text, ellipsize, justify).colorize(:color=>color, :background=>background, :mode=>mode)
-      $stdout.print formatted
+      formatted=format(@working_width, text, ellipsize, justify).colorize(:color => color, :background => background, :mode => mode)
+      @out.print formatted
     end
 
-    $stdout.print "\n"
+    @out.print "\n"
   end
 
   def print(options)
     print_headings unless @headings_printed
 
-    $stdout.print " "*@left_margin
+    @out.print " "*@left_margin
     #column order is set, so go through each column and look up values in the incoming options
     @column_widths.each_with_index do |column, i|
       to_print = options[column[:key]] || ""
       justify = column[:justify] || :left
       if to_print.is_a? String
-        $stdout.print format(column[:size], normalize(to_print), false, justify)
+        @out.print format(column[:size], normalize(to_print), false, justify)
       elsif to_print.is_a? Hash
         color = to_print[:color] || :default
         background = to_print[:background] || :default
@@ -126,31 +127,31 @@ class ConsoleTable
         justify = to_print[:justify] || justify #can override
         mode = to_print[:mode] || :default
 
-        formatted=format(column[:size], text, ellipsize, justify).colorize(:color=>color, :background=>background, :mode=>mode)
+        formatted=format(column[:size], text, ellipsize, justify).colorize(:color => color, :background => background, :mode => mode)
 
-        unless(to_print[:highlight].nil?)
+        unless (to_print[:highlight].nil?)
           highlight_regex = to_print[:highlight][:regex] || /wontbefoundbecauseit'sgobbledygookblahblahblahbah/
           highlight_color = to_print[:highlight][:color] || :blue
           highlight_background = to_print[:highlight][:background] || :default
 
-          formatted = formatted.gsub(highlight_regex, '\0'.colorize(:color=>highlight_color, :background=>highlight_background))
+          formatted = formatted.gsub(highlight_regex, '\0'.colorize(:color => highlight_color, :background => highlight_background))
         end
 
-        $stdout.print formatted
+        @out.print formatted
       else
-        $stdout.print format(column[:size], normalize(to_print.to_s))
+        @out.print format(column[:size], normalize(to_print.to_s))
       end
 
-      $stdout.print " " if i < @column_widths.size-1
+      @out.print " " if i < @column_widths.size-1
     end
-    $stdout.print "\n"
+    @out.print "\n"
 
     @count = @count + 1
   end
 
   private
   def normalize(string)
-    if (string.nil?)
+    if string.nil?
       nil
     else
       string.to_s.gsub(/\s+/, " ").strip #Primarily to remove any tabs or newlines
@@ -167,47 +168,44 @@ class ConsoleTable
     end
 
     num_spacers = @original_column_layout.length - 1
-    set_sizes = @original_column_layout.collect{|x| x[:size]}.find_all{|x| x.is_a? Integer}
+    set_sizes = @original_column_layout.collect { |x| x[:size] }.find_all { |x| x.is_a? Integer }
     used_up = set_sizes.inject(:+) || 0
     available = total_width - used_up - @left_margin - @right_margin - num_spacers
 
-    if(available <= 0)
-      $stderr.puts "ConsoleTable configuration invalid, current window is too small to display required sizes"
-      Kernel.exit(-1)
+    if available <= 0
+      raise("ConsoleTable configuration invalid, current window is too small to display required sizes")
     end
 
-    percentages = @original_column_layout.collect{|x| x[:size]}.find_all{|x| x.is_a? Float}
+    percentages = @original_column_layout.collect { |x| x[:size] }.find_all { |x| x.is_a? Float }
     percent_used = percentages.inject(:+) || 0
 
-    if(percent_used > 1.0)
-      $stderr.puts "ConsoleTable configuration invalid, percentages total value greater than 100%"
-      Kernel.exit(-1)
+    if percent_used > 1.0
+      raise("ConsoleTable configuration invalid, percentages total value greater than 100%")
     end
 
     percent_available = 1 - percent_used
-    stars = @original_column_layout.collect{|x| x[:size]}.find_all{|x| x.is_a? String}
-    num_stars = stars.length || 1
-    percent_for_stars = percent_available / num_stars
+    stars = @original_column_layout.collect { |x| x[:size] }.find_all { |x| x.is_a? String }
+    num_stars = [stars.length, 1].max
+    percent_for_stars = percent_available.to_f / num_stars
 
     @original_column_layout.each do |column_config|
       if column_config[:size].is_a? Integer
         @column_widths << column_config #As-is when integer
       elsif column_config[:size].is_a? Float
-        @column_widths << column_config.merge({:size=> (column_config[:size]*available).floor })
+        @column_widths << column_config.merge({:size => (column_config[:size]*available).floor})
       elsif column_config[:size].is_a?(String) && column_config[:size] == "*"
-        @column_widths << column_config.merge({:size=> (percent_for_stars*available).floor })
+        @column_widths << column_config.merge({:size => (percent_for_stars*available).floor})
       else
-        $stderr.puts "ConsoleTable configuration invalid, '#{column_config[:size]}' is not a valid size"
-        Kernel.exit(-1)
+        raise("ConsoleTable configuration invalid, '#{column_config[:size]}' is not a valid size")
       end
     end
 
-    @working_width = (@column_widths.inject(0) {|res, c| res+c[:size]}) + @column_widths.length - 1
+    @working_width = (@column_widths.inject(0) { |res, c| res+c[:size] }) + @column_widths.length - 1
   end
 
   def format(length, text, ellipsize=false, justify=:left)
     if text.length > length
-      if(ellipsize)
+      if ellipsize
         text[0, length-3] + '...'
       else
         text[0, length]

data/test/console_table_test.rb

@@ -0,0 +1,238 @@
+require 'test/unit'
+require '../lib/console_table'
+
+class ConsoleTableTest < Test::Unit::TestCase
+
+  def setup
+    @mock_out = StringIO.new
+
+  end
+
+  def teardown
+    # Do nothing
+  end
+
+  def test_basic
+    ENV["COLUMNS"] = "100"
+
+    commit_table_config = [
+        {:key=>:col1, :size=>20, :title=>"Column 1"},
+        {:key=>:col2, :size=>20, :title=>"Column 2"},
+    ]
+
+    ConsoleTable.define(commit_table_config, :output=>@mock_out) do |table|
+      table.print({
+                      :col1 => "Row 1, Column 1",
+                      :col2 => "Row 1, Column 2"
+                  })
+
+      table.print({
+                      :col1 => "Row 2, Column 1",
+                      :col2 => "Row 2, Column 1"
+                  })
+    end
+
+#2345678901234567890##2345678901234567890
+    expected=<<-END
+=========================================
+Column 1             Column 2
+-----------------------------------------
+Row 1, Column 1      Row 1, Column 2
+Row 2, Column 1      Row 2, Column 1
+=========================================
+    END
+
+    assert_output_equal expected, @mock_out.string
+  end
+
+  def test_percents
+    ENV["COLUMNS"] = "100"
+
+    commit_table_config = [
+        {:key=>:col1, :size=>0.3, :title=>"Column 1"},
+        {:key=>:col2, :size=>0.7, :title=>"Column 2"},
+    ]
+
+    ConsoleTable.define(commit_table_config, :output=>@mock_out) do |table|
+      table.print({
+                      :col1 => "Row 1, Column 1",
+                      :col2 => "Row 1, Column 2"
+                  })
+
+      table.print({
+                      :col1 => "Row 2, Column 1",
+                      :col2 => "Row 2, Column 1"
+                  })
+    end
+
+    expected=<<-END
+===================================================================================================
+Column 1                      Column 2
+---------------------------------------------------------------------------------------------------
+Row 1, Column 1               Row 1, Column 2
+Row 2, Column 1               Row 2, Column 1
+===================================================================================================
+    END
+
+    assert_output_equal expected, @mock_out.string
+  end
+
+  def test_star_fills_all_extra_space
+    ENV["COLUMNS"] = "100"
+
+    commit_table_config = [
+        {:key=>:col1, :size=>20, :title=>"Column 1"},
+        {:key=>:col2, :size=>"*", :title=>"Column 2"},
+    ]
+
+    ConsoleTable.define(commit_table_config, :output=>@mock_out) do |table|
+      table.print({
+                      :col1 => "Row 1, Column 1",
+                      :col2 => "Row 1, Column 2"
+                  })
+
+      table.print({
+                      :col1 => "Row 2, Column 1",
+                      :col2 => "Row 2, Column 1"
+                  })
+    end
+
+    expected=<<-END
+====================================================================================================
+Column 1             Column 2
+----------------------------------------------------------------------------------------------------
+Row 1, Column 1      Row 1, Column 2
+Row 2, Column 1      Row 2, Column 1
+====================================================================================================
+    END
+
+    assert_output_equal expected, @mock_out.string
+  end
+
+  def test_multiple_stars_split_evenly
+    ENV["COLUMNS"] = "100"
+
+    commit_table_config = [
+        {:key=>:col1, :size=>20, :title=>"Column 1"},
+        {:key=>:col2, :size=>"*", :title=>"Column 2"},
+        {:key=>:col3, :size=>"*", :title=>"Column 3"},
+    ]
+
+    ConsoleTable.define(commit_table_config, :output=>@mock_out) do |table|
+      table.print({
+                      :col1 => "Row 1, Column 1",
+                      :col2 => "Row 1, Column 2",
+                      :col3 => "Row 1, Column 3"
+                  })
+
+      table.print({
+                      :col1 => "Row 2, Column 1",
+                      :col2 => "Row 2, Column 1",
+                      :col3 => "Row 2, Column 3"
+                  })
+    end
+
+    expected=<<-END
+====================================================================================================
+Column 1             Column 2                                Column 3
+----------------------------------------------------------------------------------------------------
+Row 1, Column 1      Row 1, Column 2                         Row 1, Column 3
+Row 2, Column 1      Row 2, Column 1                         Row 2, Column 3
+====================================================================================================
+    END
+
+    assert_output_equal expected, @mock_out.string
+  end
+
+  def test_can_combine_percentages_fixed_and_stars
+    ENV["COLUMNS"] = "160"
+
+    commit_table_config = [
+        {:key=>:col1, :size=>20, :title=>"Column 1"},
+        {:key=>:col2, :size=>0.3, :title=>"Column 2"},
+        {:key=>:col3, :size=>4, :title=>"Column 3"},
+        {:key=>:col4, :size=>"*", :title=>"Column 4"},
+        {:key=>:col5, :size=>0.2, :title=>"Column 5"},
+        {:key=>:col6, :size=>"*", :title=>"Column 6"},
+        {:key=>:col7, :size=>10, :title=>"Column 7"}
+    ]
+
+    ConsoleTable.define(commit_table_config, :output=>@mock_out) do |table|
+      table.print({
+                      :col1 => "Row 1, Column 1",
+                      :col2 => "Row 1, Column 2",
+                      :col3 => "Row 1, Column 3",
+                      :col4 => "Row 1, Column 4",
+                      :col5 => "Row 1, Column 5",
+                      :col6 => "Row 1, Column 6",
+                      :col7 => "Row 1, Column 7",
+                  })
+
+      table.print({
+                      :col1 => "Row 2, Column 1",
+                      :col2 => "Row 2, Column 2",
+                      :col3 => "Row 2, Column 3",
+                      :col4 => "Row 2, Column 4",
+                      :col5 => "Row 2, Column 5",
+                      :col6 => "Row 2, Column 6",
+                      :col7 => "Row 2, Column 7",
+                  })
+    end
+
+    expected=<<-END
+================================================================================================================================================================
+Column 1             Column 2                             Colu Column 4                       Column 5                 Column 6                       Column 7
+----------------------------------------------------------------------------------------------------------------------------------------------------------------
+Row 1, Column 1      Row 1, Column 2                      Row  Row 1, Column 4                Row 1, Column 5          Row 1, Column 6                Row 1, Col
+Row 2, Column 1      Row 2, Column 2                      Row  Row 2, Column 4                Row 2, Column 5          Row 2, Column 6                Row 2, Col
+================================================================================================================================================================
+    END
+
+    assert_output_equal expected, @mock_out.string
+  end
+
+  def test_wont_create_layout_too_large_for_screen
+    ENV["COLUMNS"] = "30"
+
+    commit_table_config = [
+        {:key=>:col1, :size=>20, :title=>"Column 1"},
+        {:key=>:col1, :size=>20, :title=>"Column 2"},
+    ]
+
+    assert_raise(RuntimeError) { ConsoleTable.define(commit_table_config) }
+  end
+
+  def test_wont_create_layout_with_more_than_100_percent
+    ENV["COLUMNS"] = "30"
+
+    commit_table_config = [
+        {:key=>:col1, :size=>0.8, :title=>"Column 1"},
+        {:key=>:col1, :size=>0.3, :title=>"Column 2"},
+    ]
+
+    assert_raise(RuntimeError) { ConsoleTable.define(commit_table_config) }
+  end
+
+  def test_wont_create_layout_with_invalid_size
+    ENV["COLUMNS"] = "30"
+
+    commit_table_config = [
+        {:key=>:col1, :size=>0.8, :title=>"Column 1"},
+        {:key=>:col1, :size=>"hello!", :title=>"Column 2"},
+    ]
+
+    assert_raise(RuntimeError) { ConsoleTable.define(commit_table_config) }
+  end
+
+  private
+  def assert_output_equal(expected, actual)
+    expected_lines = expected.split("\n")
+    actual_lines = actual.split("\n")
+    assert_equal expected_lines.length, actual_lines.length
+    expected_lines.each_with_index do |expected_line, i|
+      actual_line = actual_lines[i]
+      assert_equal expected_line.rstrip, actual_line.rstrip
+    end
+
+  end
+end

data/todo.txt

@@ -0,0 +1,2 @@
+:border=>true on options, uses | instead of " " to space and adds 2 to the spacer count. prepends if true
+perhaps :border=>:thin, :thick, thin does above, thick also adds a row of --'s between, or even smartly uses +'s for joins

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: console_table
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Rod Hilton
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
@@ -68,6 +82,8 @@ files:
 - Rakefile
 - console_table.gemspec
 - lib/console_table.rb
+- test/console_table_test.rb
+- todo.txt
 homepage: https://github.com/rodhilton/console_table
 licenses:
 - MIT
@@ -92,4 +108,5 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Simplifies printing tables of information to commandline consoles
-test_files: []
+test_files:
+- test/console_table_test.rb