aboutsummaryrefslogtreecommitdiffstats
path: root/railties/lib/rails/subscriber.rb
diff options
context:
space:
mode:
Diffstat (limited to 'railties/lib/rails/subscriber.rb')
-rw-r--r--railties/lib/rails/subscriber.rb17
1 files changed, 8 insertions, 9 deletions
diff --git a/railties/lib/rails/subscriber.rb b/railties/lib/rails/subscriber.rb
index 8c62f562d9..9bf22f27a4 100644
--- a/railties/lib/rails/subscriber.rb
+++ b/railties/lib/rails/subscriber.rb
@@ -3,10 +3,10 @@ require 'active_support/notifications'
module Rails
# Rails::Subscriber is an object set to consume ActiveSupport::Notifications
- # on initialization with solely purpose of logging. The subscriber dispatches
- # notifications to a regirested object based on its given namespace.
+ # on initialization with the sole purpose of logging. The subscriber dispatches
+ # notifications to a registered object based on it's given namespace.
#
- # An example would be ActiveRecord subscriber responsible for logging queries:
+ # An example would be an Active Record subscriber responsible for logging queries:
#
# module ActiveRecord
# class Railtie
@@ -18,20 +18,20 @@ module Rails
# end
# end
#
- # It's finally registed as:
+ # Which would be registed as:
#
# Rails::Subscriber.add :active_record, ActiveRecord::Railtie::Subscriber.new
#
- # So whenever a "active_record.sql" notification arrive to Rails::Subscriber,
+ # So whenever an +active_record.sql+ notification arrives to Rails::Subscriber,
# it will properly dispatch the event (ActiveSupport::Notifications::Event) to
# the sql method.
#
- # This is useful because it avoids spanning several subscribers just for logging
- # purposes(which slows down the main thread). Besides of providing a centralized
+ # This avoids spanning several subscribers just for logging purposes
+ # (which slows down the main thread). It also provides a centralized
# facility on top of Rails.logger.
#
# Subscriber also has some helpers to deal with logging and automatically flushes
- # all logs when the request finishes (via action_dispatch.callback notification).
+ # all logs when the request finishes.
class Subscriber
mattr_accessor :colorize_logging
self.colorize_logging = true
@@ -97,7 +97,6 @@ module Rails
# option is set to true, it also adds bold to the string. This is based
# on Highline implementation and it automatically appends CLEAR to the end
# of the returned String.
- #
def color(text, color, bold=false)
return text unless colorize_logging
color = self.class.const_get(color.to_s.upcase) if color.is_a?(Symbol)