console_table 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ad359bbbe8957d51f799ac7761138ce6298c242
-  data.tar.gz: 33e4d6d67e2405a9915d7368b32d572e27f4575a
+  metadata.gz: 626c1c75fc83f5be630b35551e96d9bd318f41e5
+  data.tar.gz: c7b122ba03999438a6408ea10ac15c3c1dc7adc1
 SHA512:
-  metadata.gz: ca996310196d283a334171530e68b93922bff9bf2e4ac5bf2a00870a469f597ebcd8cd3cb9273e21c32add989513808df3e913270a28e3f4398eb00e1ca77414
-  data.tar.gz: 69d0c16af724898caa200b825b3ea4c0c2fd92fe1809b969649120002f59a662bac0c16c1857c777ebe84a34ca379902da00eda03335eda328976c41dcfae7ae
+  metadata.gz: a5711b3beebcd41a3e353d2a3e3b842316e2201320f52a92e69fab8ac95badda818eda8d475c0cbfd6c03e285b9d18d2f6c05cd71db12300fdb73bfc164c13b1
+  data.tar.gz: 1f4f0a647a7db4da4b4cbd9b691b6ef9d7d4a03cd58bec59e366fe5cf83f10a44dea6d183176da40438d818b07ff18b517550e2fd2fb995c3600b2a0f58ea64a

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+- 1.9.3
+deploy:
+  provider: rubygems
+  api_key:
+    secure: M1I+7IFuje77sZjtQbmvamzihT+NEJpCzb6Eco8AKbJu/swim+2DvojdJHJw3qpjBt+S2u6zPWWc8KqP6ME7YZzydhJKN/rftUow4lyPbJ6ut9wNg4J9EaZgawG/BOm7LESqtj6J5KWrEd2qRn86mLMHO6ZgLsvsKBWR+oMnb+U=
+  gem: console_table
+  on:
+    tags: true
+    repo: rodhilton/console_table

data/README.md

@@ -1,5 +1,7 @@
 # ConsoleTable
 
+[![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
 your data will fit, allows you to define table column sizes, and then just supply the ConsoleTable instance with data which will be
@@ -243,10 +245,137 @@ end
 
 Note the alternative method of calling `<<` where you can supply an Array instead of a hash, and ConsoleTable will infer from the array order which value goes in what column
 
+Here's a somewhat more practical example:
+
+```ruby
+require 'console_table'
+
+require 'json'
+require 'net/http'
+require 'open-uri'
+require 'colorize'
+
+symbols = ["YHOO", "AAPL", "GOOG", "MSFT", "C", "MMM", "KO", "WMT", "GM", "IBM", "MCD", "VZ", "HD", "DIS", "INTC"]
+
+params = symbols.collect{|s| "\"#{s}\"" }.join(",")
+url = "http://query.yahooapis.com/v1/public/yql?q=select * from yahoo.finance.quotes where symbol in (#{params})&env=http://datatables.org/alltables.env&format=json"
+uri = URI.parse(URI::encode(url))
+response = Net::HTTP.get_response(uri)
+json = JSON.parse(response.body)
+
+table_config = [
+	{:key=>:symbol, :title=>"Symbol", :size=>6},
+	{:key=>:name, :title=>"Name", :size=>17},
+	{:key=>:price, :title=>"Price", :size=>5, :justify=>:right},
+	{:key=>:change, :title=>"Change", :size=>7, :justify=>:right},
+	{:key=>:recommendation, :title=>"Recommendation", :size=>15, :justify=>:right}
+]
+
+ConsoleTable.define(table_config, :title=>"Stock Prices") do |table|
+
+	json["query"]["results"]["quote"].each do |j|
+		change = j["ChangeRealtime"]
+		if change.start_with?("+")
+			change = change.green
+		else
+			change = change.red
+		end
+
+		recommendation = (rand() <= 0.5) ? "BUY!".white.on_green.bold.underline : "Sell".yellow
+
+		table << [
+			j["Symbol"].magenta,
+			j["Name"],
+			j["LastTradePriceOnly"],
+			change,
+			recommendation
+		]
+
+	end
+
+	table.footer << "Recommendations randomly generated"
+
+end
+```
+
+And the output:
+
+```
+======================================================
+                     Stock Prices
+Symbol Name              Price  Change  Recommendation
+------------------------------------------------------
+YHOO   Yahoo! Inc.       44.42  +0.495            Sell
+AAPL   Apple Inc.        127.0   +0.62            BUY!
+GOOG   Google Inc.       549.0   +6.08            BUY!
+MSFT   Microsoft Corpora 43.87   +0.78            Sell
+C      Citigroup, Inc. C 51.20   +0.31            BUY!
+MMM    3M Company Common 165.9   +0.03            Sell
+KO     Coca-Cola Company 41.99   -0.18            BUY!
+WMT    Wal-Mart Stores,  85.81   -0.08            Sell
+GM     General Motors Co 37.62   -0.40            BUY!
+IBM    International Bus 160.4   +1.88            BUY!
+MCD    MCDONALD'S CORPOR 95.65   +0.56            BUY!
+VZ     Verizon Communica 49.31   -0.21            BUY!
+HD     Home Depot, Inc.  111.8   -0.27            BUY!
+DIS    Walt Disney Compa 104.1   +0.59            BUY!
+INTC   Intel Corporation 34.36  +0.235            Sell
+------------------------------------------------------
+                    Recommendations randomly generated
+======================================================
+```
+
+And yes, you can make the table super-ugly and lame if you want by adding `:borders=>true` to the define call, like so:
+
+`ConsoleTable.define(table_config, :title=>"Stock Prices", :borders=>true) do |table|`
+
+Which will yield this, if you're into that sort of thing:
+
+```
+*======================================================*
+|                     Stock Prices                     |
++------+-----------------+-----+-------+---------------+
+|Symbol|Name             |Price| Change| Recommendation|
++------+-----------------+-----+-------+---------------+
+|YHOO  |Yahoo! Inc.      |44.42| +0.495|           BUY!|
++------+-----------------+-----+-------+---------------+
+|AAPL  |Apple Inc.       |127.0|  +0.62|           BUY!|
++------+-----------------+-----+-------+---------------+
+|GOOG  |Google Inc.      |549.0|  +6.08|           Sell|
++------+-----------------+-----+-------+---------------+
+|MSFT  |Microsoft Corpora|43.87|  +0.78|           Sell|
++------+-----------------+-----+-------+---------------+
+|C     |Citigroup, Inc. C|51.20|  +0.31|           Sell|
++------+-----------------+-----+-------+---------------+
+|MMM   |3M Company Common|165.9|  +0.03|           BUY!|
++------+-----------------+-----+-------+---------------+
+|KO    |Coca-Cola Company|41.99|  -0.18|           Sell|
++------+-----------------+-----+-------+---------------+
+|WMT   |Wal-Mart Stores, |85.81|  -0.08|           BUY!|
++------+-----------------+-----+-------+---------------+
+|GM    |General Motors Co|37.62|  -0.40|           BUY!|
++------+-----------------+-----+-------+---------------+
+|IBM   |International Bus|160.4|  +1.88|           BUY!|
++------+-----------------+-----+-------+---------------+
+|MCD   |MCDONALD'S CORPOR|95.65|  +0.56|           Sell|
++------+-----------------+-----+-------+---------------+
+|VZ    |Verizon Communica|49.31|  -0.21|           BUY!|
++------+-----------------+-----+-------+---------------+
+|HD    |Home Depot, Inc. |111.8|  -0.27|           BUY!|
++------+-----------------+-----+-------+---------------+
+|DIS   |Walt Disney Compa|104.1|  +0.59|           BUY!|
++------+-----------------+-----+-------+---------------+
+|INTC  |Intel Corporation|34.36| +0.235|           Sell|
++------+-----------------+-----+-------+---------------+
+|                    Recommendations randomly generated|
+*======================================================*
+```
+
+
 ## Contributing
 
 1. Fork it ( http://github.com/rodhilton/console_table/fork )
 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
+5. Create new Pull Request

data/console_table.gemspec

@@ -19,7 +19,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.5"
   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'
 

data/lib/console_table.rb

@@ -1,7 +1,5 @@
-require 'terminfo'
-
 module ConsoleTable
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 
   def self.define(layout, options={}, &block)
     table = ConsoleTableClass.new(layout, options)
@@ -11,7 +9,6 @@ module ConsoleTable
   end
 
   class ConsoleTableClass
-
     attr_reader :footer
 
     def <<(options)
@@ -21,13 +18,29 @@ module ConsoleTable
     protected
 
     def initialize(column_layout, options={})
-      @original_column_layout = column_layout
-      @left_margin = options[:left_margin] || 0
-      @right_margin = options[:right_margin] || 0
+      @original_column_layout = []
+      column_layout.each_with_index do |layout, i|
+        if layout.is_a? String
+          @original_column_layout << {:key => "col#{i+1}".to_sym, :title=>layout, :size=>"*"}
+        elsif layout[:key].nil? and layout[:title].nil?
+          @original_column_layout << layout.merge({:key => "col#{i+1}".to_sym, :title=>"Column #{i+1}"})
+        elsif layout[:title].nil?
+          @original_column_layout << layout.merge({:title => layout[:key].to_s.capitalize})
+        elsif layout[:key].nil?
+          @original_column_layout << layout.merge({:key => "col#{i+1}".to_sym})
+        else
+          @original_column_layout << layout
+        end
+      end
+
+      #Mostly used for mocking/testing
       @out = options[:output] || $stdout
-      @title = options[:title]
       @set_width = options[:width]
+
+      @title = options[:title]
       @borders = options[:borders] || false #Lines between every cell, implies outline
+      @left_margin = options[:left_margin] || 0
+      @right_margin = options[:right_margin] || 0
 
       #Set outline, just the upper and lower lines
       if @borders
@@ -39,7 +52,6 @@ module ConsoleTable
       end
 
       @footer = []
-
       @headings_printed = false
       @count = 0
 
@@ -48,6 +60,8 @@ module ConsoleTable
     end
 
     def print_header()
+      #Kind of weird but basically if there's a title, there will be a space between the top border and the actual data, meaning we don't
+      #want special characters printed for the "joining" of the lines.  If there's no title, however, we do.
       if @title.nil?
         print_line("=", "*", false)
       else
@@ -66,6 +80,7 @@ module ConsoleTable
 
     def print_headings()
       @headings_printed = true
+
       @out.print " "*@left_margin
       if @borders
         @out.print "|"
@@ -73,8 +88,9 @@ module ConsoleTable
 
       @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)
+        ellipsize = column[:ellipsize] || false
+        title = column[:title].strip
+        @out.print format(column[:size], title, ellipsize, justify)
 
         if @borders
           @out.print "|"
@@ -84,7 +100,7 @@ module ConsoleTable
       end
       @out.print "\n"
 
-      print_line unless @borders #this line will be printed when the NEXT LINE prints out if borders are on
+      print_line unless @borders #this line will be printed when the NEXT LINE of actual data prints out if borders are on, because that call PRE-prints the separator line
     end
 
     def print_line(char="-", join_char="+", edge_join_only=false)
@@ -107,6 +123,8 @@ 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
@@ -220,9 +238,7 @@ module ConsoleTable
       if string.nil?
         nil
       else
-        require 'pp'
         normalized = string.to_s
-
         normalized = normalized.sub(/^(\e\[\d[^m]*?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]*?m)$/, '\2\1')
         normalized = normalized.gsub(/\s+/, " ").strip #Primarily to remove any tabs or newlines
@@ -235,12 +251,15 @@ module ConsoleTable
 
       total_width = @set_width
       begin
+        require 'terminfo'
         total_width = TermInfo.screen_columns
       rescue => ex
         total_width = ENV["COLUMNS"].to_i || 79
       end if total_width.nil?
 
-      keys = @original_column_layout.reject { |d| d[:key].nil? }.collect { |d| d[:key] }.uniq
+      working_column_layout = []
+
+      keys = @original_column_layout.collect { |d| d[:key] }.uniq
       if keys.length < @original_column_layout.length
         raise("ConsoleTable configuration invalid, same key defined more than once")
       end
@@ -300,7 +319,7 @@ module ConsoleTable
 
         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"
+        #We're also going to keep track of if a non-resetting control code is 'active', so we know to reset at the end if need-be
 
         #I can't think of a better way to do this, it's probably dumb
         current_length = 0
@@ -331,15 +350,15 @@ module ConsoleTable
 
         final_string_parts.join("")
       else
+        space = length-uncolorized.length
         if justify == :right
-          (" "*(length-uncolorized.length)) + text
+          (" "*space) + text
         elsif justify == :center
-          space = length-uncolorized.length
           left_side = space/2
           right_side = space - left_side
           (" " * left_side) + text + (" "*right_side)
         else #assume left
-          text + (" "*(length-uncolorized.length))
+          text + (" "*space)
         end
       end
     end

data/test/test_console_table.rb

@@ -1,13 +1,12 @@
+# encoding: utf-8
 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
 
+  require 'console_table'
+  require 'colorize'
+
   def setup
     @mock_out = StringIO.new
   end
@@ -960,6 +959,74 @@ Much mu... Normal,... Much mu...
     assert_output_equal expected, @mock_out.string
   end
 
+  def test_will_generate_default_column_keys_and_titles_and_sizes_if_not_provided
+    table_config = [
+        {:size=>20, :title=>"Column 1"},
+        {:key=>:col2, :size=>20, :title=>"Column 2"},
+        {:size=>20, :title=>"Column 3"},
+        {:key=>:col4, :size=>20},
+        {:size=>20},
+        {}
+    ]
+
+    ConsoleTable.define(table_config, :width=> 125, :output=>@mock_out) do |table|
+      table << ["A", "B", "C", "D", "E", "F"]
+
+    end
+
+    expected=<<-END
+=============================================================================================================================
+Column 1             Column 2             Column 3             Col4                 Column 5             Column 6
+-----------------------------------------------------------------------------------------------------------------------------
+A                    B                    C                    D                    E                    F
+=============================================================================================================================
+    END
+
+    assert_output_equal expected, @mock_out.string
+  end
+
+  def test_can_use_a_string_instead_of_hash_to_default_everything
+    table_config = [
+        {:size=>20, :title=>"Column 1"},
+        "Simple Column",
+        {:size=>20, :title=>"Column 3"},
+    ]
+
+    ConsoleTable.define(table_config, :width=> 70, :output=>@mock_out) do |table|
+      table << ["A", "B", "C"]
+    end
+
+    expected=<<-END
+======================================================================
+Column 1             Simple Column                Column 3
+----------------------------------------------------------------------
+A                    B                            C
+======================================================================
+    END
+
+    assert_output_equal expected, @mock_out.string
+  end
+
+  def test_can_use_a_config_of_nothing_but_titles_if_you_really_want
+    table_config = [
+        "A Column", "B Column", "C Column"
+    ]
+
+    ConsoleTable.define(table_config, :width=> 30, :output=>@mock_out) do |table|
+      table << ["A", "B", "C"]
+    end
+
+    expected=<<-END
+=============================
+A Column  B Column  C Column
+-----------------------------
+A         B         C
+=============================
+    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.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Rod Hilton
@@ -38,20 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
-- !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: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -104,6 +90,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md