command_line_reporter 3.2.1 → 3.3.0

data/spec/table_spec.rb

@@ -1,5 +1,4 @@
 require 'spec_helper'
-require 'table'
 
 describe CommandLineReporter::Table do
   context 'creation' do
@@ -10,11 +9,19 @@ describe CommandLineReporter::Table do
     end
 
     it 'defaults the border' do
-      CommandLineReporter::Table.new.border.should be_false
+      expect(CommandLineReporter::Table.new.border).to be_false
     end
 
     it 'accepts the border' do
-      CommandLineReporter::Table.new(:border => true).border.should == true
+      expect(CommandLineReporter::Table.new(:border => true).border).to eq(true)
+    end
+
+    it 'output encoding should be ascii' do
+      expect(CommandLineReporter::Table.new(:encoding => :ascii).encoding).to eq(:ascii)
+    end
+
+    it 'output encoding should be unicode' do
+      expect(CommandLineReporter::Table.new.encoding).to eq(:unicode)
     end
   end
 
@@ -55,24 +62,24 @@ describe CommandLineReporter::Table do
       it 'positional attributes' do
         [:align, :width, :size, :padding].each do |m|
           4.times do |i|
-            @table.rows[1].columns[i].send(m).should == @table.rows[0].columns[i].send(m)
+            expect(@table.rows[1].columns[i].send(m)).to eq(@table.rows[0].columns[i].send(m))
           end
         end
       end
 
       context 'no header row' do
         it 'color' do
-          @table.rows[1].columns[0].color.should == 'red'
-          @table.rows[1].columns[1].color.should == 'purple'
-          @table.rows[1].columns[2].color.should == 'blue'
-          @table.rows[1].columns[3].color.should == 'red'
+          expect(@table.rows[1].columns[0].color).to eq('red')
+          expect(@table.rows[1].columns[1].color).to eq('purple')
+          expect(@table.rows[1].columns[2].color).to eq('blue')
+          expect(@table.rows[1].columns[3].color).to eq('red')
         end
 
         it 'bold' do
-          @table.rows[1].columns[0].bold.should be_false
-          @table.rows[1].columns[1].bold.should be_false
-          @table.rows[1].columns[2].bold.should be_false
-          @table.rows[1].columns[3].bold.should be_true
+          expect(@table.rows[1].columns[0].bold).to be_false
+          expect(@table.rows[1].columns[1].bold).to be_false
+          expect(@table.rows[1].columns[2].bold).to be_false
+          expect(@table.rows[1].columns[3].bold).to be_true
         end
       end
 
@@ -88,12 +95,43 @@ describe CommandLineReporter::Table do
         end
 
         it 'bold' do
-          @table.rows[1].columns[0].bold.should be_false
-          @table.rows[1].columns[1].bold.should be_false
-          @table.rows[1].columns[2].bold.should be_false
-          @table.rows[1].columns[3].bold.should be_true
+          expect(@table.rows[1].columns[0].bold).to be_false
+          expect(@table.rows[1].columns[1].bold).to be_false
+          expect(@table.rows[1].columns[2].bold).to be_false
+          expect(@table.rows[1].columns[3].bold).to be_true
         end
       end
     end
   end
+
+  describe '#auto_adjust_widths' do
+    it 'sets the widths of each column in each row to the maximum required width for that column' do
+      table = CommandLineReporter::Table.new.tap do |t|
+        t.add(
+          CommandLineReporter::Row.new.tap do |r|
+            r.add CommandLineReporter::Column.new('medium length')
+            r.add CommandLineReporter::Column.new('i am pretty long') # longest column
+            r.add CommandLineReporter::Column.new('short', :padding => 100)
+          end
+        )
+
+        t.add(
+          CommandLineReporter::Row.new.tap do |r|
+            r.add CommandLineReporter::Column.new('longer than medium length') # longest column
+            r.add CommandLineReporter::Column.new('shorter')
+            r.add CommandLineReporter::Column.new('longer than short') # longest column (inherits padding)
+          end
+        )
+      end
+
+      table.auto_adjust_widths
+
+      table.rows.each do |row|
+        expect(row.columns[0].width).to eq(CommandLineReporter::Column.new('longer than medium length').required_width)
+        expect(row.columns[1].width).to eq(CommandLineReporter::Column.new('i am pretty long').required_width)
+        expect(row.columns[2].width).to eq(CommandLineReporter::Column.new('longer than short', :padding => 100).required_width)
+      end
+    end
+  end
+
 end

metadata

@@ -1,64 +1,64 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: command_line_reporter
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 3.3.0
   prerelease: 
-  version: 3.2.1
 platform: ruby
-authors: 
+authors:
 - Wes
 - Bailey
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-02-27 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2014-02-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
   name: colored
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "1.2"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.2'
   type: :runtime
   prerelease: false
-  version_requirements: *id002
-description: This gem makes it easy to provide a report while your ruby script is executing
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: This gem makes it easy to provide a report while your ruby script is
+  executing
 email: baywes@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- examples/capture.rb
-- examples/nested.rb
-- examples/progress.rb
-- examples/quiet.rb
-- examples/simple.rb
-- examples/table.rb
-- examples/variable.rb
-- lib/column.rb
+files:
+- lib/command_line_reporter/column.rb
+- lib/command_line_reporter/formatter/nested.rb
+- lib/command_line_reporter/formatter/progress.rb
+- lib/command_line_reporter/options_validator.rb
+- lib/command_line_reporter/row.rb
+- lib/command_line_reporter/table.rb
+- lib/command_line_reporter/version.rb
 - lib/command_line_reporter.rb
-- lib/nested_formatter.rb
-- lib/options_validator.rb
-- lib/progress_formatter.rb
-- lib/row.rb
-- lib/table.rb
-- lib/version.rb
 - README.md
 - spec/column_spec.rb
 - spec/command_line_reporter_spec.rb
@@ -72,35 +72,32 @@ files:
 - spec/table_spec.rb
 homepage: http://github.com/wbailey/command_line_reporter
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: -637477018686189691
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: -3116512959293506911
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: A tool for providing interactive command line applications
-test_files: 
+test_files:
 - spec/column_spec.rb
 - spec/command_line_reporter_spec.rb
 - spec/nested_formatter_spec.rb

data/examples/capture.rb

@@ -1,32 +0,0 @@
-require 'command_line_reporter'
-
-class Example
-  include CommandLineReporter
-
-  def run
-    suppress_output
-
-    table :border => true do
-      row :color => 'red' do
-        column 'MY NAME IS REALLY LONG AND WILL WRAP AND HOPE', :width => 20, :align => 'center', :color => 'blue'
-        column 'ADDRESS', :width => 30, :padding => 5
-        column 'CITY', :width => 15
-      end
-      row :color => 'green', :bold => true do
-        column 'caeser'
-        column '1 Appian Way'
-        column 'Rome'
-      end
-      row do
-        column 'Richard Feynman'
-        column '1 Golden Gate'
-        column 'Quantum Field'
-      end
-    end
-
-    return capture_output
-  end
-end
-
-# All the content is now in the report variable
-report = Example.new.run

data/examples/nested.rb

@@ -1,38 +0,0 @@
-require 'command_line_reporter'
-
-class Example
-  include CommandLineReporter
-
-  def initialize
-    self.formatter = 'nested'
-    self.formatter.complete_string = 'done'
-  end
-
-  def run
-    x,y,z = 0,0,0
-
-    report(:message => 'calculating first expression') do
-      x = 2 + 2
-      sleep 1
-
-      2.times do
-        report(:message => 'calculating second expression') do
-          y = 10 - x
-          sleep 1
-
-          10.times do |i|
-            report(:message => 'pixelizing', :type => 'inline', :complete => "#{i*10+10}%") do
-              z = x + y
-              sleep 1
-            end
-          end
-        end
-      end
-    end
-
-    horizontal_rule(:width => 20)
-    %w(x y z).each {|v| aligned "#{v}: #{eval v}"}
-  end
-end
-
-Example.new.run

data/examples/progress.rb

@@ -1,68 +0,0 @@
-require 'command_line_reporter'
-
-class Example
-  include CommandLineReporter
-
-  NYAN_CHARS = "****[;::;<](^-^)"
-
-  def initialize
-    self.formatter = 'progress'
-  end
-
-  def run
-    x = 0
-
-    report do
-      10.times do
-        x += 1
-        sleep 0.1
-        # formatter.progress
-        progress
-
-        10.times do
-          x += 1
-          sleep 0.1
-          # formatter.progress
-          progress
-        end
-      end
-    end
-
-    y = 0
-
-    report do
-      10.times do
-        y += 1
-        sleep 0.1
-        progress("#{y*10}%")
-      end
-    end
-
-    report do
-      3.times do
-        progress("\\")
-        sleep 0.1
-        progress("/")
-        sleep 0.1
-        progress("-")
-        sleep 0.1
-      end
-    end
-
-    report(:color => 'red') do
-      100.times do
-        progress(erase_chars + NYAN_CHARS)
-        sleep 0.1
-      end
-    end
-
-    aligned "x: #{x}"
-    aligned "y: #{y}"
-  end
-
-  def erase_chars
-    "\10" * NYAN_CHARS.size + " "
-  end
-end
-
-Example.new.run

data/examples/quiet.rb

@@ -1,40 +0,0 @@
-require 'command_line_reporter'
-require 'ostruct'
-require 'optparse'
-
-class Example
-  include CommandLineReporter
-
-  def initialize
-    self.formatter = 'progress'
-  end
-
-  def run(options = {})
-    x = 0
-
-    suppress_output if options.quiet
-
-    report do
-      10.times do
-        x += 1
-        sleep 0.1
-        progress
-      end
-    end
-
-    restore_output if options.quiet
-  end
-end
-
-
-options = OpenStruct.new({:quiet => false})
-
-OptionParser.new do |opts|
-  opts.banner = "Usage: ruby -I lib example/quiet.rb [-q|--quiet]"
-
-  opts.on('-q', '--quiet', 'do not print any output') do
-    options.quiet = true
-  end
-end.parse!
-
-Example.new.run(options)

data/examples/simple.rb

@@ -1,23 +0,0 @@
-require 'command_line_reporter'
-
-include CommandLineReporter
-
-class Example
-  def initialize
-    self.formatter = 'progress'
-  end
-
-  def run
-    report do
-      sum = 0
-      10.times do
-        sum += 10
-        progress
-      end
-      vertical_spacing
-      aligned("Sum: #{sum}")
-    end
-  end
-end
-
-Example.new.run

data/examples/table.rb

@@ -1,71 +0,0 @@
-# recoil  <co>mmand_<li>ne_<re>porter
-require 'command_line_reporter'
-
-class Example
-  include CommandLineReporter
-
-  def run
-    header(:title => 'TABLE EXAMPLES - Borders, Wrapping, Alignment and Padding', :align => 'center', :width => 70)
-
-    2.times do |j|
-      header :title => "Table #{j}", :align => 'center', :width => 65
-
-      table :border => j % 2 == 0  do
-        3.times do
-          row do
-            i = 0
-            3.times do
-              i += 10
-              column 'x' * (0 + rand(50)), :align => %w[left right center][rand(3)], :width => i, :padding => rand(5) 
-            end
-          end
-        end
-      end
-
-      vertical_spacing 2
-    end
-
-    header :title => 'An example of a table with a header row.  The color and border properties are not inherited'
-
-    table :border => true do
-      row :header => true, :color => 'red'  do
-        column 'MY NAME IS REALLY LONG AND WILL WRAP AND HOPE', :width => 20, :align => 'center', :color => 'blue'
-        column 'ADDRESS', :width => 30, :padding => 5
-        column 'CITY', :width => 15
-      end
-      row :color => 'green', :bold => true do
-        column 'caeser'
-        column '1 Appian Way'
-        column 'Rome'
-      end
-      row do
-        column 'Richard Feynman'
-        column '1 Golden Gate'
-        column 'Quantum Field'
-      end
-    end
-
-    vertical_spacing 2
-    header :title => 'The same table with the properties inherited from the first row'
-
-    table :border => true do
-      row :color => 'red' do
-        column 'MY NAME IS REALLY LONG AND WILL WRAP AND HOPE', :width => 20, :align => 'center', :color => 'blue'
-        column 'ADDRESS', :width => 30, :padding => 5
-        column 'CITY', :width => 15
-      end
-      row :color => 'green', :bold => true do
-        column 'caeser'
-        column '1 Appian Way'
-        column 'Rome'
-      end
-      row do
-        column 'Richard Feynman'
-        column '1 Golden Gate'
-        column 'Quantum Field'
-      end
-    end
-  end
-end
-
-Example.new.run

data/examples/variable.rb

@@ -1,30 +0,0 @@
-require 'command_line_reporter'
-
-include CommandLineReporter
-
-class Example
-  def initialize
-    self.formatter = 'progress'
-  end
-
-  def run
-    suppress_output 
-
-    report do
-      sum = 0
-      10.times do
-        sum += 10
-        progress
-      end
-      vertical_spacing
-      aligned("Sum: #{sum}")
-    end
-
-    capture_output
-  end
-end
-
-out = Example.new.run
-
-puts 'this could be stored in a database'
-puts out

data/lib/table.rb

@@ -1,96 +0,0 @@
-require 'row'
-require 'options_validator'
-
-module CommandLineReporter
-  class Table
-    include OptionsValidator
-
-    VALID_OPTIONS = [:border]
-    attr_accessor :rows, *VALID_OPTIONS
-
-    def initialize(options = {})
-      self.validate_options(options, *VALID_OPTIONS)
-
-      self.border = options[:border] || false
-
-      @rows = []
-    end
-
-    def add(row)
-      # Inheritance from the table
-      row.border = self.border
-
-      # Inherit properties from the first row
-      if self.rows[0]
-        row.columns.each_with_index do |c,i|
-          # The positional attributes are always required to inheret to make sure the table
-          # displays properly
-          c.align = self.rows[0].columns[i].align
-          c.padding = self.rows[0].columns[i].padding
-          c.width = self.rows[0].columns[i].width
-          c.size = c.width - 2 * c.padding
-
-          # Allow for the fact that the row or column may take precedence and that the first
-          # row might be a header row which we don't want to inherit from
-          unless row.color || c.color
-            if self.rows[0].header
-              c.color = self.rows[1].columns[i].color if self.rows[1]
-            else
-              c.color = self.rows[0].columns[i].color
-            end
-          end
-
-          # Allow for the row to take precendence and that the first # row might be a header
-          # row which we don't want to inherit from
-          unless row.bold
-            if self.rows[0].header
-              c.bold = self.rows[1].columns[i].bold if self.rows[1]
-            else
-              c.bold = self.rows[0].columns[i].bold
-            end
-          end
-        end
-      end
-
-      self.rows << row
-    end
-
-    def output
-      return if self.rows.size == 0 # we got here with nothing to print to the screen
-
-      puts separator('first') if self.border
-      self.rows.each_with_index do |row, index|
-        row.output
-        puts separator('middle') if self.border && (index != self.rows.size - 1)
-      end
-      puts separator('last') if self.border
-    end
-
-    private
-
-    def separator(type = 'middle')
-      if "\u2501" == 'u2501'
-        left = right = center = '+'
-        bar = '-'
-      else
-        bar = "\u2501"
-        case type
-        when 'first'
-          left = "\u250F"
-          center = "\u2533"
-          right = "\u2513"
-        when 'middle'
-          left = "\u2523"
-          center = "\u254A"
-          right = "\u252B"
-        when 'last'
-          left = "\u2517"
-          center = "\u253B"
-          right = "\u251B"
-        end
-      end
-
-      left + self.rows[0].columns.map {|c| bar * (c.width + 2)}.join(center) + right
-    end
-  end
-end