Refactor item status code and add to item search page (#2220)

* Consolidates most of the status display and search code into a single
file and names a concept that was always present: borrow status (which
is if an item is available, checked out, etc). There are less nested
conditionals in a view helper as a result. It also means that we're more
consistent about how we were rendering status values for admins.
* Creates two new helper methods to make working with the statuses in
views clearer. We now have `item_status_label`,
`member_item_status_label`, and `borrow_status_label`.
* Adds tooltips to the two status labels in admin views to make it
easier to understand what they mean.
* Finally, adds these status labels to the new item search view.

Author: jim

app/assets/stylesheets/admin.scss

@@ -155,7 +155,8 @@ ul.simple-list {
     align-items: center;
   }
 
-  th.no-wrap {
+  th.no-wrap,
+  td.no-wrap {
     white-space: nowrap;
   }
 }

app/assets/stylesheets/application_styles.scss

@@ -517,7 +517,8 @@ $min-width: variables.$size-md + 1;
 }
 
 .item-borrow-policy,
-.item-checkout-status,
+.item-status,
+.borrow-status,
 .item-days-until-due {
   font-size: 0.8em;
   position: relative;

app/assets/stylesheets/styles.scss

@@ -832,7 +832,8 @@ form.membership-amount {
   margin-top: 1em;
 }
 
-.item-checkout-status {
+.item-status,
+.borrow-status {
   font-size: 0.8em;
   position: relative;
   top: -1px;

app/controllers/admin/items/searches_controller.rb

@@ -36,7 +36,9 @@ def show
         end
 
         @q = scope.ransack(ransack_params)
-        result = @q.result.includes(:categories, :borrow_policy).with_attached_image
+        result = @q.result
+          .includes(:categories, :borrow_policy, :active_holds, :checked_out_exclusive_loan)
+          .with_attached_image
         @pagy, @items = pagy(result)
       end
 

app/helpers/items_helper.rb

@@ -23,10 +23,6 @@ def item_status_options(disabled_statuses: [])
     end
   end
 
-  def item_retired_reason_name(reason)
-    Item::RETIRED_REASON_NAMES[reason]
-  end
-
   def item_retired_reason_options(disabled_statuses: [])
     Item.retired_reasons.map do |key, value|
       description = " (#{Item::RETIRED_REASON_DESCRIPTIONS[key]})" if Item::RETIRED_REASON_DESCRIPTIONS[key]
@@ -178,31 +174,29 @@ def full_item_number(item)
     item.complete_number
   end
 
-  def css_class_and_status_label(item)
+  # Admins see both statuses side by side, so each is labeled with a tooltip
+  def item_status_label(item)
+    status_label item.full_status_name, css_class: "item-status", tooltip: "item status"
+  end
+
+  def borrow_status_label(item, tooltip: "borrow status")
+    return unless item.in_circulation?
+
+    status_label item.borrow_status_name,
+      css_class: "borrow-status #{Item::BORROW_STATUS_CSS_CLASSES[item.borrow_status]}",
+      tooltip: tooltip
+  end
+
+  # Members see a single label: how borrowable an active item is, or why an item
+  # that has left circulation can't be borrowed at all.
+  def member_item_status_label(item)
     if item.active?
-      if item.checked_out_exclusive_loan
-        if item.overdue?
-          ["label-error", "Overdue"]
-        else
-          ["label-warning", "Checked Out"]
-        end
-      elsif item.borrow_policy.uniquely_numbered? && item.active_holds.size > 0
-        ["label-warning", "On Hold"]
-      else
-        ["label-success", "Available"]
-      end
-    elsif item.maintenance?
-      ["", "In Maintenance"]
+      borrow_status_label(item, tooltip: nil)
     else
-      ["", "Unavailable"]
+      status_label item.member_status_name, css_class: "item-status"
     end
   end
 
-  def item_status_label(item)
-    class_name, label = css_class_and_status_label(item)
-    tag.span label, class: "label item-checkout-status #{class_name}"
-  end
-
   def days_until_due_label(item)
     return unless show_days_until_due?(item)
 
@@ -216,13 +210,10 @@ def days_until_due_label(item)
     tag.span text, class: "label item-days-until-due"
   end
 
-  def item_holds_label(item)
-    if item.active?
-      count = item.active_holds.size
-      if count > 0
-        tag.span pluralize(count, "hold"), class: "label item-hold-status"
-      end
-    end
+  private def status_label(name, css_class:, tooltip: nil)
+    css_class = "tooltip tooltip-bottom #{css_class}" if tooltip
+
+    tag.span name, class: "label #{css_class}", data: {tooltip: tooltip}
   end
 
   def audit_item_status(audit)

app/models/concerns/item_borrow_statuses.rb

@@ -0,0 +1,78 @@
+require "active_support/concern"
+
+module ItemBorrowStatuses
+  extend ActiveSupport::Concern
+
+  # Where an item is in the borrowing cycle. This is independent of the item's
+  # status: a retired item can still be checked out, and a pending item is
+  # available in the sense that nobody has it.
+  BORROW_STATUS_NAMES = {
+    "available" => "Available",
+    "on_hold" => "On Hold",
+    "checked_out" => "Checked Out",
+    "overdue" => "Overdue"
+  }
+
+  BORROW_STATUS_CSS_CLASSES = {
+    "available" => "label-success",
+    "on_hold" => "label-warning",
+    "checked_out" => "label-warning",
+    "overdue" => "label-error"
+  }
+
+  # Items are ordered in search results by how borrowable they are: active
+  # items first, ordered by borrow status, then everything a member can't
+  # borrow right now.
+  BORROW_STATUS_SEARCH_PRIORITIES = {
+    "available" => 1,
+    "on_hold" => 2,
+    "checked_out" => 3,
+    "overdue" => 4
+  }
+
+  MAINTENANCE_SEARCH_PRIORITY = 5
+  UNBORROWABLE_SEARCH_PRIORITY = 6
+
+  def borrow_status
+    if checked_out_exclusive_loan
+      overdue? ? "overdue" : "checked_out"
+    elsif borrow_policy.uniquely_numbered? && active_holds.size > 0
+      "on_hold"
+    else
+      "available"
+    end
+  end
+
+  def borrow_status_name
+    BORROW_STATUS_NAMES[borrow_status]
+  end
+
+  class_methods do
+    # SQL equivalent of #borrow_status, for ordering search results. Expects the
+    # relation to join loans, borrow_policies, and the active_hold_counts CTE.
+    def borrow_status_search_priority
+      Arel::Nodes::Case.new
+        .when(Loan.arel_table[:id].not_eq(nil)).then(
+          Arel::Nodes::Case.new
+            .when(Loan.arel_table[:due_at].lt(Time.current))
+            .then(BORROW_STATUS_SEARCH_PRIORITIES["overdue"])
+            .else(BORROW_STATUS_SEARCH_PRIORITIES["checked_out"])
+        )
+        .when(
+          Arel::Nodes::And.new([
+            BorrowPolicy.arel_table[:uniquely_numbered],
+            Arel::Nodes::SqlLiteral.new("active_hold_counts.item_id IS NOT NULL")
+          ])
+        ).then(BORROW_STATUS_SEARCH_PRIORITIES["on_hold"])
+        .else(BORROW_STATUS_SEARCH_PRIORITIES["available"])
+    end
+
+    def search_priority
+      Arel::Nodes::Case.new(arel_table[:status])
+        .when("active").then(borrow_status_search_priority)
+        .when("maintenance").then(MAINTENANCE_SEARCH_PRIORITY)
+        .else(UNBORROWABLE_SEARCH_PRIORITY)
+        .as("search_priority")
+    end
+  end
+end

app/models/concerns/item_statuses.rb

@@ -11,6 +11,13 @@ module ItemStatuses
     "retired" => "Retired"
   }
 
+  # Members are shown the borrow status of active items, so these only come up
+  # for items that have left circulation. Members normally can't see those at
+  # all, but an item saved for later can end up in any status.
+  MEMBER_STATUS_NAMES = Hash.new("Unavailable").merge(
+    "maintenance" => "In Maintenance"
+  ).freeze
+
   STATUS_DESCRIPTIONS = {
     "pending" => "just acquired; not ready to loan",
     "active" => "available to loan",
@@ -33,6 +40,29 @@ module ItemStatuses
     "upgraded" => "replaced with a newer or better item"
   }
 
+  def status_name
+    STATUS_NAMES[status]
+  end
+
+  # The status, plus why the item was retired when we know it
+  def full_status_name
+    retired_reason ? "#{status_name} (#{retired_reason_name})" : status_name
+  end
+
+  def member_status_name
+    MEMBER_STATUS_NAMES[status]
+  end
+
+  # Items that are part of the circulating inventory. Anything else has either
+  # not entered circulation yet or has left it, so its borrow status is moot.
+  def in_circulation?
+    active? || maintenance?
+  end
+
+  def retired_reason_name
+    RETIRED_REASON_NAMES[retired_reason]
+  end
+
   included do
     enum :status, {
       pending: "pending",

app/models/item.rb

@@ -1,6 +1,7 @@
 class Item < ApplicationRecord
   include ItemCategorization
   include ItemStatuses
+  include ItemBorrowStatuses
   include ItemNumbering
 
   include PgSearch::Model
@@ -113,27 +114,6 @@ def next_hold
       .left_joins(:checked_out_exclusive_loan)
       .left_joins(:borrow_policy)
 
-    items = arel_table
-    search_priority = Arel::Nodes::Case
-      .new(items[:status])
-      .when("active").then(
-        Arel::Nodes::Case.new
-        .when(Loan.arel_table[:id].not_eq(nil)).then(
-          Arel::Nodes::Case.new
-          .when(Loan.arel_table[:due_at].lt(Time.current)).then(4).else(3)
-        )
-        .when(
-          Arel::Nodes::And.new([
-            BorrowPolicy.arel_table[:uniquely_numbered],
-            Arel::Nodes::SqlLiteral.new("active_hold_counts.item_id IS NOT NULL")
-          ])
-        ).then(2)
-        .else(1)
-      )
-      .when("maintenance").then(5)
-      .else(6)
-      .as("search_priority")
-
     item_scope.select(
       "#{item_scope.pg_search_rank_table_alias}.rank",
       "items.*",

app/views/account/for_later_list_items/index.html.erb

@@ -16,7 +16,7 @@
         <div class="item-content">
           <%= tag.div class: "item-info" do %>
             <strong><%= link_to item.name, item_path(item), class: "item-name", id: "item-name-#{item.id}" %></strong>
-            <%= item_status_label(item) %>
+            <%= member_item_status_label(item) %>
             <% if item.borrow_policy.requires_approval? %>
               <span class="label label-secondary item-borrow-policy"><%= item.borrow_policy.code %>-Tool</span>
             <% end %>

app/views/admin/items/_item_panel.html.erb

@@ -11,10 +11,7 @@
         <h6>
             <strong><%= item.complete_number %></strong>
             <%= item_status_label(item) %>
-            <span class="label item-checkout-status">
-                <%= item.status.capitalize %>
-                <% if item.status == "retired" %>(<%= item_retired_reason_name(item.retired_reason) %>)<% end %>
-            </span>
+            <%= borrow_status_label(item) %>
         </h6>
     </div>