console_table 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8df10271a0fee5c99ea39e43b65df2b2f7d4f047
-  data.tar.gz: 210bf58871ea3015c9ce28944018d4049d4dc89b
+  metadata.gz: 7bc8c0f79d2fc85c38865c3b33db892ff2a432db
+  data.tar.gz: 77c8ef6f4172966e2bd66e98e900522145dd19d8
 SHA512:
-  metadata.gz: 9d05a9e405b606cb76de88b09be313ceccd17d847bf5880a96a8c6693b26e15bd287981e72ffe5fd52ed4921243aa9d5d43d67a53b526789f88e213b869028f9
-  data.tar.gz: cbd331465a4707a54852801b57a0d5f00bce0bb5e4d82a1ef546022781239cb4e09ec51f4c2fdcad73da1c51ada46ae7dd25cad15ac7937dcfbc35a5becf4eba
+  metadata.gz: 8fa13fbebea0d09c30a2a84bab7c4bca6ecfc0b8c43ecdbe255c142f1115ba43a8698527149034f7f80e97c027febfb01b29ecf6571ec905f8cb5cff95a0cc57
+  data.tar.gz: 0c35bba2d213990e7bf7e292a566df77d788cdda194ff4136004df021c6ff2518d3b40e89359d5cb60e9827ccec1ccb4164cc0b2a34e78f6aeb2d7a93b6d8618

data/README.md

@@ -143,6 +143,44 @@ Rod             04-14-80 Chainsaw         This is a very long motto, I don't...
 
 Due to limitations of this readme format, you'll have to take my word for it that the colors placed by the 'colorize' gem are preserved, and that the table correctly handles resetting ANSI colors when truncating messages that have formatting.
 
+Another little trick is that you can specify justification options by convention without using hashes for the values, simply by appending or prepending a tab character to the string.  For example:
+
+```ruby
+table_config = [
+   {:key=>:col1, :size=>26, :title=>"Column 1", :justify=>:right},
+   {:key=>:col2, :size=>26, :title=>"Column 2", :justify=>:left},
+   {:key=>:col3, :size=>26, :title=>"Column 3", :justify=>:center}
+]
+
+ConsoleTable.define(table_config) do |table|
+
+	table << {
+		:col1=>"Right",
+		:col2=>"Left",
+		:col3=>"Center"
+	}
+
+	table << {
+		:col1=>"Left\t",
+		:col2=>"\tCenter\t",
+		:col3=>"\tRight"
+	}
+end
+```
+
+This will output:
+
+```
+================================================================================
+                  Column 1 Column 2                            Column 3
+--------------------------------------------------------------------------------
+                     Right Left                                 Center
+Left                                 Center                                Right
+================================================================================
+```
+
+Notice here how the columns all have justifications set, but the values in the second row override all of them, simply by appending a tab character for left justified, prepending a tab character for right justified, and doing both for center.  The tab characters themselves are removed.  Please note this convention is not supported for the column definitions using the "title" attribute, there you must use hash properties to set a column-level justification.
+
 You can also add a title and a footer to the table, or indent the entire table within the window using different options.  Again, here's another example that should more-or-less speak for itself.
 
 
@@ -211,8 +249,4 @@ Note the alternative method of calling `<<` where you can supply an Array instea
 2. Create your feature branch (`git checkout -b my-new-feature`)
 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.
+5. Create new Pull Request

data/lib/console_table.rb

@@ -1,7 +1,7 @@
 require 'terminfo'
 
 module ConsoleTable
-  VERSION = "0.1.2"
+  VERSION = "0.1.4"
 
   def self.define(layout, options={}, &block)
     table = ConsoleTableClass.new(layout, options)
@@ -172,12 +172,19 @@ module ConsoleTable
       @column_widths.each_with_index do |column, i|
         to_print = options[column[:key]] || ""
         justify = column[:justify] || :left
+        ellipsize = column[:ellipsize] || false
+
         if to_print.is_a? String
-          @out.print format(column[:size], normalize(to_print), false, justify)
+          justify = infer_justify_from_string(to_print, justify)
+
+          @out.print format(column[:size], normalize(to_print), ellipsize, justify)
         elsif to_print.is_a? Hash
+          justify = infer_justify_from_string(to_print[:text], justify)
+
           text = normalize(to_print[:text]) || ""
-          ellipsize = to_print[:ellipsize] || false
-          justify = to_print[:justify] || justify #can override
+
+          ellipsize = to_print[:ellipsize] unless to_print[:ellipsize].nil?
+          justify = to_print[:justify] unless to_print[:justify].nil?
 
           formatted=format(column[:size], text, ellipsize, justify)
 
@@ -197,11 +204,29 @@ module ConsoleTable
       @count = @count + 1
     end
 
+    def infer_justify_from_string(to_print, justify)
+      uncolorized = uncolorize(to_print)
+      if uncolorized.start_with?("\t") and uncolorized.end_with?("\t")
+        justify = :center
+      elsif uncolorized.start_with?("\t")
+        justify = :right
+      elsif uncolorized.end_with?("\t")
+        justify = :left
+      end
+      justify
+    end
+
     def normalize(string)
       if string.nil?
         nil
       else
-        string.to_s.gsub(/\s+/, " ").strip #Primarily to remove any tabs or newlines
+        require 'pp'
+        normalized = string.to_s
+
+        normalized = normalized.sub(/^(\e\[\d.*?m)(\s+)/, '\2\1') #Any leading spaces preceeded by a color code should be swapped with the color code itself, so the spaces themselves aren't colored
+        normalized = normalized.sub(/(\s+)(\e\[\d.*?m)$/, '\2\1')
+
+        normalized.gsub(/\s+/, " ").strip #Primarily to remove any tabs or newlines
       end
     end
 
@@ -226,7 +251,7 @@ module ConsoleTable
       used_up = set_sizes.inject(:+) || 0
       available = total_width - used_up - @left_margin - @right_margin - num_spacers
 
-      if available <= 0
+      if available < 0
         raise("ConsoleTable configuration invalid, current window is too small to display required sizes")
       end
 

data/test/test_console_table.rb

@@ -2,6 +2,10 @@ require 'minitest/autorun'
 require 'console_table'
 require 'colorize'
 
+#TODO: What happens if you have a linebreak in what you print?
+# - what if it occurs inside of an active color code?
+#TODO: trimming from different sides depending on justification?
+
 class ConsoleTableTest < Minitest::Test
 
   def setup
@@ -43,6 +47,278 @@ Row 2, Column 1      Row 2, Column 1
     assert_output_equal expected, @mock_out.string
   end
 
+  def test_unicode
+    table_config = [
+        {:key=>:col1, :size=>20, :title=>"Column 1"},
+        {:key=>:col2, :size=>20, :title=>"Column 2"},
+        {:key=>:col3, :size=>20, :title=>"Column 3"},
+    ]
+
+    ConsoleTable.define(table_config, :width=> 62, :output=>@mock_out) do |table|
+      table << {
+          :col1 => "I ♥ Unicode",
+          :col2 => "I ☂ Unicode",
+          :col3 => "I ♞ Unicode"
+      }
+
+      table << {
+          :col1 => "I ⚂ Unicode Even More",
+          :col2 => "I \u00A5 Unicode Even More",
+          :col3 => "I µ Unicode Even More"
+      }
+
+      table << {
+          :col1 => {:text => "I ⁂ Unicode", :justify=>:right},
+          :col2 => {:text => "I \u2190 Unicode", :justify=>:center},
+          :col3 => {:text => "I ✓ Unicode", :justify=>:left}
+      }
+    end
+
+    expected=<<-END
+==============================================================
+Column 1             Column 2             Column 3
+--------------------------------------------------------------
+I ♥ Unicode          I ☂ Unicode          I ♞ Unicode
+I ⚂ Unicode Even Mor I ¥ Unicode Even Mor I µ Unicode Even Mor
+         I ⁂ Unicode     I ← Unicode      I ✓ Unicode
+==============================================================
+    END
+
+    assert_output_equal expected, @mock_out.string
+  end
+
+  def test_spacing_convention_sets_justification
+    table_config = [
+        {:key=>:col1, :size=>20, :title=>"Column 1"},
+        {:key=>:col2, :size=>20, :title=>"Column 2"},
+        {:key=>:col3, :size=>20, :title=>"Column 3"},
+    ]
+
+    ConsoleTable.define(table_config, :width=> 62, :output=>@mock_out) do |table|
+      table << [
+          "\tRight",
+          "\tCenter\t",
+          "Left\t"
+      ]
+    end
+
+    expected=<<-END
+==============================================================
+Column 1             Column 2             Column 3
+--------------------------------------------------------------
+               Right        Center        Left
+==============================================================
+    END
+
+    assert_output_equal expected, @mock_out.string
+  end
+
+  def test_newlines_converted_to_spaces_in_middle_stripped_at_ends
+    table_config = [
+        {:key=>:col1, :size=>20, :title=>"Column 1"},
+        {:key=>:col2, :size=>20, :title=>"Column 2"},
+        {:key=>:col3, :size=>20, :title=>"Column 3"},
+    ]
+
+    ConsoleTable.define(table_config, :width=> 62, :output=>@mock_out) do |table|
+      table << [
+          {:text=>"Bl\nah", :justify=>:left},
+          {:text=>"\nStuff", :justify=>:left},
+          {:text=>"Junk\n", :justify=>:right}
+      ]
+    end
+
+    expected=<<-END
+==============================================================
+Column 1             Column 2             Column 3
+--------------------------------------------------------------
+Bl ah                Stuff                                Junk
+==============================================================
+    END
+
+    assert_output_equal expected, @mock_out.string
+  end
+
+  def test_linebreak_inside_colorcode_still_resets
+    table_config = [
+        {:key=>:col1, :size=>20, :title=>"Column 1"},
+        {:key=>:col2, :size=>5, :title=>"Column 2"},
+    ]
+
+    ConsoleTable.define(table_config, :width=> 62, :output=>@mock_out) do |table|
+      table << [
+          "Bl\nah".blue,
+          "1234\nStuff".red
+      ]
+    end
+
+    expected=<<-END
+==========================
+Column 1             Colum
+--------------------------
+Bl ah                1234
+==========================
+    END
+
+    require 'pp'
+    puts @mock_out.string
+
+    assert_includes @mock_out.string, "\e[0;34;49mBl ah\e[0m"  #ensure the color got reset
+    assert_includes @mock_out.string, "\e[0;31;49m1234 \e[0m"  #ensure the color got reset
+
+    assert_output_equal expected, @mock_out.string
+  end
+
+  def test_can_ellipsize_at_column_level
+    table_config = [
+        {:key=>:col1, :size=>20, :title=>"Column 1", :ellipsize=>true},
+        {:key=>:col2, :size=>20, :title=>"Column 2"},
+    ]
+
+    ConsoleTable.define(table_config, :width=> 62, :output=>@mock_out) do |table|
+      table << [
+          "This is way too long to fit here",
+          "This is way too long to fit here",
+      ]
+
+      table << [
+          {text: "This is way too long to fit here", :ellipsize=>false},
+          {text: "This is way too long to fit here", :ellipsize=>true},
+      ]
+    end
+
+    expected=<<-END
+=========================================
+Column 1             Column 2
+-----------------------------------------
+This is way too l... This is way too long
+This is way too long This is way too l...
+=========================================
+    END
+
+    assert_output_equal expected, @mock_out.string
+  end
+
+  def test_justify_convention_followed_in_hash_text_but_overrideable
+    table_config = [
+        {:key=>:col1, :size=>20, :title=>"Column 1", :justify=>:center},
+    ]
+
+    ConsoleTable.define(table_config, :width=> 62, :output=>@mock_out) do |table|
+      table << ["Short"]
+      table << ["\tShort"]
+      table << ["Short\t"]
+      table << [{:text=>"Short", :justify=>:right}]
+      table << [{:text=>"Short", :justify=>:left}]
+      table << [{:text=>"\tShort"}]
+      table << [{:text=>"Short\t"}]
+      table << [{:text=>"\tShort", :justify=>:left}] #Override
+      table << [{:text=>"Short\t", :justify=>:right}] #Override
+    end
+
+    expected=<<-END
+====================
+      Column 1
+--------------------
+       Short
+               Short
+Short
+               Short
+Short
+               Short
+Short
+Short
+               Short
+====================
+    END
+
+    puts @mock_out.string
+
+    assert_output_equal expected, @mock_out.string
+  end
+
+  def test_should_not_color_tabs_or_ignore_tab_justify_convention_if_inside_color
+    table_config = [
+        {:key=>:col1, :size=>20, :title=>"Column 1", :justify=>:center},
+        {:key=>:col2, :size=>20, :title=>"Column 2", :justify=>:right},
+        {:key=>:col3, :size=>20, :title=>"Column 3", :justify=>:left},
+    ]
+
+    ConsoleTable.define(table_config, :width=> 62, :output=>@mock_out) do |table|
+      table << [
+          "\tRight".blue,
+          "\tCenter\t".red,
+          "Left\t".magenta,
+      ]
+    end
+
+    expected=<<-END
+==============================================================
+      Column 1                   Column 2 Column 3
+--------------------------------------------------------------
+               Right       Center         Left
+==============================================================
+    END
+
+    assert_includes @mock_out.string, " \e[0;34;49mRight\e[0m"  #space is on outside of coor
+    assert_includes @mock_out.string, " \e[0;35;49mLeft\e[0m "  #space is on outside of color
+    #assert_includes @mock_out.string, " \e[0;31;49mCenter\e[0m "  #this assert fails due to what I'm pretty sure is a bug in gsub(), but it's not the end of the world so I'm not doing a workaround
+
+    assert_output_equal expected, @mock_out.string
+  end
+
+  def test_spaces_preserved_in_middle_but_stripped_at_ends
+    table_config = [
+        {:key=>:col1, :size=>20, :title=>"Column 1"},
+        {:key=>:col2, :size=>20, :title=>"Column 2"},
+        {:key=>:col3, :size=>20, :title=>"Column 3"},
+    ]
+
+    ConsoleTable.define(table_config, :width=> 62, :output=>@mock_out) do |table|
+      table << [
+          {:text=>"Bl ah", :justify=>:left},
+          {:text=>" Stuff", :justify=>:left},
+          {:text=>"Junk ", :justify=>:right}
+      ]
+    end
+
+    expected=<<-END
+==============================================================
+Column 1             Column 2             Column 3
+--------------------------------------------------------------
+Bl ah                Stuff                                Junk
+==============================================================
+    END
+
+    assert_output_equal expected, @mock_out.string
+  end
+
+  def test_ignores_tabbing_convention_if_setting_justification_explicitly
+    table_config = [
+        {:key=>:col1, :size=>20, :title=>"Column 1"},
+        {:key=>:col2, :size=>20, :title=>"Column 2"},
+        {:key=>:col3, :size=>20, :title=>"Column 3"},
+    ]
+
+    ConsoleTable.define(table_config, :width=> 62, :output=>@mock_out) do |table|
+      table << [
+          {:text=>"\tBlah", :justify=>:left},
+          {:text=>"\tStuff\t", :justify=>:right},
+          {:text=>"\tJunk", :justify=>:center}
+      ]
+    end
+
+    expected=<<-END
+==============================================================
+Column 1             Column 2             Column 3
+--------------------------------------------------------------
+Blah                                Stuff         Junk
+==============================================================
+    END
+
+    assert_output_equal expected, @mock_out.string
+  end
+
   def test_can_use_convenient_operator
     table_config = [
         {:key=>:col1, :size=>20, :title=>"Column 1"},

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: console_table
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Rod Hilton
@@ -112,7 +112,6 @@ files:
 - console_table_screenshot.png
 - lib/console_table.rb
 - test/test_console_table.rb
-- todo.txt
 homepage: https://github.com/rodhilton/console_table
 licenses:
 - MIT

data/todo.txt

@@ -1 +0,0 @@
-better handling of colors. should you be able to supply colored strings and the spacing is smart enough to ignore control characters?