tabulo 2.3.3 → 2.6.1

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.6.1

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/border.rb

@@ -3,118 +3,77 @@ module Tabulo
   # @!visibility private
   class Border
 
+    Style = Struct.new(
+        :corner_top_left, :corner_top_right, :corner_bottom_right, :corner_bottom_left,
+        :edge_top, :edge_right, :edge_bottom, :edge_left,
+        :tee_top, :tee_right, :tee_bottom, :tee_left,
+        :divider_vertical, :divider_horizontal, :intersection)
+
     STYLES = {
-      ascii: {
-        corner_top_left: "+",
-        corner_top_right: "+",
-        corner_bottom_right: "+",
-        corner_bottom_left: "+",
-        edge_top: "-",
-        edge_right: "|",
-        edge_bottom: "-",
-        edge_left: "|",
-        tee_top: "+",
-        tee_right: "+",
-        tee_bottom: "+",
-        tee_left: "+",
-        divider_vertical: "|",
-        divider_horizontal: "-",
-        intersection: "+",
-      },
-      classic: {
-        corner_top_left: "+",
-        corner_top_right: "+",
-        edge_top: "-",
-        edge_right: "|",
-        edge_left: "|",
-        tee_top: "+",
-        tee_right: "+",
-        tee_left: "+",
-        divider_vertical: "|",
-        divider_horizontal: "-",
-        intersection: "+",
-      },
-      reduced_ascii: {
-        corner_top_left: "",
-        corner_top_right: "",
-        corner_bottom_right: "",
-        corner_bottom_left: "",
-        edge_top: "-",
-        edge_right: "",
-        edge_bottom: "-",
-        edge_left: "",
-        tee_top: " ",
-        tee_right: "",
-        tee_bottom: " ",
-        tee_left: "",
-        divider_vertical: " ",
-        divider_horizontal: "-",
-        intersection: " ",
-      },
-      reduced_modern: {
-        corner_top_left: "",
-        corner_top_right: "",
-        corner_bottom_right: "",
-        corner_bottom_left: "",
-        edge_top: "─",
-        edge_right: "",
-        edge_bottom: "─",
-        edge_left: "",
-        tee_top: " ",
-        tee_right: "",
-        tee_bottom: " ",
-        tee_left: "",
-        divider_vertical: " ",
-        divider_horizontal: "─",
-        intersection: " ",
-      },
-      markdown: {
-        corner_top_left: "",
-        corner_top_right: "",
-        corner_bottom_right: "",
-        corner_bottom_left: "",
-        edge_top: "",
-        edge_right: "|",
-        edge_bottom: "",
-        edge_left: "|",
-        tee_top: "",
-        tee_right: "|",
-        tee_bottom: "",
-        tee_left: "|",
-        divider_vertical: "|",
-        divider_horizontal: "-",
-        intersection: "|",
-      },
-      modern: {
-        corner_top_left: "┌",
-        corner_top_right: "┐",
-        corner_bottom_right: "┘",
-        corner_bottom_left: "└",
-        edge_top: "─",
-        edge_right: "│",
-        edge_bottom: "─",
-        edge_left: "│",
-        tee_top: "┬",
-        tee_right: "┤",
-        tee_bottom: "┴",
-        tee_left: "├",
-        divider_vertical: "│",
-        divider_horizontal: "─",
-        intersection: "┼",
-      },
-      blank: {
-      },
+      ascii:
+        Style.new(
+          "+", "+", "+", "+",
+          "-", "|", "-", "|",
+          "+", "+", "+", "+",
+          "|", "-", "+",
+        ),
+      classic:
+        Style.new(
+          "+", "+", "", "",
+          "-", "|", "", "|",
+          "+", "+", "", "+",
+          "|", "-", "+",
+        ),
+      reduced_ascii:
+        Style.new(
+          "", "", "", "",
+          "-", "", "-", "",
+          " ", "", " ", "",
+          " ", "-", " ",
+        ),
+      reduced_modern:
+        Style.new(
+          "", "", "", "",
+          "─", "", "─", "",
+          " ", "", " ", "",
+          " ", "─", " ",
+        ),
+      markdown:
+        Style.new(
+          "", "", "", "",
+          "", "|", "", "|",
+          "", "|", "", "|",
+          "|", "-", "|",
+        ),
+      modern:
+        Style.new(
+          "┌", "┐", "┘", "└",
+          "─", "│", "─", "│",
+          "┬", "┤", "┴", "├",
+          "│", "─", "┼",
+        ),
+      blank:
+        Style.new(
+          "", "", "", "",
+          "", "", "", "",
+          "", "", "", "",
+          "", "", "",
+        ),
     }
 
     # @!visibility private
     def self.from(initializer, styler = nil)
-      new(options(initializer).merge(styler: styler))
+      new(**options(initializer).merge(styler: styler))
     end
 
     # @!visibility private
     def horizontal_rule(column_widths, position = :bottom)
       left, center, right, segment =
         case position
+        when :title_top
+          [@corner_top_left, @edge_top, @corner_top_right, @edge_top]
+        when :title_bottom
+          [@tee_left, @tee_top, @tee_right, @edge_top]
         when :top
           [@corner_top_left, @tee_top, @corner_top_right, @edge_top]
         when :middle
@@ -123,6 +82,11 @@ module Tabulo
           [@corner_bottom_left, @tee_bottom, @corner_bottom_right, @edge_bottom]
         end
       segments = column_widths.map { |width| segment * width }
+
+      # Prevent weird bottom edge of title if segments empty but right/left not empty, as in
+      # Markdown border.
+      left = right = "" if segments.all?(&:empty?)
+
       style("#{left}#{segments.join(center)}#{right}")
     end
 
@@ -138,7 +102,7 @@ module Tabulo
 
     def self.options(kind)
       opts = STYLES[kind]
-      return opts if opts
+      return opts.to_h if opts
       raise InvalidBorderError
     end
 

data/lib/tabulo/cell.rb

@@ -9,14 +9,28 @@ 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:,
+      left_padding:,
+      padding_character:,
+      right_padding:,
+      styler:,
+      truncation_indicator:,
+      value:,
+      width:)
+
       @alignment = alignment
-      @width = width
+      @cell_data = cell_data
+      @formatter = formatter
+      @left_padding = left_padding
+      @padding_character = padding_character
+      @right_padding = right_padding
       @styler = styler
       @truncation_indicator = truncation_indicator
-      @padding_character = padding_character
+      @value = value
+      @width = width
     end
 
     # @!visibility private
@@ -25,34 +39,53 @@ module Tabulo
     end
 
     # @!visibility private
-    def padded_truncated_subcells(target_height, padding_amount_left, padding_amount_right)
-      total_padding_amount = padding_amount_left + padding_amount_right
+    def padded_truncated_subcells(target_height)
+      total_padding_amount = @left_padding + @right_padding
       truncated = (height > target_height)
       (0...target_height).map do |subcell_index|
         append_truncator = (truncated && (total_padding_amount != 0) && (subcell_index + 1 == target_height))
-        padded_subcell(subcell_index, padding_amount_left, padding_amount_right, append_truncator)
+        padded_subcell(subcell_index, append_truncator)
       end
     end
 
     # @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, line_index)
+      case @styler.arity
+      when 4
+        @styler.call(@value, content, @cell_data, line_index)
+      when 3
+        @styler.call(@value, content, @cell_data)
+      else
+        @styler.call(@value, content)
+      end
+    end
+
     def subcells
       @subcells ||= calculate_subcells
     end
 
-    def padded_subcell(subcell_index, padding_amount_left, padding_amount_right, append_truncator)
-      lpad = @padding_character * padding_amount_left
+    def padded_subcell(subcell_index, append_truncator)
+      lpad = @padding_character * @left_padding
       rpad =
         if append_truncator
-          styled_truncation_indicator + padding(padding_amount_right - 1)
+          styled_truncation_indicator(subcell_index) + padding(@right_padding - 1)
         else
-          padding(padding_amount_right)
+          padding(@right_padding)
         end
       inner = subcell_index < height ? subcells[subcell_index] : padding(@width)
       "#{lpad}#{inner}#{rpad}"
@@ -62,31 +95,35 @@ module Tabulo
       @padding_character * amount
     end
 
-    def styled_truncation_indicator
-      @styler.call(@value, @truncation_indicator)
+    def styled_truncation_indicator(line_index)
+      apply_styler(@truncation_indicator, line_index)
     end
 
     def calculate_subcells
+      line_index = 0
       formatted_content.split($/, -1).flat_map do |substr|
         subsubcells, subsubcell, subsubcell_width = [], String.new(""), 0
 
         substr.scan(/\X/).each do |grapheme_cluster|
           grapheme_cluster_width = Unicode::DisplayWidth.of(grapheme_cluster)
           if subsubcell_width + grapheme_cluster_width > @width
-            subsubcells << style_and_align_cell_content(subsubcell)
+            subsubcells << style_and_align_cell_content(subsubcell, line_index)
             subsubcell_width = 0
             subsubcell.clear
+            line_index += 1
           end
 
           subsubcell << grapheme_cluster
           subsubcell_width += grapheme_cluster_width
         end
 
-        subsubcells << style_and_align_cell_content(subsubcell)
+        subsubcells << style_and_align_cell_content(subsubcell, line_index)
+        line_index += 1
+        subsubcells
       end
     end
 
-    def style_and_align_cell_content(content)
+    def style_and_align_cell_content(content, line_index)
       padding = Util.max(@width - Unicode::DisplayWidth.of(content), 0)
       left_padding, right_padding =
         case real_alignment
@@ -99,7 +136,7 @@ module Tabulo
           [padding, 0]
         end
 
-      "#{' ' * left_padding}#{@styler.call(@value, content)}#{' ' * right_padding}"
+      "#{' ' * left_padding}#{apply_styler(content, line_index)}#{' ' * right_padding}"
     end
 
     def real_alignment

data/lib/tabulo/cell_data.rb

@@ -0,0 +1,14 @@
+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.. The header row(s) are not counted for the purpose
+  #   of this numbering.
+  # @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,9 @@ module Tabulo
 
     attr_accessor :width
     attr_reader :header
+    attr_reader :index
+    attr_reader :left_padding
+    attr_reader :right_padding
 
     def initialize(
       align_body:,
@@ -13,7 +16,10 @@ module Tabulo
       formatter:,
       header:,
       header_styler:,
+      index:,
+      left_padding:,
       padding_character:,
+      right_padding:,
       styler:,
       truncation_indicator:,
       width:)
@@ -23,12 +29,22 @@ module Tabulo
       @extractor = extractor
       @formatter = formatter
       @header = header
+      @index = index
+      @left_padding = left_padding
+      @right_padding = right_padding
 
       @header_styler =
         if header_styler
-          -> (_, s) { header_styler.call(s) }
+          case header_styler.arity
+          when 3
+            -> (_, str, cell_data, line_index) { header_styler.call(str, cell_data.column_index, line_index) }
+          when 2
+            -> (_, str, cell_data) { header_styler.call(str, cell_data.column_index) }
+          else
+            -> (_, str) { header_styler.call(str) }
+          end
         else
-          -> (_, s) { s }
+          -> (_, str) { str }
         end
 
       @padding_character = padding_character
@@ -38,10 +54,16 @@ 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 },
+        left_padding: @left_padding,
         padding_character: @padding_character,
+        right_padding: @right_padding,
         styler: @header_styler,
         truncation_indicator: @truncation_indicator,
         value: @header,
@@ -49,20 +71,44 @@ 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,
+        left_padding: @left_padding,
         padding_character: @padding_character,
+        right_padding: @right_padding,
         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
+
+    def padded_width
+      width + total_padding
+    end
+
+    def total_padding
+      @left_padding + @right_padding
+    end
+
+    private
+
+    def body_cell_data_required?
+      @cell_data_required ||= (@styler.arity == 3 || @formatter.arity == 2)
     end
   end
 end