Module: ActiveSupport::ColorizeLogging
Do not use. This module is for internal use only.
| Relationships & Source Files | |
| Extension / Inclusion / Inheritance Descendants | |
|
Included In:
| |
| Super Chains via Extension / Inclusion / Inheritance | |
|
Class Chain:
self,
Concern
|
|
| Defined in: | activesupport/lib/active_support/colorize_logging.rb |
Constant Summary
-
BLACK =
# File 'activesupport/lib/active_support/colorize_logging.rb', line 17
ANSI sequence colors
"\e[30m" -
BLUE =
# File 'activesupport/lib/active_support/colorize_logging.rb', line 21"\e[34m" -
CYAN =
# File 'activesupport/lib/active_support/colorize_logging.rb', line 23"\e[36m" -
GREEN =
# File 'activesupport/lib/active_support/colorize_logging.rb', line 19"\e[32m" -
MAGENTA =
# File 'activesupport/lib/active_support/colorize_logging.rb', line 22"\e[35m" -
MODES =
# File 'activesupport/lib/active_support/colorize_logging.rb', line 9
ANSI sequence modes
{ clear: 0, bold: 1, italic: 3, underline: 4, }.freeze -
RED =
# File 'activesupport/lib/active_support/colorize_logging.rb', line 18"\e[31m" -
WHITE =
# File 'activesupport/lib/active_support/colorize_logging.rb', line 24"\e[37m" -
YELLOW =
# File 'activesupport/lib/active_support/colorize_logging.rb', line 20"\e[33m"
Class Method Summary
Concern - Extended
| class_methods | Define class methods from given block. |
| included | Evaluate given block in context of base class, so that you can write class macros here. |
| prepended | Evaluate given block in context of base class, so that you can write class macros here. |
| append_features, prepend_features | |
Instance Method Summary
-
#color(text, color, mode_options = {})
Set color by using a symbol or one of the defined constants.
- #colorize_logging
- #debug(progname = nil, &block)
- #error(progname = nil, &block)
- #fatal(progname = nil, &block)
- #info(progname = nil, &block)
- #mode_from(options)
- #unknown(progname = nil, &block)
- #warn(progname = nil, &block)
Instance Method Details
#color(text, color, mode_options = {})
Set color by using a symbol or one of the defined constants. Set modes
by specifying bold, italic, or underline options. Inspired by Highline,
this method will automatically clear formatting at the end of the returned ::String.
# File 'activesupport/lib/active_support/colorize_logging.rb', line 53
def color(text, color, = {}) # :doc: return text unless colorize_logging color = self.class.const_get(color.upcase) if color.is_a?(Symbol) mode = mode_from() clear = "\e[#{MODES[:clear]}m" "#{mode}#{color}#{text}#{clear}" end
#colorize_logging
[ GitHub ]# File 'activesupport/lib/active_support/colorize_logging.rb', line 67
def colorize_logging ActiveSupport.colorize_logging end
#debug(progname = nil, &block)
[ GitHub ]# File 'activesupport/lib/active_support/colorize_logging.rb', line 30
def debug(progname = nil, &block) logger.debug(progname, &block) if logger end
#error(progname = nil, &block)
[ GitHub ]# File 'activesupport/lib/active_support/colorize_logging.rb', line 38
def error(progname = nil, &block) logger.error(progname, &block) if logger end
#fatal(progname = nil, &block)
[ GitHub ]# File 'activesupport/lib/active_support/colorize_logging.rb', line 42
def fatal(progname = nil, &block) logger.fatal(progname, &block) if logger end
#info(progname = nil, &block)
[ GitHub ]# File 'activesupport/lib/active_support/colorize_logging.rb', line 26
def info(progname = nil, &block) logger.info(progname, &block) if logger end
#mode_from(options)
[ GitHub ]# File 'activesupport/lib/active_support/colorize_logging.rb', line 61
def mode_from() modes = MODES.values_at(*.compact_blank.keys) "\e[#{modes.join(";")}m" if modes.any? end
#unknown(progname = nil, &block)
[ GitHub ]# File 'activesupport/lib/active_support/colorize_logging.rb', line 46
def unknown(progname = nil, &block) logger.unknown(progname, &block) if logger end
#warn(progname = nil, &block)
[ GitHub ]# File 'activesupport/lib/active_support/colorize_logging.rb', line 34
def warn(progname = nil, &block) logger.warn(progname, &block) if logger end