scientist 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7b1ce13f8a2483a8027f3252d79a962dd116733c
-  data.tar.gz: 54e81bb6123073b95c9bec0b1e751f88519fd498
+  metadata.gz: 613a01313617522a1af4515a526d8272c0f6cb77
+  data.tar.gz: eedb1a19d72a5833a088df4c971fdda221d03dfa
 SHA512:
-  metadata.gz: 5e97d816e8b340701d2a6488799f899ae74480992e223258615c96c6f19042d53a867680aada5cc010c5718fa499d31889056f111b9476b810ac74af2023b4d7
-  data.tar.gz: c65a04f83ef07d9c770354fc5a1dcfa1a76199f150152c0c39735839eec2cf975f333779418827c201d03b4e9047d9afcb740d1ac735a69004e2a945afafb5de
+  metadata.gz: 57f63ef2a49baba246d1b1fa0e7b378ff590a4a5a764aa23754e103c7f73f09ec7cc89f4ffaa07bfebc04da91f0c0215d8bf5d7eef1f8d18e19213a0ccad9078
+  data.tar.gz: 8790f2ccee4042604dad41e5dac7d0471629e8013af69458e7898c77628ba73dbcd93b76cd7a15a7ae5203fa02d3561dcab92fec3654c1f9ad3fc9f3766ed9a7

data/CLA.md

@@ -7,7 +7,7 @@ We welcome you to follow, fork, and work on, our open source projects. If you wa
 
 ## 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.
+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?
 

data/README.md

@@ -27,7 +27,7 @@ Wrap a `use` block around the code's original behavior, and wrap `try` around th
 * Randomizes the order in which `use` and `try` blocks are run,
 * Measures the durations of all behaviors,
 * Compares the result of `try` to the result of `use`,
-* Swallows (but records) any exceptions raise in the `try` block, and
+* Swallows (but records) any exceptions raised in the `try` block, and
 * Publishes all this information.
 
 The `use` block is called the **control**. The `try` block is called the **candidate**.

data/lib/scientist.rb

@@ -7,20 +7,22 @@ module Scientist
   # Define and run a science experiment.
   #
   # name - a String name for this experiment.
-  # run: - optional argument for which named test to run instead of "control".
+  # opts - optional hash with the the named test to run instead of "control",
+  #        :run is the only valid key.
   #
   # Yields an object which implements the Scientist::Experiment interface.
   # See `Scientist::Experiment.new` for how this is defined.
   #
   # Returns the calculated value of the control experiment, or raises if an
   # exception was raised.
-  def science(name, run: nil)
+  def science(name, opts = {})
     experiment = Experiment.new(name)
     experiment.context(default_scientist_context)
 
     yield experiment
 
-    experiment.run(run)
+    test = Hash(opts)[:run]
+    experiment.run(test)
   end
 
   # Public: the default context data for an experiment created and run via the

data/lib/scientist/experiment.rb

@@ -169,9 +169,7 @@ module Scientist::Experiment
 
     control = observations.detect { |o| o.name == name }
 
-    result = Scientist::Result.new self,
-      observations: observations,
-      control: control
+    result = Scientist::Result.new self, observations, control
 
     begin
       publish(result)

data/lib/scientist/result.rb

@@ -25,7 +25,7 @@ class Scientist::Result
   # observations: - an Array of Observations, in execution order
   # control:      - the control Observation
   #
-  def initialize(experiment, observations:, control:)
+  def initialize(experiment, observations = [], control = nil)
     @experiment   = experiment
     @observations = observations
     @control      = control
@@ -47,7 +47,7 @@ class Scientist::Result
 
   # Public: was the result a match between all behaviors?
   def matched?
-    mismatched.empty?
+    mismatched.empty? && !ignored?
   end
 
   # Public: were there mismatches in the behaviors?

data/lib/scientist/version.rb

@@ -1,3 +1,3 @@
 module Scientist
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/scientist.gemspec

@@ -10,8 +10,6 @@ Gem::Specification.new do |gem|
   gem.homepage      = "https://github.com/github/scientist"
   gem.license       = "MIT"
 
-  gem.required_ruby_version = ">= 2.1.0"
-
   gem.files         = `git ls-files`.split($/)
   gem.executables   = []
   gem.test_files    = gem.files.grep(/^test/)

data/test/scientist/result_test.rb

@@ -7,9 +7,7 @@ describe Scientist::Result do
     control = Scientist::Observation.new("control", @experiment)
     candidate = Scientist::Observation.new("candidate", @experiment)
 
-    result = Scientist::Result.new @experiment,
-      observations: [control, candidate], control: control
-
+    result = Scientist::Result.new @experiment, [control, candidate], control
     assert result.frozen?
   end
 
@@ -19,7 +17,7 @@ describe Scientist::Result do
 
     assert a.equivalent_to?(b)
 
-    result = Scientist::Result.new @experiment, observations: [a, b], control: a
+    result = Scientist::Result.new @experiment, [a, b], a
     assert result.matched?
     refute result.mismatched?
     assert_equal [], result.mismatched
@@ -28,7 +26,7 @@ describe Scientist::Result do
     y = Scientist::Observation.new("y", @experiment) { 2 }
     z = Scientist::Observation.new("z", @experiment) { 3 }
 
-    result = Scientist::Result.new @experiment, observations: [x, y, z], control: x
+    result = Scientist::Result.new @experiment, [x, y, z], x
     refute result.matched?
     assert result.mismatched?
     assert_equal [y, z], result.mismatched
@@ -36,7 +34,7 @@ describe Scientist::Result do
 
   it "has no mismatches if there is only a control observation" do
     a = Scientist::Observation.new("a", @experiment) { 1 }
-    result = Scientist::Result.new @experiment, observations: [a], control: a
+    result = Scientist::Result.new @experiment, [a], a
     assert result.matched?
   end
 
@@ -46,7 +44,7 @@ describe Scientist::Result do
 
     @experiment.compare { |x, y| x == y.to_s }
 
-    result = Scientist::Result.new @experiment, observations: [a, b], control: a
+    result = Scientist::Result.new @experiment, [a, b], a
 
     assert result.matched?, result.mismatched
   end
@@ -55,7 +53,7 @@ describe Scientist::Result do
     x = Scientist::Observation.new("x", @experiment) { 1 }
     y = Scientist::Observation.new("y", @experiment) { 2 }
 
-    result = Scientist::Result.new @experiment, observations: [x, y], control: x
+    result = Scientist::Result.new @experiment, [x, y], x
 
     assert result.mismatched?
     refute result.ignored?
@@ -67,9 +65,10 @@ describe Scientist::Result do
     called = false
     @experiment.ignore { called = true }
 
-    result = Scientist::Result.new @experiment, observations: [x, y], control: x
+    result = Scientist::Result.new @experiment, [x, y], x
 
     refute result.mismatched?
+    refute result.matched?
     assert result.ignored?
     assert_equal [], result.mismatched
     assert_equal [y], result.ignored
@@ -83,7 +82,7 @@ describe Scientist::Result do
 
     @experiment.ignore { |control, candidate| candidate == :y }
 
-    result = Scientist::Result.new @experiment, observations: [x, y, z], control: x
+    result = Scientist::Result.new @experiment, [x, y, z], x
 
     assert result.mismatched?
     assert result.ignored?
@@ -94,7 +93,7 @@ describe Scientist::Result do
   it "knows the experiment's name" do
     a = Scientist::Observation.new("a", @experiment) { 1 }
     b = Scientist::Observation.new("b", @experiment) { 1 }
-    result = Scientist::Result.new @experiment, observations: [a, b], control: a
+    result = Scientist::Result.new @experiment, [a, b], a
 
     assert_equal @experiment.name, result.experiment_name
   end
@@ -103,7 +102,7 @@ describe Scientist::Result do
     @experiment.context :foo => :bar
     a = Scientist::Observation.new("a", @experiment) { 1 }
     b = Scientist::Observation.new("b", @experiment) { 1 }
-    result = Scientist::Result.new @experiment, observations: [a, b], control: a
+    result = Scientist::Result.new @experiment, [a, b], a
 
     assert_equal({:foo => :bar}, result.context)
   end

data/test/scientist_test.rb

@@ -42,4 +42,18 @@ describe Scientist do
     assert_equal true, experiment.context[:default]
     assert_equal true, experiment.context[:inline]
   end
+
+  it "runs the named test instead of the control" do
+    obj = Object.new
+    obj.extend(Scientist)
+
+    result = obj.science "test", run: "first-way" do |e|
+      experiment = e
+
+      e.try("first-way") { true }
+      e.try("second-way") { true }
+    end
+
+    assert_equal true, result
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scientist
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - John Barnette
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-18 00:00:00.000000000 Z
+date: 2014-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -67,7 +67,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="