module Colorize::ClassMethods

Public Instance Methods

add_color_alias(*params) click to toggle source

Add color alias

# File lib/colorize/class_methods.rb, line 135
def add_color_alias(*params)
  parse_color_alias_params(params).each do |_alias_, _color_|
    check_if_color_available!(_alias_)
    check_if_color_exist!(_color_)

    add_color_code(_alias_, color_codes[_color_])
    add_color_method(_alias_)
  end
end
add_color_code(code, color) click to toggle source
# File lib/colorize/class_methods.rb, line 154
def add_color_code(code, color)
  @@color_codes[code] = color
end
add_color_method(key) click to toggle source

Generate color and on_color method

# File lib/colorize/class_methods.rb, line 179
def add_color_method(key)
  define_method key do
    colorize(:color => key)
  end

  define_method "on_#{key}" do
    colorize(:background => key)
  end
end
check_if_color_available!(color) click to toggle source

Check if color exists

# File lib/colorize/class_methods.rb, line 214
def check_if_color_available!(color)
  color_exist?(color) && fail(::Colorize::ColorAlreadyExist, "Colorize: color named :#{color} already exist!")
end
check_if_color_exist!(color) click to toggle source

Check if color is missing

# File lib/colorize/class_methods.rb, line 221
def check_if_color_exist!(color)
  color_exist?(color) || fail(::Colorize::ColorDontExist, "Colorize: color :#{color} don't exist!")
end
color_codes() click to toggle source

Color codes hash

# File lib/colorize/class_methods.rb, line 150
def color_codes
  @@color_codes
end
color_exist?(color) click to toggle source
# File lib/colorize/class_methods.rb, line 225
def color_exist?(color)
  !color_codes[color].nil?
end
color_methods() click to toggle source

Generate color and on_color methods

# File lib/colorize/class_methods.rb, line 168
def color_methods
  colors.each do |key|
    next if key == :default

    add_color_method(key)
  end
end
color_samples() click to toggle source

Display color samples

# File lib/colorize/class_methods.rb, line 125
def color_samples
  colors.permutation(2).each do |background, color|
    sample_text = "#{color.inspect.rjust(15)} on #{background.inspect.ljust(15)}"
    puts "#{new(sample_text).colorize(:color => color, :background => background)} #{sample_text}"
  end
end
colors() click to toggle source

Return array of available colors used by colorize

# File lib/colorize/class_methods.rb, line 111
def colors
  color_codes.keys
end
disable_colorization(value = nil) click to toggle source

Property for disable colorization

# File lib/colorize/class_methods.rb, line 67
def disable_colorization(value = nil)
  if value.nil?
    if defined?(@@disable_colorization)
      @@disable_colorization || false
    else
      false
    end
  else
    @@disable_colorization = (value || false)
  end
end
disable_colorization=(value) click to toggle source

Setter for disable colorization

# File lib/colorize/class_methods.rb, line 82
def disable_colorization=(value)
  @@disable_colorization = (value || false)
end
enable_readline_support(value = nil) click to toggle source

Property for readline support

# File lib/colorize/class_methods.rb, line 45
def enable_readline_support(value = nil)
  if value.nil?
    if defined?(@@readline_support)
      @@readline_support || false
    else
      false
    end
  else
    @@readline_support = (value || false)
  end
end
enable_readline_support=(value) click to toggle source

Setter for enable readline support

# File lib/colorize/class_methods.rb, line 60
def enable_readline_support=(value)
  @@readline_support = (value || false)
end
mode_codes() click to toggle source

Mode codes hash

# File lib/colorize/class_methods.rb, line 161
def mode_codes
  @@mode_codes
end
modes() click to toggle source

Return array of available modes used by colorize

# File lib/colorize/class_methods.rb, line 118
def modes
  mode_codes.keys
end
modes_methods() click to toggle source

Generate modes methods

# File lib/colorize/class_methods.rb, line 192
def modes_methods
  modes.each do |key|
    next if key == :default

    define_method key do
      colorize(:mode => key)
    end
  end
end
parse_color_alias_params(params) click to toggle source
# File lib/colorize/class_methods.rb, line 202
def parse_color_alias_params(params)
  return [params] if params.is_a?(Array) && params.length == 2

  params.flat_map do |param|
    next param if param.is_a?(Array) && param.length == 2
    next param.to_a if param.is_a?(Hash)
  end
end
prevent_colors(value = nil) click to toggle source

Property for prevent recolorization

# File lib/colorize/class_methods.rb, line 89
def prevent_colors(value = nil)
  if value.nil?
    if defined?(@@prevent_colors)
      @@prevent_colors || false
    else
      false
    end
  else
    @@prevent_colors = (value || false)
  end
end
prevent_colors=(value) click to toggle source

Setter for prevent recolorization

# File lib/colorize/class_methods.rb, line 104
def prevent_colors=(value)
  @@prevent_colors = (value || false)
end