trailguide 0.1.20 → 0.1.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c45506f04eec39f23d00fce31f84d1d1e24f4289e2870af413f8928d54cceef8
-  data.tar.gz: 1b6cb001e0fa544f6390e4a82e265922f9ab75b602f4406a2cddf337704fd076
+  metadata.gz: ec80228061f031c01c0eb4d6dbef24d52ca205ccf2e6137ebe3a18886b095258
+  data.tar.gz: 6fa47e1dd04511cbb35d39a737589a34658fcc9d1f0dde64298908a9ca539f27
 SHA512:
-  metadata.gz: 757e5c2ad76a1143db739638fc60ccaf263d047c2ea3f41172c74368c8c3a2744ba760b0255c6393623ba2266df5e6ec4bff3f3c4e6898370eeefb536b7b5e0b
-  data.tar.gz: 820c4664c60c161dfad8e81dcab8cb61e4137d9961c97e5b0da3f9dfdb5e496692d3bc1bd7f9784645095dfb4be38c75bb73604b80e6e855d42ec2bdac187de0
+  metadata.gz: ca6d1439e8632ec16946dcfc50e5201f24714a568a2b99c234d0ed666db6a6149724aeea7190be7669fe06dc232619cce6ead9211f175c1a518d2b6458dff7d4
+  data.tar.gz: 7ab9d62c95a8c3b0a63fd1b09f0b51bea8d021b98a6797acff0658fbe8a718d5b8665458df8b92b31e89c2e606788d1aa677e96a1ce21dfeb2516e780e8bfacb

data/app/controllers/trail_guide/admin/application_controller.rb

@@ -15,6 +15,38 @@ module TrailGuide
         end
       end
       helper_method :preview_url
+
+      def experiment_peekable?(experiment)
+        return false unless TrailGuide::Admin.configuration.peek_parameter
+        return false unless experiment.running?
+        return false if experiment.target_sample_size_reached?
+        return true
+      end
+      helper_method :experiment_peekable?
+
+      def experiment_peeking?(experiment)
+        params[TrailGuide::Admin.configuration.peek_parameter] == experiment.experiment_name.to_s
+      end
+      helper_method :experiment_peeking?
+
+      def experiment_metrics_visible?(experiment)
+        return true unless experiment.running?
+        return true if params[TrailGuide::Admin.configuration.peek_parameter] == experiment.experiment_name.to_s
+        return true if experiment.target_sample_size_reached?
+        return false
+      end
+      helper_method :experiment_metrics_visible?
+
+      def experiment_metric(experiment, metric)
+        return metric if experiment_metrics_visible?(experiment)
+        return '?'
+      end
+      helper_method :experiment_metric
+
+      def peek_url(experiment, *args, **opts)
+        trail_guide_admin.experiments_url(*args, opts.merge({TrailGuide::Admin.configuration.peek_parameter => experiment.experiment_name, anchor: experiment.experiment_name}))
+      end
+      helper_method :peek_url
     end
   end
 end

data/app/views/trail_guide/admin/experiments/_combined_experiment.html.erb

@@ -8,6 +8,13 @@
       </div>
       <div class="col-sm-12 col-md-6 col-lg-4 text-right">
         <% if combined_experiment.running? %>
+          <% if experiment_peekable?(combined_experiment) %>
+            <% if experiment_peeking?(combined_experiment) %>
+              <%= link_to "hide", trail_guide_admin.experiments_path(anchor: combined_experiment.experiment_name), class: 'btn btn-sm btn-outline-primary', method: :put %>
+            <% else %>
+              <%= link_to "peek", peek_url(combined_experiment), class: 'btn btn-sm btn-primary', method: :put %>
+            <% end %>
+          <% end %>
           <%= link_to "stop", trail_guide_admin.stop_experiment_path(combined_experiment.experiment_name), class: 'btn btn-sm btn-warning', method: :put %>
           <%= link_to "restart", trail_guide_admin.restart_experiment_path(combined_experiment.experiment_name), class: 'btn btn-sm btn-danger',method: :put %>
         <% elsif combined_experiment.started? %>
@@ -84,13 +91,13 @@
                 <% end %>
               </th>
 
-              <td><%= variant.participants %></td>
+              <td><%= experiment_metric combined_experiment, variant.participants %></td>
 
               <% if experiment.goals.empty? %>
-                <td><%= variant.converted %></td>
+                <td><%= experiment_metric combined_experiment, variant.converted %></td>
               <% else %>
                 <% experiment.goals.each do |goal| %>
-                  <td><%= variant.converted(goal) %></td>
+                  <td><%= experiment_metric combined_experiment, variant.converted(goal) %></td>
                 <% end %>
               <% end %>
 
@@ -117,12 +124,17 @@
       <tfoot class="thead-light">
         <tr>
           <th scope="row">&nbsp;</th>
-          <th><%= combined_experiment.variants.sum(&:participants) %></th>
+          <th>
+            <span><%= combined_experiment.participants %></span>
+            <% if combined_experiment.configuration.target_sample_size %>
+              <span class="text-muted">/ <%= combined_experiment.configuration.target_sample_size %></span>
+            <% end %>
+          </th>
           <% if combined_experiment.goals.empty? %>
-            <th><%= combined_experiments.sum { |e| e.variants.sum(&:converted) } %></th>
+            <th><%= experiment_metric combined_experiment, combined_experiments.sum(&:converted) %></th>
           <% else %>
             <% combined_experiment.goals.each do |goal| %>
-              <th><%= combined_experiments.sum { |e| e.variants.sum { |v| v.converted(goal) } } %></th>
+              <th><%= experiment_metric combined_experiment, combined_experiments.sum { |e| e.converted(goal) } %></th>
             <% end %>
           <% end %>
           <th>&nbsp;</th>

data/app/views/trail_guide/admin/experiments/_experiment.html.erb

@@ -8,6 +8,13 @@
       </div>
       <div class="col-sm-12 col-md-6 col-lg-4 text-right">
         <% if experiment.running? %>
+          <% if experiment_peekable?(experiment) %>
+            <% if experiment_peeking?(experiment) %>
+              <%= link_to "hide", trail_guide_admin.experiments_path(anchor: experiment.experiment_name), class: 'btn btn-sm btn-outline-primary', method: :put %>
+            <% else %>
+              <%= link_to "peek", peek_url(experiment), class: 'btn btn-sm btn-primary', method: :put %>
+            <% end %>
+          <% end %>
           <%= link_to "stop", trail_guide_admin.stop_experiment_path(experiment.experiment_name), class: 'btn btn-sm btn-warning', method: :put %>
           <%= link_to "restart", trail_guide_admin.restart_experiment_path(experiment.experiment_name), class: 'btn btn-sm btn-danger',method: :put %>
         <% elsif experiment.started? %>
@@ -78,13 +85,13 @@
               <% end %>
             </th>
 
-            <td><%= variant.participants %></td>
+            <td><%= experiment_metric experiment, variant.participants %></td>
 
             <% if experiment.goals.empty? %>
-              <td><%= variant.converted %></td>
+              <td><%= experiment_metric experiment, variant.converted %></td>
             <% else %>
               <% experiment.goals.each do |goal| %>
-                <td><%= variant.converted(goal) %></td>
+                <td><%= experiment_metric experiment, variant.converted(goal) %></td>
               <% end %>
             <% end %>
 
@@ -110,12 +117,17 @@
       <tfoot class="thead-light">
         <tr>
           <th scope="row">&nbsp;</th>
-          <th><%= experiment.variants.sum(&:participants) %></th>
+          <th>
+            <span><%= experiment.participants %></span>
+            <% if experiment.configuration.target_sample_size %>
+              <span class="text-muted">/ <%= experiment.configuration.target_sample_size %></span>
+            <% end %>
+          </th>
           <% if experiment.goals.empty? %>
-            <th><%= experiment.variants.sum(&:converted) %></th>
+            <th><%= experiment_metric experiment, experiment.converted %></th>
           <% else %>
             <% experiment.goals.each do |goal| %>
-              <th><%= experiment.variants.sum { |var| var.converted(goal) } %></th>
+              <th><%= experiment_metric experiment, experiment.converted(goal) %></th>
             <% end %>
           <% end %>
           <th>&nbsp;</th>

data/config/initializers/trailguide.rb

@@ -7,6 +7,13 @@ TrailGuide.configure do |config|
   # globally disable trailguide - returns control everywhere
   config.disabled = false
 
+  # whether or not to include TrailGuide::Helper into controller and view
+  # contexts
+  #
+  # true      the helper module is automatically mixed-in to controllers/views
+  # false     you'll need to include the helper module manually where you want
+  config.include_helpers = true
+
   # request param for overriding/previewing variants - allows previewing
   # variants with request params
   # i.e. example.com/somepage/?experiment[my_experiment]=option_b
@@ -146,6 +153,12 @@ TrailGuide::Experiment.configure do |config|
   # false   default behavior, requests will be filtered based on your config
   config.skip_request_filter = false
 
+  # set a default target sample size for all experiments - this will prevent
+  # metrics and stats from being displayed in the admin UI until the sample size
+  # is reached or the experiment is stopped
+  #
+  # config.target_sample_size = nil
+
   # callback when connecting to redis fails and trailguide falls back to always
   # returning control variants
   config.on_redis_failover = -> (experiment, error) do
@@ -227,6 +240,19 @@ end
 # admin ui configuration
 #
 TrailGuide::Admin.configure do |config|
+  # display title for admin UI
+  #
   config.title = 'TrailGuide'
+
+  # display subtitle for admin UI
+  #
   config.subtitle = 'Experiments and A/B Tests'
+
+  # request parameter can be used to "peek" at results even before an
+  # experiment's target_sample_size has been hit if one is configured
+  #
+  # if you set this to nil, admins will not be able to peek at experiment
+  # results until the target sample size is hit or the experiment is stopped
+  #
+  config.peek_parameter = nil
 end

data/lib/trail_guide/config.rb

@@ -3,7 +3,7 @@ module TrailGuide
     DEFAULT_KEYS = [
       :redis, :disabled, :override_parameter, :allow_multiple_experiments,
       :adapter, :on_adapter_failover, :filtered_ip_addresses,
-      :filtered_user_agents, :request_filter
+      :filtered_user_agents, :request_filter, :include_helpers
     ].freeze
 
     def initialize(*args, **opts, &block)

data/lib/trail_guide/engine.rb

@@ -8,8 +8,10 @@ module TrailGuide
 
     initializer "trailguide" do |app|
       TrailGuide::Catalog.load_experiments!
-      ActionController::Base.send :include, TrailGuide::Helper
-      ActionController::Base.helper TrailGuide::Helper
+      if TrailGuide.configuration.include_helpers
+        ActionController::Base.send :include, TrailGuide::Helper
+        ActionController::Base.helper TrailGuide::Helper
+      end
     end
   end
 end

data/lib/trail_guide/experiments/base.rb

@@ -131,6 +131,24 @@ module TrailGuide
           reset
         end
 
+        def participants
+          variants.sum(&:participants)
+        end
+
+        def converted(checkpoint=nil)
+          variants.sum { |var| var.converted(checkpoint) }
+        end
+
+        def unconverted
+          participants - converted
+        end
+
+        def target_sample_size_reached?
+          return true unless configuration.target_sample_size
+          return true if participants >= configuration.target_sample_size
+          return false
+        end
+
         def as_json(opts={})
           { experiment_name => {
             configuration: {

data/lib/trail_guide/experiments/config.rb

@@ -5,7 +5,7 @@ module TrailGuide
         :name, :summary, :preview_url, :algorithm, :metric, :variants, :goals,
         :start_manually, :reset_manually, :store_override, :track_override,
         :combined, :allow_multiple_conversions, :allow_multiple_goals,
-        :track_winner_conversions, :skip_request_filter
+        :track_winner_conversions, :skip_request_filter, :target_sample_size
       ].freeze
 
       CALLBACK_KEYS = [

data/lib/trail_guide/experiments/participant.rb

@@ -9,15 +9,15 @@ module TrailGuide
       end
 
       def participating?
-        participant.participating?(experiment)
+        @participating ||= variant.present?#participant.participating?(experiment)
       end
 
       def converted?(checkpoint=nil)
-        participant.converted?(experiment, checkpoint)
+        @converted ||= participant.converted?(experiment, checkpoint)
       end
 
       def variant
-        participant.variant(experiment)
+        @variant ||= participant.variant(experiment)
       end
 
       def method_missing(meth, *args, &block)

data/lib/trail_guide/participant.rb

@@ -1,12 +1,13 @@
 module TrailGuide
   class Participant
-    attr_reader :context
+    attr_reader :context, :variants
     delegate :key?, :keys, :[], :[]=, :delete, :destroy!, :to_h, to: :adapter
 
     def initialize(context, adapter: nil)
       @context = context
       @adapter = adapter.new(context) unless adapter.nil?
-      cleanup_inactive_experiments!
+      @variants = {}
+      #cleanup_inactive_experiments!
     end
 
     def adapter
@@ -36,6 +37,7 @@ module TrailGuide
     end
 
     def participating?(experiment, include_control=true)
+      return variants[experiment.storage_key] if variants.key?(experiment.storage_key)
       return false unless experiment.started?
       return false unless adapter.key?(experiment.storage_key)
       varname = adapter[experiment.storage_key]
@@ -44,7 +46,10 @@ module TrailGuide
       return false unless variant && adapter.key?(variant.storage_key)
 
       chosen_at = Time.at(adapter[variant.storage_key].to_i)
-      return variant if chosen_at >= experiment.started_at
+      if chosen_at >= experiment.started_at
+        variants[experiment.storage_key] = variant
+        return variant
+      end
     end
 
     def converted?(experiment, checkpoint=nil)

data/lib/trail_guide/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trailguide
 version: !ruby/object:Gem::Version
-  version: 0.1.20
+  version: 0.1.21
 platform: ruby
 authors:
 - Mark Rebec
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-12 00:00:00.000000000 Z
+date: 2019-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails