vanity 2.0.0.beta8 → 2.0.0.beta9

data/.travis.yml

@@ -1,6 +1,10 @@
 sudo: false
 cache: bundler
 language: ruby
+before_script:
+  - 'echo ''gem: --no-ri --no-rdoc'' > ~/.gemrc' # skip installing docs for gems
+before_install:
+  - gem install bundler -v="1.8.0" # Minimum version of bundler required
 bundler_args: --without development
 script: 'bundle exec rake test'
 services:
@@ -21,5 +25,3 @@ gemfile:
   - gemfiles/rails4.gemfile
   - gemfiles/rails41.gemfile
   - gemfiles/rails42.gemfile
-before_script:
-- 'echo ''gem: --no-ri --no-rdoc'' > ~/.gemrc' # skip installing docs for gems

data/Appraisals

@@ -1,8 +1,8 @@
 appraise "rails32" do
   gem "mocha",  "~> 1.0", :require=>false
   gem "minitest", "~>4.2.0"
-  gem "test-unit", "~> 3.0"
   gem "rails", "3.2.22"
+  gem "minitest_tu_shim", "~> 1.3.3", :platforms => :mri_22
   gem "fastthread", :git => "git://github.com/zoltankiss/fastthread.git", :platforms => :mri_20
   gem "passenger", "~>3.0"
 end

data/Gemfile

@@ -14,11 +14,12 @@ gem "integration", "<= 0.1.0"
 gem "rubystats"
 
 # APIs
-gem "garb", "< 0.9.2" # API changes at this version
+gem "garb", "< 0.9.2", :require => false # API changes at this version
 
 # Testing
 gem "timecop", :require=>false
 gem "webmock", :require=>false
+gem "fakefs", :require => "fakefs/safe"
 
 platform :ruby do
   gem "bson_ext"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    vanity (2.0.0.beta8)
+    vanity (2.0.0.beta9)
       i18n
 
 GEM
@@ -34,8 +34,10 @@ GEM
     coffee-script-source (1.9.1)
     colorator (0.1)
     crack (0.3.1)
+    directory_watcher (1.4.1)
     execjs (2.5.2)
     fast-stemmer (1.0.2)
+    fakefs (0.6.7)
     ffi (1.9.8)
     garb (0.9.1)
       activesupport (>= 2.2.0)
@@ -118,6 +120,7 @@ DEPENDENCIES
   appraisal (~> 1.0.2)
   bson_ext
   bundler (>= 1.0.0)
+  fakefs
   garb (< 0.9.2)
   integration (<= 0.1.0)
   jdbc-sqlite3

data/gemfiles/rails32.gemfile

@@ -8,13 +8,14 @@ gem "redis-namespace", ">= 1.1.0"
 gem "mongo"
 gem "integration", "<= 0.1.0"
 gem "rubystats"
-gem "garb", "< 0.9.2"
+gem "garb", "< 0.9.2", :require=>false
 gem "timecop", :require => false
 gem "webmock", :require => false
 gem "mocha", "~> 1.0", :require => false
+gem "fakefs", :require=>"fakefs/safe"
 gem "minitest", "~>4.2.0"
-gem "test-unit", "~> 3.0"
 gem "rails", "3.2.22"
+gem "minitest_tu_shim", "~> 1.3.3", :platforms => :mri_22
 gem "fastthread", :git => "git://github.com/zoltankiss/fastthread.git", :platforms => :mri_20
 gem "passenger", "~>3.0"
 

data/gemfiles/rails32.gemfile.lock

@@ -7,7 +7,7 @@ GIT
 PATH
   remote: ..
   specs:
-    vanity (2.0.0.beta8)
+    vanity (2.0.0.beta9)
       i18n
 
 GEM
@@ -69,6 +69,7 @@ GEM
     daemon_controller (1.0.0)
     erubis (2.7.0)
     execjs (2.5.2)
+    fakefs (0.6.7)
     fast-stemmer (1.0.2)
     ffi (1.9.8)
     garb (0.9.1)
@@ -132,7 +133,6 @@ GEM
       rake (>= 0.8.1)
     polyglot (0.3.5)
     posix-spawn (0.3.11)
-    power_assert (0.2.2)
     pygments.rb (0.6.3)
       posix-spawn (~> 0.3.6)
       yajl-ruby (~> 1.2.0)
@@ -177,8 +177,6 @@ GEM
       rack (~> 1.0)
       tilt (~> 1.1, != 1.3.0)
     sqlite3 (1.3.10)
-    test-unit (3.0.9)
-      power_assert
     thor (0.19.1)
     tilt (1.4.1)
     timecop (0.3.5)
@@ -206,12 +204,14 @@ DEPENDENCIES
   appraisal (~> 1.0.2)
   bson_ext
   bundler (>= 1.0.0)
+  fakefs
   fastthread!
   garb (< 0.9.2)
   integration (<= 0.1.0)
   jdbc-sqlite3
   jekyll
   minitest (~> 4.2.0)
+  minitest_tu_shim (~> 1.3.3)
   mocha (~> 1.0)
   mongo
   passenger (~> 3.0)
@@ -222,7 +222,6 @@ DEPENDENCIES
   redis-namespace (>= 1.1.0)
   rubystats
   sqlite3 (~> 1.3.10)
-  test-unit (~> 3.0)
   timecop
   vanity!
   webmock

data/gemfiles/rails4.gemfile

@@ -8,10 +8,11 @@ gem "redis-namespace", ">= 1.1.0"
 gem "mongo"
 gem "integration", "<= 0.1.0"
 gem "rubystats"
-gem "garb", "< 0.9.2"
+gem "garb", "< 0.9.2", :require=>false
 gem "timecop", :require => false
 gem "webmock", :require => false
 gem "mocha", "~> 1.0", :require => false
+gem "fakefs", :require=>"fakefs/safe"
 gem "rails", "4.0.13"
 gem "fastthread", :git => "git://github.com/zoltankiss/fastthread.git", :platforms => :mri_20
 gem "passenger", "~>3.0"

data/gemfiles/rails4.gemfile.lock

@@ -7,7 +7,7 @@ GIT
 PATH
   remote: ..
   specs:
-    vanity (2.0.0.beta8)
+    vanity (2.0.0.beta9)
       i18n
 
 GEM
@@ -62,6 +62,7 @@ GEM
     directory_watcher (1.4.1)
     erubis (2.7.0)
     fast-stemmer (1.0.2)
+    fakefs (0.6.7)
     garb (0.9.1)
       activesupport (>= 2.2.0)
       crack (>= 0.1.6)
@@ -151,6 +152,7 @@ DEPENDENCIES
   appraisal (~> 1.0.2)
   bson_ext
   bundler (>= 1.0.0)
+  fakefs
   fastthread!
   garb (< 0.9.2)
   integration (<= 0.1.0)

data/gemfiles/rails41.gemfile

@@ -8,10 +8,11 @@ gem "redis-namespace", ">= 1.1.0"
 gem "mongo"
 gem "integration", "<= 0.1.0"
 gem "rubystats"
-gem "garb", "< 0.9.2"
+gem "garb", "< 0.9.2", :require=>false
 gem "timecop", :require => false
 gem "webmock", :require => false
 gem "mocha", "~> 1.0", :require => false
+gem "fakefs", :require=>"fakefs/safe"
 gem "rails", "4.1.9"
 gem "fastthread", :git => "git://github.com/zoltankiss/fastthread.git", :platforms => :mri_20
 gem "passenger", "~>3.0"

data/gemfiles/rails41.gemfile.lock

@@ -7,7 +7,7 @@ GIT
 PATH
   remote: .././
   specs:
-    vanity (2.0.0.beta8)
+    vanity (2.0.0.beta9)
       i18n
 
 GEM
@@ -69,6 +69,7 @@ GEM
     daemon_controller (1.2.0)
     erubis (2.7.0)
     execjs (2.5.2)
+    fakefs (0.6.7)
     fast-stemmer (1.0.2)
     ffi (1.9.8)
     garb (0.9.1)
@@ -200,6 +201,7 @@ DEPENDENCIES
   appraisal (~> 1.0.2)
   bson_ext
   bundler (>= 1.0.0)
+  fakefs
   fastthread!
   garb (< 0.9.2)
   integration (<= 0.1.0)

data/gemfiles/rails42.gemfile

@@ -8,10 +8,11 @@ gem "redis-namespace", ">= 1.1.0"
 gem "mongo"
 gem "integration", "<= 0.1.0"
 gem "rubystats"
-gem "garb", "< 0.9.2"
+gem "garb", "< 0.9.2", :require=>false
 gem "timecop", :require => false
 gem "webmock", :require => false
 gem "mocha", "~> 1.0", :require => false
+gem "fakefs", :require=>"fakefs/safe"
 gem "rails", "4.2.0"
 gem "fastthread", :git => "git://github.com/zoltankiss/fastthread.git", :platforms => :mri_20
 gem "passenger", "~>3.0"

data/gemfiles/rails42.gemfile.lock

@@ -7,7 +7,7 @@ GIT
 PATH
   remote: ..
   specs:
-    vanity (2.0.0.beta8)
+    vanity (2.0.0.beta9)
       i18n
 
 GEM
@@ -78,6 +78,7 @@ GEM
     daemon_controller (1.2.0)
     erubis (2.7.0)
     execjs (2.5.2)
+    fakefs (0.6.7)
     fast-stemmer (1.0.2)
     ffi (1.9.8)
     garb (0.9.1)
@@ -226,6 +227,7 @@ DEPENDENCIES
   appraisal (~> 1.0.2)
   bson_ext
   bundler (>= 1.0.0)
+  fakefs
   fastthread!
   garb (< 0.9.2)
   integration (<= 0.1.0)

data/lib/vanity.rb

@@ -11,25 +11,31 @@ require "yaml"
 # @see Vanity::Playground
 # @see Vanity::Metric
 # @see Vanity::Experiment
+# @see Vanity::Configuration
+# @see Vanity::Connection
 module Vanity
 end
 
 require "vanity/version"
-# Metrics.
+# Metrics
 require "vanity/metric/base"
 require "vanity/metric/active_record"
 require "vanity/metric/google_analytics"
 require "vanity/metric/remote"
-# Experiments.
+# Experiments
 require "vanity/experiment/base"
 require "vanity/experiment/ab_test"
 # Database adapters
+require "vanity/adapters"
 require "vanity/adapters/abstract_adapter"
 require "vanity/adapters/mock_adapter"
-# Playground.
+# Playground
 require "vanity/playground"
-require "vanity/templates"
+require "vanity/configuration"
+require "vanity/connection"
 require "vanity/autoconnect"
+require "vanity/templates"
 require "vanity/helpers"
-# Integration with various frameworks.
+require "vanity/vanity"
+# Integration with various frameworks
 require "vanity/frameworks"

data/lib/vanity/adapters.rb

@@ -0,0 +1,20 @@
+module Vanity
+  module Adapters
+    class << self
+      # Creates new connection to underlying datastore and returns suitable
+      # adapter (adapter object extends AbstractAdapter and wraps the
+      # connection). Vanity.playground.establish_connection uses this.
+      #
+      # @since 1.4.0
+      def establish_connection(spec)
+        begin
+          require "vanity/adapters/#{spec[:adapter]}_adapter"
+        rescue LoadError
+          raise "Could not find #{spec[:adapter]} in your load path"
+        end
+        adapter_method = "#{spec[:adapter]}_connection"
+        send adapter_method, spec
+      end
+    end
+  end
+end

data/lib/vanity/adapters/abstract_adapter.rb

@@ -1,23 +1,5 @@
 module Vanity
   module Adapters
-
-    class << self
-      # Creates new connection to underlying datastore and returns suitable
-      # adapter (adapter object extends AbstractAdapter and wraps the
-      # connection). Vanity.playground.establish_connection uses this.
-      #
-      # @since 1.4.0
-      def establish_connection(spec)
-        begin
-          require "vanity/adapters/#{spec[:adapter]}_adapter"
-        rescue LoadError
-          raise "Could not find #{spec[:adapter]} in your load path"
-        end
-        adapter_method = "#{spec[:adapter]}_connection"
-        send adapter_method, spec
-      end
-    end
-
     # Base class for all adapters. Adapters wrap underlying connection to a
     # datastore and implement an API that Vanity can use to store/access
     # metrics, experiments, etc.

data/lib/vanity/autoconnect.rb

@@ -24,6 +24,7 @@ module Vanity
       'db:seed',
       'db:setup',
       'db:structure:dump',
+      'db:test:load',
       'db:version',
       'doc:app',
       'log:clear',

data/lib/vanity/configuration.rb

@@ -0,0 +1,211 @@
+module Vanity
+  # This class holds the "how" Vanity operates. For the "what", please see
+  # Vanity::Playground.
+  class Configuration
+    class MissingEnvironment < StandardError; end
+
+    LEGACY_REDIS_CONFIG_FILE = "redis.yml"
+
+    class<<self
+      private
+
+      def default_logger # :nodoc:
+        logger = Logger.new(STDOUT)
+        logger.level = Logger::WARN
+        logger
+      end
+
+      def default_on_datastore_error(error, klass, method, arguments) # :nodoc:
+        log = "[#{Time.now.iso8601}]"
+        log << " [vanity #{klass} #{method}]"
+        log << " [#{error.message}]"
+        log << " [#{arguments.join(' ')}]"
+        Vanity.logger.error(log)
+        nil
+      end
+
+      def default_request_filter(request) # :nodoc:
+        request &&
+          request.env &&
+          request.env["HTTP_USER_AGENT"] &&
+          request.env["HTTP_USER_AGENT"].match(/\(.*https?:\/\/.*\)/)
+      end
+    end
+
+    DEFAULTS = {
+      collecting: true,
+      experiments_path: File.join(Pathname.new("."), "experiments"),
+      add_participant_route: "/vanity/add_participant",
+      logger: default_logger,
+      failover_on_datastore_error: false,
+      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')),
+      locales_path: File.expand_path(File.join(File.dirname(__FILE__), 'locales')),
+      use_js: false,
+      config_path: File.join(Pathname.new("."), "config"),
+      config_file: "vanity.yml",
+      environment: ENV["RACK_ENV"] || ENV["RAILS_ENV"] || "development"
+    }.freeze
+
+    # True if saving results to the datastore (participants and conversions).
+    attr_writer :collecting
+
+    # Path to load experiment files from.
+    attr_writer :experiments_path
+
+    # URL to the add_participant action.
+    attr_writer :add_participant_route
+
+    # Logger. The default logs to STDOUT.
+    attr_writer :logger
+
+    # -- Datastore graceful failover --
+
+    # 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
+    attr_writer :failover_on_datastore_error
+
+    # 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.
+    #
+    # @example
+    #    Proc.new do |error, klass, method, arguments|
+    #      ...
+    #    end
+    #
+    # The default implementation logs this information to Playground#logger.
+    #
+    # Set a custom action by calling config.on_datastore_error =
+    # Proc.new { ... }.
+    #
+    # @since 2.0.0
+    attr_writer :on_datastore_error
+
+    # -- Blocking or ignoring visitors --
+
+    # 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.
+    #
+    # @example
+    #    Proc.new do |request|
+    #      ...
+    #    end
+    #
+    # The default implementation does a simple test of whether the request's
+    # HTTP_USER_AGENT header contains a URI, since well behaved bots typically
+    # include a reference URI in their user agent strings. (Original idea:
+    # http://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 { ... }.
+    #
+    # @since 2.0.0
+    attr_writer :request_filter
+
+    # Path to Vanity templates. Set this to override those in the gem.
+    attr_writer :templates_path
+
+    # Path to Vanity locales. Set this to override those in the gem.
+    attr_writer :locales_path
+
+    # -- Robot Detection --
+
+    # 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.
+    attr_writer :use_js
+    # Uses ./config by default.
+    attr_writer :config_path
+    # 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.
+    attr_writer :config_file
+    # In order of precedence, RACK_ENV, RAILS_ENV or `development`.
+    attr_writer :environment
+
+
+    # We independently list each attr_accessor to includes docs, otherwise
+    # something like DEFAULTS.each { |key, value| attr_accessor key } would be
+    # shorter.
+    DEFAULTS.each do |default, value|
+      define_method default do
+        self[default]
+      end
+    end
+
+    def [](arg)
+      if instance_variable_defined?("@#{arg}")
+        instance_variable_get("@#{arg}")
+      else
+        DEFAULTS[arg]
+      end
+    end
+
+    def setup_locales
+      locales = Dir[File.join(locales_path, '*.{rb,yml}')]
+      I18n.load_path += locales
+    end
+
+    # @return nil or a hash of symbolized keys for connection settings
+    def connection_params(file_name=nil)
+      file_name ||= config_file
+      file_path = File.join(config_path, file_name)
+
+      if File.exists?(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
+
+    # @deprecated
+    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
+  end
+end