tty-table 0.7.0 → 0.12.0

data/lib/tty/table/column_constraint.rb

@@ -1,7 +1,8 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-require 'tty/table/column_set'
-require 'tty/table/border/null'
+require_relative "border/null"
+require_relative "columns"
+require_relative "error"
 
 module TTY
   class Table
@@ -56,7 +57,7 @@ module TTY
       # @api public
       def padding_size
         padding = renderer.padding
-        (padding.left + padding.right) * (table.columns_size - 1)
+        (padding.left + padding.right) * table.columns_count
       end
 
       # Estimate minimum table width to be able to display content
@@ -85,9 +86,16 @@ module TTY
       # @api public
       def enforce
         assert_minimum_width
+        padding = renderer.padding
 
         if natural_width <= renderer.width
-          renderer.resize ? expand : renderer.column_widths
+          if renderer.resize
+            expand_column_widths
+          else
+            renderer.column_widths.map do |width|
+              padding.left + width + padding.right
+            end
+          end
         else
           if renderer.resize
             shrink
@@ -103,23 +111,23 @@ module TTY
       #
       # @api private
       def rotate
-        Kernel.warn 'The table size exceeds the currently set width.' \
-                   'To avoid error either. Defaulting to vertical ' \
-                   'orientation.'
+        Kernel.warn "The table size exceeds the currently set width." \
+                    "Defaulting to vertical orientation."
         table.orientation = :vertical
         table.rotate
-        ColumnSet.widths_from(table)
+        Columns.widths_from(table)
       end
 
       # Expand column widths to match the requested width
       #
       # @api private
-      def expand
-        column_size = table.columns_size
-        ratio       = ((renderer.width - natural_width) / column_size.to_f).floor
+      def expand_column_widths
+        columns_count = table.columns_count
+        max_width     = renderer.width
+        extra_column_width = ((max_width - natural_width) / columns_count.to_f).floor
 
-        widths = (0...column_size).reduce([]) do |lengths, col|
-          lengths + [renderer.column_widths[col] + ratio]
+        widths = (0...columns_count).reduce([]) do |lengths, col|
+          lengths << renderer.column_widths[col] + extra_column_width
         end
         distribute_extra_width(widths)
       end
@@ -132,7 +140,11 @@ module TTY
         ratio       = ((natural_width - renderer.width) / column_size.to_f).ceil
 
         widths = (0...column_size).reduce([]) do |lengths, col|
-          lengths + [renderer.column_widths[col] - ratio]
+          width = (renderer.column_widths[col] - ratio)
+          # basically ruby 2.4 Numeric#clamp
+          width = width < minimum_width ? minimum_width : width
+          width = width > renderer.width ? renderer.width : width
+          lengths << width
         end
         distribute_extra_width(widths)
       end
@@ -145,8 +157,8 @@ module TTY
       def assert_minimum_width
         width = renderer.width
         return unless width <= minimum_width
-        fail ResizeError, "Table's width is too small to contain the content " \
-                          "(min width #{minimum_width}, currently set #{width})"
+        raise ResizeError, "Table's width is too small to contain the content " \
+                           "(min width #{minimum_width}, currently set #{width})"
       end
 
       # Distribute remaining width to meet the total width requirement.

data/lib/tty/table/{column_set.rb → columns.rb}

@@ -1,64 +1,54 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-require 'equatable'
+require_relative "error"
 
 module TTY
   class Table
-    # A class that represents table column properties.
+    # A module for calculating table data column widths
     #
     # Used by {Table} to manage column sizing.
     #
     # @api private
-    class ColumnSet
-      include Equatable
-
-      # Initialize a ColumnSet
-      #
-      # @param [Array[Array[Object]]] data
-      #
-      # @api public
-      def initialize(table)
-        @data = table.data
-      end
-
+    module Columns
       # Calculate total table width
       #
       # @return [Integer]
       #
       # @api public
-      def total_width
-        extract_widths.reduce(:+)
+      def total_width(data)
+        extract_widths(data).reduce(:+)
       end
+      module_function :total_width
 
       # Calcualte maximum column widths
       #
       # @return [Array] column widths
       #
       # @api private
-      def extract_widths
+      def extract_widths(data)
         colcount = data.max { |row_a, row_b| row_a.size <=> row_b.size }.size
-        find_maximas(colcount)
+        (0...colcount).reduce([]) do |maximas, col_index|
+          maximas << find_maximum(data, col_index)
+          maximas
+        end
       end
+      module_function :extract_widths
 
-      # Assert data integrity for column widths
-      #
-      # @param [Array] column_widths
+      # Find a maximum column width. The calculation takes into account
+      # wether the content is escaped or not.
       #
-      # @param [Integer] table_widths
+      # @param [Integer] index
+      #   the column index
       #
-      # @raise [TTY::InvalidArgument]
+      # @return [Integer]
       #
-      # @api public
-      def self.assert_widths(column_widths, table_widths)
-        if column_widths.empty?
-          fail InvalidArgument, 'Value for :column_widths must be ' \
-                                 'a non-empty array'
-        end
-        if column_widths.size != table_widths
-          fail InvalidArgument, 'Value for :column_widths must match ' \
-                                 'table column count'
-        end
+      # @api private
+      def find_maximum(data, index)
+        data.map do |row|
+          (field = row.call(index)) ? field.length : 0
+        end.max
       end
+      module_function :find_maximum
 
       # Converts column widths to array format or infers default widths
       #
@@ -69,7 +59,7 @@ module TTY
       # @return [Array[Integer]]
       #
       # @api public
-      def self.widths_from(table, column_widths = nil)
+      def widths_from(table, column_widths = nil)
         case column_widths
         when Array
           assert_widths(column_widths, table.columns_size)
@@ -77,48 +67,33 @@ module TTY
         when Numeric
           Array.new(table.columns_size, column_widths)
         when NilClass
-          new(table).extract_widths
+          extract_widths(table.data)
         else
-          fail TypeError, 'Invalid type for column widths'
+          raise TypeError, "Invalid type for column widths"
         end
       end
+      module_function :widths_from
 
-      private
-
-      attr_reader :data
-
-      # Find maximum widths for each row and header if present.
-      #
-      # @param [Integer] colcount
-      #   number of columns
-      #
-      # @return [Array[Integer]]
+      # Assert data integrity for column widths
       #
-      # @api private
-      def find_maximas(colcount)
-        maximas = []
-        start   = 0
-
-        start.upto(colcount - 1) do |col_index|
-          maximas << find_maximum(col_index)
-        end
-        maximas
-      end
-
-      # Find a maximum column width. The calculation takes into account
-      # wether the content is escaped or not.
+      # @param [Array] column_widths
       #
-      # @param [Integer] index
-      #   the column index
+      # @param [Integer] table_widths
       #
-      # @return [Integer]
+      # @raise [TTY::InvalidArgument]
       #
-      # @api private
-      def find_maximum(index)
-        data.map do |row|
-          (field = row.call(index)) ? field.length : 0
-        end.max
+      # @api public
+      def assert_widths(column_widths, table_widths)
+        if column_widths.empty?
+          raise InvalidArgument, "Value for :column_widths must be " \
+                                 "a non-empty array"
+        end
+        if column_widths.size != table_widths
+          raise InvalidArgument, "Value for :column_widths must match " \
+                                 "table column count"
+        end
       end
-    end # ColumnSet
+      module_function :assert_widths
+    end # Columns
   end # Table
 end # TTY

data/lib/tty/table/empty.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module TTY
   class Table
     class Empty < TTY::Table

data/lib/tty/table/error.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module TTY
   class Table

data/lib/tty/table/field.rb

@@ -1,8 +1,6 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-require 'equatable'
-require 'pastel'
-require 'unicode/display_width'
+require "strings"
 
 module TTY
   class Table
@@ -13,32 +11,15 @@ module TTY
     #
     # @api private
     class Field
-      include Equatable
-
       # The value inside the field
       #
       # @api public
-      attr_reader :value
+      attr_accessor :value
 
       # The formatted value inside the field used for display
       #
       # @api public
-      attr_reader :content
-
-      # The name for the value
-      #
-      # @api public
-      attr_reader :name
-
-      # The actual value
-      #
-      # @api public
-      attr_writer :value
-
-      # The formatted string
-      #
-      # @api public
-      attr_writer :content
+      attr_accessor :content
 
       # Number of columns this field spans. Defaults to 1.
       #
@@ -58,15 +39,15 @@ module TTY
       # Initialize a Field
       #
       # @example
-      #   field = TTY::Table::Field.new 'a1'
+      #   field = TTY::Table::Field.new "a1"
       #   field.value  # => a1
       #
       # @example
-      #   field = TTY::Table::Field.new value: 'a1'
+      #   field = TTY::Table::Field.new value: "a1"
       #   field.value  # => a1
       #
       # @example
-      #   field = TTY::Table::Field.new value: 'a1', alignment: :center
+      #   field = TTY::Table::Field.new value: "a1", alignment: :center
       #   field.value     # => a1
       #   field.alignment # => :center
       #
@@ -75,9 +56,9 @@ module TTY
         @value, options = extract_options(value)
         @content = @value.to_s
         @width   = options[:width]
-        @alignment = options.fetch(:alignment) { nil }
-        @colspan = options.fetch(:colspan) { 1 }
-        @rowspan = options.fetch(:rowspan) { 1 }
+        @alignment = options.fetch(:alignment, nil)
+        @colspan = options.fetch(:colspan, 1)
+        @rowspan = options.fetch(:rowspan, 1)
       end
 
       # Extract options and set value
@@ -104,7 +85,7 @@ module TTY
       #
       # @api public
       def width
-        @width || display_width(@content)
+        @width || Strings::Align.display_width(@content)
       end
 
       # Return number of lines this value spans.
@@ -127,7 +108,7 @@ module TTY
       # @api public
       def length
         (lines.map do |line|
-          display_width(self.class.color.strip(line))
+          Strings::Align.display_width(line)
         end << 0).max
       end
 
@@ -153,14 +134,41 @@ module TTY
         content
       end
 
+      # Compare fields for equality of value attribute
+      #
+      # @return [Boolean]
+      #
       # @api public
-      def self.color
-        @color ||= Pastel.new(enabled: true)
+      def eql?(other)
+        instance_of?(other.class) && value.eql?(other.value)
       end
 
+      # Compare fields for equivalence of value attribute
+      #
+      # @return [Boolean]
+      #
+      # @api public
+      def ==(other)
+        other.is_a?(self.class) && value == other.value
+      end
+
+      # Inspect this instance attributes
+      #
+      # @return [String]
+      #
+      # @api public
+      def inspect
+        "#<#{self.class.name} value=#{value.inspect} " \
+          "rowspan=#{rowspan.inspect} colspan=#{colspan.inspect}>"
+      end
+
+      # Hash for this instance and its attributes
+      #
+      # @return [Numeric]
+      #
       # @api public
-      def display_width(string)
-        Unicode::DisplayWidth.of(string)
+      def hash
+        [self.class, value].hash
       end
     end # Field
   end # Table

data/lib/tty/table/header.rb

@@ -1,7 +1,9 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-require 'forwardable'
-require 'tty/table/field'
+require "forwardable"
+
+require_relative "error"
+require_relative "field"
 
 module TTY
   class Table
@@ -76,8 +78,8 @@ module TTY
           @attributes[attribute].value
         else
           @attribute_for.fetch(to_field(attribute)) do |header_name|
-            fail UnknownAttributeError,
-                 "the header '#{header_name.value}' is unknown"
+            raise UnknownAttributeError,
+                  "the header '#{header_name.value}' is unknown"
           end
         end
       end

data/lib/tty/table/indentation.rb

@@ -1,47 +1,38 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module TTY
   class Table
-    # A class responsible for indenting table representation
-    class Indentation
-      # The amount of indentation
-      #
-      # @api public
-      attr_accessor :indentation
-
-      # Initialize an Indentation
-      #
-      # @api public
-      def initialize(indentation)
-        @indentation = indentation
-      end
-
+    # A module responsible for indenting table representation
+    module Indentation
       # Return a table part with indentation inserted
       #
       # @param [#map, #to_s] part
       #   the rendered table part
       #
       # @api public
-      def indent(part)
-        if part.respond_to?(:to_a)
-          part.map { |line| insert_indentation(line) }
+      def indent(part, indentation)
+        if part.is_a?(Enumerable) && part.respond_to?(:to_a)
+          part.map { |line| insert_indentation(line, indentation) }
         else
-          insert_indentation(part)
+          insert_indentation(part, indentation)
         end
       end
-
-      private
+      module_function :indent
 
       # Insert indentation into a table renderd line
       #
-      # @param [#to_a, #to_s] line
+      # @param [String] line
       #   the rendered table line
+      # @param [Integer] indentation
+      #   the amount of indentation to apply
+      #
+      # @return [String]
       #
       # @api public
-      def insert_indentation(line)
-        line = line.is_a?(Array) ? line[0] : line
-        line.insert(0, ' ' * indentation) if line
+      def insert_indentation(line, indentation)
+        line ? " " * indentation + line.to_s : ""
       end
+      module_function :insert_indentation
     end # Indentation
   end # Table
 end # TTY