tabulo 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 719b6855766058c0b5086c8d04f8e85b03532fcd
-  data.tar.gz: ade0250e9e1ae8d136d2863df2a21f8f1efda31e
+  metadata.gz: 8e5af752ebead6db9dfc76f720fe93390e1476d8
+  data.tar.gz: 3aaeac2dcb657193be54534bac8babbad1cb56d7
 SHA512:
-  metadata.gz: ac5a02ca95749e3efcc6209e713b6620aafd416aede395546a45dae337443f932e3f80d7de3084c3f94f8cfed780516892dd54d2a393756a030ccaf6a0eaf8fe
-  data.tar.gz: 446462cb31aa4547245ba05cbda0ba47260c9809f8c4de35d545080a1c0d407d99d3f016cdbf4d34f83331dec7b2526b7debb987ca464bc8b46adeee075761ec
+  metadata.gz: 1227ced88276ad18ac557b66c2bf9db675dba4b9061797c7ddf9432b14c7882eb025b6b126bfa833dd15f92bd6421e42481bed5b858f369ac8c48e811a2da544
+  data.tar.gz: 9f68e39a20c006414d65d0239188df0ae66eb912e9e99de51ea310636d15cf2a9b0038819bbcae39f9b26982ae5f69ddcf1e410efc13cdd2c1d91cb487fbd858

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## v0.4.2
+
+* Improve README.
+* Fix error when printing a Table, or a Row thereof, when the Table doesn't
+  have any columns.
+* Remove unused development dependency on yard-tomdoc.
+* Write more specs.
+
 ## v0.4.1
 
 * Update README to reflect default column width of 12.

data/README.md

@@ -40,8 +40,7 @@ Each `Tabulo::Row` is also an `Enumerable`, which provides access to the underly
 ```ruby
 table.each do |row|
   row.each do |cell|
-    # 1, 2, 50000000...
-    puts cell.class  # Fixnum
+    # cell => 1, 2... 2, 4... etc.
   end
 end
 ```
@@ -138,17 +137,29 @@ the `align_header` or `align_body` options of `add_column`, e.g.:
 ### Column width, wrapping and truncation
 
 By default, column width is fixed at 12 characters, plus 1 character of padding on either side.
-This can be customized using the `width` option of `add_column`:
+This can be adjusted on a column-by-column basis using the `width` option of `add_column`:
 
 ```ruby
-  table.add_column(:even?, width: 5)
+  table = Tabulo::Table.new([1, 2]) do |t|
+    t.add_column(:itself, width: 6)
+    t.add_column(:even?, width: 9)
+  end
+```
+
+```
+> puts table
++--------+-----------+
+| itself |   even?   |
++--------+-----------+
+|      1 |   false   |
+|      2 |    true   |
 ```
 
 If you want to set the default column width for all columns of the table to something other
 than 12, use the `column_width` option when initializing the table:
 
 ```ruby
-  Tabulo::Table.new([1, 2], columns: %i(itself even?), column_width: 6)
+  table = Tabulo::Table.new([1, 2], columns: %i(itself even?), column_width: 6)
 ```
 
 ```
@@ -158,9 +169,9 @@ than 12, use the `column_width` option when initializing the table:
 +--------+--------+
 |      1 |  false |
 |      2 |  true  |
-``` 
+```
 
-The widths set for individual columns will override the default column width for the table.
+Widths set for individual columns always override the default column width for the table.
 
 ### Overflow handling
 
@@ -208,6 +219,40 @@ table = Tabulo::Table.new(
 | abcdefghijkl~|           26 |
 ```
 
+### Formatting cell values
+
+While the callable passed to `add_column` determines the underyling, calculated value in each
+cell of the column, there is a separate concept, of a "formatter", that determines how that value will
+be visually displayed. By default, `.to_s` is called on the underlying cell value to "format"
+it; however, you can format it differently by passing another callable to the `formatter` option
+of `add_column`:
+
+```ruby
+table = Tabulo::Table.new(1..3) do |t|
+  t.add_column("N", &:itself)
+  t.add_column("Reciprocal", formatter: -> (n) { "%.2f" % n }) do |n|
+    1.0 / n
+  end
+end
+```
+
+```
+puts table
++--------------+--------------+
+|       N      |  Reciprocal  |
++--------------+--------------+
+|            1 |         1.00 |
+|            2 |         0.50 |
+|            3 |         0.33 |
+```
+
+Note the numbers in the "Reciprocal" column in this example are still right-aligned, even though
+the callable passed to `formatter` returns a String. Default cell alignment is determined by the type
+of the underlying cell value, not the way it is formatted. This is usually the desired result.
+
+Note also that the item yielded to `.each` for each cell when enumerating over a `Tabulo::Row` is
+the underlying value of that cell, not its formatted value.
+
 ### Repeating headers
 
 By default, headers are only shown once, at the top of the table (`header_frequency: :start`). If
@@ -274,11 +319,6 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 the tests. You can also run `bin/console` for an interactive prompt that will allow you to
 experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new
-version, update the version number in `version.rb`, and then run `bundle exec rake release`, which
-will create a git tag for the version, push git commits and tags, and push the `.gem` file to
-[rubygems.org](https://rubygems.org).
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/matt-harvey/tabulo.

data/TODO.md

@@ -3,7 +3,6 @@
 * Consider incorporating a linter / static analysis tool into the build.
 * Raise an ArgumentError for disallowed arguments and options (this is
   a library!)
-* Document :formatter option in README.
 * Column#initialize should have the same signature as Table#add_column.
 * Handle multiline cell content (i.e. when the calculated cell value
   itself contains a newline).

data/lib/tabulo/row.rb

@@ -31,7 +31,11 @@ module Tabulo
     #   any column headers that appear just above it in the {Table} (depending on where this Row is
     #   in the {Table} and how the {Table} was configured with respect to header frequency).
     def to_s
-      @table.formatted_body_row(@source, with_header: @with_header)
+      if @table.columns.any?
+        @table.formatted_body_row(@source, with_header: @with_header)
+      else
+        ""
+      end
     end
 
     # @return a Hash representation of the {Row}, with column labels acting

data/lib/tabulo/table.rb

@@ -99,7 +99,11 @@ module Tabulo
     # @return [String] a graphical "ASCII" representation of the Table, suitable for
     #   display in a fixed-width font.
     def to_s
-      join_lines(map(&:to_s))
+      if @columns.any?
+        join_lines(map(&:to_s))
+      else
+        ""
+      end
     end
 
     # Calls the given block once for each {Row} in the Table, passing that {Row} as parameter.
@@ -179,7 +183,7 @@ module Tabulo
         end
       end
 
-      subrows = (0...cell_stacks.map(&:size).max).map do |subrow_index|
+      subrows = (0...cell_stacks.map(&:size).max || 1).map do |subrow_index|
         cell_stacks.map.with_index do |cell_stack, column_index|
           if subrow_index < cell_stack.size
             cell_stack[subrow_index]

data/lib/tabulo/version.rb

@@ -1,3 +1,3 @@
 module Tabulo
-  VERSION = "0.4.1"
+  VERSION = "0.4.2"
 end

data/tabulo.gemspec

@@ -29,5 +29,4 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "coveralls"
   spec.add_development_dependency "yard"
-  spec.add_development_dependency "yard-tomdoc"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tabulo
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Matthew Harvey
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-25 00:00:00.000000000 Z
+date: 2017-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,20 +94,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: yard-tomdoc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: Enumerable ASCII table
 email:
 - software@matthewharvey.net