split 0.4.0 → 0.4.1

data/.gitignore

@@ -2,4 +2,5 @@
 .bundle
 Gemfile.lock
 pkg/*
-*.rbc
+*.rbc
+.idea

data/CHANGELOG.mdown

@@ -1,3 +1,14 @@
+## 0.4.1 (April 6, 2012)
+
+Features:
+
+  - Added configuration option to disable Split testing (@ilyakatz, #45)
+
+Bugfixes:
+
+  - Fix weights for existing experiments (@andreas, #40)
+  - Fixed dashboard range error (@andrew, #42)
+
 ## 0.4.0 (March 7, 2012)
 
 **IMPORTANT**

data/README.mdown

@@ -182,6 +182,7 @@ You can override the default configuration options of Split like so:
       config.db_failover = true # handle redis errors gracefully
       config.db_failover_on_db_error = proc{|error| Rails.logger.error(error.message) }
       config.allow_multiple_experiments = true
+      config.enabled = true
     end
 
 ### DB failover solution
@@ -249,6 +250,10 @@ is configured.
   - [Split::Export](http://github.com/andrew/split-export) - easily export ab test data out of Split
   - [Split::Analytics](http://github.com/andrew/split-analytics) - push test data to google analytics
 
+## Screencast
+
+Ryan bates has produced an excellent 10 minute screencast about split on the Railscasts site: [A/B Testing with Split](http://railscasts.com/episodes/331-a-b-testing-with-split)
+
 ## Contributors
 
 Special thanks to the following people for submitting patches:
@@ -264,7 +269,7 @@ Report Issues/Feature requests on [GitHub Issues](http://github.com/andrew/split
 
 Tests can be ran with `rake spec`
 
-[![Build Status](https://secure.travis-ci.org/andrew/split.png?branch=master)](http://travis-ci.org/andrew/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)
 
 ### Note on Patches/Pull Requests
 

data/lib/split/configuration.rb

@@ -5,6 +5,7 @@ module Split
     attr_accessor :db_failover
     attr_accessor :db_failover_on_db_error
     attr_accessor :allow_multiple_experiments
+    attr_accessor :enabled
 
     def initialize
       @robot_regex = /\b(Baidu|Gigabot|Googlebot|libwww-perl|lwp-trivial|msnbot|SiteUptime|Slurp|WordPress|ZIBB|ZyBorg)\b/i
@@ -12,6 +13,7 @@ module Split
       @db_failover = false
       @db_failover_on_db_error = proc{|error|} # e.g. use Rails logger here
       @allow_multiple_experiments = false
+      @enabled = true
     end
   end
-end
+end

data/lib/split/dashboard/helpers.rb

@@ -19,7 +19,7 @@ module Split
     def confidence_level(z_score)
       return z_score if z_score.is_a? String
 
-      z = round(z_score.to_f, 3)
+      z = round(z_score.to_s.to_f, 3)
       if z > 0.0
         if z < 1.96
           'no confidence'

data/lib/split/experiment.rb

@@ -138,7 +138,7 @@ module Split
 
       if Split.redis.exists(name)
         if load_alternatives_for(name) == alts.map(&:name)
-          experiment = self.new(name, *load_alternatives_for(name))
+          experiment = self.new(name, *alternatives)
         else
           exp = self.new(name, *load_alternatives_for(name))
           exp.reset

data/lib/split/helper.rb

@@ -1,33 +1,14 @@
 module Split
   module Helper
     def ab_test(experiment_name, control, *alternatives)
-      puts 'WARNING: You should always pass the control alternative through as the second argument with any other alternatives as the third because the order of the hash is not preserved in ruby 1.8' if RUBY_VERSION.match(/1\.8/) && alternatives.length.zero?
-      begin
-        experiment = Split::Experiment.find_or_create(experiment_name, *([control] + alternatives))
-        if experiment.winner
-          ret = experiment.winner.name
-        else
-          if forced_alternative = override(experiment.name, experiment.alternative_names)
-            ret = forced_alternative
-          else
-            clean_old_versions(experiment)
-            begin_experiment(experiment) if exclude_visitor? or not_allowed_to_test?(experiment.key)
 
-            if ab_user[experiment.key] 
-              ret = ab_user[experiment.key]
+      puts 'WARNING: You should always pass the control alternative through as the second argument with any other alternatives as the third because the order of the hash is not preserved in ruby 1.8' if RUBY_VERSION.match(/1\.8/) && alternatives.length.zero?
+      ret = if Split.configuration.enabled
+              experiment_variable(alternatives, control, experiment_name)
             else
-              alternative = experiment.next_alternative
-              alternative.increment_participation
-              begin_experiment(experiment, alternative.name)
-              ret = alternative.name
+              control_variable(control)
             end
-          end
-        end
-      rescue Errno::ECONNREFUSED => e
-        raise unless Split.configuration.db_failover
-        Split.configuration.db_failover_on_db_error.call(e)
-        ret = Hash === control ? control.keys.first : control
-      end
+
       if block_given?
         if defined?(capture) # a block in a rails view
           block = Proc.new { yield(ret) }
@@ -42,7 +23,7 @@ module Split
     end
 
     def finished(experiment_name, options = {:reset => true})
-      return if exclude_visitor?
+      return if exclude_visitor? or !Split.configuration.enabled
       return unless (experiment = Split::Experiment.find(experiment_name))
       if alternative_name = ab_user[experiment.key]
         alternative = Split::Alternative.new(alternative_name, experiment_name)
@@ -76,7 +57,7 @@ module Split
     end
 
     def doing_other_tests?(experiment_key)
-      ab_user.keys.reject{|k| k == experiment_key}.length > 0
+      ab_user.keys.reject { |k| k == experiment_key }.length > 0
     end
 
     def clean_old_versions(experiment)
@@ -87,7 +68,7 @@ module Split
 
     def old_versions(experiment)
       if experiment.version > 0
-        ab_user.keys.select{|k| k.match(Regexp.new(experiment.name))}.reject{|k| k == experiment.key}
+        ab_user.keys.select { |k| k.match(Regexp.new(experiment.name)) }.reject { |k| k == experiment.key }
       else
         []
       end
@@ -104,5 +85,44 @@ module Split
         false
       end
     end
+
+
+    protected
+
+    def control_variable(control)
+      Hash === control ? control.keys.first : control
+    end
+
+    def experiment_variable(alternatives, control, experiment_name)
+      begin
+        experiment = Split::Experiment.find_or_create(experiment_name, *([control] + alternatives))
+        if experiment.winner
+          ret = experiment.winner.name
+        else
+          if forced_alternative = override(experiment.name, experiment.alternative_names)
+            ret = forced_alternative
+          else
+            clean_old_versions(experiment)
+            begin_experiment(experiment) if exclude_visitor? or not_allowed_to_test?(experiment.key)
+
+            if ab_user[experiment.key]
+              ret = ab_user[experiment.key]
+            else
+              alternative = experiment.next_alternative
+              alternative.increment_participation
+              begin_experiment(experiment, alternative.name)
+              ret = alternative.name
+            end
+          end
+        end
+      rescue Errno::ECONNREFUSED => e
+        raise unless Split.configuration.db_failover
+        Split.configuration.db_failover_on_db_error.call(e)
+        ret = control_variable(control)
+      end
+      ret
+    end
+
   end
+
 end

data/lib/split/version.rb

@@ -1,3 +1,3 @@
 module Split
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
 end

data/spec/configuration_spec.rb

@@ -9,5 +9,6 @@ describe Split::Configuration do
     config.db_failover.should be_false
     config.db_failover_on_db_error.should be_a Proc
     config.allow_multiple_experiments.should be_false
+    config.enabled.should be_true
   end
 end

data/spec/dashboard_helpers_spec.rb

@@ -6,7 +6,7 @@ include Split::DashboardHelpers
 describe Split::DashboardHelpers do
   describe 'confidence_level' do
     it 'should handle very small numbers' do
-      confidence_level(0.000000000000006).should eql('No Change')
+      confidence_level(Complex(2e-18, -0.03)).should eql('No Change')
     end
   end
 end

data/spec/experiment_spec.rb

@@ -28,7 +28,7 @@ describe Split::Experiment do
 
     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)
@@ -184,4 +184,23 @@ describe Split::Experiment do
       lambda { Split::Experiment.find_or_create('link_enabled', true, false) }.should raise_error
     end
   end
-end
+
+  describe 'specifying weights' do
+    it "should work for a new experiment" do
+      experiment = Split::Experiment.find_or_create('link_color', {'blue' => 1}, {'red' => 2 })
+
+      experiment.alternatives.map(&:weight).should == [1, 2]
+    end
+
+    it "should work for an existing experiment" do
+      experiment = Split::Experiment.find_or_create('link_color', 'blue', 'red')
+      experiment.save
+
+      same_experiment = Split::Experiment.find_or_create('link_color', {'blue' => 1}, {'red' => 2 })
+      same_experiment.alternatives.map(&:weight).should == [1, 2]
+    end
+  end
+
+
+
+end

data/spec/helper_spec.rb

@@ -85,7 +85,7 @@ describe Split::Helper do
       small = Split::Alternative.new('small', 'button_size')
       small.participant_count.should eql(0)
     end
-    
+
     it "should let a user participate in many experiment with allow_multiple_experiments option" do
       Split.configure do |config|
         config.allow_multiple_experiments = true
@@ -346,6 +346,37 @@ describe Split::Helper do
         end
       end
 
+      describe "disable split testing" do
+
+        before(:each) do
+          Split.configure do |config|
+            config.enabled = false
+          end
+        end
+
+        after(:each) do
+          Split.configure do |config|
+            config.enabled = true
+          end
+        end
+
+        it "should not attempt to connect to redis" do
+
+          lambda {
+            ab_test('link_color', 'blue', 'red')
+          }.should_not raise_error(Errno::ECONNREFUSED)
+        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)
+        end
+
+      end
+
+
     end
 
     context 'and db_failover config option is turned on' do
@@ -398,6 +429,7 @@ describe Split::Helper do
         end
       end
 
+
     end
 
   end

data/spec/spec_helper.rb

@@ -1,7 +1,10 @@
+ENV['RACK_ENV'] = "test"
+
 require 'rubygems'
 require 'bundler/setup'
 require 'split'
 require 'ostruct'
+require 'complex' if RUBY_VERSION.match(/1\.8/)
 
 def session
   @session ||= {}

data/split.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_dependency 'redis',           '~> 2.1'
-  s.add_dependency 'redis-namespace', '~> 1.0.3'
+  s.add_dependency 'redis-namespace', '~> 1.1.0'
   s.add_dependency 'sinatra',         '>= 1.2.6'
 
   s.add_development_dependency 'rake'

metadata

@@ -1,111 +1,154 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: split
-version: !ruby/object:Gem::Version
-  version: 0.4.0
+version: !ruby/object:Gem::Version 
+  hash: 13
   prerelease: 
+  segments: 
+  - 0
+  - 4
+  - 1
+  version: 0.4.1
 platform: ruby
-authors:
+authors: 
 - Andrew Nesbitt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-07 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2012-04-06 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: redis
-  requirement: &70291376942100 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.1'
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 2
+        - 1
+        version: "2.1"
   type: :runtime
-  prerelease: false
-  version_requirements: *70291376942100
-- !ruby/object:Gem::Dependency
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: redis-namespace
-  requirement: &70291376938960 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.0.3
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 1
+        - 1
+        - 0
+        version: 1.1.0
   type: :runtime
-  prerelease: false
-  version_requirements: *70291376938960
-- !ruby/object:Gem::Dependency
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
   name: sinatra
-  requirement: &70291376938260 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 1
+        - 2
+        - 6
         version: 1.2.6
   type: :runtime
-  prerelease: false
-  version_requirements: *70291376938260
-- !ruby/object:Gem::Dependency
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
   name: rake
-  requirement: &70291376937280 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
-  prerelease: false
-  version_requirements: *70291376937280
-- !ruby/object:Gem::Dependency
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
   name: bundler
-  requirement: &70291376930680 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.0'
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
   type: :development
-  prerelease: false
-  version_requirements: *70291376930680
-- !ruby/object:Gem::Dependency
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
   name: rspec
-  requirement: &70291376929580 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.6'
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 6
+        version: "2.6"
   type: :development
-  prerelease: false
-  version_requirements: *70291376929580
-- !ruby/object:Gem::Dependency
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
   name: rack-test
-  requirement: &70291376928420 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.6'
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 0
+        - 6
+        version: "0.6"
   type: :development
-  prerelease: false
-  version_requirements: *70291376928420
-- !ruby/object:Gem::Dependency
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
   name: guard-rspec
-  requirement: &70291376927240 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.4'
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        - 4
+        version: "0.4"
   type: :development
-  prerelease: false
-  version_requirements: *70291376927240
+  version_requirements: *id008
 description: 
-email:
+email: 
 - andrewnez@gmail.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - .travis.yml
 - CHANGELOG.mdown
@@ -136,31 +179,41 @@ files:
 - spec/helper_spec.rb
 - spec/spec_helper.rb
 - split.gemspec
+has_rdoc: true
 homepage: https://github.com/andrew/split
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: split
-rubygems_version: 1.8.11
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Rack based split testing framework
-test_files:
+test_files: 
 - spec/alternative_spec.rb
 - spec/configuration_spec.rb
 - spec/dashboard_helpers_spec.rb