trailguide 0.1.13 → 0.1.14

data/lib/trail_guide/participant.rb

@@ -38,7 +38,7 @@ module TrailGuide
       return false unless variant && adapter.key?(variant.storage_key)
 
       chosen_at = Time.at(adapter[variant.storage_key].to_i)
-      chosen_at >= experiment.started_at
+      return variant if chosen_at >= experiment.started_at
     end
 
     def converted?(experiment, checkpoint=nil)
@@ -68,6 +68,10 @@ module TrailGuide
       end
     end
 
+    def variant(experiment)
+      participating?(experiment) || nil
+    end
+
     def participating!(variant)
       adapter[variant.experiment.storage_key] = variant.name
       adapter[variant.storage_key] = Time.now.to_i
@@ -81,7 +85,7 @@ module TrailGuide
         adapter.delete(variant.experiment.storage_key)
         adapter.delete(variant.storage_key)
         adapter.delete(storage_key)
-        experiment.funnels.each do |funnel|
+        variant.experiment.funnels.each do |funnel|
           funnel_key = "#{variant.experiment.storage_key}:#{funnel.to_s}"
           adapter.delete(funnel_key)
         end
@@ -90,11 +94,22 @@ module TrailGuide
       end
     end
 
+    def exit!(experiment)
+      chosen = variant(experiment)
+      return true if chosen.nil?
+      adapter.delete(experiment.storage_key)
+      adapter.delete(chosen.storage_key)
+      experiment.goals.each do |goal|
+        adapter.delete("#{experiment.storage_key}:#{goal.to_s}")
+      end
+      return true
+    end
+
     def active_experiments(include_control=true)
       return false if adapter.keys.empty?
       adapter.keys.map { |key| key.to_s.split(":").first.to_sym }.uniq.map do |key|
         experiment = TrailGuide.catalog.find(key)
-        next unless experiment && experiment.running? && participating?(experiment, include_control)
+        next unless experiment && !experiment.combined? && experiment.running? && participating?(experiment, include_control)
         [ experiment.experiment_name, adapter[experiment.storage_key] ]
       end.compact.to_h
     end
@@ -105,7 +120,7 @@ module TrailGuide
       adapter.keys.any? do |key|
         experiment_name = key.to_s.split(":").first.to_sym
         experiment = TrailGuide.catalog.find(experiment_name)
-        experiment && experiment.running? && participating?(experiment, include_control)
+        experiment && !experiment.combined? && experiment.running? && participating?(experiment, include_control)
       end
     end
   end

data/lib/trail_guide/version.rb

@@ -2,7 +2,7 @@ module TrailGuide
   module Version
     MAJOR = 0
     MINOR = 1
-    PATCH = 13
+    PATCH = 14
     VERSION = "#{MAJOR}.#{MINOR}.#{PATCH}"
 
     class << self

data/lib/trailguide.rb

@@ -6,6 +6,7 @@ require "trail_guide/algorithms"
 require "trail_guide/participant"
 require "trail_guide/variant"
 require "trail_guide/experiment"
+require "trail_guide/combined_experiment"
 require "trail_guide/catalog"
 require "trail_guide/helper"
 require "trail_guide/engine"
@@ -24,6 +25,7 @@ module TrailGuide
     config.algorithm = :weighted
     config.adapter = :multi
     config.allow_multiple_experiments = true # false / :control
+    config.track_winner_conversions = false
     config.allow_multiple_conversions = false
     config.allow_multiple_goals = false
 
@@ -34,9 +36,12 @@ module TrailGuide
     config.on_experiment_start = nil   # -> (experiment) { ... }
     config.on_experiment_stop = nil    # -> (experiment) { ... }
     config.on_experiment_resume = nil  # -> (experiment) { ... }
+    config.on_experiment_winner = nil  # -> (experiment, winner) { ... }
     config.on_experiment_reset = nil   # -> (experiment) { ... }
     config.on_experiment_delete = nil  # -> (experiment) { ... }
 
+    config.return_experiment_winner = nil # -> (experiment, winner) { ... return variant }
+
     config.filtered_user_agents = []
     config.filtered_ip_addresses = []
     config.request_filter = -> (context) do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trailguide
 version: !ruby/object:Gem::Version
-  version: 0.1.13
+  version: 0.1.14
 platform: ruby
 authors:
 - Mark Rebec
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-06 00:00:00.000000000 Z
+date: 2019-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -111,6 +111,7 @@ files:
 - app/controllers/trail_guide/admin/experiments_controller.rb
 - app/controllers/trail_guide/experiments_controller.rb
 - app/views/layouts/trail_guide/admin/application.html.erb
+- app/views/trail_guide/admin/experiments/_combined_experiment.html.erb
 - app/views/trail_guide/admin/experiments/_experiment.html.erb
 - app/views/trail_guide/admin/experiments/index.html.erb
 - config/routes.rb
@@ -130,10 +131,13 @@ files:
 - lib/trail_guide/algorithms/random.rb
 - lib/trail_guide/algorithms/weighted.rb
 - lib/trail_guide/catalog.rb
+- lib/trail_guide/combined_experiment.rb
 - lib/trail_guide/engine.rb
 - lib/trail_guide/errors.rb
 - lib/trail_guide/experiment.rb
-- lib/trail_guide/experiment_config.rb
+- lib/trail_guide/experiments/base.rb
+- lib/trail_guide/experiments/combined_config.rb
+- lib/trail_guide/experiments/config.rb
 - lib/trail_guide/helper.rb
 - lib/trail_guide/participant.rb
 - lib/trail_guide/unity.rb

data/lib/trail_guide/experiment_config.rb

@@ -1,137 +0,0 @@
-module TrailGuide
-  class ExperimentConfig < Canfig::Config
-    ENGINE_CONFIG_KEYS = [
-      :start_manually, :reset_manually, :store_override, :track_override,
-      :algorithm, :allow_multiple_conversions, :allow_multiple_goals
-    ].freeze
-
-    def self.engine_config
-      ENGINE_CONFIG_KEYS.map do |key|
-        [key, TrailGuide.configuration.send(key.to_sym)]
-      end.to_h
-    end
-
-    def self.default_config
-      { name: nil, metric: nil, variants: [], goals: [] }
-    end
-
-    def self.callbacks_config
-      {
-        callbacks: {
-          on_choose:   [TrailGuide.configuration.on_experiment_choose].flatten.compact,
-          on_use:      [TrailGuide.configuration.on_experiment_use].flatten.compact,
-          on_convert:  [TrailGuide.configuration.on_experiment_convert].flatten.compact,
-          on_start:    [TrailGuide.configuration.on_experiment_start].flatten.compact,
-          on_stop:     [TrailGuide.configuration.on_experiment_stop].flatten.compact,
-          on_resume:   [TrailGuide.configuration.on_experiment_resume].flatten.compact,
-          on_reset:    [TrailGuide.configuration.on_experiment_reset].flatten.compact,
-          on_delete:   [TrailGuide.configuration.on_experiment_delete].flatten.compact,
-        }
-      }
-    end
-
-    attr_reader :experiment
-
-    def initialize(experiment, *args, **opts, &block)
-      @experiment = experiment
-      opts = opts.merge(self.class.engine_config)
-      opts = opts.merge(self.class.default_config)
-      opts = opts.merge(self.class.callbacks_config)
-      super(*args, **opts, &block)
-    end
-
-    def resettable?
-      !reset_manually
-    end
-
-    def allow_multiple_conversions?
-      allow_multiple_conversions
-    end
-
-    def allow_multiple_goals?
-      allow_multiple_goals
-    end
-
-    def name
-      @name ||= (self[:name] || experiment.name).try(:to_s).try(:underscore).try(:to_sym)
-    end
-
-    def metric
-      @metric ||= (self[:metric] || name).try(:to_s).try(:underscore).try(:to_sym)
-    end
-
-    def algorithm
-      @algorithm ||= TrailGuide::Algorithms.algorithm(self[:algorithm])
-    end
-
-    def variant(varname, metadata: {}, weight: 1, control: false)
-      raise ArgumentError, "The variant `#{varname}` already exists in the experiment `#{name}`" if variants.any? { |var| var == varname }
-      control = true if variants.empty?
-      variants.each(&:variant!) if control
-      variant = Variant.new(experiment, varname, metadata: metadata, weight: weight, control: control)
-      variants << variant
-      variant
-    end
-
-    def control
-      return variants.find { |var| var.control? } || variants.first
-    end
-
-    def control=(name)
-      variants.each(&:variant!)
-      var_idx = variants.index { |var| var == name }
-
-      if var_idx.nil?
-        variant = Variant.new(experiment, name, control: true)
-      else
-        variant = variants.slice!(var_idx, 1)[0]
-        variant.control!
-      end
-
-      variants.unshift(variant)
-      variant
-    end
-
-    def goal(name)
-      goals << name.to_s.underscore.to_sym
-    end
-    alias_method :funnel, :goal
-
-    def goals
-      self[:goals]
-    end
-    alias_method :funnels, :goals
-
-    def on_choose(meth=nil, &block)
-      callbacks[:on_choose] << (meth || block)
-    end
-
-    def on_use(meth=nil, &block)
-      callbacks[:on_use] << (meth || block)
-    end
-
-    def on_convert(meth=nil, &block)
-      callbacks[:on_convert] << (meth || block)
-    end
-
-    def on_start(meth=nil, &block)
-      callbacks[:on_start] << (meth || block)
-    end
-
-    def on_stop(meth=nil, &block)
-      callbacks[:on_stop] << (meth || block)
-    end
-
-    def on_resume(meth=nil, &block)
-      callbacks[:on_resume] << (meth || block)
-    end
-
-    def on_reset(meth=nil, &block)
-      callbacks[:on_reset] << (meth || block)
-    end
-
-    def on_delete(meth=nil, &block)
-      callbacks[:on_delete] << (meth || block)
-    end
-  end
-end