Adds SuggestedPatterns and related Detector

Why are these changes being introduced:

* LIRS staff and UXWS have both noted that searching for Standards is
  not useful in our system

Relevant ticket(s):

* https://mitlibraries.atlassian.net/browse/TCO-141

How does this address that need:

* Adds a regex pattern based system that is similar to, but different
  than, SuggestedResources
* These patterns can be used for more than just Standards, so the models
  were made to be more generic in name
* The SuggestedPatterns will be stored in our database, which is a bit
  different than our other regular expression based detectors. These
  feel different enough to warrant this difference as we want to store
  additional metadata about what to display for these types of patterns
  when the other regex patterns use external resources to fetch data.

Document any side effects to this change:

* I'm not confident the naming is ideal

Author: JPrevost

app/controllers/demo_controller.rb

@@ -23,5 +23,6 @@ def detections
     @detections[:lcsh] = Detector::Lcsh.new(@searchterm).detections
     @detections[:standard_identifiers] = Detector::StandardIdentifiers.new(@searchterm).detections
     @detections[:suggested_resources] = Detector::SuggestedResource.full_term_match(@searchterm)
+    @detections[:suggested_resources_patterns] = Detector::SuggestedResourcePattern.new(@searchterm)
   end
 end

app/graphql/types/detectors_type.rb

@@ -25,8 +25,19 @@ def standard_identifiers
       end
     end
 
+    # Prefer Term based SuggestedResources over Pattern Based Suggested Resources
     def suggested_resources
-      Detector::SuggestedResource.full_term_match(@object).map do |suggested_resource|
+      traditional_suggested_resources.presence || pattern_based_suggested_resources
+    end
+
+    def traditional_suggested_resources
+      Detector::SuggestedResource.full_term_match(@object) do |suggested_resource|
+        { title: suggested_resource.title, url: suggested_resource.url }
+      end
+    end
+
+    def pattern_based_suggested_resources
+      Detector::SuggestedResourcePattern.new(@object).detections do |suggested_resource|
         { title: suggested_resource.title, url: suggested_resource.url }
       end
     end

app/models/detector/suggested_resource_pattern.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+class Detector
+  # Detector::SuggestedResourcePattern handles detections for SuggestedResources based on patterns stored in our
+  # SuggestedPattern model
+  class SuggestedResourcePattern
+    attr_reader :detections
+
+    # shared singleton methods
+    extend Detector::BulkChecker
+
+    def initialize(phrase)
+      @detections = {}
+      check_patterns(phrase)
+    end
+
+    # check_patterns loops through all stored patterns from SuggestedPattern model, checks to see if they produce
+    # matches for the incoming `phrase`, and if so creates a Hash with useful data
+    #
+    # @note Not using shared PatternChecker as we want to include additional data in the returned object
+    # @param phrase [String]. A string representation of a searchterm (not an actual Term object)
+    # @return primarily intended to add matches to @detections
+    def check_patterns(phrase)
+      sps = []
+      SuggestedPattern.find_each do |sp|
+        next unless Regexp.new(sp.pattern).match(phrase)
+
+        sps << {
+          shortcode: sp.shortcode,
+          title: sp.title,
+          url: sp.url
+        }
+        @detections = sps
+      end
+    end
+
+    # The record method will consult the set of regex-based detectors that are defined in
+    # SuggestedPattern records. Any matches will be registered as Detection records.
+    #
+    # @note There are multiple patterns within SuggestedPattern records. Each check is capable of generating
+    #       a separate Detection record.
+    #
+    # @return nil
+    def self.record(term)
+      sp = Detector::SuggestedResourcePattern.new(term.phrase)
+
+      sp.detections.each do
+        Detection.find_or_create_by(
+          term:,
+          detector: Detector.where(name: 'SuggestedResourcePattern').first,
+          detector_version: ENV.fetch('DETECTOR_VERSION', 'unset')
+        )
+      end
+
+      nil
+    end
+  end
+end

app/models/suggested_pattern.rb

@@ -0,0 +1,18 @@
+# == Schema Information
+#
+# Table name: suggested_patterns
+#
+#  id         :integer          not null, primary key
+#  title      :string           not null
+#  url        :string           not null
+#  pattern    :string           not null
+#  shortcode  :string           not null
+#  created_at :datetime         not null
+#  updated_at :datetime         not null
+#
+class SuggestedPattern < ApplicationRecord
+  validates :title, presence: true
+  validates :url, presence: true
+  validates :pattern, presence: true, uniqueness: true
+  validates :shortcode, presence: true, uniqueness: true
+end

app/models/term.rb

@@ -55,6 +55,7 @@ def record_detections
     Detector::Journal.record(self)
     Detector::Lcsh.record(self)
     Detector::SuggestedResource.record(self)
+    Detector::SuggestedResourcePattern.record(self)
 
     nil
   end

app/views/demo/view.html.erb

@@ -108,3 +108,15 @@
 <% else %>
   <p>No suggested resoure found.</p>
 <% end %>
+
+<h2>Suggested Resource (Patterns)</h2>
+<% if @detections[:suggested_resources_patterns].detections.present? %>
+  <p>Suggested resoure patterns found.</p>
+  <% @detections[:suggested_resources_patterns].detections.each do |sr| %>
+    <h3><%= sr[:title] %></h3>
+    <p>URL: <%= link_to(sr[:url], sr[:url]) %></p>
+  <% end %>
+
+<% else %>
+  <p>No suggested resoure patterns found.</p>
+<% end %>

db/migrate/20250331153721_add_suggested_patterns.rb

@@ -0,0 +1,12 @@
+class AddSuggestedPatterns < ActiveRecord::Migration[7.2]
+  def change
+    create_table :suggested_patterns do |t|
+      t.string :title, null: false
+      t.string :url, null: false
+      t.string :pattern, null: false
+      t.string :shortcode, null: false
+
+      t.timestamps
+    end
+  end
+end

db/schema.rb

@@ -42,6 +42,7 @@
 Detector.find_or_create_by(name: 'SuggestedResource')
 Detector.find_or_create_by(name: 'Citation')
 Detector.find_or_create_by(name: 'Barcode')
+Detector.find_or_create_by(name: 'SuggestedResourcePattern')
 
 # DetectorCategories
 DetectorCategory.find_or_create_by(
@@ -84,5 +85,42 @@
   category: Category.find_by(name: 'Transactional'),
   confidence: 0.2
 )
+DetectorCategory.find_or_create_by(
+  detector: Detector.find_by(name: 'SuggestedResourcePattern'),
+  category: Category.find_by(name: 'Transactional'),
+  confidence: 0.9
+)
+
+# Patterns for Suggested Resources
+SuggestedPattern.find_or_create_by(
+  title: 'Looking for Standards?',
+  url: 'https://libguides.mit.edu/standards',
+  pattern: '(IEC|iec)(\\s)(\\d{5})',
+  shortcode: 'iec'
+)
+SuggestedPattern.find_or_create_by(
+  title: 'Looking for Standards?',
+  url: 'https://libguides.mit.edu/standards',
+  pattern: '(ASCE|asce)(\\s)(\\d)',
+  shortcode: 'asce'
+)
+SuggestedPattern.find_or_create_by(
+  title: 'Looking for Standards?',
+  url: 'https://libguides.mit.edu/standards',
+  pattern: '(IEEE|ieee)\\s+(?:Std\\s+)?([PC]?[0-9]{3,4})',
+  shortcode: 'ieee'
+)
+SuggestedPattern.find_or_create_by(
+  title: 'Looking for Standards?',
+  url: 'https://libguides.mit.edu/standards',
+  pattern: '(ISO|iso)\\s(\\d{1,5})',
+  shortcode: 'iso'
+)
+SuggestedPattern.find_or_create_by(
+  title: 'Looking for Standards?',
+  url: 'https://libguides.mit.edu/standards',
+  pattern: '(ASTM|astm)\\s',
+  shortcode: 'astm'
+)
 
 Rails.logger.info('Seeding DB complete')

db/seeds.rb

@@ -33,3 +33,6 @@ journal:
 
 suggestedresource:
   name: 'SuggestedResource'
+
+suggestedresourcepattern:
+  name: 'SuggestedResourcePattern'