command_kit 0.3.0 → 0.4.0

data/lib/command_kit/printing/fields.rb

@@ -0,0 +1,56 @@
+require 'command_kit/printing/indent'
+
+module CommandKit
+  module Printing
+    #
+    # Supports printing aligned key/value fields.
+    #
+    # @since 0.4.0
+    #
+    module Fields
+      include Indent
+
+      #
+      # Prints a Hash as left-justified `:` separated fields.
+      #
+      # @param [Hash, Array<(Object, Object)>] fields
+      #   The fields to print.
+      #
+      # @example
+      #   print_fields('Name' => 'foo', 'Version' => '0.1.0')
+      #   # Name:    foo
+      #   # Version: 0.1.0
+      #
+      # @api public
+      #
+      def print_fields(fields)
+        max_length = 0
+
+        fields = fields.map { |name,value|
+          name       = name.to_s
+          value      = value.to_s
+          max_length = name.length if name.length > max_length
+
+          [name, value]
+        }
+
+        fields.each do |name,value|
+          first_line, *rest = value.to_s.lines(chomp: true)
+
+          # print the first line with the header
+          header = "#{name}:".ljust(max_length + 1)
+          puts "#{header} #{first_line}"
+
+          # indent and print the rest of the lines
+          indent(max_length + 2) do
+            rest.each do |line|
+              puts line
+            end
+          end
+        end
+
+        return nil
+      end
+    end
+  end
+end

data/lib/command_kit/printing/indent.rb

@@ -7,7 +7,7 @@ module CommandKit
     #
     #     include Printing::Indent
     #     
-    #     def main
+    #     def run
     #       puts "regular output:"
     #     
     #       indent(4) do

data/lib/command_kit/printing/lists.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require 'command_kit/printing/indent'
+
+module CommandKit
+  module Printing
+    #
+    # Methods for printing lists.
+    #
+    # ## Examples
+    #
+    #     include Printing::Lists
+    #     
+    #     def main
+    #       print_list %w[foo bar baz]
+    #       # * foo
+    #       # * bar
+    #       # * baz
+    #
+    #       list = ['item 1', 'item 2', ['sub-item 1', 'sub-item 2']]
+    #       print_list(list)
+    #       # * item 1
+    #       # * item 2
+    #       #   * sub-item 1
+    #       #   * sub-item 2
+    #
+    #       print_list %w[foo bar baz], bullet: '-'
+    #       # - foo
+    #       # - bar
+    #       # - baz
+    #     end
+    #
+    # @since 0.4.0
+    #
+    module Lists
+      include Indent
+
+      #
+      # Prints a bulleted list of items.
+      #
+      # @param [Array<#to_s, Array>] list
+      #   The list of items to print.
+      #
+      # @param [String] bullet
+      #   The bullet character to use for line item.
+      #
+      # @example
+      #   print_list %w[foo bar baz]
+      #   # * foo
+      #   # * bar
+      #   # * baz
+      #
+      # @example print a nested list:
+      #   list = ['item 1', 'item 2', ['sub-item 1', 'sub-item 2']]
+      #   print_list(list)
+      #   # * item 1
+      #   # * item 2
+      #   #   * sub-item 1
+      #   #   * sub-item 2
+      #
+      # @example with a custom bullet character:
+      #   print_list %w[foo bar baz], bullet: '-'
+      #   # - foo
+      #   # - bar
+      #   # - baz
+      #
+      # @since 0.4.0
+      #
+      def print_list(list, bullet: '*')
+        list.each do |item|
+          case item
+          when Array
+            indent { print_list(item, bullet: bullet) }
+          else
+            first_line, *rest = item.to_s.lines(chomp: true)
+
+            # print the bullet only on the first list
+            puts "#{bullet} #{first_line}"
+
+            # indent the remaining lines
+            indent(bullet.length + 1) do
+              rest.each do |line|
+                puts line
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/command_kit/printing/tables/border_style.rb

@@ -0,0 +1,169 @@
+module CommandKit
+  module Printing
+    module Tables
+      #
+      # Represents the table's border style.
+      #
+      # @api private
+      #
+      class BorderStyle
+
+        # The top-left-corner border character.
+        #
+        # @return [String]
+        attr_reader :top_left_corner
+
+        # The top-border character.
+        #
+        # @return [String]
+        attr_reader :top_border
+
+        # The top-joined-border character.
+        #
+        # @return [String]
+        attr_reader :top_joined_border
+
+        # The top-right-corner border character.
+        #
+        # @return [String]
+        attr_reader :top_right_corner
+
+        # The left-hand-side border character.
+        #
+        # @return [String]
+        attr_reader :left_border
+
+        # The left-hand-side-joined-border character.
+        #
+        # @return [String]
+        attr_reader :left_joined_border
+
+        # The horizontal-separator character.
+        #
+        # @return [String]
+        attr_reader :horizontal_separator
+
+        # The vertical-separator character.
+        #
+        # @return [String]
+        attr_reader :vertical_separator
+
+        # The inner-joined border character.
+        #
+        # @return [String]
+        attr_reader :inner_joined_border
+
+        # The right-hand-side border character.
+        #
+        # @return [String]
+        attr_reader :right_border
+
+        # The right-hand-side joined border character.
+        #
+        # @return [String]
+        attr_reader :right_joined_border
+
+        # The bottom border character.
+        #
+        # @return [String]
+        attr_reader :bottom_border
+
+        # The bottom-left-corner border character.
+        #
+        # @return [String]
+        attr_reader :bottom_left_corner
+
+        # The bottom-joined border character.
+        #
+        # @return [String]
+        attr_reader :bottom_joined_border
+
+        # The bottom-right-corner border character.
+        #
+        # @return [String]
+        attr_reader :bottom_right_corner
+
+        #
+        # Initializes the border style.
+        #
+        # @param [String] top_left_corner
+        #   The top-left-corner border character.
+        #
+        # @param [String] top_border
+        # The top-border character.
+        #
+        # @param [String] top_joined_border
+        #   The top-joined-border character.
+        #
+        # @param [String] top_right_corner
+        #   The top-right-corner border character.
+        #
+        # @param [String] left_border
+        #   The left-hand-side border character.
+        #
+        # @param [String] left_joined_border
+        #   The left-hand-side-joined-border character.
+        #
+        # @param [String] horizontal_separator
+        #   The horizontal-separator character.
+        #
+        # @param [String] vertical_separator
+        #   The vertical-separator character.
+        #
+        # @param [String] inner_joined_border
+        #   The inner-joined border character.
+        #
+        # @param [String] right_border
+        #   The right-hand-side border character.
+        #
+        # @param [String] right_joined_border
+        #   The right-hand-side joined border character.
+        #
+        # @param [String] bottom_border
+        #   The bottom border character.
+        #
+        # @param [String] bottom_left_corner
+        #   The bottom-left-corner border character.
+        #
+        # @param [String] bottom_joined_border
+        #   The bottom-joined border character.
+        #
+        # @param [String] bottom_right_corner
+        #   The bottom-right-corner border character.
+        #
+        def initialize(top_left_corner:      ' ',
+                       top_border:           ' ',
+                       top_joined_border:    ' ',
+                       top_right_corner:     ' ',
+                       left_border:          ' ',
+                       left_joined_border:   ' ',
+                       horizontal_separator: ' ',
+                       vertical_separator:   ' ',
+                       inner_joined_border:  ' ',
+                       right_border:         ' ',
+                       right_joined_border:  ' ',
+                       bottom_border:        ' ',
+                       bottom_left_corner:   ' ',
+                       bottom_joined_border: ' ',
+                       bottom_right_corner:  ' ')
+          @top_left_corner      = top_left_corner
+          @top_border           = top_border
+          @top_joined_border    = top_joined_border
+          @top_right_corner     = top_right_corner
+          @left_border          = left_border
+          @left_joined_border   = left_joined_border
+          @horizontal_separator = horizontal_separator
+          @vertical_separator   = vertical_separator
+          @inner_joined_border  = inner_joined_border
+          @right_border         = right_border
+          @right_joined_border  = right_joined_border
+          @bottom_border        = bottom_border
+          @bottom_left_corner   = bottom_left_corner
+          @bottom_joined_border = bottom_joined_border
+          @bottom_right_corner  = bottom_right_corner
+        end
+
+      end
+    end
+  end
+end

data/lib/command_kit/printing/tables/cell_builder.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module CommandKit
+  module Printing
+    module Tables
+      #
+      # Build's a cell and calculates it's dimensions.
+      #
+      # @api private
+      #
+      class CellBuilder
+
+        # The lines within the cell.
+        #
+        # @return [Array<String>]
+        attr_reader :lines
+
+        # The height (in lines) of the cell.
+        #
+        # @return [Integer]
+        attr_reader :height
+
+        # The with (in characters) of the cell.
+        #
+        # @return [Integer]
+        attr_reader :width
+
+        #
+        # Initializes the cell.
+        #
+        # @param [#to_s] value
+        #   The value for the cell.
+        #
+        def initialize(value=nil)
+          @lines  = []
+          @height = 0
+          @width  = 0
+
+          if value
+            value.to_s.each_line(chomp: true) do |line|
+              self << line
+            end
+          end
+        end
+
+        #
+        # Calculates the width of a string, sans any ASNI escape sequences.
+        #
+        # @param [String] string
+        #   The string to calculate the width of.
+        #
+        # @return [Integer]
+        #   The display width of the string.
+        #
+        def self.line_width(string)
+          string.gsub(/\e\[\d+m/,'').length
+        end
+
+        #
+        # Adds a line to the cell.
+        #
+        # @param [String] line
+        #   A line to add to the cell.
+        #
+        # @return [self]
+        #
+        def <<(line)
+          line_width = self.class.line_width(line)
+
+          @height += 1
+          @width   = line_width if line_width > @width
+
+          @lines << line
+          return self
+        end
+
+        #
+        # Fetches a line from the cell.
+        #
+        # @param [Integer] line_index
+        #   The line index to fetch.
+        #
+        # @return [String]
+        #   The line at the line index or an empty String if the cell is empty.
+        #
+        def [](line_index)
+          @lines.fetch(line_index,'')
+        end
+
+      end
+    end
+  end
+end

data/lib/command_kit/printing/tables/row_builder.rb

@@ -0,0 +1,111 @@
+require 'command_kit/printing/tables/cell_builder'
+
+module CommandKit
+  module Printing
+    module Tables
+      #
+      # Builds a table row and calculates it's dimensions.
+      #
+      # @api private
+      #
+      class RowBuilder
+
+        include Enumerable
+
+        # The cells within the row.
+        #
+        # @return [Array<CellBuilder>]
+        attr_reader :cells
+
+        # The height (in lines) for the row.
+        #
+        # @return [Integer]
+        attr_reader :height
+
+        # The width (in characters) for the row.
+        #
+        # @return [Integer]
+        attr_reader :width
+
+        # The number of columns in the row.
+        #
+        # @return [Integer]
+        attr_reader :columns
+
+        #
+        # Initializes the row.
+        #
+        # @param [Array, nil] cells
+        #   The cells for the row.
+        #
+        def initialize(cells=nil)
+          @cells = []
+
+          @height = 0
+          @width  = 0
+
+          @columns = 0
+
+          if cells
+            cells.each { |value| self << value }
+          end
+        end
+
+        # An empty cell.
+        EMPTY_CELL = CellBuilder.new
+
+        #
+        # Appends a value to the row.
+        #
+        # @param [#to_s] value
+        #   The cell value to add to the row.
+        #
+        # @return [self]
+        #
+        def <<(value)
+          new_cell = if value then CellBuilder.new(value)
+                     else          EMPTY_CELL
+                     end
+
+          @height   = new_cell.height if new_cell.height > @height
+          @width   += new_cell.width
+          @columns += 1
+
+          @cells << new_cell
+          return self
+        end
+
+        #
+        # Fetches a cell from the row.
+        #
+        # @param [Integer] column_index
+        #   The column index.
+        #
+        # @return [CellBuilder]
+        #   The cell at the given column index or an empty cell if the row
+        #   does not have a cell at the given column index.
+        #
+        def [](column_index)
+          @cells.fetch(column_index,EMPTY_CELL)
+        end
+
+        #
+        # Enumerates over each cell in the row.
+        #
+        # @yield [cell]
+        #   The given block will be passed each cell within the row.
+        #
+        # @yieldparam [CellBuilder] cell
+        #   A cell within the row.
+        #
+        # @return [Enumerator]
+        #   If no block is given, an Enumerator will be returned.
+        #
+        def each(&block)
+          @cells.each(&block)
+        end
+
+      end
+    end
+  end
+end