deprecations 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 42b4cf87903a557ef44e7fa0f7d8e7cbda134c7f
-  data.tar.gz: 23360fbe0f87964cde7e0987c7df5ae10c3cd172
+  metadata.gz: 78ed3cd91fd99c383cfcf80cf73f9e5757f0f007
+  data.tar.gz: bf79ec77bdff29dc0222a4b385efa37d7bc27fd5
 SHA512:
-  metadata.gz: 64409aa1740a08d1cabe23694cfaf86ca95eb0348ca9f0ff90f5589dc9cbe771d5696f631f1dab038bf0b1c945f1c0524d2322dd086b8f9ab6801207178a49d4
-  data.tar.gz: e2b7f0edbbbb9df6f32f10210b02c3cc2c8c3160b8831ba1f15c14a2874c70925b0797741d2597ff7a329fb66f5ef1ceeb4f091e98e6de15cb949efa6c51a275
+  metadata.gz: 600ef0c82127f3df1111751cad2a13fdd0aa4342051fa629f122f498dac8ee469182f1417474df5ff1b60db178276858e707a8becfb9f62449d75e05126f41fb
+  data.tar.gz: 17760c77380a0379c7e8cc523a1869bcf77164156fe4749d63ba3ed6afa674f1f0cf9bbed7f63f394e35b956e76dba51786f47d0e6d8fe84bdd4b5ac7aec51d0

data/CHANGELOG.md

@@ -1,2 +1,5 @@
+### deprecations 1.0.2
+- support for late bound class names (like in `Foo = Class.new`)
+
 ### deprecations 1.0.0
 - initial release

data/lib/deprecations/extension.rb

@@ -18,12 +18,12 @@ module Deprecations
       end
 
       def __define_deprecated(name, decorated_name, scope, alternative, outdated)
-        alias_name = __private_alias(name, decorated_name )
+        alias_name = __private_alias(name, decorated_name)
+        send(scope, name)
         define_method(name) do |*a, &b|
           Deprecations.call(decorated_name, alternative, outdated)
           send(alias_name, *a, &b)
         end
-        send(scope, name)
         name
       end
 
@@ -44,7 +44,7 @@ module Deprecations
         method_scope = __method_scope(method_name) or __not_found!(method_name)
         __define_deprecated(
           method_name,
-          "#{self.inspect[8..-2]}.#{method_name}",
+          ->{"#{self.inspect[8..-2]}.#{method_name}"},
           method_scope,
           __decorated(alternative_method_name),
           outdated
@@ -55,7 +55,7 @@ module Deprecations
 
       def __decorated(name)
         name or return nil
-        __method_scope(name) and return "#{self.inspect[8..-2]}.#{name}"
+        __method_scope(name) and return ->{"#{self.inspect[8..-2]}.#{name}"}
         Symbol === name and __not_found!(name)
         name
       end
@@ -73,7 +73,7 @@ module Deprecations
         singleton_class.send(
           :__define_deprecated,
           :new,
-          name,
+          ->{self},
           :public,
           alternative ? "#{alternative}" : nil,
           outdated
@@ -83,7 +83,7 @@ module Deprecations
       def deprecated(method_name, alternative_method_name = nil, outdated = nil)
         method_scope = __method_scope(method_name) and return __define_deprecated(
           method_name,
-          "#{name}##{method_name}",
+          ->{"#{self}##{method_name}"},
           method_scope,
           __decorated(alternative_method_name),
           outdated
@@ -95,7 +95,7 @@ module Deprecations
 
       def __decorated(name)
         name or return nil
-        __method_scope(name) ? "#{self.name}##{name}" : singleton_class.send(:__decorated, name)
+        __method_scope(name) ? ->{"#{self}##{name}"} : singleton_class.send(:__decorated, name)
       end
     end
   end

data/lib/deprecations/version.rb

@@ -1,3 +1,3 @@
 module Deprecations
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
 end

data/lib/deprecations.rb

@@ -21,8 +21,8 @@ module Deprecations
     private
 
     def throw!(subject, alternative)
-      msg = "`#{subject}` is deprecated"
-      alternative and msg << " - use #{alternative} instead"
+      msg = "`#{value(subject)}` is deprecated"
+      alternative and msg << " - use #{value(alternative)} instead"
       ex = DeprecationError.new(msg)
       ex.set_backtrace(caller(3))
       raise(ex)
@@ -30,11 +30,15 @@ module Deprecations
 
     def warn(subject, alternative, outdated)
       location = ::Kernel.caller_locations(3,1).last and location = "#{location.path}:#{location.lineno}: "
-      msg = "#{location}[DEPRECATION] `#{subject}` is deprecated"
-      msg << (outdated ? " and will be outdated #{outdated}." : '.')
-      alternative and msg << " Please use `#{alternative}` instead."
+      msg = "#{location}[DEPRECATION] `#{value(subject)}` is deprecated"
+      msg << ((outdated = value(outdated)) ? " and will be outdated #{outdated}." : '.')
+      alternative = value(alternative) and msg << " Please use `#{alternative}` instead."
       ::Kernel.warn(msg)
     end
+    
+    def value(arg)
+      defined?(arg.call) ? arg.call : arg
+    end
 
   end
 end

data/spec/deprecations_spec.rb

@@ -23,58 +23,66 @@ module DeprecationsSamples # samples how to use
 
   # here we go:
 
-  # method Sample1#foo is deprecated
   class Sample1
     include MethodSamples
-    deprecated :foo
+    deprecated :foo # Sample1#foo is deprecated
   end
 
-  # method Sample2#foo is deprecated, Sample2#alt should be used
   class Sample2
     include MethodSamples
-    deprecated :foo, :alt
+    deprecated :foo, :alt # Sample2#foo is deprecated, Sample2#alt should be used
   end
 
-  # method Sample3#foo is deprecated and will be outdated in next version, Sample3#alt should be used
   class Sample3
     include MethodSamples
-    deprecated :foo, :alt, 'next version'
+    deprecated :foo, :alt, 'next version' # Sample3#foo is deprecated and will be outdated in next version, Sample3#alt should be used
   end
 
-  # class method Sample4::foo is deprecated
   class Sample4
     extend MethodSamples
-    deprecated :foo
+    deprecated :foo # class method Sample4::foo is deprecated
   end
 
-  # class method Sample5::foo is deprecated, Sample5::alt should be used
   class Sample5
     extend MethodSamples
-    deprecated :foo, :alt
+    deprecated :foo, :alt # class method Sample5::foo is deprecated, Sample5::alt should be used
   end
 
-  # class method Sample6::foo is deprecated and will be outdated in next version, Sample6::alt should be used
   class Sample6
     extend MethodSamples
-    deprecated :foo, :alt, 'next version'
+    deprecated :foo, :alt, 'next version' # class method Sample6::foo is deprecated and will be outdated in next version, Sample6::alt should be used
   end
 
-  # class Sample7 is deprecated
   class Sample7
+    deprecated! # class Sample7 is deprecated
     include InitializerSample
-    deprecated!
   end
 
-  # class Sample8 is deprecated, class Sample1 should be used
   class Sample8
+    deprecated! Sample1 # class Sample8 is deprecated, class Sample1 should be used
     include InitializerSample
-    deprecated! Sample1
   end
 
-  # class Sample9 is deprecated and will be outdated in version 2.0.0, class Sample1 should be used
   class Sample9
+    deprecated! Sample1, 'in 2.0.0' # class Sample9 is deprecated and will be outdated in version 2.0.0, class Sample1 should be used
     include InitializerSample
-    deprecated! Sample1, 'in 2.0.0'
+  end
+
+  module AnonymousDefined
+    AnnoSample7 = Class.new do
+      deprecated! # class AnonymousDefined::AnnoSample7 is deprecated
+      include InitializerSample
+    end
+
+    AnnoSample8 = Class.new do
+      deprecated! Sample1 # class AnonymousDefined::AnnoSample8 is deprecated, class Sample1 should be used
+      include InitializerSample
+    end
+
+    AnnoSample9 = Class.new do
+      deprecated! Sample1, 'in 2.0.0' # class AnonymousDefined::AnnoSample9 is deprecated and will be outdated in version 2.0.0, class Sample1 should be used
+      include InitializerSample
+    end
   end
 
 end
@@ -278,6 +286,34 @@ RSpec.describe Deprecations do
       end
     end
 
+    context 'when a anonymous class is marked as deprecated' do
+      let(:sample){ DeprecationsSamples::AnonymousDefined::AnnoSample7 }
+
+      it_should_behave_like 'a deprecated class (warnings enabled)'
+
+      context 'when an optional alternative class is given' do
+        let(:sample){ DeprecationsSamples::AnonymousDefined::AnnoSample8 }
+
+        it_should_behave_like 'a deprecated class (warnings enabled)'
+
+        it 'suggests the alternative class' do
+          expect(Kernel).to receive(:warn).with(/\bDeprecationsSamples::Sample1\b.*\binstead\b/)
+          sample.new
+        end
+      end
+
+      context 'when an optional comment is given' do
+        let(:sample){ DeprecationsSamples::AnonymousDefined::AnnoSample9 }
+
+        it_should_behave_like 'a deprecated class (warnings enabled)'
+
+        it 'informs about when it will become outdated' do
+          expect(Kernel).to receive(:warn).with(/outdated in 2.0.0/)
+          sample.new
+        end
+      end
+    end
+
     context 'error cases' do
 
       context 'when the method to mark as deprecated does not exist' do
@@ -341,4 +377,4 @@ RSpec.describe Deprecations do
       end
     end
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deprecations
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Mike Blumtritt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-31 00:00:00.000000000 Z
+date: 2014-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -141,3 +141,4 @@ signing_key:
 specification_version: 4
 summary: Deprecation support for your project.
 test_files: []
+has_rdoc: false