From d4c7d3fd94e5a885a6366eaeb3b908bb58ffd4db Mon Sep 17 00:00:00 2001
From: wycats <wycats@gmail.com>
Date: Tue, 29 Jun 2010 12:18:17 -0700
Subject: Create a deprecation behavior that triggers a notification for
 deprecation notices, and make the behaviors independent of the environment
 names.

* In Rails 2.3 apps being upgraded, you will need to add the deprecation
  configuration to each of your environments. Failing to do so will
  result in the same behavior as Rails 2.3, but with an outputted warning
  to provide information on how to set up the setting.
* New Rails 3 applications generate the setting
* The notification style will send deprecation notices using
  ActiveSupport::Notifications. Third-party tools can listen in to
  these notifications to provide a streamlined view of the
  deprecation notices occurring in your app.
* The payload in the notification is the deprecation warning itself
  as well as the callstack from the point that triggered the
  notification.
---
 .../lib/active_support/deprecation/behaviors.rb    | 21 +++++++++-------
 activesupport/lib/active_support/railtie.rb        | 28 ++++++++++++++++++++++
 2 files changed, 40 insertions(+), 9 deletions(-)

(limited to 'activesupport/lib')

diff --git a/activesupport/lib/active_support/deprecation/behaviors.rb b/activesupport/lib/active_support/deprecation/behaviors.rb
index 578c025fcf..feb1508586 100644
--- a/activesupport/lib/active_support/deprecation/behaviors.rb
+++ b/activesupport/lib/active_support/deprecation/behaviors.rb
@@ -1,28 +1,27 @@
+require "active_support/notifications"
+
 module ActiveSupport
   module Deprecation
     class << self
-      # Behavior is a block that takes a message argument.
-      attr_writer :behavior
-
       # Whether to print a backtrace along with the warning.
       attr_accessor :debug
 
       def behavior
-        @behavior ||= default_behavior
+        @behavior ||= DEFAULT_BEHAVIORS[:stderr]
       end
 
-      def default_behavior
-        Deprecation::DEFAULT_BEHAVIORS[defined?(Rails.env) ? Rails.env.to_s : 'test']
+      def behavior=(behavior)
+        @behavior = DEFAULT_BEHAVIORS[behavior] || behavior
       end
     end
 
-    # Default warning behaviors per Rails.env. Ignored in production.
+    # Default warning behaviors per Rails.env.
     DEFAULT_BEHAVIORS = {
-      'test' => Proc.new { |message, callstack|
+      :stderr => Proc.new { |message, callstack|
          $stderr.puts(message)
          $stderr.puts callstack.join("\n  ") if debug
        },
-      'development' => Proc.new { |message, callstack|
+      :log => Proc.new { |message, callstack|
          logger =
            if defined?(Rails) && Rails.logger
              Rails.logger
@@ -32,6 +31,10 @@ module ActiveSupport
            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
diff --git a/activesupport/lib/active_support/railtie.rb b/activesupport/lib/active_support/railtie.rb
index 1f32f8718f..7970d39faf 100644
--- a/activesupport/lib/active_support/railtie.rb
+++ b/activesupport/lib/active_support/railtie.rb
@@ -12,6 +12,34 @@ module ActiveSupport
       require 'active_support/whiny_nil' if app.config.whiny_nils
     end
 
+    initializer "active_support.deprecation_behavior" do |app|
+      if deprecation = app.config.active_support.deprecation
+        ActiveSupport::Deprecation.behavior = deprecation
+      else
+        defaults = {"development" => :log,
+                    "production"  => :notify,
+                    "test"        => :stderr}
+
+        env = Rails.env
+
+        if defaults.key?(env)
+          msg = "You did not specify how you would like Rails to report " \
+                "deprecation notices for your #{env} environment, please " \
+                "set it to :#{defaults[env]} at config/environments/#{env}.rb"
+
+          warn msg
+          ActiveSupport::Deprecation.behavior = defaults[env]
+        else
+          msg = "You did not specify how you would like Rails to report " \
+                "deprecation notices for your #{env} environment, please " \
+                "set it to :log, :notify or :stderr at config/environments/#{env}.rb"
+
+          warn msg
+          ActiveSupport::Deprecation.behavior = :stderr
+        end
+      end
+    end
+
     # Sets the default value for Time.zone
     # If assigned value cannot be matched to a TimeZone, an exception will be raised.
     initializer "active_support.initialize_time_zone" do |app|
-- 
cgit v1.2.3