tty-table 0.11.0 → 0.12.0

data/lib/tty/table/border/row_line.rb

@@ -9,8 +9,9 @@ module TTY
         #
         # @api public
         def colorize(border, style)
-          colorized_chars = border.set_color(style, right, center, left)
-          self.right, self.center, self.left = colorized_chars
+          self.right = border.set_color(style, right)
+          self.center = border.set_color(style, center)
+          self.left = border.set_color(style, left)
         end
       end # RowLine
     end # Border

data/lib/tty/table/border/unicode.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative '../border'
+require_relative "../border"
 
 module TTY
   class Table
@@ -11,21 +11,21 @@ module TTY
       class Unicode < Border
 
         def_border do
-          top          '─'
-          top_mid      '┬'
-          top_left     '┌'
-          top_right    '┐'
-          bottom       '─'
-          bottom_mid   '┴'
-          bottom_left  '└'
-          bottom_right '┘'
-          mid          '─'
-          mid_mid      '┼'
-          mid_left     '├'
-          mid_right    '┤'
-          left         '│'
-          center       '│'
-          right        '│'
+          top          "─"
+          top_mid      "┬"
+          top_left     "┌"
+          top_right    "┐"
+          bottom       "─"
+          bottom_mid   "┴"
+          bottom_left  "└"
+          bottom_right "┘"
+          mid          "─"
+          mid_mid      "┼"
+          mid_left     "├"
+          mid_right    "┤"
+          left         "│"
+          center       "│"
+          right        "│"
         end
 
       end # Unicode

data/lib/tty/table/border_dsl.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'forwardable'
+require "forwardable"
 
-require_relative 'border_options'
+require_relative "border_options"
 
 module TTY
   class Table
@@ -29,9 +29,8 @@ module TTY
       # @return [undefined]
       #
       # @api private
-      def initialize(characters = nil, &block)
-        @options = TTY::Table::BorderOptions.new
-        @options.characters = characters if characters
+      def initialize(border_opts = nil, &block)
+        @options = TTY::Table::BorderOptions.from(border_opts)
         yield_or_eval(&block) if block_given?
       end
 
@@ -45,6 +44,7 @@ module TTY
       # @api public
       def style(value = (not_set = true))
         return options.style if not_set
+
         options.style = value
       end
 
@@ -56,8 +56,10 @@ module TTY
       # @return [undefined]
       #
       # @api public
-      def separator(value)
-        value ? options.separator = value : options.separator
+      def separator(value = (not_set = true))
+        return options.separator if not_set
+
+        options.separator = value
       end
 
       # Set top border character
@@ -69,7 +71,7 @@ module TTY
       #
       # @api public
       def top(value)
-        options.characters['top'] = value
+        characters["top"] = value
       end
 
       # Set top middle border character
@@ -81,7 +83,7 @@ module TTY
       #
       # @api public
       def top_mid(value)
-        options.characters['top_mid'] = value
+        characters["top_mid"] = value
       end
 
       # Set top left corner border character
@@ -93,7 +95,7 @@ module TTY
       #
       # @api public
       def top_left(value)
-        options.characters['top_left'] = value
+        characters["top_left"] = value
       end
 
       # Set top right corner border character
@@ -105,7 +107,7 @@ module TTY
       #
       # @api public
       def top_right(value)
-        options.characters['top_right'] = value
+        characters["top_right"] = value
       end
 
       # Set bottom border character
@@ -117,7 +119,7 @@ module TTY
       #
       # @api public
       def bottom(value)
-        options.characters['bottom'] = value
+        characters["bottom"] = value
       end
 
       # Set bottom middle border character
@@ -129,7 +131,7 @@ module TTY
       #
       # @api public
       def bottom_mid(value)
-        options.characters['bottom_mid'] = value
+        characters["bottom_mid"] = value
       end
 
       # Set bottom left corner border character
@@ -141,7 +143,7 @@ module TTY
       #
       # @api public
       def bottom_left(value)
-        options.characters['bottom_left'] = value
+        characters["bottom_left"] = value
       end
 
       # Set bottom right corner border character
@@ -153,7 +155,7 @@ module TTY
       #
       # @api public
       def bottom_right(value)
-        options.characters['bottom_right'] = value
+        characters["bottom_right"] = value
       end
 
       # Set middle border character
@@ -165,7 +167,7 @@ module TTY
       #
       # @api public
       def mid(value)
-        options.characters['mid'] = value
+        characters["mid"] = value
       end
 
       # Set middle border character
@@ -177,7 +179,7 @@ module TTY
       #
       # @api public
       def mid_mid(value)
-        options.characters['mid_mid'] = value
+        characters["mid_mid"] = value
       end
 
       # Set middle left corner border character
@@ -189,7 +191,7 @@ module TTY
       #
       # @api public
       def mid_left(value)
-        options.characters['mid_left'] = value
+        characters["mid_left"] = value
       end
 
       # Set middle right corner border character
@@ -201,7 +203,7 @@ module TTY
       #
       # @api public
       def mid_right(value)
-        options.characters['mid_right'] = value
+        characters["mid_right"] = value
       end
 
       # Set left border character
@@ -213,7 +215,7 @@ module TTY
       #
       # @api public
       def left(value)
-        options.characters['left'] = value
+        characters["left"] = value
       end
 
       # Set center border character
@@ -225,7 +227,7 @@ module TTY
       #
       # @api public
       def center(value)
-        options.characters['center'] = value
+        characters["center"] = value
       end
 
       # Set right border character
@@ -237,7 +239,7 @@ module TTY
       #
       # @api public
       def right(value)
-        options.characters['right'] = value
+        characters["right"] = value
       end
 
       private

data/lib/tty/table/border_options.rb

@@ -7,49 +7,54 @@ module TTY
     # Used internally by {Table::Border} to manage options such as style
     #
     # @api private
-    class BorderOptions < Struct.new(:characters, :separator, :style)
-      # Initialize a BorderOptions
-      #
-      # @api public
-      def initialize(*args)
-        super(*args)
-        self.characters = {} unless characters
-      end
-
+    class BorderOptions
       # Create options instance from hash
       #
       # @api public
-      def self.from(value)
-        value ? new.update(value) : new
+      def self.from(options)
+        return new if options.nil?
+
+        opts = case options
+               when self.class
+                 options.to_hash
+               else
+                 options
+               end
+        new(**opts)
       end
 
-      # Set all accessors with hash attributes
-      #
-      # @param [Hash, BorderOptions] obj
+      attr_accessor :characters
+
+      attr_accessor :separator
+
+      attr_accessor :style
+
+      # Initialize a BorderOptions
       #
-      # @return [BorderOptions]
+      # @param [String] style
+      #   the style like :red
+      # @param [String] separator
+      #   the separator character
+      # @param [Hash] characters
+      #   the border characters
       #
       # @api public
-      def update(obj)
-        obj.each_pair do |key, value|
-          send("#{key}=", value)
-        end
-        self
+      def initialize(characters: {}, separator: nil, style: nil)
+        @characters = characters
+        @separator = separator
+        @style = style
       end
 
       # Convert to hash
       #
+      # @return [Hash]
+      #
       # @api public
       def to_hash
-        hash = {}
-        members.each do |key|
-          value = send(key)
-          hash[key.to_sym] = value if value
-        end
-        hash
+        { characters: characters, separator: separator, style: style }
       end
 
-      # return true if there should be a separator AFTER this line
+      # Check if there should be a separator AFTER this line
       #
       # @param [Integer] line
       #

data/lib/tty/table/column_constraint.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require_relative 'border/null'
-require_relative 'columns'
-require_relative 'error'
+require_relative "border/null"
+require_relative "columns"
+require_relative "error"
 
 module TTY
   class Table
@@ -111,9 +111,8 @@ 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
         Columns.widths_from(table)
@@ -141,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
@@ -154,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/columns.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'error'
+require_relative "error"
 
 module TTY
   class Table
@@ -69,7 +69,7 @@ module TTY
         when NilClass
           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
@@ -85,12 +85,12 @@ module TTY
       # @api public
       def assert_widths(column_widths, table_widths)
         if column_widths.empty?
-          fail InvalidArgument, 'Value for :column_widths must be ' \
-                                 'a non-empty array'
+          raise 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'
+          raise InvalidArgument, "Value for :column_widths must match " \
+                                 "table column count"
         end
       end
       module_function :assert_widths

data/lib/tty/table/field.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
-require 'equatable'
-require 'pastel'
-require 'strings'
+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
@@ -152,6 +133,43 @@ module TTY
       def to_s
         content
       end
+
+      # Compare fields for equality of value attribute
+      #
+      # @return [Boolean]
+      #
+      # @api public
+      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 hash
+        [self.class, value].hash
+      end
     end # Field
   end # Table
 end # TTY