File Manager

Viewing File: align.rb

# frozen_string_literal: true

require 'strings-ansi'
require 'unicode/display_width'

module Strings
  # Responsible for text alignment
  module Align
    NEWLINE = "\n".freeze
    SPACE = " ".freeze
    LINE_BREAK = %r{\r\n|\r|\n}.freeze

    # Aligns text within the width.
    #
    # If the text is greater than the width then unmodified
    # string is returned.
    #
    # @param [String] text
    #   the text to align lines of
    # @param [Integer] width
    #   the maximum width to align to
    #
    # @example
    #   text = "the madness of men"
    #
    #   Strings::Align.align(text, 22, direction: :left)
    #   # => "the madness of men      "
    #
    #   Strings::Align.align(text, 22, direction: :center)
    #   # => "   the madness of men   "
    #
    #   Strings::Align(text, 22, direction: :right)
    #   # => "      the madness of men"
    #
    #   Strings::Align.align(text, 22, direction: :center, fill: '*')
    #   # => "***the madness of men***"
    #
    # @api public
    def align(text, width, direction: :left, **options)
      return text if width.nil?
      method = to_alignment(direction)
      send(method, text, width, **options)
    end
    module_function :align

    # Convert direction to method name
    #
    # @api private
    def to_alignment(direction)
      case direction.to_sym
      when :left   then :align_left
      when :right  then :align_right
      when :center then :align_center
      else
        raise ArgumentError, "Unknown alignment `#{direction}`."
      end
    end
    module_function :to_alignment

    # Aligns text to the left at given length
    #
    # @return [String]
    #
    # @api public
    def align_left(text, width, fill: SPACE, separator: nil)
      return if width.nil?
      sep = separator || text[LINE_BREAK] || NEWLINE

      each_line(text, sep) do |line|
        width_diff = width - display_width(line)
        if width_diff > 0
          line + fill * width_diff
        else
          line
        end
      end
    end
    module_function :align_left

    # Centers text within the width
    #
    # @return [String]
    #
    # @api public
    def align_center(text, width, fill: SPACE, separator: nil)
      return text if width.nil?
      sep = separator || text[LINE_BREAK] || NEWLINE

      each_line(text, sep) do |line|
        width_diff = width - display_width(line)
        if width_diff > 0
          right_count = (width_diff.to_f / 2).ceil
          left_count  =  width_diff - right_count
          [fill * left_count, line, fill * right_count].join
        else
          line
        end
      end
    end
    module_function :align_center

    # Aligns text to the right at given length
    #
    # @return [String]
    #
    # @api public
    def align_right(text, width, fill: SPACE, separator: nil)
      return text if width.nil?
      sep = separator || text[LINE_BREAK] || NEWLINE

      each_line(text, sep) do |line|
        width_diff = width - display_width(line)
        if width_diff > 0
          fill * width_diff + line
        else
          line
        end
      end
    end
    module_function :align_right

    # Enumerate text line by line
    #
    # @param [String] text
    #
    # @return [String]
    #
    # @api private
    def each_line(text, separator)
      lines = text.split(separator)
      return yield(text) if text.empty?
      lines.reduce([]) do |aligned, line|
        aligned << yield(line)
      end.join(separator)
    end
    module_function :each_line

    # Visible width of a string
    #
    # @api private
    def display_width(string)
      Unicode::DisplayWidth.of(Strings::ANSI.sanitize(string))
    end
    module_function :display_width
  end # Align
end # Strings