Rubocop fixes

Author: rsmithlal

app/jobs/better_together/metrics/rich_text_external_link_checker_queue_job.rb

@@ -2,6 +2,9 @@
 
 module BetterTogether
   module Metrics
+    # Queues jobs that check external links found inside ActionText rich content.
+    # Subclasses of RichTextLinkCheckerQueueJob should implement the specifics
+    # for how individual link check jobs are performed.
     class RichTextExternalLinkCheckerQueueJob < RichTextLinkCheckerQueueJob
       protected
 

app/jobs/better_together/metrics/rich_text_internal_link_checker_queue_job.rb

@@ -2,6 +2,9 @@
 
 module BetterTogether
   module Metrics
+    # Queues jobs that check internal links found inside ActionText rich content.
+    # This job narrows the collection to internal links and may delay processing
+    # to reduce immediate load on the application.
     class RichTextInternalLinkCheckerQueueJob < RichTextLinkCheckerQueueJob
       protected
 

app/jobs/better_together/metrics/rich_text_link_checker_queue_job.rb

@@ -2,6 +2,9 @@
 
 module BetterTogether
   module Metrics
+    # Base queueing job that distributes RichText link check work across hosts.
+    # It groups RichText links by host and schedules child jobs with delays to
+    # avoid overloading external hosts or the application.
     class RichTextLinkCheckerQueueJob < MetricsJob
       def perform
         records_size = model_collection.size

app/models/better_together/content/link.rb

@@ -2,6 +2,9 @@
 
 module BetterTogether
   module Content
+    # Represents a persisted link discovered in rich content. Stores metadata
+    # about the link (host, scheme, validity) and associates to RichText
+    # metrics records.
     class Link < ApplicationRecord
       has_many :rich_text_links, class_name: 'BetterTogether::Metrics::RichTextLink', inverse_of: :link
       has_many :rich_texts, through: :rich_text_links

app/models/better_together/links.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 module BetterTogether
+  # Namespace helper for links-related tables. Ensures a consistent
+  # table name prefix for models placed under BetterTogether::Links.
   module Links
     def self.table_name_prefix
       'better_together_links_'

app/models/better_together/metrics/rich_text_link.rb

@@ -2,6 +2,8 @@
 
 module BetterTogether
   module Metrics
+    # Tracks occurrences of links found inside ActionText rich content and
+    # associates them with the original Link record and owning rich text.
     class RichTextLink < ApplicationRecord
       belongs_to :link, class_name: 'BetterTogether::Content::Link'
       belongs_to :rich_text, class_name: 'ActionText::RichText'

db/migrate/20241124181740_create_better_together_content_links.rb

@@ -1,18 +1,21 @@
 # frozen_string_literal: true
 
+  # Migration to create the persistent links table used by the
+  # BetterTogether rich text link metrics system.
 class CreateBetterTogetherContentLinks < ActiveRecord::Migration[7.1]
+  # rubocop:disable Metrics/MethodLength
   def change
     create_bt_table :links, prefix: :better_together_content do |t|
       t.string :link_type, null: false, index: true
       t.string :url, null: false, index: true
       t.string :scheme
       t.string :host, index: true
-      # Data re: the link itself
       t.boolean :external, index: true
       t.boolean :valid_link, index: true
       t.datetime :last_checked_at, index: true
       t.string :latest_status_code, index: true
       t.text :error_message
     end
   end
+  # rubocop:enable Metrics/MethodLength
 end

db/migrate/20241125190948_create_better_together_metrics_rich_text_links.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
+  # Migration to create the RichText link join table used for metrics and
+  # associations between ActionText content and discovered links.
 class CreateBetterTogetherMetricsRichTextLinks < ActiveRecord::Migration[7.1]
   def change
     create_bt_table :rich_text_links, prefix: :better_together_metrics do |t|
       t.bt_references :link, foreign_key: { to_table: :better_together_content_links }
-      # Data re: the RichText and record
       t.bt_references :rich_text, foreign_key: { to_table: :action_text_rich_texts }
       t.bt_references :rich_text_record, polymorphic: true, index: { name: 'by_rich_text_link_record' }
       t.bt_position # index in the RichText links array

lib/tasks/quality_assurance.rake

@@ -117,7 +117,6 @@ namespace :better_together do
         task check: :environment do
           BetterTogether::Metrics::RichTextInternalLinkCheckerQueueJob.new
           BetterTogether::Metrics::RichTextExternalLinkCheckerQueueJob.new
-          byebug
         end
 
         def determine_link_type(uri, internal_link)