trailguide 0.2.1 → 0.3.0

data/lib/trail_guide/metrics/config.rb

@@ -32,11 +32,13 @@ module TrailGuide
 
       # TODO do we allow a method here? do we call it on the experiment?
       def allow_conversion(meth=nil, &block)
+        raise ArgumentError if meth.nil? && !block_given?
         self[:allow_conversion] ||= []
         self[:allow_conversion] << (meth || block)
       end
 
       def on_convert(meth=nil, &block)
+        raise ArgumentError if meth.nil? && !block_given?
         self[:on_convert] ||= []
         self[:on_convert] << (meth || block)
       end

data/lib/trail_guide/metrics/goal.rb

@@ -30,11 +30,12 @@ module TrailGuide
         elsif other.is_a?(String) || other.is_a?(Symbol)
           other = other.to_s.underscore
           return name == other.to_sym || to_s == other
-        elsif other.is_a?(Array)
-          return to_s == other.flatten.map { |o| o.to_s.underscore }.join('/')
-        elsif other.is_a?(Hash)
-          # TODO "flatten" it out and compare it to_s
-          return false
+        # Currently unused placeholder for future functionality
+        #elsif other.is_a?(Array)
+        #  return to_s == other.flatten.map { |o| o.to_s.underscore }.join('/')
+        #elsif other.is_a?(Hash)
+        #  # TODO "flatten" it out and compare it to_s
+        #  return false
         end
       end
 
@@ -58,16 +59,17 @@ module TrailGuide
               trial.send(callback, trial, result, self, *args)
             end
           end
-        else
-          args.unshift(self)
-          args.unshift(trial)
-          callbacks[hook].each do |callback|
-            if callback.respond_to?(:call)
-              callback.call(*args)
-            else
-              trial.send(callback, *args)
-            end
-          end
+        # Currently unused placeholder for future functionality
+        #else
+        #  args.unshift(self)
+        #  args.unshift(trial)
+        #  callbacks[hook].each do |callback|
+        #    if callback.respond_to?(:call)
+        #      callback.call(*args)
+        #    else
+        #      trial.send(callback, *args)
+        #    end
+        #  end
         end
       end
 

data/lib/trail_guide/participant.rb

@@ -6,10 +6,12 @@ module TrailGuide
     def initialize(context, adapter: nil)
       @context = context
       @adapter = adapter.new(context) if adapter.present?
+
       cleanup_inactive_experiments! if TrailGuide.configuration.cleanup_participant_experiments == true
     end
 
     def adapter
+      # TODO move this case selection to Adapters::Participant (like Algorithms)?
       @adapter ||= begin
         config_adapter = TrailGuide.configuration.adapter
         case config_adapter
@@ -37,6 +39,7 @@ module TrailGuide
 
     def variant(experiment)
       return nil unless experiment.calibrating? || experiment.started?
+      # TODO more efficient to stop checking if keys exist, and just return if the value is blank??
       return nil unless adapter.key?(experiment.storage_key)
       varname = adapter[experiment.storage_key]
       variant = experiment.variants.find { |var| var == varname }
@@ -126,6 +129,7 @@ module TrailGuide
       active = adapter.keys.map { |key| key.to_s.split(":").first.to_sym }.uniq.map do |key|
         experiment = TrailGuide.catalog.find(key)
         next unless experiment
+        next unless experiment.configuration.sticky_assignment?
 
         if !experiment.started? && !experiment.calibrating?
           inactive << key
@@ -142,17 +146,21 @@ module TrailGuide
         end.each { |key| adapter.delete(key) }
       end
 
+      return false if active.empty?
       return active
     end
 
     def calibrating_experiments
       return false if adapter.keys.empty?
 
-      adapter.keys.map { |key| key.to_s.split(":").first.to_sym }.uniq.map do |key|
+      calibrating = adapter.keys.map { |key| key.to_s.split(":").first.to_sym }.uniq.map do |key|
         experiment = TrailGuide.catalog.find(key)
         next unless experiment && experiment.calibrating?
         [ experiment.experiment_name, adapter[experiment.storage_key] ]
       end.compact.to_h
+
+      return false if calibrating.empty?
+      return calibrating
     end
 
     def participating_in_active_experiments?(include_control=true)
@@ -161,7 +169,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.combined? && experiment.running? && participating?(experiment, include_control)
+        experiment && experiment.configuration.sticky_assignment? && !experiment.combined? && experiment.running? && participating?(experiment, include_control)
       end
     end
 

data/lib/trail_guide/unity.rb

@@ -1,13 +1,22 @@
 module TrailGuide
   class Unity
-    NAMESPACE = :unity
+    class << self
+      def configuration
+        @configuration ||= Canfig::Config.new(namespace: :unity)
+      end
+
+      def configure(*args, &block)
+        configuration.configure(*args, &block)
+      end
 
-    def self.clear!
-      keys = TrailGuide.redis.keys("#{NAMESPACE}:*")
-      TrailGuide.redis.del *keys unless keys.empty?
+      def clear!
+        keys = TrailGuide.redis.keys("#{configuration.namespace}:*")
+        TrailGuide.redis.del *keys unless keys.empty?
+      end
     end
 
     attr_reader :visitor_id, :user_id
+    delegate :configuration, to: :class
 
     def initialize(user_id: nil, visitor_id: nil)
       @user_id = user_id.to_s if user_id.present?
@@ -74,19 +83,19 @@ module TrailGuide
     protected
 
     def user_key
-      "#{NAMESPACE}:uids:#{user_id}"
+      "#{configuration.namespace}:uids:#{user_id}"
     end
 
     def visitor_key
-      "#{NAMESPACE}:vids:#{visitor_id}"
+      "#{configuration.namespace}:vids:#{visitor_id}"
     end
 
     def stored_user_key
-      "#{NAMESPACE}:uids:#{stored_user_id}"
+      "#{configuration.namespace}:uids:#{stored_user_id}"
     end
 
     def stored_visitor_key
-      "#{NAMESPACE}:vids:#{stored_visitor_id}"
+      "#{configuration.namespace}:vids:#{stored_visitor_id}"
     end
   end
 end

data/lib/trail_guide/variant.rb

@@ -14,6 +14,10 @@ module TrailGuide
       @control = control
     end
 
+    def adapter
+      @adapter ||= TrailGuide::Adapters::Variants::Redis.new(self)
+    end
+
     def ==(other)
       if other.is_a?(self.class)
         # TODO eventually remove the experiment requirement here once we start
@@ -48,15 +52,15 @@ module TrailGuide
     end
 
     def persisted?
-      TrailGuide.redis.exists(storage_key)
+      adapter.persisted?
     end
 
     def save!
-      TrailGuide.redis.hsetnx(storage_key, 'name', name)
+      adapter.setnx(:name, name)
     end
 
     def delete!
-      TrailGuide.redis.del(storage_key)
+      adapter.destroy
     end
 
     def reset!
@@ -65,20 +69,20 @@ module TrailGuide
     end
 
     def participants
-      (TrailGuide.redis.hget(storage_key, 'participants') || 0).to_i
+      (adapter.get(:participants) || 0).to_i
     end
 
     def converted(checkpoint=nil)
       if experiment.goals.empty?
         raise InvalidGoalError, "You provided the checkpoint `#{checkpoint}` but the experiment `#{experiment.experiment_name}` does not have any goals defined." unless checkpoint.nil?
-        (TrailGuide.redis.hget(storage_key, 'converted') || 0).to_i
+        (adapter.get(:converted) || 0).to_i
       elsif !checkpoint.nil?
         goal = experiment.goals.find { |g| g == checkpoint }
         raise InvalidGoalError, "Invalid goal checkpoint `#{checkpoint}` for experiment `#{experiment.experiment_name}`." if goal.nil?
-        (TrailGuide.redis.hget(storage_key, goal.to_s) || 0).to_i
+        (adapter.get(goal.name) || 0).to_i
       else
         experiment.goals.sum do |goal|
-          (TrailGuide.redis.hget(storage_key, goal.to_s) || 0).to_i
+          (adapter.get(goal.name) || 0).to_i
         end
       end
     end
@@ -95,16 +99,16 @@ module TrailGuide
     end
 
     def increment_participation!
-      TrailGuide.redis.hincrby(storage_key, 'participants', 1)
+      adapter.increment(:participants)
     end
 
     def increment_conversion!(checkpoint=nil)
       if checkpoint.nil?
-        checkpoint = 'converted'
+        checkpoint = :converted
       else
-        checkpoint = experiment.goals.find { |g| g == checkpoint }.to_s
+        checkpoint = experiment.goals.find { |g| g == checkpoint }.name
       end
-      TrailGuide.redis.hincrby(storage_key, checkpoint, 1)
+      adapter.increment(checkpoint)
     end
 
     # export the variant state (not config) as json

data/lib/trail_guide/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trailguide
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Mark Rebec
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-31 00:00:00.000000000 Z
+date: 2019-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -228,11 +228,15 @@ files:
 - app/views/trail_guide/admin/groups/index.html.erb
 - app/views/trail_guide/admin/groups/show.html.erb
 - app/views/trail_guide/admin/orphans/_alert.html.erb
+- config/initializers/admin.rb
 - config/initializers/assets.rb
+- config/initializers/experiment.rb
 - config/initializers/trailguide.rb
 - config/routes/admin.rb
 - config/routes/engine.rb
 - lib/trail_guide/adapters.rb
+- lib/trail_guide/adapters/experiments.rb
+- lib/trail_guide/adapters/experiments/redis.rb
 - lib/trail_guide/adapters/participants.rb
 - lib/trail_guide/adapters/participants/anonymous.rb
 - lib/trail_guide/adapters/participants/base.rb
@@ -241,12 +245,16 @@ files:
 - lib/trail_guide/adapters/participants/redis.rb
 - lib/trail_guide/adapters/participants/session.rb
 - lib/trail_guide/adapters/participants/unity.rb
+- lib/trail_guide/adapters/variants.rb
+- lib/trail_guide/adapters/variants/redis.rb
 - lib/trail_guide/admin.rb
 - lib/trail_guide/admin/engine.rb
 - lib/trail_guide/algorithms.rb
+- lib/trail_guide/algorithms/algorithm.rb
 - lib/trail_guide/algorithms/bandit.rb
 - lib/trail_guide/algorithms/distributed.rb
 - lib/trail_guide/algorithms/random.rb
+- lib/trail_guide/algorithms/static.rb
 - lib/trail_guide/algorithms/weighted.rb
 - lib/trail_guide/calculators.rb
 - lib/trail_guide/calculators/bayesian.rb
@@ -263,6 +271,8 @@ files:
 - lib/trail_guide/experiments/config.rb
 - lib/trail_guide/experiments/participant.rb
 - lib/trail_guide/helper.rb
+- lib/trail_guide/helper/experiment_proxy.rb
+- lib/trail_guide/helper/helper_proxy.rb
 - lib/trail_guide/metrics.rb
 - lib/trail_guide/metrics/checkpoint.rb
 - lib/trail_guide/metrics/config.rb
@@ -294,7 +304,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.9
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: User experiments for rails