rtables 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 476b203d969073a14520ac1ea98765e688b211f5
-  data.tar.gz: 0b6436a04b12f9ca02d6f36653fec415cf19a917
+  metadata.gz: f6ca63c3fa094725afe6a512242c42625b804c69
+  data.tar.gz: a4007c9aa87978745c6bcb2c1cfc4a8d27cc6be7
 SHA512:
-  metadata.gz: fc21c375f9d192b9e50bc8dd2703298b65ba5e431df8544b6816911cf7d8a0bc520da5e0518422bf5c3a46bb2a8c5af5a17f04ab6add3ad04ca2fc0cb920e38e
-  data.tar.gz: 3ff2f50aed25777364d30e22238428ead2e851f117206fd52b2d9af29a4ea46469088a149d443f8c3c30aaed8c71a6be98330458cda431196233dbdc85feb39b
+  metadata.gz: a8ab35eeb7fd374545eb59e5ed27b50023dc8c25d1f5a7ddda5e41b1e7f36344a70dac8c2dd5f5cbf337fcfb177b20b5529d1f242f16774eef7aebdf780cc765
+  data.tar.gz: de32615674f18a08e305e811a32a4fb353dfe27e1d0ce239d07126497fa3f126be7265f1feb2005720ae8ab89e9f2ee609294162eadc7ca0a316efded96e753f

data/README.md

@@ -1,4 +1,7 @@
 # Ruby Tables
+[![Build Status](https://travis-ci.org/Zarthus/rtables.svg?branch=master)](https://travis-ci.org/Zarthus/rtables)
+[![Code Climate](https://codeclimate.com/github/Zarthus/rtables/badges/gpa.svg)](https://codeclimate.com/github/Zarthus/rtables)
+[![Test Coverage](https://codeclimate.com/github/Zarthus/rtables/badges/coverage.svg)](https://codeclimate.com/github/Zarthus/rtables/coverage)
 
 RTables (Ruby Tables) is a small library that helps you generate table output in various predefined formats.
 

data/docs/tables/MonoTable.md

@@ -1,9 +1,9 @@
-# Small Monospace Table
+# Monospace Table
 
 Code:
 
 ```ruby
-require 'rtables/table/monotable'
+require 'rtables'
 table = RTables::Table::MonoTable.new
 
 table.add_column('Example')
@@ -15,19 +15,21 @@ table.add_row('Very Large Field', 'With a large amount of text on it.')
 table.render
 ```
 
-Looks like:
-
+Looks like (output from .ci/show_table_formats.rb):
 ```
-+---------+------------------------------------+
-| Example | First                              |
-| Field   | This is an example text            |
-+---------+------------------------------------+
-| Example | Small                              |
-| Field   | Field                              |
-+---------+------------------------------------+
-| Example | Very Large Field                   |
-| Field   | With a large amount of text on it. |
-+---------+------------------------------------+
++-------------+---------------------------------------------------------+
+| Name        | Maxine Caulfield                                        |
+| Occupation  | Time Wizard                                             |
+| Voice Actor | Serena de Mouroux                                       |
++-------------+---------------------------------------------------------+
+| Name        | David N. Madsen                                         |
+| Occupation  | Head of Security at Blackwell Academy                   |
+| Voice Actor | Don McManus                                             |
++-------------+---------------------------------------------------------+
+| Name        | Mark Jefferson                                          |
+| Occupation  | Professional Photographer, Teacher at Blackwell Academy |
+| Voice Actor | Derek Phillips                                          |
++-------------+---------------------------------------------------------+
 ```
 
 ## Positives
@@ -38,5 +40,3 @@ Looks like:
 ## Negatives
 
 - Requires a Monospace font to render properly.
-- If field names are too long the table will look strange.
-  - Table::MonoTable solves this by making use of [`BigMonoTable`](BigMonoTable.md) dynamically when the content is too big.

data/docs/tables/PlainTable.md

@@ -0,0 +1,36 @@
+# Plain Table
+
+Code:
+
+```ruby
+require 'rtables'
+table = RTables::Table::PlainTable.new
+
+table.add_column('Example')
+table.add_column('Field')
+table.add_row('First', 'This is an example text')
+table.add_row('Small', 'Field')
+table.add_row('Very Large Field', 'With a large amount of text on it.')
+
+table.render
+```
+
+Looks like (output from .ci/show_table_formats.rb):
+```
+Name: Maxine Caulfield
+Occupation: Time Wizard
+Voice Actor: Serena de Mouroux
+----
+Name: David N. Madsen
+Occupation: Head of Security at Blackwell Academy
+Voice Actor: Don McManus
+----
+Name: Mark Jefferson
+Occupation: Professional Photographer, Teacher at Blackwell Academy
+Voice Actor: Derek Phillips
+----
+```
+
+## Positives
+
+- Displays the same everywhere

data/docs/tables/SimpleTable.md

@@ -0,0 +1,33 @@
+# Simple Table
+
+Code:
+
+```ruby
+require 'rtables'
+table = RTables::Table::SimpleTable.new
+
+table.add_column('Example')
+table.add_column('Field')
+table.add_row('First', 'This is an example text')
+table.add_row('Small', 'Field')
+table.add_row('Very Large Field', 'With a large amount of text on it.')
+
+table.render
+```
+
+Looks like (output from .ci/show_table_formats.rb):
+```
+Name: Maxine Caulfield, Occupation: Time Wizard, Voice Actor: Serena de Mouroux
+Name: David N. Madsen, Occupation: Head of Security at Blackwell Academy, Voice Actor: Don McManus
+Name: Mark Jefferson, Occupation: Professional Photographer, Teacher at Blackwell Academy, Voice Actor: Derek Phillips
+```
+
+
+## Positives
+
+- Displays the same everywhere
+- Takes up very little space
+
+## Negatives
+
+- Difficult to read

data/docs/tables/UnicodeMonoTable.md

@@ -0,0 +1,43 @@
+# Unicode Monospace Table
+
+Code:
+
+```ruby
+require 'rtables'
+table = RTables::Table::UnicodeMonoTable.new
+
+table.add_column('Example')
+table.add_column('Field')
+table.add_row('First', 'This is an example text')
+table.add_row('Small', 'Field')
+table.add_row('Very Large Field', 'With a large amount of text on it.')
+
+table.render
+```
+
+Looks like (output from .ci/show_table_formats.rb):
+```
+┌─────────────┬─────────────────────────────────────────────────────────┐
+│ Name        │ Maxine Caulfield                                        │
+│ Occupation  │ Time Wizard                                             │
+│ Voice Actor │ Serena de Mouroux                                       │
+├─────────────┼─────────────────────────────────────────────────────────┤
+│ Name        │ David N. Madsen                                         │
+│ Occupation  │ Head of Security at Blackwell Academy                   │
+│ Voice Actor │ Don McManus                                             │
+├─────────────┼─────────────────────────────────────────────────────────┤
+│ Name        │ Mark Jefferson                                          │
+│ Occupation  │ Professional Photographer, Teacher at Blackwell Academy │
+│ Voice Actor │ Derek Phillips                                          │
+└─────────────┴─────────────────────────────────────────────────────────┘
+```
+
+## Positives
+
+- Easy to read
+- Perfect for key => value display
+
+## Negatives
+
+- Requires a Monospace font to render properly.
+- Will not function when charset is misconfigured, does not use basic ASCII characters.

data/docs/tables_in_2_minutes.md

@@ -27,40 +27,7 @@ table.add_row('It\'s a beautiful day to be a table', 'Indeed.')
 puts table.to_s
 ```
 
-The following output may be generated:
-
-```
-# PlainTable - the most boring table, but also the one that is the most consistent
-
-Column: Row1 Value1, Column2: Row1 Value2, ...
-Column: Row2 Value1, Column2: Row2 Value2, ...
-Column: Row3 Value1, Column2: Row3 Value2, ...
-```
-
-```
-# SimpleTable - slightly less boring table, keeping the same level of consistency
-
-Column: Row1 Value1
-Column2: Row1 Value2
-----
-Column: Row2 Value1
-Column2: Row2 Value2
-----
-Column: Row3 Value1
-Column2: Row3 Value2
-
-```
-
-```
-# MonoTable - prettier, but requires a monospace font to function.
-
-```
-
-```
-# UnicodeMonoTable - the prettiest, but requires a monospace font to function.
-#  Makes use of non-ascii characters, so may cause rendering issues on some clients.
-
-```
+You can run `ruby .ci/show_table_formats.rb` to generate a current list of table formats.
 
 ## Making your own table
 Your table needs to meet the following two conditions:

data/lib/rtables/tablebuilder.rb

@@ -34,7 +34,7 @@ module RTables
     end
 
     def raise_if_empty
-      fail TableFormatError, 'Table has no content to display.' if empty?
+      fail TableFormatError, 'Table has no content to display.' if empty? || @columns == 0 || @rows == 0
     end
 
     def empty?

data/lib/rtables/version.rb

@@ -1,3 +1,3 @@
 module RTables
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.0.1'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rtables
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Jos Ahrens