Class: Vanity::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/vanity/configuration.rb

Overview

This class holds the “how” Vanity operates. For the “what”, please see Vanity::Playground.

Defined Under Namespace

Classes: MissingEnvironment

Constant Summary collapse

LEGACY_CONNECTION_KEY = 
:connection
LEGACY_REDIS_CONFIG_FILE = 
"redis.yml"
DEFAULTS = 
{
  add_participant_route: "/vanity/add_participant",
  collecting: true,
  config_file: "vanity.yml",
  config_path: File.join(Pathname.new("."), "config"),
  environment: ENV["RACK_ENV"] || ENV["RAILS_ENV"] || "development",
  experiments_path: File.join(Pathname.new("."), "experiments"),
  failover_on_datastore_error: false,
  locales_path: File.expand_path(File.join(File.dirname(__FILE__), 'locales')),
  logger: default_logger,
  on_datastore_error: ->(error, klass, method, arguments) {
    default_on_datastore_error(error, klass, method, arguments)
  },
  request_filter: ->(request) { default_request_filter(request) },
  templates_path: File.expand_path(File.join(File.dirname(__FILE__), 'templates')),
  use_js: false,
  experiments_start_enabled: true,
  cookie_name: 'vanity_id',
  cookie_expires: 20 * 365 * 24 * 60 * 60, # 20 years, give or take.
  cookie_domain: nil,
  cookie_path: nil,
  cookie_secure: false,
  cookie_httponly: false,
}.freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#add_participant_route=(value) ⇒ Object (writeonly)

URL to the add_participant action.


71
72
73
 
# File 'lib/vanity/configuration.rb', line 71

def add_participant_route=(value)
  @add_participant_route = value
end

#collecting=(value) ⇒ Object (writeonly)

True if saving results to the datastore (participants and conversions).


65
66
67
 
# File 'lib/vanity/configuration.rb', line 65

def collecting=(value)
  @collecting = value
end

#config_file=(value) ⇒ Object (writeonly)

By default the vanity.yml file in the config_path variable. Variables scoped under the key for the current environment are extracted for the connection parameters. If there is no config/vanity.yml file, tries the configuration from config/redis.yml.


158
159
160
 
# File 'lib/vanity/configuration.rb', line 158

def config_file=(value)
  @config_file = value
end

#config_path=(value) ⇒ Object (writeonly)

Uses ./config by default.


153
154
155
 
# File 'lib/vanity/configuration.rb', line 153

def config_path=(value)
  @config_path = value
end

#cookie_domain=(value) ⇒ Object (writeonly)

Cookie domain. By default nil. If domain is nil then the domain from Rails.application.config.session_options will be substituted.


173
174
175
 
# File 'lib/vanity/configuration.rb', line 173

def cookie_domain=(value)
  @cookie_domain = value
end

#cookie_expires=(value) ⇒ Object (writeonly)

Cookie duration. By default 20 years.


169
170
171
 
# File 'lib/vanity/configuration.rb', line 169

def cookie_expires=(value)
  @cookie_expires = value
end

#cookie_httponly=(value) ⇒ Object (writeonly)

Cookie path. If true, cookie will not be available to JS. By default false.


182
183
184
 
# File 'lib/vanity/configuration.rb', line 182

def cookie_httponly=(value)
  @cookie_httponly = value
end

#cookie_name=(value) ⇒ Object (writeonly)

Cookie name. By default 'vanity_id'


166
167
168
 
# File 'lib/vanity/configuration.rb', line 166

def cookie_name=(value)
  @cookie_name = value
end

#cookie_path=(value) ⇒ Object (writeonly)

Cookie path. By default nil.


176
177
178
 
# File 'lib/vanity/configuration.rb', line 176

def cookie_path=(value)
  @cookie_path = value
end

#cookie_secure=(value) ⇒ Object (writeonly)

Cookie secure. If true, cookie will only be transmitted to SSL pages. By default false.


179
180
181
 
# File 'lib/vanity/configuration.rb', line 179

def cookie_secure=(value)
  @cookie_secure = value
end

#environment=(value) ⇒ Object (writeonly)

In order of precedence, RACK_ENV, RAILS_ENV or `development`.


160
161
162
 
# File 'lib/vanity/configuration.rb', line 160

def environment=(value)
  @environment = value
end

#experiments_path=(value) ⇒ Object (writeonly)

Path to load experiment files from.


68
69
70
 
# File 'lib/vanity/configuration.rb', line 68

def experiments_path=(value)
  @experiments_path = value
end

#experiments_start_enabled=(value) ⇒ Object (writeonly)

By default experiments start enabled. If you want experiments to be explicitly enabled after a production release, then set to false.


163
164
165
 
# File 'lib/vanity/configuration.rb', line 163

def experiments_start_enabled=(value)
  @experiments_start_enabled = value
end

#failover_on_datastore_error=(value) ⇒ Object (writeonly)

Turns on passing of errors to the Proc returned by #on_datastore_error. Set `config.failover_on_datastore_error` to `true` to turn this on.

Since:

  • 2.0.0


82
83
84
 
# File 'lib/vanity/configuration.rb', line 82

def failover_on_datastore_error=(value)
  @failover_on_datastore_error = value
end

#locales_path=(value) ⇒ Object (writeonly)

Path to Vanity locales. Set this to override those in the gem.


130
131
132
 
# File 'lib/vanity/configuration.rb', line 130

def locales_path=(value)
  @locales_path = value
end

#logger=(value) ⇒ Object (writeonly)

Logger. The default logs to STDOUT.


74
75
76
 
# File 'lib/vanity/configuration.rb', line 74

def logger=(value)
  @logger = value
end

#on_datastore_error=(value) ⇒ Object (writeonly)

Must return a Proc that accepts as parameters: the thrown error, the calling Class, the calling method, and an array of arguments passed to the calling method. The return value is ignored.

The default implementation logs this information to Playground#logger.

Set a custom action by calling config.on_datastore_error = Proc.new { … }.

Examples:

Proc.new do |error, klass, method, arguments|
  ...
end

Since:

  • 2.0.0


99
100
101
 
# File 'lib/vanity/configuration.rb', line 99

def on_datastore_error=(value)
  @on_datastore_error = value
end

#request_filter=(value) ⇒ Object (writeonly)

Must return a Proc that accepts as a parameter the request object, if made available by the implement framework. The return value should be a boolean whether to ignore the request. This is called only for the JS callback action.

The default implementation does a simple test of whether the request's HTTP_USER_AGENT header contains a URI, or the words 'bot', 'crawler', or 'spider' since well behaved bots typically include a reference URI in their user agent strings. (Original idea: stackoverflow.com/a/9285889.)

Alternatively, one could filter an explicit list of IPs, add additional user agent strings to filter, or any custom test. Set a custom filter by calling config.request_filter = Proc.new { … }.

Examples:

Proc.new do |request|
  ...
end

Since:

  • 2.0.0


124
125
126
 
# File 'lib/vanity/configuration.rb', line 124

def request_filter=(value)
  @request_filter = value
end

#templates_path=(value) ⇒ Object (writeonly)

Path to Vanity templates. Set this to override those in the gem.


127
128
129
 
# File 'lib/vanity/configuration.rb', line 127

def templates_path=(value)
  @templates_path = value
end

#use_js=(value) ⇒ Object (writeonly)

Call to indicate that participants should be added via js. This helps keep robots from participating in the A/B test and skewing results.

If you want to use this:

  • Add <%= vanity_js %> to any page that needs uses an ab_test. vanity_js needs to be included after your call to ab_test so that it knows which version of the experiment the participant is a member of. The helper will render nothing if the there are no ab_tests running on the current page, so adding vanity_js to the bottom of your layouts is a good option. Keep in mind that if you set config.use_js = true and don't include vanity_js in your view no participants will be recorded.

Note that a custom JS callback path can be set using:

  • Set config.add_participant_route = '/path/to/vanity/action', this should point to the add_participant path that is added with Vanity::Rails::Dashboard, make sure that this action is available to all users.


151
152
153
 
# File 'lib/vanity/configuration.rb', line 151

def use_js=(value)
  @use_js = value
end

Instance Method Details

#[](arg) ⇒ Object 


193
194
195
196
197
198
199
 
# File 'lib/vanity/configuration.rb', line 193

def [](arg)
  if instance_variable_defined?("@#{arg}")
    instance_variable_get("@#{arg}")
  else
    DEFAULTS[arg]
  end
end

#connection_params(file_name = nil) ⇒ Object

Returns nil or a hash of symbolized keys for connection settings.

Returns:

  • nil or a hash of symbolized keys for connection settings


207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/vanity/configuration.rb', line 207

def connection_params(file_name=nil)
  file_name ||= config_file
  file_path = File.join(config_path, file_name)

  if File.exist?(file_path)
    config = YAML.load(ERB.new(File.read(file_path)).result)
    config ||= {}
    params_for_environment = config[environment.to_s]

    unless params_for_environment
      raise MissingEnvironment.new("No configuration for #{environment}")
    end

    # Symbolize keys if it's a hash.
    if params_for_environment.respond_to?(:inject)
      params_for_environment.inject({}) { |h,kv| h[kv.first.to_sym] = kv.last ; h }
    else
      params_for_environment
    end
  end
end

#connection_url ⇒ Object

Deprecated. 

230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/vanity/configuration.rb', line 230

def connection_url
  connection_config = connection_params

  return unless connection_config && connection_config.respond_to?(:has_key?)

  connection_url = connection_config[LEGACY_CONNECTION_KEY]

  if connection_url
    logger.warn(%q{Deprecated: Please specify connection urls using the `url` key with a protocol prefix instead of `connection`. This fallback will be removed in a future version.})

    # Legacy lack of protocol handling
    if connection_url =~ /^\w+:/
      connection_url
    else
      "redis://" + connection_url
    end
  end
end

#redis_url_from_file ⇒ Object

Deprecated. 

250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/vanity/configuration.rb', line 250

def redis_url_from_file
  connection_url = connection_params(LEGACY_REDIS_CONFIG_FILE)

  if connection_url
    logger.warn(%q{Deprecated: Please specify the vanity config file, the default fallback to "config/redis.yml" may be removed in a future version.})

    if connection_url =~ /^\w+:/
      connection_url
    else
      "redis://" + connection_url
    end
  end
end

#setup_locales ⇒ Object 


201
202
203
204
 
# File 'lib/vanity/configuration.rb', line 201

def setup_locales
  locales = Dir[File.join(locales_path, '*.{rb,yml}')]
  I18n.load_path += locales
end