Contents

require 'rainbow/core'
require 'rainbow/string_utils'
require 'rainbow/color'

module Rainbow

  class Wrapper < ::String

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

    alias_method :color, :foreground
    alias_method :colour, :foreground

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

    # 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

    # 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

    private

    def wrap_with_sgr(codes) #:nodoc:
      return self unless Rainbow.enabled

      self.class.new(StringUtils.wrap_with_sgr(self, [*codes]))
    end

  end

end

def Rainbow(string)
  Rainbow::Wrapper.new(string.to_s)
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
rainbow-1.99.0	lib/rainbow/wrapper.rb