Module: DebugLogging
- Defined in:
- lib/debug_logging.rb,
lib/debug_logging/version.rb,
lib/debug_logging/class_logger.rb,
lib/debug_logging/configuration.rb,
lib/debug_logging/instance_logger.rb,
lib/debug_logging/argument_printer.rb,
lib/debug_logging/instance_logger_modulizer.rb
Overview
# NOTE: The manner this is made to work for class methods is totally different
than the way this is made to work for instance methods.
NOTE: The instance method manner works on Ruby 2.0+ NOTE: The class method manner works on Ruby 2.1+
USAGE (see specs)#
class Car
extend DebugLogging
self.debug_class_benchmarks = true
self.debug_instance_benchmarks = true
include DebugLogging::InstanceLogger.new(i_methods: [:drive, :stop])
extend DebugLogging::ClassLogger
logged def debug_make; new; end
def design(*args); new; end
def safety(*args); new; end
logged :design, :safety
def drive(speed); speed; end
def stop; 0; end
include DebugLogging::InstanceLogger.new(i_methods: debug_instance_methods(false))
def will_not_be_logged; false; end
end
Defined Under Namespace
Modules: ArgumentPrinter, ClassLogger, InstanceLoggerModulizer
Classes: Configuration, InstanceLogger
Constant Summary
collapse
- VERSION =
"1.0.2"
Class Attribute Summary collapse
Class Method Summary
collapse
Instance Method Summary
collapse
Class Attribute Details
.debug_logging_configuration ⇒ Object
Returns the value of attribute debug_logging_configuration.
91
92
93
|
# File 'lib/debug_logging.rb', line 91
def debug_logging_configuration
@debug_logging_configuration
end
|
Class Method Details
.configuration ⇒ Object
For single statement global config in an initializer e.g. DebugLogging.configuration.ellipsis = “…”
74
75
76
|
# File 'lib/debug_logging.rb', line 74
def self.configuration
self.debug_logging_configuration ||= Configuration.new
end
|
For global config in an initializer with a block
79
80
81
|
# File 'lib/debug_logging.rb', line 79
def self.configure
yield(configuration)
end
|
.extended(base) ⇒ Object
56
57
58
59
|
# File 'lib/debug_logging.rb', line 56
def self.extended(base)
base.send(:extend, ArgumentPrinter)
base.debug_config_reset(debug_logging_configuration.dup)
end
|
Instance Method Details
#debug_add_invocation_id ⇒ Object
156
157
158
|
# File 'lib/debug_logging.rb', line 156
def debug_add_invocation_id
@debug_logging_configuration.add_invocation_id
end
|
#debug_add_invocation_id=(add_invocation_id) ⇒ Object
159
160
161
|
# File 'lib/debug_logging.rb', line 159
def debug_add_invocation_id=(add_invocation_id)
@debug_logging_configuration.add_invocation_id = add_invocation_id
end
|
#debug_args_max_length ⇒ Object
126
127
128
|
# File 'lib/debug_logging.rb', line 126
def debug_args_max_length
@debug_logging_configuration.args_max_length
end
|
#debug_args_max_length=(args_max_length) ⇒ Object
129
130
131
|
# File 'lib/debug_logging.rb', line 129
def debug_args_max_length=(args_max_length)
@debug_logging_configuration.args_max_length = args_max_length
end
|
#debug_class_benchmarks ⇒ Object
138
139
140
|
# File 'lib/debug_logging.rb', line 138
def debug_class_benchmarks
@debug_logging_configuration.class_benchmarks
end
|
#debug_class_benchmarks=(class_benchmarks) ⇒ Object
141
142
143
|
# File 'lib/debug_logging.rb', line 141
def debug_class_benchmarks=(class_benchmarks)
@debug_logging_configuration.class_benchmarks = class_benchmarks
end
|
#debug_colorized_chain_for_class ⇒ Object
150
151
152
|
# File 'lib/debug_logging.rb', line 150
def debug_colorized_chain_for_class
@debug_logging_configuration.colorized_chain_for_class
end
|
#debug_colorized_chain_for_class=(colorized_chain_for_class) ⇒ Object
153
154
155
|
# File 'lib/debug_logging.rb', line 153
def debug_colorized_chain_for_class=(colorized_chain_for_class)
@debug_logging_configuration.colorized_chain_for_class = colorized_chain_for_class
end
|
#debug_colorized_chain_for_method ⇒ Object
144
145
146
|
# File 'lib/debug_logging.rb', line 144
def debug_colorized_chain_for_method
@debug_logging_configuration.colorized_chain_for_method
end
|
#debug_colorized_chain_for_method=(colorized_chain_for_method) ⇒ Object
147
148
149
|
# File 'lib/debug_logging.rb', line 147
def debug_colorized_chain_for_method=(colorized_chain_for_method)
@debug_logging_configuration.colorized_chain_for_method = colorized_chain_for_method
end
|
#debug_config ⇒ Object
There are times when the class will need access to the configuration object,
such as to override it per instance method
68
69
70
|
# File 'lib/debug_logging.rb', line 68
def debug_config
@debug_logging_configuration
end
|
#debug_config_reset(config = Configuration.new) ⇒ Object
93
94
95
|
# File 'lib/debug_logging.rb', line 93
def debug_config_reset(config = Configuration.new)
@debug_logging_configuration = config
end
|
#debug_ellipsis ⇒ Object
162
163
164
|
# File 'lib/debug_logging.rb', line 162
def debug_ellipsis
@debug_logging_configuration.ellipsis
end
|
#debug_ellipsis=(ellipsis) ⇒ Object
165
166
167
|
# File 'lib/debug_logging.rb', line 165
def debug_ellipsis=(ellipsis)
@debug_logging_configuration.ellipsis = ellipsis
end
|
#debug_instance_benchmarks ⇒ Object
132
133
134
|
# File 'lib/debug_logging.rb', line 132
def debug_instance_benchmarks
@debug_logging_configuration.instance_benchmarks
end
|
#debug_instance_benchmarks=(instance_benchmarks) ⇒ Object
135
136
137
|
# File 'lib/debug_logging.rb', line 135
def debug_instance_benchmarks=(instance_benchmarks)
@debug_logging_configuration.instance_benchmarks = instance_benchmarks
end
|
#debug_last_hash_max_length ⇒ Object
120
121
122
|
# File 'lib/debug_logging.rb', line 120
def debug_last_hash_max_length
@debug_logging_configuration.last_hash_max_length
end
|
#debug_last_hash_max_length=(last_hash_max_length) ⇒ Object
123
124
125
|
# File 'lib/debug_logging.rb', line 123
def debug_last_hash_max_length=(last_hash_max_length)
@debug_logging_configuration.last_hash_max_length = last_hash_max_length
end
|
#debug_last_hash_to_s_proc ⇒ Object
114
115
116
|
# File 'lib/debug_logging.rb', line 114
def debug_last_hash_to_s_proc
@debug_logging_configuration.last_hash_to_s_proc
end
|
#debug_last_hash_to_s_proc=(last_hash_to_s_proc) ⇒ Object
117
118
119
|
# File 'lib/debug_logging.rb', line 117
def debug_last_hash_to_s_proc=(last_hash_to_s_proc)
@debug_logging_configuration.last_hash_to_s_proc = last_hash_to_s_proc
end
|
#debug_log(message) ⇒ Object
62
63
64
|
# File 'lib/debug_logging.rb', line 62
def debug_log(message)
debug_logger.send(debug_log_level, message)
end
|
#debug_log_level ⇒ Object
102
103
104
|
# File 'lib/debug_logging.rb', line 102
def debug_log_level
@debug_logging_configuration.log_level
end
|
#debug_log_level=(log_level) ⇒ Object
105
106
107
|
# File 'lib/debug_logging.rb', line 105
def debug_log_level=(log_level)
@debug_logging_configuration.log_level = log_level
end
|
#debug_logger ⇒ Object
96
97
98
|
# File 'lib/debug_logging.rb', line 96
def debug_logger
@debug_logging_configuration.logger
end
|
#debug_logger=(logger) ⇒ Object
99
100
101
|
# File 'lib/debug_logging.rb', line 99
def debug_logger=(logger)
@debug_logging_configuration.logger = logger
end
|
For per-class config with a block
84
85
86
87
|
# File 'lib/debug_logging.rb', line 84
def debug_logging_configure
@debug_logging_configuration ||= Configuration.new
yield(@debug_logging_configuration)
end
|
#debug_multiple_last_hashes ⇒ Object
108
109
110
|
# File 'lib/debug_logging.rb', line 108
def debug_multiple_last_hashes
@debug_logging_configuration.multiple_last_hashes
end
|
#debug_multiple_last_hashes=(multiple_last_hashes) ⇒ Object
111
112
113
|
# File 'lib/debug_logging.rb', line 111
def debug_multiple_last_hashes=(multiple_last_hashes)
@debug_logging_configuration.multiple_last_hashes = multiple_last_hashes
end
|