tabulo 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb96e6f0dd6059d898a0bce0d60b8d97cc3c08fc
-  data.tar.gz: 84e67bf09c8e7058789bacecaabace6c1b0fa4af
+  metadata.gz: 33261a1329d456e8dd354fe214a9d437c718be38
+  data.tar.gz: 209b8bc48027f4f999892e9d9e843cdef657c48a
 SHA512:
-  metadata.gz: 2eff9dc5e7a946ea6b0ed95e5ddff7f987c39c8308ed3199447c8c0f1ad21f1f1d4ff4af7ffe0df35cf6167d2729f4c5f4ba04b62d28e37516ea71e6bee8fc3a
-  data.tar.gz: 1ca3aeeba0dd8333ca398b1245dea596e93d0b4cd11cb4f013a56d2f7dbb9d9aaba330829e16ad1b1c77419c6b1862a7da71be0082f758ff27fc4b41e1804b2f
+  metadata.gz: 6052a5c65b3429cd89075fa5b4b646166dde567724d983bd96eb8fab4fdfcdf6abde7a683ed29b67d19667374d757de5a207f7a1432f02116a690cdd68acbe8f
+  data.tar.gz: 0e5794904aa0d3ffc53239a5167b477c5695532eed749f59b11437e20f16e6693126a53dd7fc181dcb372f3997dfdd128311e199d3a444e13b6468249523fa16

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+### v1.1.0
+
+* Allow customization of horizontal divider, vertical divider and intersection characters.
+
 ### v1.0.1
 
 * Fix deprecation warnings.

data/README.md

@@ -1,7 +1,6 @@
 # Tabulo
 
 [![Gem Version][GV img]][Gem Version]
-[![Dependency Status][DS img]][Dependency Status]
 [![Coverage Status][CS img]][Coverage Status]
 [![Build Status][BS img]][Build Status]
 [![Documentation][DC img]][Documentation]
@@ -393,12 +392,10 @@ License](http://opensource.org/licenses/MIT).
 
 [Gem Version]: https://rubygems.org/gems/tabulo
 [Build Status]: https://travis-ci.org/matt-harvey/tabulo
-[Dependency Status]: https://gemnasium.com/matt-harvey/tabulo
 [Coverage Status]: https://coveralls.io/r/matt-harvey/tabulo
-[Documentation]: http://www.rubydoc.info/gems/tabulo/1.0.1
+[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
-[DS img]: https://img.shields.io/gemnasium/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.0.1-blue.svg?style=plastic
+[DC img]: https://img.shields.io/badge/docs-v1.1.0-blue.svg?style=plastic

data/VERSION

@@ -1 +1 @@
-1.0.1
+1.1.0

data/lib/tabulo/column.rb

@@ -7,7 +7,6 @@ module Tabulo
     attr_reader :header
 
     def initialize(header:, width:, align_header:, align_body:, formatter:, extractor:)
-
       @header = header
       @width = width
       @align_header = align_header
@@ -20,10 +19,6 @@ module Tabulo
       infilled_subcells(@header, @align_header)
     end
 
-    def horizontal_rule
-      Table::HORIZONTAL_RULE_CHARACTER * width
-    end
-
     def body_subcells(source)
       cell_datum = body_cell_value(source)
       formatted_content = @formatter.call(cell_datum)

data/lib/tabulo/exceptions.rb

@@ -2,4 +2,20 @@ module Tabulo
 
   # Error indicating that the label of a column is invalid.
   class InvalidColumnLabelError < StandardError; end
+
+  # Error indicating that an attempt was made to use an invalid horizontal rule character
+  # for the table.
+  class InvalidHorizontalRuleCharacterError < StandardError; end
+
+  # Error indicating that an attempt was made to use an invalid vertical rule character
+  # for the table.
+  class InvalidVerticalRuleCharacterError < StandardError; end
+
+  # Error indicating that an attempt was made to use an invalid intersection character for
+  # the table.
+  class InvalidIntersectionCharacterError < StandardError; end
+
+  # Error indicating that an attempt was made to use an invalid truncation indicator for
+  # the table.
+  class InvalidTruncationIndicatorError < StandardError; end
 end

data/lib/tabulo/table.rb

@@ -6,23 +6,23 @@ module Tabulo
   class Table
     include Enumerable
 
-    # @!visibility private
+    # @!visibility public
     DEFAULT_COLUMN_WIDTH = 12
 
-    # @!visibility private
-    HORIZONTAL_RULE_CHARACTER = "-"
+    # @!visibility public
+    DEFAULT_HORIZONTAL_RULE_CHARACTER = "-"
 
-    # @!visibility private
-    VERTICAL_RULE_CHARACTER = "|"
+    # @!visibility public
+    DEFAULT_VERTICAL_RULE_CHARACTER = "|"
 
-    # @!visibility private
-    CORNER_CHARACTER = "+"
+    # @!visibility public
+    DEFAULT_INTERSECTION_CHARACTER = "+"
 
-    # @!visibility private
-    PADDING_CHARACTER = " "
+    # @!visibility public
+    DEFAULT_TRUNCATION_INDICATOR = "~"
 
     # @!visibility private
-    TRUNCATION_INDICATOR = "~"
+    PADDING_CHARACTER = " "
 
     # @!visibility private
     attr_reader :column_registry
@@ -33,7 +33,7 @@ module Tabulo
     #   created by calling the corresponding method on each element of sources. Note
     #   the {#add_column} method is a much more flexible way to set up columns on the table.
     # @param [Integer, nil] column_width The default column width for columns in this
-    #   table, not excluding padding. If nil, then DEFAULT_COLUMN_WIDTH will be used.
+    #   table, not excluding padding. If <tt>nil</tt>, then {DEFAULT_COLUMN_WIDTH} will be used.
     # @param [:start, nil, Integer] header_frequency Controls the display of column headers.
     #   If passed <tt>:start</tt>, headers will be shown at the top of the table only. If passed <tt>nil</tt>,
     #   headers will not be shown. If passed an Integer N (> 0), headers will be shown at the top of the table,
@@ -46,18 +46,48 @@ module Tabulo
     #   headers), if their content is longer than the column's fixed width. If passed <tt>nil</tt>, content will
     #   be wrapped for as many rows as required to accommodate it. If passed an Integer N (> 0), content will be
     #   wrapped up to N rows and then truncated thereafter.
+    #   headers), if their content is longer than the column's fixed width. If passed <tt>nil</tt>, content will
+    #   be wrapped for as many rows as required to accommodate it. If passed an Integer N (> 0), content will be
+    #   wrapped up to N rows and then truncated thereafter.
+    # @param [nil, String] horizontal_rule_character Determines the character used to draw
+    #   horizontal lines where required in the table. If omitted or passed <tt>nil</tt>, defaults to
+    #   {DEFAULT_HORIZONTAL_RULE_CHARACTER}. If passed something other than <tt>nil</tt> or a single-character
+    #   String, raises {InvalidHorizontalRuleCharacterError}.
+    # @param [nil, String] vertical_rule_character Determines the character used to draw
+    #   vertical lines where required in the table. If omitted or passed <tt>nil</tt>, defaults to
+    #   {DEFAULT_VERTICAL_RULE_CHARACTER}. If passed something other than <tt>nil</tt> or a single-character
+    #   String, raises {InvalidVerticalRuleCharacterError}.
+    # @param [nil, String] intersection_character Determines the character used to draw
+    #   line intersections and corners where required in the table. If omitted or passed <tt>nil</tt>,
+    #   defaults to {DEFAULT_INTERSECTION_CHARACTER}. If passed something other than <tt>nil</tt> or
+    #   a single-character String, raises {InvalidIntersectionCharacterError}.
+    # @param [nil, String] truncation_indicator Determines the character used to indicate that a
+    #   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}.
     # @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,
-      wrap_header_cells_to: nil, wrap_body_cells_to: nil)
+      wrap_header_cells_to: nil, wrap_body_cells_to: nil, horizontal_rule_character: nil,
+      vertical_rule_character: nil, intersection_character: nil, truncation_indicator: nil)
 
       @sources = sources
       @header_frequency = header_frequency
       @wrap_header_cells_to = wrap_header_cells_to
       @wrap_body_cells_to = wrap_body_cells_to
-
       @default_column_width = (column_width || DEFAULT_COLUMN_WIDTH)
 
+      @horizontal_rule_character = validate_character(horizontal_rule_character,
+        DEFAULT_HORIZONTAL_RULE_CHARACTER, InvalidHorizontalRuleCharacterError, "horizontal rule character")
+      @vertical_rule_character = validate_character(vertical_rule_character,
+        DEFAULT_VERTICAL_RULE_CHARACTER, InvalidVerticalRuleCharacterError, "vertical rule character")
+      @intersection_character = validate_character(intersection_character,
+        DEFAULT_INTERSECTION_CHARACTER, InvalidIntersectionCharacterError, "intersection character")
+      @truncation_indicator = validate_character(truncation_indicator,
+        DEFAULT_TRUNCATION_INDICATOR, InvalidTruncationIndicatorError, "truncation indicator")
+
       @column_registry = { }
       columns.each { |item| add_column(item) }
 
@@ -166,9 +196,9 @@ module Tabulo
     #
     def horizontal_rule
       inner = column_registry.map do |_, column|
-        surround(column.horizontal_rule, HORIZONTAL_RULE_CHARACTER)
+        @horizontal_rule_character * (column.width + 2)
       end
-      surround_join(inner, CORNER_CHARACTER)
+      surround_join(inner, @intersection_character)
     end
 
     # Reset all the column widths so that each column is *just* wide enough to accommodate
@@ -278,7 +308,7 @@ module Tabulo
           append_truncator = (cell_truncated && subrow_index + 1 == row_height)
 
           lpad = PADDING_CHARACTER
-          rpad = (append_truncator ? TRUNCATION_INDICATOR : PADDING_CHARACTER)
+          rpad = (append_truncator ? @truncation_indicator : PADDING_CHARACTER)
 
           inner =
             if subrow_index < num_subcells
@@ -290,7 +320,7 @@ module Tabulo
           "#{lpad}#{inner}#{rpad}"
         end
 
-        surround_join(subrow_components, VERTICAL_RULE_CHARACTER)
+        surround_join(subrow_components, @vertical_rule_character)
       end
 
       join_lines(subrows)
@@ -311,6 +341,21 @@ module Tabulo
       lines.join($/)  # join strings with cross-platform newline
     end
 
+    # @!visibility private
+    def validate_character(character, default, exception_class, message_fragment)
+      case (c = (character || default))
+      when nil
+        ; # do nothing
+      when String
+        if c.length != 1
+          raise exception_class, "#{message_fragment} is neither nil nor a single-character String"
+        end
+      else
+        raise exception_class, "#{message_fragment} is neither nil nor a single-character String"
+      end
+      c
+    end
+
     # @!visibility private
     # @return [Integer] the length of the longest segment of str when split by newlines
     def wrapped_width(str)

data/lib/tabulo/version.rb

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

data/tabulo.gemspec

@@ -23,6 +23,11 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 2.1.10"
 
+  spec.metadata = {
+    "source_code_uri" => "https://github.com/matt-harvey/tabulo",
+    "changelog_uri"   => "https://raw.githubusercontent.com/matt-harvey/tabulo/master/CHANGELOG.md"
+  }
+
   spec.add_development_dependency "bundler", "~> 1.16.0"
   spec.add_development_dependency "rake", "~> 11.0"
   spec.add_development_dependency "rspec", "~> 3.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tabulo
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Matthew Harvey
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-13 00:00:00.000000000 Z
+date: 2018-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -168,7 +168,9 @@ files:
 homepage: https://matt-harvey.github.io/tabulo
 licenses:
 - MIT
-metadata: {}
+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: 
 rdoc_options: []
 require_paths: