Module: Console

Defined in:
lib/console/split.rb,
lib/console.rb,
lib/console/buffer.rb,
lib/console/filter.rb,
lib/console/logger.rb,
lib/console/capture.rb,
lib/console/measure.rb,
lib/console/version.rb,
lib/console/resolver.rb,
lib/console/event/spawn.rb,
lib/console/event/failure.rb,
lib/console/event/generic.rb,
lib/console/terminal/text.rb,
lib/console/event/progress.rb,
lib/console/terminal/xterm.rb,
lib/console/terminal/logger.rb,
lib/console/serialized/logger.rb

Overview

Copyright, 2019, by Samuel G. D. Williams. <www.codeotaku.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Defined Under Namespace

Modules: Event, Serialized, Terminal Classes: Buffer, Capture, Filter, Logger, Measure, Resolver, Split

Constant Summary collapse

UNKNOWN = 
'unknown'
VERSION = 
"1.9.0"
Shell =

Deprecated.

Event::Spawn

Class Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Class Attribute Details

.logger ⇒ Object

Returns the value of attribute logger.



29
30
31
 
# File 'lib/console.rb', line 29

def logger
  @logger
end

Class Method Details

.build(output, verbose: self.verbose?, level: self.default_log_level) ⇒ Object 



81
82
83
84
85
86
87
 
# File 'lib/console.rb', line 81

def build(output, verbose: self.verbose?, level: self.default_log_level)
	terminal = Terminal::Logger.new(output, verbose: verbose)
	
	logger = Logger.new(terminal, verbose: verbose, level: level)
	
	return logger
end

.default_log_level(env = ENV) ⇒ Object

Set the default log level based on ‘$DEBUG` and `$VERBOSE`. You can also specify CONSOLE_LEVEL=debug or CONSOLE_LEVEL=info in environment. mislav.net/2011/06/ruby-verbose-mode/ has more details about how it all fits together.



34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/console.rb', line 34

def default_log_level(env = ENV)
	if level = (env['CONSOLE_LEVEL'] || env['CONSOLE_LOG_LEVEL'])
		Logger::LEVELS[level.to_sym] || Logger.warn
	elsif $DEBUG
		Logger::DEBUG
	elsif $VERBOSE.nil?
		Logger::WARN
	else
		Logger::INFO
	end
end

.default_resolver(logger, env = ENV) ⇒ nil, Resolver

You can change the log level for different classes using CONSOLE_<LEVEL> env vars.

e.g. ‘CONSOLE_WARN=Acorn,Banana CONSOLE_DEBUG=Cat` will set the log level for Acorn and Banana to warn and Cat to debug. This overrides the default log level.

Parameters:

  • logger (Logger) —

    A logger instance to set the logging levels on.

  • env (Hash) (defaults to: ENV) —

    Environment to read levels from.

Returns:

  • (nil) —

    if there were no custom logging levels specified in the environment.

  • (Resolver) —

    if there were custom logging levels, then the created resolver is returned.



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/console.rb', line 56

def default_resolver(logger, env = ENV)
	# find all CONSOLE_<LEVEL> variables from environment
	levels = Logger::LEVELS
	.map { |label, level| [level, env["CONSOLE_#{label.to_s.upcase}"]&.split(',')] }
	.to_h
	.compact

	# if we have any levels, then create a class resolver, and each time a class is resolved, set the log level for
	# that class to the specified level
	if levels.any?
		resolver = Resolver.new
		levels.each do |level, names|
			resolver.bind(names) do |klass|
				logger.enable(klass, level)
			end
		end
		return resolver
	end
end

.extended(klass) ⇒ Object 



102
103
104
 
# File 'lib/console.rb', line 102

def self.extended(klass)
	klass.instance_variable_set(:@logger, nil)
end

.verbose? ⇒ Boolean

Controls verbose output using ‘$VERBOSE`.

Returns:

  • (Boolean) 


77
78
79
 
# File 'lib/console.rb', line 77

def verbose?
	!$VERBOSE.nil?
end

Instance Method Details

#logger ⇒ Object 



98
99
100
 
# File 'lib/console.rb', line 98

def logger
	@logger || Console.logger
end

#logger=(logger) ⇒ Object 



94
95
96
 
# File 'lib/console.rb', line 94

def logger= logger
	@logger = logger
end