Class: FieldTest::Experiment

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes) ⇒ Experiment

Returns a new instance of Experiment.



5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'lib/field_test/experiment.rb', line 5

def initialize(attributes)
  attributes = attributes.symbolize_keys
  @id = attributes[:id]
  @name = attributes[:name] || @id.to_s.titleize
  @description = attributes[:description]
  @variants = attributes[:variants]
  if @variants.any? { |v| !v.is_a?(String) }
    # TODO add support for more types (including query parameters)
    # or raise error in 0.6
    warn "[field_test] Only string variants are supported (#{id})"
  end
  @weights = @variants.size.times.map { |i| attributes[:weights].to_a[i] || 1 }
  @winner = attributes[:winner]
  @closed = attributes[:closed]
  @keep_variant = attributes[:keep_variant]
  @started_at = Time.zone.parse(attributes[:started_at].to_s) if attributes[:started_at]
  @ended_at = Time.zone.parse(attributes[:ended_at].to_s) if attributes[:ended_at]
  @goals = attributes[:goals] || ["conversion"]
  @goals_defined = !attributes[:goals].nil?
  @use_events = attributes[:use_events]
end

Instance Attribute Details

#description ⇒ Object (readonly)

Returns the value of attribute description.



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

def description
  @description
end

#ended_at ⇒ Object (readonly)

Returns the value of attribute ended_at.



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

def ended_at
  @ended_at
end

#goals ⇒ Object (readonly)

Returns the value of attribute goals.



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

def goals
  @goals
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



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

def id
  @id
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



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

def name
  @name
end

#started_at ⇒ Object (readonly)

Returns the value of attribute started_at.



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

def started_at
  @started_at
end

#variants ⇒ Object (readonly)

Returns the value of attribute variants.



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

def variants
  @variants
end

#weights ⇒ Object (readonly)

Returns the value of attribute weights.



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

def weights
  @weights
end

#winner ⇒ Object (readonly)

Returns the value of attribute winner.



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

def winner
  @winner
end

Class Method Details

.all ⇒ Object 



198
199
200
201
202
 
# File 'lib/field_test/experiment.rb', line 198

def self.all
  FieldTest.config["experiments"].map do |id, settings|
    FieldTest::Experiment.new(settings.merge(id: id.to_s))
  end
end

.find(id) ⇒ Object

Raises:



191
192
193
194
195
196
 
# File 'lib/field_test/experiment.rb', line 191

def self.find(id)
  experiment = all.index_by(&:id)[id.to_s]
  raise FieldTest::ExperimentNotFound unless experiment

  experiment
end

Instance Method Details

#active? ⇒ Boolean

Returns:

  • (Boolean) 


167
168
169
 
# File 'lib/field_test/experiment.rb', line 167

def active?
  !winner
end

#closed? ⇒ Boolean

Returns:

  • (Boolean) 


171
172
173
 
# File 'lib/field_test/experiment.rb', line 171

def closed?
  @closed
end

#control ⇒ Object 



179
180
181
 
# File 'lib/field_test/experiment.rb', line 179

def control
  variants.first
end

#convert(participants, goal: nil) ⇒ Object 



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/field_test/experiment.rb', line 63

def convert(participants, goal: nil)
  return false if winner

  goal ||= goals.first

  participants = FieldTest::Participant.standardize(participants)
  check_participants(participants)
  membership = membership_for(participants)

  if membership
    if membership.respond_to?(:converted)
      membership.converted = true
      membership.save! if membership.changed?
    end

    if use_events?
      FieldTest::Event.create!(
        name: goal,
        field_test_membership_id: membership.id
      )
    end

    true
  else
    false
  end
end

#events ⇒ Object 



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

def events
  FieldTest::Event.joins(:field_test_membership).where(field_test_memberships: {experiment: id})
end

#keep_variant? ⇒ Boolean

Returns:

  • (Boolean) 


175
176
177
 
# File 'lib/field_test/experiment.rb', line 175

def keep_variant?
  @keep_variant
end

#memberships ⇒ Object 



91
92
93
 
# File 'lib/field_test/experiment.rb', line 91

def memberships
  FieldTest::Membership.where(experiment: id)
end

#multiple_goals? ⇒ Boolean

Returns:

  • (Boolean) 


99
100
101
 
# File 'lib/field_test/experiment.rb', line 99

def multiple_goals?
  goals.size > 1
end

#results(goal: nil) ⇒ Object 



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
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
163
164
165
 
# File 'lib/field_test/experiment.rb', line 103

def results(goal: nil)
  goal ||= goals.first

  relation = memberships.group(:variant)
  relation = relation.where("field_test_memberships.created_at >= ?", started_at) if started_at
  relation = relation.where("field_test_memberships.created_at <= ?", ended_at) if ended_at

  if use_events? && @goals_defined
    data = {}

    participated = relation.count

    adapter_name = relation.connection_db_config.adapter.to_s
    column =
      if FieldTest.legacy_participants
        :participant
      elsif adapter_name.match?(/postg/i) # postgres
        "(participant_type, participant_id)"
      elsif adapter_name.match?(/mysql|trilogy/i)
        "COALESCE(participant_type, ''), participant_id"
      else
        # SQLite supports single column
        "COALESCE(participant_type, '') || ':' || participant_id"
      end

    converted = events.merge(relation).where(field_test_events: {name: goal}).distinct.count(column)

    (participated.keys + converted.keys).uniq.each do |variant|
      data[[variant, true]] = converted[variant].to_i
      data[[variant, false]] = participated[variant].to_i - converted[variant].to_i
    end
  else
    data = relation.group(:converted).count
  end

  results = {}
  variants.each do |variant|
    converted = data[[variant, true]].to_i
    participated = converted + data[[variant, false]].to_i
    results[variant] = {
      participated: participated,
      converted: converted,
      conversion_rate: participated > 0 ? converted.to_f / participated : nil
    }
  end

  if variants.size <= 3
    probabilities =
      cache_fetch(["field_test", "probabilities"] + results.flat_map { |_, v| [v[:participated], v[:converted]] }) do
        binary_test = BinaryTest.new
        results.each do |_, v|
          binary_test.add(v[:participated], v[:converted])
        end
        binary_test.probabilities.to_a
      end

    results.each_key.zip(probabilities) do |variant, prob_winning|
      results[variant][:prob_winning] = prob_winning
    end
  end

  results
end

#use_events? ⇒ Boolean

Returns:

  • (Boolean) 


183
184
185
186
187
188
189
 
# File 'lib/field_test/experiment.rb', line 183

def use_events?
  if @use_events.nil?
    FieldTest.events_supported?
  else
    @use_events
  end
end

#variant(participants, options = {}) ⇒ Object 



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/field_test/experiment.rb', line 27

def variant(participants, options = {})
  return winner if winner && !keep_variant?
  return control if options[:exclude]

  participants = FieldTest::Participant.standardize(participants)
  check_participants(participants)
  membership = membership_for(participants) || FieldTest::Membership.new(experiment: id)

  if winner # and keep_variant?
    return membership.variant || winner
  end

  if options[:variant] && variants.include?(options[:variant])
    membership.variant = options[:variant]
  else
    membership.variant ||= closed? ? control : weighted_variant
  end

  participant = participants.first

  # upgrade to preferred participant
  membership.participant = participant.participant if membership.respond_to?(:participant=)
  membership.participant_type = participant.type if membership.respond_to?(:participant_type=)
  membership.participant_id = participant.id if membership.respond_to?(:participant_id=)

  if membership.changed? && (!closed? || membership.persisted?)
    begin
      membership.save!
    rescue ActiveRecord::RecordNotUnique
      membership = memberships.find_by(participant.where_values)
    end
  end

  membership.try(:variant) || control
end