dat-science 1.0.0 → 1.1.0

data/README.md

@@ -115,8 +115,8 @@ 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
 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.
+experiment are `:match` when the result of the control and candidate behaviors
+are the same, and `:mismatch` when they aren't.
 
 ```ruby
 def publish(event, payload)
@@ -129,6 +129,8 @@ The published `payload` is a Symbol-keyed Hash:
 ```ruby
 {
   :experiment => "widget-permissions",
+  :first      => :control,
+  :timestamp  => <a-Time-instance>,
 
   :candidate => {
     :duration  => 2.5,
@@ -140,32 +142,31 @@ The published `payload` is a Symbol-keyed Hash:
     :duration  => 25.0,
     :exception => nil,
     :value     => 24
-  },
-
-  :first => :control
+  }
 }
 ```
 
+`:experiment` is the name of the experiment. `:first` is either `:candidate` or
+`:control`, depending on which block was run first during the experiment.
+`:timestamp` is the Time when the experiment started.
+
 The `:candidate` and `:control` Hashes have the same keys:
 
 * `:duration` is the execution in ms, expressed as a float.
 * `:exception` is a reference to any raised exception or `nil`.
 * `:value` is the result of the block.
 
-`:first` is either `:candidate` or `:control`, depending on which block was run
-first during the experiment. `:experiment` is the name of the experiment.
-
 #### Adding context
 
 It's often useful to add more information to your results, and
 `Experiment#context` makes it easy:
 
 ```ruby
-science "widget-permissions" do |experiment|
-  experiment.context :user => user
+science "widget-permissions" do |e|
+  e.context :user => user
 
-  experiment.control   { model.check_user(user).valid? } # old way
-  experiment.candidate { user.can? :read, model } # new way
+  e.control   { model.check_user(user).valid? } # old way
+  e.candidate { user.can? :read, model } # new way
 end
 ```
 

data/dat-science.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name          = "dat-science"
-  gem.version       = "1.0.0"
+  gem.version       = "1.1.0"
   gem.authors       = ["John Barnette", "Rick Bradley"]
   gem.email         = ["jbarnette@github.com"]
   gem.description   = "Gradually test, measure, and track refactored code."

data/lib/dat/science/experiment.rb

@@ -50,6 +50,8 @@ module Dat
       def run
         return run_control unless candidate? && enabled?
 
+        timestamp = Time.now
+
         if control_runs_first?
           control   = observe_control
           candidate = observe_candidate
@@ -59,6 +61,7 @@ module Dat
         end
 
         payload = {
+          :timestamp => timestamp,
           :candidate => candidate.payload,
           :control   => control.payload,
           :first     => control_runs_first? ? :control : :candidate

data/test/dat_science_experiment_test.rb

@@ -106,6 +106,8 @@ class DatScienceExperimentTest < MiniTest::Unit::TestCase
     assert_equal "foo", payload[:experiment]
     assert_equal :control, payload[:first]
 
+    assert_in_delta Time.now.to_f, payload[:timestamp].to_f, 2.0
+
     assert payload[:control][:duration]
     assert_nil payload[:control][:exception]
     assert_equal :foo, payload[:control][:value]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dat-science
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors: