stable 1.0.0

checksums.yaml

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

data/lib/stable/spec.rb

@@ -0,0 +1,40 @@
+# lib/stable/spec.rb
+require 'json'
+
+module Stable
+  class Spec
+    attr_reader :class_name, :method_name, :args, :result, :error, :timestamp
+
+    def initialize(class_name:, method_name:, args:, result: nil, error: nil, timestamp: Time.now.iso8601)
+      @class_name = class_name
+      @method_name = method_name
+      @args = args
+      @result = result
+      @error = error
+      @timestamp = timestamp
+    end
+
+    def to_jsonl
+      {
+        class: class_name,
+        method: method_name,
+        args: args,
+        result: result,
+        error: error,
+        timestamp: timestamp
+      }.compact.to_json
+    end
+
+    def self.from_jsonl(jsonl_string)
+      data = JSON.parse(jsonl_string)
+      new(
+        class_name: data['class'],
+        method_name: data['method'],
+        args: data['args'],
+        result: data['result'],
+        error: data['error'],
+        timestamp: data['timestamp']
+      )
+    end
+  end
+end

data/lib/stable.rb

@@ -0,0 +1,124 @@
+# 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)
+require_relative 'stable/spec'
+
+module Stable
+  class << self
+    def enable!
+      Thread.current[:stable_enabled] = true
+    end
+
+    def disable!
+      Thread.current[:stable_enabled] = false
+    end
+
+    def enabled?
+      Thread.current[:stable_enabled] || false
+    end
+
+    def storage=(io)
+      @storage = io
+    end
+
+    def storage
+      @storage || raise("Stable.storage must be set to an IO-like object")
+    end
+
+    def capture(klass, method_name)
+      original_method = klass.instance_method(method_name)
+      wrapper_module = Module.new do
+        define_method(method_name) do |*args, &block|
+          if Stable.enabled?
+            begin
+              result = original_method.bind(self).call(*args, &block)
+              spec = Spec.new(
+                class_name: klass.name,
+                method_name: method_name,
+                args: args,
+                result: result
+              )
+              Stable.storage.puts(spec.to_jsonl)
+              result
+            rescue => e
+              spec = Spec.new(
+                class_name: klass.name,
+                method_name: method_name,
+                args: args,
+                error: {
+                  class: e.class.name,
+                  message: e.message,
+                  backtrace: e.backtrace
+                }
+              )
+              Stable.storage.puts(spec.to_jsonl)
+              raise e
+            end
+          else
+            original_method.bind(self).call(*args, &block)
+          end
+        end
+      end
+      klass.prepend(wrapper_module)
+    end
+
+    def replay(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(', ')})"
+
+      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
+      end
+    end
+  end
+end
+

metadata

@@ -0,0 +1,43 @@
+--- !ruby/object:Gem::Specification
+name: stable
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jeff Lunt
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: an automatic unit test system that captures your usage and records it
+  for future playback
+email: jefflunt@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/stable.rb
+- lib/stable/spec.rb
+homepage: https://github.com/jefflunt/stable
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: an automatic unit test system that captures your usage and records it for
+  future playback
+test_files: []