metry 2.0.5 → 2.1.0

data/radiant/example/features/metry.feature

@@ -29,7 +29,7 @@ Feature: Radiant support
   Scenario: Running an experiment
     Given a page at "/" containing:
       """
-      <r:metry:experiment name="header" method="mod_visitor">
+      <r:metry:experiment name="header" method="sequential">
       Hello!
       <r:alternative name="grumpy">
       Go away!
@@ -41,35 +41,17 @@ Feature: Radiant support
       """
     When I view "/"
     Then I should see "Hello!"
+    And visitor #1 should have experiment "header" with "control"
     When I am a new visitor
     And there is an empty Radiant cache
     And I view "/"
     Then I should see "Go away!"
+    And visitor #2 should have experiment "header" with "grumpy"
     When I am a new visitor
     And there is an empty Radiant cache
     And I view "/"
     Then I should see "Duh?"
-    Then there should be a tracking event "1":
-      | key | value |
-      | visitor | 1 |
-      | experiment:header | control |
-    Then there should be a tracking event "2":
-      | key | value |
-      | visitor | 2 |
-      | experiment:header | grumpy |
-    Then there should be a tracking event "3":
-      | key | value |
-      | visitor | 3 |
-      | experiment:header | dopey |
-    Then there should be a visitor "1":
-      | key | value |
-      | experiment:header | control |
-    Then there should be a visitor "2":
-      | key | value |
-      | experiment:header | grumpy |
-    Then there should be a visitor "3":
-      | key | value |
-      | experiment:header | dopey |
+    And visitor #3 should have experiment "header" with "dopey"
       
   Scenario: Multiple access by same visitor should give same result
     Given a page at "/" containing:
@@ -81,35 +63,35 @@ Feature: Radiant support
       </r:alternative>
       </r:metry:experiment>
       """
-    When I view "/" 10 times
-    Then I should see the same "switch" alternative 10 times
+    When I view "/"
+    Then I should see the same page 10 times
     When I am a new visitor
-    And I view "/" 10 times
-    Then I should see the same "switch" alternative 10 times
+    And I view "/"
+    Then I should see the same page 10 times
     When I am a new visitor
-    And I view "/" 10 times
-    Then I should see the same "switch" alternative 10 times
+    And I view "/"
+    Then I should see the same page 10 times
     When I am a new visitor
-    And I view "/" 10 times
-    Then I should see the same "switch" alternative 10 times
+    And I view "/"
+    Then I should see the same page 10 times
   
   Scenario: Caching shouldn't interfere with experiments
     Given a page at "/" containing:
       """
-      <r:metry:experiment name="cached" method="mod_visitor">
+      <r:metry:experiment name="cached" method="sequential">
       Sweet
       <r:alternative name="two">
       Sour
       </r:alternative>
       </r:metry:experiment>
       """
-    When I view "/" 2 times
-    Then there should be a tracking event "1":
-      | key | value |
-      | experiment:cached | control |
-    Then there should be a tracking event "2":
-      | key | value |
-      | experiment:cached | control |
+    When I view "/"
+    Then visitor #1 should have experiment "cached" with "control"
+    And I should see "Sweet"
+    When I am a new visitor
+    And I view "/"
+    Then visitor #2 should have experiment "cached" with "two"
+    And I should see "Sour"
   
   Scenario: rand method should give reasonable experiment distribution
     Given a page at "/" containing:
@@ -131,8 +113,4 @@ Feature: Radiant support
       </r:metry:experiment>
       """
     When 100 visitors view "/"
-    Then at least 10 should see alternative "control" of experiment "lots"
-    Then at least 10 should see alternative "alt1" of experiment "lots"
-    Then at least 10 should see alternative "alt2" of experiment "lots"
-    Then at least 10 should see alternative "alt3" of experiment "lots"
-    Then at least 10 should see alternative "alt4" of experiment "lots"
+    Then there should be 5 alternatives each displayed at least 8 times

data/radiant/example/features/step_definitions/tracking.rb

@@ -1,43 +1,75 @@
 Given /^an empty tracking database$/ do
-  Metry.current.clear
+  Metry.clear
 end
 
 Then /^there should be (\d+) tracking events?$/ do |event_count|
-  assert_equal(event_count.to_i, Metry.current.event_count)
+  assert_equal(event_count.to_i, Metry::Event.count)
 end
 
 Then /^there should be (\d+) visitors$/ do |visitor_count|
-  assert_equal(visitor_count.to_i, Metry.current.visitor_count)
+  assert_equal(visitor_count.to_i, Metry::Visitor.count)
 end
 
-When /^there should be a tracking event "(\d+)":$/ do |id, table|
-  event = Metry.current.event(id)
-  assert event, "Unable to lookup event #{id}."
-  table.hashes.each do |hash|
-    expected = hash["value"]
+Then /^tracking event #(\d+) should contain:$/ do |index, table|
+  event = at(Metry::Event, index)
+  assert event, "Unable to lookup event at #{index}."
+  table.rows_hash.each do |key, expected|
     case expected
     when "_exists_"
-      assert event[hash["key"]], "Key #{hash["key"]} does not exist."
+      assert event.send(key), "Key #{key} does not exist."
     else
-      assert_equal expected, event[hash["key"]], "Key #{hash["key"]} does not match."
+      assert_equal expected, event.send(key), "Key #{key} does not match."
     end
   end
 end
 
-Then /^there should be a visitor "([^\"]*)":$/ do |id, table|
-  visitor = Metry.current.visitor(id)
-  assert visitor, "Unable to lookup visitor #{id}."
-  table.hashes.each do |hash|
-    expected = hash["value"]
-    case expected
-    when "_exists_"
-      assert visitor[hash["key"]], "Key #{hash["key"]} does not exist."
-    else
-      assert_equal expected, visitor[hash["key"]], "Key #{hash["key"]} does not match."
-    end
+Then /^tracking event #(\d+) extra should contain:$/ do |index, table|
+  event = at(Metry::Event, index)
+  table.rows_hash.each do |key, expected|
+    assert_equal expected, event.extra[key]
   end
 end
 
-Then /^there should be a visitor "([^\"]*)"$/ do |id|
-  assert Metry.current.visitor(id)
-end
+Then /^there should be a tracking event #(\d+) with visitor #(\d+)$/ do |event_index, visitor_index|
+  event = at(Metry::Event, event_index)
+  visitor = at(Metry::Visitor, visitor_index)
+  assert_equal event.visitor, visitor
+end
+
+Then /^there should be a visitor #(\d+)$/ do |index|
+  assert at(Metry::Visitor, index)
+end
+
+Then /^visitor #(\d+) should have experiment "([^\"]*)" with "([^\"]*)"$/ do |index, experiment, alternative|
+  visitor = at(Metry::Visitor, index)
+  experiment = Metry::Experiment.find(:first, :conditions => {:name => experiment})
+  assert experiment.cohort_for(visitor)
+end
+
+Then /^event #(\d+) should have experiment "([^\"]*)" with "([^\"]*)"$/ do |index, experiment, alternative|
+  event = at(Metry::Event, index)
+  experiment = Metry::Experiment.find(:first, :conditions => {:name => experiment})
+  assert_equal alternative, event.experiments[experiment.id]
+end
+
+Then /^I should see the same page (\d+) times$/ do |count|
+  expected_body = webrat.response_body
+  count.to_i.times do
+    When(%(I view "#{current_url}"))
+    assert_equal expected_body, webrat.response_body
+  end
+end
+
+When /^(\d+) visitors view "([^\"]*)"$/ do |count, path|
+  @alternatives = Hash.new(0)
+  count.to_i.times do
+    visit(path)
+    @alternatives[webrat.response_body] += 1
+    clear_cookies
+  end
+end
+
+Then /^there should be (\d+) alternatives each displayed at least (\d+) times$/ do |alternatives, minimum|
+  assert_equal alternatives.to_i, @alternatives.size
+  assert @alternatives.values.all?{|e| e >= minimum.to_i}
+end

data/radiant/example/features/step_definitions/web.rb

@@ -6,13 +6,6 @@ When /^I view "([^\"]*)"$/ do |path|
   visit(path)
 end
 
-When /^(\d+) visitors view "([^\"]*)"$/ do |count, path|
-  count.to_i.times do
-    visit(path)
-    clear_cookies
-  end
-end
-
 When /^I view "([^\"]*)" (\d+) times$/ do |path, count|
   count.to_i.times{visit(path)}
 end

data/radiant/example/features/support/env.rb

@@ -17,6 +17,13 @@ World(Test::Unit::Assertions)
 require 'rack/test'
 World(Rack::Test::Methods)
 
+module CustomRackTestSession
+  def rack_test_session
+    @_rack_test_session ||= Rack::Test::Session.new(app, "www.example.com")
+  end
+end
+World(CustomRackTestSession)
+
 $: << RAILS_ROOT + '/../../vendor/webrat/lib'
 require 'webrat'
 require 'webrat/rack_test'
@@ -25,9 +32,6 @@ Webrat.configure do |config|
   config.mode = :rack_test
 end
 
-require 'metry'
-Metry::Storage.predictable_keys = true
-
 def app
   ActionController::Dispatcher.new
 end

data/radiant/example/features/support/helpers.rb

@@ -0,0 +1,6 @@
+module CucumberHelpers
+  def at(model, index)
+    model.find(:all, :order => 'created_at')[index.to_i-1]
+  end
+end
+World(CucumberHelpers)

data/radiant/extension/lib/metry_tags.rb

@@ -14,7 +14,9 @@ module MetryTags
   tag "metry:experiment" do |tag|
     control = tag.expand
     options = tag.locals.alternatives.merge("control" => control)
-    Metry::Experiment.new(tag.attr["name"], tag.locals.event, tag.locals.visitor).choose(options, tag.attr["method"])
+    experiment = Metry::Experiment.find_or_create_by_name(tag.attr["name"])
+    alternative = experiment.choose(options.keys, tag.attr["method"], tag.locals.event, tag.locals.visitor)
+    options[alternative]
   end
   
   desc %{ Alternatives go in here with a name. }

data/test/shared.rb

@@ -3,4 +3,6 @@ $: << File.dirname(__FILE__) + '/../lib'
 require 'metry'
 
 require 'test/unit'
-require 'shoulda'
+require 'shoulda'
+
+Metry.init 'test'

data/test/test_experiment.rb

@@ -0,0 +1,104 @@
+require File.dirname(__FILE__) + '/shared'
+
+class TestExperiment < Test::Unit::TestCase
+  context "Goldilocks experiment" do
+    setup do
+      Metry.clear
+      @experiment = Metry::Experiment.create(:name => "Goldilocks")
+    end
+
+    should "be able to create and find experiment" do
+      e = reload(@experiment)
+      assert_equal @experiment, e
+      assert_equal "Goldilocks", e.name
+    end
+    
+    should "be able to find or create experiment" do
+      assert_equal @experiment, Metry::Experiment.find_or_create_by_name("Goldilocks")
+      assert_not_equal @experiment, Metry::Experiment.find_or_create_by_name("Three Little Pigs")
+    end
+  
+    should "be able to lookup a cohort" do
+      assert_equal 0, @experiment.cohorts.count
+
+      c1 = @experiment.lookup_cohort("Daddy bear")
+      c2 = @experiment.lookup_cohort("Momma bear")
+      
+      e = reload(@experiment)
+      assert_equal 2, e.cohorts.count
+      assert e.cohorts.include?(c1)
+      assert e.cohorts.include?(c2)
+      
+      assert_equal c1, @experiment.lookup_cohort("Daddy bear")
+      assert_equal 2, e.cohorts.count
+    end
+    
+    context "with existing cohorts" do
+      setup do
+        @daddy_cohort = @experiment.lookup_cohort("Daddy bear")
+        @momma_cohort = @experiment.lookup_cohort("Momma bear")
+        @baby_cohort = @experiment.lookup_cohort("Baby bear")
+      end
+
+      should "be able to associate visitors with a cohort" do
+        v1 = Metry::Visitor.create
+        v2 = Metry::Visitor.create
+        
+        v1.in_cohort @daddy_cohort
+        v2.in_cohort @momma_cohort
+        
+        daddy = reload(@daddy_cohort)
+        assert daddy.visitors.include?(v1)
+        assert v1.cohorts.include?(daddy)
+        
+        momma = reload(@momma_cohort)
+        assert momma.visitors.include?(v2)
+        assert v2.cohorts.include?(momma)
+      end
+      
+      should "be able to tell which cohort a visitor is in for a given experiment" do
+        v1 = Metry::Visitor.create
+        v1.in_cohort @daddy_cohort        
+        assert_equal @daddy_cohort, @experiment.cohort_for(v1)
+      end
+
+      context "with visitors with events" do
+        setup do
+          @experiment.goals << (@goal = Metry::Goal.create(:name => "porridge", :path => "bowl/?"))
+          @v1 = Metry::Visitor.create; @v1.in_cohort @daddy_cohort
+          @v2 = Metry::Visitor.create; @v2.in_cohort @daddy_cohort
+          @v3 = Metry::Visitor.create; @v3.in_cohort @daddy_cohort
+          @v4 = Metry::Visitor.create; @v4.in_cohort @momma_cohort
+          Metry::Event.create(:path => "bowl",  :visitor => @v1)
+          Metry::Event.create(:path => "bowl/", :visitor => @v2)
+          Metry::Event.create(:path => "bowl/", :visitor => @v2)
+          Metry::Event.create(:path => "sheet", :visitor => @v3)
+          Metry::Event.create(:path => "sheet", :visitor => @v4)
+        end
+
+        should "be able to find visitors that have reached a goal" do
+          assert_equal [@v1, @v2].sort_by{|e| e.id}, reload(@goal).visitors.sort_by{|e| e.id}
+        end
+
+        should "be able to calculate cohort/goal percentages" do
+          assert_equal((2.0/3.0), @daddy_cohort.reached_goal(@goal))
+          assert_equal 0, @momma_cohort.reached_goal(@goal)
+        end    
+      end
+
+    end
+
+    should "be able to add goals" do
+      @experiment.goals << (g1 = Metry::Goal.create(:name => "porridge", :path => "bowl"))
+      @experiment.goals << (g2 = Metry::Goal.create(:name => "bed", :path => "sheet"))
+    
+      ex = reload(@experiment)
+      assert ex.goals.include?(g1)
+      assert ex.goals.include?(g2)
+    end    
+  end
+
+  def reload(model)
+    model.class.find(model.id)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: metry
 version: !ruby/object:Gem::Version 
-  version: 2.0.5
+  version: 2.1.0
 platform: ruby
 authors: 
 - Nathaniel Talbott
@@ -9,9 +9,39 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-09 00:00:00 -04:00
+date: 2009-08-13 00:00:00 -04:00
 default_executable: 
 dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mongomapper
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0.3"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mongodb-mongo
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0.10"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mongodb-mongo_ext
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0.4"
+    version: 
 - !ruby/object:Gem::Dependency 
   name: hoe
   type: :development
@@ -45,24 +75,30 @@ files:
 - features/app_tracking.feature
 - features/basic_tracking.feature
 - features/psycho/dashboard.feature
-- features/psycho/goals.feature
+- features/psycho/experiments.feature
 - features/psycho/visitor_tracking.feature
 - features/sample_application.feature
-- features/step_definitions/goals.rb
+- features/step_definitions/experiments.rb
+- features/step_definitions/psycho.rb
 - features/step_definitions/tracking.rb
 - features/step_definitions/web.rb
 - features/support/env.rb
+- features/support/helpers.rb
 - lib/metry.rb
+- lib/metry/cohort.rb
+- lib/metry/event.rb
 - lib/metry/experiment.rb
+- lib/metry/goal.rb
 - lib/metry/psycho.rb
 - lib/metry/psycho/dashboard.erb
 - lib/metry/psycho/edit_goal.erb
-- lib/metry/psycho/goal.erb
+- lib/metry/psycho/experiment.erb
 - lib/metry/psycho/layout.erb
 - lib/metry/psycho/new_goal.erb
 - lib/metry/psycho/visitor.erb
+- lib/metry/psycho/visitors.erb
 - lib/metry/rack/tracking.rb
-- lib/metry/storage.rb
+- lib/metry/visitor.rb
 - radiant/example/CHANGELOG
 - radiant/example/CONTRIBUTORS
 - radiant/example/INSTALL
@@ -80,11 +116,11 @@ files:
 - radiant/example/db/schema.rb
 - radiant/example/features/metry.feature
 - radiant/example/features/psycho.feature
-- radiant/example/features/step_definitions/experiments.rb
 - radiant/example/features/step_definitions/radiant.rb
 - radiant/example/features/step_definitions/tracking.rb
 - radiant/example/features/step_definitions/web.rb
 - radiant/example/features/support/env.rb
+- radiant/example/features/support/helpers.rb
 - radiant/example/public/.htaccess
 - radiant/example/public/404.html
 - radiant/example/public/500.html
@@ -151,7 +187,7 @@ files:
 - radiant/extension/lib/tasks/metry_extension_tasks.rake
 - radiant/extension/metry_extension.rb
 - test/shared.rb
-- test/test_storage.rb
+- test/test_experiment.rb
 - vendor/webrat/.document
 - vendor/webrat/History.txt
 - vendor/webrat/MIT-LICENSE.txt
@@ -385,4 +421,4 @@ signing_key:
 specification_version: 2
 summary: Metry aims to close the gap between knowing you ought to be making decisions based on hard data about how visitors are using your site, and actually doing it
 test_files: 
-- test/test_storage.rb
+- test/test_experiment.rb