console_table 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e1105b617581e5b593f42b5227546ec90e7ceb6f
-  data.tar.gz: 9b720ddaeef699a8d57c00bd8bfecd69b8b5ee2b
+  metadata.gz: 62dec8c67df25306a62e7c1ccaa8341a5ca603f0
+  data.tar.gz: 7592bb485b9e110eab9395df2da50063625cad73
 SHA512:
-  metadata.gz: cf00120d77b9255bf7b2f9cd87ec5362ec6d88942034068a60c110d9d3f59f4bf5222b4e7155dc660327f87fa6a934091067de62adc32d9e6464699b3cadcacd
-  data.tar.gz: 996efe76eb5e2c28c5f78faa34e45ed596ae14d633800570bb87a2b3a6e344050b7922787db8a8597a779c052daa725df346d28abf9f3f29e2ef8fc939ff55b8
+  metadata.gz: 3331fee285ff870bcdd5e7ac8e44f7cb75a1b943a6ef2cbe656078a0ba44ea31bbad0c87c6e724dcad6a22ffd0788816bc789c031e5958dd5aaa3369d83d7f48
+  data.tar.gz: 4738d8b0d88d6764df4e5e32e0314fa2829a0a79cfbb5df9fdc0367efa64d3a00e69fc9ed9ff37ab013dbff42337212a2805f8c074901203f6f26ba82b63f93d

data/lib/console_table.rb

@@ -2,7 +2,7 @@ require 'colorize'
 require 'terminfo'
 
 module ConsoleTable
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 
   def self.define(layout, options={}, &block)
     table = ConsoleTableClass.new(layout, options)
@@ -28,6 +28,16 @@ module ConsoleTable
       @out = options[:output] || $stdout
       @title = options[:title]
       @set_width = options[:width]
+      @borders = options[:borders] || false #Lines between every cell, implies outline
+
+      #Set outline, just the upper and lower lines
+      if @borders
+        @outline = true
+      elsif not options[:outline].nil?
+        @outline = options[:outline]
+      else
+        @outline = true
+      end
 
       @footer = []
 
@@ -39,67 +49,105 @@ module ConsoleTable
     end
 
     def print_header()
-      @out.print " " * @left_margin
-      @out.print "=" * @working_width
-      @out.print "\n"
+      if @title.nil?
+        print_line("=", "*", false)
+      else
+        print_line("=", "*", true)
+      end if @outline
 
       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 "|" if @borders
         @out.print "\n"
+        print_line if @borders
       end
     end
 
     def print_headings()
       @headings_printed = true
       @out.print " "*@left_margin
+      if @borders
+        @out.print "|"
+      end
 
       @column_widths.each_with_index do |column, i|
         justify = column[:justify] || :left
         title = (column[:title] || column[:key].to_s.capitalize).strip
         @out.print format(column[:size], title, false, justify)
-        @out.print " " if i < @column_widths.size-1
+
+        if @borders
+          @out.print "|"
+        else
+          @out.print " " if i < @column_widths.size-1
+        end
       end
       @out.print "\n"
 
-      @out.print " " * @left_margin
-      @out.print "-" * @working_width
-      @out.print "\n"
+      print_line unless @borders #this line will be printed when the NEXT LINE prints out if borders are on
     end
 
-    def print_footer()
-      footer_lines = []
-      @footer.each do |line|
-        lines = line.split("\n")
-        lines.each do |l|
-          footer_lines << l.strip unless l.nil? or l.uncolorize.strip == ""
+    def print_line(char="-", join_char="+", edge_join_only=false)
+      if @borders #use +'s to join columns
+        @out.print " " * @left_margin
+        @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)
+            @out.print char
+          else
+            @out.print join_char
+          end
         end
+        @out.print "\n"
+      else #just print long lines
+        @out.print " " * @left_margin
+        @out.print "#{char}" * (@working_width + (@borders ? 2 : 0))
+        @out.print "\n"
       end
+    end
 
-      should_print_footer = footer_lines.length > 0 && footer_lines.any? { |l| l.uncolorize.length <= @working_width }
-
+    def print_footer()
       if should_print_footer
-        @out.print " " * @left_margin
-        @out.print "-" * @working_width
-        @out.print "\n"
+        print_line
       end
 
       footer_lines.each do |line|
         if line.uncolorize.length <= @working_width
           @out.print " " * @left_margin
+          @out.print "|" if @borders
           @out.print " " * (@working_width - line.uncolorize.length)
           @out.print line
+          @out.print "|" if @borders
           @out.print "\n"
         end
       end
 
-      @out.print " " * @left_margin
-      @out.print "=" * @working_width
-      @out.print "\n"
+      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| l.uncolorize.length <= @working_width }
+    end
+
+    def footer_lines
+      footer_lines = []
+      @footer.each do |line|
+        lines = line.split("\n")
+        lines.each do |l|
+          footer_lines << l.strip unless l.nil? or l.uncolorize.strip == ""
+        end
+      end
+      footer_lines
     end
 
     def print(options)
@@ -120,7 +168,12 @@ module ConsoleTable
         options = munged_options
       end
 
+      print_line if @borders
+
       @out.print " "*@left_margin
+      if @borders
+        @out.print "|"
+      end
       #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]] || ""
@@ -163,7 +216,11 @@ module ConsoleTable
           @out.print format(column[:size], normalize(to_print.to_s))
         end
 
-        @out.print " " if i < @column_widths.size-1
+        if @borders
+          @out.print "|"
+        else
+          @out.print " " if i < @column_widths.size-1
+        end
       end
       @out.print "\n"
 
@@ -194,6 +251,7 @@ module ConsoleTable
       end
 
       num_spacers = @original_column_layout.length - 1
+      num_spacers = num_spacers + 2 if @borders
       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
@@ -251,7 +309,10 @@ module ConsoleTable
     end
 
     def print_plain(to_print)
+      print_line if @borders
+
       @out.print " "*@left_margin
+      @out.print "|" if @borders
 
       if to_print.is_a? String
         @out.print format(@working_width, normalize(to_print))
@@ -270,6 +331,7 @@ module ConsoleTable
         @out.print formatted
       end
 
+      @out.print "|" if @borders
       @out.print "\n"
     end
   end

data/test/test_console_table.rb

@@ -470,13 +470,146 @@ Short1                      Short2                      Short3
 
     expected=<<-END
 =========================================
+This is just a string, it should ignore c
+=========================================
+    END
+
+    assert_output_equal expected, @mock_out.string
+  end
+
+  def test_printing_a_single_after_data_makes_headings_show_up
+    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 << ["One", "Two"]
+      table << "This is just a string, it should ignore columns"
+      table << ["One", "Two"]
+    end
+
+    expected=<<-END
+=========================================
 Column 1             Column 2
 -----------------------------------------
+One                  Two
 This is just a string, it should ignore c
+One                  Two
 =========================================
     END
 
-    puts @mock_out.string
+    assert_output_equal expected, @mock_out.string
+  end
+
+  def test_can_have_a_bordered_table
+    table_config = [
+        {:key=>:col1, :size=>20, :title=>"Column 1"},
+        {:key=>:col2, :size=>0.3, :title=>"Column 2"},
+        {:key=>:col3, :size=>10, :title=>"Column 3", :justify=>:center},
+        {:key=>:col4, :size=>"*", :title=>"Column 4", :justify=>:center}
+    ]
+
+    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}"}
+      end
+
+      table << "Plain line needs borders"
+      table.footer << "Footer needs borders"
+      table.footer << "Footer still \n needs borders"
+
+    end
+
+    expected=<<-END
+          *================================================================================*
+          |                                   Test Title                                   |
+          +--------------------+--------------+----------+---------------------------------+
+          |Column 1            |Column 2      | Column 3 |            Column 4             |
+          +--------------------+--------------+----------+---------------------------------+
+          |Row 1, Column 1     |Row 1, Column |Row 1, Col|         Row 1, Column 4         |
+          +--------------------+--------------+----------+---------------------------------+
+          |Row 2, Column 1     |Row 2, Column |Row 2, Col|         Row 2, Column 4         |
+          +--------------------+--------------+----------+---------------------------------+
+          |Row 3, Column 1     |Row 3, Column |Row 3, Col|         Row 3, Column 4         |
+          +--------------------+--------------+----------+---------------------------------+
+          |Row 4, Column 1     |Row 4, Column |Row 4, Col|         Row 4, Column 4         |
+          +--------------------+--------------+----------+---------------------------------+
+          |Row 5, Column 1     |Row 5, Column |Row 5, Col|         Row 5, Column 4         |
+          +--------------------+--------------+----------+---------------------------------+
+          |Plain line needs borders                                                        |
+          +--------------------+--------------+----------+---------------------------------+
+          |                                                            Footer needs borders|
+          |                                                                    Footer still|
+          |                                                                   needs borders|
+          *================================================================================*
+    END
+
+    assert_output_equal expected, @mock_out.string
+  end
+
+  def test_outline_joins_only_when_no_footer_or_header
+    table_config = [
+        {:key=>:col1, :size=>20, :title=>"Column 1"},
+        {:key=>:col2, :size=>0.3, :title=>"Column 2"},
+        {:key=>:col3, :size=>10, :title=>"Column 3", :justify=>:center},
+        {:key=>:col4, :size=>"*", :title=>"Column 4", :justify=>:center}
+    ]
+
+    #borders are true, so outline false should be ignored
+    ConsoleTable.define(table_config, :left_margin=>10, :right_margin=>7, :width=> 100, :borders=>true, :outline=>false, :output=>@mock_out) do |table|
+      (1..5).each do |row|
+        table << (1..4).collect{|i| "Row #{row}, Column #{i}"}
+      end
+
+      table << "Plain line needs borders"
+
+    end
+
+    expected=<<-END
+          *====================*==============*==========*=================================*
+          |Column 1            |Column 2      | Column 3 |            Column 4             |
+          +--------------------+--------------+----------+---------------------------------+
+          |Row 1, Column 1     |Row 1, Column |Row 1, Col|         Row 1, Column 4         |
+          +--------------------+--------------+----------+---------------------------------+
+          |Row 2, Column 1     |Row 2, Column |Row 2, Col|         Row 2, Column 4         |
+          +--------------------+--------------+----------+---------------------------------+
+          |Row 3, Column 1     |Row 3, Column |Row 3, Col|         Row 3, Column 4         |
+          +--------------------+--------------+----------+---------------------------------+
+          |Row 4, Column 1     |Row 4, Column |Row 4, Col|         Row 4, Column 4         |
+          +--------------------+--------------+----------+---------------------------------+
+          |Row 5, Column 1     |Row 5, Column |Row 5, Col|         Row 5, Column 4         |
+          +--------------------+--------------+----------+---------------------------------+
+          |Plain line needs borders                                                        |
+          *====================*==============*==========*=================================*
+    END
+
+    assert_output_equal expected, @mock_out.string
+  end
+
+  def test_can_have_no_outline_if_requested
+    table_config = [
+        {:key=>:col1, :size=>20, :title=>"Column 1"},
+        {:key=>:col2, :size=>0.3, :title=>"Column 2"},
+    ]
+
+    ConsoleTable.define(table_config, :width=>60, :outline=>false, :title=>"Still has a title", :output=>@mock_out) do |table|
+      (1..5).each do |row|
+        table << (1..2).collect{|i| "Row #{row}, Column #{i}"}
+      end
+
+    end
+
+    expected=<<-END
+       Still has a title
+Column 1             Column 2
+--------------------------------
+Row 1, Column 1      Row 1, Colu
+Row 2, Column 1      Row 2, Colu
+Row 3, Column 1      Row 3, Colu
+Row 4, Column 1      Row 4, Colu
+Row 5, Column 1      Row 5, Colu
+    END
 
     assert_output_equal expected, @mock_out.string
   end

data/todo.txt

@@ -1,3 +1 @@
-: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
-note the dangerousness of this with the current impl - Total width available is always the screen width, so if you make a table with 2 20 char columns and set a border, where does the final | go? it should go at the end of the 40ish character, but it'd go at the end of the line I think. might not even want to bite this off
+better handling of colors. should you be able to supply colored strings and the spacing is smart enough to ignore control characters?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: console_table
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Rod Hilton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-12 00:00:00.000000000 Z
+date: 2015-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler