lab_coat 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22451390278d5dff8546f421b305107ea5e6d6636ea288eb674ab980353dcd20
-  data.tar.gz: 0a97027504a75312e42501283898021c9417b6e283e22cb5d86a614ebf939ae8
+  metadata.gz: 35fcc39652cc2ab43879a6a513214962c139d6b5751f5a1d4b4e8dba7b72b5e3
+  data.tar.gz: 5b54b1fb3fcabe26a80b2cdd619308f51b7fc44c6b0b93572550eb3e9a50aedd
 SHA512:
-  metadata.gz: d59adedb051274080954bd28c23b0fbbdc4b6914d90a19f45e5a4c8d3d8f46a06b334e7a2c1e5698eee9adbc9bdfb0f8d4270d37c37430978d952635f4186711
-  data.tar.gz: eb3f5aadd5a01813521b81941052a699ce5ced2b7e9f8d0964942d4a419524e001a0664cd55170069a9fff149eddc6f36885d704e035cc139309115f35c8d856
+  metadata.gz: 48e1e6af3c47d799f6eecd76dcac57a168da9c1729fc29091742b79ae114d36741a9d72bac6348db0db43a868ee5f75087ced725d270ae55074221a2dc152cd5
+  data.tar.gz: 6b98f3702d8a8cc8494bc2c9eb5e09e1ecc6aff21d204be93d54485eba4754fa60aa89aa832b2644910e42d6ac42c4cdc683db0ac4d0b49b7c3fe2025b417488

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## [0.1.3] - 2024-04-17
+- `Experiment` now enforces arity at runtime for the `#enabled?`, `control`, and `candidate` methods.
+
 ## [0.1.2] - 2024-04-15
 - use `Benchmark` to capture the duration with more details
 - add `to_h` methods to `Result` and `Observation` for convenience

data/README.md

@@ -8,6 +8,7 @@ This library is heavily inspired by [Scientist](https://github.com/github/scient
 - `Experiments` are `classes`, not `modules` which means they are stateful by default.
 - There is no app wide default experiment that gets magically set.
 - The `Result` only supports one comparison at a time, i.e. only 1 `candidate` is allowed per run.
+- The `duration` is measured using Ruby's `Benchmark`.
 
 ## Installation
 
@@ -55,8 +56,8 @@ See the [`Experiment`](lib/lab_coat/experiment.rb) class for more details.
 |`enabled?`|Returns a `Boolean` that controls whether or not the experiment runs.|
 |`publish!`|This is not _technically_ required, but `Experiments` are not useful unless you can analyze the results. Override this method to record the `Result` however you wish.|
 
-> [!TIP]
-> The `#run!` method accepts arbitrary arguments and forwards them to `enabled?`, `control`, and `candidate` in case you need to provide data at runtime.
+> [!IMPORTANT]
+> The `#run!` method accepts arbitrary arguments and forwards them to `enabled?`, `control`, and `candidate` in case you need to provide data at runtime. This means the [arity](https://en.wikipedia.org/wiki/Arity) of the three methods needs to be the same. This is enforced by `LabCoat` at runtime.
 
 #### Additional methods
 
@@ -190,7 +191,7 @@ def publish!(result)
 end
 ```
 
-> ![NOTE]
+> [!NOTE]
 > All `Results` are passed to `publish!`, **including ignored ones**. It is your responsibility to call the `ignored?` method and handle those as you wish.
 
 You can always access all of the attributes of the `Result` and its `Observations` directly to fully customize what your experiment publishing looks like.

data/lib/lab_coat/experiment.rb

@@ -60,24 +60,38 @@ module LabCoat
     # Runs the control and candidate and publishes the result. Always returns the result of `control`.
     # @param context [Hash] Any data needed at runtime.
     def run!(...) # rubocop:disable Metrics/MethodLength
+      enforce_arity!
+
       # Run the control and exit early if the experiment is not enabled.
-      control = Observation.new("control", self) do
+      control_obs = Observation.new("control", self) do
         control(...)
       end
-      raised(control) if control.raised?
-      return control.value unless enabled?(...)
+      raised(control_obs) if control_obs.raised?
+      return control_obs.value unless enabled?(...)
 
-      candidate = Observation.new("candidate", self) do
+      candidate_obs = Observation.new("candidate", self) do
         candidate(...)
       end
-      raised(candidate) if candidate.raised?
+      raised(candidate_obs) if candidate_obs.raised?
 
       # Compare and publish the results.
-      result = Result.new(self, control, candidate)
+      result = Result.new(self, control_obs, candidate_obs)
       publish!(result)
 
       # Always return the control.
-      control.value
+      control_obs.value
+    end
+
+    private
+
+    # Because `run!` forwards arbitrary args to `#enabled?`, `control`, and `candidate`, the methods must have the same
+    # arity. Otherwise
+    def enforce_arity!
+      return if %i[enabled? control candidate].map { |m| method(m).arity }.uniq.size == 1
+
+      raise InvalidExperimentError,
+            "The `#enabled?`, `#control` and `#candidate` methods must have the same arity. All runtime args passed " \
+            "to `#run!` are forwarded to these methods."
     end
   end
 end

data/lib/lab_coat/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LabCoat
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lab_coat
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Omkar Moghe
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-15 00:00:00.000000000 Z
+date: 2024-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest