console_table 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 62dec8c67df25306a62e7c1ccaa8341a5ca603f0
-  data.tar.gz: 7592bb485b9e110eab9395df2da50063625cad73
+  metadata.gz: 8df10271a0fee5c99ea39e43b65df2b2f7d4f047
+  data.tar.gz: 210bf58871ea3015c9ce28944018d4049d4dc89b
 SHA512:
-  metadata.gz: 3331fee285ff870bcdd5e7ac8e44f7cb75a1b943a6ef2cbe656078a0ba44ea31bbad0c87c6e724dcad6a22ffd0788816bc789c031e5958dd5aaa3369d83d7f48
-  data.tar.gz: 4738d8b0d88d6764df4e5e32e0314fa2829a0a79cfbb5df9fdc0367efa64d3a00e69fc9ed9ff37ab013dbff42337212a2805f8c074901203f6f26ba82b63f93d
+  metadata.gz: 9d05a9e405b606cb76de88b09be313ceccd17d847bf5880a96a8c6693b26e15bd287981e72ffe5fd52ed4921243aa9d5d43d67a53b526789f88e213b869028f9
+  data.tar.gz: cbd331465a4707a54852801b57a0d5f00bce0bb5e4d82a1ef546022781239cb4e09ec51f4c2fdcad73da1c51ada46ae7dd25cad15ac7937dcfbc35a5becf4eba

data/README.md

@@ -9,7 +9,7 @@ It can be used to generate output similar to this screenshot:
 
 ![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).
+You're able to specify left/right/center text justification, headers, footers, 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.
 
@@ -123,8 +123,8 @@ table_config = [
 
 ConsoleTable.define(table_config) do |table|
 	table << {
-		:name=>{:text=>"Rod", :highlight=>{:regex=>/[A-Z]/, :color=>:red},
-		:birthday=>{text: "04-14-80", :color=>:blue},
+		:name=>"Rod".colorize(:red) #Uses 'colorize' gem
+		:birthday=>"04-14-80".blue,
 		:nickname=>{:text=>"Chainsaw", :justify=>:left},
 		:motto=>{:text=>"This is a very long motto, I don't mind if it gets cut off but I'd like it to indicate as such with ellipses", :ellipsize=>true}
 	}
@@ -138,9 +138,10 @@ will output
 Name            DOB        Nickname(s)                                    Motto
 -------------------------------------------------------------------------------
 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 capital letters in the Name are highlighted Red, and the DOB is blue.
+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.
 
 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.
 
@@ -157,23 +158,23 @@ table_config = [
 
 ConsoleTable.define(table_config, :left_margin=>5, :right_margin=>10, :title=>"Movie Killers") do |table|
 	table << {
-		:title=>{:text=>"Friday the 13th", :highlight=>{:regex=>/[A-Z]/, :color=>:red}},
+		:title=>"Friday the 13th"
 		:name=>{:text=>"Jason's Mom", :justify=>:left},
-		:release_date=>{text: "05-09-80", :color=>: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=>{:text=>"Halloween", :highlight=>{:regex=>/[A-Z]/, :color=>:red}, :background=>:orange},
+		:title=>"Halloween".white.on_red,
 		:name=>{:text=>"Michael Meyers", :justify=>:left},
-		:release_date=>{text: "10-25-80", :color=>: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.", :highlight=>{:regex=>/[A-Z]/, :color=>:red}, :background=>:orange},
+		:title=>{:text=>"Nightmare on Elm St."}
 		:name=>{:text=>"Freddy Krueger", :justify=>:left},
-		:release_date=>{text: "11-16-84", :color=>:blue},
+		:release_date=>{text: "11-16-84".blue}
 		:tagline=>{:text=>"A scream that wakes you up, might be your own", :ellipsize=>true}
 	}
 

data/console_table.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 0'
   spec.add_development_dependency 'simplecov', '~> 0.9'
   spec.add_development_dependency 'minitest', '~> 5.5'
+  spec.add_development_dependency 'colorize', '~> 0.7'
 
-  spec.add_runtime_dependency 'colorize', '~> 0.7'
   spec.add_runtime_dependency 'ruby-terminfo', '~> 0.1'
 end

data/lib/console_table.rb

@@ -1,8 +1,7 @@
-require 'colorize'
 require 'terminfo'
 
 module ConsoleTable
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 
   def self.define(layout, options={}, &block)
     table = ConsoleTableClass.new(layout, options)
@@ -58,11 +57,7 @@ module ConsoleTable
       if not @title.nil? and @title.length <= @working_width
         @out.print " "*@left_margin
         @out.print "|" if @borders
-        left_side = (@working_width - @title.uncolorize.length)/2
-        right_side = (@working_width - @title.uncolorize.length) - left_side
-        @out.print " "*left_side
-        @out.print @title
-        @out.print " "*right_side
+        @out.print format(@working_width, @title, false, :center)
         @out.print "|" if @borders
         @out.print "\n"
         print_line if @borders
@@ -98,7 +93,7 @@ module ConsoleTable
         @out.print join_char
         @column_widths.each_with_index do |column, i|
           @out.print char*column[:size]
-          if(edge_join_only and i < @column_widths.length - 1)
+          if edge_join_only and i < @column_widths.length - 1
             @out.print char
           else
             @out.print join_char
@@ -118,11 +113,10 @@ module ConsoleTable
       end
 
       footer_lines.each do |line|
-        if line.uncolorize.length <= @working_width
+        if uncolorize(line).length <= @working_width
           @out.print " " * @left_margin
           @out.print "|" if @borders
-          @out.print " " * (@working_width - line.uncolorize.length)
-          @out.print line
+          @out.print format(@working_width, line, false, :right)
           @out.print "|" if @borders
           @out.print "\n"
         end
@@ -136,7 +130,7 @@ module ConsoleTable
     end
 
     def should_print_footer
-      footer_lines.length > 0 && footer_lines.any? { |l| l.uncolorize.length <= @working_width }
+      footer_lines.length > 0 && footer_lines.any? { |l| uncolorize(l).length <= @working_width }
     end
 
     def footer_lines
@@ -144,7 +138,7 @@ module ConsoleTable
       @footer.each do |line|
         lines = line.split("\n")
         lines.each do |l|
-          footer_lines << l.strip unless l.nil? or l.uncolorize.strip == ""
+          footer_lines << l.strip unless l.nil? or uncolorize(l).strip == ""
         end
       end
       footer_lines
@@ -152,7 +146,7 @@ module ConsoleTable
 
     def print(options)
 
-      if (options.is_a? String)
+      if options.is_a? String
         print_plain(options)
         return
       end
@@ -181,36 +175,12 @@ module ConsoleTable
         if to_print.is_a? String
           @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
           text = normalize(to_print[:text]) || ""
           ellipsize = to_print[:ellipsize] || false
-          highlight = to_print[:highlight]
           justify = to_print[:justify] || justify #can override
-          mode = to_print[:mode] || :default
 
           formatted=format(column[:size], text, ellipsize, justify)
 
-          if color != :default
-            formatted = formatted.colorize(color)
-          end
-
-          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
-
-            formatted = formatted.gsub(highlight_regex, '\0'.colorize(:color => highlight_color, :background => highlight_background))
-          end
-
           @out.print formatted
         else
           @out.print format(column[:size], normalize(to_print.to_s))
@@ -287,23 +257,64 @@ module ConsoleTable
       @working_width = (@column_widths.inject(0) { |res, c| res+c[:size] }) + @column_widths.length - 1
     end
 
+
+    def uncolorize(string)
+      string.gsub(/\e\[\d.*?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)
-      if text.length > length
+      uncolorized = uncolorize(text)
+      if uncolorized.length > length
+
         if ellipsize
-          text[0, length-3] + '...'
+          goal_length = length-3
         else
-          text[0, length]
+          goal_length = length
+        end
+
+        parts = text.scan(/(\e\[\d.*?m)|(.)/) #The idea here is to break the string up into control codes and single characters
+        #We're going to now count up until we hit goal length, but we're not going to ever count control codes against the count
+        #We're also going to keep track of if the last thing was a color code, so we know to reset if a color is "active"
+
+        #I can't think of a better way to do this, it's probably dumb
+        current_length = 0
+        current_index = 0
+        final_string_parts = []
+        color_active = false
+
+        while current_length < goal_length
+          color_code, regular_text = parts[current_index]
+          if not regular_text.nil?
+            current_length = current_length + 1
+            final_string_parts << regular_text
+          elsif not color_code.nil?
+            if color_code == "\e[0m"
+              color_active = false if color_active
+            else
+              color_active = true
+            end
+            final_string_parts << color_code
+          else
+            raise("Something very confusing happened")
+          end
+          current_index = current_index + 1
         end
+
+        final_string_parts << "..." if ellipsize
+        final_string_parts << "\e[0m" if color_active
+
+        final_string_parts.join("")
       else
         if justify == :right
-          (" "*(length-text.length)) + text
+          (" "*(length-uncolorized.length)) + text
         elsif justify == :center
-          space = length-text.length
+          space = length-uncolorized.length
           left_side = space/2
           right_side = space - left_side
           (" " * left_side) + text + (" "*right_side)
         else #assume left
-          text + (" "*(length-text.length))
+          text + (" "*(length-uncolorized.length))
         end
       end
     end
@@ -317,18 +328,11 @@ module ConsoleTable
       if to_print.is_a? String
         @out.print format(@working_width, normalize(to_print))
       elsif to_print.is_a? Hash
-        color = to_print[:color] || :default
-        background = to_print[:background] || :default
         text = normalize(to_print[:text]) || ""
         ellipsize = to_print[:ellipsize] || false
         justify = to_print[:justify] || :left
-        mode = to_print[:mode] || :default
 
-        formatted=format(@working_width, text, ellipsize, justify)
-        if text != :default or background != :default or mode != :default
-          formatted = formatted.colorize(:color => color, :background => background, :mode => mode)
-        end
-        @out.print formatted
+        @out.print format(@working_width, text, ellipsize, justify)
       end
 
       @out.print "|" if @borders

data/test/test_console_table.rb

@@ -1,5 +1,6 @@
 require 'minitest/autorun'
 require 'console_table'
+require 'colorize'
 
 class ConsoleTableTest < Minitest::Test
 
@@ -512,7 +513,7 @@ One                  Two
 
     ConsoleTable.define(table_config, :left_margin=>10, :right_margin=>7, :width=> 100, :title=>"Test Title", :borders=>true, :output=>@mock_out) do |table|
       (1..5).each do |row|
-        table << (1..4).collect{|i| "Row #{row}, Column #{i}"}
+        table << (1..4).collect{|i| "Row #{row}, Column #{i}".red}
       end
 
       table << "Plain line needs borders"
@@ -614,6 +615,48 @@ Row 5, Column 1      Row 5, Colu
     assert_output_equal expected, @mock_out.string
   end
 
+  def test_can_use_colors_without_affecting_layout
+    table_config = [
+        {:key=>:col1, :size=>10, :title=>"Column 1", :justify=>:left},
+        {:key=>:col2, :size=>10, :title=>"Column 2", :justify=>:center},
+        {:key=>:col3, :size=>10, :title=>"Column 3", :justify=>:right},
+    ]
+
+    ConsoleTable.define(table_config, :width=> 120, :output=>@mock_out) do |table|
+      table << ["Short".blue, "Short".bold, "Short".red.on_blue]
+
+      table << ["Much much longer".blue, "Much much longer".bold, "Much much longer".red.on_blue]
+
+      table << [
+          {:text=>"Much much longer".blue, :ellipsize=>true},
+          {:text=>"Much much longer".underline, :ellipsize=>true},
+          {:text=>"Much much longer".on_magenta, :ellipsize=>true}
+      ]
+
+      table << [
+          {:text=>"Much much longer".yellow, :ellipsize=>true},
+          {:text=>"Normal, should reset", :ellipsize=>true},
+          {:text=>"Much much longer".bold, :ellipsize=>true}
+      ]
+    end
+
+    expected=<<-END
+================================
+Column 1    Column 2    Column 3
+--------------------------------
+Short        Short         Short
+Much much  Much much  Much much
+Much mu... Much mu... Much mu...
+Much mu... Normal,... Much mu...
+================================
+    END
+
+    assert_includes @mock_out.string, "\e[1;39;49mShort\e[0m"  #Should have normal color codes
+    assert_includes @mock_out.string, "\e[0;33;49mMuch mu...\e[0m"  #the cut-off one should keep the color code for ellipses, then reset
+
+    assert_output_equal expected, @mock_out.string
+  end
+
   private
   def assert_output_equal(expected, actual)
     expected_lines = expected.split("\n")
@@ -621,7 +664,7 @@ Row 5, Column 1      Row 5, Colu
     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
+      assert_equal expected_line.uncolorize.rstrip, actual_line.uncolorize.rstrip
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: console_table
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Rod Hilton
@@ -73,7 +73,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements: