stable 1.20.0 → 1.20.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62b2d2b99ffdecc5553ba21e97ceadf89bd02563c930e79d765875b941bb1bfa
-  data.tar.gz: 89c84d540ca58cbec3935d3503d1f787677d1ebb506b6d909b00954ef88ad273
+  metadata.gz: 6e15bc20c1e3075bbcf961acf641350f5a86f28d344c4cdf10714d1f81e5cedb
+  data.tar.gz: 6c7e38b8cdb11d438057c612b7be9c7c0509ec627ff1702d5bb0a829cd4108f5
 SHA512:
-  metadata.gz: 937aef6d33cb4e758035bf02abcbb660258051a69dfdb72565c39bdc17e47974bcf0e008d812a63e05c11e3328229e70a9e956e9c789eb9e2e67f72cfc57511c
-  data.tar.gz: 1cff3aab0cdbe3c76f2e91e040f536ec4d5b73b61d3c6d39b956a5436f3d1d62a4290858fd8b8ae80da944914073135ba260cdcb3430bea2f28132d9f3c982fe
+  metadata.gz: 6f713c013b885c9297b227d46b8ee5195b4d38844f042a7c6df9706e605eaec397eceeac54cb40962df2f9cccef49ec617234f7abd42956026ecbd99e6d574bd
+  data.tar.gz: 59902723fb85cdde62aab42c994570d4f630f4373a046e90b6f955b2b6bbd296f091c63c06a0b0ce93671bfee8e1326addf6316858b48ac3a5ed850ba5fa1817

data/lib/stable/version.rb

@@ -1,3 +1,3 @@
 module Stable
-  VERSION = "1.20.0"
+  VERSION = "1.20.1"
 end

data/lib/stable.rb

@@ -58,6 +58,34 @@ module Stable
       @storage = nil
     end
 
+    # This is the core method for observing a method on a class or module. It
+    # uses a dynamic module and `prepend` to intercept method calls without
+    # altering the original method.
+    #
+    # The design handles several complexities:
+    #
+    # 1.  **Instance vs. Class Methods:** It accepts a `type` parameter to
+    #     differentiate between instance and class methods. For class methods,
+    #     it targets the singleton class (`klass.singleton_class`) to inject
+    #     the wrapper.
+    #
+    # 2.  **State Capture:** For instance methods, it captures the object's state
+    #     (instance variables) *before* the method is called. This `prior` state
+    #     is crucial for rehydrating the object during verification. State is not
+    #     captured for class methods to prevent infinite loops, as the recording
+    #     process itself may call class methods (e.g., `.name`).
+    #
+    # 3.  **Method Binding:** It correctly handles both bound (`Method`) and
+    #     unbound (`UnboundMethod`) method objects, ensuring `self` is correctly
+    #     bound when the original method is eventually called.
+    #
+    # 4.  **Fact Creation:** It gathers all relevant data—class name, method name,
+    #     arguments, prior state, and the result or error—into a `Fact` object.
+    #
+    # 5.  **Duplicate Prevention:** It generates a signature for each potential
+    #     fact and checks if a fact with the same signature has already been
+    #     recorded to prevent creating duplicate entries.
+    #
     def watch(klass, method_name, type: :instance)
       original_method = type == :instance ? klass.instance_method(method_name) : klass.method(method_name)
       target = type == :instance ? klass : klass.singleton_class
@@ -66,7 +94,7 @@ module Stable
         define_method(method_name) do |*args, **kwargs, &block|
           if Stable.enabled?
             begin
-              prior = Stable.send(:_capture_state, self)
+              prior = type == :instance ? Stable.send(:_capture_state, self) : nil
               result = original_method.is_a?(UnboundMethod) ? original_method.bind(self).call(*args, **kwargs, &block) : original_method.call(*args, **kwargs, &block)
               fact = Fact.new(
                 class_name: klass.name,
@@ -84,7 +112,7 @@ module Stable
               end
               result
             rescue => e
-              prior = Stable.send(:_capture_state, self)
+              prior = type == :instance ? Stable.send(:_capture_state, self) : nil
               fact = Fact.new(
                 class_name: klass.name,
                 method_name: method_name,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stable
 version: !ruby/object:Gem::Version
-  version: 1.20.0
+  version: 1.20.1
 platform: ruby
 authors:
 - Jeff Lunt