Module: LogBuddy
- Extended by:
- Utils
- Defined in:
- lib/log_buddy.rb,
lib/log_buddy/mixin.rb,
lib/log_buddy/utils.rb,
lib/log_buddy/version.rb
Overview
LogBuddy is a developer tool for easy logging while testing, debugging, and inspecting.
The log shortcut method to give you easy, concise output of variables with their names and values.
Examples:
a = "foo"
@a = "my var"
def
"woof!"
end
d { a } # logs "a = 'foo'"
d { @a } # logs "@a = 'my var'"
d { } # logs "bark = woof!"
Defined Under Namespace
Modules: Mixin, Utils, Version
Class Method Summary collapse
-
.init(options = {}) ⇒ Object
Configure and include LogBuddy into Object.
- .log_to_stdout? ⇒ Boolean
- .logger ⇒ Object
-
.mixin_to_object ⇒ Object
Add the LogBuddy::Mixin to Object instance and class level.
Methods included from Utils
arg_and_blk_debug, debug, obj_to_string, parse_args, read_line, stdout_puts
Class Method Details
.init(options = {}) ⇒ Object
Configure and include LogBuddy into Object. You can pass in any of the following configuration options:
-
:logger
- the logger instance that LogBuddy should use (if not provided, tries to default to RAILS_DEFAULT_LOGGER, and then to a STDOUT logger). -
<tt):log_to_stdout</tt> - whether LogBuddy should also log to STDOUT, very helpful for Autotest (default is
true
). -
:disabled
- when true, LogBuddy will not produce any output
30 31 32 33 34 35 |
# File 'lib/log_buddy.rb', line 30 def self.init( = {}) @logger = [:logger] @log_to_stdout = .has_key?(:log_to_stdout) ? [:log_to_stdout] : true @disabled = ([:disabled] == true) mixin_to_object end |
.log_to_stdout? ⇒ Boolean
52 53 54 |
# File 'lib/log_buddy.rb', line 52 def log_to_stdout? @log_to_stdout end |
.logger ⇒ Object
47 48 49 50 |
# File 'lib/log_buddy.rb', line 47 def logger return @logger if @logger @logger = init_default_logger end |