split 0.6.2 → 0.6.3

data/.gitignore

@@ -4,3 +4,4 @@ Gemfile.lock
 pkg/*
 *.rbc
 .idea
+coverage

data/CHANGELOG.mdown

@@ -1,3 +1,13 @@
+## 0.6.3 (July 8, 2013)
+
+Features:
+
+  - Add hooks for Trial#choose! and Trial#complete! (@bmarini, #176)
+
+Bugfixes:
+
+  - Stores and parses Experiment's start_time as a UNIX integer (@joeroot, #177)
+
 ## 0.6.2 (June 6, 2013)
 
 Features:

data/README.mdown

@@ -9,7 +9,8 @@ Split is designed to be hacker friendly, allowing for maximum customisation and
 [![Gem Version](https://badge.fury.io/rb/split.png)](http://badge.fury.io/rb/split)
 [![Build Status](https://secure.travis-ci.org/andrew/split.png?branch=master)](http://travis-ci.org/andrew/split)
 [![Dependency Status](https://gemnasium.com/andrew/split.png)](https://gemnasium.com/andrew/split)
-[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/andrew/split)
+[![Code Climate](https://codeclimate.com/github/andrew/split.png)](https://codeclimate.com/github/andrew/split)
+[![Coverage Status](https://coveralls.io/repos/andrew/split/badge.png)](https://coveralls.io/r/andrew/split)
 
 ## Requirements
 
@@ -217,6 +218,35 @@ Split.configure do |config|
 end
 ```
 
+### Trial Event Hooks
+
+You can define methods that will be called at the same time as experiment
+alternative participation and goal completion.
+
+For example:
+
+``` ruby
+Split.configure do |config|
+  config.on_trial_choose   = :log_trial_choice
+  config.on_trial_complete = :log_trial_complete
+end
+```
+
+Set these attributes to a method name available in the same context as the
+`ab_test` method. These methods should accept one argument, a `Trial` instance.
+
+``` ruby
+def log_trial_choose(trial)
+  logger.info "experiment=%s alternative=%s user=%s" %
+    [ trial.experiment.name, trial.alternative, current_user.id ]
+end
+
+def log_trial_complete(trial)
+  logger.info "experiment=%s alternative=%s user=%s complete=true" %
+    [ trial.experiment.name, trial.alternative, current_user.id ]
+end
+```
+
 ## Web Interface
 
 Split comes with a Sinatra-based front end to get an overview of how your experiments are doing.
@@ -251,6 +281,17 @@ Split::Dashboard.use Rack::Auth::Basic do |username, password|
 end
 ```
 
+You can even use Devise or any other Warden-based authentication method to authorize users. Just replace `mount Split::Dashboard, :at => 'split'` in `config/routes.rb` with the following:
+```ruby
+match "/split" => Split::Dashboard, :anchor => false, :constraints => lambda { |request|
+  request.env['warden'].authenticated? # are we authenticated?
+  request.env['warden'].authenticate! # authenticate if not already
+  # or even check any other condition such as request.env['warden'].user.is_admin?
+}
+```
+
+More information on this [here](http://steve.dynedge.co.uk/2011/12/09/controlling-access-to-routes-and-rack-apps-in-rails-3-with-devise-and-warden/)
+
 ### Screenshot
 
 ![split_screenshot](https://f.cloud.github.com/assets/78887/306152/99c64650-9670-11e2-93f8-197f49495d02.png)

data/lib/split/configuration.rb

@@ -12,6 +12,8 @@ module Split
     attr_accessor :persistence
     attr_accessor :algorithm
     attr_accessor :store_override
+    attr_accessor :on_trial_choose
+    attr_accessor :on_trial_complete
 
     attr_reader :experiments
 

data/lib/split/experiment.rb

@@ -65,7 +65,7 @@ module Split
 
       if new_record?
         Split.redis.sadd(:experiments, name)
-        Split.redis.hset(:experiment_start_times, @name, Time.now)
+        Split.redis.hset(:experiment_start_times, @name, Time.now.to_i)
         @alternatives.reverse.each {|a| Split.redis.lpush(name, a.name)}
         @goals.reverse.each {|a| Split.redis.lpush(goals_key, a)} unless @goals.nil?
       else
@@ -157,7 +157,14 @@ module Split
 
     def start_time
       t = Split.redis.hget(:experiment_start_times, @name)
-      Time.parse(t) if t
+      if t
+        # Check if stored time is an integer
+        if t =~ /^[-+]?[0-9]+$/
+          t = Time.at(t.to_i)
+        else
+          t = Time.parse(t)
+        end
+      end
     end
 
     def next_alternative

data/lib/split/helper.rb

@@ -63,6 +63,8 @@ module Split
         alternative_name = ab_user[experiment.key]
         trial = Trial.new(:experiment => experiment, :alternative => alternative_name, :goals => options[:goals])
         trial.complete!
+        call_trial_complete_hook(trial)
+
         if should_reset
           reset!(experiment)
         else
@@ -178,6 +180,7 @@ module Split
             ret = ab_user[experiment.key]
           else
             trial.choose!
+            call_trial_choose_hook(trial)
             ret = begin_experiment(experiment, trial.alternative.name)
           end
         end
@@ -186,6 +189,14 @@ module Split
       ret
     end
 
+    def call_trial_choose_hook(trial)
+      send(Split.configuration.on_trial_choose, trial) if Split.configuration.on_trial_choose
+    end
+
+    def call_trial_complete_hook(trial)
+      send(Split.configuration.on_trial_complete, trial) if Split.configuration.on_trial_complete
+    end
+
     def keys_without_experiment(keys, experiment_key)
       keys.reject { |k| k.match(Regexp.new("^#{experiment_key}(:finished)?$")) }
     end

data/lib/split/version.rb

@@ -1,6 +1,6 @@
 module Split
   MAJOR   = 0
   MINOR   = 6
-  PATCH   = 2
+  PATCH   = 3
   VERSION = [MAJOR, MINOR, PATCH].join('.')
 end

data/spec/configuration_spec.rb

@@ -151,7 +151,7 @@ describe Split::Configuration do
           let(:input) { '' }
 
           it "should raise an error" do
-            expect { @config.experiments = yaml }.to raise_error(/Experiments must be a Hash/)
+            expect { @config.experiments = yaml }.to raise_error
           end
         end
 
@@ -159,7 +159,7 @@ describe Split::Configuration do
           let(:input) { '---' }
 
           it "should raise an error" do
-            expect { @config.experiments = yaml }.to raise_error(/Experiments must be a Hash/)
+            expect { @config.experiments = yaml }.to raise_error
           end
         end
       end

data/spec/experiment_spec.rb

@@ -44,7 +44,7 @@ describe Split::Experiment do
     end
 
     it "should save the start time to redis" do
-      experiment_start_time = Time.parse("Sat Mar 03 14:01:03")
+      experiment_start_time = Time.at(1372167761)
       Time.stub(:now => experiment_start_time)
       experiment.save
 
@@ -59,6 +59,15 @@ describe Split::Experiment do
       Split::Experiment.find('basket_text').algorithm.should == experiment_algorithm
     end
 
+    it "should handle having a start time stored as a string" do
+      experiment_start_time = Time.parse("Sat Mar 03 14:01:03")
+      Time.stub(:now => experiment_start_time)
+      experiment.save
+      Split.redis.hset(:experiment_start_times, experiment.name, experiment_start_time)
+
+      Split::Experiment.find('basket_text').start_time.should == experiment_start_time
+    end
+
     it "should handle not having a start time" do
       experiment_start_time = Time.parse("Sat Mar 03 14:01:03")
       Time.stub(:now => experiment_start_time)

data/spec/helper_spec.rb

@@ -20,11 +20,11 @@ describe Split::Helper do
     end
 
     it "should raise the appropriate error when passed integers for alternatives" do
-      lambda { ab_test('xyz', 1, 2, 3) }.should raise_error(ArgumentError)
+      lambda { ab_test('xyz', 1, 2, 3) }.should raise_error
     end
 
     it "should raise the appropriate error when passed symbols for alternatives" do
-      lambda { ab_test('xyz', :a, :b, :c) }.should raise_error(ArgumentError)
+      lambda { ab_test('xyz', :a, :b, :c) }.should raise_error
     end
 
     it "should not raise error when passed an array for goals" do
@@ -112,6 +112,14 @@ describe Split::Helper do
       end
     end
 
+    context "when on_trial_choose is set" do
+      before { Split.configuration.on_trial_choose = :some_method }
+      it "should call the method" do
+        self.should_receive(:some_method)
+        ab_test('link_color', 'blue', 'red')
+      end
+    end
+
     it "should allow passing a block" do
       alt = ab_test('link_color', 'blue', 'red')
       ret = ab_test('link_color', 'blue', 'red') { |alternative| "shared/#{alternative}" }
@@ -247,6 +255,14 @@ describe Split::Helper do
       doing_other_tests?(@experiment.key).should be false
     end
 
+    context "when on_trial_complete is set" do
+      before { Split.configuration.on_trial_complete = :some_method }
+      it "should call the method" do
+        self.should_receive(:some_method)
+        finished(@experiment_name)
+      end
+    end
+
   end
 
   context "finished with config" do
@@ -273,7 +289,7 @@ describe Split::Helper do
       alts = Split.configuration.experiments[experiment_name][:alternatives]
       experiment = Split::Experiment.find_or_create(experiment_name, *alts)
       alt_name = ab_user[experiment.key] = alts.first
-      alt = mock('alternative')
+      alt = double('alternative')
       alt.stub(:name).and_return(alt_name)
       Split::Alternative.stub(:new).with(alt_name, experiment_name.to_s).and_return(alt)
       if should_finish
@@ -588,7 +604,7 @@ describe Split::Helper do
         it 'should raise an exception' do
           lambda {
             ab_test('link_color', 'blue', 'red')
-          }.should raise_error(Errno::ECONNREFUSED)
+          }.should raise_error
         end
       end
 
@@ -596,7 +612,7 @@ describe Split::Helper do
         it 'should raise an exception' do
           lambda {
             finished('link_color')
-          }.should raise_error(Errno::ECONNREFUSED)
+          }.should raise_error
         end
       end
 
@@ -618,14 +634,14 @@ describe Split::Helper do
 
           lambda {
             ab_test('link_color', 'blue', 'red')
-          }.should_not raise_error(Errno::ECONNREFUSED)
+          }.should_not raise_error
         end
 
         it "should return control variable" do
           ab_test('link_color', 'blue', 'red').should eq('blue')
           lambda {
             finished('link_color')
-          }.should_not raise_error(Errno::ECONNREFUSED)
+          }.should_not raise_error
         end
 
       end
@@ -645,7 +661,7 @@ describe Split::Helper do
         it 'should not raise an exception' do
           lambda {
             ab_test('link_color', 'blue', 'red')
-          }.should_not raise_error(Errno::ECONNREFUSED)
+          }.should_not raise_error
         end
         it 'should call db_failover_on_db_error proc with error as parameter' do
           Split.configure do |config|
@@ -703,7 +719,7 @@ describe Split::Helper do
         it 'should not raise an exception' do
           lambda {
             finished('link_color')
-          }.should_not raise_error(Errno::ECONNREFUSED)
+          }.should_not raise_error
         end
         it 'should call db_failover_on_db_error proc with error as parameter' do
           Split.configure do |config|
@@ -817,16 +833,16 @@ describe Split::Helper do
 
     it "fails gracefully if config is missing experiment" do
       Split.configuration.experiments = { :other_experiment => { :foo => "Bar" } }
-      lambda { ab_test :my_experiment }.should raise_error(/not found/i)
+      lambda { ab_test :my_experiment }.should raise_error
     end
 
     it "fails gracefully if config is missing" do
-      lambda { Split.configuration.experiments = nil }.should raise_error(/Experiments must be a Hash/)
+      lambda { Split.configuration.experiments = nil }.should raise_error
     end
 
     it "fails gracefully if config is missing alternatives" do
       Split.configuration.experiments[:my_experiment] = { :foo => "Bar" }
-      lambda { ab_test :my_experiment }.should raise_error(/alternatives/i)
+      lambda { ab_test :my_experiment }.should raise_error
     end
   end
 

data/spec/persistence/cookie_adapter_spec.rb

@@ -2,7 +2,7 @@ require "spec_helper"
 
 describe Split::Persistence::CookieAdapter do
 
-  let(:context) { mock(:cookies => CookiesMock.new) }
+  let(:context) { double(:cookies => CookiesMock.new) }
   subject { Split::Persistence::CookieAdapter.new(context) }
 
   describe "#[] and #[]=" do

data/spec/persistence/session_adapter_spec.rb

@@ -2,7 +2,7 @@ require "spec_helper"
 
 describe Split::Persistence::SessionAdapter do
 
-  let(:context) { mock(:session => {}) }
+  let(:context) { double(:session => {}) }
   subject { Split::Persistence::SessionAdapter.new(context) }
 
   describe "#[] and #[]=" do

data/spec/persistence_spec.rb

@@ -18,7 +18,7 @@ describe Split::Persistence do
 
       it "should raise if the adapter cannot be found" do
         Split.configuration.stub(:persistence).and_return(:something_weird)
-        expect { subject.adapter }.to raise_error(Split::InvalidPersistenceAdapterError)
+        expect { subject.adapter }.to raise_error
       end
     end
     context "when the persistence config is a class" do

data/spec/spec_helper.rb

@@ -2,6 +2,10 @@ ENV['RACK_ENV'] = "test"
 
 require 'rubygems'
 require 'bundler/setup'
+
+require 'coveralls'
+Coveralls.wear!
+
 require 'split'
 require 'ostruct'
 require 'yaml'

data/spec/trial_spec.rb

@@ -3,8 +3,8 @@ require 'split/trial'
 
 describe Split::Trial do
   it "should be initializeable" do
-    experiment  = mock('experiment')
-    alternative = mock('alternative', :kind_of? => Split::Alternative)
+    experiment  = double('experiment')
+    alternative = double('alternative', :kind_of? => Split::Alternative)
     trial = Split::Trial.new(:experiment => experiment, :alternative => alternative)
     trial.experiment.should == experiment
     trial.alternative.should == alternative
@@ -13,8 +13,8 @@ describe Split::Trial do
 
   describe "alternative" do
     it "should use the alternative if specified" do
-      alternative = mock('alternative', :kind_of? => Split::Alternative)
-      trial = Split::Trial.new(:experiment => experiment = mock('experiment'), :alternative => alternative)
+      alternative = double('alternative', :kind_of? => Split::Alternative)
+      trial = Split::Trial.new(:experiment => experiment = double('experiment'), :alternative => alternative)
       trial.should_not_receive(:choose)
       trial.alternative.should == alternative
     end
@@ -39,8 +39,8 @@ describe Split::Trial do
 
 
     it "should choose from the available alternatives" do
-      trial = Split::Trial.new(:experiment => experiment = mock('experiment'))
-      alternative = mock('alternative', :kind_of? => Split::Alternative)
+      trial = Split::Trial.new(:experiment => experiment = double('experiment'))
+      alternative = double('alternative', :kind_of? => Split::Alternative)
       experiment.should_receive(:next_alternative).and_return(alternative)
       alternative.should_receive(:increment_participation)
       experiment.stub(:winner).and_return nil

data/split.gemspec

@@ -29,6 +29,7 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'rake'
   s.add_development_dependency 'bundler',     '~> 1.3'
-  s.add_development_dependency 'rspec',       '~> 2.12'
+  s.add_development_dependency 'rspec',       '~> 2.14'
   s.add_development_dependency 'rack-test',   '>= 0.5.7'
+  s.add_development_dependency 'coveralls'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: split
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-06 00:00:00.000000000 Z
+date: 2013-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -114,7 +114,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.12'
+        version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -122,7 +122,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.12'
+        version: '2.14'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
@@ -139,6 +139,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.5.7
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - andrewnez@gmail.com
@@ -247,3 +263,4 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/cookies_mock.rb
 - spec/trial_spec.rb
+has_rdoc: