tabulo 2.7.0 → 2.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 632d2d2d3b7d0120410d0afd2b8f1d1b341fd1b6daa7802b15b6f791640d409e
-  data.tar.gz: f5720b528f1c4384118196619ea923b317ec3ff7d374fa87d79808361031e7cc
+  metadata.gz: 63054578d0f667075a8e2888d3fc0a2572ec9b8a93e3f74468f058613a7c2f19
+  data.tar.gz: 3d0b8bad1b9ad7fa2949037ec6de683f7b43c7ecc73ca02c53bbb14f926139fe
 SHA512:
-  metadata.gz: 283e3ac39971cfdf9df9968fe0e40b00d049865fe7f49ef0403d71e35ea8f49a43d85579cb9f12d080e0bacafa48c943d2e57176309be99809272983cd9db2d7
-  data.tar.gz: 32256e95de32d81a65d64e49a6f1eb42c33d7ccca2c76a5d6ce5cb6d0beee8c9d5588aa6d5df2c68a59ac8805e5b5048851a0959ddf281eaf891771ee162158c
+  metadata.gz: d8626993288417bdd75b581819ea4ef9ef79bfcdfb5d18e7469ac2699e303096405f6155b690a289f5bbc27a8235cc80fb4cb0ad8e62146c664f198fefce9a7e
+  data.tar.gz: 9a306fb542677778f3e6998ee83352f87802bf6d07b422846b61d1fe42acdd8b40a914daa87a10e5abe2f84e6d4b8cd5ddc5711e49d9b5d066113b167b4cf4a9

data/.github/workflows/tests.yml

@@ -23,9 +23,9 @@ jobs:
           '2.3.8',
           '2.4.10',
           '2.5.9',
-          '2.6.7',
-          '2.7.3',
-          '3.0.1',
+          '2.6.8',
+          '2.7.4',
+          '3.0.2',
         ]
     steps:
     - uses: actions/checkout@v2

data/.gitignore

@@ -10,3 +10,4 @@
 **/.*.swp
 coverage
 gh-md-toc
+.ruby-version

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+### v2.7.1
+
+* Dependency version upgrades
+* Minor documentation improvements and tweaks
+
 ### v2.7.0
 
 * Add `wrap_preserve` option, allowing whole words to be preserved when wrapping.

data/README.md

@@ -4,7 +4,6 @@
 [![Documentation][DC img]][Documentation]
 [![Build Status][BS img]][Build Status]
 [![Coverage Status][CS img]][Coverage Status]
-[![Code Climate][CC img]][Code Climate]
 [![Awesome][AR img]][Awesome Ruby]
 
 Tabulo is a Ruby library for generating plain text tables (also known as “terminal tables”
@@ -85,6 +84,7 @@ Tabulo has also been ported to Crystal (with some modifications): see [Tablo](ht
         * [Full API](#quick-api)
         * [Column labels _vs_ headers](#labels-headers)
         * [Positioning columns](#column-positioning)
+        * [Extracting column content from a hash or array](#from-arrays-hashes)
      * [Removing columns](#removing-columns)
      * [Adding a title](#title)
      * [Cell alignment](#cell-alignment)
@@ -93,6 +93,7 @@ Tabulo has also been ported to Crystal (with some modifications): see [Tablo](ht
         * [Automating column widths](#automating-column-widths)
         * [Configuring padding](#configuring-padding)
         * [Overflow handling](#overflow-handling)
+        * [Wrapping at word boundaries](#preserve-words)
         * [Manual cell wrapping](#manual-wrapping)
      * [Formatting cell values](#formatting-cell-values)
      * [Colours and other styling](#colours-and-styling)
@@ -281,6 +282,69 @@ table.add_column(:even?, before: :odd?)
 +--------------+--------------+--------------+
 ```
 
+<a name="from-arrays-hashes"></a>
+#### Extracting column content from a hash or array [&#x2191;](#contents)
+
+Sometimes the data source for the table may be a collection of hashes or arrays. For example:
+
+```ruby
+data = [
+  { english: "hello", portuguese: "bom dia" },
+  { english: "goodbye", portuguese: "adeus" },
+]
+```
+
+or
+
+```ruby
+data = [
+  ["hello", "bom dia"],
+  ["goodbye", "adeus"],
+]
+```
+
+To tabulate such a collection, simply use the same mechanism as described above, passing a block to
+the `add_column` method to tell Tabulo how to extract the data for each column from a row. For
+example, to tabulate the first example above, you could do something like this:
+
+```ruby
+table = Tabulo::Table.new(data) do |t|
+  t.add_column("English") { |h| h[:english] }
+  t.add_column("Portuguese") { |h| h[:portuguese] }
+end
+
+puts table
+```
+
+For the second example, you could do the following:
+
+```ruby
+table = Tabulo::Table.new(data) do |t|
+  t.add_column("English") { |a| a[0] }
+  t.add_column("Portuguese") { |a| a[1] }
+end
+
+puts table
+```
+
+In both cases, the output will be as follows:
+
+```
++--------------+--------------+
+|    English   |  Portuguese  |
++--------------+--------------+
+| hello        | bom dia      |
+| goodbye      | adeus        |
++--------------+--------------+
+```
+
+If you have previously used other terminal tabulation libraries, you may be accustomed to being _required_
+to place your data into an array of hashes or arrays before you can tabulate them. Tabulo, however,
+offers an API that is more general and flexible than this; your data source can be _any_
+enumerable collection (not just an array), and each item in that collection can be _any_ object (not
+necessarily an array or a hash). However, as shown above, it is still straightforward to tabulate an
+array of hashes or arrays, if your data source happens to take that form.
+
 <a name="removing-columns"></a>
 ### Removing columns [&#x2191;](#contents)
 
@@ -729,7 +793,7 @@ the table.
 The `formatter` callback also has an alternative, 2-parameter version. If `formatter` is passed
 a 2-parameter callable, the second parameter will be given a `CellData` instance,
 containing additional information about the cell that may be useful in determining how to format
-it&mdash;see the [documentation](https://www.rubydoc.info/gems/tabulo/2.7.0/Tabulo/CellData.html)
+it&mdash;see the [documentation](https://www.rubydoc.info/gems/tabulo/2.7.1/Tabulo/CellData.html)
 for details.
 
 <a name="colours-and-styling"></a>
@@ -775,7 +839,7 @@ number is even). The second parameter represents the formatted string value of t
 content after any processing by the [formatter](#formatting-cell-values). The third and fourth
 parameters are optional, and contain further information about the cell and its contents that may be useful in
 determining how to style it. See the
-[documentation](https://www.rubydoc.info/gems/tabulo/2.7.0/Tabulo/Table#add_column-instance_method) for details.
+[documentation](https://www.rubydoc.info/gems/tabulo/2.7.1/Tabulo/Table#add_column-instance_method) for details.
 
 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
@@ -795,7 +859,7 @@ table.add_column(:even?, header_styler: -> (s) { "\033[32m#{s}\033[0m" })
 ```
 
 The `header_styler` option accepts a 1-, 2- or 3-parameter callable. See the
-[documentation](https://www.rubydoc.info/gems/tabulo/2.7.0/Tabulo/Table#add_column-instance_method)
+[documentation](https://www.rubydoc.info/gems/tabulo/2.7.1/Tabulo/Table#add_column-instance_method)
 for details.
 
 <a name="styling-title"></a>
@@ -809,7 +873,7 @@ table = Tabulo::Table.new(1..5, :itself, :even?, :odd?, title: "Numbers", title_
 ```
 
 The `title_styler` option accepts a 1- or 2-parameter callable. See the
-[documentation](https://www.rubydoc.info/gems/tabulo/2.7.0/Tabulo/Table#initialize-instance_method)
+[documentation](https://www.rubydoc.info/gems/tabulo/2.7.1/Tabulo/Table#initialize-instance_method)
 for details.
 
 <a name="styling-borders"></a>
@@ -1004,7 +1068,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`&#8217;s behaviour. For details, see the
-[documentation](https://www.rubydoc.info/gems/tabulo/2.7.0/Tabulo/Table#transpose-instance_method).
+[documentation](https://www.rubydoc.info/gems/tabulo/2.7.1/Tabulo/Table#transpose-instance_method).
 
 <a name="borders"></a>
 ### Configuring borders [&#x2191;](#contents)
@@ -1395,15 +1459,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/2.7.0
+[Documentation]: http://www.rubydoc.info/gems/tabulo/2.7.1
 [Build Status]: https://github.com/matt-harvey/tabulo/actions/workflows/tests.yml
 [Coverage Status]: https://coveralls.io/github/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-v2.7.0-blue.svg
+[DC img]: https://img.shields.io/badge/documentation-v2.7.1-blue.svg
 [BS img]: https://github.com/matt-harvey/tabulo/actions/workflows/tests.yml/badge.svg
 [CS img]: https://img.shields.io/coveralls/matt-harvey/tabulo.svg
-[CC img]: https://codeclimate.com/github/matt-harvey/tabulo/badges/gpa.svg
 [AR img]: https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg

data/VERSION

@@ -1 +1 @@
-2.7.0
+2.7.1

data/lib/tabulo/version.rb

@@ -1,3 +1,3 @@
 module Tabulo
-  VERSION = "2.7.0"
+  VERSION = "2.7.1"
 end

data/tabulo.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |spec|
   }
 
   spec.add_runtime_dependency "tty-screen", "0.8.1"
-  spec.add_runtime_dependency "unicode-display_width", "2.0.0"
+  spec.add_runtime_dependency "unicode-display_width", "2.1.0"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", "~> 12.3.3"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tabulo
 version: !ruby/object:Gem::Version
-  version: 2.7.0
+  version: 2.7.1
 platform: ruby
 authors:
 - Matthew Harvey
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-18 00:00:00.000000000 Z
+date: 2021-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tty-screen
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -206,7 +206,7 @@ licenses:
 metadata:
   source_code_uri: https://github.com/matt-harvey/tabulo
   changelog_uri: https://raw.githubusercontent.com/matt-harvey/tabulo/master/CHANGELOG.md
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -221,8 +221,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key:
+rubygems_version: 3.2.29
+signing_key: 
 specification_version: 4
 summary: Terminal table generator
 test_files: []