ablab 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 82b09b75abb045ba604cc9940801370381565a4f
-  data.tar.gz: 7687acf2d7bf62c7027eea04b411f143b6651093
+  metadata.gz: cd4478bb1810dd0d5afddf97eb299cf2ebaf343b
+  data.tar.gz: 0290705fe61858b5b355fee0ade8d9bb3e44a5fc
 SHA512:
-  metadata.gz: dd0c52bec7918a4f6c783311647fc59e6f92b217c0807474036e97a173679e7d29e2d6b419c3de87c0c61b0809dcb0260500e64200dfc330d23573ec20778ca0
-  data.tar.gz: 0ca01138cc6a81182efc7cd0bf862141fbd68baba8e516b10400315f9fe0088fcd54ef3a4d75570d99e1b10d2f3ee132600da5c06caf81d629a921450ba3f557
+  metadata.gz: e6ec28c30693a9030cd5d995d2d73242be556d16b0ac8167458d8bcec811c76a309250c0e610a02158654b04f9cb3d565dca8dea141ccca4b65658a9e53c380a
+  data.tar.gz: 1a4b4e194003966c232068aa3bc1f4e0bde85751746aee96c76ddf60b6ad1a828f63074185e57c5157f0a099589541bb172e4f00ec8cf23cc7b917ce68e4b5b4

data/app/assets/javascripts/ablab/tracker.js

@@ -16,4 +16,4 @@ var Ablab = (function(scripts) {
       currentScript.parentNode.appendChild(script);
     }
   }
-})(document.getElementsByTagName("script"));
+}(document.getElementsByTagName("script")));

data/app/assets/stylesheets/ablab/ablab.css

@@ -3,10 +3,14 @@
   They will automatically be included in application.css.
 */
 
-* {
+html {
   box-sizing: border-box;
 }
 
+*, *:before, *:after {
+  box-sizing: inherit;
+}
+
 body {
   font-family: sans-serif;
   background: #f5f5f5;
@@ -91,9 +95,24 @@ table th {
   border: none;
   border-bottom: 2px solid #e96e25;
   border-left: 1px dotted #e96e25;
+  cursor: help;
 }
 
 table {
   border: 1px solid #ffa26b;
   box-shadow: 0 1px 2px rgba(0, 0, 0, 0.2);
 }
+
+th i {
+  display: none;
+  position: absolute;
+  font-size: 12px;
+  font-weight: normal;
+  background: #ffa26b;
+  padding: 0.5em 0.809em;
+  box-shadow: 0 1px 1px rgba(0, 0, 0, 0.2);
+}
+
+th:hover i {
+  display: block;
+}

data/app/controllers/ablab/base_controller.rb

@@ -8,10 +8,12 @@ module Ablab
 
     def track
       exp = experiment(params[:experiment].to_sym)
-      if params[:event] == 'success'
-        exp.track_success!
-      else
-        exp.track_view!
+      Thread.new do
+        if params[:event] == 'success'
+          exp.track_success!
+        else
+          exp.track_view!
+        end
       end
       respond_to do |format|
         format.js

data/app/helpers/ablab/ablab_helper.rb

@@ -15,8 +15,9 @@ module Ablab
       '%.3f' % decimal
     end
 
-    def significant?(z_score)
-      z_score && z_score >= 1.65
+    def significant?(results)
+      return false if results[:sessions] < 30 || results[:conversions] < 5
+      results[:z_score] && results[:z_score] >= 1.65
     end
 
     def confidence(z_score, na = 'n/a')
@@ -40,7 +41,7 @@ module Ablab
           -1
         end
       end
-      significant?(winner_results[:z_score]) && winner_name == group_name
+      significant?(winner_results) && winner_name == group_name
     end
   end
 end

data/app/views/ablab/base/dashboard.html.erb

@@ -11,15 +11,34 @@
     <% end %>
     <table>
       <tr>
-        <th>Group</th>
-        <th>Description</th>
-        <th>Views</th>
-        <th>Sessions</th>
-        <th>Successes</th>
-        <th>Conversions</th>
-        <th>Conversion rate</th>
-        <th>Z-score</th>
-        <th>Confidence</th>
+        <th>Group
+          <i>The group, defining a variant of the experiment</i>
+        </th>
+        <th>Description
+          <i>The description of the variant of the experiment corresponding to a group</i>
+        </th>
+        <th>Views
+          <i>How many times the experiment was viewed in a group</i>
+        </th>
+        <th>Sessions
+          <i>How many unique visitors in a group viewed the experiment</i>
+        </th>
+        <th>Successes
+          <i>How many times the goal was reached for a group</i>
+        </th>
+        <th>Conversions
+          <i>How many unique visitors in a group reached the goal</i>
+        </th>
+        <th>Conversion rate
+          <i>Ratio of convertions over sessions</i>
+        </th>
+        <th>Z-score
+          <i>Z-score for the confidence testing</i>
+        </th>
+        <th>Confidence
+          <i>Probability that this group is having a real effect on the
+            conversion rate, compared to the control group</i>
+        </th>
       </tr>
       <% experiment.results.each do |group_name, results| %>
         <tr class="<%= 'winner' if winner?(experiment, group_name) %> <%= 'control' if results[:control] %>">

data/lib/ablab.rb

@@ -65,6 +65,11 @@ module Ablab
       @goal
     end
 
+    def percentage_of_visitors(percentage = nil)
+      @percentage_of_visitors = percentage if percentage
+      @percentage_of_visitors || 100
+    end
+
     def group(name, options = {})
       group = Group.new(name, options[:description])
       @groups << group
@@ -85,7 +90,6 @@ module Ablab
 
     def initialize(experiment, session_id)
       @experiment, @session_id = experiment, session_id
-      @experiment = experiment
     end
 
     def in_group?(name)
@@ -102,8 +106,9 @@ module Ablab
 
     def group
       return @group unless @group.nil?
-      idx = (draw / (1000.0 / experiment.groups.size)).floor
-      @group = experiment.groups[idx].name
+      size = 1000.0 * (experiment.percentage_of_visitors) / 100.0
+      idx = (draw * experiment.groups.size / size).floor
+      @group = experiment.groups[idx].try(:name)
     end
 
     def draw

data/lib/ablab/store/memory.rb

@@ -5,27 +5,25 @@ module Ablab
     class Memory
       def initialize
         @views = Hash.new do |hash, key|
-          hash[key] = Hash.new { |hash, key| hash[key] = 0 }
+          hash[key] = Hash.new { |h, k| h[k] = 0 }
         end
         @sessions = Hash.new do |hash, key|
-          hash[key] = Hash.new { |hash, key| hash[key] = Set.new }
+          hash[key] = Hash.new { |h, k| h[k] = Set.new }
         end
         @successes = Hash.new do |hash, key|
-          hash[key] = Hash.new { |hash, key| hash[key] = 0 }
+          hash[key] = Hash.new { |h, k| h[k] = 0 }
         end
         @conversions = Hash.new do |hash, key|
-          hash[key] = Hash.new { |hash, key| hash[key] = Set.new }
+          hash[key] = Hash.new { |h, k| h[k] = Set.new }
         end
       end
 
       def track_view!(experiment, bucket, session_id)
-        @views[experiment][bucket] += 1
-        @sessions[experiment][bucket].add(session_id)
+        track(experiment, bucket, session_id, @views, @sessions)
       end
 
       def track_success!(experiment, bucket, session_id)
-        @successes[experiment][bucket] += 1
-        @conversions[experiment][bucket].add(session_id)
+        track(experiment, bucket, session_id, @successes, @conversions)
       end
 
       def views(experiment, bucket)
@@ -52,6 +50,12 @@ module Ablab
           conversions: conversions(experiment, bucket)
         }
       end
+
+      private def track(experiment, bucket, session_id, counter, set)
+        return false if bucket.nil?
+        counter[experiment][bucket] += 1
+        set[experiment][bucket].add(session_id)
+      end
     end
   end
 end

data/lib/ablab/store/redis.rb

@@ -11,17 +11,11 @@ module Ablab
       end
 
       def track_view!(experiment, bucket, session_id)
-        redis.pipelined do
-          redis.incr(key(:views, experiment, bucket))
-          redis.pfadd(key(:sessions, experiment, bucket), session_id)
-        end
+        track(experiment, bucket, session_id, :views, :sessions)
       end
 
       def track_success!(experiment, bucket, session_id)
-        redis.pipelined do
-          redis.incr(key(:successes, experiment, bucket))
-          redis.pfadd(key(:conversions, experiment, bucket), session_id)
-        end
+        track(experiment, bucket, session_id, :successes, :conversions)
       end
 
       def views(experiment, bucket)
@@ -59,6 +53,14 @@ module Ablab
       private def key(type, experiment, bucket)
         "#{@key_prefix}:#{type}:#{experiment}:#{bucket}"
       end
+
+      private def track(experiment, bucket, session_id, counter, set)
+        return false if bucket.nil?
+        redis.pipelined do
+          redis.incr(key(counter, experiment, bucket))
+          redis.pfadd(key(set, experiment, bucket), session_id)
+        end
+      end
     end
   end
 end

data/lib/ablab/version.rb

@@ -1,3 +1,3 @@
 module Ablab
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/spec/ablab/store/store_examples.rb

@@ -2,6 +2,10 @@ require 'spec_helper'
 
 RSpec.shared_examples 'store' do
   describe '#track_view!' do
+    it 'returns false if group is nil' do
+      expect(store.track_view!(:foo, nil, 'abc')).to be(false)
+    end
+
     it 'tracks views' do
       5.times { store.track_view!(:foo, :a, 'abc') }
       7.times { store.track_view!(:foo, :b, 'abc') }
@@ -23,6 +27,10 @@ RSpec.shared_examples 'store' do
   end
 
   describe '#track_success!' do
+    it 'returns false if group is nil' do
+      expect(store.track_success!(:foo, nil, 'abc')).to be(false)
+    end
+
     it 'tracks successes' do
       5.times { store.track_success!(:foo, :a, 'abc') }
       7.times { store.track_success!(:foo, :b, 'abc') }

data/spec/ablab_spec.rb

@@ -74,13 +74,24 @@ describe Ablab do
       end
     end
 
-    describe '#description' do
+    describe '#goal' do
       it 'sets the experiment goal' do
         experiment.goal 'foo bar'
         expect(experiment.goal).to eq('foo bar')
       end
     end
 
+    describe '#percentage_of_visitors' do
+      it 'returns 100 if never set' do
+        expect(experiment.percentage_of_visitors).to eq(100)
+      end
+
+      it 'sets the percentage of visitors included in the experiment' do
+        experiment.percentage_of_visitors 25
+        expect(experiment.percentage_of_visitors).to eq(25)
+      end
+    end
+
     describe '#group' do
       it 'creates a group' do
         experiment.group :a, description: 'foo bar baz'
@@ -156,5 +167,21 @@ describe Ablab do
       run2 = Ablab::Run.new(experiment, 'foobar')
       expect(run1.group).to eq(run2.group)
     end
+
+    it 'selects only the given percentage of users' do
+      experiment.percentage_of_visitors 30
+      run = Ablab::Run.new(experiment, 0)
+      allow(run).to receive(:draw).and_return 0
+      expect(run).to be_in_group(:control)
+      run = Ablab::Run.new(experiment, 0)
+      allow(run).to receive(:draw).and_return 100
+      expect(run).to be_in_group(:a)
+      run = Ablab::Run.new(experiment, 0)
+      allow(run).to receive(:draw).and_return 200
+      expect(run).to be_in_group(:b)
+      run = Ablab::Run.new(experiment, 0)
+      allow(run).to receive(:draw).and_return 300
+      expect(run.group).to be_nil
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ablab
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Luca Ongaro
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-12 00:00:00.000000000 Z
+date: 2016-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -115,7 +115,7 @@ files:
 - spec/ablab/store/store_examples.rb
 - spec/ablab_spec.rb
 - spec/spec_helper.rb
-homepage: 
+homepage: https://github.com/lucaong/ablab
 licenses:
 - MIT
 metadata: {}
@@ -135,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Ablab - A/B testing on Rails