tabulo 1.5.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: edb6043945662b09cf500a65acec2fa51eac9c9397e7c58a890379bc174424cd
-  data.tar.gz: f7866a1ac405b431752ccba6a81678c9533b245384290c913bb015267ff8f7cd
+  metadata.gz: fdbbbcb7f1eb925be546ddb8b798f2c2aa949e737aa221018cfffeb25352458a
+  data.tar.gz: 6960e851a8086dc345d4f4db2d3867893b4a0772c748336b2341dd22f9c862be
 SHA512:
-  metadata.gz: e67b0006b767a5dbe884bad9296636a01e1d5bdc57c6ffd2689f9315a9465e899e79e74508e2ae7c83c37869bfb3a523931accd2e5d6db346e104794a6c844ec
-  data.tar.gz: 663b95287868f59f2c29f75564cb660b5c1b2462984f351d6abd6ff057228fd1f8af5a3c7a99d68ed99740b90a493fe18bd9e4a7228f45dc312c929aeb7308a3
+  metadata.gz: b4488086be31ac7f659110c3f55c1a6ecce1ccfa59406ba165490622b86167bc61a666a3c42d4ae8c12a5ad4975141ea418242bcd971a4930fbc75a991797cc4
+  data.tar.gz: 1de32be32999408268de863e94c79fed536e6844a658f135288c4469c8081d3bce7461c90ef809d67f9a2cf5a1fd6c36f323da4c64a40d20d2fff336bf65d2eb

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+### v1.5.1
+
+* Dependency version upgrades
+* Minor documentation fixes
+
 ### v1.5.0
 
 * Support use of ANSI escape sequences to add colours and

data/README.md

@@ -87,7 +87,7 @@ Tabulo has also been ported to Crystal (with some modifications): see [Tablo](ht
         * [Automating column widths](#automating-column-widths)
         * [Overflow handling](#overflow-handling)
      * [Formatting cell values](#formatting-cell-values)
-     * [Colours and stying[(#colours-and-styling)
+     * [Colours and styling](#colours-and-styling)
      * [Repeating headers](#repeating-headers)
      * [Using a Table Enumerator](#using-a-table-enumerator)
      * [Accessing cell values](#accessing-cell-values)
@@ -405,13 +405,11 @@ the underlying value of that cell, not its formatted value.
 <a name="colours-and-styling"></a>
 ### Colours and styling
 
-In most terminals, if you want print text that is coloured, or has other styles
-such as underlining, you need to use ANSI escape sequences, either directly, or by means of a library
-such as [Rainbow](http://github.com/sickill/rainbow) that uses them under the hood. When added
-to a string, ANSI escape codes increase a string's length without increasing the width
-it visually occupies in the terminal. So that Tabulo can perform the width calculations required to
-render the table correctly, the `styler` option should be passed to `add_column` to apply colours
-or other styling that require escape sequences.
+In most terminals, if you want to print text that is coloured, or has certain other styles such as
+underlining, you need to use ANSI escape sequences, either directly, or by means of a library such
+as [Rainbow](http://github.com/sickill/rainbow) that uses them internally. Tabulo needs to properly
+account for escape sequences when performing the width calculations required to render tables.
+The `styler` option on the `add_column` method is intended to facilitate this.
 
 For example, suppose you have a table to which you want to add a column that
 displays `true` in green if a given number is even, or else displays `false` in red.
@@ -420,7 +418,7 @@ You can achieve this as follows using raw ANSI escape codes:
 ```ruby
 table.add_column(
   :even?,
-  styler: -> (n, s) { n.even? ? "\033[32m#{s}\033[0m" : "\033[31m#{s}\033[0m" }
+  styler: -> (cell_value, s) { cell_value ? "\033[32m#{s}\033[0m" : "\033[31m#{s}\033[0m" }
 )
 ```
 
@@ -434,17 +432,17 @@ require "rainbow"
 
 table.add_column(
   :even?,
-  styler: -> (n, s) { n.even? ? Rainbow(s).red : Rainbow(s).green }
+  styler: -> (cell_value, s) { cell_value ? Rainbow(s).green : Rainbow(s).red }
 )
 ```
 
 The `styler` option should be passed a callable that takes two parameters: the
-first represents the element of the underlying enumerable for a given table
-row; and the second the represents formatted string value of that cell, i.e. the
-cell content after any processing by the [formatter](#formatting-cell-values) (if any).
+first represents the content of the cell (in this case a boolean indicating whether the
+number is even); and the second represents the formatted string value of that cell, i.e. the
+cell content after any processing by the [formatter](#formatting-cell-values).
 If the content of a cell is wrapped over multiple lines, then the `styler` will be called
 once per line, so that each line of the cell will have the escape sequence applied to it
-separately (ensuring the stying doesn't bleed into neighbouring cells).
+separately (ensuring the styling doesn't bleed into neighbouring cells).
 
 If you want to apply colours or other styling to the content of a column header, as opposed
 to cells in the table body, use the `header_styler` option, e.g.:
@@ -623,7 +621,7 @@ a new table in which the rows and columns are swapped:
 By default, a header row is added to the new table, showing the string value of the element
 represented in that column. This can be configured, however, along with other aspects of
 `transpose`'s behaviour. For details, see the
-[documentation](https://www.rubydoc.info/gems/tabulo/1.5.0/Tabulo/Table#transpose-instance_method).
+[documentation](https://www.rubydoc.info/gems/tabulo/1.5.1/Tabulo/Table#transpose-instance_method).
 
 <a name="additional-configuration-options"></a>
 ### Additional configuration options
@@ -764,14 +762,14 @@ 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.5.0
+[Documentation]: http://www.rubydoc.info/gems/tabulo/1.5.1
 [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
 [Awesome Ruby]: https://github.com/markets/awesome-ruby#cli-utilities
 
 [GV img]: https://img.shields.io/gem/v/tabulo.svg
-[DC img]: https://img.shields.io/badge/documentation-v1.5.0-blue.svg
+[DC img]: https://img.shields.io/badge/documentation-v1.5.1-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.5.0
+1.5.1

data/lib/tabulo/version.rb

@@ -1,3 +1,3 @@
 module Tabulo
-  VERSION = "1.5.0"
+  VERSION = "1.5.1"
 end

data/tabulo.gemspec

@@ -28,8 +28,8 @@ Gem::Specification.new do |spec|
     "changelog_uri"   => "https://raw.githubusercontent.com/matt-harvey/tabulo/master/CHANGELOG.md"
   }
 
-  spec.add_runtime_dependency "tty-screen", "0.6.5"
-  spec.add_runtime_dependency "unicode-display_width", "1.5.0"
+  spec.add_runtime_dependency "tty-screen", "0.7.0"
+  spec.add_runtime_dependency "unicode-display_width", "1.6.0"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", "~> 11.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tabulo
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.5.1
 platform: ruby
 authors:
 - Matthew Harvey
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-02 00:00:00.000000000 Z
+date: 2019-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tty-screen
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.6.5
+        version: 0.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.6.5
+        version: 0.7.0
 - !ruby/object:Gem::Dependency
   name: unicode-display_width
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 1.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 1.6.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement