command_line_reporter 3.2.1 → 3.3.0

data/README.md

@@ -1,4 +1,4 @@
-## Command Line Reporter
+## Command Line Reporter [![Build Status](https://travis-ci.org/wbailey/command_line_reporter.png)](https://travis-ci.org/wbailey/command_line_reporter)  [![Code Climate](https://codeclimate.com/github/wbailey/command_line_reporter.png)](https://codeclimate.com/github/wbailey/command_line_reporter) [![Gem Version](https://badge.fury.io/rb/command_line_reporter.png)](http://badge.fury.io/rb/command_line_reporter)
 
 This gem provides a DSL that makes it easy to write reports of various types in ruby.  It eliminates
 the need to litter your source with *puts* statements instead providing a more readable, expressive
@@ -10,8 +10,11 @@ interface to your application.  Some of the best features include:
 * Output suppression that makes it easy for your script to support a _quiet_ flag
 * Capture report output as a string
 
-The latest release uses unicode drawing characters for the table, colors allowing you to distinguish
-data in new ways including bold if your terminal supports it.
+The latest releast thanks to a contribution from [Josh Brown](https://github.com/tobijb) allows you
+to choose between UTF8 or ASCII for drawing tables.  By default it will use UTF8 if your system
+support it. Here is an example of output you can generate easily with "the reporter":
+
+![Screenshot](http://i.imgur.com/5izCf.png)
 
 ### Installation
 
@@ -94,6 +97,7 @@ There are several methods the mixin provides that do not depend on the formatter
 * _table(hash) {block}_
   * The first argument is a hash that defines properties of the table.
     * _:border_ - true|false indicates whether to include borders around the table cells
+    * _:encoding_ - :ascii or :unicode (default unicode)
   * The second argument is a block which includes calls the to the _row_ method
 * _row {block}_
   * _:header_ - Set to true to indicate if this is a header row in the table.
@@ -113,22 +117,22 @@ There are several methods the mixin provides that do not depend on the formatter
 
 ### To Do
 
-* Refactor the table structure to use a formatter that produces the current ascii output
-* After the formatter is added to a table then create one for html output
+* Add a formatter that supports html output
 * Add the ability for a column to span across others in a table
 
 ### Contributors
 
-* Thanks to [Stefan Frank](https://github.com/mugwump) for raising the issue that he could not
-  capture report output in a variable as a string
-* Thanks to [Mike Gunderloy](https://github.com/ffmike) for suggesting the need for suppressing
-  output and putting together a fantastic pull request and discussion
-* Thanks to [Jason Rogers](https://github.com/jacaetevha) and [Peter
-  Suschlik](https://github.com/splattael) for their contributions as well on items I missed
+* [Josh Brown](https://github.com/tobijb) added the ability to encode tables in either ascii or utf8
+* [Stefan Frank](https://github.com/mugwump) for raising the issue that he could not capture report
+  output in a variable as a string
+* [Mike Gunderloy](https://github.com/ffmike) for suggesting the need for suppressing output and
+  putting together a fantastic pull request and discussion
+* [Jason Rogers](https://github.com/jacaetevha) and [Peter Suschlik](https://github.com/splattael)
+  for their contributions as well on items I missed
 
 ### License
 
-Copyright (c) 2011-2012 Wes Bailey
+Copyright (c) 2011-2014 Wes Bailey
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
 associated documentation files (the "Software"), to deal in the Software without restriction,

data/lib/{column.rb → command_line_reporter/column.rb}

@@ -1,4 +1,3 @@
-require 'options_validator'
 require 'colored'
 
 module CommandLineReporter
@@ -13,7 +12,7 @@ module CommandLineReporter
 
       self.text = text.to_s
 
-      self.width = options[:width] || 10
+      self.width = options[:width]  || 10
       self.align = options[:align] || 'left'
       self.padding = options[:padding] || 0
       self.color = options[:color] || nil
@@ -23,8 +22,14 @@ module CommandLineReporter
 
       raise ArgumentError unless self.width > 0
       raise ArgumentError unless self.padding.to_s.match(/^\d+$/)
+    end
+
+    def size
+      self.width - 2 * self.padding
+    end
 
-      self.size = self.width - 2 * self.padding
+    def required_width
+      self.text.to_s.size + 2 * self.padding
     end
 
     def screen_rows

data/lib/{nested_formatter.rb → command_line_reporter/formatter/nested.rb}

@@ -1,5 +1,4 @@
 require 'singleton'
-require 'options_validator'
 require 'colored'
 
 module CommandLineReporter

data/lib/{progress_formatter.rb → command_line_reporter/formatter/progress.rb}

@@ -1,5 +1,4 @@
 require 'singleton'
-require 'options_validator'
 require 'colored'
 
 module CommandLineReporter

data/lib/{row.rb → command_line_reporter/row.rb}

@@ -1,11 +1,8 @@
-require 'column'
-require 'options_validator'
-
 module CommandLineReporter
   class Row
     include OptionsValidator
 
-    VALID_OPTIONS = [:header, :color, :bold]
+    VALID_OPTIONS = [:header, :color, :bold, :encoding]
     attr_accessor :columns, :border, *VALID_OPTIONS
 
     def initialize(options = {})
@@ -16,6 +13,8 @@ module CommandLineReporter
       self.header = options[:header] || false
       self.color = options[:color]
       self.bold = options[:bold] || false
+      self.encoding = options[:encoding] || false
+
     end
 
     def add(column)
@@ -32,7 +31,7 @@ module CommandLineReporter
 
     def output
       screen_count.times do |sr|
-        border_char = ("\u2501" == "u2501") ? '|' : "\u2503"
+        border_char = ("\u2501" == "u2501" || self.encoding == :ascii) ? '|' : "\u2503"
         line = (self.border) ? "#{border_char} " : ''
         self.columns.size.times do |mc|
           col = self.columns[mc]

data/lib/command_line_reporter/table.rb

@@ -0,0 +1,130 @@
+module CommandLineReporter
+  class Table
+    include OptionsValidator
+
+    VALID_OPTIONS = [:border, :width, :encoding]
+    attr_accessor :rows, *VALID_OPTIONS
+
+    def initialize(options = {})
+      self.validate_options(options, *VALID_OPTIONS)
+
+      self.border = options[:border] || false
+      self.width = options[:width] || false
+      self.encoding = options[:encoding] || CommandLineReporter::DEFAULTS[:encoding]
+
+      @rows = []
+
+      raise ArgumentError, "Invalid encoding" unless [ :ascii, :unicode ].include? self.encoding
+    end
+
+    def add(row)
+      # Inheritance from the table
+      row.border = self.border
+
+      # Inherit properties from the appropriate row
+      inherit_column_attrs(row) if self.rows[0]
+
+      self.rows << row
+    end
+
+    def output
+      return if self.rows.size == 0 # we got here with nothing to print to the screen
+      auto_adjust_widths if self.width == :auto
+
+      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
+
+    def auto_adjust_widths
+      column_widths = []
+
+      self.rows.each do |row|
+        row.columns.each_with_index do |col, i|
+          column_widths[i] = [ col.required_width, ( column_widths[i] || 0 ) ].max
+        end
+      end
+
+      self.rows.each do |row|
+        row.columns.each_with_index do |col, i|
+          col.width = column_widths[i]
+        end
+      end
+    end
+
+    private
+
+    def separator(type = 'middle')
+      left, right, center, bar = use_utf8? ? ascii_separator : utf8_separator
+
+      left + self.rows[0].columns.map {|c| bar * (c.width + 2)}.join(center) + right
+    end
+
+    def use_utf8?
+      self.encoding == :ascii || "\u2501" == "u2501"
+    end
+
+    def ascii_separator
+      left = right = center = '+'
+      bar = '-'
+      [left, right, center, bar]
+    end
+
+    def utf8_separator(type)
+      bar = "\u2501"
+
+      left, right, center = case type
+                            when 'first'
+                              ["\u250F", "\u2533", "\u2513"]
+                            when 'middle'
+                              ["\u2523", "\u254A", "\u252B"]
+                            when 'last'
+                              ["\u2517", "\u253B", "\u251B"]
+                            end
+
+      [left, right, center, bar]
+    end
+
+    def inherit_column_attrs(row)
+      row.columns.each_with_index do |c,i|
+        use_positional_attrs(c, i)
+        use_color(row, c, i)
+        use_bold(row, c, i)
+      end
+    end
+
+    def use_positional_attrs(c, i)
+      # The positional attributes are always required to inheret to make sure the table
+      # displays properly
+      %w{align padding width}.each do |attr|
+        val = self.rows[0].columns[i].send(attr)
+        c.send(attr + "=", val)
+      end
+    end
+
+    def inherit_from
+      self.rows[0].header ? 1 : 0
+    end
+
+    def use_color(row, c, i)
+      if c.color
+        # keep default
+      elsif row.color
+        c.color = row.color
+      else
+        c.color = self.rows[inherit_from].columns[i].color
+      end
+    end
+
+    def use_bold(row, c, i)
+      if row.bold
+        c.bold = row.bold
+      elsif inherit_from != 1
+        c.bold = self.rows[inherit_from].columns[i].bold
+      end
+    end
+  end
+end

data/lib/{version.rb → command_line_reporter/version.rb}

@@ -1,3 +1,3 @@
 module CommandLineReporter
-  VERSION = '3.2.1'
+  VERSION = '3.3.0'
 end

data/lib/command_line_reporter.rb

@@ -1,7 +1,12 @@
 require 'stringio'
-require 'table'
 
-Dir[File.join(File.dirname(__FILE__), '*_formatter.rb')].each {|r| require r}
+require 'command_line_reporter/options_validator'
+require 'command_line_reporter/formatter/progress'
+require 'command_line_reporter/formatter/nested'
+require 'command_line_reporter/row'
+require 'command_line_reporter/column'
+require 'command_line_reporter/table'
+require 'command_line_reporter/version'
 
 module CommandLineReporter
   include OptionsValidator
@@ -12,6 +17,7 @@ module CommandLineReporter
     :width => 100,
     :align => 'left',
     :formatter => 'nested',
+    :encoding => :unicode,
   }
 
   def capture_output
@@ -120,6 +126,7 @@ module CommandLineReporter
   end
 
   def row(options = {})
+    options[:encoding] ||= @table.encoding
     @row = CommandLineReporter::Row.new(options)
     yield
     @table.add(@row)