dat-science 1.2.0 → 1.2.1

data/README.md

@@ -126,7 +126,7 @@ end
 
 By default the results of an experiment are discarded. This isn't very useful.
 `Experiment#publish` can be overridden to publish results via any
-instrumentation mechansim, which makes it easy to graph durations or
+instrumentation mechanism, which makes it easy to graph durations or
 matches/mismatches and store results. The only two events published by an
 experiment are `:match` when the result of the control and candidate behaviors
 are the same, and `:mismatch` when they aren't.
@@ -201,10 +201,17 @@ end
 ```
 
 The results of the `control` and `candidate` blocks will be run through the
-`cleaner` You could get the same behavior by calling `count` in the blocks,
+`cleaner`. You could get the same behavior by calling `count` in the blocks,
 but the `cleaner` makes it easier to keep things in sync. The original
 `control` result is still returned.
 
+## What do I do with all these results?
+
+Once you've started an experiment and published some results, you'll want to
+analyze the mismatches from your experiment.  Check out
+[`dat-analysis`](https://github.com/github/dat-analysis) where you'll find an
+analysis toolkit to help you understand your experiment results.
+
 ## Hacking on science
 
 Be on a Unixy box. Make sure a modern Bundler is available. `script/test` runs

data/dat-science.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name          = "dat-science"
-  gem.version       = "1.2.0"
+  gem.version       = "1.2.1"
   gem.authors       = ["John Barnette", "Rick Bradley"]
   gem.email         = ["jbarnette@github.com"]
   gem.description   = "Gradually test, measure, and track refactored code."
@@ -12,6 +12,6 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep /^test/
   gem.require_paths = ["lib"]
 
-  gem.add_development_dependency "minitest"
-  gem.add_development_dependency "mocha"
+  gem.add_development_dependency "minitest", "~> 5.0.8"
+  gem.add_development_dependency "mocha",    "~> 0.14.0"
 end

data/lib/dat/science/experiment.rb

@@ -101,7 +101,7 @@ module Dat
           :first     => control_runs_first? ? :control : :candidate
         }
 
-        kind = control == candidate ? :match : :mismatch
+        kind = evaluate control, candidate
         publish_with_context kind, payload
 
         raise control.exception if control.raised?
@@ -109,6 +109,17 @@ module Dat
         control.value
       end
 
+      # Public: Determine the outcome of an experiment run
+      #
+      # control - result from running control method
+      # candidate - result from running candidate method
+      #
+      # Returns :match if control and candidate produced the same
+      # result, :mismatch otherwise.
+      def evaluate(control, candidate)
+        control == candidate ? :match : :mismatch
+      end
+
       protected
 
       # Internal: Does this experiment have candidate behavior?

data/lib/dat/science/result.rb

@@ -37,11 +37,20 @@ module Dat
       def payload
         {
           :duration  => duration,
-          :exception => exception,
+          :exception => serialized_exception,
           :value     => experiment.clean(value)
         }
       end
 
+      def serialized_exception
+        return nil unless exception
+        {
+          :class     => exception.class.name,
+          :message   => exception.message,
+          :backtrace => exception.backtrace
+        }
+      end
+
       def raised?
         !!exception
       end

data/test/dat_science_experiment_test.rb

@@ -1,7 +1,7 @@
 require "minitest/autorun"
 require "dat/science/experiment"
 
-class DatScienceExperimentTest < MiniTest::Unit::TestCase
+class DatScienceExperimentTest < MiniTest::Test
   class Experiment < Dat::Science::Experiment
     def self.published
       @published ||= []
@@ -257,4 +257,26 @@ class DatScienceExperimentTest < MiniTest::Unit::TestCase
     refute_nil payload[:control][:exception]
     refute_nil payload[:candidate][:exception]
   end
+
+  def test_publishes_exception_data
+    e = Experiment.new "foo"
+    e.control { raise "foo" }
+    e.candidate { raise "bar" }
+
+    assert_raises RuntimeError do
+      e.run
+    end
+
+    event, payload = Experiment.published.first
+    refute_nil event
+    refute_nil payload
+
+    assert_equal :mismatch, event
+    assert_equal 'foo',          payload[:control][:exception][:message]
+    assert_equal 'RuntimeError', payload[:control][:exception][:class]
+    refute_nil                   payload[:control][:exception][:backtrace]
+    assert_equal 'bar',          payload[:candidate][:exception][:message]
+    assert_equal 'RuntimeError', payload[:candidate][:exception][:class]
+    refute_nil                   payload[:candidate][:exception][:backtrace]
+  end
 end

data/test/dat_science_test.rb

@@ -2,7 +2,7 @@ require "minitest/autorun"
 require "mocha/setup"
 require "dat/science"
 
-class DatScienceTest < MiniTest::Unit::TestCase
+class DatScienceTest < MiniTest::Test
   def teardown
     Dat::Science.reset
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dat-science
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,40 +10,40 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-14 00:00:00.000000000 Z
+date: 2014-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.0.8
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.0.8
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.14.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.14.0
 description: Gradually test, measure, and track refactored code.
 email:
 - jbarnette@github.com