console_table 0.0.5 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0f4ac113386a891b3e7d95fa64d700214eba8798
-  data.tar.gz: 6f0979982d1a0e0996312a999b020c7f253bee8f
+  metadata.gz: 2714908facb82595d5192b796aa3dee67b79c63e
+  data.tar.gz: 710aebb51608070c1ea67a72d66e3d5796f1ef9a
 SHA512:
-  metadata.gz: e0c0ccc7c271858afebdaa23bae2700d46fcf2b5f213815373685160b7ff8f50d5154bf22f0b23a33b39981d90d1462aa09574f6563308a5a8f6f7ed69c94e1b
-  data.tar.gz: 0d25ee5db8423d23545a950baeff579a4c68f0c57f2b33fbe1f8f1f5618ddf99c4c080dc27469d64eb313dc168ff005cf1f70ec661f7bc5597a8c77573450085
+  metadata.gz: b713ffa5e0c3073417e5fbd7b56f282cde5fa307e802bf771ca3312fc1e90e7f97e75b7903536e5fb42f2302983035a16dc1834d6231541e65c2e56ce4113050
+  data.tar.gz: ef98aaa437d86e63f4ee6ca91296738dba6c15a2e4e0dda5162abe72f7a88c5761363e2f5b4609d038fe6a32caddc58599337b36c448f3bc6465ef43e8dbdd3d

data/README.md

@@ -7,10 +7,12 @@ truncated or padded as needed to fit your specifications.
 
 It can be used to generate output similar to this screenshot:
 
-![image](console_table_screenshot.png =700x)
+![image](console_table_screenshot.png)
 
 You're able to specify left/right/center text justification, headers, footers, colors, and most importantly different sizes including exact character widths, screen percentages, and `*` for whatever is left.  If the window resizes the class will notice and output all new lines with recalculated locations (previous lines are not re-printed).
 
+**Note**: This project is _not_ like `hirb` and it makes no attempt to take any sort of ActiveRecord objects or an array of data and automatically fit the data to a nice table.  It gives much, much more control over to the developer in how the output is formatted, but is much more difficult to work with as a trade-off - you will have to go through each element of your data set and manually munge it into the format needed by ConsoleTable to print a line.  ConsoleTable is meant to save on a lot of math and calculation, but will do no analyzing of your data itself in order to format it, please consult the Usage section for more details.
+
 
 ## Installation
 
@@ -145,9 +147,6 @@ You can also add a title and a footer to the table, or indent the entire table w
 
 ```ruby
 require 'console_table'
-require 'terminfo'
-
-puts TermInfo.screen_columns
 
 table_config = [
    {:key=>:title, :size=>15, :title=>"Movie Title"},
@@ -159,7 +158,7 @@ table_config = [
 ConsoleTable.define(table_config, :left_margin=>5, :right_margin=>10, :title=>"Movie Killers") do |table|
 	table.print({
 		:title=>{:text=>"Friday the 13th", :highlight=>{:regex=>/[A-Z]/, :color=>:red}},
-		:name=>{:text=>"Jason", :justify=>:left},
+		:name=>{:text=>"Jason's Mom", :justify=>:left},
 		:release_date=>{text: "05-09-80", :color=>:blue},
 		:tagline=>{:text=>"They were warned...They are doomed...And on Friday the 13th, nothing will save them.", :ellipsize=>true}
 	})
@@ -171,8 +170,17 @@ ConsoleTable.define(table_config, :left_margin=>5, :right_margin=>10, :title=>"M
 		:tagline=>{:text=>"Everyone is entitled to one good scare", :ellipsize=>true}
 	})
 
+	table << {
+		:title=>{:text=>"Nightmare on Elm St.", :highlight=>{:regex=>/[A-Z]/, :color=>:red}, :background=>:orange},
+		:name=>{:text=>"Freddy Krueger", :justify=>:left},
+		:release_date=>{text: "11-16-84", :color=>:blue},
+		:tagline=>{:text=>"A scream that wakes you up, might be your own", :ellipsize=>true}
+	}
+
+	table << ["Hellraiser", "Pinhead", "9-18-87", "Demon to some. Angel to others."]
+
 	table.add_footer("This is just a line of footer text")
-	table.add_footer("This is a second footer with \nlots of \nlinebreaks\n in it.")
+	table.add_footer("This is a second footer with \nlots of \nlinebreaks in it.")
 end
 ```
 
@@ -182,17 +190,19 @@ end
                                Movie Killers
      Movie Title     Name            Release                     Motto
      -----------------------------------------------------------------
-     Friday the 13th Jason           05-09-80 They were warned...Th...
+     Friday the 13th Jason's Mom     05-09-80 They were warned...Th...
      Halloween       Michael Meyers  10-25-80 Everyone is entitled ...
+     Nightmare on El Freddy Krueger  11-16-84 A scream that wakes y...
+     Hellraiser      Pinhead         9-18-87  Demon to some. Angel to
      -----------------------------------------------------------------
                                     This is just a line of footer text
                                           This is a second footer with
                                                                lots of
-                                                            linebreaks
-                                                                in it.
-     =================================================================  
+                                                     linebreaks in it.
+     =================================================================
 ```
 
+Note the alternative method of calling print (`<<`) and the fact that you can also supply an array instead of a hash, and ConsoleTable will infer from the array order which value goes in what column
 
 ## Contributing
 
@@ -201,3 +211,7 @@ end
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## Warning
+
+This gem grew out of a skunkworks project and was originally just 300 or so lines as part of a single shell script, which I moved into its own gem simply to reduce the filesize of the script.  It was written and tested simply by making changes and running the script, and only when moving it to a gem did I write any tests for it at all.  It is somewhat undertested and likely buggy in places that my own usage of the gem never uncovered.  Please report any bugs [here](https://github.com/rodhilton/console_table/issues), but also know that I would not recommend usage of this gem for critical-path coding.

data/console_table.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "console_table"
-  spec.version       = "0.0.5"
+  spec.version       = "0.0.7"
   spec.authors       = ["Rod Hilton"]
   spec.email         = ["consoletable@rodhilton.com"]
   spec.summary       = %q{Simplifies printing tables of information to commandline consoles}

data/lib/console_table.rb

@@ -16,6 +16,7 @@ class ConsoleTable
     @right_margin = options[:right_margin] || 0
     @out = options[:output] || $stdout
     @title = options[:title]
+    @set_width = options[:width]
 
     @footer_lines = []
 
@@ -112,8 +113,21 @@ class ConsoleTable
     @out.print "\n"
   end
 
+  def <<(options)
+    print(options)
+  end
+
   def print(options)
     print_headings unless @headings_printed
+    
+    if options.is_a? Array #If an array or something is supplied, infer the order from the heading order
+      munged_options = {}
+      options.each_with_index do |element, i|
+        munged_options[@original_column_layout[i][:key]] = element
+      end
+
+      options = munged_options
+    end
 
     @out.print " "*@left_margin
     #column order is set, so go through each column and look up values in the incoming options
@@ -133,11 +147,19 @@ class ConsoleTable
 
         formatted=format(column[:size], text, ellipsize, justify)
 
-        if color != :default or background != :default or mode != :default
-          formatted = formatted.colorize(:color => color, :background => background, :mode => mode)
+        if color != :default
+          formatted = formatted.colorize(color)
         end
 
-        unless (to_print[:highlight].nil?)
+        if background != :default
+          formatted = formatted.colorize(:background=>background)
+        end
+
+        if mode != :default
+          formatted = formatted.colorize(:mode=>mode)
+        end
+
+        unless highlight.nil?
           highlight_regex = to_print[:highlight][:regex] || /wontbefoundbecauseit'sgobbledygookblahblahblahbah/
           highlight_color = to_print[:highlight][:color] || :blue
           highlight_background = to_print[:highlight][:background] || :default
@@ -169,11 +191,12 @@ class ConsoleTable
   def calc_column_widths()
     @column_widths = []
 
+    total_width = @set_width
     begin
       total_width = TermInfo.screen_columns
     rescue => ex
       total_width = ENV["COLUMNS"].to_i || 79
-    end
+    end if total_width.nil?
 
     keys = @original_column_layout.reject{|d| d[:key].nil?}.collect { |d| d[:key] }.uniq
     if keys.length < @original_column_layout.length

data/test/test_console_table.rb

@@ -5,7 +5,6 @@ class ConsoleTableTest < Minitest::Test
 
   def setup
     @mock_out = StringIO.new
-
   end
 
   def teardown
@@ -13,14 +12,12 @@ class ConsoleTableTest < Minitest::Test
   end
 
   def test_basic
-    ENV["COLUMNS"] = "100"
-
-    commit_table_config = [
+    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|
+    ConsoleTable.define(table_config, :width=> 100, :output=>@mock_out) do |table|
       table.print({
                       :col1 => "Row 1, Column 1",
                       :col2 => "Row 1, Column 2"
@@ -45,15 +42,73 @@ Row 2, Column 1      Row 2, Column 1
     assert_output_equal expected, @mock_out.string
   end
 
-  def test_percents
-    ENV["COLUMNS"] = "100"
+  def test_can_use_convenient_operator
+    table_config = [
+        {:key=>:col1, :size=>20, :title=>"Column 1"},
+        {:key=>:col2, :size=>20, :title=>"Column 2"},
+    ]
+
+    ConsoleTable.define(table_config, :width=>100, :output=>@mock_out) do |table|
+      table << {
+                    :col1 => "Row 1, Column 1",
+                    :col2 => "Row 1, Column 2"
+                }
 
-    commit_table_config = [
+      table << {
+                      :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_can_supply_array_and_order_is_inferred
+    table_config = [
+        {:key=>:col1, :size=>20, :title=>"Column 1"},
+        {:key=>:col2, :size=>20, :title=>"Column 2"},
+    ]
+
+    ConsoleTable.define(table_config, :width=> 100, :output=>@mock_out) do |table|
+      table << [
+          "Row 1, Column 1",
+          "Row 1, Column 2"
+      ]
+
+      table << [
+          {:text=>"Row 2, Column 1", :justify=>:center},
+          {:text=>"Row 2, Column 2", :justify=>:right}
+      ]
+    end
+
+    expected=<<-END
+=========================================
+Column 1             Column 2
+-----------------------------------------
+Row 1, Column 1      Row 1, Column 2
+  Row 2, Column 1         Row 2, Column 2
+=========================================
+    END
+
+    assert_output_equal expected, @mock_out.string
+  end
+
+  def test_percents
+    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|
+    ConsoleTable.define(table_config, :width=> 100, :output=>@mock_out) do |table|
       table.print({
                       :col1 => "Row 1, Column 1",
                       :col2 => "Row 1, Column 2"
@@ -78,14 +133,12 @@ Row 2, Column 1               Row 2, Column 1
   end
 
   def test_star_fills_all_extra_space
-    ENV["COLUMNS"] = "100"
-
-    commit_table_config = [
+    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|
+    ConsoleTable.define(table_config, :width=> 100, :output=>@mock_out) do |table|
       table.print({
                       :col1 => "Row 1, Column 1",
                       :col2 => "Row 1, Column 2"
@@ -110,15 +163,13 @@ Row 2, Column 1      Row 2, Column 1
   end
 
   def test_multiple_stars_split_evenly
-    ENV["COLUMNS"] = "100"
-
-    commit_table_config = [
+    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|
+    ConsoleTable.define(table_config, :width=> 100, :output=>@mock_out) do |table|
       table.print({
                       :col1 => "Row 1, Column 1",
                       :col2 => "Row 1, Column 2",
@@ -145,14 +196,12 @@ Row 2, Column 1      Row 2, Column 1                         Row 2, Column 3
   end
 
   def test_no_size_assumed_to_be_star
-    ENV["COLUMNS"] = "40"
-
-    commit_table_config = [
+    table_config = [
         {:key=>:col1, :title=>"Column 1"},
         {:key=>:col2, :title=>"Column 2"},
     ]
 
-    ConsoleTable.define(commit_table_config, :output=>@mock_out) do |table|
+    ConsoleTable.define(table_config, :width=> 40, :output=>@mock_out) do |table|
       table.print({
                       :col1 => "Row 1, Column 1",
                       :col2 => "Row 1, Column 2",
@@ -172,14 +221,12 @@ Row 1, Column 1                         Row 1, Column 2
   end
 
   def test_no_name_defaulted_to_capitalize_of_key_name
-    ENV["COLUMNS"] = "40"
-
-    commit_table_config = [
+    table_config = [
         {:key=>:col1},
         {:key=>:col2},
     ]
 
-    ConsoleTable.define(commit_table_config, :output=>@mock_out) do |table|
+    ConsoleTable.define(table_config, :width=> 40, :output=>@mock_out) do |table|
       table.print({
                       :col1 => "Row 1, Column 1",
                       :col2 => "Row 1, Column 2",
@@ -199,9 +246,7 @@ Row 1, Column 1                         Row 1, Column 2
   end
 
   def test_can_combine_percentages_fixed_and_stars
-    ENV["COLUMNS"] = "160"
-
-    commit_table_config = [
+    table_config = [
         {:key=>:col1, :size=>20, :title=>"Column 1"},
         {:key=>:col2, :size=>0.3, :title=>"Column 2"},
         {:key=>:col3, :size=>4, :title=>"Column 3"},
@@ -211,7 +256,7 @@ Row 1, Column 1                         Row 1, Column 2
         {:key=>:col7, :size=>10, :title=>"Column 7"}
     ]
 
-    ConsoleTable.define(commit_table_config, :output=>@mock_out) do |table|
+    ConsoleTable.define(table_config, :width=> 160, :output=>@mock_out) do |table|
       table.print({
                       :col1 => "Row 1, Column 1",
                       :col2 => "Row 1, Column 2",
@@ -246,68 +291,56 @@ Row 2, Column 1      Row 2, Column 2                      Row  Row 2, Column 4
   end
 
   def test_wont_create_layout_too_large_for_screen
-    ENV["COLUMNS"] = "30"
-
-    commit_table_config = [
+    table_config = [
         {:key=>:col1, :size=>20, :title=>"Column 1"},
         {:key=>:col2, :size=>20, :title=>"Column 2"},
     ]
 
-    assert_raises(RuntimeError) { ConsoleTable.define(commit_table_config) }
+    assert_raises(RuntimeError) { ConsoleTable.define(table_config, :width=>30) }
   end
 
   def test_wont_create_layout_with_more_than_100_percent
-    ENV["COLUMNS"] = "30"
-
-    commit_table_config = [
+    table_config = [
         {:key=>:col1, :size=>0.8, :title=>"Column 1"},
         {:key=>:col2, :size=>0.3, :title=>"Column 2"},
     ]
 
-    assert_raises(RuntimeError) { ConsoleTable.define(commit_table_config) }
+    assert_raises(RuntimeError) { ConsoleTable.define(table_config) }
   end
 
   def test_wont_create_layout_with_invalid_size
-    ENV["COLUMNS"] = "30"
-
-    commit_table_config = [
+    table_config = [
         {:key=>:col1, :size=>0.8, :title=>"Column 1"},
         {:key=>:col2, :size=>"hello!", :title=>"Column 2"},
     ]
 
-    assert_raises(RuntimeError) { ConsoleTable.define(commit_table_config) }
+    assert_raises(RuntimeError) { ConsoleTable.define(table_config) }
   end
 
   def test_wont_allow_repeats_of_key_names
-    ENV["COLUMNS"] = "50"
-
-    commit_table_config = [
+    table_config = [
         {:key=>:col1, :size=>20, :title=>"Column 1"},
         {:key=>:col1, :size=>20, :title=>"Column 2"},
     ]
 
-    assert_raises(RuntimeError) { ConsoleTable.define(commit_table_config) }
+    assert_raises(RuntimeError) { ConsoleTable.define(table_config) }
   end
 
   def test_wont_allow_columns_with_no_key_name
-    ENV["COLUMNS"] = "50"
-
-    commit_table_config = [
+    table_config = [
         {:key=>:col1, :size=>20, :title=>"Column 1"},
         {:size=>20, :title=>"Column 2"},
     ]
 
-    assert_raises(RuntimeError) { ConsoleTable.define(commit_table_config) }
+    assert_raises(RuntimeError) { ConsoleTable.define(table_config) }
   end
 
   def test_can_truncate_output
-    ENV["COLUMNS"] = "100"
-
-    commit_table_config = [
+    table_config = [
         {:key=>:col1, :size=>20, :title=>"Column 1"}
     ]
 
-    ConsoleTable.define(commit_table_config, :output=>@mock_out) do |table|
+    ConsoleTable.define(table_config, :width=> 100, :output=>@mock_out) do |table|
       table.print({
                       :col1 => "This is short"
                   })
@@ -335,15 +368,13 @@ This is way too l...
   end
 
   def test_can_justify_columns_and_override_in_rows
-    ENV["COLUMNS"] = "100"
-
-    commit_table_config = [
+    table_config = [
         {:key=>:col1, :size=>20, :title=>"Column 1"},
         {:key=>:col2, :size=>20, :title=>"Column 2", :justify=>:center},
         {:key=>:col3, :size=>20, :title=>"Column 3", :justify=>:right}
     ]
 
-    ConsoleTable.define(commit_table_config, :output=>@mock_out) do |table|
+    ConsoleTable.define(table_config, :width=> 100, :output=>@mock_out) do |table|
       table.print({
                       :col1 => "Short1",
                       :col2 => "Short2",
@@ -376,6 +407,63 @@ Short1                      Short2                      Short3
     assert_output_equal expected, @mock_out.string
   end
 
+  def test_huge_example
+
+    table_config = [
+        {:key=>:title, :size=>15, :title=>"Movie Title"},
+        {:key=>:name, :size=>15, :title=>"Name"},
+        {:key=>:release_date, :size=>8, :title=>"Release Date Too Long"},
+        {:key=>:tagline, :size=>"*", :title=>"Motto", :justify=>:right},
+    ]
+
+    ConsoleTable.define(table_config, :left_margin=>5, :right_margin=>10, :width=>80, :title=>"Movie Killers", :output=>@mock_out) do |table|
+      table.print({
+                      :title=>{:text=>"Friday the 13th"},
+                      :name=>{:text=>"Jason's Mom", :justify=>:left},
+                      :release_date=>{text: "05-09-80"},
+                      :tagline=>{:text=>"They were warned...They are doomed...And on Friday the 13th, nothing will save them.", :ellipsize=>true}
+                  })
+
+      table.print({
+                      :title=>{:text=>"Halloween"},
+                      :name=>{:text=>"Michael Meyers", :justify=>:left},
+                      :release_date=>{text: "10-25-80"},
+                      :tagline=>{:text=>"Everyone is entitled to one good scare", :ellipsize=>true}
+                  })
+
+      table << {
+          :title=>{:text=>"Nightmare on Elm St."},
+          :name=>{:text=>"Freddy Krueger", :justify=>:left},
+          :release_date=>{text: "11-16-84"},
+          :tagline=>{:text=>"A scream that wakes you up, might be your own", :ellipsize=>true}
+      }
+
+      table << ["Hellraiser", "Pinhead", "9-18-87", "Demon to some. Angel to others."]
+
+      table.add_footer("This is just a line of footer text")
+      table.add_footer("This is a second footer with \nlots of \nlinebreaks in it.")
+    end
+
+    expected=<<-END
+     =================================================================
+                               Movie Killers
+     Movie Title     Name            Release                     Motto
+     -----------------------------------------------------------------
+     Friday the 13th Jason's Mom     05-09-80 They were warned...Th...
+     Halloween       Michael Meyers  10-25-80 Everyone is entitled ...
+     Nightmare on El Freddy Krueger  11-16-84 A scream that wakes y...
+     Hellraiser      Pinhead         9-18-87  Demon to some. Angel to
+     -----------------------------------------------------------------
+                                    This is just a line of footer text
+                                          This is a second footer with
+                                                               lots of
+                                                     linebreaks in it.
+     =================================================================
+    END
+
+    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.0.5
+  version: 0.0.7
 platform: ruby
 authors:
 - Rod Hilton