Merge pull request #133 from MITLibraries/user-categorization

Simple confirmation workflow

Author: matt-bernhardt

Gemfile

@@ -37,6 +37,9 @@ gem 'omniauth'
 gem 'omniauth_openid_connect'
 gem 'omniauth-rails_csrf_protection'
 
+# Pagy used for pagination on long lists of records
+gem 'pagy', '~> 9.1'
+
 # Parser added explicitly to allow for the namespace to be available for scout
 gem 'parser'
 

Gemfile.lock

@@ -277,6 +277,7 @@ GEM
       validate_url
       webfinger (~> 2.0)
     orm_adapter (0.5.0)
+    pagy (9.1.1)
     parallel (1.26.2)
     parser (3.3.4.2)
       ast (~> 2.4.1)
@@ -490,6 +491,7 @@ DEPENDENCIES
   omniauth
   omniauth-rails_csrf_protection
   omniauth_openid_connect
+  pagy (~> 9.1)
   parser
   pg
   puma (>= 5.0)

app/controllers/term_controller.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class TermController < ApplicationController
+  include Pagy::Backend
+
+  def confirm_index
+    @pagy, @records = pagy(Term.user_unconfirmed)
+  end
+
+  def confirm_term
+    @term = Term.find(params[:id])
+    @categories = Category.all
+  end
+end

app/helpers/application_helper.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
 
 module ApplicationHelper
+  include Pagy::Frontend
 end

app/models/ability.rb

@@ -22,6 +22,10 @@ def initialize(user)
 
     # Allow all authenticated users to view reports
     can :view, :report
+
+    # Create manual confirmation
+    can :manage, :confirmations
+    can :manage, Confirmation
     # End of Rules for all authenticated user with no additional roles required
 
     # Rules for admins

app/models/category.rb

@@ -14,4 +14,5 @@ class Category < ApplicationRecord
   has_many :detector_categories, dependent: :destroy
   has_many :detectors, through: :detector_categories
   has_many :categorizations, dependent: :destroy
+  has_many :confirmations, dependent: :destroy
 end

app/models/confirmation.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# A Confirmation is a "ground truth" record, provided by a person who has
+# reviewed a Term record and recommended how TACOS should classify the term
+# 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.
+#
+# == Schema Information
+#
+# Table name: confirmations
+#
+#  id          :integer          not null, primary key
+#  user_id     :integer          not null
+#  term_id     :integer          not null
+#  category_id :integer
+#  flag        :boolean
+#  created_at  :datetime         not null
+#  updated_at  :datetime         not null
+#
+class Confirmation < ApplicationRecord
+  belongs_to :user
+  belongs_to :term
+  belongs_to :category, optional: true
+end

app/models/term.rb

@@ -16,6 +16,10 @@ class Term < ApplicationRecord
   has_many :search_events, dependent: :destroy
   has_many :detections, dependent: :destroy
   has_many :categorizations, dependent: :destroy
+  has_many :confirmations, dependent: :destroy
+
+  scope :user_confirmed, -> { where.associated(:confirmations).distinct }
+  scope :user_unconfirmed, -> { where.missing(:confirmations).distinct }
 
   # The record_detections method is the one-stop method to call every Detector's record method that is defined within
   # the application.

app/models/user.rb

@@ -12,6 +12,8 @@
 #  admin      :boolean          default(FALSE)
 #
 class User < ApplicationRecord
+  has_many :confirmations, dependent: :destroy
+
   include FakeAuthConfig
 
   if FakeAuthConfig.fake_auth_enabled?

app/views/layouts/_site_nav.html.erb

@@ -10,6 +10,9 @@
         <nav class="local-nav" aria-label="Main menu">
           <%= nav_link_to("Home", root_path) %>
           <% if user_signed_in? %>
+            <% if can? :manage, Confirmation %>
+              <%= link_to('Confirm terms', confirm_index_path, class: 'nav-item') %>
+            <% end %>
             <% if can? :index, Term %>
               <%= link_to('Admin', admin_root_path, class: 'nav-item') %>
             <% end %>