piotrmurach/tty-option

View on GitHub
lib/tty/option/usage_wrapper.rb

Summary

Maintainability
A
0 mins
Test Coverage
# frozen_string_literal: true

module TTY
  module Option
    module UsageWrapper
      # Wrap a string to a maximum width with indentation
      #
      # @param [String] text
      # @param [Integer] width
      # @param [Integer] indent
      # @param [Boolean] indent_first
      #
      # @api public
      def wrap(text, width: 80, indent: 2, indent_first: false)
        wrap = width - indent
        lines = []
        indentation = " " * indent

        line, rest = *next_line(text, wrap: wrap)
        lines << (indent_first ? indentation : "") + line

        while !rest.nil?
          line, rest = *next_line(rest, wrap: wrap)
          lines << indentation + line.strip
        end

        lines.join("\n")
      end
      module_function :wrap

      # Extract a line from a string and return remainder
      #
      # @param [String] str
      # @param [Integer] wrap
      #
      # @return [Array<String, String>]
      #
      # @api private
      def next_line(text, wrap: nil)
        line = text[0, wrap + 1] # account for word boundary
        index = line.index("\n", 1)

        # line without newlines and can be broken
        if (index.nil? || index.zero?) && wrap < line.length
          index = line.rindex(/\s/)
        end

        # line without any whitespace
        if index.nil? || index.zero?
          index = wrap
        end

        [text[0...index], text[index..-1]]
      end
      module_function :next_line
      private_class_method :next_line
    end # StringsHelper
  end # Option
end # TTY