Merge pull request #144 from MITLibraries/tco-101

Finish implementing confirmation workflow

Author: matt-bernhardt

.rubocop_todo.yml

@@ -112,6 +112,7 @@ Rails/I18nLocaleTexts:
   Exclude:
     - 'app/controllers/admin/application_controller.rb'
     - 'app/controllers/application_controller.rb'
+    - 'app/controllers/confirmation_controller.rb'
 
 # Offense count: 25
 # Configuration parameters: AllowedConstants.

app/controllers/confirmation_controller.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+class ConfirmationController < ApplicationController
+  rescue_from ActiveRecord::RecordNotUnique, with: :error_not_unique
+
+  # new populates instance variables used by the new confirmation form.
+  def new
+    @term = Term.find(params[:term_id])
+    @categories = Category.all
+    @confirmation = Confirmation.new
+  end
+
+  # create receives the submission from the new confirmation form, creating the needed record with the help of various
+  # private methods.
+  def create
+    new_record = Confirmation.new(confirmation_params)
+
+    if new_record.save
+      # Now that the confirmation has saved, set the flag on the related Term record.
+      flag_term(params[:term_id]) if confirmation_flag?(params[:confirmation][:category_id])
+
+      # By this point, saving has succeeded
+      feedback_for(confirmation_flag?(params[:confirmation][:category_id]))
+      redirect_to terms_unconfirmed_path
+    else
+      error_cannot_save
+    end
+  end
+
+  private
+
+  def confirmation_params
+    params.require(:confirmation).permit(:term_id, :category_id, :user_id)
+  end
+
+  # feedback_for defines an appropriate flash message, based on whether the user has placed the term in the "flagged"
+  # category or not.
+  def feedback_for(flagged)
+    if flagged == true
+      flash[:success] = 'Term flagged for review'
+    else
+      flash[:success] = "Term confirmed as #{Category.find_by(id: params[:confirmation][:category_id]).name}"
+    end
+  end
+
+  # error_cannot_save catches cases where the received Confirmation record cannot be saved, for whatever reason.
+  def error_cannot_save
+    flash[:error] = 'Unable to finish confirming this term. Please try again, or try a different term.'
+    Sentry.capture_message('Unable to confirm term in a category')
+    redirect_to terms_unconfirmed_path
+  end
+
+  # error_not_unique catches the RecordNotUnique error in case a duplicate confirmation is ever submitted, and shows an
+  # appropriate error message to the user.
+  def error_not_unique(exception)
+    flash[:error] = 'Duplicate confirmations are not supported'
+    Sentry.capture_message(exception.message)
+    redirect_to terms_unconfirmed_path
+  end
+
+  # flag_term sets the "flagged" boolean field on a Term record when a Confirmation comes in for that category.
+  def flag_term(term_id)
+    t = Term.find_by(id: term_id)
+    t.flag = true
+    t.save
+  end
+
+  # confirmation_flag? compares the submitted category (coerced to an integer) to the ID value for the "flagged"
+  # category.
+  #
+  # @param submission e.g. params[:confirmation][:category]
+  # @return boolean
+  def confirmation_flag?(submission)
+    submission.to_i == Category.find_by(name: 'Flagged').id
+  end
+end

app/controllers/term_controller.rb

@@ -3,12 +3,8 @@
 class TermController < ApplicationController
   include Pagy::Backend
 
-  def confirm_index
+  # This provides the list of terms that are awaiting confirmation.
+  def unconfirmed
     @pagy, @records = pagy(Term.user_unconfirmed)
   end
-
-  def confirm_term
-    @term = Term.find(params[:id])
-    @categories = Category.all
-  end
 end

app/models/confirmation.rb

@@ -5,11 +5,9 @@
 # during the categorization workflow. Most of the time, we anticipate that the
 # user will place the term into one of the primary categories. If no category
 # seems appropriate, there is an "undefined" option available (which is not
-# used by TACOS normally).
-#
-# There is also a "flag" boolean field available, in case the user feels that
-# the term should be reviewed and removed from the dataset entirely. This flag
-# is why the category field is not a required value.
+# used by TACOS' automated categorization workflow). There is also a "flagged"
+# category, in case the user feels that the term should be reviewed and removed
+# from the dataset entirely.
 #
 # == Schema Information
 #
@@ -18,13 +16,12 @@
 #  id          :integer          not null, primary key
 #  user_id     :integer          not null
 #  term_id     :integer          not null
-#  category_id :integer
-#  flag        :boolean
+#  category_id :integer          not null
 #  created_at  :datetime         not null
 #  updated_at  :datetime         not null
 #
 class Confirmation < ApplicationRecord
   belongs_to :user
   belongs_to :term
-  belongs_to :category, optional: true
+  belongs_to :category
 end

app/models/term.rb

@@ -11,6 +11,7 @@
 #  phrase     :string
 #  created_at :datetime         not null
 #  updated_at :datetime         not null
+#  flag       :boolean
 #
 class Term < ApplicationRecord
   has_many :search_events, dependent: :destroy

app/views/confirmation/new.html.erb

@@ -0,0 +1,38 @@
+<h3>Term confirmation form</h3>
+<p>Please put the following term into one of the categories below.</p>
+<div class="well">
+  <p><%= @term.phrase %></p>
+</div>
+<%= form_for @confirmation, url: term_confirmation_index_path(@term)  do |f| %>
+  <%= hidden_field(:confirmation, :term_id, :value => @term.id) %>
+  <%= hidden_field(:confirmation, :user_id, :value => current_user.id) %>
+  <fieldset>
+  <legend>Available categories</legend>
+  <ul class="list-unbulleted categories">
+    <% @categories.all.each do |cat| %>
+      <li>
+        <%= f.radio_button :category_id, cat.id, required: 'required' %>
+        <div>
+          <%= f.label(:category_id, cat.name, :value => cat.id) do
+            content_tag(:p, cat.name)
+          end %>
+          <p><%= cat.description %></p>
+        </div>
+      </li>
+    <% end %>
+  </ul>
+  </fieldset>
+  <%= f.submit %>
+<% end %>
+
+<style type="text/css">
+ul.categories li {
+  display: flex;
+  flex-flow: row nowrap;
+  align-items: baseline;
+  column-gap: 1rem;
+}
+ul.categories li label p {
+  font-weight: bold;
+}
+</style>

app/views/layouts/_site_nav.html.erb

@@ -11,7 +11,7 @@
           <%= nav_link_to("Home", root_path) %>
           <% if user_signed_in? %>
             <% if can? :manage, Confirmation %>
-              <%= link_to('Confirm terms', confirm_index_path, class: 'nav-item') %>
+              <%= link_to('Confirm terms', terms_unconfirmed_path, class: 'nav-item') %>
             <% end %>
             <% if can? :index, Term %>
               <%= link_to('Admin', admin_root_path, class: 'nav-item') %>

app/views/term/confirm_term.html.erb

@@ -7,7 +7,7 @@ take you to the form for submitting this information.</p>
 
 <ul class="list-unbulleted">
 <% @records.each do |t| %>
-  <li><%= link_to(t.phrase, confirm_term_path(t)) %></li>
+  <li><%= link_to(t.phrase, new_term_confirmation_path(t)) %></li>
 <% end %>
 </ul>
 

app/views/term/confirm_index.html.erb app/views/term/unconfirmed.html.erbapp/views/term/confirm_index.html.erb renamed to app/views/term/unconfirmed.html.erb

@@ -39,8 +39,10 @@
   get '/report/algorithm_metrics', to: 'report#algorithm_metrics'
 
   # Confirmation interface
-  get '/confirm', to: 'term#confirm_index', as: 'confirm_index'
-  get '/confirm/:id', to: 'term#confirm_term', as: 'confirm_term'
+  get '/terms/unconfirmed', to: 'term#unconfirmed', as: 'terms_unconfirmed'
+  resources :terms do
+    resources :confirmation, only: [:new, :create]
+  end
 
   # Defines the root path route ("/")
   root to: 'static#index'