Merge pull request #2931 from dmathieu/safe_gsub_doc

better method documentation on disable safe string methods

1 files changed, 12 insertions, 6 deletions

diff --git a/activesupport/lib/active_support/core_ext/string/output_safety.rb b/activesupport/lib/active_support/core_ext/string/output_safety.rb
index 24b617578f..6e8f72e2b3 100644
--- a/activesupport/lib/active_support/core_ext/string/output_safety.rb
+++ b/activesupport/lib/active_support/core_ext/string/output_safety.rb
@@ -157,13 +157,19 @@ module ActiveSupport #:nodoc:
 
     UNAVAILABLE_STRING_METHODS.each do |unavailable_method|
       class_eval <<-EOT, __FILE__, __LINE__
-        def #{unavailable_method}(*args)          # def gsub(*args)
+        # def gsub(*args)
+        #   raise NoMethodError, "gsub cannot be used with a Safe Buffer object. You should use object.to_str.gsub"
+        # end
+        def #{unavailable_method}(*args)
           raise NoMethodError, "#{unavailable_method} cannot be used with a Safe Buffer object. You should use object.to_str.#{unavailable_method}"
-        end                                       # end
-
-        def #{unavailable_method}!(*args)         # def gsub!(*args)
-          raise NoMethodError, "#{unavailable_method} cannot be used with a Safe Buffer object. You should use object.to_str.#{unavailable_method}"
-        end                                       # end
+        end
+
+        # def gsub!(*args)
+        #   raise NoMethodError, "gsub! cannot be used with a Safe Buffer object. You should use object.to_str.gsub!"
+        # end
+        def #{unavailable_method}!(*args)
+          raise NoMethodError, "#{unavailable_method}! cannot be used with a Safe Buffer object. You should use object.to_str.#{unavailable_method}!"
+        end
       EOT
     end