sickill/rainbow

View on GitHub
lib/rainbow/presenter.rb

Summary

Maintainability
A
0 mins
Test Coverage
# frozen_string_literal: true

require_relative 'string_utils'
require_relative 'x11_color_names'
require_relative 'color'

module Rainbow
  class Presenter < ::String
    TERM_EFFECTS = {
      reset: 0,
      bright: 1,
      faint: 2,
      italic: 3,
      underline: 4,
      blink: 5,
      inverse: 7,
      hide: 8,
      cross_out: 9
    }.freeze

    # Sets color of this text.
    def color(*values)
      wrap_with_sgr(Color.build(:foreground, values).codes)
    end

    alias foreground color
    alias fg color

    # Sets background color of this text.
    def background(*values)
      wrap_with_sgr(Color.build(:background, values).codes)
    end

    alias bg background

    # Resets terminal to default colors/backgrounds.
    #
    # It shouldn't be needed to use this method because all methods
    # append terminal reset code to end of string.
    def reset
      wrap_with_sgr(TERM_EFFECTS[:reset])
    end

    # Turns on bright/bold for this text.
    def bright
      wrap_with_sgr(TERM_EFFECTS[:bright])
    end

    alias bold bright

    # Turns on faint/dark for this text (not well supported by terminal
    # emulators).
    def faint
      wrap_with_sgr(TERM_EFFECTS[:faint])
    end

    alias dark faint

    # Turns on italic style for this text (not well supported by terminal
    # emulators).
    def italic
      wrap_with_sgr(TERM_EFFECTS[:italic])
    end

    # Turns on underline decoration for this text.
    def underline
      wrap_with_sgr(TERM_EFFECTS[:underline])
    end

    # Turns on blinking attribute for this text (not well supported by terminal
    # emulators).
    def blink
      wrap_with_sgr(TERM_EFFECTS[:blink])
    end

    # Inverses current foreground/background colors.
    def inverse
      wrap_with_sgr(TERM_EFFECTS[:inverse])
    end

    # Hides this text (set its color to the same as background).
    def hide
      wrap_with_sgr(TERM_EFFECTS[:hide])
    end

    def cross_out
      wrap_with_sgr(TERM_EFFECTS[:cross_out])
    end

    alias strike cross_out

    # Define foreground named color methods eg #red and #tomato
    (Color::Named.color_names | Color::X11Named.color_names).each do |name|
      define_method(name) { color(name) }
    end

    private

    def wrap_with_sgr(codes) # :nodoc:
      self.class.new(StringUtils.wrap_with_sgr(self, [*codes]))
    end
  end
end