scientist 0.0.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 89ebfbe0cbc1c0de8e8247f59fac21a7ac547e96
-  data.tar.gz: 50b3ee5ed061c80af3ed1e10098acab524d82dc5
+  metadata.gz: c0c4363232ca282aeab9af989a6499a4aaa8eea8
+  data.tar.gz: 781901ba02fe3c35bc0ab79ed9a969998834a92a
 SHA512:
-  metadata.gz: 1c35cd1392cca5da51729d825f9b4b9e58ed3439247141438070ad5137de59600549e12a3eff4a0ed73ee19fa220de4cd66fe37eb2207df5f1a200b7cde532d4
-  data.tar.gz: 80cf84df09f69c2fb3f3f51b6fd72ca3a7d569b0a57c6d5a7dc48d48a597b7add4bbebea149d5dc2bef3aedc9ce5e02897c24285596d9cbbd912f68ec1919e0f
+  metadata.gz: 5d27e2fc8dc16c73253dcf66f22c21c73a589cdfd6f8cbf88337f88f8ae6cd40fa047e701c16440f20eca36aa644ca940fe6f321269a62d5e0808fb3e79bc43f
+  data.tar.gz: 063961175f72b277982ce4eb1bd9060a65a902a75c4a4735689202030534fe0fedeede28e6e67815c8d7e8a69af7bd979c7fcb41758790683045a73da21d90de

data/.travis.yml

@@ -4,4 +4,7 @@ cache: bundler
 script: script/test
 rvm:
   - 1.9.3
-  - 2.1.5
+  - 2.0.0
+  - 2.1.8
+  - 2.2.4
+before_install: gem install bundler

data/README.md

@@ -2,7 +2,7 @@
 
 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)
 
-## How do I do science?
+## How do I science?
 
 Let's pretend you're changing the way you handle permissions in a large web app. Tests can help guide your refactoring, but you really want to compare the current and refactored behaviors under load.
 
@@ -11,10 +11,9 @@ require "scientist"
 
 class MyWidget
   def allows?(user)
-    experiment = Scientist::Default.new "widget-permissions" do |e|
-      e.use { model.check_user?(user).valid? } # old way
-      e.try { user.can?(:read, model) } # new way
-    end
+    experiment = Scientist::Default.new "widget-permissions"
+    experiment.use { model.check_user?(user).valid? } # old way
+    experiment.try { user.can?(:read, model) } # new way
 
     experiment.run
   end
@@ -58,9 +57,12 @@ The examples above will run, but they're not really *doing* anything. The `try`
 ```ruby
 require "scientist"
 
-class MyExperiment < ActiveRecord::Base
+class MyExperiment
+  include ActiveModel::Model
   include Scientist::Experiment
 
+  attr_accessor :name
+
   def enabled?
     # see "Ramping up experiments" below
     super
@@ -73,8 +75,10 @@ class MyExperiment < ActiveRecord::Base
 end
 
 # replace `Scientist::Default` as the default implementation
-def Scientist::Experiment.new(name)
-  MyExperiment.find_or_initialize_by(name: name)
+module Scientist::Experiment
+  def self.new(name)
+    MyExperiment.new(name: name)
+  end
 end
 ```
 
@@ -289,8 +293,8 @@ class MyExperiment
       :name            => name,
       :context         => context,
       :control         => observation_payload(result.control),
-      :candidate       => observation_payload(result.candidates.first)
-      :execution_order => result.observations.map(&:name),
+      :candidate       => observation_payload(result.candidates.first),
+      :execution_order => result.observations.map(&:name)
     }
 
     key = "science.#{name}.mismatch"
@@ -301,8 +305,8 @@ class MyExperiment
   def observation_payload(observation)
     if observation.raised?
       {
-        :exception => observation.exeception.class,
-        :message   => observation.exeception.message,
+        :exception => observation.exception.class,
+        :message   => observation.exception.message,
         :backtrace => observation.exception.backtrace
       }
     else

data/lib/scientist/experiment.rb

@@ -5,6 +5,10 @@
 # implements Scientist::Experiment's interface.
 module Scientist::Experiment
 
+  # Whether to raise when the control and candidate mismatch.
+  # If this is nil, raise_on_mismatches class attribute is used instead.
+  attr_accessor :raise_on_mismatches
+
   # Create a new instance of a class that implements the Scientist::Experiment
   # interface.
   #
@@ -218,7 +222,7 @@ module Scientist::Experiment
       raised :publish, ex
     end
 
-    if self.class.raise_on_mismatches? && result.mismatched?
+    if raise_on_mismatches? && result.mismatched?
       raise MismatchError.new(self.name, result)
     end
 
@@ -269,4 +273,13 @@ module Scientist::Experiment
   def use(&block)
     try "control", &block
   end
+
+  # Whether or not to raise a mismatch error when a mismatch occurs.
+  def raise_on_mismatches?
+    if raise_on_mismatches.nil?
+      self.class.raise_on_mismatches?
+    else
+      !!raise_on_mismatches
+    end
+  end
 end

data/lib/scientist/version.rb

@@ -1,3 +1,3 @@
 module Scientist
-  VERSION = "0.0.4"
+  VERSION = "1.0.0"
 end

data/scientist.gemspec

@@ -4,8 +4,8 @@ Gem::Specification.new do |gem|
   gem.name          = "scientist"
   gem.description   = "A Ruby library for carefully refactoring critical paths"
   gem.version       = Scientist::VERSION
-  gem.authors       = ["John Barnette", "Rick Bradley"]
-  gem.email         = ["jbarnette@github.com", "rick@github.com"]
+  gem.authors       = ["GitHub Open Source", "John Barnette", "Rick Bradley", "Jesse Toth", "Nathan Witmer"]
+  gem.email         = ["opensource+scientist@github.com", "jbarnette@github.com", "rick@rickbradley.com", "jesseplusplus@github.com","zerowidth@github.com"]
   gem.summary       = "Carefully test, measure, and track refactored code."
   gem.homepage      = "https://github.com/github/scientist"
   gem.license       = "MIT"
@@ -15,5 +15,5 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(/^test/)
   gem.require_paths = ["lib"]
 
-  gem.add_development_dependency "minitest", "~> 5.2"
+  gem.add_development_dependency "minitest", "~> 5.8"
 end

data/test/scientist/experiment_test.rb

@@ -399,8 +399,7 @@ describe Scientist::Experiment do
       Fake.raise_on_mismatches = true
       @ex.use { raise "control" }
       @ex.try { "candidate" }
-      # assert_raises(Scientist::Experiment::MismatchError) { @ex.run }
-      @ex.run
+      assert_raises(Scientist::Experiment::MismatchError) { @ex.run }
     end
 
     it "raises a mismatch error if the candidate raises and the control doesn't" do
@@ -410,6 +409,38 @@ describe Scientist::Experiment do
       assert_raises(Scientist::Experiment::MismatchError) { @ex.run }
     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
+        @ex.raise_on_mismatches = true
+        @ex.use { "fine" }
+        @ex.try { "not fine" }
+
+        assert_raises(Scientist::Experiment::MismatchError) { @ex.run }
+      end
+
+      it "doesn't raise when there is a mismatch if the experiment instance's raise on mismatches is disabled" do
+        Fake.raise_on_mismatches = true
+        @ex.raise_on_mismatches = false
+        @ex.use { "fine" }
+        @ex.try { "not fine" }
+
+        assert_equal "fine", @ex.run
+      end
+
+      it "respects the raise_on_mismatches class attribute by default" do
+        Fake.raise_on_mismatches = false
+        @ex.use { "fine" }
+        @ex.try { "not fine" }
+
+        assert_equal "fine", @ex.run
+
+        Fake.raise_on_mismatches = true
+
+        assert_raises(Scientist::Experiment::MismatchError) { @ex.run }
+      end
+    end
+
     describe "MismatchError" do
       before do
         Fake.raise_on_mismatches = true

metadata

@@ -1,15 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: scientist
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 1.0.0
 platform: ruby
 authors:
+- GitHub Open Source
 - John Barnette
 - Rick Bradley
+- Jesse Toth
+- Nathan Witmer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-18 00:00:00.000000000 Z
+date: 2016-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -17,26 +20,27 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '5.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '5.8'
 description: A Ruby library for carefully refactoring critical paths
 email:
+- opensource+scientist@github.com
 - jbarnette@github.com
-- rick@github.com
+- rick@rickbradley.com
+- jesseplusplus@github.com
+- zerowidth@github.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
-- CLA.md
-- CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -76,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.2.3
 signing_key: 
 specification_version: 4
 summary: Carefully test, measure, and track refactored code.

data/CLA.md

@@ -1,54 +0,0 @@
-GitHub CLA
-===============
-
-## Don't give up - please go ahead and create this PR.
-
-We welcome you to follow, fork, and work on, our open source projects. If you want to contribute back to this project, or any other GitHub project, we need to ask you to complete the Contributor License Agreement (CLA) below. If you are contributing on behalf of your employer, or as part of your role as an employee, remember that you are signing in the name of your employer and you have to make sure that that's okay before you sign.
-
-## What is this?
-
-This is GitHub Inc.'s Contributor License Agreement. If you've worked in the technology space before, contributed or maintained an open source project, there's a good chance that you've run across one or more of these in the past. What CLAs aim to do is make sure the project is able to merge contributions from multiple contributors without getting itself into different types of trouble. This one is no different in that sense.
-
-## Why is this?
-
-The answer is that we need to protect the open source projects that we maintain, their users and their contributors (including Hubber contributors, of course, but not just). Why? Just imagine a case when a contributor is making a contribution to a project and that contribution is subsequently merged and becomes an integral part of the project. Now, go on to imagine that our contributor copied the code, or that this contributor works for a company that doesn't want its employees to make contributions to this project or any project. What then? Well, the person the code was copied from or the company can do whatever the hell they like, including to come after the project and its users if using it, make them stop or even sue. If either has patent rights in the code, the project is in even deeper trouble.
-
-
-## So.
-
-Please read the following terms, make sure you understand, and that if you agree, that you sign. Then, your pull request would be created and the project and the other contributors would be safe. It's important to us that you remember that except for the license you grant by signing this document - to GitHub, to your fellow contributors and to the project, you reserve all right, title, and interest in your contributions.
-
-### 1. Definitions.
-
-*You*, *you* (*Your*, or *your*) means the copyright owner or legal entity authorized by the copyright owner to sign this agreement.
-
-*Contribution* or *contribution* means any original work of authorship, including any modifications or additions to an existing work, that is submitted to a GitHub project. "Submitted" means via a Pull Request, an issue or any form of electronic, verbal, or written communication sent to GitHub.
-
-### 2. Grant of Copyright License.
-
-Subject to the terms and conditions of this agreement, you grant to GitHub, to fellow contributors and to the project a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, sublicense, and distribute your contributions and such derivative works.
-
-### 3. Grant of Patent License.
-
-Subject to the terms and conditions of this agreement, You hereby grant to GitHub, to fellow contributors to the project, and to its users a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer your contribution as part of the project, where such license applies only to those patent claims licensable by you that are necessarily infringed by your contribution or by combination of your contribution with the project to which this contribution was submitted. If any entity institutes patent litigation against you or any other entity (including a cross-claim or counterclaim in a lawsuit) alleging that your contribution, or the project to which you have contributed, constitutes direct or contributory patent infringement, then any patent licenses granted to that entity under this agreement for that contribution shall terminate as of the date such litigation is filed.
-
-### 4. You Can Grant this License.
-
-Signing would mean that you are legally entitled to grant the above license. If your employer(s) has rights to intellectual property that you create that includes your contributions, you have verified and are certain that you have received permission to make your contribution on behalf of that employer, that your employer has waived such rights for your contribution, or that your employer has executed a separate license with GitHub or the project.
-
-### 5. Your Contribution is Yours.
-
-Signing doesn't change the fact that your contribution is your original creation (see section 7 for submissions on behalf of others) and that they include complete details of any third-party license or other restriction (including related patents and trademarks) of which you are personally aware and which are associated with any part of your contributions.
-
-### 6. You Provide Your Contribution "as is".
-
-Signing this won't mean anybody will argue otherwise. In other words, your contributions are made without warranties or conditions of any kind.
-
-### 7. If Some or All Your Contributions Is Not Yours.
-
-That's fine but you need to identify the source or sources of the contribution and any license or other restriction (like related patents, trademarks, and license agreements) of which you are personally aware, and conspicuously marking the contribution as "Submitted on behalf of a third-party or third parties: [named here]". A place where you can do this is in a commit comment to the PR.
-
-### 8. If Any Circumstances of Your Contribution change.
-You agree to notify the project and GitHub of any facts or circumstances of which you become aware.
-
-### 9. That's it!

data/CONTRIBUTING.md

@@ -1,3 +0,0 @@
-Hi there! We're thrilled that you'd like to contribute to this project. Before you do, would you mind reading [this license agreement](CLA.md)? If you open a PR, we'll assume you agree to it. If you have any hesitation or disagreement, please do open a PR still, but note your concerns as well.
-
-Thanks!