console_table 0.1.7 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d29f00cea80b04a26dc82d97bfa2f6223a37966d
-  data.tar.gz: 66059cc9c33ec69fe028422c3fc707a53fb94f29
+  metadata.gz: d31ea023e41a11349f456744423ec4ebf540102c
+  data.tar.gz: cba32a643b607437ece928dbed1dd818ea64d0ac
 SHA512:
-  metadata.gz: 17cd329d715430896670cd02dcaf547af1cd93199192cee28d6b85e594b196e9d3152c7d0a24656a5a48dd331fae4ef5e52bb387bc42002e73379fd337afa490
-  data.tar.gz: 6592e9a36084707eec3b715c90ff8118943be9a8c6d9b7ce7112a8503d5d511747e3aff97664164d07ccfe1053e777acc2ac0fd792356d81c8dceaafa702578b
+  metadata.gz: b607321df3045b48f45ca3e77570def4fa316d221d853a594c62b6bd689d9b93b493bc7a50ca420214d63f4cca97f96d7d674ce4e08b4463c0749f102daee9b8
+  data.tar.gz: 9382b05787a3453d447d00dc8e83a0a6bd5ec09d55553d69ae31af8409058640b61086ac90a9ffc75575ff9abac35ed254cd33db27422ae3cb2cfc5ab7dd11ac

data/README.md

@@ -1,6 +1,5 @@
-# ConsoleTable
-
-[![Gem Version](https://badge.fury.io/rb/console_table.svg)](https://rubygems.org/gems/console_table) [![Build Status](https://travis-ci.org/rodhilton/console_table.svg?branch=master)](https://travis-ci.org/rodhilton/console_table)
+ConsoleTable [![Gem Version](https://badge.fury.io/rb/console_table.svg)](https://rubygems.org/gems/console_table) [![Build Status](https://travis-ci.org/rodhilton/console_table.svg?branch=master)](https://travis-ci.org/rodhilton/console_table)
+=========
 
 ConsoleTable is a helper class that allows you to print data to a console in a clean, table-like fashion.  It's intended for use
 in commandline applications with information-dense output.  It checks your terminal window size (or COLUMNS environment variable) to ensure
@@ -214,6 +213,7 @@ You can also add a title and a footer to the table, or indent the entire table w
 
 ```ruby
 require 'console_table'
+require 'colorize'
 
 table_config = [
    {:key=>:title, :size=>15, :title=>"Movie Title"},
@@ -224,23 +224,23 @@ table_config = [
 
 ConsoleTable.define(table_config, :left_margin=>5, :right_margin=>10, :title=>"Movie Killers") do |table|
 	table << {
-		:title=>"Friday the 13th"
+		:title=>"Friday the 13th",
 		:name=>{:text=>"Jason's Mom", :justify=>:left},
-		:release_date=>"05-09-80".blue
+		:release_date=>"05-09-80".blue,
 		:tagline=>{:text=>"They were warned...They are doomed...And on Friday the 13th, nothing will save them.", :ellipsize=>true}
 	}
 
 	table << {
 		:title=>"Halloween".white.on_red,
 		:name=>{:text=>"Michael Meyers", :justify=>:left},
-		:release_date=>"10-25-80".blue
+		:release_date=>"10-25-80".blue,
 		:tagline=>{:text=>"Everyone is entitled to one good scare", :ellipsize=>true}
 	}
 
 	table << {
-		:title=>{:text=>"Nightmare on Elm St."}
+		:title=>{:text=>"Nightmare on Elm St."},
 		:name=>{:text=>"Freddy Krueger", :justify=>:left},
-		:release_date=>{text: "11-16-84".blue}
+		:release_date=>{text: "11-16-84".blue},
 		:tagline=>{:text=>"A scream that wakes you up, might be your own", :ellipsize=>true}
 	}
 
@@ -251,6 +251,7 @@ ConsoleTable.define(table_config, :left_margin=>5, :right_margin=>10, :title=>"M
 end
 ```
 
+which yields:
 
 ```
      =================================================================
@@ -412,6 +413,7 @@ end
 ```
 
 Which yields:
+
 ```
 ================================================================================
 Name                       DOB                        Title

data/console_table.gemspec

@@ -1,11 +1,11 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'console_table'
+# require 'console_table'
 
 Gem::Specification.new do |spec|
   spec.name          = "console_table"
-  spec.version       = ConsoleTable::VERSION
+  spec.version       = "0.2.0"
   spec.authors       = ["Rod Hilton"]
   spec.email         = ["consoletable@rodhilton.com"]
   spec.summary       = %q{Simplifies printing tables of information to commandline consoles}
@@ -17,6 +17,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_development_dependency 'simplecov', '~> 0.9'
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency 'rake', '~> 0'
   spec.add_development_dependency 'minitest', '~> 5.5'

data/lib/console_table.rb

@@ -1,6 +1,24 @@
+# ConsoleTable allows you to define a table with columns set to specific sizes,
+# and then give that table rows of data which it will format into a view that fits
+# inside a terminal/console.
+#
+# Author::    Rod Hilton
+# License::   MIT
+#
+#--
+# TODO: it's a little weird how, if a footer is too long, it simply doesn't print at all.
+#   This seems like not what someone would want to have happen.
+#   Could we take footer lines and split them every X characters where X is the working
+#   width, then use those?  Long lines effectively wrap, but not on word boundaries
+# TODO: if you're doing center or right-justification, should it trim from the sides or
+#   from the left, respectively?
+#++
+
 module ConsoleTable
-  VERSION = "0.1.7"
+  VERSION = "0.1.8"
 
+  # Define a console table.  Requires a table layout which specifies column information
+  # like sizes, titles, and key names.
   def self.define(layout, options={}, &block)
     table = ConsoleTableClass.new(layout, options)
     table.send(:print_header)
@@ -9,8 +27,11 @@ module ConsoleTable
   end
 
   class ConsoleTableClass
+
+    # Add strings to the footer array to have them formatted when the table closes
     attr_reader :footer
 
+    # Add rows to the table.  Prints immediately, consult documentation for examples
     def <<(options)
       print(options)
     end
@@ -92,6 +113,30 @@ module ConsoleTable
       end
     end
 
+    def print_footer()
+      if should_print_footer
+        print_line
+      end
+
+      footer_lines.each do |line|
+        if uncolorize(line).length <= @working_width
+          @out.print " " * @left_margin
+          @out.print "|" if @borders
+          @out.print format(@working_width, line, false, :right)
+          @out.print "|" if @borders
+          @out.print "\n"
+        end
+      end
+
+      if should_print_footer
+        print_line("=", "*", true)
+      else
+        print_line("=", "*", false)
+      end if @outline
+    end
+
+    private
+
     def print_headings()
       @headings_printed = true
 
@@ -137,30 +182,6 @@ module ConsoleTable
       end
     end
 
-    #TODO: it's a little weird how, if a footer is too long, it simply doesn't print at all.  This seems like not what someone would want to have happen.
-    #Could we take footer lines and split them every X characters where X is the working width, then use those?  Long lines effectively wrap, but not on word boundaries
-    def print_footer()
-      if should_print_footer
-        print_line
-      end
-
-      footer_lines.each do |line|
-        if uncolorize(line).length <= @working_width
-          @out.print " " * @left_margin
-          @out.print "|" if @borders
-          @out.print format(@working_width, line, false, :right)
-          @out.print "|" if @borders
-          @out.print "\n"
-        end
-      end
-
-      if should_print_footer
-        print_line("=", "*", true)
-      else
-        print_line("=", "*", false)
-      end if @outline
-    end
-
     def should_print_footer
       footer_lines.length > 0 && footer_lines.any? { |l| uncolorize(l).length <= @working_width }
     end
@@ -321,7 +342,6 @@ module ConsoleTable
       string.gsub(/\e\[\d[^m]*?m/m, "")
     end
 
-    #TODO: if you're doing center or right-justification, should it trim from the sides or from the left, respectively?
     def format(length, text, ellipsize=false, justify=:left)
       uncolorized = uncolorize(text)
       if uncolorized.length > length
@@ -354,8 +374,6 @@ module ConsoleTable
               color_active = true
             end
             final_string_parts << color_code
-          else
-            raise("Something very confusing happened")
           end
           current_index = current_index + 1
         end
@@ -385,13 +403,8 @@ module ConsoleTable
       @out.print "|" if @borders
 
       if to_print.is_a? String
-        @out.print format(@working_width, normalize(to_print))
-      elsif to_print.is_a? Hash
-        text = normalize(to_print[:text]) || ""
-        ellipsize = to_print[:ellipsize] || false
-        justify = to_print[:justify] || :left
-
-        @out.print format(@working_width, text, ellipsize, justify)
+        justify = infer_justify_from_string(to_print, :left)
+        @out.print format(@working_width, normalize(to_print), false, justify)
       end
 
       @out.print "|" if @borders

data/test/test_console_table.rb

@@ -1,13 +1,15 @@
 # encoding: utf-8
+require 'simplecov'
+SimpleCov.start
+
 require 'minitest/autorun'
-#TODO: trimming from different sides depending on justification?
 
 class ConsoleTableTest < Minitest::Test
 
-  require 'console_table'
-  require 'colorize'
 
   def setup
+    require 'console_table'
+    require 'colorize'
     @mock_out = StringIO.new
   end
 
@@ -1260,8 +1262,6 @@ Row 2, Column 1                            Row 2, Column 1
 ==========================================================
     END
 
-    puts @mock_out.string
-
     assert_output_equal expected, @mock_out.string
 
   end
@@ -1288,6 +1288,86 @@ Row 2, Column 1         Row 2, Column 2
 
   end
 
+  def test_can_print_basically_anything
+    table_config = [
+        {:key => :col1, :size => 20, :title => "Column 1"}
+    ]
+
+    ConsoleTable.define(table_config, :width => 100, :output=>@mock_out) do |table|
+      table << ["String"]
+      table << [42]
+      table << [0.3]
+      table << [:why_not]
+      table << [nil]
+
+    end
+
+    expected=<<-END
+====================
+Column 1
+--------------------
+String
+42
+0.3
+why_not
+
+====================
+    END
+
+    assert_output_equal expected, @mock_out.string
+  end
+
+  def test_plain_line_can_be_justified
+    table_config = [
+        {:key => :col1, :size => 20, :title => "Column 1"}
+    ]
+
+    ConsoleTable.define(table_config, :width => 30, :output => @mock_out) do |table|
+      table << ["One"]
+
+      table << "Plain line"
+      table << "Plain line\t"
+      table << "\tPlain line\t"
+      table << "\tPlain line"
+
+      table << ["Two"]
+
+    end
+
+    expected=<<-END
+====================
+Column 1
+--------------------
+One
+Plain line
+Plain line
+     Plain line
+          Plain line
+Two
+====================
+    END
+
+    assert_output_equal expected, @mock_out.string
+  end
+
+  def test_trimming_without_cutting_off_color_doesnt_result_in_extra_color_reset
+    ConsoleTable.define([30], :width => 30, :output => @mock_out) do |table|
+      table << ["This is way too long and #{"will".red} be truncated"]
+    end
+
+    expected=<<-END
+==============================
+Column 1
+------------------------------
+This is way too long and will
+==============================
+    END
+
+    assert_includes @mock_out.string, "and \e[0;31;49mwill\e[0m \n"
+
+    assert_output_equal expected, @mock_out.string
+  end
+
   private
   def assert_output_equal(expected, actual)
     expected_lines = expected.split("\n")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: console_table
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.2.0
 platform: ruby
 authors:
 - Rod Hilton
@@ -10,6 +10,20 @@ bindir: bin
 cert_chain: []
 date: 2015-02-14 00:00:00.000000000 Z
 dependencies:
+- !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: bundler
   requirement: !ruby/object:Gem::Requirement