Deprecated globalize? in favor of in_place_translations?

Author: Luca Guidi

Diff for: app/helpers/click_to_globalize_helper.rb

@@ -3,7 +3,7 @@ module ClickToGlobalizeHelper
 
   # Render +app/views/shared/_click_to_globalize.html.erb+.
   def click_to_globalize
-    render :file => @@click_partial if globalize?
+    render :file => @@click_partial if in_place_translations?
   end
 
   # Get form_authenticity_token if the application is protected from forgery.

Diff for: lib/click_to_globalize.rb

@@ -78,20 +78,37 @@ module Controller
     def self.included(recipient)
       recipient.send :include, InstanceMethods
       recipient.class_eval do
-        helper_method :globalize?
+        helper_method :in_place_translations?
       end
     end
 
     module InstanceMethods
+      include ActiveSupport::Deprecation
+
+      # This is the <b>on/off</b> switch for the Click to Globalize features.
+      # Override this method in your controllers for custom conditions.
+      #
+      # Example:
+      #
+      #   def in_place_translations?
+      #     current_user.admin?
+      #   end
+      def in_place_translations?
+        true
+      end
+
       # This is the <b>on/off</b> switch for the Click to Globalize features.
       # Override this method in your controllers for custom conditions.
       #
+      # NOTICE: this method has been deprecated in favor of <tt>in_place_translations?</tt>
+      #
       # Example:
       #
       #   def globalize?
       #     current_user.admin?
       #   end
       def globalize?
+        ::ActiveSupport::Deprecation.warn("You should use in_place_translations?", caller)
         true
       end
     end

Diff for: test/functional/translations_controller_test.rb

@@ -8,7 +8,7 @@
 
 class TranslationsControllerTest < ActionController::TestCase
   test "should have translation mode enabled by default" do
-    assert @controller.globalize?
+    assert @controller.in_place_translations?
   end
 
   test "routing" do
@@ -50,7 +50,11 @@ class AnApplicationControllerTest < ActionController::TestCase
   setup :load_translations
 
   test "should have translation mode enabled by default" do
-    assert @controller.globalize?
+    assert @controller.in_place_translations?
+  end
+
+  test "globalize? deprecation" do
+    assert_deprecated("You should use in_place_translations?"){ @controller.globalize? }
   end
 
   test "should return translated contents" do
@@ -63,7 +67,7 @@ class AnApplicationControllerTest < ActionController::TestCase
   end
 
   test "should always render the action" do
-    @controller.stubs(:globalize?).returns false
+    @controller.stubs(:in_place_translations?).returns false
 
     get :index, params
     assert_response :success

Diff for: test/test_helper.rb

@@ -29,7 +29,7 @@ def render(options = nil, extra_options = {}, &block)
       ActionView::Base.new.render options, extra_options, &block
     end
 
-    def globalize?
-      ApplicationController.new.globalize?
+    def in_place_translations?
+      ApplicationController.new.in_place_translations?
     end
 end