scientist 1.6.1 → 1.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eee7969d8abea0f0fa0a53dea180d2f786d67a589b8694b2ccf6c70bdcedcbb4
-  data.tar.gz: 87bb457307fb452731efed8413770abed9f3d687e9718dd54edce106d745d389
+  metadata.gz: 1e623b9acbede185a6ee8ca0ae2227a52707499c28bdf04e4fe8a2afcbd0f051
+  data.tar.gz: 560b1d3353829f6be217229546297fcd4102e6c47dc87fc12ffa963c5e2fa3f7
 SHA512:
-  metadata.gz: 882c44d39b595fe4c660abd619b5889552fe5d48c8bf2a2ff57e8b62fa221853a3af8727d04318068da888b6a8dd59e23f78c0eda71237261e409cb4038a5524
-  data.tar.gz: a6397a830792dda87404c7775d804d19a8b229a488180bba633501ff80ca889b9e61d44cf06287e48059664f8d6dd5097bf82e2ac6c4d33e478e02ea5e88c78f
+  metadata.gz: 593c2807ff16f1381a0189e4babdad3ab366ad66057e4af1b083611fb204d55ae9434bf989550f8371de7586be55fe4f8a760f84f2424323a9189803583e9243
+  data.tar.gz: 1239bb86dfad9fcee2b0dc4dc2fc8458306e877afd2aa1e722b9e4db7072b71658469bf48b425959c52111fac2cc8bb5dbbb11435263a199f036ad2ee4697228

data/CONTRIBUTING.md

@@ -10,9 +10,9 @@ Contributions to this project are [released](https://help.github.com/articles/gi
 ## Submitting a pull request
 
 0. [Fork][fork] and clone the repository
-0. Create a new branch: `git checkout -b my-branch-name`
-0. Make your change, push to your fork and [submit a pull request][pr]
-0. Pat your self on the back and wait for your pull request to be reviewed and merged.
+1. Create a new branch: `git checkout -b my-branch-name`
+2. Make your change, push to your fork and [submit a pull request][pr]
+3. Pat your self on the back and wait for your pull request to be reviewed and merged.
 
 Here are a few things you can do that will increase the likelihood of your pull request being accepted:
 

data/README.md

@@ -84,7 +84,7 @@ class MyExperiment
 end
 ```
 
-When `Scientist::Experiment` is included in a class, it automatically sets it as the default implementation via `Scientist::Experiment.set_default`. This `set_default` call is is skipped if you include `Scientist::Experiment` in a module.
+When `Scientist::Experiment` is included in a class, it automatically sets it as the default implementation via `Scientist::Experiment.set_default`. This `set_default` call is skipped if you include `Scientist::Experiment` in a module.
 
 Now calls to the `science` helper will load instances of `MyExperiment`.
 
@@ -129,7 +129,7 @@ class MyWidget
         control.class == ArgumentError &&
         candidate.class == ArgumentError &&
         control.message.start_with?("Input has invalid characters") &&
-        candidate.message.star_with?("Invalid characters in input") 
+        candidate.message.start_with?("Invalid characters in input") 
       end
 
       e.compare_error do |control, candidate|

data/lib/scientist/experiment.rb

@@ -84,6 +84,7 @@ module Scientist::Experiment
   #
   # Returns the configured block.
   def before_run(&block)
+    marshalize(block)
     @_scientist_before_run = block
   end
 
@@ -99,6 +100,7 @@ module Scientist::Experiment
   #
   # Returns the configured block.
   def clean(&block)
+    marshalize(block)
     @_scientist_cleaner = block
   end
 
@@ -131,6 +133,7 @@ module Scientist::Experiment
   #
   # Returns the block.
   def compare(*args, &block)
+    marshalize(block)
     @_scientist_comparator = block
   end
 
@@ -141,6 +144,7 @@ module Scientist::Experiment
   #
   # Returns the block.
   def compare_errors(*args, &block)
+    marshalize(block)
     @_scientist_error_comparator = block
   end
 
@@ -159,6 +163,7 @@ 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
@@ -251,6 +256,7 @@ 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
 
@@ -276,6 +282,7 @@ 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)
@@ -287,6 +294,7 @@ module Scientist::Experiment
 
   # Register the control behavior for this experiment.
   def use(&block)
+    marshalize(block)
     try "control", &block
   end
 
@@ -318,4 +326,19 @@ module Scientist::Experiment
     control = observations.detect { |o| o.name == name }
     Scientist::Result.new(self, observations, control)
   end
+
+  private
+
+  # 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
+  end
 end

data/lib/scientist/version.rb

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

data/script/release

@@ -12,10 +12,10 @@ cd $(dirname "$0")/..
 rm -rf scientist-*.gem
 gem build -q scientist.gemspec
 
-# Make sure we're on the master branch.
+# Make sure we're on the main branch.
 
-(git branch --no-color | grep -q '* master') || {
-  echo "Only release from the master branch."
+(git branch --no-color | grep -q '* main') || {
+  echo "Only release from the main branch."
   exit 1
 }
 
@@ -35,4 +35,4 @@ git fetch -t origin
 # Tag it and bag it.
 
 gem push scientist-*.gem && git tag "$tag" &&
-  git push origin master && git push origin "$tag"
+  git push origin main && git push origin "$tag"

data/test/scientist/experiment_test.rb

@@ -491,6 +491,27 @@ describe Scientist::Experiment do
       assert_raises(Scientist::Experiment::MismatchError) { runner.call }
     end
 
+    it "can be marshaled" do
+      Fake.raise_on_mismatches = true
+      @ex.before_run { "some block" }
+      @ex.clean { "some block" }
+      @ex.compare_errors { "some block" }
+      @ex.ignore { false }
+      @ex.run_if { "some block" }
+      @ex.try { "candidate" }
+      @ex.use { "control" }
+      @ex.compare { |control, candidate| control == candidate }
+
+      mismatch = nil
+      begin
+        @ex.run
+      rescue Scientist::Experiment::MismatchError => e
+        mismatch = e
+      end
+
+      assert_kind_of(String, Marshal.dump(mismatch))
+    end
+
     describe "#raise_on_mismatches?" do
       it "raises when there is a mismatch if the experiment instance's raise on mismatches is enabled" do
         Fake.raise_on_mismatches = false

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scientist
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 1.6.2
 platform: ruby
 authors:
 - GitHub Open Source
@@ -12,7 +12,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-22 00:00:00.000000000 Z
+date: 2021-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest