tabulo 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8583d9f66b9305bb91dc45079567e811c60e839389c468ac963b2e49d1edc6a1
-  data.tar.gz: f89afda08a128532f113a7d36f1941ed638d745c7addf5761f068865eadbcdaa
+  metadata.gz: 2db6b288685b76e7cab29fc52f1f0d265cb77310392449681bd15950231fb3d7
+  data.tar.gz: 8a9477cc4c7f04a0219bac645c774bd5569f1cd2baff5bfb17ffba57e22b497b
 SHA512:
-  metadata.gz: 0c0f4a420b0dfd4624afaa857f2ba03c28e5decab3c1fcb867b40662d277f8071a6c75a22b7f9bb72adf7595bbd8e6616a4103be1c92fee5e228e2bdacff07f7
-  data.tar.gz: 86b81698a9bfa003ed01f80a314e0bf4c0c55569152ef326ef29a73091094c02d844b536e7729fb879bf2225c260d3640687d97d6bc08acf604863b3a08ee083
+  metadata.gz: 292313dfb4ec2e67e0f0f879c61f9b3797b407d9c8bf1a1e049126b509cedeca557b4cb0d0e4498658438ced29a0faf0aab868ee821cda92a9cea6959a81e75c
+  data.tar.gz: 8714b8dae9a6373d0953a496816e14264af2c78e680b8854866e513776f6aa81827d9beb4c29c190455b3911326495a4cfbe5b712175c54b5087e7927531737b

data/.travis.yml

@@ -5,4 +5,5 @@ rvm:
   - 2.2.10
   - 2.3.8
   - 2.4.5
-  - 2.5.3
+  - 2.5.5
+  - 2.6.2

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+### v1.2.2
+
+* Improve documentation.
+
 ### v1.2.1
 
 * Improve documentation in README.

data/README.md

@@ -1,8 +1,10 @@
 # Tabulo
 
 [![Gem Version][GV img]][Gem Version]
+[![Documentation][DC img]][Documentation]
 [![Coverage Status][CS img]][Coverage Status]
 [![Build Status][BS img]][Build Status]
+[![Code Climate][CC img]][Code Climate]
 
 ## Overview
 
@@ -29,9 +31,9 @@ end
 
 ## Features
 
-* A [DRY interface](#configuring-columns) that relieves the developer of maintaining a correspondence between an array
-  of column headers on the one hand, and an array of rows of cell values on the other
-* Set [fixed column widths](#fixed-column-widths), then either [wrap](#overflow-handling) or
+* A [DRY interface](#configuring-columns): by being "column based", it is designed to spare the
+  developer the burden of syncing the ordering within the header row with that of the body rows.
+* Lets you set [fixed column widths](#fixed-column-widths), then either [wrap](#overflow-handling) or
   [truncate](#overflow-handling) the overflow.
 * Alternatively, [shrinkwrap](#shrinkwrap) the table so that each column is just wide enough for its contents.
 * Put an upper limit on total table width when shrinkwrapping, to
@@ -44,10 +46,11 @@ end
   printing as you go, without waiting for the entire underlying collection to load.
 * Each `Tabulo::Row` is also an `Enumerable`, [providing access](#accessing-cell-values) to the underlying cell values.
 * Tabulate any `Enumerable`: the underlying collection need not be an array.
+* [Customize](#additional-configuration-options) border and divider characters.
 
 Tabulo has also been ported to Crystal (with some modifications): see [Tablo](https://github.com/hutou/tablo).
 
-## Table of Contents
+## Contents
 
   * [Overview](#overview)
   * [Features](#features)
@@ -59,12 +62,13 @@ Tabulo has also been ported to Crystal (with some modifications): see [Tablo](ht
      * [Cell alignment](#cell-alignment)
      * [Column width, wrapping and truncation](#column-width-wrapping-and-truncation)
         * [Configuring fixed widths](#configuring-fixed-widths)
+        * [Configuring padding](#configuring-padding)
         * [Automating column widths](#automating-column-widths)
         * [Overflow handling](#overflow-handling)
      * [Formatting cell values](#formatting-cell-values)
      * [Repeating headers](#repeating-headers)
      * [Using a Table Enumerator](#using-a-table-enumerator)
-     * [Accessing cell values)(#accessing-cell-values)
+     * [Accessing cell values](#accessing-cell-values)
      * [Additional configuration options](#additional-configuration-options)
   * [Development](#development)
   * [Contributing](#contributing)
@@ -202,7 +206,10 @@ table = Tabulo::Table.new([1, 2], columns: %i[itself even?], column_width: 6)
 
 Widths set for individual columns always override the default column width for the table.
 
-Note the single character of padding either side of each column is not counted in the column width.
+<a name="configuring-padding"></a>
+#### Configuring padding
+
+The single character of padding either side of each column is not counted in the column width.
 The amount of this padding can be configured for the table as a whole, using the `column_padding`
 option passed to `Table.new`.
 
@@ -329,7 +336,7 @@ end
 ```
 
 ```
-puts table
+> puts table
 +--------------+--------------+
 |       N      |  Reciprocal  |
 +--------------+--------------+
@@ -423,6 +430,25 @@ table.each do |row|
 end
 ```
 
+The first argument to `add_column`, considered as a `Symbol`, always provides the key
+for the purpose of accessing the `Hash` form of a `Tabulo::Row`. This key serves as
+a sort of "logical label" for the column; and it need not be the same as the column
+header. If we want the header to be different to the label, we can achieve this
+using the `header` option to `add_column`:
+
+```ruby
+table = Tabulo::Table.new(1..5) do |t|
+  t.add_column("Number") { |n| n }
+  t.add_column(:doubled, header: "Number X 2") { |n| n * 2 }
+end
+
+table.each do |row|
+  cells = row.to_h
+  puts cells[:Number]  # 1...2...3...4...5
+  puts cells[:doubled] # 2...4...6...8...10
+end
+```
+
 ### Additional configuration options
 
 The characters used for horizontal dividers, vertical dividers and corners, which default to `-`,
@@ -432,15 +458,44 @@ The characters used for horizontal dividers, vertical dividers and corners, whic
 The character used to indicate truncation, which defaults to `~`, can be configured using the
 `truncation_indicator` option passed to `Table.new`.
 
-## Development
+A bottom border can be added to the table when printing, as follows:
+
+```ruby
+puts table
+puts table.horizontal_rule
+```
+
+This will output a bottom border that's appropriately sized for the table.
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run
-the tests. You can also run `bin/console` for an interactive prompt that will allow you to
-experiment.
+This mechanism can also be used to output a horizontal divider after each row:
+
+```ruby
+table = Tabulo::Table.new(1..3, columns: %i[itself even?])
+```
+
+```
+> table.each { |row| puts row ; puts table.horizontal_rule }
++--------------+--------------+
+|    itself    |     even?    |
++--------------+--------------+
+|            1 |     false    |
++--------------+--------------+
+|            2 |     true     |
++--------------+--------------+
+|            3 |     false    |
++--------------+--------------+
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/matt-harvey/tabulo.
+Issues and pull requests are welcome on GitHub at https://github.com/matt-harvey/tabulo.
+
+To start working on Tabulo, `git clone` and `cd` into your fork of the repo, then run `bin/setup` to
+install dependencies.
+
+`bin/console` will give you an interactive prompt that will allow you to experiment; and `rake spec`
+will run the test suite. For a list of other Rake tasks that are available in the development
+environment, run `rake -T`.
 
 ## License
 
@@ -448,9 +503,13 @@ The gem is available as open source under the terms of the [MIT
 License](http://opensource.org/licenses/MIT).
 
 [Gem Version]: https://rubygems.org/gems/tabulo
+[Documentation]: http://www.rubydoc.info/gems/tabulo/1.2.2
 [Build Status]: https://travis-ci.org/matt-harvey/tabulo
 [Coverage Status]: https://coveralls.io/r/matt-harvey/tabulo
+[Code Climate]: https://codeclimate.com/github/matt-harvey/tabulo
 
-[GV img]: https://img.shields.io/gem/v/tabulo.svg?style=plastic
-[BS img]: https://img.shields.io/travis/matt-harvey/tabulo.svg?style=plastic
-[CS img]: https://img.shields.io/coveralls/matt-harvey/tabulo.svg?style=plastic
+[GV img]: https://img.shields.io/gem/v/tabulo.svg
+[DC img]: https://img.shields.io/badge/documentation-v1.2.2-blue.svg
+[BS img]: https://img.shields.io/travis/matt-harvey/tabulo.svg
+[CS img]: https://img.shields.io/coveralls/matt-harvey/tabulo.svg
+[CC img]: https://codeclimate.com/github/matt-harvey/tabulo/badges/gpa.svg

data/VERSION

@@ -1 +1 @@
-1.2.1
+1.2.2

data/lib/tabulo/table.rb

@@ -237,9 +237,7 @@ module Tabulo
       return self if column_registry.none?
       columns = column_registry.values
 
-      columns.each do |column|
-        column.width = wrapped_width(column.header)
-      end
+      columns.each { |column| column.width = wrapped_width(column.header) }
 
       @sources.each do |source|
         columns.each do |column|

data/lib/tabulo/version.rb

@@ -1,3 +1,3 @@
 module Tabulo
-  VERSION = "1.2.1"
+  VERSION = "1.2.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tabulo
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Matthew Harvey
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-17 00:00:00.000000000 Z
+date: 2019-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler