scientist 1.6.2 → 1.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e623b9acbede185a6ee8ca0ae2227a52707499c28bdf04e4fe8a2afcbd0f051
-  data.tar.gz: 560b1d3353829f6be217229546297fcd4102e6c47dc87fc12ffa963c5e2fa3f7
+  metadata.gz: 5553615794cee9e0fbdb4c22b3dd528885b30a75c9c8c2bd1d5d4f8ebd4bc0ba
+  data.tar.gz: ff1c3e2b2f23defc19ad663df792da483926406aa98261d403fa7c008c03be85
 SHA512:
-  metadata.gz: 593c2807ff16f1381a0189e4babdad3ab366ad66057e4af1b083611fb204d55ae9434bf989550f8371de7586be55fe4f8a760f84f2424323a9189803583e9243
-  data.tar.gz: 1239bb86dfad9fcee2b0dc4dc2fc8458306e877afd2aa1e722b9e4db7072b71658469bf48b425959c52111fac2cc8bb5dbbb11435263a199f036ad2ee4697228
+  metadata.gz: ffef7682cdd59612ca44b33ba3678467251c2ccabfdecda41022cc95c0d07673abd38ca3a33c357fa40358398691ba0f8ecf8ec04ddff14800a25a915f011f4d
+  data.tar.gz: 06e06b1428967829d9b330eba28bd1bd2ce47eb5b12b6317eb6c6e8ea53e4e6434337803b88fdadbccdcb23a1b8cafe2fbe98a38756ea53d81ed21afe0ec369e

data/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: "/"
+    schedule:
+      interval: "weekly"

data/.github/workflows/ci.yml

@@ -0,0 +1,33 @@
+name: CI
+on: [push, pull_request]
+permissions:
+  actions: none
+  checks: write
+  contents: read
+  deployments: none
+  issues: none
+  packages: none
+  pull-requests: none
+  repository-projects: none
+  security-events: none
+  statuses: write
+jobs:
+  build:
+    name: ruby-${{ matrix.ruby_version }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby_version:
+          - "2.6"
+          - "2.7"
+          - "3.0"
+          - "3.1"
+          - "3.2"
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby_version }}
+          bundler-cache: true
+      - run: bundle exec rake

data/README.md

@@ -1,6 +1,6 @@
 # Scientist!
 
-A Ruby library for carefully refactoring critical paths. [![Build Status](https://travis-ci.org/github/scientist.svg?branch=master)](https://travis-ci.org/github/scientist) [![Coverage Status](https://coveralls.io/repos/github/github/scientist/badge.svg?branch=master)](https://coveralls.io/github/github/scientist?branch=master)
+A Ruby library for carefully refactoring critical paths. [![Build Status](https://github.com/github/scientist/actions/workflows/ci.yml/badge.svg)](https://github.com/github/scientist/actions/workflows/ci.yml)
 
 ## How do I science?
 
@@ -109,7 +109,7 @@ class MyWidget
 end
 ```
 
-If either the control block or candidate block raises an error, Scientist compares the two observations' classes and messages using `==`. To override this behavior, use `compare_error` to define how to compare observed errors instead:
+If either the control block or candidate block raises an error, Scientist compares the two observations' classes and messages using `==`. To override this behavior, use `compare_errors` to define how to compare observed errors instead:
 
 ```ruby
 class MyWidget
@@ -132,7 +132,7 @@ class MyWidget
         candidate.message.start_with?("Invalid characters in input") 
       end
 
-      e.compare_error do |control, candidate|
+      e.compare_errors do |control, candidate|
         compare_error_message_and_class.call(control, candidate) ||
         compare_argument_errors.call(control, candidate)
       end
@@ -260,7 +260,7 @@ def admin?(user)
 end
 ```
 
-The ignore blocks are only called if the *values* don't match. Unless a `compare_error` comparator is defined, two cases are considered mismatches: a) one observation raising an exception and the other not, b) observations raising exceptions with different classes or messages.
+The ignore blocks are only called if the *values* don't match. Unless a `compare_errors` comparator is defined, two cases are considered mismatches: a) one observation raising an exception and the other not, b) observations raising exceptions with different classes or messages.
 
 ### Enabling/disabling experiments
 

data/Rakefile

@@ -0,0 +1,7 @@
+require "rake/testtask"
+
+task default: "test"
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/test_helper.rb', 'test/**/*_test.rb']
+end

data/lib/scientist/experiment.rb

@@ -84,10 +84,19 @@ module Scientist::Experiment
   #
   # Returns the configured block.
   def before_run(&block)
-    marshalize(block)
     @_scientist_before_run = block
   end
 
+  # Define a block of code to run after an experiment completes, if the experiment
+  # is enabled.
+  #
+  # The block takes one argument, the Scientist::Result containing experiment results.
+  #
+  # Returns the configured block.
+  def after_run(&block)
+    @_scientist_after_run = block
+  end
+
   # A Hash of behavior blocks, keyed by String name. Register behavior blocks
   # with the `try` and `use` methods.
   def behaviors
@@ -100,7 +109,6 @@ module Scientist::Experiment
   #
   # Returns the configured block.
   def clean(&block)
-    marshalize(block)
     @_scientist_cleaner = block
   end
 
@@ -133,7 +141,6 @@ module Scientist::Experiment
   #
   # Returns the block.
   def compare(*args, &block)
-    marshalize(block)
     @_scientist_comparator = block
   end
 
@@ -144,7 +151,6 @@ module Scientist::Experiment
   #
   # Returns the block.
   def compare_errors(*args, &block)
-    marshalize(block)
     @_scientist_error_comparator = block
   end
 
@@ -163,7 +169,6 @@ module Scientist::Experiment
   #
   # This can be called more than once with different blocks to use.
   def ignore(&block)
-    marshalize(block)
     @_scientist_ignores ||= []
     @_scientist_ignores << block
   end
@@ -235,6 +240,10 @@ module Scientist::Experiment
 
     result = generate_result(name)
 
+    if @_scientist_after_run
+      @_scientist_after_run.call(result)
+    end
+
     begin
       publish(result)
     rescue StandardError => ex
@@ -256,7 +265,6 @@ module Scientist::Experiment
 
   # Define a block that determines whether or not the experiment should run.
   def run_if(&block)
-    marshalize(block)
     @_scientist_run_if_block = block
   end
 
@@ -282,7 +290,6 @@ module Scientist::Experiment
 
   # Register a named behavior for this experiment, default "candidate".
   def try(name = nil, &block)
-    marshalize(block)
     name = (name || "candidate").to_s
 
     if behaviors.include?(name)
@@ -294,7 +301,6 @@ module Scientist::Experiment
 
   # Register the control behavior for this experiment.
   def use(&block)
-    marshalize(block)
     try "control", &block
   end
 
@@ -332,13 +338,14 @@ module Scientist::Experiment
   # In order to support marshaling, we have to make the procs marshalable. Some
   # CI providers attempt to marshal Scientist mismatch errors so that they can
   # be sent out to different places (logs, etc.) The mismatch errors contain
-  # code from the experiment. This code contains Procs - which can't be
-  # marshaled until we run the following code.
-  def marshalize(block)
-    unless block.respond_to?(:_dump) || block.respond_to?(:_dump_data)
-      def block._dump(_)
-        to_s
-      end
-    end
+  # code from the experiment. This code contains procs. These procs prevent the
+  # error from being marshaled. To fix this, we simple exclude the procs from
+  # the data that we marshal.
+  def marshal_dump
+    [@name, @result, @raise_on_mismatches]
+  end
+
+  def marshal_load
+    @name, @result, @raise_on_mismatches = array
   end
 end

data/lib/scientist/observation.rb

@@ -58,7 +58,7 @@ class Scientist::Observation
   # * The values of the observation are equal (using `==`)
   # * The values of the observations are equal according to a comparison
   #   proc, if given
-  # * The exceptions raised by the obeservations are equal according to the
+  # * The exceptions raised by the observations are equal according to the
   #   error comparison proc, if given.
   # * Both observations raised an exception with the same class and message.
   #

data/lib/scientist/version.rb

@@ -1,3 +1,3 @@
 module Scientist
-  VERSION = "1.6.2"
+  VERSION = '1.6.4'
 end

data/scientist.gemspec

@@ -18,5 +18,5 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
 
   gem.add_development_dependency "minitest", "~> 5.8"
-  gem.add_development_dependency "coveralls", "~> 0.8"
+  gem.add_development_dependency "rake"
 end

data/script/test

@@ -4,9 +4,4 @@
 set -e
 
 cd $(dirname "$0")/..
-  script/bootstrap && bundle exec ruby -I lib \
-    -e 'require "bundler/setup"' \
-    -e 'require "coveralls"; Coveralls.wear!{ add_filter ".bundle" }' \
-    -e 'require "minitest/autorun"' \
-    -e 'require "scientist"' \
-    -e '(ARGV.empty? ? Dir["test/**/*_test.rb"] : ARGV).each { |f| load f }' -- "$@"
+  script/bootstrap && bundle exec rake test

data/test/scientist/experiment_test.rb

@@ -635,6 +635,37 @@ candidate:
     end
   end
 
+  describe "after run block" do
+    it "runs when an experiment is enabled" do
+      control_ok = candidate_ok = false
+      after_result = nil
+      @ex.after_run { |result| after_result = result }
+      @ex.use { control_ok = after_result.nil? }
+      @ex.try { candidate_ok = after_result.nil? }
+
+      @ex.run
+
+      assert after_result, "after_run should have run"
+      assert after_result.matched?, "after_run should be called with the result"
+      assert control_ok, "control should have run before after_run"
+      assert candidate_ok, "candidate should have run before after_run"
+    end
+
+    it "does not run when an experiment is disabled" do
+      after_result = nil
+
+      def @ex.enabled?
+        false
+      end
+      @ex.after_run { |result| after_result = result }
+      @ex.use { "value" }
+      @ex.try { "value" }
+      @ex.run
+
+      refute after_result, "after_run should not have run"
+    end
+  end
+
   describe "testing hooks for extending code" do
     it "allows a user to provide fabricated durations for testing purposes" do
       @ex.use { true }

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require "minitest/autorun"
+
+$LOAD_PATH.unshift(File.expand_path(File.join(__dir__, "../lib")))
+require "scientist"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scientist
 version: !ruby/object:Gem::Version
-  version: 1.6.2
+  version: 1.6.4
 platform: ruby
 authors:
 - GitHub Open Source
@@ -12,7 +12,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-04 00:00:00.000000000 Z
+date: 2023-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -29,19 +29,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.8'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0'
 description: A Ruby library for carefully refactoring critical paths
 email:
 - opensource+scientist@github.com
@@ -53,12 +53,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
-- ".travis.yml"
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - README.md
+- Rakefile
 - doc/changelog.md
 - lib/scientist.rb
 - lib/scientist/default.rb
@@ -76,6 +78,7 @@ files:
 - test/scientist/observation_test.rb
 - test/scientist/result_test.rb
 - test/scientist_test.rb
+- test/test_helper.rb
 homepage: https://github.com/github/scientist
 licenses:
 - MIT
@@ -95,7 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Carefully test, measure, and track refactored code.
@@ -105,3 +108,4 @@ test_files:
 - test/scientist/observation_test.rb
 - test/scientist/result_test.rb
 - test/scientist_test.rb
+- test/test_helper.rb

data/.travis.yml

@@ -1,14 +0,0 @@
----
-language: ruby
-cache: bundler
-script: script/test
-rvm:
-  - 2.6.7
-  - 2.7.3
-  - 3.0.1
-  - truffleruby-head
-before_install: gem install bundler
-addons:
- apt:
-   packages:
-     - libgmp-dev