stable 1.3.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbfe47a4e34cd7aa98e7c0cdfa165adcb2612bb7d3e416ff30395239215df9df
-  data.tar.gz: 40ea2eef27e201637b20bd88d722d1bf01cad66fd84faed5ca6b9573c2124074
+  metadata.gz: 449e9c176cb2085bca88f353966805090e49d1cb8292966069fc4ca32bb18fde
+  data.tar.gz: 48980832cbe61ac2dc13474eae12bd70e4bd5c6e42d015eac8ae28245b34ccd4
 SHA512:
-  metadata.gz: a33475e16728dbb9bf94f6de1807c7157d4b8edabf4a6f8bb67dac10c800a9b092a36ff66a26e8a50da6399e1c83c571edcfc843b613a34e1e898345b7797e2e
-  data.tar.gz: 7ed53b7619f0b5644f16f215cc6ed1a3e9ecb949741cb953edca5447784e2cbc71661890217e32674182a1614af4d5e33fd9ee845ada6e1b61fc934528625a46
+  metadata.gz: dac85ffc0a8efbd42ea82b62f8ba1796e810c60f7536060ced002c0f6c184d308374b012d8e4d2b30ae3706522a1b4642919fa8447c0b3fe4f3cb2c4516ef483
+  data.tar.gz: 491c78e463ac466fb08cf60c0437f4a99b6df645aa7c2537394a4e470d3707d06244a86154eaf7f94726ee5af2f3747bbbb98c8c7e5eae2bd3f67e04580867d9

data/lib/stable/configuration.rb

@@ -0,0 +1,11 @@
+# lib/stable/configuration.rb
+module Stable
+  class Configuration
+    attr_accessor :storage_path, :enabled
+
+    def initialize
+      @storage_path = nil
+      @enabled = false
+    end
+  end
+end

data/lib/stable.rb

@@ -1,9 +1,18 @@
 # `stable` is a library for recording and replaying method calls.
 # See README.md for detailed usage instructions.
 require_relative 'stable/spec'
+require_relative 'stable/configuration'
 
 module Stable
   class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
     def enable!
       Thread.current[:stable_enabled] = true
     end
@@ -13,7 +22,7 @@ module Stable
     end
 
     def enabled?
-      Thread.current[:stable_enabled] || false
+      Thread.current[:stable_enabled] || configuration.enabled || false
     end
 
     def storage=(io)
@@ -21,10 +30,29 @@ module Stable
     end
 
     def storage
-      @storage || raise("Stable.storage must be set to an IO-like object")
+      @storage ||= (configuration.storage_path && File.open(configuration.storage_path, 'a+')) || raise("Stable.storage must be set to an IO-like object")
+    end
+
+    # this method is a block-based way to enable and disable recording of
+    # specs. It ensures that recording is turned on for the duration of the
+    # block and is automatically turned off afterward, even if an error occurs.
+    #
+    # example:
+    #
+    #   Stable.recording do
+    #     # code in here will be recorded
+    #   end
+    #
+    def recording
+      enable!
+      yield if block_given?
+    ensure
+      disable!
+      storage.close if storage.respond_to?(:close)
+      @storage = nil
     end
 
-    def record(klass, method_name)
+    def watch(klass, method_name)
       original_method = klass.instance_method(method_name)
       wrapper_module = Module.new do
         define_method(method_name) do |*args, &block|
@@ -39,6 +67,7 @@ module Stable
               )
               unless Stable.send(:_spec_exists?, spec.signature)
                 Stable.storage.puts(spec.to_jsonl)
+                Stable.storage.flush
                 Stable.send(:_recorded_specs) << spec
               end
               result
@@ -55,6 +84,7 @@ module Stable
               )
               unless Stable.send(:_spec_exists?, spec.signature)
                 Stable.storage.puts(spec.to_jsonl)
+                Stable.storage.flush
                 Stable.send(:_recorded_specs) << spec
               end
               raise e
@@ -76,7 +106,10 @@ module Stable
     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) }
+        storage.rewind
+        specs = storage.each_line.map { |line| Spec.from_jsonl(line) }
+        storage.seek(0, IO::SEEK_END)
+        specs
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stable
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.5.0
 platform: ruby
 authors:
 - Jeff Lunt
@@ -17,6 +17,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/stable.rb
+- lib/stable/configuration.rb
 - lib/stable/spec.rb
 homepage: https://github.com/jefflunt/stable
 licenses: