deprecation 0.2.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a2f81b6ac3b0ec0e588962e5c9b0314e7a8a3439
-  data.tar.gz: b63ada54354a0804f77c468ade91442b5d82bb72
+SHA256:
+  metadata.gz: e9a260ef95ae7ea900cdccf416399e8168e8da46ab3495addb20f104a3126657
+  data.tar.gz: 34417abfaf5f55051c0046f3b68a7deac496be50b79ebd750939305134a36f47
 SHA512:
-  metadata.gz: a6b8a23cff2ad9efb77fcc4b5ec5d1b120239d2a3163108c97d5ae84241e668f9761253e034ceecc90aeffcb9842e831d477e8ec6b326da1feddfe6cc653086d
-  data.tar.gz: 905c8692fa62dab1eaf683a42b288dab2246a615a258b80bfda4a273f22f97b5bead792f39ceea651ca026fe53fa917425029534f0c130f06ac7ab30970283c8
+  metadata.gz: 13c2f5fd578288526c121533c676e4e29d1efa38c28d8f6de77807ee258a0a23c090bfbbdf4b2f55104c3885fb385f097da4cc83f9bd0ecae63f2e7ee3451abe
+  data.tar.gz: a8e27ab502a86737076f1decb8f7de57c8945a716adb64657692a618e394c8a39b5ba95f3816cd56fb3023d29f6dcf293089fb8fda2f15565bff20cc8cb8b779

data/.github/workflows/ruby.yml

@@ -0,0 +1,31 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [2.6, 2.7, 3.0]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rake

data/Gemfile

@@ -1,3 +1,3 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 gemspec

data/README.md

@@ -1,7 +1,5 @@
 Deprecation
 ------------
-[![Build Status](https://travis-ci.org/cbeer/deprecation.png?branch=master)](https://travis-ci.org/cbeer/deprecation)
-
 Provide deprecation warnings for code
 
 ## Add warnings
@@ -52,4 +50,4 @@ Deprecation.default_deprecation_behavior = :raise # Raise an exception when usin
 
 Deprecation.default_deprecation_behavior = :silence # ignore all deprecations
 
-```
+```

data/deprecation.gemspec

@@ -12,6 +12,8 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/cbeer/deprecation"
   s.license = "MIT"
 
+  s.required_ruby_version = '>= 2.1'
+
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
@@ -23,4 +25,3 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rspec", ">= 2.14"
   s.add_development_dependency "bundler", ">= 1.0.14"
 end
-

data/lib/deprecation.rb

@@ -49,9 +49,6 @@ module Deprecation
   end
 
   included do
-    class << self
-    end
-
     # By default, warnings are not silenced and debugging is off.
     self.silenced = false
     self.debug = false

data/lib/deprecation/method_wrappers.rb

@@ -7,20 +7,35 @@ module Deprecation
     options = method_names.extract_options!
     method_names += options.keys
 
+    generated_deprecation_methods = Module.new
     method_names.each do |method_name|
-      target_module.alias_method_chain(method_name, :deprecation) do |target, punctuation|
-        target_module.module_eval(<<-end_eval, __FILE__, __LINE__ + 1)
-          def #{target}_with_deprecation#{punctuation}(*args, &block)
+      if RUBY_VERSION < '3'
+        generated_deprecation_methods.module_eval(<<-end_eval, __FILE__, __LINE__ + 1)
+          def #{method_name}(*args, &block)
             Deprecation.warn(#{target_module.to_s},
               Deprecation.deprecated_method_warning(#{target_module.to_s},
                 :#{method_name},
                 #{options[method_name].inspect}),
               caller
             )
-            send(:#{target}_without_deprecation#{punctuation}, *args, &block)
+            super
+          end
+          pass_keywords(:#{method_name}) if respond_to?(:pass_keywords, true)
+        end_eval
+      else
+        generated_deprecation_methods.module_eval(<<-end_eval, __FILE__, __LINE__ + 1)
+          def #{method_name}(*args, **kwargs, &block)
+            Deprecation.warn(#{target_module.to_s},
+              Deprecation.deprecated_method_warning(#{target_module.to_s},
+                :#{method_name},
+                #{options[method_name].inspect}),
+              caller
+            )
+            super
           end
         end_eval
       end
     end
+    target_module.prepend generated_deprecation_methods
   end
 end

data/lib/deprecation/reporting.rb

@@ -18,7 +18,7 @@ module Deprecation
       end
 
       deprecation_message(callstack, message).tap do |m|
-        deprecation_behavior(context).each { |b| b.call(m, callstack) }
+        deprecation_behavior(context).each { |b| b.call(m, sanitized_callstack(callstack)) }
       end
     end
 
@@ -62,7 +62,7 @@ module Deprecation
         options = {}
       end
 
-      warning = "#{method_name} is deprecated and will be removed from #{options[:deprecation_horizon] || context.deprecation_horizon}"
+      warning = "#{method_name} is deprecated and will be removed from #{options[:deprecation_horizon] || (context.deprecation_horizon if context.respond_to? :deprecation_horizon) || "a future release"}"
       case message
         when Symbol then "#{warning} (use #{message} instead)"
         when String then "#{warning} (#{message})"
@@ -92,8 +92,7 @@ module Deprecation
       end
 
       def extract_callstack(callstack)
-        deprecation_gem_root = File.expand_path("../..", __FILE__) + "/"
-        offending_line = callstack.find { |line| !line.start_with?(deprecation_gem_root) and line !~ IGNORE_REGEX } || callstack.first
+        offending_line = sanitized_callstack(callstack).first || callstack.first
         if offending_line
           if md = offending_line.match(/^(.+?):(\d+)(?::in `(.*?)')?/)
             md.captures
@@ -102,5 +101,13 @@ module Deprecation
           end
         end
       end
+
+      def sanitized_callstack(callstack)
+        callstack.reject { |line| line.start_with? deprecation_gem_root}.select { |line| (line =~ IGNORE_REGEX).nil? }
+      end
+
+      def deprecation_gem_root
+        File.expand_path("../..", __FILE__) + "/"
+      end
   end
 end

data/lib/deprecation/version.rb

@@ -1,3 +1,3 @@
 module Deprecation
-  VERSION = "0.2.0"
+  VERSION = "1.1.0"
 end

data/spec/deprecation_spec.rb

@@ -9,13 +9,13 @@ describe Deprecation do
 
 
     def a
-      1 
+      1
     end
 
     deprecation_deprecate :a
 
     def b
-      
+
     end
 
     def c
@@ -23,15 +23,21 @@ describe Deprecation do
     end
 
     def d
-
+      4
     end
-    
+
     deprecation_deprecate :c, :d
 
     def e
 
     end
     deprecation_deprecate :e => { :deprecation_horizon => 'asdf 1.4' }
+
+
+    def f(x, foo: nil)
+      7
+    end
+    deprecation_deprecate :f
   end
   subject { DeprecationTest.new}
 
@@ -41,6 +47,32 @@ describe Deprecation do
     end
   end
 
+  describe "a method that takes positional args and keyword args" do
+    around do |example|
+      # We need to suppress the raise behavior, so we can ensure the original method is called
+      DeprecationTest.deprecation_behavior = :silence
+      example.run
+      DeprecationTest.deprecation_behavior = :raise
+    end
+
+    it "delegates to the original" do
+      expect(subject.f 9, foo: 3).to eq 7
+    end
+  end
+
+  describe "a method that takes no args" do
+    around do |example|
+      # We need to suppress the raise behavior, so we can ensure the original method is called
+      DeprecationTest.deprecation_behavior = :silence
+      example.run
+      DeprecationTest.deprecation_behavior = :raise
+    end
+
+    it "delegates to the original" do
+      expect(subject.d).to eq 4
+    end
+  end
+
   describe "b" do
     it "should not be deprecated" do
       expect { subject.b }.not_to raise_error
@@ -90,12 +122,11 @@ describe Deprecation do
     let(:logger) { double() }
 
     before(:each) do
-      Deprecation.stub logger: logger
-      Deprecation.stub default_deprecation_behavior: :log
+      allow(Deprecation).to receive_messages(logger: logger, default_deprecation_behavior: :log)
     end
 
     it "should provide a useful deprecation trace" do
-      logger.should_receive(:warn).with(/called from old_method/)
+      expect(logger).to receive(:warn).with(/called from old_method/)
       expect(A.new.old_method).to eq true
 
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deprecation
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Chris Beer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-19 00:00:00.000000000 Z
+date: 2021-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -73,8 +73,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
-- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -102,15 +102,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Stand-alone deprecation library borrowed from ActiveSupport::Deprecation

data/.travis.yml

@@ -1,6 +0,0 @@
-language: ruby
-rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.0
-  - jruby-19mode