deprecations 2.2.2 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 976d65184fd1442180e364ecd885aabf9202877f1bb7d11c1315eed9fe30b5ee
-  data.tar.gz: bf4ad1bc538b49878a6268321883d1d89a3cc3fe0627ef8c2d37200972c22ad2
+  metadata.gz: 9973f05a62830c682760b9becfce855fa3e25d2bfdb40a0516846b5e3e27297f
+  data.tar.gz: 77b6ca73354da20235e652895d30513dc4f3ab47dd3bd73658eeb250d2cac52c
 SHA512:
-  metadata.gz: 29383bc82baad099e0597f6efb0c4a0e2d4bb7f87e2235c19e1ebd58e0611c287aa7b1f478c1e75fc942f43bd2078cfb09f80f90df72ab4d184012e2dee8a51d
-  data.tar.gz: 0636b27fc0c83e46df73364b669b6c59f0c2e844e424807a990ee45d8bf1957b93db289d744d63013b099317f8f23618aa92b979c468a200712608956bd220a7
+  metadata.gz: 190ddcd1b3f3f750d83579d369f02b12fc03f6fdd4a21a05b5d58a3d830d72b49c696bebbd8e27e431458a0224162a00bc1fa79f59851b608b5f9547b7e111ca
+  data.tar.gz: 14e17835fd8c727d3a30db5f22673918373969a4b687c494e67abe6b83e9f8e72ee0c6dcab98b63bca8e08926506e98c076e89a59acd9ae457787b42a01cd91b

data/README.md

@@ -14,13 +14,13 @@ gem 'deprecations'
 
 and install it by running Bundler:
 
-```bash
-$ bundle
+```shell
+$ bundle add deprecations
 ```
 
 To install the gem globally use:
 
-```bash
+```shell
 $ gem install deprecations
 ```
 
@@ -36,7 +36,6 @@ you can specify which methods and classes are deprecated. To mark a method as de
 
 ```ruby
 class MySample
-
   def clear
     # something here
   end
@@ -46,7 +45,6 @@ class MySample
   end
 
   deprecated :clean, :clear, 'next version'
-
 end
 ```
 
@@ -79,9 +77,10 @@ There are 3 pre-defined behaviors:
 Besides this you can implement your own:
 
 ```ruby
-Deprecations.behavior = proc do |subject, _alternative, _outdated|
-  SuperLogger.warning "deprecated: #{subject}"
-end
+Deprecations.behavior =
+  proc do |subject, _alternative, _outdated|
+    SuperLogger.warning "deprecated: #{subject}"
+  end
 ```
 
 Any object responding to `#call` will be accepted as a valid handler.
@@ -89,9 +88,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.with_behavior(:silent) do
-  MyDeprecatedClass.new.do_some_magic
-end
+Deprecations.with_behavior(:silent) { MyDeprecatedClass.new.do_some_magic }
 ```
 
 Please have a look at the [specs](https://github.com/mblumtritt/deprecations/blob/master/spec/deprecations_spec.rb) for detailed information and more samples.

data/lib/deprecations/behavior.rb

@@ -14,12 +14,10 @@ module Deprecations
       behavior = as_behavior(behavior)
       raise(ArgumentError, 'block expected') unless block_given?
       current_behavior = @behavior
-      begin
-        @behavior = behavior
-        yield
-      ensure
-        @behavior = current_behavior
-      end
+      @behavior = behavior
+      yield
+    ensure
+      @behavior = current_behavior if current_behavior
     end
 
     alias set_behavior with_behavior
@@ -32,7 +30,7 @@ module Deprecations
         raise(
           ArgumentError,
           'invalid parameter - behavior has to be ' \
-            "#{valid_behaviors} or need to respond to `call`"
+            "#{valid_behaviors} or need to respond to `#call`"
         )
       end
     end
@@ -43,20 +41,26 @@ module Deprecations
 
     module Raise
       def self.call(subject, alternative, _outdated)
-        msg = "`#{subject}` is deprecated"
-        msg << " - use #{alternative} instead" if alternative
-        ex = Error.new(msg)
-        ex.set_backtrace(caller(3))
-        raise(ex)
+        raise(
+          Error
+            .new(
+              "`#{subject}` is deprecated#{
+                " - use #{alternative} instead" if alternative
+              }"
+            )
+            .tap { |error| error.set_backtrace(caller(3)) }
+        )
       end
     end
 
     module Warn
       def self.call(subject, alternative, outdated)
-        msg = "`#{subject}` is deprecated"
-        msg << (outdated ? " and will be outdated #{outdated}." : '.')
-        msg << " Please use `#{alternative}` instead." if alternative
-        ::Kernel.warn(msg, uplevel: 3)
+        ::Kernel.warn(
+          "`#{subject}` is deprecated#{
+            outdated ? " and will be outdated #{outdated}." : '.'
+          }#{" Please use `#{alternative}` instead." if alternative}",
+          uplevel: 3
+        )
       end
     end
 

data/lib/deprecations/extension.rb

@@ -1,93 +1,75 @@
 # frozen_string_literal: true
 
 module Deprecations
-  class << self
-    private
-
-    def infect(mod)
-      mod.extend(ClassMethods)
-      mod.send(:include, InstanceMethods)
-    end
-
-    module Helper
-      private
+  private_class_method def self.infect(mod)
+    mod.extend(ClassMethods)
+    mod.__send__(:include, InstanceMethods)
+  end
 
-      def __method(method_name)
-        begin
-          instance_method(method_name)
-        rescue StandardError
-          nil
-        end
-      end
+  module ClassMethods
+    private
 
-      def __method_deprecated!(method, alternative, outdated)
-        defining_context = self
-        undef_method(method.name)
-        define_method(method.name) do |*a, &b|
-          decorated = Class === self ? "#{self}." : "#{defining_context}#"
-          alternative = "#{decorated}#{alternative.name}" if UnboundMethod ===
+    def deprecated(method_name, alternative = nil, outdated = nil)
+      alias_name = "__deprecated__singleton_method__#{method_name}__"
+      return if private_method_defined?(alias_name)
+      alias_method(alias_name, method_name)
+      private(alias_name)
+      alternative = instance_method(alternative) if alternative.is_a?(Symbol)
+      define_method(method_name) do |*args, **kw_args, &b|
+        Deprecations.call(
+          "#{self}.#{::Kernel.__method__}",
+          if alternative.is_a?(UnboundMethod)
+            "#{self}.#{alternative.name}"
+          else
             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}`"
-          )
-      end
-
-      def __method_alternative(alternative)
-        Symbol === alternative ? __method_checked(alternative) : alternative
+          end,
+          outdated
+        )
+        __send__(alias_name, *args, **kw_args, &b)
       end
     end
+  end
 
-    module ClassMethods
-      private
-
-      include Helper
+  module InstanceMethods
+    private
 
-      def deprecated(method_name, alternative = nil, outdated = nil)
-        __method_deprecated!(
-          __method_checked(method_name),
-          __method_alternative(alternative),
+    def deprecated(method_name, alternative = nil, outdated = nil)
+      alias_name = "__deprecated__instance_method__#{method_name}__"
+      return if private_method_defined?(alias_name)
+      alias_method(alias_name, method_name)
+      private(alias_name)
+      alternative = instance_method(alternative) if alternative.is_a?(Symbol)
+      define_method(method_name) do |*args, **kw_args, &b|
+        pref =
+          if defined?(self.class.name)
+            self.class.name
+          else
+            Kernel.instance_method(:class).bind(self).call
+          end
+        Deprecations.call(
+          "#{pref}##{::Kernel.__method__}",
+          if alternative.is_a?(UnboundMethod)
+            "#{pref}##{alternative.name}"
+          else
+            alternative
+          end,
           outdated
         )
+        __send__(alias_name, *args, **kw_args, &b)
       end
+    rescue NameError
+      raise if private_method_defined?(alias_name)
+      singleton_class.__send__(:deprecated, method_name, alternative, outdated)
     end
 
-    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
-            )
-          )
-        __method_deprecated!(m, __method_alternative(alternative), outdated)
-      end
-
-      def deprecated!(alternative = nil, outdated = nil)
-        m = method(:new)
-        define_singleton_method(:new) do |*a, &b|
-          Deprecations.call(self, alternative, outdated)
-          m.call(*a, &b)
-        end
+    def deprecated!(alternative = nil, outdated = nil)
+      org = method(:new)
+      define_singleton_method(:new) do |*args, **kw_args, &b|
+        Deprecations.call(name, alternative, outdated)
+        org.call(*args, **kw_args, &b)
       end
+    rescue NameError
+      nil
     end
   end
 

data/lib/deprecations/version.rb

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

data/lib/deprecations.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 module Deprecations
-  require_relative 'deprecations/version'
-  require_relative 'deprecations/extension'
   require_relative 'deprecations/behavior'
+  require_relative 'deprecations/extension'
+  require_relative 'deprecations/version'
 
   Error = Class.new(ScriptError)
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deprecations
 version: !ruby/object:Gem::Version
-  version: 2.2.2
+  version: 2.5.0
 platform: ruby
 authors:
 - Mike Blumtritt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-30 00:00:00.000000000 Z
+date: 2023-12-22 00:00:00.000000000 Z
 dependencies: []
 description: |
   This gem provides transparent declaration of deprecated methods and classes.
@@ -29,6 +29,7 @@ licenses: []
 metadata:
   source_code_uri: https://github.com/mblumtritt/deprecations
   bug_tracker_uri: https://github.com/mblumtritt/deprecations/issues
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -37,14 +38,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.1
 signing_key:
 specification_version: 4
 summary: Deprecation support for your project.