stable 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5d2929b75b7c0dbf556f482bd3b4eeb852cfebff63fd26e4debd66c1c6980e3
-  data.tar.gz: fad79c07ad6849822bf0d73ff71ab104d4d4876efa6d6f146239ec7faa31a69b
+  metadata.gz: e6eaeeb526166f78e5d039f97e943f3dae2541b869728ce3888778e0d72be922
+  data.tar.gz: b7edd805344ecd2eead6e6cbef78abacdde918eef4c9219a252f24d0aa76f9b8
 SHA512:
-  metadata.gz: c2de06eb210c9f700779a3d07b131695749e7f6ad1e8d3d70d5d701bf7204b2a6834d3c0411d86be0c9bb7fbf81aab3a8d56603e259c8cca5cb1fd3ed9c72883
-  data.tar.gz: 38511e64502515d0b24578c4d056a289ce3f65837a3e54b249b04b77714148a15e668f033b1746e1958206c51b4ee13995dde283d88642995916dc10802f0718
+  metadata.gz: 0c0197b7316ed87668a74ce881317454924cfee6467976fd662901dea25daf8ee338cfe455c0a8133c96ab2d8639d2109223d8de20fc699b4b09c6e8e45e65df
+  data.tar.gz: 95bba0dd950234f2f1115b25cfd0197b0bec71474930d0302d113a7e2113d260c09578e1d66f2c7b59e5f6db51bd3f6b2bd48bffcb98b60d16829a0912a63e1f

data/lib/stable/spec.rb

@@ -2,6 +2,9 @@
 require 'json'
 
 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
 

data/lib/stable.rb

@@ -1,30 +1,5 @@
-# stable is a library for recording and replaying method calls. the idea of
-# this is to reduce the amount of manual unit tests you need to write, while
-# keeping the stability/notification system that unit tests provide.
-#
-# usage:
-#
-#   require 'stable'
-#
-#   # stable uses an IO-like object to write the captured inputs/outputs.
-#   # if you don't set this, the default it to print the interaction records to
-#   # $stdout, so you could also pipe the result to another place.
-#   Stable.storage = File.open('captured_calls.jsonl', 'a')
-#
-#   # wrap a method on a given class
-#   Stable.capture(MyClass, :my_method)
-#
-#   # enable runtime input/output capture
-#   Stable.enable!
-#
-#   MyClass.my_metehod  # this will be captures by stable
-#
-#   # disable input/output capture
-#   Stable.disable!
-#
-#   # replay captured calls, which gives you a unit test-list pass/fail
-#   record = JSON.parse(File.read('captured_calls.jsonl').lines.first)
-#   Stable.replay(record)
+# `stable` is a library for recording and replaying method calls.
+# See README.md for detailed usage instructions.
 require_relative 'stable/spec'
 
 module Stable
@@ -49,7 +24,7 @@ module Stable
       @storage || raise("Stable.storage must be set to an IO-like object")
     end
 
-    def capture(klass, method_name)
+    def record(klass, method_name)
       original_method = klass.instance_method(method_name)
       wrapper_module = Module.new do
         define_method(method_name) do |*args, &block|
@@ -86,7 +61,7 @@ module Stable
       klass.prepend(wrapper_module)
     end
 
-    def replay(record_hash)
+    def verify(record_hash)
       spec = Spec.from_jsonl(record_hash.to_json)
       klass = Object.const_get(spec.class_name)
       instance = klass.new
@@ -121,4 +96,3 @@ module Stable
     end
   end
 end
-

metadata

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