deprecated
Release 3.0.1

An easy way to handle deprecating and conditionally running deprecated code

Homepage Repository Rubygems Ruby Documentation Download

License: MIT
Install: gem install deprecated -v 3.0.1

Documentation

Deprecated is a module to help you deprecate code BEFORE you remove it. Don't
surprise your users, deprecate them!

Usage is simple:

    class Foo
      include Deprecated

      def moo
        "cow"
      end

      deprecated :moo

      def sheep
        "baaa"
      end

      deprecated :sheep, "Sounds#baa"

      protected

      def bar
        true
      end

      deprecated :bar
    end
    
    Foo.new.moo # warns that the call is deprecated
    
    Deprecated.set_action(:raise)
    Foo.new.moo # raises with the same message

    Deprecated.set_action do |klass, sym, replacement|
      email_boss(
        "Someone tried to use #{klass}##{sym}! " +
        "They should be using #{replacement} instead!"
      )
    end

    Foo.new.sheep # do I really need to explain?

    Foo.new.bar # still protected!

Let's do it live!

    class Bar
      include Deprecated

      # sets it just for this class
      deprecated_set_action do |klass, sym, replacement|
        email_boss(
          "Someone tried to use #{klass}##{sym}! " +
          "They should be using #{replacement} instead!"
        )
      end

      def cow
        "moo"
      end

      deprecate :cow # emails your boss when called!
    end

Please see Deprecated::Module#deprecated, Deprecated.set_action, and
Deprecated::Module#deprecated_set_action for more information.

This library is released under the MIT license:
* http://www.opensource.org/licenses/MIT

Dependencies: 0
Dependent packages: 12
Dependent repositories: 93
Total releases: 5
Latest release: Sep 29, 2012
First release: Jul 25, 2009
Stars: 8
Forks: 3
Watchers: 1
Contributors: 2
Repository size: 129 KB
SourceRank: 13