tabulo 2.6.1 → 2.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5bf2b89914117264e5f213553c792d1456d4f5d99ae8afac565ff1dbc069400b
-  data.tar.gz: 6220df7007ae352c400291101f6308f99ad063fe98c5820820da599f674d4a43
+  metadata.gz: dde64a0fb26dfd5b5624fc18d4c442989cf81433371267d2ce52dbcac4137433
+  data.tar.gz: b0bc0295c6bb8fa5bbaf855ede1dc44fea722acfd23f2b74e1db68b36396e5df
 SHA512:
-  metadata.gz: 13228bb55890713cb9483f18d55339dcf7393aff65a7f91383eb9a5d7dce03acd968e09e883ae3f72088e4d543d1bdc962cb38a0c9444cdd1a93482c55f9c354
-  data.tar.gz: e865337603240b4b8456f5b2b7bbb64f660b18acfc4caf0318ef9869f58070801da24bbdd7de740133a6ef386d5c6c02ee198098605fb7a13acd60547bbdb04e
+  metadata.gz: 9dddd9de39377071967c86f75e65a175352f33966d52d39e5dd725012a7a5531415870b0e95a7ce546e9bec0af4c15a0fefd2a50eb3585a64a93ed99cae3bd37
+  data.tar.gz: b936c064abfab53617eb82f7977dd2f7b1957115990ea301d211de8f23661667ada82a92fd2dbdc9c34d0d741ce00b1a3dd03a655fe73b855f610cfb663fe298

data/.travis.yml

@@ -7,4 +7,4 @@ rvm:
   - 2.4.10
   - 2.5.8
   - 2.6.6
-  - 2.7.1
+  - 2.7.2

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+### v2.6.2
+
+* Ensure line break character sequences are property formatted in output, regardless
+  of whether they are "\r\n", "\r" or "\n".
+
 ### v2.6.1
 
 * Update dependency versions

data/README.md

@@ -16,19 +16,19 @@ or “ASCII tables”). It is both highly configurable and very easy to
 _Quick API:_
 
 ```
-> puts Tabulo::Table.new(User.all, :id, :first_name, :last_name, border: :modern).pack
-┌────┬────────────┬───────────┐
-│ id │ first_name │ last_name │
-├────┼────────────┼───────────┤
-│  1 │ John       │ Citizen   │
-│  2 │ Jane       │ Doe       │
-└────┴────────────┴───────────┘
+> puts Tabulo::Table.new(User.all, :id, :first_name, :last_name).pack
++----+------------+-----------+
+| id | first_name | last_name |
++----+------------+-----------+
+|  1 | John       | Citizen   |
+|  2 | Jane       | Doe       |
++----+------------+-----------+
 ```
 
 _Full API:_
 
 ```
-table = Tabulo::Table.new(User.all, border: :modern) do |t|
+table = Tabulo::Table.new(User.all) do |t|
   t.add_column("ID", &:id)
   t.add_column("First name", &:first_name)
   t.add_column("Last name") { |user| user.last_name.upcase }
@@ -37,12 +37,12 @@ end
 
 ```
 > puts table.pack
-┌────┬────────────┬───────────┐
-│ ID │ First name │ Last name │
-├────┼────────────┼───────────┤
-│  1 │ John       │ CITIZEN   │
-│  2 │ Jane       │ DOE       │
-└────┴────────────┴───────────┘
++----+------------+-----------+
+| ID | First name | Last name |
++----+------------+-----------+
+|  1 | John       | CITIZEN   |
+|  2 | Jane       | DOE       |
++----+------------+-----------+
 ```
 
 <a name="features"></a>
@@ -600,7 +600,7 @@ The character used to indicate truncation, which defaults to `~`, can be configu
 #### Manual cell wrapping [&#x2191;](#contents)
 
 You can &ldquo;manually&rdquo; wrap the content of a title, header or body cell at a particular
-point, simply by placing a newline character at that point:
+point, simply by placing a newline character, at that point:
 
 ```ruby
 table = Tabulo::Table.new(1..3) do |t|
@@ -622,6 +622,11 @@ end
 +--------------+--------------+--------------+
 ```
 
+Tabulo will treat any of the character combinations `"\n"`, `"\r\n"` or `"\r"` equally, as a line break,
+regardless of the platform it&#8217;s currently being run on. This ensures things are formatted as
+expected if, for example, you are examining content that was produced on another platform from
+the one you&#8217;re running Tabulo on.
+
 <a name="formatting-cell-values"></a>
 ### Formatting cell values [&#x2191;](#contents)
 
@@ -683,7 +688,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.6.1/Tabulo/CellData.html)
+it&mdash;see the [documentation](https://www.rubydoc.info/gems/tabulo/2.6.2/Tabulo/CellData.html)
 for details.
 
 <a name="colours-and-styling"></a>
@@ -729,7 +734,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.6.1/Tabulo/Table#add_column-instance_method) for details.
+[documentation](https://www.rubydoc.info/gems/tabulo/2.6.2/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
@@ -749,7 +754,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.6.1/Tabulo/Table#add_column-instance_method)
+[documentation](https://www.rubydoc.info/gems/tabulo/2.6.2/Tabulo/Table#add_column-instance_method)
 for details.
 
 <a name="styling-title"></a>
@@ -763,7 +768,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.6.1/Tabulo/Table#initialize-instance_method)
+[documentation](https://www.rubydoc.info/gems/tabulo/2.6.2/Tabulo/Table#initialize-instance_method)
 for details.
 
 <a name="styling-borders"></a>
@@ -958,7 +963,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.6.1/Tabulo/Table#transpose-instance_method).
+[documentation](https://www.rubydoc.info/gems/tabulo/2.6.2/Tabulo/Table#transpose-instance_method).
 
 <a name="borders"></a>
 ### Configuring borders [&#x2191;](#contents)
@@ -1014,6 +1019,10 @@ This is done using the `border` option passed to `Table.new`. The options are as
 └──────────────┴──────────────┴──────────────┘
 ```
 
+_Note: The unicode characters used for the `:modern` border may not render properly
+when viewing this documentation on some browsers or devices. This doesn&#8217;t reflect any brokenness
+in `tabulo` itself._
+
 `:markdown`&mdash;renders a GitHub flavoured Markdown table:
 
 ```
@@ -1103,6 +1112,10 @@ generally support adding a caption (i.e. title) element to tables.
 ────────────── ────────────── ──────────────
 ```
 
+_Note: The unicode characters used for the `:reduced_modern` border may not render properly
+when viewing this documentation on some browsers or devices. This doesn&#8217;t reflect any brokenness
+in `tabulo` itself._
+
 `:classic`&mdash;reproduces the default behaviour in Tabulo v1; this is like the `:ascii` option,
 but without a bottom border:
 
@@ -1156,16 +1169,16 @@ every Nth row. For example:
 If you want a line before every row, pass `1` to `row_divider_frequency`. For example:
 
 ```
-> puts Tabulo::Table.new(1..3, :itself, :even?, :odd?, border: :modern, row_divider_frequency: 1)
-┌──────────────┬──────────────┬──────────────┐
-│    itself    │     even?    │     odd?     │
-├──────────────┼──────────────┼──────────────┤
-│            1 │     false    │     true     │
-├──────────────┼──────────────┼──────────────┤
-│            2 │     true     │     false    │
-├──────────────┼──────────────┼──────────────┤
-│            3 │     false    │     true     │
-└──────────────┴──────────────┴──────────────┘
+> puts Tabulo::Table.new(1..3, :itself, :even?, :odd?, row_divider_frequency: 1)
++--------------+--------------+--------------+
+|    itself    |     even?    |     odd?     |
++--------------+--------------+--------------+
+|            1 |     false    |     true     |
++--------------+--------------+--------------+
+|            2 |     true     |     false    |
++--------------+--------------+--------------+
+|            3 |     false    |     true     |
++--------------+--------------+--------------+
 ```
 
 <a name="freezing-a-table"></a>
@@ -1341,14 +1354,14 @@ 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.6.1
+[Documentation]: http://www.rubydoc.info/gems/tabulo/2.6.2
 [Build Status]: https://travis-ci.org/matt-harvey/tabulo
 [Coverage Status]: https://coveralls.io/r/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.6.1-blue.svg
+[DC img]: https://img.shields.io/badge/documentation-v2.6.2-blue.svg
 [BS img]: https://img.shields.io/travis/matt-harvey/tabulo.svg
 [CS img]: https://img.shields.io/coveralls/matt-harvey/tabulo.svg
 [CC img]: https://codeclimate.com/github/matt-harvey/tabulo/badges/gpa.svg

data/VERSION

@@ -1 +1 @@
-2.6.1
+2.6.2

data/lib/tabulo/cell.rb

@@ -101,7 +101,7 @@ module Tabulo
 
     def calculate_subcells
       line_index = 0
-      formatted_content.split($/, -1).flat_map do |substr|
+      formatted_content.split(Util::NEWLINE, -1).flat_map do |substr|
         subsubcells, subsubcell, subsubcell_width = [], String.new(""), 0
 
         substr.scan(/\X/).each do |grapheme_cluster|

data/lib/tabulo/table.rb

@@ -35,17 +35,17 @@ module Tabulo
     #   be unique. Each element of the Array  will be used to create a column whose content is
     #   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 [:left, :right, :center, :auto] align_body (:auto) Determines the alignment of body cell
+    # @param [:left, :right, :center, :auto] align_body Determines the alignment of body cell
     #   (i.e. non-header) content within columns in this Table. Can be overridden for individual columns
     #   using the <tt>align_body</tt> option passed to {#add_column}. If passed <tt>:auto</tt>,
     #   alignment is determined by cell content, with numbers aligned right, booleans
     #   center-aligned, and other values left-aligned.
-    # @param [:left, :right, :center] align_header (:center) Determines the alignment of header text
+    # @param [:left, :right, :center] align_header Determines the alignment of header text
     #   for columns in this Table. Can be overridden for individual columns using the
     #   <tt>align_header</tt> option passed to {#add_column}
-    # @param [:left, :right, :center] align_header (:center) Determines the alignment of the table
+    # @param [:left, :right, :center] align_header Determines the alignment of the table
     #   title, if present.
-    # @param [:ascii, :markdown, :modern, :blank, nil] border (nil) Determines the characters used
+    # @param [:ascii, :markdown, :modern, :blank, nil] border Determines the characters used
     #   for the Table border, including both the characters around the outside of table, and the lines drawn
     #   within the table to separate columns from each other and the header row from the Table body.
     #   If <tt>nil</tt>, then the value of {DEFAULT_BORDER} will be used.
@@ -63,7 +63,7 @@ module Tabulo
     #                       borders and intersection characters consisting of whitespace only
     #   - `:classic`        Like `:ascii`, but does not have a horizontal line at the bottom of the
     #                       table. This reproduces the default behaviour in `tabulo` v1.
-    # @param [nil, #to_proc] border_styler (nil) A lambda or other callable object taking
+    # @param [nil, #to_proc] border_styler A lambda or other callable object taking
     #   a single parameter, representing a section of the table's borders (which for this purpose
     #   include any horizontal and vertical lines inside the table), and returning a string.
     #   If passed <tt>nil</tt>, then no additional styling will be applied to borders. If passed a
@@ -72,7 +72,7 @@ module Tabulo
     #   <tt>border_styler</tt> is not taken into consideration by the internal table rendering calculations
     #   Thus it can be used to apply ANSI escape codes to border characters, to colour the borders
     #   for example, without breaking the table formatting.
-    # @param [nil, Integer, Array] column_padding (1) Determines the amount of blank space with which to pad
+    # @param [nil, Integer, Array] column_padding Determines the amount of blank space with which to pad
     #   either side of each column. If passed an Integer, then the given amount of padding is
     #   applied to each side of each column. If passed a two-element Array, then the first element of the
     #   Array indicates the amount of padding to apply to the left of each column, and the second
@@ -80,26 +80,26 @@ module Tabulo
     #   individual columns using the `padding` option of {#add_column}.
     # @param [Integer, nil] column_width The default column width for columns in this
     #   table, not excluding padding. If <tt>nil</tt>, then {DEFAULT_COLUMN_WIDTH} will be used.
-    # @param [nil, #to_proc] formatter (:to_s.to_proc) The default formatter for columns in this
+    # @param [nil, #to_proc] formatter The default formatter for columns in this
     #   table. See `formatter` option of {#add_column} for details.
     # @param [:start, nil, Integer] header_frequency (:start) 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,
     #   then repeated every N rows.
-    # @param [nil, #to_proc] header_styler (nil) The default header styler for columns in this
+    # @param [nil, #to_proc] header_styler The default header styler for columns in this
     #   table. See `header_styler` option of {#add_column} for details.
-    # @param [nil, Integer] row_divider_frequency (nil) Controls the display of horizontal row dividers within
+    # @param [nil, Integer] row_divider_frequency Controls the display of horizontal row dividers within
     #   the table body. If passed <tt>nil</tt>, dividers will not be shown. If passed an Integer N (> 0),
     #   dividers will be shown after every N rows. The characters used to form the dividers are
     #   determined by the `border` option, and are the same as those used to form the bottom edge of the
     #   header row.
-    # @param [nil, #to_proc] styler (nil) The default styler for columns in this table. See `styler`
+    # @param [nil, #to_proc] styler The default styler for columns in this table. See `styler`
     #   option of {#add_column} for details.
-    # @param [nil, String] title (nil) If passed a String, will arrange for a title to be shown at the top
+    # @param [nil, String] title If passed a String, will arrange for a title to be shown at the top
     #   of the table. Note: If the `border` option is set to `:markdown`, adding a title to the table
     #   will cause it to cease being valid Markdown when rendered, since Markdown engines do not generally
     #   support adding a caption element (i.e. title) to tables.
-    # @param [nil, #to_proc] title_styler (nil) A lambda or other callable object that will
+    # @param [nil, #to_proc] title_styler A lambda or other callable object that will
     #   determine the colors or other styling applied to the table title. Can be passed
     #   <tt>nil</tt>, or can be passed a callable that takes either 1 or 2 parametes:
     #   * If passed <tt>nil</tt>, then no additional styling will be applied to the title.
@@ -184,24 +184,24 @@ module Tabulo
     #   a method to be called on each item in the table sources to provide the content
     #   for this column. If a String is passed as the label, then it will be converted to
     #   a Symbol for the purpose of serving as this label.
-    # @param [:left, :center, :right, :auto, nil] align_body (nil) Specifies how the cell body contents
+    # @param [:left, :center, :right, :auto, nil] align_body Specifies how the cell body contents
     #   should be aligned. If <tt>nil</tt> is passed, then the alignment is determined
     #   by the Table-level setting passed to the <tt>align_body</tt> option on Table initialization
     #   (which itself defaults to <tt>:auto</tt>). Otherwise this option determines the alignment of
     #   this column. If <tt>:auto</tt> is passed, the alignment is determined by the type of the cell
     #   value, with numbers aligned right, booleans center-aligned, and other values left-aligned.
     #   Note header text alignment is configured separately using the :align_header param.
-    # @param [:left, :center, :right, nil] align_header (nil) Specifies how the header text
+    # @param [:left, :center, :right, nil] align_header Specifies how the header text
     #   should be aligned. If <tt>nil</tt> is passed, then the alignment is determined
     #   by the Table-level setting passed to the <tt>align_header</tt> (which itself defaults
     #   to <tt>:center</tt>). Otherwise, this option determines the alignment of the header
     #   content for this column.
-    # @param [Symbol, String, Integer, nil] before (nil) The label of the column before (i.e. to
+    # @param [Symbol, String, Integer, nil] before The label of the column before (i.e. to
     #   the left of) which the new column should inserted. If <tt>nil</tt> is passed, it will be
     #   inserted after all other columns. If there is no column with the given label, then an
     #   {InvalidColumnLabelError} will be raised. A non-Integer labelled column can be identified
     #   in either String or Symbol form for this purpose.
-    # @param [#to_proc] formatter (nil) A lambda or other callable object that
+    # @param [#to_proc] formatter A lambda or other callable object that
     #   will be passed the calculated value of each cell to determine how it should be displayed. This
     #   is distinct from the extractor and the styler (see below).
     #   For example, if the extractor for this column generates a Date, then the formatter might format
@@ -219,7 +219,7 @@ module Tabulo
     #     whether the {Cell} is an odd- or even-numbered {Row}, to arrange for different formatting
     #     to be applied to alternating rows.
     #     See the documentation for {CellData} for more.
-    # @param [nil, #to_s] header (nil) Text to be displayed in the column header. If passed nil,
+    # @param [nil, #to_s] header Text to be displayed in the column header. If passed nil,
     #   the column's label will also be used as its header text.
     # @param [nil, #to_proc] header_styler (nil) A lambda or other callable object that will
     #   determine the colors or other styling applied to the header content. Can be passed
@@ -249,14 +249,14 @@ module Tabulo
     #
     #   Note that if the header content is truncated, then any <tt>header_styler</tt> will be applied to the
     #   truncation indicator character as well as to the truncated content.
-    # @param [nil, Integer, Array] padding (nil) Determines the amount of blank space with which to
+    # @param [nil, Integer, Array] padding Determines the amount of blank space with which to
     #   pad either side of the column. If passed nil, then the `column_padding` setting of the
     #   {Table} will determine the column's padding. (See {#initialize}.) Otherwise, this option
     #   overrides, for this column, the `column_padding` that was set at the table level: if passed an Integer,
     #   then the given amount of padding is applied to either side of the column; or if passed a two-element Array,
     #   then the first element of the Array indicates the amount of padding to apply to the left of the column,
     #   and the second element indicates the amount to apply to the right.
-    # @param [nil, #to_proc] styler (nil) A lambda or other callable object that will determine
+    # @param [nil, #to_proc] styler A lambda or other callable object that will determine
     #   the colors or other styling applied to the formatted value of the cell. Can be passed
     #   <tt>nil</tt>, or can be passed a callable that takes either 2 or 3 parameters:
     #   * If passed <tt>nil</tt>, then no additional styling will be applied to the cell content
@@ -288,7 +288,7 @@ module Tabulo
     #
     #   Note that if the content of a cell is truncated, then the whatever styling is applied by the
     #   <tt>styler</tt> to the cell content will also be applied to the truncation indicator character.
-    # @param [Integer] width (nil) Specifies the width of the column, excluding padding. If
+    # @param [Integer] width Specifies the width of the column, excluding padding. If
     #   nil, then the column will take the width provided by the `column_width` param
     #   with which the Table was initialized.
     # @param [#to_proc] extractor A block or other callable that will be passed each of the {Table}
@@ -412,7 +412,7 @@ module Tabulo
     # Produce a horizontal dividing line suitable for printing at the top, bottom or middle
     # of the table.
     #
-    # @param [:top, :middle, :bottom, :title_top, :title_bottom] position (:bottom)
+    # @param [:top, :middle, :bottom, :title_top, :title_bottom] position
     #   Specifies the position for which the resulting horizontal dividing line is intended to
     #   be printed. This determines the border characters that are used to construct the line.
     #   The `:title_top` and `:title_bottom` options are used internally for adding borders
@@ -451,7 +451,7 @@ module Tabulo
     # is called. If the source Enumerable changes between that point, and the point when
     # the Table is printed, then columns will *not* be resized yet again on printing.
     #
-    # @param [nil, Numeric] max_table_width (:auto) With no args, or if passed <tt>:auto</tt>,
+    # @param [nil, Numeric] max_table_width With no args, or if passed <tt>:auto</tt>,
     #   stops the total table width (including padding and borders) from expanding beyond the
     #   bounds of the terminal screen.
     #   If passed <tt>nil</tt>, the table width will not be capped.
@@ -523,13 +523,13 @@ module Tabulo
     #   new Table, which contains the names of "fields" (corresponding to the original Table's
     #   column headings). If this is not provided, then by default this column will be made just
     #   wide enough to accommodate its contents.
-    # @option opts [String] :field_names_header ("") By default the left-most column will have a
+    # @option opts [String] :field_names_header By default the left-most column will have a
     #   blank header; but this can be overridden by passing a String to this option.
-    # @option opts [:left, :center, :right] :field_names_header_alignment (:right) Specifies how the
+    # @option opts [:left, :center, :right] :field_names_header_alignment Specifies how the
     #   header text of the left-most column (if it has header text) should be aligned.
-    # @option opts [:left, :center, :right] :field_names_body_alignment (:right) Specifies how the
+    # @option opts [:left, :center, :right] :field_names_body_alignment Specifies how the
     #   body text of the left-most column should be aligned.
-    # @option opts [#to_proc] :headers (:to_s.to_proc) A lambda or other callable object that
+    # @option opts [#to_proc] :headers A lambda or other callable object that
     #   will be passed in turn each of the elements of the current Table's <tt>sources</tt>
     #   Enumerable, to determine the text to be displayed in the header of each column of the
     #   new Table (other than the left-most column's header, which is determined as described

data/lib/tabulo/util.rb

@@ -3,6 +3,8 @@ module Tabulo
   # @!visibility private
   module Util
 
+    NEWLINE = /\r\n|\n|\r/
+
     # @!visibility private
     def self.condense_lines(lines)
       join_lines(lines.reject(&:empty?))
@@ -34,7 +36,7 @@ module Tabulo
     # @return [Integer] the length of the longest segment of str when split by newlines
     def self.wrapped_width(str)
       return 0 if str.empty?
-      segments = str.split($/)
+      segments = str.split(NEWLINE)
       segments.inject(1) do |longest_length_so_far, segment|
         Util.max(longest_length_so_far, Unicode::DisplayWidth.of(segment))
       end

data/lib/tabulo/version.rb

@@ -1,3 +1,3 @@
 module Tabulo
-  VERSION = "2.6.1"
+  VERSION = "2.6.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tabulo
 version: !ruby/object:Gem::Version
-  version: 2.6.1
+  version: 2.6.2
 platform: ruby
 authors:
 - Matthew Harvey
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-24 00:00:00.000000000 Z
+date: 2020-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tty-screen