deprecator 0.0.2 → 0.0.3

data/README.md

@@ -2,11 +2,17 @@
 
 Yet another library for dealing with code deprecation in ruby gracefully.
 
+Allows you to replace behavior. For example before some important release you want to revise all deprecated code that is being called by your tests (and you have near 100% coverage, don't you?) - you can just throw in a strategy, that raises an error.
+
+The same technique also provides for ability to make deprecation messages localized via l10n/i18n etc.
+
 ## Installation
 
 Add this line to your application's Gemfile:
 
+```ruby
     gem 'deprecator'
+```
 
 And then execute:
 
@@ -20,7 +26,73 @@ Or install it yourself as:
 
 ```ruby
 
+#!/usr/bin/env ruby
+
+require 'deprecator'
+
+class SomeClass
+  deprecated
+
+  def method1
+    deprecated
+  end
+
+  def method2
+    if true
+      deprecated "this is deprecated when true is true"
+    end
+  end
+
+  deprecated_method
+  def method3
+  end
+
+  deprecated_method :method4, "%{method} is no longer here, use some other method!"
+  deprecated_method [:method5, :method6], "%{method} is no longer here, use some other method!"
+end
+
+obj = SomeClass.new # outputs to stderr: [DEPRECATED] deprecated class SomeClass instantiated at /Users/vasfed/work/deprecator/examples/example.rb:26:in `new'
+obj.method1 # [DEPRECATED] method1 is deprecated!
+obj.method2 # [DEPRECATED] this is deprecated when true is true
+obj.method3 # [DEPRECATED] method method3 is deprecated. Called from /Users/vasfed/work/deprecator/examples/example.rb:28:in `<top (required)>'
+obj.method4 # [DEPRECATED] method4 is no longer here, use some other method!
+obj.method6 # [DEPRECATED] method6 is no longer here, use some other method!
+
+```
+
+changing strategies:
+
+```ruby
+
+Deprecator.strategy = :raise # included: warning(default), raise, raiseHard
+
+class SomeClass
+  deprecated "some reason"
+  def initialize
+    puts "SomeClass#initialize called"
+  end
+end
+
+begin
+  SomeClass.new
+rescue Deprecator::Deprecated => e
+  puts "caught exception #{e.class}: #{e}"
+end
+
+
+class CustomStrategy < Deprecator::Strategy::Base
+  def object_found *args
+    puts "Deprecated object created."
+  end
+end
+
+Deprecator.strategy = CustomStrategy
+SomeClass.new
 
+# outputs:
+# caught exception Deprecator::DeprecatedObjectCreated: some reason
+# Deprecated object created.
+# SomeClass#initialize called
 
 ```
 

data/Rakefile

@@ -13,3 +13,7 @@ end
 # task :test => :compile
 
 task :default => :test
+
+task :run_example do
+  load File.expand_path('../examples/example.rb', __FILE__)
+end

data/examples/example.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+
+require 'deprecator'
+
+class SomeClass
+  deprecated
+
+  def method1
+    deprecated
+  end
+
+  def method2
+    if true
+      deprecated "this is deprecated when true is true"
+    end
+  end
+
+  deprecated_method
+  def method3
+  end
+
+  deprecated_method :method4, "%{method} is no longer here, use some other method!"
+  deprecated_method [:method5, :method6], "%{method} is no longer here, use some other method!"
+end
+
+obj = SomeClass.new # outputs to stderr: [DEPRECATED] deprecated class SomeClass instantiated at /Users/vasfed/work/deprecator/examples/example.rb:26:in `new'
+obj.method1 # [DEPRECATED] method1 is deprecated!
+obj.method2 # [DEPRECATED] this is deprecated when true is true
+obj.method3 # [DEPRECATED] method method3 is deprecated. Called from /Users/vasfed/work/deprecator/examples/example.rb:28:in `<top (required)>'
+obj.method4 # [DEPRECATED] method4 is no longer here, use some other method!
+obj.method6 # [DEPRECATED] method6 is no longer here, use some other method!

data/examples/example2.rb

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+
+require 'deprecator'
+
+Deprecator.strategy = :raise # included: warning(default), raise, raiseHard
+
+class SomeClass
+  deprecated "some reason"
+  def initialize
+    puts "SomeClass#initialize called"
+  end
+end
+
+begin
+  SomeClass.new
+rescue Deprecator::Deprecated => e
+  puts "caught exception #{e.class}: #{e}"
+end
+
+
+class CustomStrategy < Deprecator::Strategy::Base
+  def object_found *args
+    puts "Deprecated object created."
+  end
+end
+
+Deprecator.strategy = CustomStrategy
+SomeClass.new
+
+# outputs:
+# caught exception Deprecator::DeprecatedObjectCreated: some reason
+# Deprecated object created.
+# SomeClass#initialize called

data/lib/deprecator.rb

@@ -4,28 +4,48 @@ require 'is_a'
 
 module Deprecator
 
+  class UnknownStrategy < ArgumentError; end
+
+  class Deprecated     < RuntimeError; end
+  class DeprecatedMethodCalled  < Deprecated; end
+  class DeprecatedObjectCreated < Deprecated; end
+
+  class CodeError      < RuntimeError; end
+  class NotImplemented < CodeError; end
+  class Fixme < CodeError; end
+  class Todo < CodeError; end
+
+
+
+
   class DeprecatedClass
     def self.inherited cls
-      cls.extend(Deprecated)
+      ::Deprecator.strategy.class_found(cls, caller_line)
+      # cls.extend(Deprecated::ClassMethods)
+      # cls.send :include, Deprecated::InstanceMethods
     end
   end
 
-  module Deprecated
+  module DeprecatorModule
     def self.included cls
       cls.extend self
     end
 
     def self.extended cls
       ::Deprecator.strategy.class_found(cls, caller_line)
-      cls.send :include, InstanceMethods
+      # cls.send :include, InstanceMethods
+      # cls.extend ClassMethods
     end
 
-    module InstanceMethods
-      # SMELL: initialize in module is no good, but in this case may help for some cases
-      def initialize *args
-        ::Deprecator.strategy.object_found(self, caller_line)
-      end
-    end
+    # module ClassMethods
+    # end
+
+    # module InstanceMethods
+    #   # SMELL: initialize in module is no good, but in this case may help for some cases
+    #   def initialize *args
+    #     ::Deprecator.strategy.object_found(self, caller_line)
+    #   end
+    # end
     Class = DeprecatedClass
   end
 
@@ -42,17 +62,21 @@ module Deprecator
         @method_added_stack.push(m)
       end
 
+      @skip_next_method_added_addition = true
       define_singleton_method(:method_added, ->(name){
         return if name == :method_added
         super(name)
         old = @method_added_stack.pop
         if old
+          @skip_next_method_added_addition = true
           define_singleton_method(:method_added, old)
+          remove_instance_variable :@skip_next_method_added_addition
         else
           class <<self; remove_method(:method_added); end
         end
         blk.call(name)
       })
+      remove_instance_variable :@skip_next_method_added_addition
     end
 
     def deprecated_method name=nil, reason=nil, &blk
@@ -78,8 +102,6 @@ module Deprecator
 
   DefaultStrategy = Strategy::Warning
 
-  class UnknownStrategy < ArgumentError; end
-  class NotImplemented < RuntimeError; end
 
   @@strategy = nil
   def self.strategy

data/lib/deprecator/core_ext.rb

@@ -22,5 +22,5 @@ module Kernel
   alias NOT_IMPLEMENTED not_implemented
 end
 
-DEPRECATED = Deprecator::Deprecated
+DEPRECATED = Deprecator::DeprecatorModule
 Deprecated = DEPRECATED unless Object.const_defined?(:Deprecated)

data/lib/deprecator/strategy.rb

@@ -1,15 +1,38 @@
 module Deprecator
   module Strategy
 
-
     class Base
-      def class_found o, where=nil, reason=nil, args=nil
-        # msg(if reason
-        #   reason.gsub(/%{cls}/, o)
-        # else
-        #   "#{o} is deprecated!"
-        # end, where)
+      #on class/module definition/extenting with deprecater or deprecate statement
+      def class_found cls, where=nil, reason=nil, args=nil
+        this = self
+        cls.send(:define_method, :initialize){|*args|
+          ::Deprecator.strategy.object_found(cls, self, reason, caller_line, where)
+        }
+
+        cls.send(:define_singleton_method, :method_added, ->(name){
+          super(name)
+          if name == :initialize && !@skip_next_initialize_addition
+            meth = instance_method(name)
+            @skip_next_initialize_addition = true
+            define_method(name){|*args|
+              ::Deprecator.strategy.object_found(cls, self, reason, caller_line, where)
+              meth.bind(self).call(*args)
+            }
+            remove_instance_variable :@skip_next_initialize_addition
+          end
+          })
+        cls.send(:define_singleton_method, :singleton_method_added, ->(name){
+          #guard for self?
+          if name == :method_added && !@skip_next_method_added_addition
+            warn "[WARNING] when you replace method_added for deprecated class - you can no longer autotrack its object creation, use deprecation of initialize method."
+          end
+          })
+      end
+
+      # on deprecated class initialize
+      def object_found cls, object, reason, where, deprecated_at
       end
+      # on method definition
       def method_found cls,name, reason, where=nil
         this = self
         unless cls.method_defined?(name) # also we may place stubs there for existing methods in other strategies
@@ -24,6 +47,8 @@ module Deprecator
           }
         end
       end
+      def method_called cls,name,reason=nil,where,defined_at; end
+      def deprecated reason=nil, where=caller_line, args=nil; end
       def fixme! msg, where, args; end
       def todo! msg, where, args; end
       def not_implemented msg, where, args
@@ -31,18 +56,20 @@ module Deprecator
       end
     end
 
+
+
     class Warning < Base
       def msg msg, where=nil
-        warn "[DEPRECATED] #{msg}"
+        warn "[DEPRECATED] #{msg}".gsub('%{where}', where)
       end
 
-      def object_found o, where=nil, reason=nil # deprecated class initialize
-        msg "deprecated class #{o.class} instantiated", where
+      def object_found cls, object, reason, where, deprecated_at # deprecated class initialize
+        msg "deprecated class #{cls} instantiated at %{where}", where
       end
 
-      # this is not entry point
       def method_called cls,name,reason=nil,where,defined_at
-        msg "method #{name} is deprecated. Called from #{caller_line}"
+        reason ||= "method %{method} is deprecated. Called from %{where}"
+        msg reason.gsub('%{method}', name.to_s), where
       end
 
       def deprecated reason=nil, where=caller_line, args=nil
@@ -55,5 +82,45 @@ module Deprecator
     end
 
 
+
+    class Raise < Base
+      def object_found cls, object, reason, where, deprecated_at # deprecated class initialize
+        raise DeprecatedObjectCreated, reason || "deprecated"
+      end
+
+      def method_called cls,name,reason=nil,where,defined_at
+        reason ||= "method %{method} is deprecated."
+        raise DeprecatedMethodCalled, (reason || "deprecated").gsub('%{method}', name.to_s)
+      end
+
+      def deprecated reason=nil, where=caller_line, args=nil
+        where =~ /in `(.+)'$/
+        method_name = $1 || '<unknown>'
+        reason ||= "%{method} is deprecated!"
+        reason.gsub!('%{method}', method_name)
+        raise Deprecated, reason
+      end
+    end
+
+
+
+    class RaiseHard < Raise
+      def class_found cls, where=nil, reason=nil, args=nil
+        raise Deprecated, "#{cls} is deprecated"
+      end
+
+      def method_found cls,name, reason, where=nil
+        raise Deprecated, "#{cls}##{name} is deprecated"
+      end
+
+      def fixme! msg, where, args;
+        raise Deprecator::Fixme, msg
+      end
+
+      def todo! msg, where, args
+        raise Deprecator::Todo, msg
+      end
+    end
+
   end
 end

data/lib/deprecator/version.rb

@@ -1,3 +1,3 @@
 module Deprecator
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/deprecator_spec.rb

@@ -46,7 +46,7 @@ describe Deprecator do
 
     context "methods" do
       before{
-        subject.strategy = :warning
+        subject.strategy = :base
       }
       it "simple" do
         subject.strategy.should_receive(:deprecated).with("reason", duck_type(:to_s), [])
@@ -73,6 +73,34 @@ describe Deprecator do
   end
 
   context "strategy" do
+    context "also installs hooks for class instantiation" do
+      before{ subject.strategy = :base }
+      it "without a reason passed" do
+        cls = Class.new(DEPRECATED::Class)
+        subject.strategy.should_receive(:object_found).with(cls, kind_of(cls), nil, /#{Regexp.escape __FILE__}:#{__LINE__+1}/, /#{Regexp.escape __FILE__}:#{__LINE__-1}/)
+        cls.new
+      end
+
+      it "with reason passed" do
+        cls = Class.new{ deprecated "reason" }
+        subject.strategy.should_receive(:object_found).with(cls, kind_of(cls), "reason", /#{Regexp.escape __FILE__}:#{__LINE__+1}/, /#{Regexp.escape __FILE__}:#{__LINE__-1}/)
+        cls.new
+      end
+
+      it "and guards for initialize method" do
+        cls = Class.new{
+          deprecated "reason"
+          # def self.method_added(name); puts "method added #{name}"; end
+          def initialize
+            self.class.initialize_called
+          end
+        }
+        cls.should_receive(:initialize_called).once
+        subject.strategy.should_receive(:object_found).with(cls, kind_of(cls), "reason", /#{Regexp.escape __FILE__}:#{__LINE__+1}/, /#{Regexp.escape __FILE__}:#{__LINE__-7}/)
+        cls.new
+      end
+    end
+
     context "set" do
       it "via object" do
         obj = Object.new

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: deprecator
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -89,6 +89,8 @@ files:
 - README.md
 - Rakefile
 - deprecator.gemspec
+- examples/example.rb
+- examples/example2.rb
 - lib/deprecator.rb
 - lib/deprecator/core_ext.rb
 - lib/deprecator/strategy.rb
@@ -116,7 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2851817988265802731
+      hash: 2302177472746095841
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24