deprecated 1.0.0 → 2.0.0

data/lib/deprecated.rb

@@ -1,7 +1,7 @@
 #
 # Deprecate - handle deprecating and executing deprecated code
 #
-# Version:: 1.0.0
+# Version:: 2.0.0
 # Author:: Erik Hollensbe
 # License:: BSD
 # Copyright:: Copyright (c) 2006 Erik Hollensbe
@@ -17,47 +17,26 @@
 #   
 #   class Foo
 #     private
-#       # rename the original function and make it private
-#       def _monkey
-#         do stuff...
-#       end
-#     public
+#     # rename the original function and make it private
+#     def monkey
+#       do stuff...
+#     end
 #     # deprecate the function, this will create a 'monkey' method
 #     # that will call the deprecate warnings
-#     deprecate :monkey, :_monkey
+#     deprecate :monkey, :private
 #   end
 #
 # The 'deprecate' call is injected into the 'Module' class at
 # require-time. This allows all classes that are newly-created to
-# access the 'deprecate' functionality.
-#
-# The call itself takes a list of symbols. Each pair is first the name
-# of the original function, the second the name of the current,
-# renamed function. Both are represented as symbols.
-#
-#   Ex:
-#
-#   # foo subroutine is generated to call _foo, and notify the user
-#   # when called.
-#   deprecate :foo, :_foo
-#
-# You can define as many symbols as you like on one line as
-# deprecated, but for obvious reasons the length of the list must be
-# even. In the case that it isn't, the 'deprecate' call will throw an
-# exception of type 'DeprecatedError'.
-#
-# If you prefer to have more sugar in your syntax, the call
-# understands arrays:
-#
-#   deprecate [:foo, :_foo], [:bar, :_bar]
-#
-# And of course, you can make the call multiple times.
+# access the 'deprecate' functionality. The deprecate definition must
+# follow the method definition. You may only define one deprecated
+# function per call.
 #
 # Methods deprecated default to 'public'. This is due to a limitation
 # in how Ruby handles permission definition. If you're aware of a
 # workaround to this problem, please let me know.
 #
-# You can however change this by providing an optional leading
+# You can however change this by providing an optional trailing
 # parameter to the 'deprecate' call:
 #
 # * :public - set the created method to be public
@@ -102,8 +81,6 @@
 
 module Deprecate
   
-  CALLER_REGEX = /\`([^\']+)/
-  
   #
   # set_action defines the action that will be taken when code marked
   # deprecated is encountered. There are several stock options:
@@ -189,38 +166,32 @@ end
 
 Module.send(:define_method, :deprecate, 
             proc do |*args|
-              args.flatten!
-              if args.length
-
-                permission = :public
-
-                if args.length % 2 != 0
-                  permission = args.shift
-                end
-
-                while args.length > 0
-                  syms = args.slice! 0, 2
-                  
-                  if syms.include? nil
-                    raise DeprecatedError.new("Invalid number of arguments passed to 'deprecated' function")
-                  end
-                  
-                  define_method(syms[0]) do |*sendparams|
-                    Deprecate.action.call(self.class.to_s + '#' + syms[0].to_s)
-                    self.send(syms[1], *sendparams) 
-                  end
-                  
-                  case permission
-                  when :public
-                    public(syms[0])
-                  when :protected
-                    protected(syms[0])
-                  when :private
-                    private(syms[0])
-                  end
-
-                end
+              sym = args.shift
+              protection = args.shift || :public
+              
+              unless sym
+                raise DeprecatedError.new("Invalid number of arguments passed to 'deprecated' function")
+              end
+             
+              old_method = self.instance_method(sym)
+              
+              define_method(sym) do |*sendparams|
+                Deprecate.action.call(self.class.to_s + '#' + sym.to_s)
+                new_method = self.class.instance_method(sym)
+                retval = old_method.bind(self).call(*sendparams)
+                new_method.bind(self)
+                return retval
+              end
+              
+              case protection
+              when :public
+                public(sym)
+              when :private
+                private(sym)
+              when :protected
+                protected(sym)
               end
+              
             end)
 
 Deprecate.set_action(:warn)

data/test/deprecated.rb

@@ -1,42 +1,33 @@
 #!/usr/bin/env ruby
 
-require 'lib/deprecate.rb'
+require 'lib/deprecated.rb'
 require 'test/unit'
 
 # this class is used to test the deprecate functionality
 class DummyClass
-  deprecate :monkey, :_monkey
-
-  def _monkey
+  def monkey
     return true
   end
 
+  deprecate :monkey
 end
 
 # we want exceptions for testing here.
 Deprecate.set_action(:throw)
 
 class DeprecateTest < Test::Unit::TestCase
-  def set_action_builder
-    d = DummyClass.new
-    test = true
-    begin
-      d.monkey
-      test = false
-    rescue DeprecatedError => e
-      test = e.message == "DummyClass#monkey is deprecated."
-    end
-
-    return test
-  end
-
-  # this inadvertently tests the deprecate functionality as well...
   def test_set_action
      
-    assert(set_action_builder, "Deprecate.set_action message/:throw test")
+    assert_raise(DeprecatedError) { raise StandardError.new unless DummyClass.new.monkey }
 
     Deprecate.set_action(proc { |msg| raise DeprecatedError.new("#{msg} is deprecated.") })
 
-    assert(set_action_builder, "Deprecate.set_action custom proc test")
+    assert_raise(DeprecatedError) { raise StandardError.new unless DummyClass.new.monkey }
+   
+
+    # set to warn and make sure our return values are getting through.
+    Deprecate.set_action(:warn)
+    
+    assert_nothing_raised(DeprecatedError) { raise StandardError.new unless DummyClass.new.monkey } 
   end
 end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: deprecated
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
-date: 2006-02-15 00:00:00 -08:00
+  version: 2.0.0
+date: 2006-05-17 00:00:00 -07:00
 summary: An easy way to handle deprecating and conditionally running deprecated code
 require_paths: 
 - lib