columnist 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 35ce2268e5eb282ea238c82f068afe57dc8140e4
-  data.tar.gz: cf74dcb33851da6ae27429675ce80d06288f0dc0
+  metadata.gz: 0fa0309605840f3f0d3703adf7b0aeec35c32458
+  data.tar.gz: da7cd50f03f621888fedd2cb2ac4a42243c098b3
 SHA512:
-  metadata.gz: a76d6cb4ee88847ed5dd3ddc465d56cb3fc6f7f886a1e4c16dc80ce787f3ec49d52e6a81ec258250d9c39bce28cab12f31073d3d328e38f478984eecd90082b5
-  data.tar.gz: e5b603a886e092c61b43472a984027e275b81195db5eff1894b533c01a32a9b17c1ba60bde9f20b2f40079c03eac9e0136c3b9b2c56946f2819a70609db89742
+  metadata.gz: d1b9986c7cf20d37fad2b7dc5e52f55571caa290a955c459d4051c42522f4d831a74b37dfa3671d260981849330655dc1510f8fb1224f51d912eb4df43d0f35f
+  data.tar.gz: 6c12a03ec438fffffbce01633cea2052c1f3f23fb3231bf72955305b7ed54206064427ab9ce98a112297da9dda5239de74655855b19955bf48c0525f39feaa84

data/README.md

@@ -1,30 +1,31 @@
 ## Columnist
 
-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
-interface to your application.  Some of the best features include:
+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
+interface to your application. Some of the best features include:
 
 * Formatters that automatically indicate progress
 * Table syntax similar to HTML that makes it trivial to format your data in rows and columns
 * Easily created headers and footers for your report
-* Output suppression that makes it easy for your script to support a _quiet_ flag
+* Output suppression that makes it easy for your script to support a `quiet` flag
 * Capture report output as a string
 
-The latest release, 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
-supports it. Here is an example of output you can generate easily with "the reporter":
+The latest release allows you to choose between UTF8 or ASCII for drawing tables. By default it will
+use UTF8 if your system supports it.
 
-![Screenshot](http://i.imgur.com/5izCf.png)
+Here is an example of output you can generate easily with **Columnist**:
+
+![Screenshot](https://raw.githubusercontent.com/alb3rtuk/columnist/master/examples/screenshot-1.png)
 
 ### Installation
 
-It is up on rubygems.org so add it to your bundle in the Gemfile
+It is up on rubygems.org so add it to your bundle in the Gemfile..
 
 ```bash
 gem 'columnist', '>=1.0'
 ```
 
-or do it the old fashioned way:
+Or do it the old fashioned way..
 
 ```bash
 gem install columnist
@@ -32,119 +33,132 @@ gem install columnist
 
 ### Usage
 
-The gem provides a mixin that can be included in your scripts.
+The gem provides a mixin that can be included in your script as follows:
 
 ```ruby
 require 'columnist'
 
-class MyReport
+class YourClass
   include Columnist
   ...
 end
 ```
 
-### [Wiki](https://github.com/alb3rtuk/columnist)
+The best way to get an idea of how it works is to look at an example program:
+
+```ruby
+require 'columnist'
+
+class Example
+    include Columnist
+
+    def run
+        table(:border => true, :border_color => 39) do
+            row do
+                column('NAME', :width => 20)
+                column('ADDRESS', :width => 30)
+                column('CITY', :width => 25, :align => 'right')
+            end
+            row do
+                column('Dean Linden', :color => 'magenta')
+                column('12 Appian Way', :color => 'magenta')
+                column('New York')
+            end
+            row do
+                column('Ross Joy')
+                column('24 Golden Gate Road')
+                column('San Francisco')
+            end
+            row do
+                column('Tommy Booy', :color => 202)
+                column('6210 Crenshaw', :color => 202)
+                column('Los Angeles')
+            end
+        end
+    end
+end
+
+Example.new.run
+```
+
+The above code will output the following result:
+
+![Screenshot](https://raw.githubusercontent.com/alb3rtuk/columnist/master/examples/screenshot-3.png)
 
-The [Wiki](https://github.com/alb3rtuk/columnist) has all of the documentation
-necessary for getting you started.
+### Color Reference
+
+**Columnist** has 256-color support! Use the chart below for reference.
+
+![Screenshot](https://raw.githubusercontent.com/alb3rtuk/columnist/master/examples/screenshot-2.png)
 
 ### API Reference
 
 There are several methods the mixin provides that do not depend on the formatter used:
 
-* _header(hash)_ and _footer(hash)_
-  * _:title_ - The title text for the section.  _Default: 'Report'_
-  * _:width_ - The width in characters for the section.  _Default: 100_
-  * _:align_ - 'left'|'right'|'center' align the title text.  _Default: 'left'_
-  * _:spacing_ - Number of vertical lines to leave as spacing after|before the header|footer.
-    _Default: 1_
-  * _:timestamp_ - Include a line indicating the timestamp below|above the header|footer text.
-    Either true|false.  _Default: false_
-  * _:rule_ - true|false indicates whether to include a horizontal rule below|above the
-    header|footer.  _Default: false_
-  * _:color_ - The color to use for the terminal output i.e. 'red' or 'blue' or 'green'
-  * _:bold_ - true|false to boldface the font
-* _report(hash) {block}_
+* **header(hash)** and **footer(hash)**
+  * **:title** - The title text for the section. **Default: 'Report'**
+  * **:width** - The width in characters for the section. **Default: 100**
+  * **:align** - 'left'|'right'|'center' align the title text. **Default: 'left'**
+  * **:spacing** - Number of vertical lines to leave as spacing after|before the header|footer.
+   **Default: 1**
+  * **:timestamp** - Include a line indicating the timestamp below|above the header|footer text.
+    Either true|false. **Default: false**
+  * **:rule** - true|false indicates whether to include a horizontal rule below|above the
+    header|footer. **Default: false**
+  * **:color** - The color to use for the terminal output i.e. 'red' or 'blue' or 'green'
+  * **:bold** - true|false to boldface the font
+* **report(hash) {block}**
   * The first argument is a hash that defines the options for the method. See the details in the
     formatter section for allowed values.
   * The second argument is a block of ruby code that you want executed within the context of the
-    reporter.  Any ruby code is allowed.  See the examples that follow in the formatter sections for
+    reporter. Any ruby code is allowed. See the examples that follow in the formatter sections for
     details.
-* _formatter=(string)_
-  * Factory method indicating the formatter you want your application to use.  At present the 2
-    formatters are (_Default: 'nested'_):
+* **formatter=(string)**
+  * Factory method indicating the formatter you want your application to use. At present the 2
+    formatters are (**Default: 'nested'**):
   * 'progress' - Use the progress formatter
   * 'nested' - Use the nested (or documentation) formatter
-* _horizontal_rule(hash)_
-  * _:char_ - The character used to build the rule.  _Default: '-'_
-  * _:width_ - The width in characters of the rule.  _Default: 100_
-  * _:color_ - The color to use for the terminal output i.e. 'red' or 'blue' or 'green'
-  * _:bold_ - true|false to boldface the font
-* _vertical_spacing(int)_
-  * Number of blank lines to output.  _Default: 1_
-* _datetime(hash)_
-  * _:align_ - 'left'|'center'|'right' alignment of the timestamp.  _Default: 'left'_
-  * _:width_ - The width of the string in characters.  _Default: 100_
-  * _:format_ - Any allowed format from #strftime#.  _Default: %Y-%m-%d %H:%I:%S%p_
-  * _:color_ - The color to use for the terminal output i.e. 'red' or 'blue' or 'green'
-  * _:bold_ - true|false to boldface the font
-* _aligned(string, hash)_
-  * _text_ - String to display
-  * _:align_ - 'left'|'right'|'center' align the string text.  _Default: 'left'_
-  * _:width_ - The width in characters of the string text.  _Default: 100_
-  * _:color_ - The color to use for the terminal output i.e. 'red' or 'blue' or 'green'
-  * _:bold_ - true|false to boldface the font
-* _table(hash) {block}_
+* **horizontal_rule(hash)**
+  * **:char** - The character used to build the rule. **Default: '-'**
+  * **:width** - The width in characters of the rule. **Default: 100**
+  * **:color** - The color to use for the terminal output i.e. 'red' or 'blue' or 'green'
+  * **:bold** - true|false to boldface the font
+* **vertical_spacing(int)**
+  * Number of blank lines to output. **Default: 1**
+* **datetime(hash)**
+  * **:align** - 'left'|'center'|'right' alignment of the timestamp. **Default: 'left'**
+  * **:width** - The width of the string in characters. **Default: 100**
+  * **:format** - Any allowed format from #strftime#. **Default: %Y-%m-%d %H:%I:%S%p**
+  * **:color** - The color to use for the terminal output i.e. 'red' or 'blue' or 'green'
+  * **:bold** - true|false to boldface the font
+* **aligned(string, hash)**
+  * **text** - String to display
+  * **:align** - 'left'|'right'|'center' align the string text. **Default: 'left'**
+  * **:width** - The width in characters of the string text. **Default: 100**
+  * **:color** - The color to use for the terminal output i.e. 'red' or 'blue' or 'green'
+  * **:bold** - true|false to boldface the font
+* **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.
-  * _:color_ - The color to use for the terminal output i.e. 'red' or 'blue' or 'green'
-  * _:bold_ - true|false to boldface the font
-* _column(string, hash)_
-  * _text_ - String to display in the table cell
-  * _options_ - The options to define the column
+    * **: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.
+  * **:color** - The color to use for the terminal output i.e. 'red' or 'blue' or 'green'
+  * **:bold** - true|false to boldface the font
+* **column(string, hash)**
+  * **text** - String to display in the table cell
+  * **options** - The options to define the column
     * :width - defines the width of the column
     * :padding - The number of spaces to put on both the left and right of the text.
     * :align - Allowed values are left|right|center
     * :color - The color to use for the terminal output i.e. 'red' or 'blue' or 'green'
     * :bold - true|false to boldface the font
-* _suppress_output_ - Suppresses output stream that goes to STDOUT
-* _capture_output_ - Captures all of the output stream to a string and restores output to STDOUT
-* _restore_output_ - Restores the output stream to STDOUT
-
-### To Do
-
-* Add a formatter that supports html output
-* Add the ability for a column to span across others in a table
-
-### Contributors
-
-* [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-2014 Albert Rannetsperger
-
-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,
-including without limitation the rights to use, copy, modify, merge, publish, distribute,
-sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+* **suppress_output** - Suppresses output stream that goes to STDOUT
+* **capture_output** - Captures all of the output stream to a string and restores output to STDOUT
+* **restore_output** - Restores the output stream to STDOUT
 
-The above copyright notice and this permission notice shall be included in all copies or substantial
-portions of the Software.
+## Original
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
-NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES
-OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+The original gem, created by [Wes Bailey](https://github.com/wbailey), can be found here:
+[https://github.com/wbailey/command_line_reporter](https://github.com/wbailey/command_line_reporter)

data/examples/example.rb

@@ -0,0 +1,32 @@
+require 'columnist'
+
+class Example
+    include Columnist
+
+    def run
+        table(:border => true, :border_color => 39) do
+            row do
+                column('NAME', :width => 20)
+                column('ADDRESS', :width => 30)
+                column('CITY', :width => 25, :align => 'right')
+            end
+            row do
+                column('Dean Linden', :color => 'magenta')
+                column('12 Appian Way', :color => 'magenta')
+                column('New York')
+            end
+            row do
+                column('Ross Joy')
+                column('24 Golden Gate Road')
+                column('San Francisco')
+            end
+            row do
+                column('Tommy Booy', :color => 202)
+                column('6210 Crenshaw', :color => 202)
+                column('Los Angeles')
+            end
+        end
+    end
+end
+
+Example.new.run

data/lib/columnist/row.rb

@@ -7,7 +7,6 @@ module Columnist
 
         def initialize(options = {})
             self.validate_options(options, *VALID_OPTIONS)
-
             self.columns = []
             self.border = false
             self.header = options[:header] || false
@@ -32,10 +31,8 @@ module Columnist
         def output
             screen_count.times do |sr|
                 border_char = use_utf8? ? "\u2503" : '|'
-                border_char = border_char.send(self.border_color) if self.border_color
-
+                border_char = colorize(border_char, self.border_color)
                 line = (self.border) ? "#{border_char} " : ''
-
                 self.columns.size.times do |mc|
                     col = self.columns[mc]
                     # Account for the fact that some columns will have more screen rows than their
@@ -62,10 +59,8 @@ module Columnist
                     else
                         line << self.columns[mc].screen_rows[sr]
                     end
-
                     line << ' ' + ((self.border) ? "#{border_char} " : '')
                 end
-
                 puts line
             end
         end
@@ -79,5 +74,37 @@ module Columnist
         def use_utf8?
             self.encoding == :unicode && "\u2501" != "u2501"
         end
+
+        def colorize(str, color)
+            case color
+                when 'red'
+                    return "\x1B[38;5;9m#{str}\x1B[38;5;256m"
+                when 'green'
+                    return "\x1B[38;5;10m#{str}\x1B[38;5;256m"
+                when 'yellow'
+                    return "\x1B[38;5;11m#{str}\x1B[38;5;256m"
+                when 'blue'
+                    return "\x1B[38;5;33m#{str}\x1B[38;5;256m"
+                when 'magenta'
+                    return "\x1B[38;5;13m#{str}\x1B[38;5;256m"
+                when 'cyan'
+                    return "\x1B[38;5;14m#{str}\x1B[38;5;256m"
+                when 'gray'
+                    return "\x1B[38;5;240m#{str}\x1B[38;5;256m"
+                when 'white'
+                    return "\x1B[38;5;255m#{str}\x1B[38;5;256m"
+                when 'black'
+                    return "\x1B[38;5;0m#{str}\x1B[38;5;256m"
+            end
+            if is_number?(color)
+                str = "\x1B[38;5;#{color}m#{str}\x1B[38;5;256m"
+            end
+            str
+        end
+
+        def is_number?(str)
+            true if Integer(str) rescue false
+        end
+
     end
 end

data/lib/columnist/table.rb

@@ -7,15 +7,12 @@ module Columnist
 
         def initialize(options = {})
             self.validate_options(options, *VALID_OPTIONS)
-
             self.border = options[:border] || false
             self.border_color = options[:border_color] || false
             self.width = options[:width] || false
             self.encoding = options[:encoding] || Columnist::DEFAULTS[:encoding]
-
             @rows = []
-
-            raise ArgumentError, "Invalid encoding" unless [:ascii, :unicode].include? self.encoding
+            raise ArgumentError, 'Invalid encoding' unless [:ascii, :unicode].include? self.encoding
         end
 
         def add(row)
@@ -61,9 +58,8 @@ module Columnist
 
         def separator(type = 'middle')
             left, center, right, bar = use_utf8? ? utf8_separator(type) : ascii_separator
-
             separator_str = left + self.rows[0].columns.map { |c| bar * (c.width + 2) }.join(center) + right
-            separator_str.send(self.border_color) if self.border_color
+            separator_str = colorize(separator_str, self.border_color)
         end
 
         def use_utf8?
@@ -129,5 +125,37 @@ module Columnist
                 c.bold = self.rows[inherit_from].columns[i].bold
             end
         end
+
+        def colorize(str, color)
+            case color
+                when 'red'
+                    return "\x1B[38;5;9m#{str}\x1B[38;5;256m"
+                when 'green'
+                    return "\x1B[38;5;10m#{str}\x1B[38;5;256m"
+                when 'yellow'
+                    return "\x1B[38;5;11m#{str}\x1B[38;5;256m"
+                when 'blue'
+                    return "\x1B[38;5;33m#{str}\x1B[38;5;256m"
+                when 'magenta'
+                    return "\x1B[38;5;13m#{str}\x1B[38;5;256m"
+                when 'cyan'
+                    return "\x1B[38;5;14m#{str}\x1B[38;5;256m"
+                when 'gray'
+                    return "\x1B[38;5;240m#{str}\x1B[38;5;256m"
+                when 'white'
+                    return "\x1B[38;5;255m#{str}\x1B[38;5;256m"
+                when 'black'
+                    return "\x1B[38;5;0m#{str}\x1B[38;5;256m"
+            end
+            if is_number?(color)
+                str = "\x1B[38;5;#{color}m#{str}\x1B[38;5;256m"
+            end
+            str
+        end
+
+        def is_number?(str)
+            true if Integer(str) rescue false
+        end
+
     end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: columnist
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Albert Rannetsperger
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-09 00:00:00.000000000 Z
+date: 2015-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colored
@@ -58,6 +58,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
+- examples/example.rb
+- examples/screenshot-1.png
+- examples/screenshot-2.png
+- examples/screenshot-3.png
 - lib/columnist.rb
 - lib/columnist/column.rb
 - lib/columnist/formatter/nested.rb