betamax 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f89807eb4aa9a8365294d743efddad3a94a6a6c9078615731bebc2fa1cf93f6
-  data.tar.gz: 31a8decf2ca628028820007eff48e83cbe45758fab781bc87503c3c172e61c8a
+  metadata.gz: b13224e3fa5f820802a68dc000dbabab4a023eff18250e3b0af5e9fb36f98092
+  data.tar.gz: 70fb0889db8f8b4df8b7b60527895f27d806bda46164990670cec559e5e0b29c
 SHA512:
-  metadata.gz: 92208fdfd5c7bff89094c394827da00a06425f3c0037e9caa498230a1afb3dec467ab5b32325018c0ce2162095ad9ae1c59be4ab36f8943699ffafffdf13407a
-  data.tar.gz: cf74600f45a068b9b01b3d268211d3992e6d836d7e80d2f8baafe446a80628588669cb68530e2cb1bea63bd3fca6ea2a5509009562d2bbdb67df538cfdc6650d
+  metadata.gz: '0698af118ee8b4a7900e8fa490548b9967e4c91c5fa1cb7d7543b5f55aaf71ab1993a8b6efdfa80467c830e86f24227be5f42e3b0509bb628657914c49f01003'
+  data.tar.gz: ea48915b0269d20c9810d7a65a8519c0b9a6b84cdab6dd918822ba92da084fbd427b0d2145ce7f27757a5bacf39d9476a7646e0fcf2fbbbcbff2a26d64db51e6

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## [Unreleased]
 
+## 0.2.0
+
+- Add Minitest support via `Betamax::Minitest#with_betamax`.
+- Clear the active player when a test raises, so a later test cannot record onto a stale player.
+
+## 0.1.1 - 2026-06-15
+
+- Add UNLICENSE
+
 ## [0.1.0] - 2026-06-15
 
 - Initial release

data/README.md

@@ -1,32 +1,76 @@
 # Betamax
 
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/betamax`. To experiment with that code, run `bin/console` for an interactive prompt.
+Betamax allows for the recording and playback of arbitrary Ruby objects to simplify testing external dependencies. Think of it like the [VCR](https://github.com/vcr/vcr) gem, but for any complicated object, not just HTTP interactions. This gem was originally developed to write a test suite for a MiniDisc NetMD Walkman library, where the recording and playback of real USB traffic was desired.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
 Install the gem and add to the application's Gemfile by executing:
 
 ```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+bundle add betamax
 ```
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
 ```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+gem install betamax
 ```
 
 ## Usage
 
-TODO: Write usage instructions here
+Currently this gem supports testing with RSpec. First, require the gem in your spec helper:
+
+```ruby
+# File: spec/spec_helper.rb
+
+require 'betamax'
+```
+
+Then, record an object. The first time you run your test, a recording will be created in `spec/betamax_tapes/`. Subsequent test runs will playback from your recording. Make sure to tag your example as `:betamax` to enable recording and playback.
+
+```ruby
+RSpec.describe 'a MiniDisc device' do
+  let(:walkman) do
+    usb_device = LibUSB::Context.devices(idProduct: 0x0084).first
+
+    MiniDisc::Device.new usb_device: Betamax.record(usb_device)
+  end
+
+  it 'has a tracklist', :betamax do
+    walkman.open do |disc|
+      disc.tracks.first.title.should == 'Song of the Highwire Shrimper'
+    end
+  end
+end
+
+```
+
+In the above example, the test will continue to work even if the USB device is no longer present. If for some reason changes to your code change the interaction with your recorded object, your test will fail. This could be because methods were called in a different order, block arguments changed, method calls were expected but did not take place, etc.
+
+### Minitest
+
+Include `Betamax::Minitest` in your test class and surround the recorded interaction with `with_betamax`. Tapes are named after the test class and method and stored in `test/betamax_tapes/` (override with `tapes_folder:`).
+
+```ruby
+class WalkmanTest < Minitest::Test
+  include Betamax::Minitest
+
+  def test_tracklist
+    with_betamax do
+      usb_device = LibUSB::Context.devices(idProduct: 0x0084).first
+      walkman = MiniDisc::Device.new usb_device: Betamax.record(usb_device)
+
+      walkman.open do |disc|
+        assert_equal 'Song of the Highwire Shrimper', disc.tracks.first.title
+      end
+    end
+  end
+end
+```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake` to run the RSpec and Minitest suites and RuboCop. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 

data/Rakefile

@@ -1,10 +1,15 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new :spec
 
-require "rubocop/rake_task"
+Rake::TestTask.new :test do |task|
+  task.libs << 'lib'
+  task.pattern = 'test/**/*_test.rb'
+end
 
 RuboCop::RakeTask.new
 
-task default: %i[spec rubocop]
+task default: %i[spec test rubocop]

data/UNLICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <http://unlicense.org/>

data/lib/betamax/errors.rb

@@ -3,7 +3,7 @@ module Betamax
     class Error < StandardError; end
 
     class NoTapeInserted < Error
-      def initialize message = "No tape inserted"
+      def initialize message = 'No tape inserted'
         super
       end
     end
@@ -51,7 +51,7 @@ module Betamax
 
     class UnusedRecordings < PlaybackError
       def initialize unused_methods
-        method_names = unused_methods.map(&:method_name).join(", ")
+        method_names = unused_methods.map(&:method_name).join(', ')
         super "Recording has #{unused_methods.size} unused method(s): #{method_names}"
       end
     end

data/lib/betamax/minitest.rb

@@ -0,0 +1,27 @@
+module Betamax
+  module Minitest
+    DEFAULT_TAPES_FOLDER = Pathname.new 'test/betamax_tapes/'
+
+    # Adapts a Minitest test and block to the example interface Player expects.
+    class Example
+      attr_reader :metadata
+
+      def initialize test, &block
+        @metadata = { description: test.name, example_group: { description: test.class.name } }
+        @block = block
+      end
+
+      def run
+        @block.call
+      end
+
+      def exception
+        nil
+      end
+    end
+
+    def with_betamax(tapes_folder: DEFAULT_TAPES_FOLDER, &)
+      Player.new(Example.new(self, &), tapes_folder: Pathname.new(tapes_folder)).play
+    end
+  end
+end

data/lib/betamax/player.rb

@@ -13,6 +13,8 @@ module Betamax
       insert_tape
       @example.run
       eject_tape unless @example.exception
+    ensure
+      Fiber[:betamax_player] = nil
     end
 
     def record object

data/lib/betamax/rspec.rb

@@ -1,6 +1,6 @@
 module Betamax
   module RSpec
-    DEFAULT_TAPES_FOLDER = Pathname.new "spec/betamax_tapes/"
+    DEFAULT_TAPES_FOLDER = Pathname.new 'spec/betamax_tapes/'
 
     def play_rspec example, tapes_folder: DEFAULT_TAPES_FOLDER
       Player.new(example, tapes_folder:).play

data/lib/betamax/tape.rb

@@ -1,5 +1,5 @@
-require "fileutils"
-require "yaml"
+require 'fileutils'
+require 'yaml'
 
 module Betamax
   class Tape
@@ -20,11 +20,11 @@ module Betamax
 
     def self.from_rspec_example example, tapes_folder:
       name = cassette_name_for example.metadata
-      name.gsub! "::", "_"
-      name.gsub!(/[\s-]+/, "_")
-      name.gsub! %r{[^a-zA-Z0-9_/]}, ""
+      name.gsub! '::', '_'
+      name.gsub!(/[\s-]+/, '_')
+      name.gsub! %r{[^a-zA-Z0-9_/]}, ''
 
-      filename = Pathname.new(name).sub_ext ".yaml"
+      filename = Pathname.new(name).sub_ext '.yaml'
       full_path = tapes_folder / filename
 
       new full_path
@@ -44,7 +44,7 @@ module Betamax
         current = current[:parent_example_group]
       end
 
-      description_parts.join "/"
+      description_parts.join '/'
     end
 
     def load
@@ -66,7 +66,7 @@ module Betamax
         version: Recording::VERSION,
         objects: { default: proxy }
 
-      File.open @path, "w" do |file|
+      File.open @path, 'w' do |file|
         file.puts recording.to_yaml
       end
     end

data/lib/betamax/version.rb

@@ -1,3 +1,3 @@
 module Betamax
-  VERSION = "0.1.0".freeze
+  VERSION = '0.2.0'.freeze
 end

data/lib/betamax.rb

@@ -1,16 +1,17 @@
-require "pathname"
-
-require_relative "betamax/errors"
-require_relative "betamax/method_player"
-require_relative "betamax/method_recorder"
-require_relative "betamax/player"
-require_relative "betamax/recorded_method"
-require_relative "betamax/recorded_object"
-require_relative "betamax/recorded_yielding"
-require_relative "betamax/recording"
-require_relative "betamax/rspec"
-require_relative "betamax/tape"
-require_relative "betamax/version"
+require 'pathname'
+
+require_relative 'betamax/errors'
+require_relative 'betamax/method_player'
+require_relative 'betamax/method_recorder'
+require_relative 'betamax/minitest'
+require_relative 'betamax/player'
+require_relative 'betamax/recorded_method'
+require_relative 'betamax/recorded_object'
+require_relative 'betamax/recorded_yielding'
+require_relative 'betamax/recording'
+require_relative 'betamax/rspec'
+require_relative 'betamax/tape'
+require_relative 'betamax/version'
 
 module Betamax
   extend RSpec

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: betamax
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - John DeSilva
@@ -20,10 +20,12 @@ files:
 - CHANGELOG.md
 - README.md
 - Rakefile
+- UNLICENSE
 - lib/betamax.rb
 - lib/betamax/errors.rb
 - lib/betamax/method_player.rb
 - lib/betamax/method_recorder.rb
+- lib/betamax/minitest.rb
 - lib/betamax/player.rb
 - lib/betamax/recorded_method.rb
 - lib/betamax/recorded_object.rb
@@ -47,14 +49,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.2.0
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.10
+rubygems_version: 4.0.16
 specification_version: 4
 summary: Record and playback of arbitrary Ruby objects
 test_files: []