stable 1.19.1 → 1.20.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c37e32ad41c2706a5759ea8c71dbaa01fdbca65a68c21a0ba4f7854d6e31536
-  data.tar.gz: 3f0dc4afac0758033537dbe4b3c7d30900135cf559c89a6a43648c4f4007d79c
+  metadata.gz: 6e15bc20c1e3075bbcf961acf641350f5a86f28d344c4cdf10714d1f81e5cedb
+  data.tar.gz: 6c7e38b8cdb11d438057c612b7be9c7c0509ec627ff1702d5bb0a829cd4108f5
 SHA512:
-  metadata.gz: 3c7834e8ea59b1c8d9d5ef50cd0540d58fdf646009c8c5320b562637a95a032dbafe7b92e31adf0d61c1f87e253b09352eab3ac6bf2bfb6617860c36de334d96
-  data.tar.gz: 7fb53c7055b9d1a5fb285f94aa757c91009943d1875eb183bea7a228264fa17ad0cb0147419fa57af4282b00ddc320a14bccafdcff646c3576fc204003ffd5d2
+  metadata.gz: 6f713c013b885c9297b227d46b8ee5195b4d38844f042a7c6df9706e605eaec397eceeac54cb40962df2f9cccef49ec617234f7abd42956026ecbd99e6d574bd
+  data.tar.gz: 59902723fb85cdde62aab42c994570d4f630f4373a046e90b6f955b2b6bbd296f091c63c06a0b0ce93671bfee8e1326addf6316858b48ac3a5ed850ba5fa1817

data/lib/example/stateful_calculator.rb

@@ -0,0 +1,25 @@
+# lib/example/stateful_calculator.rb
+
+# this class demonstrates a stateful calculator where operations rely on the
+# value stored in the `@memory` instance variable.
+class StatefulCalculator
+  def initialize
+    @memory = 0
+  end
+
+  def add(number)
+    @memory += number
+  end
+
+  def subtract(number)
+    @memory -= number
+  end
+
+  def clear
+    @memory = 0
+  end
+
+  def memory
+    @memory
+  end
+end

data/lib/stable/fact.rb

@@ -8,9 +8,9 @@ module Stable
   # outputs. it's a self-contained, serializable representation of a method's
   # behavior at a specific point in time.
   class Fact
-    attr_reader :class_name, :method_name, :method_type, :args, :kwargs, :result, :error, :actual_result, :actual_error, :status, :uuid, :signature, :name, :source_file
+    attr_reader :class_name, :method_name, :method_type, :args, :kwargs, :result, :error, :actual_result, :actual_error, :status, :uuid, :signature, :name, :source_file, :prior
 
-    def initialize(class_name:, method_name:, args:, method_type: :instance, kwargs: {}, result: nil, error: nil, uuid: SecureRandom.uuid, name: nil, source_file: nil)
+    def initialize(class_name:, method_name:, args:, method_type: :instance, kwargs: {}, result: nil, error: nil, uuid: SecureRandom.uuid, name: nil, source_file: nil, prior: nil)
       @class_name = class_name
       @method_name = method_name
       @method_type = method_type
@@ -23,6 +23,7 @@ module Stable
       @signature = Digest::SHA256.hexdigest("#{class_name}##{method_name}:#{args.to_json}:#{kwargs.to_json}")
       @name = name || uuid.split('-').last
       @source_file = source_file
+      @prior = prior
     end
 
     def name=(new_name)
@@ -31,11 +32,16 @@ module Stable
     end
 
 
-    def run!
+    def verify!
       begin
         klass = Object.const_get(class_name)
         if method_type == :instance
           instance = klass.new
+          if prior
+            prior.each do |var, value|
+              instance.instance_variable_set(var, value)
+            end
+          end
           @actual_result = instance.public_send(method_name, *args, **kwargs)
         else
           @actual_result = klass.public_send(method_name, *args, **kwargs)
@@ -82,6 +88,7 @@ module Stable
         method_type: method_type,
         args: args,
         kwargs: kwargs,
+        prior: prior,
         result: result,
         error: error,
         uuid: uuid,
@@ -98,6 +105,7 @@ module Stable
         method_type: (data['method_type'] || :instance).to_sym,
         args: data['args'],
         kwargs: data['kwargs'],
+        prior: data['prior'],
         result: data['result'],
         error: data['error'],
         uuid: data['uuid'],
@@ -105,7 +113,5 @@ module Stable
         source_file: source_file
       )
     end
-
-
   end
 end

data/lib/stable/version.rb

@@ -1,3 +1,3 @@
 module Stable
-  VERSION = "1.19.1"
+  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,6 +94,7 @@ module Stable
         define_method(method_name) do |*args, **kwargs, &block|
           if Stable.enabled?
             begin
+              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,
@@ -73,6 +102,7 @@ module Stable
                 method_type: type,
                 args: args,
                 kwargs: kwargs,
+                prior: prior,
                 result: result
               )
               unless Stable.send(:_fact_exists?, fact.signature)
@@ -82,12 +112,14 @@ module Stable
               end
               result
             rescue => e
+              prior = type == :instance ? Stable.send(:_capture_state, self) : nil
               fact = Fact.new(
                 class_name: klass.name,
                 method_name: method_name,
                 method_type: type,
                 args: args,
                 kwargs: kwargs,
+                prior: prior,
                 error: {
                   class: e.class.name,
                   message: e.message,
@@ -122,7 +154,7 @@ module Stable
     end
 
     def verify(record_hash)
-      Fact.from_jsonl(record_hash.to_json).run!
+      Fact.from_jsonl(record_hash.to_json).verify!
     end
 
     private
@@ -140,5 +172,11 @@ module Stable
     def _fact_exists?(signature)
       _recorded_facts.any? { |fact| fact.signature == signature }
     end
+
+    def _capture_state(obj)
+      obj.instance_variables.each_with_object({}) do |var, hash|
+        hash[var] = obj.instance_variable_get(var)
+      end
+    end
   end
 end

data/lib/tasks/stable.rake

@@ -8,6 +8,7 @@ namespace :stable do
     require_relative '../../lib/example/calculator'
     require_relative '../../lib/example/kw_calculator'
     require_relative '../../lib/example/class_methods'
+    require_relative '../../lib/example/stateful_calculator'
 
     fact_path = File.expand_path('../../../facts/calculator.fact.example', __FILE__)
     Stable.configure do |config|
@@ -23,7 +24,7 @@ namespace :stable do
     puts formatter.header
 
     _filter_facts(facts, args[:filter].to_s.strip.downcase).each do |fact|
-      fact.run!
+      fact.verify!
       puts formatter.to_s(fact)
     end
 
@@ -43,7 +44,7 @@ namespace :stable do
       puts formatter.header
 
       facts.each do |fact|
-        fact.run!
+        fact.verify!
         puts formatter.to_s(fact)
       end
 
@@ -96,7 +97,7 @@ namespace :stable do
 
       updated_facts = []
       _filter_facts(facts, _clean_filter(args[:filter])).each do |fact|
-        fact.run!
+        fact.verify!
         if fact.status == :failed
           puts formatter.to_s(fact)
           print "  update this fact? (y/n): "

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stable
 version: !ruby/object:Gem::Version
-  version: 1.19.1
+  version: 1.20.1
 platform: ruby
 authors:
 - Jeff Lunt
@@ -32,6 +32,7 @@ files:
 - lib/example/calculator.rb
 - lib/example/class_methods.rb
 - lib/example/kw_calculator.rb
+- lib/example/stateful_calculator.rb
 - lib/stable.rb
 - lib/stable/configuration.rb
 - lib/stable/fact.rb