ablab 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 12f71c1bce10f9c02b35a34690b8c5a3f9116591
-  data.tar.gz: ac5b44830c77f57d30efa75bcd95b0c33648e5f1
+  metadata.gz: aa8125e2a869a953786f4b1bcacab2ac1752d00c
+  data.tar.gz: c661d695bcad5f817801b42aa1e4ffc99920d346
 SHA512:
-  metadata.gz: 149c7facb01e5c55f04890ed49afb0281d49068bf319e603b35df286098829d5d9f77c06b81e087a53b7578c1ca219f5f8828ee647b082315b5865b602d74aa9
-  data.tar.gz: 3f6446406904c78461b83d40a4b343cac2a13ae4a03b84f84e425cf3c1d9e4bf6ee87601e7d52c5993f1e919bcab673b528e6765755b704c167c8bd1c79fc246
+  metadata.gz: 7f459d5d133435d8c828d0626c0846575c3eb49d941fb21bb430cb1c91853162f5ff82fe89c2c49df0e2ace5eafcc1eba65adcd05865e6e84fcb875de792848d
+  data.tar.gz: 2a9e3c91a04cec5ee3691604b806dce7b53c4cf3871ee1dea791033326f16f0be0f13475ac507f4ece116e858adedf0537fbbb645baaaf671e33a8204587ca88

data/lib/ablab.rb

@@ -76,7 +76,7 @@ module Ablab
 
     def initialize(name, &block)
       @name      = name.to_sym
-      @control   = Group.new(:control, 'control group')
+      @control   = Group.control
       @groups    = [@control]
       @callbacks = []
       instance_exec(&block)
@@ -98,7 +98,7 @@ module Ablab
     end
 
     def group(name, options = {})
-      group = Group.new(name, options[:description])
+      group = Group.new(name, options[:description], options[:weight])
       @groups << group
     end
 
@@ -137,17 +137,23 @@ module Ablab
 
     def group
       return @group unless @group.nil?
-      forced = forced_group
-      return forced if forced
-      size = 1000.0 * (experiment.percentage_of_visitors) / 100.0
-      idx = (draw * experiment.groups.size / size).floor
-      @group = experiment.groups[idx].try(:name)
+      if forced = forced_group
+        return forced
+      end
+      d = draw / experiment.percentage_of_visitors
+      return nil if d >= 1
+      tot_weight = experiment.groups.map(&:weight).reduce(:+).to_f
+      @group = experiment.groups.reduce(0) do |t, group|
+        t += group.weight / tot_weight
+        break group if d < t
+        t
+      end
     end
 
     def draw
       sid_hash = Digest::SHA1.hexdigest(session_id)[-8..-1].to_i(16)
       exp_hash = Digest::SHA1.hexdigest(experiment.name.to_s)[-8..-1].to_i(16)
-      (sid_hash ^ exp_hash) % 1000
+      ((sid_hash ^ exp_hash) % 1000) / 10.0
     end
 
     def perform_callbacks!(event)
@@ -165,7 +171,7 @@ module Ablab
       return nil unless request && request.respond_to?(:params)
       groups = parse_groups(request.params[:ablab_group])
       group  = groups[experiment.name.to_s]
-      group.to_sym if group && experiment.groups.map { |g| g.name.to_s }.include?(group)
+      experiment.groups.find { |g| g == group }
     end
 
     private def parse_groups(str)
@@ -195,9 +201,39 @@ module Ablab
   end
 
   class Group
-    attr_reader :name, :description
-    def initialize(name, description = nil)
+    attr_reader :name, :description, :weight
+    alias_method :eql?, :==
+    def initialize(name, description = nil, weight = nil)
       @name, @description = name.to_sym, description
+      @weight = weight || 1
+    end
+
+    def control?
+      name == :control
+    end
+
+    def experimental?
+      !control?
+    end
+
+    def ==(o)
+      if o.is_a?(Symbol)
+        name == o
+      elsif o.is_a?(String)
+        name.to_s == o
+      elsif o.is_a?(self.class)
+        name == o.name && description == o.description
+      else
+        false
+      end
+    end
+
+    def hash
+      name.hash
+    end
+
+    def self.control
+      new(:control, 'control group')
     end
   end
 

data/lib/ablab/version.rb

@@ -1,3 +1,3 @@
 module Ablab
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/spec/ablab_spec.rb

@@ -186,10 +186,26 @@ describe Ablab do
       allow(run).to receive(:draw).and_return 0
       expect(run).to be_in_group(:control)
       run = Ablab::Run.new(experiment, 'abc', request)
-      allow(run).to receive(:draw).and_return 334
+      allow(run).to receive(:draw).and_return 33.4
       expect(run).to be_in_group(:a)
       run = Ablab::Run.new(experiment, 'abc', request)
-      allow(run).to receive(:draw).and_return 999
+      allow(run).to receive(:draw).and_return 99.9
+      expect(run).to be_in_group(:b)
+    end
+
+    it 'respects group weights' do
+      experiment = Ablab::Experiment.new(:foo) do
+        group :a
+        group :b, weight: 2
+      end
+      run = Ablab::Run.new(experiment, 'abc', request)
+      allow(run).to receive(:draw).and_return 24.0
+      expect(run).to be_in_group(:control)
+      run = Ablab::Run.new(experiment, 'abc', request)
+      allow(run).to receive(:draw).and_return 25.0
+      expect(run).to be_in_group(:a)
+      run = Ablab::Run.new(experiment, 'abc', request)
+      allow(run).to receive(:draw).and_return 50.0
       expect(run).to be_in_group(:b)
     end
 
@@ -202,16 +218,16 @@ describe Ablab do
     it 'selects only the given percentage of users' do
       experiment.percentage_of_visitors 30
       run = Ablab::Run.new(experiment, 'abc', request)
-      allow(run).to receive(:draw).and_return 0
+      allow(run).to receive(:draw).and_return 0.0
       expect(run).to be_in_group(:control)
       run = Ablab::Run.new(experiment, 'abc', request)
-      allow(run).to receive(:draw).and_return 100
+      allow(run).to receive(:draw).and_return 10.0
       expect(run).to be_in_group(:a)
       run = Ablab::Run.new(experiment, 'abc', request)
-      allow(run).to receive(:draw).and_return 200
+      allow(run).to receive(:draw).and_return 20.0
       expect(run).to be_in_group(:b)
       run = Ablab::Run.new(experiment, 'abc', request)
-      allow(run).to receive(:draw).and_return 300
+      allow(run).to receive(:draw).and_return 30.0
       expect(run.group).to be_nil
     end
 
@@ -220,25 +236,26 @@ describe Ablab do
         d1 = Ablab::Run.new(experiment, '8asd7f8asf7', request).draw
         dir = File.expand_path(File.dirname(__FILE__), '../lib')
         d2 = `bundle exec ruby -I#{dir} -e "require 'ablab'; require 'ostruct'; puts Ablab::Run.new(OpenStruct.new(name: :foo), '8asd7f8asf7', nil).draw"`
-        expect(d1).to eq(d2.to_i)
+        expect(d1).to eq(d2.to_f)
       end
 
-      it "returns an integer number < 1000" do
+      it "returns an float number < 100" do
         expect(
-          (0..100).map { |i| Ablab::Run.new(experiment, "#{i}", request).draw }.all? { |x| x.is_a?(Integer) && x < 1000 }
+          (0..100).map { |i| Ablab::Run.new(experiment, "#{i}", request).draw }.all? { |x| x.is_a?(Float) && x < 100 }
         ).to be(true)
       end
     end
 
     describe "#group" do
       it "returns one of the groups" do
-        expect(Ablab::Run.new(experiment, rand(12345).to_s, request).group).to be_in([:a, :b, :control])
+        expect([:a, :b, :control]).to include(Ablab::Run.new(experiment, rand(12345).to_s, request).group)
       end
 
       it "returns the forced group, if set with the 'ablab_group' param" do
         params = { ablab_group: 'bar:baz,foo:a' }
         allow(request).to receive(:params).and_return(params)
         run = Ablab::Run.new(experiment, '6q5wed', request)
+        expect(run.group).to be_a(Ablab::Group)
         expect(run.group).to eq(:a)
       end
     end
@@ -341,4 +358,51 @@ describe Ablab do
       end
     end
   end
+
+  describe Ablab::Group do
+    let(:control_group) { Ablab::Group.new(:control, "control group") }
+    let(:experimental_group) { Ablab::Group.new(:foo, "foo group") }
+
+    describe "#control?" do
+      it 'is true for the control group' do
+        expect(control_group.control?).to be true
+      end
+
+      it 'is false for other groups' do
+        expect(experimental_group.control?).to be false
+      end
+    end
+
+    describe "#experimental?" do
+      it 'is false for the control group' do
+        expect(control_group.experimental?).to be false
+      end
+
+      it 'is true for other groups' do
+        expect(experimental_group.experimental?).to be true
+      end
+    end
+
+    describe "#==" do
+      it 'accepts comparison to Symbol instances' do
+        expect(control_group).to eq(:control)
+        expect(control_group).not_to eq(:foo)
+      end
+
+      it 'accepts comparison to String instances' do
+        expect(control_group).to eq('control')
+        expect(control_group).not_to eq('foo')
+      end
+
+      it 'accepts comparison to Ablab::Group instances' do
+        expect(control_group).to eq(control_group)
+        expect(control_group).to eq(Ablab::Group.new(:control, "control group"))
+        expect(control_group).not_to eq(experimental_group)
+      end
+
+      it 'is false for everyhing else' do
+        expect(control_group).not_to eq(Object.new)
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ablab
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Luca Ongaro
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-23 00:00:00.000000000 Z
+date: 2016-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails