tabulo 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5b182912c5f405049dd0098da2154e460ac625bb
-  data.tar.gz: 7cbae37e2ce3779cd6ff70803392cdb21aae1358
+SHA256:
+  metadata.gz: 8583d9f66b9305bb91dc45079567e811c60e839389c468ac963b2e49d1edc6a1
+  data.tar.gz: f89afda08a128532f113a7d36f1941ed638d745c7addf5761f068865eadbcdaa
 SHA512:
-  metadata.gz: 929a1aa6ad4a46837e0d916dd67bfd6d01b664d214f9533bcf2d8c82da4509d17e2f220b02d9353f95d558e07e9908b62e97f18dbb86440242a8f1c36c89d587
-  data.tar.gz: 449cea43dd183067878f3417729c18144dfd7a8e2016048b68b197e6d4bf936dfbf5a558e2e68453924fc6cadc9818e5388c2392474a5d91a26a933af7ea5d44
+  metadata.gz: 0c0f4a420b0dfd4624afaa857f2ba03c28e5decab3c1fcb867b40662d277f8071a6c75a22b7f9bb72adf7595bbd8e6616a4103be1c92fee5e228e2bdacff07f7
+  data.tar.gz: 86b81698a9bfa003ed01f80a314e0bf4c0c55569152ef326ef29a73091094c02d844b536e7729fb879bf2225c260d3640687d97d6bc08acf604863b3a08ee083

data/.gitignore

@@ -9,3 +9,4 @@
 /tmp/
 **/.*.swp
 coverage
+gh-md-toc

data/.travis.yml

@@ -2,7 +2,7 @@ sudo: false
 language: ruby
 rvm:
   - 2.1.10
-  - 2.2.6
-  - 2.3.3
-  - 2.4.0
-before_install: gem install bundler -v 1.16.0
+  - 2.2.10
+  - 2.3.8
+  - 2.4.5
+  - 2.5.3

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+### v1.2.1
+
+* Improve documentation in README.
+* Update Travis config.
+* Change homepage in Gemspec
+
 ### v1.2.0
 
 * Allow customization of padding.

data/README.md

@@ -6,11 +6,13 @@
 
 ## Overview
 
-Tabulo generates ASCII tables.
+Tabulo is a Ruby library for generating ASCII tables.
 
 ```ruby
-table = Tabulo::Table.new([1, 2, 50000000]) do |t|
-  t.add_column("N", &:itself)
+underyling_enumerable = [1, 2, 50000000] # need not be an array
+
+table = Tabulo::Table.new(underlying_enumerable) do |t|
+  t.add_column("N") { |n| n }
   t.add_column("Doubled") { |n| n * 2 }
 end
 ```
@@ -27,6 +29,8 @@ 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
   [truncate](#overflow-handling) the overflow.
 * Alternatively, [shrinkwrap](#shrinkwrap) the table so that each column is just wide enough for its contents.
@@ -38,7 +42,33 @@ end
 * Newlines within cell content are correctly handled.
 * A `Tabulo::Table` is an `Enumerable`, so you can [step through it](#enumerator) a row at a time,
   printing as you go, without waiting for the entire underlying collection to load.
-* Each `Tabulo::Row` is also an `Enumerable`, providing access to the underlying cell values.
+* 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.
+
+Tabulo has also been ported to Crystal (with some modifications): see [Tablo](https://github.com/hutou/tablo).
+
+## Table of Contents
+
+  * [Overview](#overview)
+  * [Features](#features)
+  * [Table of Contents](#table-of-contents)
+  * [Installation](#installation)
+  * [Detailed usage](#detailed-usage)
+     * [Requiring the gem](#requiring-the-gem)
+     * [Configuring columns](#configuring-columns)
+     * [Cell alignment](#cell-alignment)
+     * [Column width, wrapping and truncation](#column-width-wrapping-and-truncation)
+        * [Configuring fixed widths](#configuring-fixed-widths)
+        * [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)
+     * [Additional configuration options](#additional-configuration-options)
+  * [Development](#development)
+  * [Contributing](#contributing)
+  * [License](#license)
 
 ## Installation
 
@@ -378,6 +408,21 @@ underlying collection. (This is negated if we [shrinkwrap](#shrinkwrap) the tabl
 in that case the entire collection must be traversed up front in order for column widths to be
 calculated.)
 
+<a name="accessing-cell-values"></a>
+### Accessing cell values
+Each `Tabulo::Table` is an `Enumerable` of which each element is a `Tabulo::Row`. Each `Tabulo::Row`
+is itself an `Enumerable` comprising the underlying the values of each cell. A `Tabulo::Row` can
+also be converted to a `Hash` for keyed access. For example:
+
+```ruby
+table = Tabulo::Table.new(1..5, columns: %i[itself even? odd?])
+
+table.each do |row|
+  row.each { |cell| puts cell } # 1...2...3...4...5
+  puts row.to_h[:even?]         # false...true...false...true...false
+end
+```
+
 ### Additional configuration options
 
 The characters used for horizontal dividers, vertical dividers and corners, which default to `-`,

data/Rakefile

@@ -1,6 +1,6 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
-require 'rake-version'
+require "rake-version"
 
 RSpec::Core::RakeTask.new(:spec)
 

data/VERSION

@@ -1 +1 @@
-1.2.0
+1.2.1

data/lib/tabulo/version.rb

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

data/tabulo.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = "Enumerable ASCII table"
   spec.description   = "Enumerable ASCII table"
-  spec.homepage      = "https://matt-harvey.github.io/tabulo"
+  spec.homepage      = "https://github.com/matt-harvey/tabulo"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
     "changelog_uri"   => "https://raw.githubusercontent.com/matt-harvey/tabulo/master/CHANGELOG.md"
   }
 
-  spec.add_development_dependency "bundler", "~> 1.16.0"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", "~> 11.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "simplecov"

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: tabulo
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Matthew Harvey
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-16 00:00:00.000000000 Z
+date: 2019-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.16.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.16.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -165,7 +165,7 @@ files:
 - lib/tabulo/table.rb
 - lib/tabulo/version.rb
 - tabulo.gemspec
-homepage: https://matt-harvey.github.io/tabulo
+homepage: https://github.com/matt-harvey/tabulo
 licenses:
 - MIT
 metadata:
@@ -187,7 +187,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Enumerable ASCII table