split 0.4.5 → 0.4.6

data/CHANGELOG.mdown

@@ -1,3 +1,14 @@
+## 0.4.6 (October 28, 2012)
+
+Features:
+
+  - General code quality improvements (@buddhamagnet, #79)
+
+Bugfixes:
+
+  - Don't increment the experiment counter if user has finished (@dimko, #78)
+  - Fixed an incorrect test (@jaywengrow, #74)
+
 ## 0.4.5 (August 30, 2012)
 
 Bugfixes:

data/lib/split.rb

@@ -3,6 +3,7 @@ require 'split/alternative'
 require 'split/helper'
 require 'split/version'
 require 'split/configuration'
+require 'split/engine' if defined?(Rails)
 require 'redis/namespace'
 
 module Split
@@ -18,7 +19,7 @@ module Split
   #      or `Redis::Namespace`.
   def redis=(server)
     if server.respond_to? :split
-      if server =~ /redis\:\/\//
+      if server["redis://"]
         redis = Redis.connect(:url => server, :thread_safe => true)
       else
         server, namespace = server.split('/', 2)
@@ -56,11 +57,4 @@ module Split
    end
 end
 
-Split.configure {}
-
-if defined?(Rails)
-  class ActionController::Base
-    ActionController::Base.send :include, Split::Helper
-    ActionController::Base.helper Split::Helper
-  end
-end
+Split.configure {}

data/lib/split/engine.rb

@@ -0,0 +1,8 @@
+module Split
+  class Engine < ::Rails::Engine
+    initializer "split" do |app|
+      ActionController::Base.send :include, Split::Helper
+      ActionController::Base.helper Split::Helper
+    end
+  end
+end

data/lib/split/experiment.rb

@@ -1,7 +1,6 @@
 module Split
   class Experiment
     attr_accessor :name
-    attr_accessor :winner
 
     def initialize(name, *alternative_names)
       @name = name.to_s
@@ -75,6 +74,10 @@ module Split
       end
     end
 
+    def finished_key
+      "#{key}:finished"
+    end
+
     def reset
       alternatives.each(&:reset)
       reset_winner

data/lib/split/helper.rb

@@ -1,8 +1,11 @@
 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?
+      
+      if RUBY_VERSION.match(/1\.8/) && alternatives.length.zero?
+        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'
+      end
+      
       ret = if Split.configuration.enabled
               experiment_variable(alternatives, control, experiment_name)
             else
@@ -25,10 +28,17 @@ module Split
     def finished(experiment_name, options = {:reset => true})
       return if exclude_visitor? or !Split.configuration.enabled
       return unless (experiment = Split::Experiment.find(experiment_name))
+      return if !options[:reset] && ab_user[experiment.finished_key]
+
       if alternative_name = ab_user[experiment.key]
         alternative = Split::Alternative.new(alternative_name, experiment_name)
         alternative.increment_completion
-        ab_user.delete(experiment.key) if options[:reset]
+
+        if options[:reset]
+          ab_user.delete(experiment.key)
+        else
+          ab_user[experiment.finished_key] = true
+        end
       end
     rescue => e
       raise unless Split.configuration.db_failover

data/lib/split/version.rb

@@ -1,3 +1,6 @@
 module Split
-  VERSION = "0.4.5"
+  MAJOR = 0
+  MINOR = 4
+  TINY  = 6
+  VERSION = [MAJOR, MINOR, TINY].join('.')
 end

data/spec/experiment_spec.rb

@@ -55,7 +55,7 @@ describe Split::Experiment do
 
       experiment.delete
       Split.redis.exists('basket_text').should be false
-      Split::Experiment.find('link_color').should be_nil
+      Split::Experiment.find('basket_text').should be_nil
     end
 
     it "should increment the version" do

data/spec/helper_spec.rb

@@ -99,61 +99,55 @@ describe Split::Helper do
   end
 
   describe 'finished' do
-    it 'should increment the counter for the completed alternative' do
-      experiment = Split::Experiment.find_or_create('link_color', 'blue', 'red')
-      alternative_name = ab_test('link_color', 'blue', 'red')
-
-      previous_completion_count = Split::Alternative.new(alternative_name, 'link_color').completed_count
+    before(:each) do
+      @experiment_name = 'link_color'
+      @alternatives = ['blue', 'red']
+      @experiment = Split::Experiment.find_or_create(@experiment_name, *@alternatives)
+      @alternative_name = ab_test(@experiment_name, *@alternatives)
+      @previous_completion_count = Split::Alternative.new(@alternative_name, @experiment_name).completed_count
+    end
 
-      finished('link_color')
+    it 'should increment the counter for the completed alternative' do
+      finished(@experiment_name)
+      new_completion_count = Split::Alternative.new(@alternative_name, @experiment_name).completed_count
+      new_completion_count.should eql(@previous_completion_count + 1)
+    end
 
-      new_completion_count = Split::Alternative.new(alternative_name, 'link_color').completed_count
+    it "should set experiment's finished key if reset is false" do
+      finished(@experiment_name, :reset => false)
+      session[:split].should eql(@experiment.key => @alternative_name, @experiment.finished_key => true)
+    end
 
-      new_completion_count.should eql(previous_completion_count + 1)
+    it 'should not increment the counter if reset is false and the experiment has been already finished' do
+      2.times { finished(@experiment_name, :reset => false) }
+      new_completion_count = Split::Alternative.new(@alternative_name, @experiment_name).completed_count
+      new_completion_count.should eql(@previous_completion_count + 1)
     end
 
     it "should clear out the user's participation from their session" do
-      experiment = Split::Experiment.find_or_create('link_color', 'blue', 'red')
-      alternative_name = ab_test('link_color', 'blue', 'red')
-
-      previous_completion_count = Split::Alternative.new(alternative_name, 'link_color').completed_count
-
-      session[:split].should eql("link_color" => alternative_name)
-      finished('link_color')
+      session[:split].should eql(@experiment.key => @alternative_name)
+      finished(@experiment_name)
       session[:split].should == {}
     end
 
     it "should not clear out the users session if reset is false" do
-      experiment = Split::Experiment.find_or_create('link_color', 'blue', 'red')
-      alternative_name = ab_test('link_color', 'blue', 'red')
-
-      previous_completion_count = Split::Alternative.new(alternative_name, 'link_color').completed_count
-
-      session[:split].should eql("link_color" => alternative_name)
-      finished('link_color', :reset => false)
-      session[:split].should eql("link_color" => alternative_name)
+      session[:split].should eql(@experiment.key => @alternative_name)
+      finished(@experiment_name, :reset => false)
+      session[:split].should eql(@experiment.key => @alternative_name, @experiment.finished_key => true)
     end
 
     it "should reset the users session when experiment is not versioned" do
-      experiment = Split::Experiment.find_or_create('link_color', 'blue', 'red')
-      alternative_name = ab_test('link_color', 'blue', 'red')
-
-      previous_completion_count = Split::Alternative.new(alternative_name, 'link_color').completed_count
-
-      session[:split].should eql(experiment.key => alternative_name)
-      finished('link_color', :reset => true)
+      session[:split].should eql(@experiment.key => @alternative_name)
+      finished(@experiment_name)
       session[:split].should eql({})
     end
 
     it "should reset the users session when experiment is versioned" do
-      experiment = Split::Experiment.find_or_create('link_color', 'blue', 'red')
-      experiment.increment_version
-      alternative_name = ab_test('link_color', 'blue', 'red')
-
-      previous_completion_count = Split::Alternative.new(alternative_name, 'link_color').completed_count
+      @experiment.increment_version
+      @alternative_name = ab_test(@experiment_name, *@alternatives)
 
-      session[:split].should eql(experiment.key => alternative_name)
-      finished('link_color', :reset => true)
+      session[:split].should eql(@experiment.key => @alternative_name)
+      finished(@experiment_name)
       session[:split].should eql({})
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: split
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.4.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-30 00:00:00.000000000 Z
+date: 2012-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
-  requirement: &70263359071460 !ruby/object:Gem::Requirement
+  requirement: &70093446916440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '2.1'
   type: :runtime
   prerelease: false
-  version_requirements: *70263359071460
+  version_requirements: *70093446916440
 - !ruby/object:Gem::Dependency
   name: redis-namespace
-  requirement: &70263359070960 !ruby/object:Gem::Requirement
+  requirement: &70093446931800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 1.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *70263359070960
+  version_requirements: *70093446931800
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &70263359070500 !ruby/object:Gem::Requirement
+  requirement: &70093446947900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 1.2.6
   type: :runtime
   prerelease: false
-  version_requirements: *70263359070500
+  version_requirements: *70093446947900
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70263359070120 !ruby/object:Gem::Requirement
+  requirement: &70093446950180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70263359070120
+  version_requirements: *70093446950180
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70263359069580 !ruby/object:Gem::Requirement
+  requirement: &70093447002840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *70263359069580
+  version_requirements: *70093447002840
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70263359069080 !ruby/object:Gem::Requirement
+  requirement: &70093447013900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *70263359069080
+  version_requirements: *70093447013900
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &70263359068620 !ruby/object:Gem::Requirement
+  requirement: &70093447010320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +87,10 @@ dependencies:
         version: '0.6'
   type: :development
   prerelease: false
-  version_requirements: *70263359068620
+  version_requirements: *70093447010320
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70263359068160 !ruby/object:Gem::Requirement
+  requirement: &70093447018620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,7 +98,7 @@ dependencies:
         version: '1.2'
   type: :development
   prerelease: false
-  version_requirements: *70263359068160
+  version_requirements: *70093447018620
 description: 
 email:
 - andrewnez@gmail.com
@@ -125,6 +125,7 @@ files:
 - lib/split/dashboard/views/_experiment.erb
 - lib/split/dashboard/views/index.erb
 - lib/split/dashboard/views/layout.erb
+- lib/split/engine.rb
 - lib/split/experiment.rb
 - lib/split/helper.rb
 - lib/split/version.rb