tabulo 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 33261a1329d456e8dd354fe214a9d437c718be38
-  data.tar.gz: 209b8bc48027f4f999892e9d9e843cdef657c48a
+  metadata.gz: 5b182912c5f405049dd0098da2154e460ac625bb
+  data.tar.gz: 7cbae37e2ce3779cd6ff70803392cdb21aae1358
 SHA512:
-  metadata.gz: 6052a5c65b3429cd89075fa5b4b646166dde567724d983bd96eb8fab4fdfcdf6abde7a683ed29b67d19667374d757de5a207f7a1432f02116a690cdd68acbe8f
-  data.tar.gz: 0e5794904aa0d3ffc53239a5167b477c5695532eed749f59b11437e20f16e6693126a53dd7fc181dcb372f3997dfdd128311e199d3a444e13b6468249523fa16
+  metadata.gz: 929a1aa6ad4a46837e0d916dd67bfd6d01b664d214f9533bcf2d8c82da4509d17e2f220b02d9353f95d558e07e9908b62e97f18dbb86440242a8f1c36c89d587
+  data.tar.gz: 449cea43dd183067878f3417729c18144dfd7a8e2016048b68b197e6d4bf936dfbf5a558e2e68453924fc6cadc9818e5388c2392474a5d91a26a933af7ea5d44

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+### v1.2.0
+
+* Allow customization of padding.
+
 ### v1.1.0
 
 * Allow customization of horizontal divider, vertical divider and intersection characters.

data/README.md

@@ -3,7 +3,6 @@
 [![Gem Version][GV img]][Gem Version]
 [![Coverage Status][CS img]][Coverage Status]
 [![Build Status][BS img]][Build Status]
-[![Documentation][DC img]][Documentation]
 
 ## Overview
 
@@ -173,6 +172,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.
+The amount of this padding can be configured for the table as a whole, using the `column_padding`
+option passed to `Table.new`.
+
 <a name="shrinkwrap"></a>
 #### Automating column widths
 
@@ -375,6 +378,15 @@ 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.)
 
+### Additional configuration options
+
+The characters used for horizontal dividers, vertical dividers and corners, which default to `-`,
+`|` and `+` respectively, can be configured using the using the `horizontal_rule_character`,
+`vertical_rule_character` and `intersection_character` options passed to `Table.new`.
+
+The character used to indicate truncation, which defaults to `~`, can be configured using the
+`truncation_indicator` option passed to `Table.new`.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run
@@ -393,9 +405,7 @@ License](http://opensource.org/licenses/MIT).
 [Gem Version]: https://rubygems.org/gems/tabulo
 [Build Status]: https://travis-ci.org/matt-harvey/tabulo
 [Coverage Status]: https://coveralls.io/r/matt-harvey/tabulo
-[Documentation]: http://www.rubydoc.info/gems/tabulo/1.1.0
 
 [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
-[DC img]: https://img.shields.io/badge/docs-v1.1.0-blue.svg?style=plastic

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.2.0

data/lib/tabulo/table.rb

@@ -9,6 +9,9 @@ module Tabulo
     # @!visibility public
     DEFAULT_COLUMN_WIDTH = 12
 
+    # @!visibility public
+    DEFAULT_COLUMN_PADDING = 1
+
     # @!visibility public
     DEFAULT_HORIZONTAL_RULE_CHARACTER = "-"
 
@@ -65,11 +68,13 @@ module Tabulo
     #   cell's content has been truncated. If omitted or passed <tt>nil</tt>,
     #   defaults to {DEFAULT_TRUNCATION_INDICATOR}. If passed something other than <tt>nil</tt> or
     #   a single-character String, raises {InvalidTruncationIndicatorError}.
+    # @param [nil, Integer] column_padding Determines the amount of blank space with which to pad either
+    #   of each column. Defaults to 1.
     # @return [Table] a new Table
     # @raise [InvalidColumnLabelError] if non-unique Symbols are provided to columns.
     # @raise [InvalidHorizontalRuleCharacterError] if invalid argument passed to horizontal_rule_character.
     # @raise [InvalidVerticalRuleCharacterError] if invalid argument passed to vertical_rule_character.
-    def initialize(sources, columns: [], column_width: nil, header_frequency: :start,
+    def initialize(sources, columns: [], column_width: nil, column_padding: nil, header_frequency: :start,
       wrap_header_cells_to: nil, wrap_body_cells_to: nil, horizontal_rule_character: nil,
       vertical_rule_character: nil, intersection_character: nil, truncation_indicator: nil)
 
@@ -78,6 +83,7 @@ module Tabulo
       @wrap_header_cells_to = wrap_header_cells_to
       @wrap_body_cells_to = wrap_body_cells_to
       @default_column_width = (column_width || DEFAULT_COLUMN_WIDTH)
+      @column_padding = (column_padding || DEFAULT_COLUMN_PADDING)
 
       @horizontal_rule_character = validate_character(horizontal_rule_character,
         DEFAULT_HORIZONTAL_RULE_CHARACTER, InvalidHorizontalRuleCharacterError, "horizontal rule character")
@@ -196,7 +202,7 @@ module Tabulo
     #
     def horizontal_rule
       inner = column_registry.map do |_, column|
-        @horizontal_rule_character * (column.width + 2)
+        @horizontal_rule_character * (column.width + @column_padding * 2)
       end
       surround_join(inner, @intersection_character)
     end
@@ -244,7 +250,7 @@ module Tabulo
 
       if max_table_width
         total_columns_width = columns.inject(0) { |sum, column| sum + column.width }
-        total_padding = column_registry.count * 2
+        total_padding = column_registry.count * @column_padding * 2
         total_borders = column_registry.count + 1
         unadjusted_table_width = total_columns_width + total_padding + total_borders
 
@@ -307,8 +313,13 @@ module Tabulo
           cell_truncated = (num_subcells > row_height)
           append_truncator = (cell_truncated && subrow_index + 1 == row_height)
 
-          lpad = PADDING_CHARACTER
-          rpad = (append_truncator ? @truncation_indicator : PADDING_CHARACTER)
+          lpad = PADDING_CHARACTER * @column_padding
+          rpad =
+            if append_truncator && @column_padding != 0
+              @truncation_indicator + PADDING_CHARACTER * (@column_padding - 1)
+            else
+              PADDING_CHARACTER * @column_padding
+            end
 
           inner =
             if subrow_index < num_subcells

data/lib/tabulo/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tabulo
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Matthew Harvey
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-14 00:00:00.000000000 Z
+date: 2018-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler