Class: Split::Experiment

Inherits:
Object
  • Object
show all
Defined in:
lib/split/experiment.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, *alternative_names) ⇒ Experiment

Returns a new instance of Experiment.



5
6
7
8
9
10
 
# File 'lib/split/experiment.rb', line 5

def initialize(name, *alternative_names)
  @name = name.to_s
  @alternatives = alternative_names.map do |alternative|
                    Split::Alternative.new(alternative, name)
                  end
end

Instance Attribute Details

#name ⇒ Object

Returns the value of attribute name.



3
4
5
 
# File 'lib/split/experiment.rb', line 3

def name
  @name
end

Class Method Details

.all ⇒ Object 



122
123
124
 
# File 'lib/split/experiment.rb', line 122

def self.all
  Array(Split.redis.smembers(:experiments)).map {|e| find(e)}
end

.find(name) ⇒ Object 



126
127
128
129
130
 
# File 'lib/split/experiment.rb', line 126

def self.find(name)
  if Split.redis.exists(name)
    self.new(name, *load_alternatives_for(name))
  end
end

.find_or_create(key, *alternatives) ⇒ Object 



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/split/experiment.rb', line 132

def self.find_or_create(key, *alternatives)
  name = key.to_s.split(':')[0]

  if alternatives.length == 1
    if alternatives[0].is_a? Hash
      alternatives = alternatives[0].map{|k,v| {k => v} }
    else
      raise InvalidArgument, 'You must declare at least 2 alternatives'
    end
  end

  alts = initialize_alternatives(alternatives, name)

  if Split.redis.exists(name)
    existing_alternatives = load_alternatives_for(name)
    if existing_alternatives == alts.map(&:name)
      experiment = self.new(name, *alternatives)
    else
      exp = self.new(name, *existing_alternatives)
      exp.reset
      exp.alternatives.each(&:delete)
      experiment = self.new(name, *alternatives)
      experiment.save
    end
  else
    experiment = self.new(name, *alternatives)
    experiment.save
  end
  return experiment

end

.initialize_alternatives(alternatives, name) ⇒ Object 



164
165
166
167
168
169
170
171
172
173
 
# File 'lib/split/experiment.rb', line 164

def self.initialize_alternatives(alternatives, name)

  unless alternatives.all? { |a| Split::Alternative.valid?(a) }
    raise InvalidArgument, 'Alternatives must be strings'
  end

  alternatives.map do |alternative|
    Split::Alternative.new(alternative, name)
  end
end

.load_alternatives_for(name) ⇒ Object 



110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/split/experiment.rb', line 110

def self.load_alternatives_for(name)
  case Split.redis.type(name)
  when 'set' # convert legacy sets to lists
    alts = Split.redis.smembers(name)
    Split.redis.del(name)
    alts.reverse.each {|a| Split.redis.lpush(name, a) }
    Split.redis.lrange(name, 0, -1)
  else
    Split.redis.lrange(name, 0, -1)
  end
end

Instance Method Details

#alternative_names ⇒ Object 



41
42
43
 
# File 'lib/split/experiment.rb', line 41

def alternative_names
  @alternatives.map(&:name)
end

#alternatives ⇒ Object 



37
38
39
 
# File 'lib/split/experiment.rb', line 37

def alternatives
  @alternatives.dup
end

#control ⇒ Object 



20
21
22
 
# File 'lib/split/experiment.rb', line 20

def control
  alternatives.first
end

#delete ⇒ Object 



87
88
89
90
91
92
93
 
# File 'lib/split/experiment.rb', line 87

def delete
  alternatives.each(&:delete)
  reset_winner
  Split.redis.srem(:experiments, name)
  Split.redis.del(name)
  increment_version
end

#finished_key ⇒ Object 



77
78
79
 
# File 'lib/split/experiment.rb', line 77

def finished_key
  "#{key}:finished"
end

#increment_version ⇒ Object 



65
66
67
 
# File 'lib/split/experiment.rb', line 65

def increment_version
  @version = Split.redis.incr("#{name}:version")
end

#key ⇒ Object 



69
70
71
72
73
74
75
 
# File 'lib/split/experiment.rb', line 69

def key
  if version.to_i > 0
    "#{name}:#{version}"
  else
    name
  end
end

#new_record? ⇒ Boolean

Returns:

  • (Boolean) 


95
96
97
 
# File 'lib/split/experiment.rb', line 95

def new_record?
  !Split.redis.exists(name)
end

#next_alternative ⇒ Object 



45
46
47
 
# File 'lib/split/experiment.rb', line 45

def next_alternative
  winner || random_alternative
end

#random_alternative ⇒ Object 



49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/split/experiment.rb', line 49

def random_alternative
  weights = alternatives.map(&:weight)

  total = weights.inject(:+)
  point = rand * total

  alternatives.zip(weights).each do |n,w|
    return n if w >= point
    point -= w
  end
end

#reset ⇒ Object 



81
82
83
84
85
 
# File 'lib/split/experiment.rb', line 81

def reset
  alternatives.each(&:reset)
  reset_winner
  increment_version
end

#reset_winner ⇒ Object 



24
25
26
 
# File 'lib/split/experiment.rb', line 24

def reset_winner
  Split.redis.hdel(:experiment_winner, name)
end

#save ⇒ Object 



99
100
101
102
103
104
105
106
107
108
 
# File 'lib/split/experiment.rb', line 99

def save
  if new_record?
    Split.redis.sadd(:experiments, name)
    Split.redis.hset(:experiment_start_times, @name, Time.now)
    @alternatives.reverse.each {|a| Split.redis.lpush(name, a.name) }
  else
    Split.redis.del(name)
    @alternatives.reverse.each {|a| Split.redis.lpush(name, a.name) }
  end
end

#start_time ⇒ Object 



32
33
34
35
 
# File 'lib/split/experiment.rb', line 32

def start_time
  t = Split.redis.hget(:experiment_start_times, @name)
  Time.parse(t) if t
end

#version ⇒ Object 



61
62
63
 
# File 'lib/split/experiment.rb', line 61

def version
  @version ||= (Split.redis.get("#{name.to_s}:version").to_i || 0)
end

#winner ⇒ Object 



12
13
14
15
16
17
18
 
# File 'lib/split/experiment.rb', line 12

def winner
  if w = Split.redis.hget(:experiment_winner, name)
    Split::Alternative.new(w, name)
  else
    nil
  end
end

#winner=(winner_name) ⇒ Object 



28
29
30
 
# File 'lib/split/experiment.rb', line 28

def winner=(winner_name)
  Split.redis.hset(:experiment_winner, name, winner_name.to_s)
end