Module: Split

Extended by:
Split
Included in:
Split
Defined in:
lib/split/alternative.rb,
lib/split.rb,
lib/split/user.rb,
lib/split/trial.rb,
lib/split/engine.rb,
lib/split/helper.rb,
lib/split/metric.rb,
lib/split/zscore.rb,
lib/split/version.rb,
lib/split/dashboard.rb,
lib/split/exceptions.rb,
lib/split/experiment.rb,
lib/split/persistence.rb,
lib/split/configuration.rb,
lib/split/redis_interface.rb,
lib/split/goals_collection.rb,
lib/split/dashboard/helpers.rb,
lib/split/experiment_catalog.rb,
lib/split/algorithms/whiplash.rb,
lib/split/encapsulated_helper.rb,
lib/split/persistence/dual_adapter.rb,
lib/split/persistence/redis_adapter.rb,
lib/split/algorithms/weighted_sample.rb,
lib/split/persistence/cookie_adapter.rb,
lib/split/persistence/session_adapter.rb

Overview

Split’s helper exposes all kinds of methods we don’t want to mix into our model classes.

This module exposes only two methods:

- ab_test()
- ab_finished()

that can safely be mixed into any class.

Passes the instance of the class that it’s mixed into to the Split persistence adapter as context.

Defined Under Namespace

Modules: Algorithms, DashboardHelpers, EncapsulatedHelper, Helper, Persistence, Zscore Classes: Alternative, Configuration, Dashboard, Engine, Experiment, ExperimentCatalog, ExperimentNotFound, GoalsCollection, InvalidExperimentsFormatError, InvalidPersistenceAdapterError, Metric, RedisInterface, Trial, User

Constant Summary collapse

MAJOR = 
2
MINOR = 
2
PATCH = 
0
VERSION = 
[MAJOR, MINOR, PATCH].join('.')

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#configuration ⇒ Object

Returns the value of attribute configuration.



26
27
28
 
# File 'lib/split.rb', line 26

def configuration
  @configuration
end

Instance Method Details

#configure {|configuration| ... } ⇒ Object

Call this method to modify defaults in your initializers.

Examples:

Split.configure do |config|
  config.ignore_ip_addresses = '192.168.2.1'
end

Yields:



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

def configure
  self.configuration ||= Configuration.new
  yield(configuration)
end

#redis ⇒ Object

Returns the current Redis connection. If none has been created, will create a new one.



49
50
51
52
53
 
# File 'lib/split.rb', line 49

def redis
  return @redis if @redis
  self.redis = self.configuration.redis
  self.redis
end

#redis=(server) ⇒ Object

Accepts:

1. A redis URL (valid for `Redis.new(url: url)`)
2. an options hash compatible with `Redis.new`
3. or a valid Redis instance (one that responds to `#smembers`). Likely,
   this will be an instance of either `Redis`, `Redis::Client`,
   `Redis::DistRedis`, or `Redis::Namespace`.



34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/split.rb', line 34

def redis=(server)
  @redis = if server.is_a?(String)
    Redis.new(:url => server, :thread_safe => true)
  elsif server.is_a?(Hash)
    Redis.new(server.merge(:thread_safe => true))
  elsif server.respond_to?(:smembers)
    server
  else
    raise ArgumentError,
      "You must supply a url, options hash or valid Redis connection instance"
  end
end