tabulo 2.3.3 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6104501fe177f52639fb3e05c12c5cd53d62d1388ad85e2abecaa58f15b3d39d
-  data.tar.gz: 35648de653973f20a5871a71bb2cd9340eb1b80196dc25f510477e7e8143a9db
+  metadata.gz: bbe40163f1115e0ea4b81c13b61518eee7827d4ebd8fb87047b0f5081b0ff02a
+  data.tar.gz: 630ab47731a06f597ca568ac2bce02ae0a92621a943b2db716ccf5ff0c25bc56
 SHA512:
-  metadata.gz: e5c158f65f97272c637bf37fab53f542001264f3e094ea07a67b4a5e6d583cfb315a40d0a51abad2135fa84169b1edce77420dc9fded8f619f842aa5087c7262
-  data.tar.gz: 0d0f2abb4a82098b4c4886926254f65c17c80b751509818927f8a237c2f4dce35f61d8fcdf028ba9d47640611d14349437eb767ffd2deaf92ebc5c8ee16eda8c
+  metadata.gz: d2d3d5ccadecf03327f4325736fe4a8caaef1304bbecf42261e77030271011d3065cb028d584705c83bb8156364a3618a71f6256e3c2b9abbe3a8d54013febb0
+  data.tar.gz: 3b1203c04e29e62a9d4d314b1be5e25483711f3e0d13008a60ecf1feac18a63b3374bdf0a9678f69593881a3bc96a9197b9d0b9b8b80bdb4a700d4d94115f9e6

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+### v2.4.0
+
+* Add additional, optional `CellData` parameter to `styler` and `formatter` callbacks
+* Add optional `column_index` parameter to `header_styler` callback
+* Add optional `row_index` parameter to `extractor` callback
+* Add `rake yard` Rake task for generating YARD documentation
+* Minor documentation fixes
+* Upgrade dependency version: `unicode-display_width` gem to 1.7.0
+
 ### v2.3.3
 
 * Fix styler option on Table initializer, which had no effect

data/README.md

@@ -216,6 +216,29 @@ end
 +--------------+--------------+--------------+
 ```
 
+The `add_column` method can be passed a single parameter callable, as shown in the above example,
+with the parameter representing the member of the underyling enumerable; or it can be passed
+2-parameter callable, with the second parameter representing the (0-based) index of each row. This can be
+useful if you want to display a row number in one of the columns:
+
+```ruby
+table = Tabulo::Table.new(["a", "b", "c"]) do |t|
+  t.add_column("Row") { |letter, row_index| row_index }
+  t.add_column("Value", &:itself)
+end
+```
+
+```
+> puts table
++--------------+--------------+
+|      Row     |     Value    |
++--------------+--------------+
+|            0 | a            |
+|            1 | b            |
+|            2 | c            |
++--------------+--------------+
+```
+
 <a name="labels-headers"></a>
 #### Column labels _vs_ headers
 
@@ -550,6 +573,12 @@ end
 Formatters set for individual columns on calling `#add_column` always override the default formatter for
 the table.
 
+The `formatter` callback 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.4.0/Tabulo/CellData.html)
+for details.
+
 <a name="colours-and-styling"></a>
 ### Colours and other styling
 
@@ -587,16 +616,20 @@ table.add_column(
 )
 ```
 
-The `styler` option should be passed a callable that takes two parameters: the first represents
-the underlying value of the cell (in this case a boolean indicating whether the number is even);
-and the second represents the formatted string value of that cell, i.e. the cell content after
-any processing by the [formatter](#formatting-cell-values). 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 (ensuring the styling doesn&#8217;t bleed
-into neighbouring cells).
+The `styler` option should be passed a callable that takes either two or three parameters: the
+first parameter represents the underlying value of the cell (in this case a boolean indicating whether
+the number is even); the second represents the formatted string value of that cell, i.e. the cell
+content after any processing by the [formatter](#formatting-cell-values); and the third parameter,
+if present, will be passed a `CellData` object, containing other information about the cell
+that may be useful in determining how to style it&mdash;see the
+[documentation](https://www.rubydoc.info/gems/tabulo/2.4.0/Tabulo/CellData.html) 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
+(ensuring the styling doesn&#8217;t bleed into neighbouring cells).
 
-If the content of a cell has been [truncated](#overflow-handling), then whatever colours or other styling
-apply to the cell content will also be applied the truncation indicator character.
+If the content of a cell has been [truncated](#overflow-handling), then whatever colours or other
+styling apply to the cell content will also be applied the truncation indicator character.
 
 <a name="styling-column-headers"></a>
 #### Styling column headers
@@ -608,6 +641,10 @@ to cells in the table body, use the `header_styler` option, e.g.:
 table.add_column(:even?, header_styler: -> (s) { "\033[32m#{s}\033[0m" })
 ```
 
+The `header_styler` option accepts either a 1- or 2-parameter callable. See the
+[documentation](https://www.rubydoc.info/gems/tabulo/2.4.0/Tabulo/Table#add_column-instance_method)
+for details.
+
 <a name="default-styles"></a>
 #### Setting default styles
 
@@ -798,7 +835,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.3.3/Tabulo/Table#transpose-instance_method).
+[documentation](https://www.rubydoc.info/gems/tabulo/2.4.0/Tabulo/Table#transpose-instance_method).
 
 <a name="borders"></a>
 ### Configuring borders
@@ -1107,14 +1144,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.3.3
+[Documentation]: http://www.rubydoc.info/gems/tabulo/2.4.0
 [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.3.3-blue.svg
+[DC img]: https://img.shields.io/badge/documentation-v2.4.0-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/Rakefile

@@ -1,12 +1,17 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 require "rake-version"
+require "yard"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec
 
 RakeVersion::Tasks.new do |v|
   v.copy "lib/tabulo/version.rb"
   v.copy "README.md", all: true
 end
+
+YARD::Rake::YardocTask.new do |t|
+  t.options = ["--markup-provider=redcarpet", "--markup=markdown"]
+end

data/VERSION

@@ -1 +1 @@
-2.3.3
+2.4.0

data/lib/tabulo.rb

@@ -4,6 +4,7 @@ require "tabulo/util"
 require "tabulo/table"
 require "tabulo/version"
 require "tabulo/row"
+require "tabulo/cell_data"
 require "tabulo/cell"
 require "tabulo/column"
 require "tabulo/border"

data/lib/tabulo/cell.rb

@@ -9,14 +9,24 @@ module Tabulo
     attr_reader :value
 
     # @!visibility private
-    def initialize(value:, formatter:, alignment:, width:, styler:, truncation_indicator:, padding_character:)
-      @value = value
-      @formatter = formatter
+    def initialize(
+      alignment:,
+      cell_data:,
+      formatter:,
+      padding_character:,
+      styler:,
+      truncation_indicator:,
+      value:,
+      width:)
+
       @alignment = alignment
-      @width = width
+      @cell_data = cell_data
+      @padding_character = padding_character
+      @formatter = formatter
       @styler = styler
       @truncation_indicator = truncation_indicator
-      @padding_character = padding_character
+      @value = value
+      @width = width
     end
 
     # @!visibility private
@@ -37,11 +47,27 @@ module Tabulo
     # @return [String] the content of the Cell, after applying the formatter for this Column (but
     #   without applying any wrapping or the styler).
     def formatted_content
-      @formatted_content ||= @formatter.call(@value)
+      @formatted_content ||= apply_formatter
     end
 
     private
 
+    def apply_formatter
+      if @formatter.arity == 2
+        @formatter.call(@value, @cell_data)
+      else
+        @formatter.call(@value)
+      end
+    end
+
+    def apply_styler(content)
+      if @styler.arity == 3
+        @styler.call(@value, content, @cell_data)
+      else
+        @styler.call(@value, content)
+      end
+    end
+
     def subcells
       @subcells ||= calculate_subcells
     end
@@ -63,7 +89,7 @@ module Tabulo
     end
 
     def styled_truncation_indicator
-      @styler.call(@value, @truncation_indicator)
+      apply_styler(@truncation_indicator)
     end
 
     def calculate_subcells
@@ -99,7 +125,7 @@ module Tabulo
           [padding, 0]
         end
 
-      "#{' ' * left_padding}#{@styler.call(@value, content)}#{' ' * right_padding}"
+      "#{' ' * left_padding}#{apply_styler(content)}#{' ' * right_padding}"
     end
 
     def real_alignment

data/lib/tabulo/cell_data.rb

@@ -0,0 +1,13 @@
+module Tabulo
+
+  # Contains information about a particular {Cell} in the {Table}.
+  #
+  # @attr source [Object] The member of this {Cell}'s {Table}'s underlying enumerable from which
+  #   this {Cell}'s {Row} was derived.
+  # @attr row_index [Integer] The positional index of the {Cell}'s {Row}. The topmost {Row} of the
+  #   {Table} has index 0, the next has index 1, etc..
+  # @attr column_index [Integer] The positional index of the {Cell}'s {Column}. The leftmost {Column}
+  #   of the {Table} has index 0, the next has index 1, etc..
+  CellData = Struct.new(:source, :row_index, :column_index)
+
+end

data/lib/tabulo/column.rb

@@ -5,6 +5,7 @@ module Tabulo
 
     attr_accessor :width
     attr_reader :header
+    attr_reader :index
 
     def initialize(
       align_body:,
@@ -13,6 +14,7 @@ module Tabulo
       formatter:,
       header:,
       header_styler:,
+      index:,
       padding_character:,
       styler:,
       truncation_indicator:,
@@ -23,12 +25,15 @@ module Tabulo
       @extractor = extractor
       @formatter = formatter
       @header = header
+      @index = index
 
       @header_styler =
-        if header_styler
-          -> (_, s) { header_styler.call(s) }
+        if header_styler && (header_styler.arity == 2)
+          -> (_, str, cell_data) { header_styler.call(str, cell_data.column_index) }
+        elsif header_styler
+          -> (_, str) { header_styler.call(str) }
         else
-          -> (_, s) { s }
+          -> (_, str) { str }
         end
 
       @padding_character = padding_character
@@ -38,8 +43,12 @@ module Tabulo
     end
 
     def header_cell
+      if @header_styler.arity == 3
+        cell_data = CellData.new(nil, nil, @index)
+      end
       Cell.new(
         alignment: @align_header,
+        cell_data: cell_data,
         formatter: -> (s) { s },
         padding_character: @padding_character,
         styler: @header_styler,
@@ -49,20 +58,34 @@ module Tabulo
       )
     end
 
-    def body_cell(source)
+    def body_cell(source, row_index:, column_index:)
+      if body_cell_data_required?
+        cell_data = CellData.new(source, row_index, @index)
+      end
       Cell.new(
         alignment: @align_body,
+        cell_data: cell_data,
         formatter: @formatter,
         padding_character: @padding_character,
         styler: @styler,
         truncation_indicator: @truncation_indicator,
-        value: body_cell_value(source),
+        value: body_cell_value(source, row_index: row_index, column_index: column_index),
         width: @width,
       )
     end
 
-    def body_cell_value(source)
-      @extractor.call(source)
+    def body_cell_value(source, row_index:, column_index:)
+      if @extractor.arity == 2
+        @extractor.call(source, row_index)
+      else
+        @extractor.call(source)
+      end
+    end
+
+    private
+
+    def body_cell_data_required?
+      @cell_data_required ||= (@styler.arity == 3 || @formatter.arity == 2)
     end
   end
 end

data/lib/tabulo/row.rb

@@ -7,11 +7,12 @@ module Tabulo
     attr_reader :source
 
     # @!visibility private
-    def initialize(table, source, divider: false, header: :top)
+    def initialize(table, source, divider:, header:, index:)
       @table = table
       @source = source
       @divider = divider
       @header = header
+      @index = index
     end
 
     # Calls the given block once for each {Cell} in the {Row}, passing that {Cell} as parameter.
@@ -23,8 +24,8 @@ module Tabulo
     #     puts cell.value   # => 1,       => false
     #   end
     def each
-      @table.column_registry.each do |_, column|
-        yield column.body_cell(@source)
+      @table.column_registry.each_with_index do |(_, column), column_index|
+        yield column.body_cell(@source, row_index: @index, column_index: column_index)
       end
     end
 
@@ -34,7 +35,7 @@ module Tabulo
     #   and divider frequency).
     def to_s
       if @table.column_registry.any?
-        @table.formatted_body_row(@source, header: @header, divider: @divider)
+        @table.formatted_body_row(@source, divider: @divider, header: @header, index: @index)
       else
         ""
       end
@@ -42,7 +43,9 @@ module Tabulo
 
     # @return a Hash representation of the {Row}, with column labels acting as keys and the {Cell}s the values.
     def to_h
-      @table.column_registry.map { |label, column| [label, column.body_cell(@source)] }.to_h
+      @table.column_registry.map.with_index do |(label, column), column_index|
+        [label, column.body_cell(@source, row_index: @index, column_index: column_index)]
+      end.to_h
     end
   end
 end

data/lib/tabulo/table.rb

@@ -64,7 +64,7 @@ module Tabulo
     #   If passed <tt>nil</tt>, then no additional styling will be applied to borders. If passed a
     #   callable, then that callable will be called for each border section, with the
     #   resulting string rendered in place of that border. The extra width of the string returned by the
-    #   {border_styler} is not taken into consideration by the internal table rendering calculations
+    #   <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
@@ -168,48 +168,85 @@ module Tabulo
     #   in either String or Symbol form for this purpose.
     # @param [#to_proc] formatter (nil) 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 (see below). For example, if the extractor for this column
-    #   generates a Date, then the formatter might format that Date in a particular way.
-    #   If no formatter is provided, then the callable that was passed to the `formatter` option
-    #   of the table itself on its creation (see {#initialize}) (which itself defaults to
-    #   `:to_s.to_proc`), will be used as the formatter for the column.
+    #   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
+    #   that Date in a particular way.
+    #   * If <tt>nil</tt> is provided, then the callable that was passed to the `formatter` option
+    #    of the table itself on its creation (see {#initialize}) (which itself defaults to
+    #    `:to_s.to_proc`), will be used as the formatter for the column.
+    #   * If a 1-parameter callable is passed, then this callable will be called with the calculated
+    #     value of the cell; it should then return a String, and this String will be displayed as
+    #     the formatted value of the cell.
+    #   * If a 2-parameter callable is passed, then the first parameter represents the calculated
+    #     value of the cell, and the second parameter is a {CellData} instance, containing
+    #     additional information about the cell that may be relevant to what formatting should
+    #     be applied. For example, the {CellData#row_index} attribute can be inspected to determine
+    #     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,
     #   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 taking
-    #   a single parameter, representing a single line of within the header content for
-    #   this column. For example, if the header cell content is wrapped over three lines, then
-    #   the {header_styler} will be called once for each line. If passed <tt>nil</tt>, then
-    #   no additional styling will be applied to the header cell content. If passed a callable,
-    #   then that callable will be called for each line of content within the header cell, and the
-    #   resulting string rendered in place of that line. The extra width of the string returned by the
-    #   {header_styler} is not taken into consideration by the internal table and
-    #   cell width calculations involved in rendering the table. Thus it can be used to apply
-    #   ANSI escape codes to header cell content, to colour the cell content for example, without
-    #   breaking the table formatting.
-    #   Note that if the header content is truncated, then any {header_styler} will be applied to the
+    # @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
+    #   <tt>nil</tt>, or can be passed a callable that takes either 1 or 2 parameters:
+    #   * If passed <tt>nil</tt>, then no additional styling will be applied to the cell content
+    #     (other than what was already applied by the <tt>formatter</tt>).
+    #   * If passed a callable, then that callable will be called for each line of content within
+    #     the header cell, and the resulting string rendered in place of that line.
+    #     The extra width of the string returned by the <tt>header_styler</tt> is not taken into
+    #     consideration by the internal table and cell width calculations involved in rendering the
+    #     table. Thus it can be used to apply ANSI escape codes to header cell content, to color the
+    #     cell content for example, without breaking the table formatting.
+    #     * If the passed callable takes 1 parameter, then the first parameter is a string
+    #       representing a single formatted line within the header cell. For example, if the header
+    #       cell content is wrapped over three lines, then the <tt>header_styler</tt> will be called
+    #       three times for that header cell, once for each line of content.
+    #     * If the passed callable takes 2 parameters, then the first parameter is as above, and the
+    #       second parameter is an Integer representing the positional index of this header's {Column},
+    #       with the leftmost column having index 0, the next having index 1 etc.. This can be
+    #       used, for example, to apply different styles to alternating {Column}s.
+    #
+    #   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, #to_proc] styler (nil) A lambda or other callable object that will be passed
-    #   two arguments: the calculated value of the cell (prior to the {formatter} being applied);
-    #   and a string representing a single formatted line within the cell. For example, if the
-    #   cell content is wrapped over three lines, then for that cell, the {styler} will be called
-    #   three times, once for each line of content within the cell. If passed <tt>nil</tt>, then
-    #   no additional styling will be applied to the cell content (other than what was already
-    #   applied by the {formatter}). If passed a callable, then that callable will be called for
-    #   each line of content within the cell, and the resulting string rendered in place of that
-    #   line. The {styler} option differs from the {formatter} option in that the extra width of the
-    #   string returned by {styler} is not taken into consideration by the internal table and
-    #   cell width calculations involved in rendering the table. Thus it can be used to apply
-    #   ANSI escape codes to cell content, to colour the cell content for example, without
-    #   breaking the table formatting.
+    # @param [nil, #to_proc] styler (nil) 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
+    #     (other than what was already applied by the <tt>formatter</tt>).
+    #   * If passed a callable, then that callable will be called for each line of content within
+    #     the cell, and the resulting string rendered in place of that line.
+    #     The <tt>styler</tt> option differs from the <tt>formatter</tt> option in that the extra width of the
+    #     string returned by <tt>styler</tt> is not taken into consideration by the internal table and
+    #     cell width calculations involved in rendering the table. Thus it can be used to apply
+    #     ANSI escape codes to cell content, to color the cell content for example, without
+    #     breaking the table formatting.
+    #     * If the passed callable takes 2 parameters, then the first parameter is the calculated
+    #       value of the cell (prior to the <tt>formatter</tt> being applied); and the second parameter is
+    #       a string representing a single formatted line within the cell. For example, if the cell
+    #       content is wrapped over three lines, then for that cell, the <tt>styler</tt> will be called
+    #       three times, once for each line of content within the cell.
+    #     * If the passed callable takes 3 parameters, then the first two parameters are as above,
+    #       and the third parameter is a {CellData} instance, containing additional information
+    #       about the cell that may be relevant to what styles should be applied. For example, the
+    #       {CellData#row_index} attribute can be inspected to determine whether the {Cell} is an
+    #       odd- or even-numbered {Row}, to arrange for different styling to be applied to
+    #       alternating rows. See the documentation for {CellData} for more.
+    #
     #   Note that if the content of a cell is truncated, then the whatever styling is applied by the
-    #   {styler} to the cell content will also be applied to the truncation indicator character.
+    #   <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
     #   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 sources to determine the value in each cell of this
-    #   column. If this is not provided, then the column label will be treated as a method to be
-    #   called on each source item to determine each cell's value.
+    # @param [#to_proc] extractor A block or other callable that will be passed each of the {Table}
+    #   sources to determine the value in each cell of this column.
+    #   * If this is not provided, then the column label will be treated as a method to be called on
+    #     each source item to determine each cell's value.
+    #   * If provided a single-parameter callable, then this callable will be passed each of the
+    #     {Table} sources to determine the cell value for each row in this column.
+    #   * If provided a 2-parameter callable, then for each of the {Table} sources, this callable
+    #     will be passed the source, and the row index, to determine the cell value for that row.
+    #     For this purpose, the first body row (not counting the header row) has an index of 0,
+    #     the next an index of 1, etc..
     # @raise [InvalidColumnLabelError] if label has already been used for another column in this
     #   Table. (This is case-sensitive, but is insensitive to whether a String or Symbol is passed
     #   to the label parameter.)
@@ -229,6 +266,7 @@ module Tabulo
         formatter: formatter || @formatter,
         header: (header || label).to_s,
         header_styler: header_styler || @header_styler,
+        index: column_registry.count,
         padding_character: PADDING_CHARACTER,
         styler: styler || @styler,
         truncation_indicator: @truncation_indicator,
@@ -297,7 +335,7 @@ module Tabulo
 
         show_divider = @row_divider_frequency && (index != 0) && Util.divides?(@row_divider_frequency, index)
 
-        yield Row.new(self, source, header: header, divider: show_divider)
+        yield Row.new(self, source, header: header, divider: show_divider, index: index)
       end
     end
 
@@ -307,14 +345,15 @@ module Tabulo
       format_row(cells, @wrap_header_cells_to)
     end
 
-    # @param [:top, :middle, :bottom] align_body (:bottom) Specifies the position
+    # Produce a horizontal dividing line suitable for printing at the top, bottom or middle
+    # of the table.
+    #
+    # @param [:top, :middle, :bottom] position (:bottom) 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.
     # @return [String] an "ASCII" graphical representation of a horizontal
-    #   dividing line suitable for printing at the top, bottom or middle of the
-    #   table.
-    # @example Print a horizontal divider between each pair of rows, and again
-    #   at the bottom:
+    #   dividing line.
+    # @example Print a horizontal divider between each pair of rows, and again at the bottom:
     #
     #   table.each_with_index do |row, i|
     #     puts table.horizontal_rule(:middle) unless i == 0
@@ -360,9 +399,10 @@ module Tabulo
     def pack(max_table_width: :auto)
       get_columns.each { |column| column.width = wrapped_width(column.header) }
 
-      @sources.each do |source|
-        get_columns.each do |column|
-          cell_width = wrapped_width(column.body_cell(source).formatted_content)
+      @sources.each_with_index do |source, row_index|
+        get_columns.each_with_index do |column, column_index|
+          cell = column.body_cell(source, row_index: row_index, column_index: column_index)
+          cell_width = wrapped_width(cell.formatted_content)
           column.width = Util.max(column.width, cell_width)
         end
       end
@@ -445,15 +485,15 @@ module Tabulo
         # Add a column to the new table for each of the original table's sources
         sources.each_with_index do |source, i|
           t.add_column(i, header: extra_opts[:headers].call(source)) do |original_column|
-            original_column.body_cell_value(source)
+            original_column.body_cell_value(source, row_index: i, column_index: original_column.index)
           end
         end
       end
     end
 
     # @!visibility private
-    def formatted_body_row(source, header:, divider:)
-      cells = get_columns.map { |column| column.body_cell(source) }
+    def formatted_body_row(source, header:, divider:, index:)
+      cells = get_columns.map.with_index { |c, i| c.body_cell(source, row_index: index, column_index: i) }
       inner = format_row(cells, @wrap_body_cells_to)
 
       if header == :top

data/lib/tabulo/version.rb

@@ -1,3 +1,3 @@
 module Tabulo
-  VERSION = "2.3.3"
+  VERSION = "2.4.0"
 end

data/tabulo.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |spec|
   }
 
   spec.add_runtime_dependency "tty-screen", "0.7.1"
-  spec.add_runtime_dependency "unicode-display_width", "1.6.1"
+  spec.add_runtime_dependency "unicode-display_width", "1.7.0"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", "~> 12.3.3"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tabulo
 version: !ruby/object:Gem::Version
-  version: 2.3.3
+  version: 2.4.0
 platform: ruby
 authors:
 - Matthew Harvey
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-13 00:00:00.000000000 Z
+date: 2020-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tty-screen
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.6.1
+        version: 1.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.6.1
+        version: 1.7.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -189,6 +189,7 @@ files:
 - lib/tabulo.rb
 - lib/tabulo/border.rb
 - lib/tabulo/cell.rb
+- lib/tabulo/cell_data.rb
 - lib/tabulo/column.rb
 - lib/tabulo/deprecation.rb
 - lib/tabulo/exceptions.rb