backspin 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9c7a5cfbb0da377abb251f0f53d3bef24f131e72664fde1de6372f02024a506
-  data.tar.gz: 3835b7201b3d9ca7d4b399b7f7e58fdfa8e81838e22a45b1f4d7225da2fca09b
+  metadata.gz: e49507f2d196ebd4d7b4d39a6013d840224a357272fb5ba4880702e26d28c8d9
+  data.tar.gz: cfee20f6ff8b65c622bfc9482d85e49c78f78e1e9a2c91b5f09f71e2b1d61663
 SHA512:
-  metadata.gz: e533519b22a5e4a83a3511eb3ffbfd0429432b75179988435806d006ff57aa7a91e7c3f73c3bb6d1fe2b587f90bef97febdc5952a82f69e46c1b6f7bc26f6087
-  data.tar.gz: ddffab372459f5c8ff6f8246cc5ffd988c3a28c5041d56f9961e13f7d5bd0a2c9bfde3bf6d844792e708b332e5acd836afd4d71d041ec1435e7a1644716d2156
+  metadata.gz: 660d3af239a57512fbd74eecf2f7fc81c91a6fc42c0a95957952f01931bcd2b5f5387af2004557af985c8c3ef6f37c6b284e41b757af2919a241d5408060b25e
+  data.tar.gz: 6a0b7f7e2bc4533e80e8011fb17c1f851c31ddd6e831300efec0589423f541640e1ace953c75f066e8a9efc26c6e3fef886cc87941d204e09d1a2302d58adcbc

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.5.0 - 2025-06-11
+* Simplify matcher API so user provided matchers override defaults - [#14](https://github.com/rsanheim/backspin/pull/14)
+* Also extract a proper `Matcher` object
+
 ## 0.4.2 - 2025-06-10
 Unified `:match` API for customizing how actual commands are matched against recorded commands. - [#11](https://github.com/rsanheim/backspin/pull/11)
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    backspin (0.5.0)
+    backspin (0.6.0)
       ostruct
       rspec-mocks (~> 3)
 

data/lib/backspin/command.rb

@@ -52,6 +52,8 @@ module Backspin
         Open3::Capture3
       when "Kernel::System"
         ::Kernel::System
+      when "Backspin::Capturer"
+        Backspin::Capturer
       else
         # Default to capture3 for backwards compatibility
         Open3::Capture3
@@ -97,3 +99,8 @@ end
 module ::Kernel
   class System; end
 end
+
+# Define the Backspin::Capturer class for identification
+module Backspin
+  class Capturer; end
+end

data/lib/backspin/recorder.rb

@@ -136,6 +136,150 @@ module Backspin
       )
     end
 
+    # Performs capture recording by intercepting all stdout/stderr output
+    def perform_capture_recording
+      require "tempfile"
+
+      # Create temporary files for capturing output
+      stdout_tempfile = Tempfile.new("backspin_stdout")
+      stderr_tempfile = Tempfile.new("backspin_stderr")
+
+      begin
+        # Save original file descriptors
+        original_stdout_fd = $stdout.dup
+        original_stderr_fd = $stderr.dup
+
+        # Redirect both Ruby IO and file descriptors
+        $stdout.reopen(stdout_tempfile)
+        $stderr.reopen(stderr_tempfile)
+
+        # Execute the block
+        result = yield
+
+        # Flush and read captured output
+        $stdout.flush
+        $stderr.flush
+        stdout_tempfile.rewind
+        stderr_tempfile.rewind
+
+        captured_stdout = stdout_tempfile.read
+        captured_stderr = stderr_tempfile.read
+
+        # Create a single command representing all captured output
+        command = Command.new(
+          method_class: Backspin::Capturer,
+          args: ["<captured block>"],
+          stdout: captured_stdout,
+          stderr: captured_stderr,
+          status: 0,
+          recorded_at: Time.now.iso8601
+        )
+
+        record.add_command(command)
+        record.save(filter: @filter)
+
+        RecordResult.new(output: result, mode: :record, record: record)
+      ensure
+        # Restore original file descriptors
+        $stdout.reopen(original_stdout_fd)
+        $stderr.reopen(original_stderr_fd)
+        original_stdout_fd.close
+        original_stderr_fd.close
+
+        # Clean up temp files
+        stdout_tempfile.close!
+        stderr_tempfile.close!
+      end
+    end
+
+    # Performs capture verification by capturing output and comparing with recorded values
+    def perform_capture_verification
+      raise RecordNotFoundError, "Record not found: #{record.path}" unless record.exists?
+      raise RecordNotFoundError, "No commands found in record #{record.path}" if record.empty?
+
+      require "tempfile"
+
+      # Create temporary files for capturing output
+      stdout_tempfile = Tempfile.new("backspin_stdout")
+      stderr_tempfile = Tempfile.new("backspin_stderr")
+
+      begin
+        # Save original file descriptors
+        original_stdout_fd = $stdout.dup
+        original_stderr_fd = $stderr.dup
+
+        # Redirect both Ruby IO and file descriptors
+        $stdout.reopen(stdout_tempfile)
+        $stderr.reopen(stderr_tempfile)
+
+        # Execute the block
+        output = yield
+
+        # Flush and read captured output
+        $stdout.flush
+        $stderr.flush
+        stdout_tempfile.rewind
+        stderr_tempfile.rewind
+
+        captured_stdout = stdout_tempfile.read
+        captured_stderr = stderr_tempfile.read
+
+        # Get the recorded command (should be only one for capture)
+        recorded_command = record.commands.first
+
+        # Create actual command from captured output
+        actual_command = Command.new(
+          method_class: Backspin::Capturer,
+          args: ["<captured block>"],
+          stdout: captured_stdout,
+          stderr: captured_stderr,
+          status: 0
+        )
+
+        # Create CommandDiff for comparison
+        command_diff = CommandDiff.new(
+          recorded_command: recorded_command,
+          actual_command: actual_command,
+          matcher: @matcher
+        )
+
+        RecordResult.new(
+          output: output,
+          mode: :verify,
+          verified: command_diff.verified?,
+          record: record,
+          command_diffs: [command_diff]
+        )
+      ensure
+        # Restore original file descriptors
+        $stdout.reopen(original_stdout_fd)
+        $stderr.reopen(original_stderr_fd)
+        original_stdout_fd.close
+        original_stderr_fd.close
+
+        # Clean up temp files
+        stdout_tempfile.close!
+        stderr_tempfile.close!
+      end
+    end
+
+    # Performs capture playback - executes block normally but could optionally suppress output
+    def perform_capture_playback
+      raise RecordNotFoundError, "Record not found: #{record.path}" unless record.exists?
+      raise RecordNotFoundError, "No commands found in record" if record.empty?
+
+      # For now, just execute the block normally
+      # In the future, we could optionally suppress output or return recorded output
+      output = yield
+
+      RecordResult.new(
+        output: output,
+        mode: :playback,
+        verified: true,
+        record: record
+      )
+    end
+
     private
 
     def setup_capture3_replay_stub

data/lib/backspin/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Backspin
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

data/lib/backspin.rb

@@ -116,6 +116,43 @@ module Backspin
       result
     end
 
+    # Captures all stdout/stderr output from a block
+    #
+    # @param record_name [String] Name for the record file
+    # @param mode [Symbol] Recording mode - :auto, :record, :verify, :playback
+    # @param matcher [Proc, Hash] Custom matcher for verification
+    # @param filter [Proc] Custom filter for recorded data
+    # @return [RecordResult] Result object with captured output
+    def capture(record_name, mode: :auto, matcher: nil, filter: nil, &block)
+      raise ArgumentError, "record_name is required" if record_name.nil? || record_name.empty?
+      raise ArgumentError, "block is required" unless block_given?
+
+      record_path = Record.build_record_path(record_name)
+      mode = determine_mode(mode, record_path)
+
+      # Create or load the record based on mode
+      record = if mode == :record
+        Record.create(record_name)
+      else
+        Record.load_or_create(record_path)
+      end
+
+      # Create recorder with all needed context
+      recorder = Recorder.new(record: record, mode: mode, matcher: matcher, filter: filter)
+
+      # Execute the appropriate mode
+      case mode
+      when :record
+        recorder.perform_capture_recording(&block)
+      when :verify
+        recorder.perform_capture_verification(&block)
+      when :playback
+        recorder.perform_capture_playback(&block)
+      else
+        raise ArgumentError, "Unknown mode: #{mode}"
+      end
+    end
+
     private
 
     def determine_mode(mode_option, record_path)

data/release.rake

@@ -4,7 +4,7 @@ require "bundler/gem_tasks"
 
 # Simplified release tasks using gem-release
 # Install with: gem install gem-release
-
+# https://github.com/svenfuchs/gem-release
 namespace :release do
   desc "Release a new version (bump, tag, release)"
   task :version, [:level] do |t, args|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: backspin
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Rob Sanheim
@@ -153,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Record and replay CLI interactions for testing
 test_files: []