vendor/rails/activesupport/lib/active_support/core_ext/logger.rb

   1 # Adds the 'around_level' method to Logger.
   2
   3 class Logger
   4   def self.define_around_helper(level)
   5     module_eval <<-end_eval
   6       def around_#{level}(before_message, after_message, &block)
   7         self.#{level}(before_message)
   8         return_value = block.call(self)
   9         self.#{level}(after_message)
  10         return return_value
  11       end
  12     end_eval
  13   end
  14   [:debug, :info, :error, :fatal].each {|level| define_around_helper(level) }
  15 end
  16
  17
  18 require 'logger'
  19
  20 # Extensions to the built in Ruby logger.
  21 #
  22 # If you want to use the default log formatter as defined in the Ruby core, then you
  23 # will need to set the formatter for the logger as in:
  24 #
  25 #   logger.formatter = Formatter.new
  26 #
  27 # You can then specify the datetime format, for example:
  28 #
  29 #   logger.datetime_format = "%Y-%m-%d"
  30 #
  31 # Note: This logger is deprecated in favor of ActiveSupport::BufferedLogger
  32 class Logger
  33   # Set to false to disable the silencer
  34   cattr_accessor :silencer
  35   self.silencer = true
  36
  37   # Silences the logger for the duration of the block.
  38   def silence(temporary_level = Logger::ERROR)
  39     if silencer
  40       begin
  41         old_logger_level, self.level = level, temporary_level
  42         yield self
  43       ensure
  44         self.level = old_logger_level
  45       end
  46     else
  47       yield self
  48     end
  49   end
  50
  51   alias :old_datetime_format= :datetime_format=
  52   # Logging date-time format (string passed to +strftime+). Ignored if the formatter
  53   # does not respond to datetime_format=.
  54   def datetime_format=(datetime_format)
  55     formatter.datetime_format = datetime_format if formatter.respond_to?(:datetime_format=)
  56   end
  57
  58   alias :old_datetime_format :datetime_format
  59   # Get the logging datetime format. Returns nil if the formatter does not support
  60   # datetime formatting.
  61   def datetime_format
  62     formatter.datetime_format if formatter.respond_to?(:datetime_format)
  63   end
  64
  65   alias :old_formatter :formatter if method_defined?(:formatter)
  66   # Get the current formatter. The default formatter is a SimpleFormatter which only
  67   # displays the log message
  68   def formatter
  69     @formatter ||= SimpleFormatter.new
  70   end
  71
  72   unless const_defined? :Formatter
  73     class Formatter
  74       Format = "%s, [%s#%d] %5s -- %s: %s\n"
  75
  76       attr_accessor :datetime_format
  77
  78       def initialize
  79         @datetime_format = nil
  80       end
  81
  82       def call(severity, time, progname, msg)
  83         Format % [severity[0..0], format_datetime(time), $$, severity, progname,
  84         msg2str(msg)]
  85       end
  86
  87       private
  88         def format_datetime(time)
  89           if @datetime_format.nil?
  90             time.strftime("%Y-%m-%dT%H:%M:%S.") << "%06d " % time.usec
  91           else
  92             time.strftime(@datetime_format)
  93           end
  94         end
  95
  96         def msg2str(msg)
  97           case msg
  98           when ::String
  99             msg
 100           when ::Exception
 101             "#{ msg.message } (#{ msg.class })\n" <<
 102             (msg.backtrace || []).join("\n")
 103           else
 104             msg.inspect
 105           end
 106         end
 107     end
 108   end
 109
 110   # Simple formatter which only displays the message.
 111   class SimpleFormatter < Logger::Formatter
 112     # This method is invoked when a log event occurs
 113     def call(severity, timestamp, progname, msg)
 114       "#{String === msg ? msg : msg.inspect}\n"
 115     end
 116   end
 117
 118   private
 119     alias old_format_message format_message
 120
 121     # Ruby 1.8.3 transposed the msg and progname arguments to format_message.
 122     # We can't test RUBY_VERSION because some distributions don't keep Ruby
 123     # and its standard library in sync, leading to installations of Ruby 1.8.2
 124     # with Logger from 1.8.3 and vice versa.
 125     if method_defined?(:formatter=)
 126       def format_message(severity, timestamp, progname, msg)
 127         formatter.call(severity, timestamp, progname, msg)
 128       end
 129     else
 130       def format_message(severity, timestamp, msg, progname)
 131         formatter.call(severity, timestamp, progname, msg)
 132       end
 133
 134       attr_writer :formatter
 135       public :formatter=
 136
 137       alias old_format_datetime format_datetime
 138       def format_datetime(datetime) datetime end
 139
 140       alias old_msg2str msg2str
 141       def msg2str(msg) msg end
 142     end
 143 end