stable 1.1.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6de202dcc5cfca5f9d9b7799c85f919dc55735f85a06e8b1f2f674eb71240aa1
-  data.tar.gz: b7edd805344ecd2eead6e6cbef78abacdde918eef4c9219a252f24d0aa76f9b8
+  metadata.gz: 632d329e437a0d82fed98a7fd06f9f93c160363e961ea2c835bcc40cc1330066
+  data.tar.gz: e301162819f6e056594cc07c600c4c678d91143e371b848367be9e9abaaceaca
 SHA512:
-  metadata.gz: 74f14d4cb35e05c31f7bbc569b6da703a54f59a3cd2f2edc3c630ef7e536ccdad9b60d069f43be2184645744e72c28d5b0aaf3fcd3638b5b1b9a039fd10f08f1
-  data.tar.gz: 95bba0dd950234f2f1115b25cfd0197b0bec71474930d0302d113a7e2113d260c09578e1d66f2c7b59e5f6db51bd3f6b2bd48bffcb98b60d16829a0912a63e1f
+  metadata.gz: '036778caa60876817ab53b71c2e5c2fbedd4105e9084c1bc6a45b6c688a6172f60a0b3434cc732806426131259848ed345de71d519011263692a907282f9a02a'
+  data.tar.gz: f427b87ee21f105729862a77e51d06814c90a931f18ced149a6b22cfff42cce643997252e0fdc42f00b9ec6a1db7e478c635db9f45bb7b49076b77443c650804

data/lib/stable/spec.rb

@@ -1,20 +1,83 @@
 # lib/stable/spec.rb
 require 'json'
+require 'securerandom'
+require 'digest'
 
 module Stable
   # a spec is a recording of a single method call, including the inputs and
   # outputs. it's a self-contained, serializable representation of a method's
   # behavior at a specific point in time.
   class Spec
-    attr_reader :class_name, :method_name, :args, :result, :error, :timestamp
+    attr_reader :class_name, :method_name, :args, :result, :error, :timestamp, :actual_result, :actual_error, :status, :uuid, :signature
 
-    def initialize(class_name:, method_name:, args:, result: nil, error: nil, timestamp: Time.now.iso8601)
+    def initialize(class_name:, method_name:, args:, result: nil, error: nil, timestamp: Time.now.iso8601, uuid: SecureRandom.uuid)
       @class_name = class_name
       @method_name = method_name
       @args = args
       @result = result
       @error = error
       @timestamp = timestamp
+      @status = :pending
+      @uuid = uuid
+      @signature = Digest::SHA256.hexdigest("#{class_name}##{method_name}:#{args.to_json}")
+    end
+
+    def run!
+      klass = Object.const_get(class_name)
+      instance = klass.new
+
+      begin
+        @actual_result = instance.public_send(method_name, *args)
+        if error
+          @status = :failed
+        elsif actual_result == result
+          @status = :passed
+        else
+          @status = :failed
+        end
+      rescue => e
+        @actual_error = e
+        if error && e.class.name == error["class"]
+          @status = :passed_with_error
+        else
+          @status = :failed
+        end
+      end
+      self
+    end
+
+    def to_s
+      desc = "#{uuid}/#{signature}"
+      call = "#{class_name}##{method_name}(#{args.join(', ')})"
+
+      case status
+      when :passed
+        "#{desc} P #{call}"
+      when :passed_with_error
+        "#{desc} P (error) #{call}"
+      when :failed
+        lines = ["#{desc} F #{call}"]
+        if actual_error
+          if error
+            lines << "  Expected error: #{error['class']}"
+            lines << "  Actual error:   #{actual_error.class.name}: #{actual_error.message}"
+          else
+            lines << "  Expected result: #{result.inspect}"
+            lines << "  Actual error:    #{actual_error.class.name}: #{actual_error.message}"
+          end
+        else
+          if error
+            lines << "  Expected error: #{error['class']}"
+            lines << "  Actual result: #{actual_result.inspect}"
+          else
+            lines << "  Expected: #{result.inspect}"
+            lines << "  Actual:   #{actual_result.inspect}"
+          end
+        end
+        lines.join("\n")
+      else
+        "#{desc} ? #{call}"
+      end
     end
 
     def to_jsonl
@@ -24,7 +87,9 @@ module Stable
         args: args,
         result: result,
         error: error,
-        timestamp: timestamp
+        timestamp: timestamp,
+        uuid: uuid,
+        signature: signature
       }.compact.to_json
     end
 
@@ -36,7 +101,8 @@ module Stable
         args: data['args'],
         result: data['result'],
         error: data['error'],
-        timestamp: data['timestamp']
+        timestamp: data['timestamp'],
+        uuid: data['uuid']
       )
     end
   end

data/lib/stable.rb

@@ -37,7 +37,10 @@ module Stable
                 args: args,
                 result: result
               )
-              Stable.storage.puts(spec.to_jsonl)
+              unless Stable.send(:_spec_exists?, spec.signature)
+                Stable.storage.puts(spec.to_jsonl)
+                Stable.send(:_recorded_specs) << spec
+              end
               result
             rescue => e
               spec = Spec.new(
@@ -50,7 +53,10 @@ module Stable
                   backtrace: e.backtrace
                 }
               )
-              Stable.storage.puts(spec.to_jsonl)
+              unless Stable.send(:_spec_exists?, spec.signature)
+                Stable.storage.puts(spec.to_jsonl)
+                Stable.send(:_recorded_specs) << spec
+              end
               raise e
             end
           else
@@ -62,37 +68,20 @@ module Stable
     end
 
     def verify(record_hash)
-      spec = Spec.from_jsonl(record_hash.to_json)
-      klass = Object.const_get(spec.class_name)
-      instance = klass.new
-      description = "#{spec.class_name}##{spec.method_name}(#{spec.args.join(', ')})"
+      Spec.from_jsonl(record_hash.to_json).run!
+    end
 
-      begin
-        actual_result = instance.public_send(spec.method_name, *spec.args)
-        if spec.error
-          puts "FAILED: #{description}"
-          puts "  Expected error: #{spec.error['class']}"
-          puts "  Actual result: #{actual_result.inspect}"
-        elsif actual_result == spec.result
-          puts "PASSED: #{description}"
-        else
-          puts "FAILED: #{description}"
-          puts "  Expected: #{spec.result.inspect}"
-          puts "  Actual:   #{actual_result.inspect}"
-        end
-      rescue => e
-        if spec.error && e.class.name == spec.error["class"]
-          puts "PASSED: #{description} (error)"
-        elsif spec.error
-          puts "FAILED: #{description}"
-          puts "  Expected error: #{spec.error['class']}"
-          puts "  Actual error:   #{e.class.name}: #{e.message}"
-        else
-          puts "FAILED: #{description}"
-          puts "  Expected result: #{spec.result.inspect}"
-          puts "  Actual error:    #{e.class.name}: #{e.message}"
-        end
+    private
+
+    def _recorded_specs
+      @_recorded_specs ||= begin
+        return [] unless storage.respond_to?(:path) && File.exist?(storage.path)
+        File.foreach(storage.path).map { |line| Spec.from_jsonl(line) }
       end
     end
+
+    def _spec_exists?(signature)
+      _recorded_specs.any? { |spec| spec.signature == signature }
+    end
   end
 end

metadata

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