aboutsummaryrefslogtreecommitdiffstats
path: root/activesupport/lib/active_support/deprecation/behaviors.rb
blob: 7b343579f91d6e286abf56c2fa8b30c9df12e93c (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
require "active_support/notifications"

module ActiveSupport
  module Deprecation
    class << self
      # Whether to print a backtrace along with the warning.
      attr_accessor :debug

      # Returns the set behavior or if one isn't set, defaults to +:stderr+
      def behavior
        @behavior ||= [DEFAULT_BEHAVIORS[:stderr]]
      end

      # Sets the behavior to the specified value. Can be a single value, array, or
      # and object that responds to +call+.
      #
      # Available options:
      #
      # [+stderr+]  Log all deprecation warnings to $stderr
      # [+log+]  Log all deprecation warnins to +Rails.logger+
      # [+notify] Use +ActiveSupport::Notifications+ to notify of +deprecation.rails+.
      # [+silence+] Do nothing
      #
      # Note, setting behaviors only effects deprecations that happen afterwards.
      # For example, All gems are required before Rails boots. Those gems may
      # raise deprecation warnings according to the default setting. Setting
      # behavior in a config file only effects code after boot time. So, the
      # set behavior applies to deprecations raised at runtime.
      #
      # Examples
      #
      #   ActiveSupport::Deprecation.behavior = :stderr
      #   ActiveSupport::Deprecation.behavior = [:stderr, :log]
      #   ActiveSupport::Deprecation.behavior = proc { |message, callstack| 
      #     # custom stuff
      #   }
      #   ActiveSupport::Deprecation.behavior = MyCustomHandler
      def behavior=(behavior)
        @behavior = Array(behavior).map { |b| DEFAULT_BEHAVIORS[b] || b }
      end
    end

    # Default warning behaviors per Rails.env.
    DEFAULT_BEHAVIORS = {
      :stderr => Proc.new { |message, callstack|
         $stderr.puts(message)
         $stderr.puts callstack.join("\n  ") if debug
       },
      :log => Proc.new { |message, callstack|
         logger =
           if defined?(Rails) && Rails.logger
             Rails.logger
           else
             require 'active_support/logger'
             ActiveSupport::Logger.new($stderr)
           end
         logger.warn message
         logger.debug callstack.join("\n  ") if debug
       },
       :notify => Proc.new { |message, callstack|
          ActiveSupport::Notifications.instrument("deprecation.rails",
            :message => message, :callstack => callstack)
       }
    }
  end
end