Module: Split::Helper
- Included in:
- EncapsulatedHelper::ContextShim
- Defined in:
- lib/split/helper.rb
Instance Method Summary collapse
- #ab_test(metric_descriptor, control = nil, *alternatives) ⇒ Object
- #ab_user ⇒ Object
- #begin_experiment(experiment, alternative_name = nil) ⇒ Object
- #clean_old_versions(experiment) ⇒ Object
- #doing_other_tests?(experiment_key) ⇒ Boolean
- #exclude_visitor? ⇒ Boolean
- #finish_experiment(experiment, options = {:reset => true}) ⇒ Object
- #finished(metric_descriptor, options = {:reset => true}) ⇒ Object
- #is_ignored_ip_address? ⇒ Boolean
- #is_robot? ⇒ Boolean
- #not_allowed_to_test?(experiment_key) ⇒ Boolean
- #old_versions(experiment) ⇒ Object
- #override_alternative(experiment_name) ⇒ Object
- #override_present?(experiment_name) ⇒ Boolean
- #reset!(experiment) ⇒ Object
Instance Method Details
#ab_test(metric_descriptor, control = nil, *alternatives) ⇒ Object
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 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 |
# File 'lib/split/helper.rb', line 4 def ab_test(metric_descriptor, control=nil, *alternatives) if RUBY_VERSION.match(/1\.8/) && alternatives.length.zero? && ! control.nil? 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 # Check if array is passed to ab_test: ab_test('name', ['Alt 1', 'Alt 2', 'Alt 3']) if control.is_a? Array and alternatives.length.zero? control, alternatives = control.first, control[1..-1] end begin experiment_name_with_version, goals = normalize_experiment(metric_descriptor) experiment_name = experiment_name_with_version.to_s.split(':')[0] experiment = Split::Experiment.new(experiment_name, :alternatives => [control].compact + alternatives, :goals => goals) control ||= experiment.control && experiment.control.name ret = if Split.configuration.enabled experiment.save start_trial( Trial.new(:experiment => experiment) ) else control_variable(control) end rescue => e raise(e) unless Split.configuration.db_failover Split.configuration.db_failover_on_db_error.call(e) if Split.configuration.db_failover_allow_parameter_override && override_present?(experiment_name) ret = override_alternative(experiment_name) end ensure unless ret ret = control_variable(control) end end if block_given? if defined?(capture) # a block in a rails view block = Proc.new { yield(ret) } concat(capture(ret, &block)) false else yield(ret) end else ret end end |
#ab_user ⇒ Object
105 106 107 |
# File 'lib/split/helper.rb', line 105 def ab_user @ab_user ||= Split::Persistence.adapter.new(self) end |
#begin_experiment(experiment, alternative_name = nil) ⇒ Object
99 100 101 102 103 |
# File 'lib/split/helper.rb', line 99 def begin_experiment(experiment, alternative_name = nil) alternative_name ||= experiment.control.name ab_user[experiment.key] = alternative_name alternative_name end |
#clean_old_versions(experiment) ⇒ Object
121 122 123 124 125 |
# File 'lib/split/helper.rb', line 121 def clean_old_versions(experiment) old_versions(experiment).each do |old_key| ab_user.delete old_key end end |
#doing_other_tests?(experiment_key) ⇒ Boolean
117 118 119 |
# File 'lib/split/helper.rb', line 117 def doing_other_tests?(experiment_key) keys_without_experiment(ab_user.keys, experiment_key).length > 0 end |
#exclude_visitor? ⇒ Boolean
109 110 111 |
# File 'lib/split/helper.rb', line 109 def exclude_visitor? instance_eval(&Split.configuration.ignore_filter) end |
#finish_experiment(experiment, options = {:reset => true}) ⇒ Object
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 |
# File 'lib/split/helper.rb', line 57 def finish_experiment(experiment, = {:reset => true}) return true unless experiment.winner.nil? should_reset = experiment.resettable? && [:reset] if ab_user[experiment.finished_key] && !should_reset return true else alternative_name = ab_user[experiment.key] trial = Trial.new(:experiment => experiment, :alternative => alternative_name, :goals => [:goals]) call_trial_complete_hook(trial) if trial.complete! if should_reset reset!(experiment) else ab_user[experiment.finished_key] = true end end end |
#finished(metric_descriptor, options = {:reset => true}) ⇒ Object
76 77 78 79 80 81 82 83 84 85 86 87 88 89 |
# File 'lib/split/helper.rb', line 76 def finished(metric_descriptor, = {:reset => true}) return if exclude_visitor? || Split.configuration.disabled? metric_descriptor, goals = normalize_experiment(metric_descriptor) experiments = Metric.possible_experiments(metric_descriptor) if experiments.any? experiments.each do |experiment| finish_experiment(experiment, .merge(:goals => goals)) end end rescue => e raise unless Split.configuration.db_failover Split.configuration.db_failover_on_db_error.call(e) end |
#is_ignored_ip_address? ⇒ Boolean
140 141 142 143 144 145 146 147 |
# File 'lib/split/helper.rb', line 140 def is_ignored_ip_address? return false if Split.configuration.ignore_ip_addresses.empty? Split.configuration.ignore_ip_addresses.each do |ip| return true if defined?(request) && (request.ip == ip || (ip.class == Regexp && request.ip =~ ip)) end false end |
#is_robot? ⇒ Boolean
136 137 138 |
# File 'lib/split/helper.rb', line 136 def is_robot? defined?(request) && request.user_agent =~ Split.configuration.robot_regex end |
#not_allowed_to_test?(experiment_key) ⇒ Boolean
113 114 115 |
# File 'lib/split/helper.rb', line 113 def not_allowed_to_test?(experiment_key) !Split.configuration.allow_multiple_experiments && doing_other_tests?(experiment_key) end |
#old_versions(experiment) ⇒ Object
127 128 129 130 131 132 133 134 |
# File 'lib/split/helper.rb', line 127 def old_versions(experiment) if experiment.version > 0 keys = ab_user.keys.select { |k| k.match(Regexp.new(experiment.name)) } keys_without_experiment(keys, experiment.key) else [] end end |
#override_alternative(experiment_name) ⇒ Object
95 96 97 |
# File 'lib/split/helper.rb', line 95 def override_alternative(experiment_name) params[experiment_name] if override_present?(experiment_name) end |
#override_present?(experiment_name) ⇒ Boolean
91 92 93 |
# File 'lib/split/helper.rb', line 91 def override_present?(experiment_name) defined?(params) && params[experiment_name] end |
#reset!(experiment) ⇒ Object
53 54 55 |
# File 'lib/split/helper.rb', line 53 def reset!(experiment) ab_user.delete(experiment.key) end |