benchmark-swap 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 300c84291632dc4b0f85e22e83dde631f6baffeaee7d61911adbb62ecceaa288
-  data.tar.gz: 7c5fd3e887f3af1d60012ae3f62b6be0f04e9f425ebb4e69fdd2cc663ad6f1fd
+  metadata.gz: fd86fa1751573aadec3a1c8424f978425a8a0b5d777529b23950d8f93ff104c0
+  data.tar.gz: 6a0e1ecfbf5ca6d47edda1f03388084a0112e3c34fbb46e0435725a6c6493da5
 SHA512:
-  metadata.gz: 12661ba83db0e3e3f861768b2f90cf096c3acd273df8c9099b7870def338d8f0698cc0cb5f9db37dcbe02a0f6052e365b592513c1bba8d19e1e21ee1aed3cd86
-  data.tar.gz: 29ee23f65939cf66613bc324c3acb8048c9093b59889d9652208340d2f9acbaad5691865df2ee43474a332cbb13f0cf3b447363c53f88244a327186ca2d33d3c
+  metadata.gz: 1fafb8b7eef3fe9b381241ceb939e6a10d43205e8cf92887e971db59087dcface283986294aab3df31d305833359e0136a03d4b52870c91ccce6311cbc2af2dd
+  data.tar.gz: '02586225a030da25e823f7ea06efc79fb93baf4ff27c4a7b462bf650d7cc829d3adbd4599fdbea13d8b6a6fbf5b3e269777da92cab4f9c719d7a77b4e05b9b01'

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
-## 0.1.0
+## Unreleased
+
+- Verification no longer crashes the run when a returned value raises from `==` or from `inspect`. It reports a difference instead.
+- An option that benchmark-ips does not know now raises `ArgumentError` instead of being ignored, so a typo no longer runs the benchmark with default settings.
+- The list of swapped methods no longer crashes when a singleton method hangs on an object that raises from `to_s`.
+- The warning shown when the two sides disagree has clearer wording.
+
+## 0.1.0 (2026-09-08)
 
 - First release.

data/README.md

@@ -1,5 +1,7 @@
 # Benchmark::Swap
 
+[![CI](https://github.com/meinac/benchmark-swap/actions/workflows/ci.yml/badge.svg)](https://github.com/meinac/benchmark-swap/actions/workflows/ci.yml)
+
 Compare two implementations of a method with benchmark-ips, without lifting the method out of its call chain into two standalone lambdas. That lift is slow to do and easy to get wrong when the method sits deep inside real code. `Benchmark::Swap` keeps the method where it lives and swaps its body in place.
 
 Built for exploring performance changes inside a large Rails app from the Rails console.
@@ -70,6 +72,8 @@ original:  8479556.9 i/s
 
 Two "Warming up / Calculating" blocks and one "Comparison:" block are expected. Each side gets its own benchmark-ips run, then the two are compared with the original as the baseline.
 
+Pass `quiet: true` if you want only the swap list and the comparison.
+
 ## How it works
 
 1. **Discovery.** The block runs once under a Ruby `TracePoint` on the `:call` event. It collects every method that was actually called and has a twin with the suffix defined on the same owner. Only calls from the current thread count. A method whose twin lives on a different class or module (for example the original on a parent class, the twin on the child) is skipped. Frozen owners are skipped too.
@@ -87,7 +91,9 @@ The swap itself copies the twin's `UnboundMethod` body onto the original method
 | `suffix:` | `"_perf"` | Suffix used to find the twin method |
 | `verify:` | `true` | Compare both sides once before benchmarking |
 | `output:` | `$stdout` | Where the gem's own report lines go |
-| anything else | | Passed to benchmark-ips, for example `time:` and `warmup:` |
+| anything else | | Passed to benchmark-ips config: `warmup`, `time`, `iterations`, `stats`, `confidence`, `quiet`, `suite` |
+
+Any other key raises `ArgumentError`, because benchmark-ips would otherwise ignore it and run with the defaults.
 
 The call returns a `Runner::Result` struct with `candidates`, `verification`, `original`, and `swapped`. `original` and `swapped` are benchmark-ips `Report` objects. It returns `nil` when no twin was called.
 

data/lib/benchmark/swap/candidate.rb

@@ -10,7 +10,9 @@ module Benchmark
         else
           "#{owner}##{name}"
         end
-      rescue TypeError
+      rescue StandardError
+        # attached_object is interpolated, so the object decides what happens.
+        # Module#to_s on a singleton class needs no cooperation from it.
         "#{owner}##{name}"
       end
 

data/lib/benchmark/swap/runner.rb

@@ -15,9 +15,16 @@ module Benchmark
       SWAPPED_LABEL = "swapped"
       PREFIX = "benchmark-swap:"
 
+      # Benchmark::IPS::Job#config reads the keys it knows and ignores the
+      # rest, which would turn a typo into a benchmark that quietly ran with
+      # the defaults.
+      IPS_OPTIONS = %i[warmup time iterations stats confidence quiet suite].freeze
+
       Result = Struct.new(:candidates, :verification, :original, :swapped)
 
       def initialize(suffix:, verify:, output:, ips_options:)
+        reject_unknown(ips_options)
+
         @suffix = suffix
         @verify = verify
         @output = output
@@ -40,6 +47,15 @@ module Benchmark
 
       private
 
+      def reject_unknown(ips_options)
+        unknown = ips_options.keys - IPS_OPTIONS
+        return if unknown.empty?
+
+        raise ArgumentError,
+              "unknown option#{"s" if unknown.size > 1}: #{unknown.join(", ")}. " \
+              "Known: #{IPS_OPTIONS.join(", ")}"
+      end
+
       def nothing_found
         say "#{PREFIX} no *#{@suffix} twin was called by this block, nothing to compare."
 
@@ -59,7 +75,7 @@ module Benchmark
         outcome = Verifier.new.call(swapper, &block)
         return outcome if outcome.match?
 
-        say "#{PREFIX} WARNING both sides returned a different result"
+        say "#{PREFIX} WARNING the two sides returned different results"
         say "  #{ORIGINAL_LABEL}: #{outcome.original}"
         say "  #{SWAPPED_LABEL}: #{outcome.swapped}"
         say ""
@@ -77,10 +93,8 @@ module Benchmark
       end
 
       def ips(label, &block)
-        options = @ips_options
-
         Benchmark.ips do |job|
-          job.config(**options) unless options.empty?
+          job.config(**@ips_options) unless @ips_options.empty?
           job.report(label, &block)
         end
       end

data/lib/benchmark/swap/verifier.rb

@@ -21,6 +21,10 @@ module Benchmark
           return value == other.value unless error || other.error
 
           other.error.instance_of?(error.class) && other.error.message == error.message
+        rescue StandardError
+          # Comparing is best effort, and this class promises a warning rather
+          # than a failure. A value that raises from == counts as a difference.
+          false
         end
 
         def to_s
@@ -28,6 +32,8 @@ module Benchmark
 
           text = value.inspect
           text.length > MAX_LENGTH ? "#{text[0, MAX_LENGTH]}..." : text
+        rescue StandardError
+          "(cannot be shown)"
         end
       end
 

data/lib/benchmark/swap/version.rb

@@ -2,6 +2,6 @@
 
 module Benchmark
   module Swap
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: benchmark-swap
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Mehmet Emin INAC