terminal-table 1.5.2 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a5276af39a8c70872f4f6ebbc2e6a3737d78f8da
-  data.tar.gz: 2763365975b930b885ae1c88c957e6fe3b508904
+  metadata.gz: 906edc10ddbc49ce496a4bb49d2b0318ce67ce87
+  data.tar.gz: e28e319ee32ef1be3a81ccd3e324970d7778a20d
 SHA512:
-  metadata.gz: 1e8e66ec3b2c947acc0cb91ae1fa573e693bbe54846bd3c69b1c0dd43f995d0a705102a5d1ddfbfa995e49a57a0858a5c71305657d8fa9a6daa1de13f7b2da50
-  data.tar.gz: dd328d81b11d32dcc3ffbf17a85b0dd87edec4a48231fba2a94c53279536abe07a6f8c44e06174cd3f957760b9886da4fc6d2dbc00a6a5e1f3c5fde67d9b90cb
+  metadata.gz: 37a853ebbf1ccad933892ed34372ca2126d3f302f4c81e9da4dd3e53937613af6e0f820e62c2675a3da50e3542b185d7bd523d15312f37535ca29c95dba14c13
+  data.tar.gz: 8ef39f7169f4682ed4c94739ef2cda11eb1be487b4991e1c4fa3b70ebb7a30bc728d29eaa991d4849c873f58df04b86e3f4ce7bd5c76647893f439550d71b548

data/History.rdoc

@@ -1,48 +1,53 @@
-1.4.3 / 2011-10-13
-==================
-
-  * Optimize for faster table output.
-
-1.4.2 / 2010-01-14
-==================
-
-  * Fixed some bugs with colspan
-
-=== 1.4.1 / 2009-12-18
-
-* Fix column alignment with separators.
-
-=== 1.4.0 / 2009-12-18
-
-* Can now add :seperator arbitrarily in a table [thanks splattael]
-* Fix common typo: seperator -> separator [thanks splattael]
-
-=== 1.3.0 / 2009-10-16
-
-* Major refactoring (functionality remains the same)
-
-=== 1.2.0 / 2009-08-06
-
-* Added colspan support to table
-
-=== 1.1.0 / 2009-08-06
-
-* Added colspan support to table
-
-=== 1.1.0 / 2009-07-13
-
-* Added Table#==
-
-=== 1.0.5 / 2009-03-14
-
-* Allowing nil to be passed to table for headings
-* Revised doc to show that rows can be splatted now
-* Misc refactoring
-
-=== 1.0.3 / 2009-01-15
-
-* Moved yield or eval to Terminal::Table initialize where it belongs
-
-=== 1.0.0 / 2009-01-13
-
-* Initial release
+1.6.0 / 2016-06-06
+==================
+
+  * Added table styles - margin_left, all_separators.
+
+1.4.3 / 2011-10-13
+==================
+
+  * Optimize for faster table output.
+
+1.4.2 / 2010-01-14
+==================
+
+  * Fixed some bugs with colspan
+
+=== 1.4.1 / 2009-12-18
+
+* Fix column alignment with separators.
+
+=== 1.4.0 / 2009-12-18
+
+* Can now add :seperator arbitrarily in a table [thanks splattael]
+* Fix common typo: seperator -> separator [thanks splattael]
+
+=== 1.3.0 / 2009-10-16
+
+* Major refactoring (functionality remains the same)
+
+=== 1.2.0 / 2009-08-06
+
+* Added colspan support to table
+
+=== 1.1.0 / 2009-08-06
+
+* Added colspan support to table
+
+=== 1.1.0 / 2009-07-13
+
+* Added Table#==
+
+=== 1.0.5 / 2009-03-14
+
+* Allowing nil to be passed to table for headings
+* Revised doc to show that rows can be splatted now
+* Misc refactoring
+
+=== 1.0.3 / 2009-01-15
+
+* Moved yield or eval to Terminal::Table initialize where it belongs
+
+=== 1.0.0 / 2009-01-13
+
+* Initial release

data/README.rdoc

@@ -1,240 +1,238 @@
-= Terminal Table
-
-== Description
-
-Terminal Table is a fast and simple, yet feature rich ASCII table generator written in Ruby.
-
-== Installation
-
-Install http://gemcutter.org and execute:
-  
-  $ gem install terminal-table
-
-== Usage
-
-=== Basics
-
-To use Terminal Table:
-
-  require 'terminal-table'
-
-To generate a table, provide an array of arrays (which are interpreted as rows):
-
-  rows = []
-  rows << ['One', 1]
-  rows << ['Two', 2]
-  rows << ['Three', 3]
-  table = Terminal::Table.new :rows => rows
-  
-  # > puts table
-  #
-  # +-------+---+
-  # | One   | 1 |
-  # | Two   | 2 |
-  # | Three | 3 |
-  # +-------+---+
-
-
-The constructor can also be given a block which is either yielded the Table object or instance evaluated:
-
-  table = Terminal::Table.new do |t|
-    t.rows = rows
-  end
-
-  table = Terminal::Table.new do
-    self.rows = rows
-  end
-
-Adding rows one by one:
-
-  table = Terminal::Table.new do |t|
-    t << ['One', 1]
-    t.add_row ['Two', 2]
-  end
-
-To add separators between rows:
-  
-  table = Terminal::Table.new do |t|
-    t << ['One', 1]
-    t << :separator
-    t.add_row ['Two', 2]
-    t.add_separator
-    t.add_row ['Three', 3]
-  end
-  
-  # > puts table
-  #
-  # +-------+---+
-  # | One   | 1 |
-  # +-------+---+
-  # | Two   | 2 |
-  # +-------+---+
-  # | Three | 3 |
-  # +-------+---+
-
-Cells can handle multiline content:
-  
-  table = Terminal::Table.new do |t|
-    t << ['One', 1]
-    t << :separator
-    t.add_row ["Two\nDouble", 2]
-    t.add_separator
-    t.add_row ['Three', 3]
-  end
-  
-  # > puts table
-  #
-  # +--------+---+
-  # | One    | 1 |
-  # +--------+---+
-  # | Two    | 2 |
-  # | Double |   |
-  # +--------+---+
-  # | Three  | 3 |
-  # +--------+---+
-
-=== Head
-
-To add a head to the table:
-
-  table = Terminal::Table.new :headings => ['Word', 'Number'], :rows => rows
-  
-  # > puts table
-  #
-  # +-------+--------+
-  # | Word  | Number |
-  # +-------+--------+
-  # | One   | 1      |
-  # | Two   | 2      |
-  # | Three | 3      |
-  # +-------+--------+
-
-=== Title
-
-To add a title to the table:
-
-  table = Terminal::Table.new :title => "Cheatsheet", :headings => ['Word', 'Number'], :rows => rows
-  
-  # > puts table
-  #
-  # +------------+--------+
-  # |     Cheatsheet      |
-  # +------------+--------+
-  # | Word       | Number |
-  # +------------+--------+
-  # | One        | 1      |
-  # | Two        | 2      |
-  # | Three      | 3      |
-  # +------------+--------+
-
-=== Alignment
-
-To align the second column to the right:
-
-  table.align_column(1, :right)
-  
-  # > puts table
-  #
-  # +-------+--------+
-  # | Word  | Number |
-  # +-------+--------+
-  # | One   |      1 |
-  # | Two   |      2 |
-  # | Three |      3 |
-  # +-------+--------+
-
-To align an individual cell, you specify the cell value in a hash along the alignment:
-
-  table << ["Four", {:value => 4.0, :alignment => :center}]
-  
-  # > puts table
-  #
-  # +-------+--------+
-  # | Word  | Number |
-  # +-------+--------+
-  # | One   |      1 |
-  # | Two   |      2 |
-  # | Three |      3 |
-  # | Four  |  4.0   |
-  # +-------+--------+
-  
-=== Style
-
-To specify style options:
-  
-  table = Terminal::Table.new :headings => ['Word', 'Number'], :rows => rows, :style => {:width => 80}
-  
-  # > puts table
-  #
-  # +--------------------------------------+---------------------------------------+
-  # | Word                                 | Number                                |
-  # +--------------------------------------+---------------------------------------+
-  # | One                                  | 1                                     |
-  # | Two                                  | 2                                     |
-  # | Three                                | 3                                     |
-  # +--------------------------------------+---------------------------------------+
-
-And change styles on the fly:
-  
-  table.style = {:width => 40, :padding_left => 3, :border_x => "=", :border_i => "x"}
-  
-  # > puts table
-  #
-  # x====================x=================x
-  # |               Cheatsheet             |
-  # x====================x=================x
-  # |   Word             |   Number        |
-  # x====================x=================x
-  # |   One              |   1             |
-  # |   Two              |   2             |
-  # |   Three            |   3             |
-  # x====================x=================x
-  
-To change the default style options:
-
-  Terminal::Style.defaults = {:width => 80}
-
-All Table objects created afterwards will inherit these defaults.
-
-=== Constructor options and setter methods
-
-Valid options for the constructor are :rows, :headings, :style and :title - and all options can also be set on the created table object by their setter method:
-
-  table = Terminal::Table.new
-  table.title = "Cheatsheet"
-  table.headings = ['Word', 'Number']
-  table.rows = rows
-  table.style = {:width => 40}
-
-== More examples
-
-For more examples, please see the examples/examples.rb file included in the source distribution.
-
-== Author
-
-TJ Holowaychuk <tj@vision-media.ca>
-
-== License
-
-(The MIT License)
-
-Copyright (c) 2008-2009 TJ Holowaychuk <tj@vision-media.ca>
-
-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, an d/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-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.
+= Terminal Table
+
+== Description
+
+Terminal Table is a fast and simple, yet feature rich ASCII table generator written in Ruby.
+
+== Installation
+
+  $ gem install terminal-table
+
+== Usage
+
+=== Basics
+
+To use Terminal Table:
+
+  require 'terminal-table'
+
+To generate a table, provide an array of arrays (which are interpreted as rows):
+
+  rows = []
+  rows << ['One', 1]
+  rows << ['Two', 2]
+  rows << ['Three', 3]
+  table = Terminal::Table.new :rows => rows
+  
+  # > puts table
+  #
+  # +-------+---+
+  # | One   | 1 |
+  # | Two   | 2 |
+  # | Three | 3 |
+  # +-------+---+
+
+
+The constructor can also be given a block which is either yielded the Table object or instance evaluated:
+
+  table = Terminal::Table.new do |t|
+    t.rows = rows
+  end
+
+  table = Terminal::Table.new do
+    self.rows = rows
+  end
+
+Adding rows one by one:
+
+  table = Terminal::Table.new do |t|
+    t << ['One', 1]
+    t.add_row ['Two', 2]
+  end
+
+To add separators between rows:
+  
+  table = Terminal::Table.new do |t|
+    t << ['One', 1]
+    t << :separator
+    t.add_row ['Two', 2]
+    t.add_separator
+    t.add_row ['Three', 3]
+  end
+  
+  # > puts table
+  #
+  # +-------+---+
+  # | One   | 1 |
+  # +-------+---+
+  # | Two   | 2 |
+  # +-------+---+
+  # | Three | 3 |
+  # +-------+---+
+
+Cells can handle multiline content:
+  
+  table = Terminal::Table.new do |t|
+    t << ['One', 1]
+    t << :separator
+    t.add_row ["Two\nDouble", 2]
+    t.add_separator
+    t.add_row ['Three', 3]
+  end
+  
+  # > puts table
+  #
+  # +--------+---+
+  # | One    | 1 |
+  # +--------+---+
+  # | Two    | 2 |
+  # | Double |   |
+  # +--------+---+
+  # | Three  | 3 |
+  # +--------+---+
+
+=== Head
+
+To add a head to the table:
+
+  table = Terminal::Table.new :headings => ['Word', 'Number'], :rows => rows
+  
+  # > puts table
+  #
+  # +-------+--------+
+  # | Word  | Number |
+  # +-------+--------+
+  # | One   | 1      |
+  # | Two   | 2      |
+  # | Three | 3      |
+  # +-------+--------+
+
+=== Title
+
+To add a title to the table:
+
+  table = Terminal::Table.new :title => "Cheatsheet", :headings => ['Word', 'Number'], :rows => rows
+  
+  # > puts table
+  #
+  # +------------+--------+
+  # |     Cheatsheet      |
+  # +------------+--------+
+  # | Word       | Number |
+  # +------------+--------+
+  # | One        | 1      |
+  # | Two        | 2      |
+  # | Three      | 3      |
+  # +------------+--------+
+
+=== Alignment
+
+To align the second column to the right:
+
+  table.align_column(1, :right)
+  
+  # > puts table
+  #
+  # +-------+--------+
+  # | Word  | Number |
+  # +-------+--------+
+  # | One   |      1 |
+  # | Two   |      2 |
+  # | Three |      3 |
+  # +-------+--------+
+
+To align an individual cell, you specify the cell value in a hash along the alignment:
+
+  table << ["Four", {:value => 4.0, :alignment => :center}]
+  
+  # > puts table
+  #
+  # +-------+--------+
+  # | Word  | Number |
+  # +-------+--------+
+  # | One   |      1 |
+  # | Two   |      2 |
+  # | Three |      3 |
+  # | Four  |  4.0   |
+  # +-------+--------+
+  
+=== Style
+
+To specify style options:
+  
+  table = Terminal::Table.new :headings => ['Word', 'Number'], :rows => rows, :style => {:width => 80}
+  
+  # > puts table
+  #
+  # +--------------------------------------+---------------------------------------+
+  # | Word                                 | Number                                |
+  # +--------------------------------------+---------------------------------------+
+  # | One                                  | 1                                     |
+  # | Two                                  | 2                                     |
+  # | Three                                | 3                                     |
+  # +--------------------------------------+---------------------------------------+
+
+And change styles on the fly:
+  
+  table.style = {:width => 40, :padding_left => 3, :border_x => "=", :border_i => "x"}
+  
+  # > puts table
+  #
+  # x====================x=================x
+  # |               Cheatsheet             |
+  # x====================x=================x
+  # |   Word             |   Number        |
+  # x====================x=================x
+  # |   One              |   1             |
+  # |   Two              |   2             |
+  # |   Three            |   3             |
+  # x====================x=================x
+  
+To change the default style options:
+
+  Terminal::Style.defaults = {:width => 80}
+
+All Table objects created afterwards will inherit these defaults.
+
+=== Constructor options and setter methods
+
+Valid options for the constructor are :rows, :headings, :style and :title - and all options can also be set on the created table object by their setter method:
+
+  table = Terminal::Table.new
+  table.title = "Cheatsheet"
+  table.headings = ['Word', 'Number']
+  table.rows = rows
+  table.style = {:width => 40}
+
+== More examples
+
+For more examples, please see the examples/examples.rb file included in the source distribution.
+
+== Author
+
+TJ Holowaychuk <tj@vision-media.ca>
+
+== License
+
+(The MIT License)
+
+Copyright (c) 2008-2009 TJ Holowaychuk <tj@vision-media.ca>
+
+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, an d/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+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.