deprecate_soft 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b9799b61944284b4206b894196574252ccbcf7e550b127d7f45dfe524a943a5
-  data.tar.gz: 1474ec114cd60edcd85a7c975efb69121654f19ea0659ca4b13f577ca9370520
+  metadata.gz: 71f04af257e3e75e4c00ab45333c7e800a440f29f7677361bb6057d300eb6553
+  data.tar.gz: 62e5028bb462ac1cfec9d91a462baaaca81ba0f9211392c387cbff926aaf5a06
 SHA512:
-  metadata.gz: fd8cd841c2c67e77b3b7aed65e4fe0405f19d296c727c051346ba139662c395c3542e2848ee5d9c09146653bd6bdc5fdfa3756fcb57f95412d29a355d729841f
-  data.tar.gz: 8662fc4dec07bfc90b334d3aa5127b5c9042af70168d3013e03045f35d19beec572ffb5f16dfc386e169e48e590c83c600c9c7d823b724a5ee48615a7045f5b7
+  metadata.gz: 93a50dfb57c19b479a103192f8e86f2bd3abed9bf1400db03e6ad4d1f3aba1eddd67eff0226a101b8c3d3813d69839e7ac505a8feb38252a521d1c9038b9a3aa
+  data.tar.gz: 7ffb74d9dfdf8d2051d20a7fa1c8efca196248bd2c8358e8077534f7900bea851ef30868c6a5cb3ed267b3b49ed2ebecb9fea166394b0280c5ebe284036b00de

data/.rubocop.yml

@@ -1,11 +1,14 @@
 AllCops:
   TargetRubyVersion: 2.5 # purposely an old Ruby version
 
-Style/StringLiterals:
-  EnforcedStyle: single_quotes
+Layout/LineLength:
+  Max: 180
 
-Style/StringLiteralsInInterpolation:
-  EnforcedStyle: single_quotes
+Lint/ConstantDefinitionInBlock:
+  Enabled: false
+
+Lint/UnusedBlockArgument:
+  Enabled: false
 
 Metrics/AbcSize:
   Enabled: false
@@ -22,9 +25,6 @@ Metrics/CyclomaticComplexity:
 Metrics/MethodLength:
   Enabled: false
 
-Lint/UnusedBlockArgument:
-  Enabled: false
-
 Naming/MethodParameterName:
   Enabled: false
 
@@ -34,8 +34,20 @@ Style/SafeNavigation:
 Style/Documentation:
   Enabled: false
 
+Style/IfUnlessModifier:
+  Enabled: false
+
 Style/RedundantSelf:
   Enabled: false
 
 Style/SingleLineMethods:
   Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: single_quotes
+
+Style/TrivialAccessors:
+  Enabled: false

data/CHANGELOG.md

@@ -1,17 +1,38 @@
-## DepracateSoft Change Log
+
+## 📝 DepracateSoft Change Log
+
+## [1.2.0] - 2025-04-05
+### ✨ Added Support
+ - improving handling of class methods
+ - added deprecate_class_soft for class methods. Fixed [Issue #1](https://github.com/tilo/deprecate_soft/issues/1)
+ - support to define the method after the declaration
+### 🛠️ Internals
+ - stream-lined include DeprecateSoft
+### 📐 Deliberate Limitations
+ - Class methods need to be defined via `def self.method`, not in `class << self` blocks.
+   Simply move the to-be-deprecated method out of the `self << class` and declare it via `self.method_name`.
+   This also makes the to be deleted method stand out more.
 
 ## [1.1.0] - 2025-03-29
- - simplify initialization
- - added tests for corner cases:
-   - deprecate_soft called before method definition
-   - deprecate_soft called twice
-   - deprecate_soft for private methods
-   - before_hook or after_hook raise
- - prevent double-wrapping methods
- - ensure that methods run undisturbed, even if the before_hook or after_hook raise an exception
+### ✨ Added Support
+ - Errors in `before_hook` / `after_hook` do not prevent method execution.
+ - `Kernel.warn` is used to log hook exceptions instead of raising.
+ - No impact if `deprecate_soft` is called twice for the same method
+### 🧪 Test Coverage
+ - deprecate_soft called before method definition
+ - deprecate_soft called twice
+ - deprecate_soft for private instance and class methods
+ - errors in `before_hook` or `after_hook` 
+### 🛠️ Internals
+ -  simplified initialization
 
 ## [1.0.0] - 2025-03-24
- - Initial release
+- Initial release of `deprecate_soft`.
+- Support for soft-deprecating instance and class methods, as well as private methods.
+- Added `before_hook` and `after_hook` for custom instrumentation or logging.
+- Safe wrapping of methods with optional message.
+- Skips wrapping if method is not yet defined.
+- Supports defining deprecations inline with method definitions.
 
 ## [0.0.1] - 2025-03-22
  - pre-release

data/README.md

@@ -1,6 +1,10 @@
 
 # DeprecateSoft
 
+[![Gem Version](https://badge.fury.io/rb/deprecate_soft.svg)](https://badge.fury.io/rb/deprecate_soft)
+[![CI](https://github.com/tilo/deprecate_soft/actions/workflows/main.yml/badge.svg)](https://github.com/tilo/deprecate_soft/actions/workflows/main.yml)
+[![codecov](https://codecov.io/gh/tilo/deprecate_soft/branch/main/graph/badge.svg)](https://codecov.io/gh/tilo/deprecate_soft)
+
 DeprecateSoft is a lightweight and flexible Ruby gem designed to help you gracefully and safely delete methods.
 
 It was inspired by the need to track deprecated method usage in large codebases before safely removing old code — with zero disruption and flexible metrics support.
@@ -28,6 +32,7 @@ This mechanism has been **proven in large-scale production systems** to safely c
 ## 📖 Blog Posts
 - [Safely Delete Old Ruby Code with deprecate_soft](https://medium.com/@tilo-sloboda/safely-delete-old-code-with-deprecate-soft-89e819b41d52)
 ---
+## 📝 [Change Log](https://github.com/tilo/deprecate_soft/blob/main/CHANGELOG.md)
 
 ## 🚀 Installation
 
@@ -53,6 +58,8 @@ Declare `deprecate_soft` **after** the method definition.
 
 ### For Instance Methods:
 
+use `deprecate_soft`
+
 ```ruby
 class MyService
   include DeprecateSoft
@@ -69,15 +76,17 @@ MyService.new.deprecated_method(1, 2) # will exercise the tracking hooks
 
 ### For Class Methods:
 
+use `deprecate_class_soft`
+
 ```ruby
 class MyService
-  extend DeprecateSoft
+  include DeprecateSoft
 
   def self.deprecated_method(a, b)
     puts "doing something with #{a} and #{b}"
   end
 
-  deprecate_soft :deprecated_method, "will be removed"
+  deprecate_class_soft :deprecated_method, "will be removed" # ⚠️
 end
 
 MyService.deprecated_method(1, 2) # will exercise the tracking hooks
@@ -325,6 +334,9 @@ end
 - Make sure hooks do not raise or interfere with production behavior.
 - Only use non-blocking, low-latency methods for tracking!
 - Currently assumes Ruby 2.5+ (for `&.` and keyword args support).
+- Class methods need to be defined via `def self.method`, not in `class << self` blocks.
+  Simply move the to-be-deprecated method out of the `self << class` and declare it via `self.method_name`.
+  This also makes the to be deleted method stand out more.
 
 ---
 

data/lib/deprecate_soft/global_monkey_patch.rb

@@ -3,17 +3,13 @@
 module DeprecateSoft
   module GlobalMonkeyPatch
     def deprecate_soft(method_name, message)
-      if self.singleton_class.method_defined?(method_name) || self.singleton_class.private_method_defined?(method_name)
-        # Class method
-        DeprecateSoft::MethodWrapper.wrap_method(self, method_name, message, is_class_method: true)
-      elsif self.instance_methods.include?(method_name) || self.private_instance_methods.include?(method_name)
-        # Instance method
-        DeprecateSoft::MethodWrapper.wrap_method(self, method_name, message, is_class_method: false)
-      else # rubocop:disable Style/EmptyElse
-        #  protect against declaring deprecate_soft before method is defined
-        #
-        # Do nothing — fail-safe in production
-      end
+      extend DeprecateSoft::ClassMethods unless is_a?(DeprecateSoft::ClassMethods)
+      deprecate_soft(method_name, message)
+    end
+
+    def deprecate_class_soft(method_name, message = nil)
+      extend DeprecateSoft::ClassMethods unless is_a?(DeprecateSoft::ClassMethods)
+      deprecate_class_soft(method_name, message)
     end
   end
 end

data/lib/deprecate_soft/method_wrapper.rb

@@ -14,7 +14,8 @@ module DeprecateSoft
         target.define_method(hidden_method_name, original_method)
 
         target.define_method(method_name) do |*args, &block|
-          full_name = "#{self.name}.#{method_name}"
+          klass_name = self.class.name || self.class.to_s
+          full_name = "#{klass_name}.#{method_name}"
 
           begin
             DeprecateSoft.before_hook&.call(full_name, message, args: args)
@@ -39,7 +40,8 @@ module DeprecateSoft
         context.define_method(hidden_method_name, original_method)
 
         context.define_method(method_name) do |*args, &block|
-          full_name = "#{self.class}##{method_name}"
+          klass_name = self.class.name || self.to_s
+          full_name = "#{klass_name}.#{method_name}"
 
           begin
             DeprecateSoft.before_hook&.call(full_name, message, args: args)

data/lib/deprecate_soft/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DeprecateSoft
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

data/lib/deprecate_soft.rb

@@ -1,24 +1,11 @@
 # frozen_string_literal: true
 
-require_relative 'deprecate_soft/version'
-
-require_relative 'deprecate_soft/method_wrapper'
+# require all files under lib/deprecate_soft
+Dir[File.join(__dir__, 'deprecate_soft', '*.rb')].sort.each do |file|
+  require file
+end
 
 module DeprecateSoft
-  def configure_base(base)
-    base.extend(ClassMethods)
-    base.extend(InstanceMethods)
-  end
-  module_function :configure_base
-
-  def included(base)
-    configure_base(base)
-  end
-
-  def extended(base)
-    configure_base(base)
-  end
-
   class << self
     attr_accessor :before_hook, :after_hook
     attr_writer :prefix, :suffix
@@ -34,23 +21,58 @@ module DeprecateSoft
     def configure
       yield self
     end
-  end
 
-  module InstanceMethods
-    def deprecate_soft(method_name, message)
-      #  protect against declaring deprecate_soft before method is defined
-      return unless method_defined?(method_name) || private_method_defined?(method_name)
+    def prefixed_name(method_name)
+      "#{prefix}#{method_name}_#{suffix}".to_sym
+    end
+
+    def included(base)
+      base.extend(ClassMethods)
 
-      DeprecateSoft::MethodWrapper.wrap_method(self, method_name, message, is_class_method: false)
+      base.define_singleton_method(:method_added) do |method_name|
+        pending = base.instance_variable_get(:@__pending_soft_wraps)
+        if pending&.key?(method_name)
+          DeprecateSoft::MethodWrapper.wrap_method(base, method_name, pending.delete(method_name), is_class_method: false)
+        end
+        super(method_name) if defined?(super)
+      end
+
+      base.singleton_class.define_method(:singleton_method_added) do |method_name|
+        pending = instance_variable_get(:@_pending_soft_wraps)
+        if pending&.key?(method_name)
+          DeprecateSoft::MethodWrapper.wrap_method(base, method_name, pending.delete(method_name), is_class_method: true)
+        end
+        super(method_name) if defined?(super)
+      end
     end
   end
 
   module ClassMethods
-    def deprecate_soft(method_name, message)
-      #  protect against declaring deprecate_soft before method is defined
-      return unless singleton_class.method_defined?(method_name) || singleton_class.private_method_defined?(method_name)
+    def deprecate_soft(method_name, message = nil)
+      hidden = DeprecateSoft.prefixed_name(method_name)
+
+      if method_defined?(method_name) || private_method_defined?(method_name)
+        return if method_defined?(hidden) || private_method_defined?(hidden)
+
+        DeprecateSoft::MethodWrapper.wrap_method(self, method_name, message, is_class_method: false)
+      else
+        @__pending_soft_wraps ||= {}
+        @__pending_soft_wraps[method_name] = message
+      end
+    end
+
+    def deprecate_class_soft(method_name, message = nil)
+      hidden = DeprecateSoft.prefixed_name(method_name)
+      target = singleton_class
+
+      if target.method_defined?(method_name) || target.private_method_defined?(method_name)
+        return if target.method_defined?(hidden) || target.private_method_defined?(hidden)
 
-      DeprecateSoft::MethodWrapper.wrap_method(self, method_name, message, is_class_method: true)
+        DeprecateSoft::MethodWrapper.wrap_method(self, method_name, message, is_class_method: true)
+      else
+        @_pending_soft_wraps ||= {}
+        @_pending_soft_wraps[method_name] = message
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deprecate_soft
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Tilo Sloboda
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-29 00:00:00.000000000 Z
+date: 2025-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dogstatsd-ruby
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |
   DeprecateSoft is a lightweight Ruby gem that lets you gracefully deprecate methods
   in your codebase without breaking functionality. It wraps existing instance or