scientist 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ad0ca94921ed85fa82b13057d4c68c842d42ea256df543b32196e665c75519c
-  data.tar.gz: 02f8948568c02e57d003b42a7ca4964e78e1ca14df57b6f204c2db31be5098a9
+  metadata.gz: 7a444eefb69bf453db50912ba9a629edd0845f1b2591c36809f4329862188b82
+  data.tar.gz: 28895c2df468c46c10d4b474ee9aa58b448514bb856c6f059112ad48d09bb97b
 SHA512:
-  metadata.gz: 671d170da1739b46f102a898a32b522438f45323cc1d2b788865566bfc2c16d16c6b364c4610a97ee30e4da597642bb4ad9d2c422384eddbab278ae170469f9f
-  data.tar.gz: 5334f5ae2d735cdc3b230bfefd469bd51c9e9363ec5cec83d45e99cbb2b3b55fa14f057dc59dc7909828dc0182c9168c9a86d47efe5529971206b9ff5c14a52a
+  metadata.gz: 40c3e14294c377e70c86e03b50ac121da94b8e79e0b5f14a6844343a4f5b56b6fa340f66caa4671498e303978eea9ebd331ad7633aebd6b5901d970321f71342
+  data.tar.gz: '092d3a37710ea538580205e284b31314eb298b5d10d910d2a36cff0b334ecbbd01c2b9311b35769eec7f308549f954c1a27084306f60232cd18bae24fd59e96d'

data/CONTRIBUTING.md

@@ -0,0 +1,26 @@
+## Contributing
+
+[fork]: https://github.com/github/scientist/fork
+[pr]: https://github.com/github/scientist/compare
+
+Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
+
+Contributions to this project are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [project's open source license](LICENSE.txt).
+
+## 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.
+
+Here are a few things you can do that will increase the likelihood of your pull request being accepted:
+
+- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
+- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
+
+## Resources
+
+- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
+- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
+- [GitHub Help](https://help.github.com)

data/README.md

@@ -52,7 +52,7 @@ If you don't declare any `try` blocks, none of the Scientist machinery is invoke
 
 ## Making science useful
 
-The examples above will run, but they're not really *doing* anything. The `try` blocks run every time and none of the results get published. Replace the default experiment implementation to control execution and reporting:
+The examples above will run, but they're not really *doing* anything. The `try` blocks don't run yet and none of the results get published. Replace the default experiment implementation to control execution and reporting:
 
 ```ruby
 require "scientist/experiment"
@@ -352,6 +352,35 @@ MyExperiment.raise_on_mismatches = true
 
 Scientist will raise a `Scientist::Experiment::MismatchError` exception if any observations don't match.
 
+#### Custom mismatch errors
+
+To instruct Scientist to raise a custom error instead of the default `Scientist::Experiment::MismatchError`:
+
+```ruby
+class CustomMismatchError < Scientist::Experiment::MismatchError
+  def to_s
+    message = "There was a mismatch! Here's the diff:"
+
+    diffs = result.candidates.map do |candidate|
+      Diff.new(result.control, candidate)
+    end.join("\n")
+
+    "#{message}\n#{diffs}"
+  end
+end
+```
+
+```ruby
+science "widget-permissions" do |e|
+  e.use { Report.find(id) }
+  e.try { ReportService.new.fetch(id) }
+
+  e.raise_with CustomMismatchError
+end
+```
+
+This allows for pre-processing on mismatch error exception messages.
+
 ### Handling errors
 
 #### In candidate code

data/lib/scientist/experiment.rb

@@ -44,7 +44,7 @@ module Scientist::Experiment
         observation.exception.inspect.prepend("  ") + "\n" +
           observation.exception.backtrace.map { |line| line.prepend("    ") }.join("\n")
       else
-        observation.value.inspect.prepend("  ")
+        observation.cleaned_value.inspect.prepend("  ")
       end
     end
   end
@@ -176,6 +176,10 @@ module Scientist::Experiment
     false
   end
 
+  def raise_with(exception)
+    @_scientist_custom_mismatch_error = exception
+  end
+
   # Called when an exception is raised while running an internal operation,
   # like :publish. Override this method to track these exceptions. The
   # default implementation re-raises the exception.
@@ -223,7 +227,11 @@ module Scientist::Experiment
     end
 
     if raise_on_mismatches? && result.mismatched?
-      raise MismatchError.new(self.name, result)
+      if @_scientist_custom_mismatch_error
+        raise @_scientist_custom_mismatch_error.new(self.name, result)
+      else
+        raise MismatchError.new(self.name, result)
+      end
     end
 
     if control.raised?

data/lib/scientist/version.rb

@@ -1,3 +1,3 @@
 module Scientist
-  VERSION = "1.1.1"
+  VERSION = "1.1.2"
 end

data/test/scientist/experiment_test.rb

@@ -262,6 +262,19 @@ describe Scientist::Experiment do
     assert_equal "kaboom", exception.message
   end
 
+  describe "#raise_with" do
+    it "raises custom error if provided" do
+      CustomError = Class.new(Scientist::Experiment::MismatchError)
+
+      @ex.use { 1 }
+      @ex.try { 2 }
+      @ex.raise_with(CustomError)
+      @ex.raise_on_mismatches = true
+
+      assert_raises(CustomError) { @ex.run }
+    end
+  end
+
   describe "#run_if" do
     it "does not run the experiment if the given block returns false" do
       candidate_ran = false
@@ -392,6 +405,16 @@ describe Scientist::Experiment do
       assert_raises(Scientist::Experiment::MismatchError) { @ex.run }
     end
 
+    it "cleans values when raising on observation mismatch" do
+      Fake.raise_on_mismatches = true
+      @ex.use { "fine" }
+      @ex.try { "not fine" }
+      @ex.clean { "So Clean" }
+
+      err = assert_raises(Scientist::Experiment::MismatchError) { @ex.run }
+      assert_match /So Clean/, err.message
+    end
+
     it "doesn't raise when there is a mismatch if raise on mismatches is disabled" do
       Fake.raise_on_mismatches = false
       @ex.use { "fine" }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scientist
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - GitHub Open Source
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-06 00:00:00.000000000 Z
+date: 2018-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -55,6 +55,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - README.md