trailguide 0.4.4 → 0.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c099d61bcdf95cc843e70c0f6d29181e98a0b406223c9da34f58c5acbc512275
-  data.tar.gz: 86d169432b3f218fd174b52b0b1bb8e16134dbfbac3e4d8b16064f5b077e1926
+  metadata.gz: e93ca2d83d4cdd34db5aabbf756d177659c1adaad045dbcf9b80bb0511c36b6e
+  data.tar.gz: ffcf53c636b650b2ab578d69078df41b13f828a48c72feb5eebcbd79b221f5a6
 SHA512:
-  metadata.gz: c6ded8b6d09c96fa94238274675b4450163cd71d83a6c8275d590a2dede66435b5e89aacf95afc91d78f1a04a26dae4763a78c432455b9d9de3e015433760458
-  data.tar.gz: 1819ff2788259221bdd5e4942df7d3b5f99320b3dc2319602fd5174b3922bcf72248e65fc715e685590e3aa4676c704fb3e8f99256e7457c3316660925daf341
+  metadata.gz: 1414ca1f5aff67e105d3e1ce840608a02ee3542df0952b9bcf3c8e6668f8f0d122d7679d9eac65b16f816b8e665b084d3d8a42f4f91fe1fc06435a9758090c46
+  data.tar.gz: 067252f1d834adfada65a2adf42e802392adf4164ae3e729ccd7e75b7693ce43598b1e27f64e4f98cfd862628ce83611aba6565d19fd81519da436de51f3970b

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

@@ -4,7 +4,7 @@ module TrailGuide
   module Admin
     class ExperimentsController < ::TrailGuide::Admin::ApplicationController
       before_action except: [:index, :import] do
-        (redirect_to :back rescue redirect_to trail_guide_admin.experiments_path) and return unless experiment.present?
+        (redirect_to :back rescue redirect_to trail_guide_admin.experiments_path) unless experiment.present?
       end
 
       before_action :experiments, only: [:index]

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

@@ -2,7 +2,7 @@ module TrailGuide
   module Admin
     class GroupsController < ::TrailGuide::Admin::ApplicationController
       before_action except: [:index] do
-        (redirect_to :back rescue redirect_to trail_guide_admin.experiments_path) and return unless group.present?
+        (redirect_to :back rescue redirect_to trail_guide_admin.groups_path) unless group.present?
       end
 
       before_action :groups,      only: [:index]

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

@@ -0,0 +1,38 @@
+module TrailGuide
+  module Admin
+    class OrphansController < ::TrailGuide::Admin::ApplicationController
+      before_action except: [:index] do
+        (redirect_to :back rescue redirect_to trail_guide_admin.orphans_path) unless orphan.present?
+      end
+
+      before_action :orphans, only: [:index]
+      before_action :orphan,  only: [:show, :adopt]
+
+      def index
+      end
+
+      def show
+      end
+
+      def adopt
+        TrailGuide.catalog.adopted(@orphan.to_sym)
+        flash[:success] = "Cleared references to <code>#{@orphan}</code>! It will reappear if it is encountered by users again."
+        if TrailGuide.catalog.orphans.count > 0
+          redirect_to trail_guide_admin.orphans_path
+        else
+          redirect_to trail_guide_admin.experiments_path
+        end
+      end
+
+      private
+
+      def orphans
+        @orphans = TrailGuide.catalog.orphans
+      end
+
+      def orphan
+        @orphan, @traces = TrailGuide.catalog.orphans.find { |orphan,_traces| orphan == params[:id].to_s.underscore }
+      end
+    end
+  end
+end

data/app/views/layouts/trail_guide/admin/_footer.html.erb

@@ -14,6 +14,15 @@
       <span class="fas fa-fill" data-toggle="tooltip" title="goals"></span> across
       <strong><%= number_with_delimiter TrailGuide.catalog.all.count %></strong>
       <span class="fas fa-flask" data-toggle="tooltip" title="experiments"></span>
+      <% unless TrailGuide.configuration.ignore_orphaned_groups? || TrailGuide.catalog.orphans.empty? %>
+        &nbsp;&nbsp;&nbsp;
+        <%= link_to trail_guide_admin.orphans_url, style: 'text-decoration: none', data: {toggle: 'tooltip'}, title: 'orphans' do %>
+          <span class="alert-warning" style="background-color: transparent; boder-color: transparent;">
+            <strong><%= number_with_delimiter TrailGuide.catalog.orphans.count %></strong>
+            <span class="fas fa-ghost"></span>
+          </span>
+        <% end %>
+      <% end %>
     </div>
     <div class="col-sm-3 text-right">
       <small class="text-muted"><%= TrailGuide.redis_client.id %><%= "/#{TrailGuide.redis.namespace}" if TrailGuide.redis.respond_to?(:namespace) %></small>

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

@@ -27,7 +27,7 @@
       <% end %>
     <% elsif experiment.started? %>
       <% if experiment.stopped? %>
-        This experiment has been stopped and he control variant will be returned to all participants until it is restarted or a winner is selected. It ran from <strong><%= format_time(experiment.started_at) %></strong> to <strong><%= format_time(experiment.stopped_at) %></strong>.
+        This experiment has been stopped and the control variant will be returned to all participants until it is restarted or a winner is selected. It ran from <strong><%= format_time(experiment.started_at) %></strong> to <strong><%= format_time(experiment.stopped_at) %></strong>.
       <% elsif experiment.paused? %>
         This experiment was paused on <strong><%= format_time(experiment.paused_at) %></strong> paused. The control variant will be returned to all participants until it is resumed, restarted or a winner is selected.
       <% else %>

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

@@ -1,5 +1,3 @@
-<%= render partial: 'trail_guide/admin/orphans/alert' %>
-
 <div class="row justify-content-center">
   <div class="col-12 col-md-10 col-lg-8">
     <div class="experiments">

data/app/views/trail_guide/admin/groups/index.html.erb

@@ -1,5 +1,3 @@
-<%= render partial: 'trail_guide/admin/orphans/alert' %>
-
 <div class="row justify-content-center">
   <div class="col-12 col-md-10 col-lg-8">
     <div class="experiments">

data/app/views/trail_guide/admin/orphans/_alert.html.erb

@@ -1,11 +1,7 @@
 <% unless TrailGuide.configuration.ignore_orphaned_groups? || TrailGuide.catalog.orphans.empty? %>
   <div class="row justify-content-center">
     <div class="col-sm-12 col-md-10 col-lg-8">
-      <div class="alert alert-warning alert-dismissable">
-        <button type="button" class="close" data-dismiss="alert" aria-label="Close">
-          <span aria-hidden="true">&times;</span>
-        </button>
-
+      <div class="alert alert-warning">
         <h5>
           <span class="fas fa-ghost"></span>
           &nbsp;
@@ -16,28 +12,6 @@
         <p>TrailGuide has detected <strong><%= TrailGuide.catalog.orphans.values.sum(&:count) %></strong> calls to <code>trailguide.convert</code> against <strong><%= TrailGuide.catalog.orphans.count %></strong> unknown group <%= "name".pluralize(TrailGuide.catalog.orphans.count) %>.</p>
         
         <p><small>This usually means that the last experiment that belonged to a given group was removed without realizing it, and references to the group were overlooked. <strong>Don't worry, your users won't notice a thing</strong>, and you can find all the logged references below. You can find <%= link_to "more info here.", "https://github.com/markrebec/trailguide#orphaned-groups", target: :blank %></small></p>
-
-        <div class="accordion bg-transparent border-0" id="orphans">
-          <% TrailGuide.catalog.orphans.each do |orphan,traces| %>
-            <div class="card">
-                <button class="btn btn-outline-light text-left btn-block" type="button" data-toggle="collapse" data-target="#orphan-<%= orphan %>" aria-expanded="true" aria-controls="collapseOne">
-                  <strong><code><%= orphan %></code></strong>
-                </button>
-
-              <div id="orphan-<%= orphan %>" class="collapse" aria-labelledby="orphan-btn-<%= orphan %>" data-parent="#orphans">
-                <div class="card-body">
-                  <ul style="list-style: none;">
-                    <% traces.each do |trace| %>
-                      <li><code><%= trace %></code></li>
-                    <% end %>
-                  </ul>
-                </div>
-              </div>
-            </div>
-          <% end %>
-        </div>
-
-        <p><small>These warnings will expire after 15 minutes of inactivity, and they will disappear automatically once you remove the references listed above and are no longer being reactivated. If you prefer to clear these warnings immediately after cleaning up, you can run <code>TrailGuide.catalog.adopted(:group_name)</code> from a console, rake task, or background job.</small></p>
       </div>
     </div>
   </div>

data/app/views/trail_guide/admin/orphans/index.html.erb

@@ -0,0 +1,33 @@
+<%= render partial: 'trail_guide/admin/orphans/alert' %>
+
+<div class="row justify-content-center">
+  <div class="col-12 col-md-10 col-lg-8">
+    <div class="experiments">
+      <% @orphans.each do |orphan,traces| %>
+        <button href="<%= trail_guide_admin.orphan_path(orphan) %>" class="experiment btn btn-outline-warning rounded-lg text-left">
+          <div class="row align-items-center">
+            <div class="col-12 col-md-8 col-lg-9 experiment-text">
+              <h4 id="<%= orphan %>">
+                <%= orphan.to_s.humanize.titleize %>
+              </h4>
+            </div>
+            <div class="col-12 col-md-4 col-lg-3 text-center text-md-right">
+              <div class="row align-items-center">
+                <div class="col-6 col-md-7 col-lg-8 experiment-text text-center">
+                </div>
+
+                <div class="col-6 col-md-5 col-lg-4">
+                  <h4>
+                    <span class="fas fa-ghost"></span>
+                    &times;
+                    <%= traces.count %>
+                  </h4>
+                </div>
+              </div>
+            </div>
+          </div>
+        </button>
+      <% end %>
+    </div>
+  </div>
+</div>

data/app/views/trail_guide/admin/orphans/show.html.erb

@@ -0,0 +1,32 @@
+<div class="row justify-content-center">
+  <div class="col-12 col-md-10 col-lg-8">
+    <div class="row align-items-center">
+      <div class="col-8 col-lg-10">
+        <h1 id="<%= @orphan %>" class="alert-warning" style="background-color: transparent; boder-color: transparent;">
+          <span class="fas fa-ghost"></span>
+          &nbsp;
+          <%= @orphan.to_s.humanize.titleize %>
+        </h1>
+      </div>
+
+      <div class="col-4 col-lg-2 text-right">
+      </div>
+    </div>
+
+    <div class="alert alert-warning">
+      <p>TrailGuide has detected <strong><%= @traces.count %></strong> orphaned calls to <code>trailguide.convert(:<%= @orphan %>)</code>.</p>
+      
+      <p><small>This usually means that the last experiment that belonged to the group was removed without realizing it, and references to the group were overlooked. <strong>Don't worry, your users won't notice a thing</strong>, and you can find all the logged references below. You can find <%= link_to "more info here.", "https://github.com/markrebec/trailguide#orphaned-groups", target: :blank %></small></p>
+    </div>
+
+    <ul style="list-style: none; margin-bottom: 15px;">
+      <% @traces.each do |trace| %>
+        <li><code><%= trace %></code></li>
+      <% end %>
+    </ul>
+
+    <div class="alert alert-info">
+      <p><small>These warnings will expire after 15 minutes of inactivity, and they will disappear automatically once you remove the references listed above. If you prefer to clear these warnings immediately after cleaning up, you can run <code>TrailGuide.catalog.adopted(:group_name)</code> from a console, rake task, or background job or <%= link_to 'click here to clear them immediately', trail_guide_admin.adopt_orphan_url(@orphan) %>.</small></p>
+    </div>
+  </div>
+</div>

data/config/routes/admin.rb

@@ -1,5 +1,10 @@
 TrailGuide::Admin::Engine.routes.draw do
-  resources :groups, only: [:index, :show]
+  resources :groups,  only: [:index, :show]
+  resources :orphans, only: [:index, :show] do
+    member do
+      match :adopt, via: [:put, :post, :get]
+    end
+  end
 
   resources :experiments, path: '/', only: [:index, :show] do
     member do
@@ -21,9 +26,9 @@ TrailGuide::Admin::Engine.routes.draw do
     end
 
     collection do
-      put  '/import', action: :import, as: :import
-      get  '/export', action: :index,  as: :export, format: [:json]
-      get  '/scope/:scope', action: :index, as: :scoped
+      put  '/import',       action: :import, as: :import
+      get  '/export',       action: :index,  as: :export, format: [:json]
+      get  '/scope/:scope', action: :index,  as: :scoped
     end
   end
 end

data/lib/trail_guide/adapters/participants/base.rb

@@ -28,6 +28,11 @@ module TrailGuide
             @config = config
           end
 
+          def subject
+            context.try(:trailguide_user) || context.try(:current_user)
+          end
+          alias_method :user, :subject
+
           def [](key)
             raise NotImplementedError, "You must override the `[]` method in your inheriting adapter class"
           end

data/lib/trail_guide/adapters/participants/redis.rb

@@ -6,6 +6,7 @@ module TrailGuide
         def initialize(&block)
           configure do |config|
             config.namespace = :participants
+            # TODO this can be simplified now that adapters have a contextual subject
             config.lookup = -> (context) {
               context.try(:trailguide_user).try(:id) ||
                 context.try(:current_user).try(:id)

data/lib/trail_guide/experiments/participant.rb

@@ -2,7 +2,7 @@ module TrailGuide
   module Experiments
     class Participant
       attr_reader :experiment, :participant
-      delegate :context, to: :participant
+      delegate :context, :subject, to: :participant
 
       def initialize(experiment, participant)
         @experiment = experiment

data/lib/trail_guide/participant.rb

@@ -1,7 +1,7 @@
 module TrailGuide
   class Participant
     attr_reader :context
-    delegate :key?, :keys, :[], :[]=, :delete, :destroy!, :to_h, to: :adapter
+    delegate :key?, :keys, :[], :[]=, :delete, :destroy!, :to_h, :subject, to: :adapter
 
     def initialize(context, adapter: nil)
       @context = context

data/lib/trail_guide/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trailguide
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.4.5
 platform: ruby
 authors:
 - Mark Rebec
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-12 00:00:00.000000000 Z
+date: 2020-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -196,6 +196,7 @@ files:
 - app/controllers/trail_guide/admin/application_controller.rb
 - app/controllers/trail_guide/admin/experiments_controller.rb
 - app/controllers/trail_guide/admin/groups_controller.rb
+- app/controllers/trail_guide/admin/orphans_controller.rb
 - app/controllers/trail_guide/experiments_controller.rb
 - app/views/layouts/trail_guide/admin/_calculator.erb
 - app/views/layouts/trail_guide/admin/_footer.html.erb
@@ -228,6 +229,8 @@ 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
+- app/views/trail_guide/admin/orphans/index.html.erb
+- app/views/trail_guide/admin/orphans/show.html.erb
 - config/initializers/admin.rb
 - config/initializers/assets.rb
 - config/initializers/experiment.rb