deprecations 2.0.4 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d98430ec3094db3b30af3b96a693db71e2968d3fa2dda4fb92bdaacf67e0e8f8
-  data.tar.gz: 0bf5b46d38582b06aa63fc697b46539a44b376d4b207ce495e305fe70e587753
+  metadata.gz: 976d65184fd1442180e364ecd885aabf9202877f1bb7d11c1315eed9fe30b5ee
+  data.tar.gz: bf4ad1bc538b49878a6268321883d1d89a3cc3fe0627ef8c2d37200972c22ad2
 SHA512:
-  metadata.gz: 8ef90c37e7050de756e4f1c463be6813aedc2b4d24e374938d4ce29d744dabe11fd64d721c6ac2cd3493b8c76f1401ff4c73f7e00c09e152ab90f03e89892f55
-  data.tar.gz: '045540686602609ee4bf04ff1a862b5cb9f1da9027d839d55da66a458caaa8f7ac94404879c0cb5c33a002387a8df49f083987c73a62319ebeb554557e3a3baa'
+  metadata.gz: 29383bc82baad099e0597f6efb0c4a0e2d4bb7f87e2235c19e1ebd58e0611c287aa7b1f478c1e75fc942f43bd2078cfb09f80f90df72ab4d184012e2dee8a51d
+  data.tar.gz: 0636b27fc0c83e46df73364b669b6c59f0c2e844e424807a990ee45d8bf1957b93db289d744d63013b099317f8f23618aa92b979c468a200712608956bd220a7

data/README.md

@@ -52,7 +52,7 @@ end
 
 Whenever the method `MySample#clean` is called this warning appears:
 
-> [DEPRECATION] `MySample#clean` is deprecated and will be outdated next version. Please use `MySample#clear` instead.
+> warning: `MySample#clean` is deprecated and will be outdated next version. Please use `MySample#clear` instead.
 
 Marking a complete class as deprecated will present the deprecation warning whenever this class is instantiated:
 
@@ -89,7 +89,7 @@ Any object responding to `#call` will be accepted as a valid handler.
 Whenever you need to temporary change the standard behavior (like e.g. in your specs) you can do this like
 
 ```ruby
-Deprecations.set_behavior(:silent) do
+Deprecations.with_behavior(:silent) do
   MyDeprecatedClass.new.do_some_magic
 end
 ```

data/lib/deprecations/behavior.rb

@@ -1,14 +1,16 @@
+# frozen_string_literal: true
+
 module Deprecations
   class << self
     def behavior
       BEHAVIOR.key(@behavior) || @behavior
     end
 
-    def behavior=(behavior)
-      @behavior = as_behavior(behavior)
+    def behavior=(value)
+      @behavior = as_behavior(value)
     end
 
-    def set_behavior(behavior)
+    def with_behavior(behavior)
       behavior = as_behavior(behavior)
       raise(ArgumentError, 'block expected') unless block_given?
       current_behavior = @behavior
@@ -20,6 +22,8 @@ module Deprecations
       end
     end
 
+    alias set_behavior with_behavior
+
     private
 
     def as_behavior(arg)
@@ -27,7 +31,7 @@ module Deprecations
       BEHAVIOR.fetch(arg) do
         raise(
           ArgumentError,
-          'invalid parameter - behavior has to be' \
+          'invalid parameter - behavior has to be ' \
             "#{valid_behaviors} or need to respond to `call`"
         )
       end
@@ -42,22 +46,20 @@ module Deprecations
         msg = "`#{subject}` is deprecated"
         msg << " - use #{alternative} instead" if alternative
         ex = Error.new(msg)
-        ex.set_backtrace(caller(4))
+        ex.set_backtrace(caller(3))
         raise(ex)
       end
     end
 
     module Warn
       def self.call(subject, alternative, outdated)
-        location = caller_locations(4, 1)[-1]
-        location = "#{location.path}:#{location.lineno}: " if location
-        msg = "#{location}[DEPRECATION] `#{subject}` is deprecated"
+        msg = "`#{subject}` is deprecated"
         msg << (outdated ? " and will be outdated #{outdated}." : '.')
         msg << " Please use `#{alternative}` instead." if alternative
-        ::Kernel.warn(msg)
+        ::Kernel.warn(msg, uplevel: 3)
       end
     end
 
-    BEHAVIOR = {silence: ->(*){ }, raise: Raise, warn: Warn}
+    BEHAVIOR = { silence: proc {}, raise: Raise, warn: Warn }.freeze
   end
 end

data/lib/deprecations/extension.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 module Deprecations
   class << self
     private
+
     def infect(mod)
       mod.extend(ClassMethods)
       mod.send(:include, InstanceMethods)
@@ -8,8 +11,13 @@ module Deprecations
 
     module Helper
       private
+
       def __method(method_name)
-        instance_method(method_name) rescue nil
+        begin
+          instance_method(method_name)
+        rescue StandardError
+          nil
+        end
       end
 
       def __method_deprecated!(method, alternative, outdated)
@@ -17,16 +25,23 @@ module Deprecations
         undef_method(method.name)
         define_method(method.name) do |*a, &b|
           decorated = Class === self ? "#{self}." : "#{defining_context}#"
-          alternative = "#{decorated}#{alternative.name}" if UnboundMethod === alternative
-          Deprecations.call("#{decorated}#{::Kernel.__method__}", alternative, outdated)
+          alternative = "#{decorated}#{alternative.name}" if UnboundMethod ===
+            alternative
+          Deprecations.call(
+            "#{decorated}#{::Kernel.__method__}",
+            alternative,
+            outdated
+          )
           method.bind(self).call(*a, &b)
         end
       end
 
       def __method_checked(method_name)
-        __method(method_name) or raise(
-          NameError, "undefined method `#{method_name}` for class `#{self}`"
-        )
+        __method(method_name) or
+          raise(
+            NameError,
+            "undefined method `#{method_name}` for class `#{self}`"
+          )
       end
 
       def __method_alternative(alternative)
@@ -36,6 +51,7 @@ module Deprecations
 
     module ClassMethods
       private
+
       include Helper
 
       def deprecated(method_name, alternative = nil, outdated = nil)
@@ -49,12 +65,19 @@ module Deprecations
 
     module InstanceMethods
       private
+
       include Helper
 
       def deprecated(method_name, alternative = nil, outdated = nil)
-        m = __method(method_name) or return singleton_class.send(
-          :deprecated, method_name, alternative, outdated
-        )
+        m = __method(method_name) or
+          return(
+            singleton_class.send(
+              :deprecated,
+              method_name,
+              alternative,
+              outdated
+            )
+          )
         __method_deprecated!(m, __method_alternative(alternative), outdated)
       end
 
@@ -66,7 +89,6 @@ module Deprecations
         end
       end
     end
-
   end
 
   infect(Module)

data/lib/deprecations/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Deprecations
-  VERSION = '2.0.4'
+  VERSION = '2.2.2'
 end

data/lib/deprecations.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Deprecations
-  autoload(:VERSION, "#{__FILE__[/.*(?=\..+$)/]}/version")
+  require_relative 'deprecations/version'
   require_relative 'deprecations/extension'
   require_relative 'deprecations/behavior'
 

metadata

@@ -1,97 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: deprecations
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 2.2.2
 platform: ruby
 authors:
 - Mike Blumtritt
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-05-13 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.11'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.11'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 10.1.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 10.1.1
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.0.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.0.0
+date: 2022-07-30 00:00:00.000000000 Z
+dependencies: []
 description: |
   This gem provides transparent declaration of deprecated methods and classes.
   It's easy, small, has no dependencies and no overhead.
-email: mike.blumtritt@invision.de
+email:
 executables: []
 extensions: []
 extra_rdoc_files:
 - README.md
 files:
-- ".gitignore"
-- Gemfile
-- Guardfile
 - README.md
-- Rakefile
-- deprecations.gemspec
 - lib/deprecations.rb
 - lib/deprecations/behavior.rb
 - lib/deprecations/extension.rb
 - lib/deprecations/version.rb
-- spec/deprecations/behavior_spec.rb
-- spec/deprecations/version_spec.rb
-- spec/deprecations_spec.rb
-- spec/spec_helper.rb
 homepage: https://github.com/mblumtritt/deprecations
 licenses: []
 metadata:
-  issue_tracker: https://github.com/mblumtritt/deprecations/issues
-post_install_message: 
+  source_code_uri: https://github.com/mblumtritt/deprecations
+  bug_tracker_uri: https://github.com/mblumtritt/deprecations/issues
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -104,15 +42,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.6
+      version: '0'
 requirements: []
-rubyforge_project: deprecations
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Deprecation support for your project.
-test_files:
-- spec/deprecations/behavior_spec.rb
-- spec/deprecations/version_spec.rb
-- spec/deprecations_spec.rb
-- spec/spec_helper.rb
+test_files: []

data/.gitignore

@@ -1,5 +0,0 @@
-tmp/
-local/
-pkg/
-coverage/
-Gemfile.lock

data/Gemfile

@@ -1 +0,0 @@
-source('https://rubygems.org'){ gemspec }

data/Guardfile

@@ -1,12 +0,0 @@
-guard(
-  :rspec,
-  cmd: 'bundle exec rspec -c',
-  spec_paths: ['spec'],
-  failed_mode: :focus,
-  all_on_start: true,
-  all_after_pass: true
-) do
-  watch(%r{^spec/.+_spec.rb$})
-  watch(%r{^lib/.+.rb$}){ 'spec' }
-  watch(%r{^spec/spec_helper}){ 'spec' }
-end

data/Rakefile

@@ -1,10 +0,0 @@
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:test) do |t|
-  t.pattern = ['spec/*_spec.rb', 'spec/**/*/*_spec.rb']
-  t.rspec_opts = '-w'
-  t.verbose = Rake.application.options.trace
-end
-
-task default: :test

data/deprecations.gemspec

@@ -1,32 +0,0 @@
-require File.expand_path('../lib/deprecations/version', __FILE__)
-
-Gem::Specification.new do |spec|
-  spec.name = spec.rubyforge_project = 'deprecations'
-  spec.version = Deprecations::VERSION
-  spec.summary = 'Deprecation support for your project.'
-  spec.description = <<~EOS
-    This gem provides transparent declaration of deprecated methods and classes.
-    It's easy, small, has no dependencies and no overhead.
-  EOS
-  spec.author = 'Mike Blumtritt'
-  spec.email = 'mike.blumtritt@invision.de'
-  spec.homepage = 'https://github.com/mblumtritt/deprecations'
-  spec.metadata = {'issue_tracker' => 'https://github.com/mblumtritt/deprecations/issues'}
-
-  spec.add_development_dependency 'bundler', '~> 1.11'
-  spec.add_development_dependency 'rake', '~> 10.1', '>= 10.1.1'
-  spec.add_development_dependency 'rspec', '~> 3.0', '>= 3.0.0'
-
-  spec.platform = Gem::Platform::RUBY
-  spec.required_ruby_version = '>= 2.0.0'
-  spec.required_rubygems_version = Gem::Requirement.new('>= 1.3.6')
-
-  spec.require_paths = %w[lib]
-
-  all_files = %x(git ls-files -z).split(0.chr)
-  spec.test_files = all_files.grep(%r{^(spec|test)/})
-  spec.files = all_files - spec.test_files
-
-  spec.has_rdoc = false
-  spec.extra_rdoc_files = %w(README.md)
-end

data/spec/deprecations/behavior_spec.rb

@@ -1,98 +0,0 @@
-require 'spec_helper'
-
-RSpec.describe Deprecations do
-  context 'behavior' do
-
-    it 'is possible to configure the behavior with a pre-defined value' do
-      %i(silence raise warn).each do |behavior|
-        Deprecations.behavior = behavior
-        expect(Deprecations.behavior).to be(behavior)
-      end
-    end
-
-    it 'is possible to configure a custom behavior' do
-      custom = proc do |*args|
-        FantasticLogger.log(*args)
-      end
-      Deprecations.behavior = custom
-      expect(Deprecations.behavior).to be(custom)
-    end
-
-    context 'standard behavior :silence' do
-      before do
-        Deprecations.behavior = :silence
-      end
-
-      it 'does simply nothing' do
-        expect(subject.call(*%w(should be silent))).to be(subject)
-      end
-    end
-
-    context 'standard behavior :warn' do
-      before do
-        Deprecations.behavior = :warn
-      end
-      after do
-        Deprecations.call('Bad#method', 'Bad#alternative', 'after next version')
-      end
-
-      it 'warns about the deprecation' do
-        expect(Kernel).to receive(:warn).once.with(/DEPRECATION/)
-      end
-
-      it 'points to the deprecated method' do
-        expect(Kernel).to receive(:warn).once.with(/Bad#method.*deprecated/)
-      end
-
-      it 'suggests the alternative method' do
-        expect(Kernel).to receive(:warn).once.with(/Bad#alternative.*instead/)
-      end
-
-      it 'contains information about when it will not longer supported' do
-        expect(Kernel).to receive(:warn).once.with(/outdated after next version/)
-      end
-    end
-
-    context 'standard behavior :raise' do
-      before do
-        Deprecations.behavior = :raise
-      end
-      subject{ Deprecations.call('Bad#method', 'Bad#alternative', 'after next version') }
-
-      it 'raises a Deprecations::Error' do
-        expect{ subject }.to raise_error(Deprecations::Error)
-      end
-
-      it 'points to the deprecated method' do
-        expect{ subject }.to raise_error(Deprecations::Error, /Bad#method.*deprecated/)
-      end
-
-      it 'suggests the alternative method' do
-        expect{ subject }.to raise_error(Deprecations::Error, /Bad#alternative.*instead/)
-      end
-    end
-
-    context 'change behavior temporary' do
-      let(:sample_class) do
-        Class.new(BasicObject) do
-          deprecated!
-        end
-      end
-
-      before do
-        Deprecations.behavior = :raise
-      end
-
-      after do
-        Deprecations.set_behavior(:warn) do
-          sample_class.new.__id__
-        end
-      end
-
-      it 'is possible to temporary use a different behavior' do
-        expect(Kernel).to receive(:warn).once
-      end
-
-    end
-  end
-end

data/spec/deprecations/version_spec.rb

@@ -1,7 +0,0 @@
-require 'spec_helper'
-
-RSpec.describe 'Deprecations::VERSION' do
-  it 'has format <major>.<minor>.<build>' do
-    expect(Deprecations::VERSION).to match(/^\d{1,2}\.\d{1,2}\.\d{1,3}/)
-  end
-end

data/spec/deprecations_spec.rb

@@ -1,235 +0,0 @@
-require 'spec_helper'
-
-RSpec.describe Deprecations do
-  context 'policy' do
-    before do
-      Deprecations.behavior = :silence
-    end
-
-    context 'parameter forwarding' do
-
-      context 'when an instance method is marked as deprecated' do
-        subject do
-          Class.new(BasicObject) do
-            def foo(*args)
-              {foo: args}
-            end
-            deprecated :foo
-          end
-        end
-
-        it 'forwards all parameters and returns the original method`s result' do
-          result = subject.new.foo(:arg1, :arg2, 42)
-          expect(result).to eq(foo: [:arg1, :arg2, 42])
-        end
-      end
-
-      context 'when a class method is marked as deprecated' do
-        subject do
-          Class.new(BasicObject) do
-            def self.foo(*args)
-              {foo: args}
-            end
-            deprecated :foo
-          end
-        end
-
-        it 'forwards all parameters and returns the original method`s result' do
-          result = subject.foo(:arg1, :arg2, 42)
-          expect(result).to eq(foo: [:arg1, :arg2, 42])
-        end
-      end
-
-      context 'when a class is marked as deprecated' do
-        subject do
-          Class.new(BasicObject) do
-            attr_reader :parameters
-            def initialize(*parameters)
-              @parameters = parameters
-            end
-            deprecated!
-          end
-        end
-
-        it 'forwards all parameters to the initializer and returns the original method`s result' do
-          expect(subject.new(:arg1, :arg2, 42).parameters).to eq([:arg1, :arg2, 42])
-        end
-      end
-
-    end
-
-    context 'block forwarding' do
-
-      context 'when an instance method is marked as deprecated' do
-        subject do
-          Class.new(BasicObject) do
-            def foo(arg)
-              yield(arg)
-            end
-            deprecated :foo
-          end
-        end
-
-        it 'forwards a given Proc to the original method' do
-          result = subject.new.foo(41) do |arg|
-            {my_blocks_result: arg + 1}
-          end
-          expect(result).to eq(my_blocks_result: 42)
-        end
-      end
-
-      context 'when a class method is marked as deprecated' do
-        subject do
-          Class.new(BasicObject) do
-            def self.foo(arg)
-              yield(arg)
-            end
-            deprecated :foo
-          end
-        end
-
-        it 'forwards a given Proc to the original method' do
-          result = subject.foo(665) do |arg|
-            {my_blocks_result: arg + 1}
-          end
-          expect(result).to eq(my_blocks_result: 666)
-        end
-      end
-
-      context 'when a class is marked as deprecated' do
-        subject do
-          Class.new(BasicObject) do
-            attr_reader :value
-            def initialize(arg)
-              @value = yield(arg)
-            end
-            deprecated!
-          end
-        end
-
-        it 'forwards a given Proc to the initializer' do
-          instance = subject.new(41) do |arg|
-            {my_blocks_result: arg + 1}
-          end
-          expect(instance.value).to eq(my_blocks_result: 42)
-        end
-      end
-
-    end
-
-  end
-
-  context 'handling' do
-
-    context 'when a method is marked as deprecated' do
-
-      context 'when an alternative method and a comment are present ' do
-        subject do
-          Class.new(BasicObject) do
-            def foo
-            end
-            def bar
-            end
-            deprecated :foo, :bar, 'next version'
-          end
-        end
-
-        after do
-          subject.new.foo
-        end
-
-        it 'calls the handler with correct subject' do
-          expect(Deprecations).to receive(:call)
-            .once
-            .with("#{subject}#foo", anything, anything)
-        end
-        it 'calls the handler with correct alternative method' do
-          expect(Deprecations).to receive(:call)
-            .once
-            .with(anything, "#{subject}#bar", anything)
-        end
-        it 'calls the handler with a comment' do
-          expect(Deprecations).to receive(:call)
-            .once
-            .with(anything, anything, 'next version')
-        end
-      end
-
-      context 'when no alternative method and no comment are present' do
-        subject do
-          Class.new(BasicObject) do
-            def bar
-            end
-            deprecated :bar
-          end
-        end
-
-        after do
-          subject.new.bar
-        end
-
-        it 'calls handler without an alternative method' do
-          expect(Deprecations).to receive(:call).once.with(anything, nil, anything)
-        end
-        it 'calls handler without a comment' do
-          expect(Deprecations).to receive(:call).once.with(anything, anything, nil)
-        end
-      end
-
-    end
-
-    context 'when a class is anonymous defined' do
-      module Samples
-        AnonymousDefined = Class.new(::BasicObject) do
-          def clean; end
-          def clear; end
-          deprecated :clean, :clear
-
-          def self.create; end
-          def self.make; end
-          deprecated :create, :make
-        end
-      end
-
-      it 'uses correct decorated instance method names' do
-        expect(Deprecations).to receive(:call).once.with(
-          'Samples::AnonymousDefined#clean',
-          'Samples::AnonymousDefined#clear',
-          nil
-        )
-        Samples::AnonymousDefined.new.clean
-      end
-
-      it 'uses correct decorated singleton method names' do
-        expect(Deprecations).to receive(:call).once.with(
-          'Samples::AnonymousDefined.create',
-          'Samples::AnonymousDefined.make',
-          nil
-        )
-        Samples::AnonymousDefined.create
-      end
-    end
-
-    context 'when a sub-class is used' do
-      module Samples
-        class Parent < ::BasicObject
-          def clean; end
-          def clear; end
-          deprecated :clean, :clear
-        end
-
-        class Child < Parent; end
-      end
-
-      it 'uses correct decorated method names' do
-        expect(Deprecations).to receive(:call).once.with(
-          'Samples::Parent#clean',
-          'Samples::Parent#clear',
-          nil
-        )
-        Samples::Child.new.clean
-      end
-    end
-
-  end
-end

data/spec/spec_helper.rb

@@ -1,8 +0,0 @@
-RSpec.configure do |config|
-  config.raise_errors_for_deprecations!
-  config.disable_monkey_patching!
-  config.expose_dsl_globally = false
-  config.expect_with(:rspec){ |c| c.syntax = :expect }
-  config.mock_with(:rspec){ |c| c.syntax = :expect }
-end
-require 'deprecations'