tty-table 0.7.0 → 0.12.0

data/lib/tty/table/operation/alignment.rb

@@ -1,6 +1,6 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-require 'verse'
+require "strings"
 
 module TTY
   class Table
@@ -19,10 +19,14 @@ module TTY
 
         # Evaluate alignment of the provided row
         #
+        # @param [TTY::Table::Field] field
+        #   the table field
+        #
         # @param [Array] row
         #  the table row
-        # @param [Hash] options
-        #  the table options
+        #
+        # @param [Integer] col
+        #   the table column index
         #
         # @return [TTY::Table::Field]
         #
@@ -42,18 +46,16 @@ module TTY
         # @param [TTY::Table::Field] field
         #   the table field
         #
-        # @param [Integer] co
+        # @param [Integer] col
         #   the table column index
         #
-        # @param [Hash] options
-        #
         # @return [TTY::Table::Field]
         #
         # @api private
         def align_field(field, col)
           column_width = widths[col]
           direction    = field.alignment || alignments[col] || DEFAULT
-          Verse.align(field.content, column_width, direction)
+          Strings.align(field.content, column_width, direction: direction)
         end
       end # Alignment
     end # Operation

data/lib/tty/table/operation/escape.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module TTY
   class Table
@@ -7,7 +7,6 @@ module TTY
       #
       # @api private
       class Escape
-
         # Escape special characters in a table field
         #
         # @param [TTY::Table::Field] field
@@ -21,7 +20,7 @@ module TTY
         # @api public
         def call(field, row, col)
           field.content.gsub(/(\t|\r|\n)/) do |val|
-            val.dump.gsub('"', '')
+            val.dump.gsub('"', "")
           end
         end
       end # Escape

data/lib/tty/table/operation/filter.rb

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

data/lib/tty/table/operation/padding.rb

@@ -1,6 +1,6 @@
-# coding: utf-8
+# frozen_string_literal: true
 
-require 'verse'
+require "strings"
 
 module TTY
   class Table
@@ -11,9 +11,7 @@ module TTY
       class Padding
         # Initialize a Padding operation
         #
-        # @param [Verse::Padder] padding
-        #
-        # @param [Array[Integer]] widths
+        # @param [Strings::Padder] padding
         #
         # @api public
         def initialize(padding)
@@ -25,17 +23,11 @@ module TTY
         # @param [TTY::Table::Field] field
         #   the table field
         #
-        # @param [Integer] row
-        #   the field row index
-        #
-        # @param [Integer] col
-        #   the field column index
-        #
         # @return [TTY::Table::Field]
         #
         # @api public
         def call(field, *)
-          Verse.pad(field.content, padding)
+          Strings.pad(field.content, padding)
         end
 
         protected

data/lib/tty/table/operation/truncation.rb

@@ -1,6 +1,6 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-require 'verse'
+require "strings"
 
 module TTY
   class Table
@@ -34,8 +34,8 @@ module TTY
         #
         # @api public
         def call(field, row, col)
-          width = widths[col] || field.width
-          Verse.truncate(field.content, width)
+          column_width = widths[col] || field.width
+          Strings.truncate(field.content, column_width)
         end
       end # Truncation
     end # Operation

data/lib/tty/table/operation/wrapped.rb

@@ -1,6 +1,6 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-require 'verse'
+require "strings"
 
 module TTY
   class Table
@@ -33,8 +33,8 @@ module TTY
         #
         # @api public
         def call(field, row, col)
-          width = widths[col] || field.width
-          Verse.wrap(field.content, width)
+          column_width = widths[col] || field.width
+          Strings.wrap(field.content, column_width)
         end
       end # Wrapped
     end # Operation

data/lib/tty/table/operations.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module TTY
   class Table
@@ -8,14 +8,8 @@ module TTY
     class Operations
       # Initialize Operations
       #
-      # @param [TTY::Table] table
-      #   the table to perform operations on
-      #
-      # @return [Object]
-      #
       # @api public
-      def initialize(table)
-        @table      = table
+      def initialize
         @operations = Hash.new { |hash, key| hash[key] = [] }
       end
 
@@ -55,14 +49,14 @@ module TTY
       # @return [TTY::Table]
       #
       # @api public
-      def run_operations(*args)
+      def apply_to(table, *args)
         operation_types = args
         table.data.each_with_index do |row, row_i|
           row.fields.each_with_index do |field, col_i|
             field.reset!
             operation_types.each do |type|
               operations[type].each do |operation|
-                field.content = operation.call(field, row_i, col_i)
+                field.content = operation.(field, row_i, col_i)
               end
             end
           end
@@ -71,11 +65,6 @@ module TTY
 
       protected
 
-      # The table
-      #
-      # @api private
-      attr_reader :table
-
       # Available operations
       #
       # @return [Hash]

data/lib/tty/table/options.rb

@@ -1,10 +1,9 @@
-# coding: utf-8
+# frozen_string_literal: true
 
-require 'delegate'
+require "delegate"
 
 module TTY
   class Table
-
     # Structure for holding table options with indifferent access
     class Options < DelegateClass(Hash)
 
@@ -25,6 +24,5 @@ module TTY
       end
 
     end # Options
-
   end # Table
 end # TTY

data/lib/tty/table/orientation.rb

@@ -1,7 +1,7 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-require 'tty/table/orientation/horizontal'
-require 'tty/table/orientation/vertical'
+require_relative "orientation/horizontal"
+require_relative "orientation/vertical"
 
 module TTY
   class Table
@@ -33,8 +33,8 @@ module TTY
         when /v|ert(ical)?/i
           Vertical.new :vertical
         else
-          fail InvalidOrientationError,
-               'orientation must be one of :horizontal, :vertical'
+          raise InvalidOrientationError,
+                "orientation must be one of :horizontal, :vertical"
         end
       end
 

data/lib/tty/table/orientation/horizontal.rb

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

data/lib/tty/table/orientation/vertical.rb

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

data/lib/tty/table/renderer.rb

@@ -1,17 +1,18 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-require 'tty/table/renderer/basic'
-require 'tty/table/renderer/ascii'
-require 'tty/table/renderer/unicode'
+require_relative "error"
+require_relative "renderer/basic"
+require_relative "renderer/ascii"
+require_relative "renderer/unicode"
 
 module TTY
   class Table
-    # A class responsible for rendering tabular data
+    # A module responsible for selecting tabule data renderer
     #
     # Used internally by {Table} to render table content out.
     #
     # @api private
-    class Renderer
+    module Renderer
       RENDERER_MAPPER = {
         ascii:   TTY::Table::Renderer::ASCII,
         basic:   TTY::Table::Renderer::Basic,
@@ -20,18 +21,19 @@ module TTY
 
       # Select renderer class based on string name.
       #
-      # The possible values for renderer are
+      # The possible values for type are
       #   [:basic, :ascii, :unicode]
       #
-      # @param [Symbol] renderer
-      #   the renderer used for displaying table
+      # @param [Symbol] type
+      #   the renderer type used for displaying table
       #
       # @return [TTY::Table::Renderer]
       #
       # @api private
-      def self.select(type)
+      def select(type)
         RENDERER_MAPPER[type || :basic]
       end
+      module_function :select
 
       # Raises an error if provided border class is of wrong type or has invalid
       # implementation
@@ -43,17 +45,38 @@ module TTY
       #   raised when border class does not implement core methods
       #
       # @api public
-      def self.assert_border_class(border_class)
+      def assert_border_class(border_class)
         return unless border_class
         unless border_class <= TTY::Table::Border
-          fail TypeError,
-               "#{border_class} should inherit from TTY::Table::Border"
+          raise TypeError,
+                "#{border_class} should inherit from TTY::Table::Border"
         end
         unless border_class.characters
-          fail NoImplementationError,
-               "#{border_class} should implement def_border"
+          raise NoImplementationError,
+                "#{border_class} should implement def_border"
         end
       end
+      module_function :assert_border_class
+
+      # Render a given table and return the string representation.
+      #
+      # @param [TTY::Table] table
+      #   the table to be rendered
+      #
+      # @param [Hash] options
+      #   the options to render the table with
+      # @option options [String] :renderer
+      #   used to format table output
+      #
+      # @return [String]
+      #
+      # @api public
+      def render(table, options = {}, &block)
+        renderer = select(options[:renderer]).new(table, options)
+        yield renderer if block_given?
+        renderer.render
+      end
+      module_function :render
 
       # Add custom border for the renderer
       #
@@ -70,30 +93,12 @@ module TTY
       #   raise if the klass does not implement def_border
       #
       # @api public
-      def self.render_with(border_class, table, options = {}, &block)
+      def render_with(border_class, table, options = {}, &block)
         assert_border_class(border_class)
         options[:border_class] = border_class if border_class
         render(table, options, &block)
       end
-
-      # Render a given table and return the string representation.
-      #
-      # @param [TTY::Table] table
-      #   the table to be rendered
-      #
-      # @param [Hash] options
-      #   the options to render the table with
-      # @option options [String] :renderer
-      #   used to format table output
-      #
-      # @return [String]
-      #
-      # @api public
-      def self.render(table, options = {}, &block)
-        renderer = select(options[:renderer]).new(table, options)
-        yield renderer if block_given?
-        renderer.render
-      end
+      module_function :render_with
     end # Renderer
   end # Table
 end # TTY

data/lib/tty/table/renderer/ascii.rb

@@ -1,11 +1,11 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-require 'tty/table/border/ascii'
-require 'tty/table/renderer/basic'
+require_relative "../border/ascii"
+require_relative "../renderer/basic"
 
 module TTY
   class Table
-    class Renderer
+    module Renderer
       class ASCII < Basic
         # Create ASCII renderer
         #

data/lib/tty/table/renderer/basic.rb

@@ -1,28 +1,27 @@
-# encoding: utf-8
-
-require 'tty-screen'
-require 'verse'
-
-require 'tty/table/alignment_set'
-require 'tty/table/border_dsl'
-require 'tty/table/border_options'
-require 'tty/table/border/null'
-require 'tty/table/column_constraint'
-require 'tty/table/column_set'
-require 'tty/table/header'
-require 'tty/table/indentation'
-require 'tty/table/operations'
-require 'tty/table/operation/alignment'
-require 'tty/table/operation/truncation'
-require 'tty/table/operation/wrapped'
-require 'tty/table/operation/filter'
-require 'tty/table/operation/escape'
-require 'tty/table/operation/padding'
-require 'tty/table/validatable'
+# frozen_string_literal: true
+
+require "strings"
+require "tty-screen"
+
+require_relative "../alignment_set"
+require_relative "../border_dsl"
+require_relative "../border/null"
+require_relative "../column_constraint"
+require_relative "../columns"
+require_relative "../header"
+require_relative "../indentation"
+require_relative "../operations"
+require_relative "../operation/alignment"
+require_relative "../operation/truncation"
+require_relative "../operation/wrapped"
+require_relative "../operation/filter"
+require_relative "../operation/escape"
+require_relative "../operation/padding"
+require_relative "../validatable"
 
 module TTY
   class Table
-    class Renderer
+    module Renderer
       # Renders table without any border styles.
       #
       # @api private
@@ -70,7 +69,7 @@ module TTY
         # @api public
         attr_reader :indent
 
-        # The table totabl width
+        # The table total width
         #
         # @return [Integer]
         #
@@ -113,16 +112,19 @@ module TTY
         def initialize(table, options = {})
           @table         = assert_table_type(table)
           @multiline     = options.fetch(:multiline) { false }
-          @border        = TTY::Table::BorderOptions.from(options.delete(:border))
+          @border        = BorderDSL.new(options.delete(:border)).options
+          unless @table.separators.empty?
+            @border.separator ||= @table.separators
+          end
           @column_widths = options.fetch(:column_widths, nil)
           alignment      = Array(options[:alignment]) * table.columns_size
-          @alignments    = TTY::Table::AlignmentSet.new(options[:alignments] || alignment)
+          @alignments    = AlignmentSet.new(options[:alignments] || alignment)
           @filter        = options.fetch(:filter) { proc { |val, _| val } }
           @width         = options.fetch(:width) { TTY::Screen.width }
           @border_class  = options.fetch(:border_class) { Border::Null }
           @indent        = options.fetch(:indent) { 0 }
           @resize        = options.fetch(:resize) { false }
-          @padding       = Verse::Padder.parse(options[:padding])
+          @padding       = Strings::Padder.parse(options[:padding])
         end
 
         # Parses supplied column widths, if not present
@@ -132,7 +134,7 @@ module TTY
         #
         # @api public
         def column_widths
-          @column_widths = ColumnSet.widths_from(table, @column_widths)
+          @column_widths = Columns.widths_from(table, @column_widths)
         end
 
         # Store border characters, style and separator for the table rendering
@@ -143,17 +145,13 @@ module TTY
         #   block representing border options
         #
         # @api public
-        def border(options=(not_set=true), &block)
-          @border = TTY::Table::BorderOptions.new unless @border
-          if block_given?
-            border_dsl = TTY::Table::BorderDSL.new(&block)
-            @border = border_dsl.options
-          elsif !not_set
-            @border = TTY::Table::BorderOptions.from(options)
-          end
-          @border
+        def border(border_opts = (not_set = true), &block)
+          return @border if not_set && !block_given?
+
+          border_opts = {} if not_set
+          @border = BorderDSL.new(border_opts, &block).options
         end
-        alias_method :border=, :border
+        alias border= border
 
         # Change the value of indentation
         #
@@ -162,7 +160,7 @@ module TTY
         #
         # @api public
         def indent=(value)
-          @indentation.indentation = value
+          @indent = value
         end
 
         # Sets the output padding,
@@ -172,7 +170,7 @@ module TTY
         #
         # @api public
         def padding=(value)
-          @padding = Verse::Padder.parse(value)
+          @padding = Strings::Padder.parse(value)
         end
 
         # Renders table as string with border
@@ -188,32 +186,48 @@ module TTY
         def render
           return if table.empty?
 
-          @operations = TTY::Table::Operations.new(table)
-          @operations.add(:escape, Operation::Escape.new)
-          @operations.run_operations(:escape) unless multiline
+          operations = TTY::Table::Operations.new
+          operations.add(:escape, Operation::Escape.new)
+          operations.apply_to(table, :escape) unless multiline
+
           column_constraint = ColumnConstraint.new(table, self)
           @column_widths = column_constraint.enforce
-          add_operations(@column_widths)
+          widths_without_padding = @column_widths.map do |_width|
+                                    _width - padding.left - padding.right
+                                  end
+          create_operations(widths_without_padding).each do |op|
+            operations.add(*op)
+          end
+          operations.apply_to(table, *select_operations)
+
+          render_data.compact.join("\n")
+        end
+
+        # Select applicable operations for this table
+        #
+        # @api private
+        def select_operations
           ops = []
           ops << :escape unless multiline
           ops << :alignment
           ops << (multiline ? :wrapping : :truncation)
           ops << :padding
           ops << :filter
-          @operations.run_operations(*ops)
-
-          render_data.compact.join("\n")
         end
 
-        # Initialize and add operations
+        # Initialize operations
+        #
+        # @return [Array[String, Operation]]
         #
         # @api private
-        def add_operations(widths)
-          @operations.add(:alignment,  Operation::Alignment.new(alignments, widths))
-          @operations.add(:filter,     Operation::Filter.new(filter))
-          @operations.add(:truncation, Operation::Truncation.new(widths))
-          @operations.add(:wrapping,   Operation::Wrapped.new(widths))
-          @operations.add(:padding,    Operation::Padding.new(padding))
+        def create_operations(widths)
+          [
+            [:alignment,  Operation::Alignment.new(alignments, widths)],
+            [:filter,     Operation::Filter.new(filter)],
+            [:truncation, Operation::Truncation.new(widths)],
+            [:wrapping,   Operation::Wrapped.new(widths)],
+            [:padding,    Operation::Padding.new(padding)]
+          ]
         end
 
         protected
@@ -225,33 +239,17 @@ module TTY
         # @api public
         attr_reader :table
 
-        # Initializes indentation
-        #
-        # @return [TTY::Table::Indentation]
-        #
-        # @api private
-        def indentation
-          @indentation ||= TTY::Table::Indentation.new(indent)
-        end
-
-        # Delegate indentation insertion
-        #
-        # @api public
-        def insert_indent(line)
-          indentation.indent(line)
-        end
-
         # Render table data
         #
         # @api private
         def render_data
           first_row        = table.first
-          data_border      = border_class.new(column_widths, padding, border)
+          data_border      = border_class.new(column_widths, border)
           header           = render_header(first_row, data_border)
           rows_with_border = render_rows(data_border)
           bottom_line      = data_border.bottom_line
 
-          insert_indent(bottom_line) if bottom_line
+          bottom_line = Indentation.indent(bottom_line, @indent) if bottom_line
 
           [header, rows_with_border, bottom_line].compact
         end
@@ -261,7 +259,7 @@ module TTY
         # @param [TTY::Table::Row, TTY::Table::Header] row
         #   the first row in the table
         #
-        # @param [TTY::Table::Border] data_boder
+        # @param [TTY::Table::Border] data_border
         #   the border for this table
         #
         # @return [String]
@@ -269,17 +267,17 @@ module TTY
         # @api private
         def render_header(row, data_border)
           top_line = data_border.top_line
-          if row.is_a?(TTY::Table::Header)
-            header = [top_line, data_border.row_line(row), data_border.separator]
-            insert_indent(header.compact)
-          else
-            top_line
+          return top_line unless row.is_a?(TTY::Table::Header)
+          header = [top_line, data_border.row_line(row)]
+          if !border.separator || border.separator?(0)
+            header << data_border.middle_line
           end
+          Indentation.indent(header.compact, @indent)
         end
 
         # Format the rows
         #
-        # @param [TTY::Table::Border] data_boder
+        # @param [TTY::Table::Border] data_border
         #   the border for this table
         #
         # @return [Arrays[String]]
@@ -288,8 +286,9 @@ module TTY
         def render_rows(data_border)
           rows = table.rows
           size = rows.size
+          offset = table.first.is_a?(TTY::Table::Header) ? 1 : 0
           rows.each_with_index.map do |row, index|
-            render_row(row, data_border, size != (index += 1))
+            render_row(row, index+offset, data_border, size != (index + 1))
           end
         end
 
@@ -298,21 +297,19 @@ module TTY
         # @param [Array] row
         #   a row to decorate
         #
-        # @param [TTY::Table::Border] data_boder
+        # @param [TTY::Table::Border] data_border
         #   the border for this table
         #
-        # @param [Boolean] is_last_row
+        # @param [Boolean] is_not_last_row
         #
         # @api private
-        def render_row(row, data_border, is_last_row)
-          separator = data_border.separator
+        def render_row(row, index, data_border, is_not_last_row)
           row_line  = data_border.row_line(row)
-
-          if (border.separator == TTY::Table::Border::EACH_ROW) && is_last_row
-            insert_indent([row_line, separator])
-          else
-            insert_indent(row_line)
+          line = [row_line]
+          if border.separator?(index) && is_not_last_row
+            line << data_border.middle_line
           end
+          Indentation.indent(line, @indent)
         end
       end # Basic
     end # Renderer