newshound 0.2.7 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58c2540992cef9f0214865a6d365d0e2b2e98e6f7a9d186df9c50affbc254498
-  data.tar.gz: e1db27edd5f1f665bb30154ce0fe2aea85781397e6caaf71f171d2c5e5a4fc8c
+  metadata.gz: 79ace59ee869878db3221ca5d851c9bf10ae50354877d6b4a2b57ccc9489319e
+  data.tar.gz: 9a0e6d98ce5ac41b433c19d66ae920b207c090d7550df505645068c46f627feb
 SHA512:
-  metadata.gz: fb50eb837a41ceafd5e5b47a5a90762d7e04b5642c520e24a103202a87eead65d241dcb9674939d1cef34fdb9a1fb186d885cd19cdd154ac9d0049f9bb6ccefd
-  data.tar.gz: 5344958684e704bba2f18ef8bce4bccd04ad954119ed8f0b5e57f6d2e6b1af422ac70642e32eceb7af488946102b0e71474f540db38030b930222b88f8ca97da
+  metadata.gz: 7124a65e125a08eea643486de24db7e84436c981ccd6e9c6fa12b205b33f1e2e30b062d38c766ab0f9df18bda79fd3d093b5bfccf23b5d9938b0c45e45d6a23e
+  data.tar.gz: d414aa404515671d71525214ebe0f601e456c6704e5bfccf29a49246454ea9f9d83e899576db2903cfe4d0491b8255a915d6b17a4c5cdefb879d5318b0476f66

data/.tool-versions

@@ -1 +1 @@
-ruby 3.4.3
+ruby 4.0.1

data/CHANGELOG.md

@@ -5,14 +5,39 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [0.2.7] - 2026-01-30
+## [1.0.1] - 2026-03-17
 
-## [] - 
+### Changed
 
-### 
+- The authorize_with initializer will generate with the method inside the configure block. (2d6ef48)
 
-- [0.2.6] -2025-01-13
+### Added
+
+- Configurable banner links for exceptions, jobs, and warnings via string path patterns (1df1636)
+- Record ID in format_for_banner output for linking to individual records (e06d040)
+
+## [0.2.8] - 2026-02-10
+
+### Changed
+
+- Ruby support to 3.3+ and added Ruby 4.0 to CI matrix (24e5b86)
+- Job monitoring uses configurable adapter pattern via config.job_source (8d33d30)
+
+### Removed
+
+- Ruby 3.1 and 3.2 support (24e5b86)
+- Hard dependency on que gem (8d33d30)
+- QueReporter class (replaced by JobReporter + Jobs adapters) Version: major (8d33d30)
 
 ### Fixed
 
-- Solid Errors title is able to present in banner.
+- Set the correct location for the repository on the web. (cb7bb88)
+- test_exceptions rake task calling report instead of banner_data (e440188)
+- Banner overlaying content in apps with !important body padding-top rules (16f22f1)
+
+### Added
+
+- Jobs adapter pattern with Base class and registry (c50ba9c)
+- Jobs::Que adapter for Que job backend (c50ba9c)
+- JobReporter that delegates to a configurable job source adapter (c50ba9c)
+- ExceptionReporter#formatted_exception_count and #exception_summary helpers (e440188)

data/lib/generators/newshound/install/install_generator.rb

@@ -31,7 +31,7 @@ module Newshound
         say "    rake newshound:test_jobs"
         say ""
         say "  For more information, visit:", :blue
-        say "    https://github.com/salbanez/newshound"
+        say "    https://github.com/SOFware/newshound"
         say "===============================================================================", :green
         say ""
       end

data/lib/generators/newshound/install/templates/newshound.rb

@@ -14,6 +14,11 @@ Newshound.configure do |config|
   # Default is :exception_track
   config.exception_source = :exception_track # or :solid_errors
 
+  # Job source adapter for monitoring background jobs
+  # Uncomment and set to enable job monitoring in the banner
+  # config.job_source = :que # or a custom adapter instance
+  # See Newshound::Jobs::Base for the adapter interface
+
   # User roles that are authorized to view the Newshound banner
   # These should match the role values in your User model
   # Default is [:developer, :super_user]
@@ -23,14 +28,36 @@ Newshound.configure do |config|
   # Most apps use :current_user (Devise, etc.)
   # Default is :current_user
   config.current_user_method = :current_user
-end
 
-# Advanced: Custom authorization logic
-# If the default role-based authorization doesn't fit your needs,
-# you can provide a custom authorization block:
-#
-# Newshound.authorize_with do |controller|
-#   # Your custom logic here
-#   # Return true to show the banner, false to hide it
-#   controller.current_user&.admin?
-# end
+  # Links for banner items
+  # Configure paths so banner items link to your exception/job dashboards.
+  # Use :id in show paths to interpolate the record ID.
+  #
+  # config.exception_links = {
+  #   index: "/errors",
+  #   show: "/errors/:id"
+  # }
+  #
+  # config.job_links = {
+  #   index: "/background_jobs",
+  #   show: "/background_jobs/jobs/:id",
+  #   scheduled: "/background_jobs/scheduled",
+  #   failed: "/background_jobs/failed",
+  #   completed: "/background_jobs/completed"
+  # }
+  #
+  # config.warning_links = {
+  #   index: "/warnings",
+  #   show: "/warnings/:id"
+  # }
+
+  # Custom authorization logic:
+  # If the default role-based authorization doesn't fit your needs,
+  # you can provide a custom authorization block:
+  #
+  # config.authorize_with do |controller|
+  #   # Your custom logic here
+  #   # Return true to show the banner, false to hide it
+  #   controller.current_user&.admin?
+  # end
+end

data/lib/newshound/configuration.rb

@@ -4,7 +4,8 @@ module Newshound
   class Configuration
     attr_accessor :exception_limit, :enabled, :authorized_roles,
       :current_user_method, :authorization_block, :exception_source,
-      :warning_source, :warning_limit
+      :warning_source, :warning_limit, :job_source,
+      :exception_links, :job_links, :warning_links
 
     def initialize
       @exception_limit = 10
@@ -15,6 +16,10 @@ module Newshound
       @exception_source = :exception_track
       @warning_source = nil
       @warning_limit = 10
+      @job_source = nil
+      @exception_links = {}
+      @job_links = {}
+      @warning_links = {}
     end
 
     # Allow custom authorization logic

data/lib/newshound/exception_reporter.rb

@@ -29,10 +29,24 @@ module Newshound
     # Returns data formatted for the banner UI
     def banner_data
       {
-        exceptions: recent_exceptions.map { |exception| exception_source.format_for_banner(exception) }
+        exceptions: recent_exceptions.map { |exception|
+          exception_source.format_for_banner(exception)
+        }
       }
     end
 
+    def formatted_exception_count(
+      format = "Total exceptions: %s"
+    )
+      format % recent_exceptions.length
+    end
+
+    def exception_summary
+      recent_exceptions.map.with_index(1) do |ex, i|
+        exception_source.format_for_report(ex, i)
+      end
+    end
+
     private
 
     def resolve_exception_source(source)

data/lib/newshound/exceptions/base.rb

@@ -31,7 +31,7 @@ module Newshound
       # Formats an exception for banner UI display
       #
       # @param exception [Object] Exception record from the tracking system
-      # @return [Hash] Hash with keys: :title, :message, :location, :time
+      # @return [Hash] Hash with keys: :id, :title, :message, :location, :time
       def format_for_banner(exception)
         raise NotImplementedError, "#{self.class} must implement #format_for_banner"
       end

data/lib/newshound/exceptions/exception_track.rb

@@ -23,6 +23,7 @@ module Newshound
         details = parse_exception_details(exception)
 
         {
+          id: exception.try(:id),
           title: details[:title],
           message: details[:message].truncate(100),
           location: details[:location],

data/lib/newshound/exceptions/solid_errors.rb

@@ -23,6 +23,7 @@ module Newshound
         details = parse_exception_details(exception)
 
         {
+          id: exception.try(:error)&.id || exception.try(:id),
           title: details[:title],
           message: details[:message].truncate(100),
           location: details[:location],

data/lib/newshound/job_reporter.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+module Newshound
+  class JobReporter
+    attr_reader :job_source, :configuration, :logger
+
+    def initialize(job_source: nil, configuration: nil, logger: nil)
+      @configuration = configuration || Newshound.configuration
+      @job_source = resolve_job_source(job_source)
+      @logger = logger || (defined?(Rails) ? Rails.logger : Logger.new($stdout))
+    end
+
+    def generate_report
+      return no_jobs_block unless job_source
+
+      [
+        {
+          type: "section",
+          text: {
+            type: "mrkdwn",
+            text: "*📊 Job Queue Status*"
+          }
+        },
+        job_counts_section,
+        queue_health_section
+      ].compact
+    end
+    alias_method :report, :generate_report
+
+    def banner_data
+      return {queue_stats: {}} unless job_source
+
+      job_source.format_for_banner
+    end
+
+    private
+
+    def resolve_job_source(source)
+      source ||= @configuration.job_source
+      return nil if source.nil?
+
+      source.is_a?(Symbol) ? Jobs.source(source) : source
+    end
+
+    def job_counts_section
+      counts = job_source.job_counts_by_type
+
+      return no_jobs_section if counts.empty?
+
+      {
+        type: "section",
+        text: {
+          type: "mrkdwn",
+          text: format_job_counts(counts)
+        }
+      }
+    end
+
+    def format_job_counts(counts)
+      lines = ["*Job Counts by Type:*"]
+
+      counts.each do |job_class, stats|
+        status_emoji = (stats[:failed] > 0) ? "⚠️" : "✅"
+        lines << "• #{status_emoji} *#{job_class}*: #{stats[:total]} total (#{stats[:success]} success, #{stats[:failed]} failed)"
+      end
+
+      lines.join("\n")
+    end
+
+    def queue_health_section
+      stats = job_source.queue_statistics
+
+      {
+        type: "section",
+        text: {
+          type: "mrkdwn",
+          text: format_queue_health(stats)
+        }
+      }
+    end
+
+    def format_queue_health(stats)
+      health_emoji = if stats[:failed] > 10
+        "🔴"
+      else
+        (stats[:failed] > 5) ? "🟡" : "🟢"
+      end
+
+      <<~TEXT
+        *Queue Health #{health_emoji}*
+        • *Ready to Run:* #{stats[:ready]}
+        • *Scheduled:* #{stats[:scheduled]}
+        • *Failed (Retry Queue):* #{stats[:failed]}
+        • *Completed Today:* #{stats[:finished_today]}
+      TEXT
+    end
+
+    def no_jobs_section
+      {
+        type: "section",
+        text: {
+          type: "mrkdwn",
+          text: "*No jobs found in the queue*"
+        }
+      }
+    end
+
+    def no_jobs_block
+      [
+        {
+          type: "section",
+          text: {
+            type: "mrkdwn",
+            text: "*✅ No Job Source Configured*"
+          }
+        }
+      ]
+    end
+  end
+end

data/lib/newshound/jobs/base.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Newshound
+  module Jobs
+    # Base class for job source adapters
+    # Each adapter is responsible for:
+    # 1. Fetching queue statistics from its specific job backend
+    # 2. Fetching job counts grouped by type
+    # 3. Formatting job data for banner display
+    #
+    # Subclasses must implement:
+    # - #queue_statistics - Returns a hash of queue stats
+    # - #job_counts_by_type - Returns a hash of job class => counts
+    #
+    # Unlike Warnings::Base and Exceptions::Base (which format individual records),
+    # #format_for_banner takes no arguments and returns aggregate queue statistics.
+    # A default implementation is provided that delegates to #queue_statistics.
+    class Base
+      # Returns queue-level statistics
+      #
+      # @return [Hash] with keys :ready, :scheduled, :failed, :finished_today
+      def queue_statistics
+        raise NotImplementedError, "#{self.class} must implement #queue_statistics"
+      end
+
+      # Returns job counts grouped by job class
+      #
+      # @return [Hash] job_class => { success:, failed:, total: }
+      def job_counts_by_type
+        raise NotImplementedError, "#{self.class} must implement #job_counts_by_type"
+      end
+
+      # Returns data formatted for the banner UI
+      #
+      # @return [Hash] with key :queue_stats containing ready_to_run, scheduled, failed, completed_today
+      def format_for_banner
+        stats = queue_statistics
+
+        {
+          queue_stats: {
+            ready_to_run: stats[:ready],
+            scheduled: stats[:scheduled],
+            failed: stats[:failed],
+            completed_today: stats[:finished_today]
+          }
+        }
+      end
+    end
+  end
+end

data/lib/newshound/jobs/que.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Newshound
+  module Jobs
+    class Que < Base
+      attr_reader :logger
+
+      def initialize(logger: nil)
+        @logger = logger || (defined?(Rails) ? Rails.logger : Logger.new($stdout))
+      end
+
+      def queue_statistics
+        conn = ActiveRecord::Base.connection
+        current_time = conn.quote(Time.now)
+        beginning_of_day = conn.quote(Date.today.to_time)
+
+        {
+          ready: count_jobs("finished_at IS NULL AND expired_at IS NULL AND run_at <= #{current_time}"),
+          scheduled: count_jobs("finished_at IS NULL AND expired_at IS NULL AND run_at > #{current_time}"),
+          failed: count_jobs("error_count > 0 AND finished_at IS NULL"),
+          finished_today: count_jobs("finished_at >= #{beginning_of_day}")
+        }
+      rescue => e
+        logger.error "Failed to fetch Que statistics: #{e.message}"
+        {ready: 0, scheduled: 0, failed: 0, finished_today: 0}
+      end
+
+      def job_counts_by_type
+        results = ActiveRecord::Base.connection.execute(<<~SQL)
+          SELECT job_class, error_count, COUNT(*) as count
+          FROM que_jobs
+          WHERE finished_at IS NULL
+          GROUP BY job_class, error_count
+          ORDER BY job_class
+        SQL
+
+        results.each_with_object({}) do |row, hash|
+          job_class = row["job_class"]
+          error_count = row["error_count"].to_i
+          count = row["count"].to_i
+
+          hash[job_class] ||= {success: 0, failed: 0, total: 0}
+
+          if error_count.zero?
+            hash[job_class][:success] += count
+          else
+            hash[job_class][:failed] += count
+          end
+
+          hash[job_class][:total] += count
+        end
+      rescue => e
+        logger.error "Failed to fetch job counts: #{e.message}"
+        {}
+      end
+
+      private
+
+      def count_jobs(where_clause)
+        ActiveRecord::Base.connection.select_value(
+          "SELECT COUNT(*) FROM que_jobs WHERE #{where_clause}"
+        ).to_i
+      end
+    end
+  end
+end

data/lib/newshound/jobs.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+Dir[File.join(__dir__, "jobs", "*.rb")].each { |file| require file }
+
+module Newshound
+  module Jobs
+    @registry = {}
+
+    class << self
+      attr_reader :registry
+
+      # Register a job adapter class with a symbolic name
+      #
+      # @param name [Symbol, String] The name to register the adapter under
+      # @param adapter_class [Class] The adapter class (must inherit from Jobs::Base)
+      def register(name, adapter_class)
+        @registry[name.to_sym] = adapter_class
+      end
+
+      # Get a job source adapter instance
+      #
+      # @param source [Symbol, Object] Either a symbolic name to look up, or an adapter instance
+      # @return [Jobs::Base] An instance of the job adapter
+      # @raise [RuntimeError] If the source symbol cannot be resolved
+      def source(source)
+        return source unless source.is_a?(Symbol)
+
+        if @registry.key?(source)
+          return @registry[source].new
+        end
+
+        constant = constants.find { |c| c.to_s.gsub(/(?<!^)([A-Z])/, "_\\1").downcase == source.to_s }
+        raise "Invalid job source: #{source}" unless constant
+
+        const_get(constant).new
+      end
+
+      def clear_registry!
+        @registry = {}
+      end
+    end
+  end
+end

data/lib/newshound/middleware/banner_injector.rb

@@ -55,11 +55,11 @@ module Newshound
 
       def generate_banner_html
         exception_reporter = Newshound::ExceptionReporter.new
-        que_reporter = Newshound::QueReporter.new
+        job_reporter = Newshound::JobReporter.new
         warning_reporter = Newshound::WarningReporter.new
 
         exception_data = exception_reporter.banner_data
-        job_data = que_reporter.banner_data
+        job_data = job_reporter.banner_data
         warning_data = warning_reporter.banner_data
 
         # Generate HTML from template
@@ -91,25 +91,66 @@ module Newshound
         <<~JS
           <script>
             (function() {
+              var cachedPriority, cachedBodyRule;
+
+              // Detect once whether any non-newshound stylesheet uses !important on body padding-top
+              function detectPriority() {
+                var styles = document.querySelectorAll('style:not(#newshound-styles)');
+
+                for (var i = 0; i < styles.length; i++) {
+                  if (styles[i].textContent.match(/body\\s*{[^}]*padding-top[^;]*!important/s)) {
+                    return 'important';
+                  }
+                }
+
+                try {
+                  for (var s = 0; s < document.styleSheets.length; s++) {
+                    var sheet = document.styleSheets[s];
+                    if (sheet.ownerNode && sheet.ownerNode.id === 'newshound-styles') continue;
+                    var rules = sheet.cssRules || [];
+                    for (var r = 0; r < rules.length; r++) {
+                      if (rules[r].selectorText === 'body' &&
+                          rules[r].style.getPropertyPriority('padding-top') === 'important') {
+                        return 'important';
+                      }
+                    }
+                  }
+                } catch (e) {}
+
+                return '';
+              }
+
+              // Find the html body rule in the newshound stylesheet once
+              function findBodyRule() {
+                var styleEl = document.getElementById('newshound-styles');
+                if (!styleEl || !styleEl.sheet) return null;
+                var rules = styleEl.sheet.cssRules;
+                for (var i = 0; i < rules.length; i++) {
+                  if (rules[i].selectorText === 'html body') return rules[i];
+                }
+                return null;
+              }
+
               window.newshoundUpdatePadding = function() {
-                // Wait for transition to complete
                 setTimeout(function() {
                   var banner = document.getElementById('newshound-banner');
-                  if (banner) {
-                    var height = banner.offsetHeight;
-                    document.body.style.paddingTop = height + 'px';
-                  }
+                  if (!banner) return;
+
+                  if (cachedBodyRule === undefined) cachedBodyRule = findBodyRule();
+                  if (!cachedBodyRule) return;
+
+                  if (cachedPriority === undefined) cachedPriority = detectPriority();
+
+                  cachedBodyRule.style.setProperty('padding-top', banner.offsetHeight + 'px', cachedPriority);
                 }, 300);
               };
 
-              // Set initial padding after page load
               if (document.readyState === 'loading') {
                 document.addEventListener('DOMContentLoaded', window.newshoundUpdatePadding);
               } else {
                 window.newshoundUpdatePadding();
               }
 
-              // Also update on window resize
               window.addEventListener('resize', window.newshoundUpdatePadding);
             })();
           </script>
@@ -118,8 +159,8 @@ module Newshound
 
       def render_styles
         <<~CSS
-          <style>
-            body {
+          <style id="newshound-styles">
+            html body {
               padding-top: 50px;
               transition: padding-top 0.3s ease-out;
             }
@@ -157,13 +198,13 @@ module Newshound
               font-weight: 600;
               background: rgba(255,255,255,0.2);
             }
-            .newshound-badge.error {
+            .newshound-error {
               background: #ef4444;
             }
-            .newshound-badge.warning {
+            .newshound-warning {
               background: #f59e0b;
             }
-            .newshound-badge.success {
+            .newshound-success {
               background: #10b981;
             }
             .newshound-toggle {
@@ -235,6 +276,20 @@ module Newshound
               text-transform: uppercase;
               letter-spacing: 0.5px;
             }
+            .newshound-link {
+              color: inherit;
+              text-decoration: none;
+            }
+            .newshound-link:hover {
+              text-decoration: underline;
+            }
+            a.newshound-stat {
+              color: inherit;
+              text-decoration: none;
+            }
+            a.newshound-stat:hover {
+              background: rgba(255,255,255,0.2);
+            }
           </style>
         CSS
       end
@@ -245,16 +300,16 @@ module Newshound
         warning_count = warning_data[:warnings]&.length || 0
 
         if exception_count > 0 || failed_jobs > 10
-          badge_class = "error"
+          badge_class = "newshound-error"
           text = "#{exception_count} exceptions, #{failed_jobs} failed jobs"
         elsif warning_count > 0 || failed_jobs > 5
-          badge_class = "warning"
+          badge_class = "newshound-warning"
           parts = []
           parts << "#{warning_count} warnings" if warning_count > 0
           parts << "#{failed_jobs} failed jobs" if failed_jobs > 5
           text = parts.join(", ")
         else
-          badge_class = "success"
+          badge_class = "newshound-success"
           text = "All clear"
         end
 
@@ -268,23 +323,11 @@ module Newshound
           return %(<div class="newshound-section"><div class="newshound-section-title">✅ Exceptions</div><div class="newshound-item">No exceptions in the last 24 hours</div></div>)
         end
 
-        items = exceptions.take(5).map do |ex|
-          <<~HTML
-            <div class="newshound-item">
-              <div class="newshound-item-title">#{escape_html(ex[:title])}</div>
-              <div class="newshound-item-detail">
-                #{escape_html(ex[:message])} • #{escape_html(ex[:location])} • #{escape_html(ex[:time])}
-              </div>
-            </div>
-          HTML
-        end.join
-
-        <<~HTML
-          <div class="newshound-section">
-            <div class="newshound-section-title">⚠️ Recent Exceptions (#{exceptions.length})</div>
-            #{items}
-          </div>
-        HTML
+        render_item_section(
+          items: exceptions,
+          links: Newshound.configuration.exception_links,
+          title: "⚠️ Recent Exceptions (#{exceptions.length})"
+        )
       end
 
       def render_warnings(data)
@@ -292,53 +335,81 @@ module Newshound
 
         return "" if warnings.empty?
 
-        items = warnings.take(5).map do |w|
-          <<~HTML
-            <div class="newshound-item">
-              <div class="newshound-item-title">#{escape_html(w[:title])}</div>
-              <div class="newshound-item-detail">
-                #{escape_html(w[:message])} • #{escape_html(w[:location])} • #{escape_html(w[:time])}
-              </div>
+        render_item_section(
+          items: warnings,
+          links: Newshound.configuration.warning_links,
+          title: "⚠️ Warnings (#{warnings.length})"
+        )
+      end
+
+      def render_item_section(items:, links:, title:)
+        rendered_items = items.take(5).map do |item|
+          item_content = <<~HTML
+            <div class="newshound-item-title">#{escape_html(item[:title])}</div>
+            <div class="newshound-item-detail">
+              #{escape_html(item[:message])} • #{escape_html(item[:location])} • #{escape_html(item[:time])}
             </div>
           HTML
+
+          if links[:show] && item[:id]
+            url = links[:show].gsub(":id", item[:id].to_s)
+            %(<a href="#{escape_html(url)}" class="newshound-link"><div class="newshound-item">#{item_content}</div></a>)
+          else
+            %(<div class="newshound-item">#{item_content}</div>)
+          end
         end.join
 
+        title_html = if links[:index]
+          %(<a href="#{escape_html(links[:index])}" class="newshound-link">#{title}</a>)
+        else
+          title
+        end
+
         <<~HTML
           <div class="newshound-section">
-            <div class="newshound-section-title">⚠️ Warnings (#{warnings.length})</div>
-            #{items}
+            <div class="newshound-section-title">#{title_html}</div>
+            #{rendered_items}
           </div>
         HTML
       end
 
       def render_jobs(data)
         stats = data[:queue_stats] || {}
+        links = Newshound.configuration.job_links
+
+        section_title = "📊 Job Queue Status"
+        title_html = if links[:index]
+          %(<a href="#{escape_html(links[:index])}" class="newshound-link">#{section_title}</a>)
+        else
+          section_title
+        end
 
         <<~HTML
           <div class="newshound-section">
-            <div class="newshound-section-title">📊 Job Queue Status</div>
+            <div class="newshound-section-title">#{title_html}</div>
             <div class="newshound-grid">
-              <div class="newshound-stat">
-                <span class="newshound-stat-value">#{stats[:ready_to_run] || 0}</span>
-                <span class="newshound-stat-label">Ready</span>
-              </div>
-              <div class="newshound-stat">
-                <span class="newshound-stat-value">#{stats[:scheduled] || 0}</span>
-                <span class="newshound-stat-label">Scheduled</span>
-              </div>
-              <div class="newshound-stat">
-                <span class="newshound-stat-value">#{stats[:failed] || 0}</span>
-                <span class="newshound-stat-label">Failed</span>
-              </div>
-              <div class="newshound-stat">
-                <span class="newshound-stat-value">#{stats[:completed_today] || 0}</span>
-                <span class="newshound-stat-label">Completed Today</span>
-              </div>
+              #{render_job_stat(stats[:ready_to_run] || 0, "Ready", links[:index])}
+              #{render_job_stat(stats[:scheduled] || 0, "Scheduled", links[:scheduled])}
+              #{render_job_stat(stats[:failed] || 0, "Failed", links[:failed])}
+              #{render_job_stat(stats[:completed_today] || 0, "Completed Today", links[:completed])}
             </div>
           </div>
         HTML
       end
 
+      def render_job_stat(value, label, link)
+        content = <<~HTML
+          <span class="newshound-stat-value">#{value}</span>
+          <span class="newshound-stat-label">#{label}</span>
+        HTML
+
+        if link
+          %(<a href="#{escape_html(link)}" class="newshound-stat">#{content}</a>)
+        else
+          %(<div class="newshound-stat">#{content}</div>)
+        end
+      end
+
       def escape_html(text)
         return +"" unless text.present?
         text.to_s

data/lib/newshound/railtie.rb

@@ -27,23 +27,23 @@ module Newshound
         desc "Test exception reporter"
         task test_exceptions: :environment do
           reporter = Newshound::ExceptionReporter.new
-          data = reporter.report
           puts "Exception Report:"
-          puts "  Total exceptions: #{data[:exceptions]&.length || 0}"
-          data[:exceptions]&.each_with_index do |ex, i|
-            puts "  #{i + 1}. #{ex[:title]} - #{ex[:message]}"
+          puts "  #{reporter.formatted_exception_count}"
+          reporter.exception_summary.each do |line|
+            puts "  #{line}"
           end
         end
 
         desc "Test job reporter"
         task test_jobs: :environment do
-          reporter = Newshound::QueReporter.new
-          data = reporter.report
+          reporter = Newshound::JobReporter.new
+          data = reporter.banner_data
+          stats = data[:queue_stats]
           puts "Job Queue Report:"
-          puts "  Ready to run: #{data.dig(:queue_stats, :ready_to_run)}"
-          puts "  Scheduled: #{data.dig(:queue_stats, :scheduled)}"
-          puts "  Failed: #{data.dig(:queue_stats, :failed)}"
-          puts "  Completed today: #{data.dig(:queue_stats, :completed_today)}"
+          puts "  Ready to run: #{stats[:ready_to_run] || 0}"
+          puts "  Scheduled: #{stats[:scheduled] || 0}"
+          puts "  Failed: #{stats[:failed] || 0}"
+          puts "  Completed today: #{stats[:completed_today] || 0}"
         end
       end
     end

data/lib/newshound/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Newshound
-  VERSION = "0.2.7"
+  VERSION = "1.0.1"
 end

data/lib/newshound/warnings/base.rb

@@ -33,7 +33,7 @@ module Newshound
       # Formats a warning for banner UI display
       #
       # @param warning [Object] Warning record from the data source
-      # @return [Hash] Hash with keys: :title, :message, :location, :time
+      # @return [Hash] Hash with keys: :id, :title, :message, :location, :time
       def format_for_banner(warning)
         raise NotImplementedError, "#{self.class} must implement #format_for_banner"
       end

data/lib/newshound.rb

@@ -6,7 +6,8 @@ require_relative "newshound/exceptions"
 require_relative "newshound/exception_reporter"
 require_relative "newshound/warnings"
 require_relative "newshound/warning_reporter"
-require_relative "newshound/que_reporter"
+require_relative "newshound/jobs"
+require_relative "newshound/job_reporter"
 require_relative "newshound/authorization"
 require_relative "newshound/middleware/banner_injector"
 require_relative "newshound/railtie" if defined?(Rails)

data/newshound.gemspec

@@ -8,11 +8,11 @@ Gem::Specification.new do |spec|
   spec.authors = ["Savannah Moore"]
   spec.email = ["savannah.albanez@sofwarellc.com"]
 
-  spec.summary = "Real-time web UI banner for monitoring Que jobs and exception tracking"
+  spec.summary = "Real-time web UI banner for monitoring background jobs and exception tracking"
   spec.description = "Newshound displays exceptions and job statuses in a collapsible banner for authorized users in your Rails app"
   spec.homepage = "https://github.com/SOFware/newshound"
   spec.license = "MIT"
-  spec.required_ruby_version = ">= 3.1.0"
+  spec.required_ruby_version = ">= 3.3.0"
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
@@ -27,7 +27,12 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.post_install_message = <<~MSG
+    To complete installation, run:
+
+      rails generate newshound:install
+  MSG
+
   # Runtime dependencies
   spec.add_dependency "rails", ">= 6.0"
-  spec.add_dependency "que", ">= 1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: newshound
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 1.0.1
 platform: ruby
 authors:
 - Savannah Moore
@@ -23,20 +23,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6.0'
-- !ruby/object:Gem::Dependency
-  name: que
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.0'
 description: Newshound displays exceptions and job statuses in a collapsible banner
   for authorized users in your Rails app
 email:
@@ -65,8 +51,11 @@ files:
 - lib/newshound/exceptions/base.rb
 - lib/newshound/exceptions/exception_track.rb
 - lib/newshound/exceptions/solid_errors.rb
+- lib/newshound/job_reporter.rb
+- lib/newshound/jobs.rb
+- lib/newshound/jobs/base.rb
+- lib/newshound/jobs/que.rb
 - lib/newshound/middleware/banner_injector.rb
-- lib/newshound/que_reporter.rb
 - lib/newshound/railtie.rb
 - lib/newshound/version.rb
 - lib/newshound/warning_reporter.rb
@@ -80,6 +69,10 @@ metadata:
   homepage_uri: https://github.com/SOFware/newshound
   source_code_uri: https://github.com/SOFware/newshound
   changelog_uri: https://github.com/SOFware/newshound/blob/main/CHANGELOG.md
+post_install_message: |
+  To complete installation, run:
+
+    rails generate newshound:install
 rdoc_options: []
 require_paths:
 - lib
@@ -87,14 +80,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 4.0.3
 specification_version: 4
-summary: Real-time web UI banner for monitoring Que jobs and exception tracking
+summary: Real-time web UI banner for monitoring background jobs and exception tracking
 test_files: []

data/lib/newshound/que_reporter.rb

@@ -1,166 +0,0 @@
-# frozen_string_literal: true
-
-module Newshound
-  class QueReporter
-    attr_reader :job_source, :logger
-
-    def initialize(job_source: nil, logger: nil)
-      @job_source = job_source || (defined?(::Que::Job) ? ::Que::Job : nil)
-      @logger = logger || (defined?(Rails) ? Rails.logger : Logger.new($stdout))
-    end
-
-    def generate_report
-      [
-        {
-          type: "section",
-          text: {
-            type: "mrkdwn",
-            text: "*📊 Que Jobs Status*"
-          }
-        },
-        job_counts_section,
-        queue_health_section
-      ].compact
-    end
-    alias_method :report, :generate_report
-
-    # Returns data formatted for the banner UI
-    def banner_data
-      stats = queue_statistics
-
-      {
-        queue_stats: {
-          ready_to_run: stats[:ready],
-          scheduled: stats[:scheduled],
-          failed: stats[:failed],
-          completed_today: stats[:finished_today]
-        }
-      }
-    end
-
-    private
-
-    def job_counts_section
-      counts = job_counts_by_type
-
-      return no_jobs_section if counts.empty?
-
-      {
-        type: "section",
-        text: {
-          type: "mrkdwn",
-          text: format_job_counts(counts)
-        }
-      }
-    end
-
-    def job_counts_by_type
-      return {} unless job_source
-
-      # Use raw SQL since Que::Job may not support ActiveRecord's .group method
-      results = ActiveRecord::Base.connection.execute(<<~SQL)
-        SELECT job_class, error_count, COUNT(*) as count
-        FROM que_jobs
-        WHERE finished_at IS NULL
-        GROUP BY job_class, error_count
-        ORDER BY job_class
-      SQL
-
-      results.each_with_object({}) do |row, hash|
-        job_class = row["job_class"]
-        error_count = row["error_count"].to_i
-        count = row["count"].to_i
-
-        hash[job_class] ||= {success: 0, failed: 0, total: 0}
-
-        if error_count.zero?
-          hash[job_class][:success] += count
-        else
-          hash[job_class][:failed] += count
-        end
-
-        hash[job_class][:total] += count
-      end
-    rescue => e
-      logger.error "Failed to fetch job counts: #{e.message}"
-      {}
-    end
-
-    def format_job_counts(counts)
-      lines = ["*Job Counts by Type:*"]
-
-      counts.each do |job_class, stats|
-        status_emoji = (stats[:failed] > 0) ? "⚠️" : "✅"
-        lines << "• #{status_emoji} *#{job_class}*: #{stats[:total]} total (#{stats[:success]} success, #{stats[:failed]} failed)"
-      end
-
-      lines.join("\n")
-    end
-
-    def queue_health_section
-      stats = queue_statistics
-
-      {
-        type: "section",
-        text: {
-          type: "mrkdwn",
-          text: format_queue_health(stats)
-        }
-      }
-    end
-
-    def queue_statistics
-      return default_stats unless job_source
-
-      conn = ActiveRecord::Base.connection
-      current_time = conn.quote(Time.now)
-      beginning_of_day = conn.quote(Date.today.to_time)
-
-      {
-        ready: count_jobs("finished_at IS NULL AND expired_at IS NULL AND run_at <= #{current_time}"),
-        scheduled: count_jobs("finished_at IS NULL AND expired_at IS NULL AND run_at > #{current_time}"),
-        failed: count_jobs("error_count > 0 AND finished_at IS NULL"),
-        finished_today: count_jobs("finished_at >= #{beginning_of_day}")
-      }
-    rescue => e
-      logger.error "Failed to fetch Que statistics: #{e.message}"
-      default_stats
-    end
-
-    def count_jobs(where_clause)
-      ActiveRecord::Base.connection.select_value(
-        "SELECT COUNT(*) FROM que_jobs WHERE #{where_clause}"
-      ).to_i
-    end
-
-    def default_stats
-      {ready: 0, scheduled: 0, failed: 0, finished_today: 0}
-    end
-
-    def format_queue_health(stats)
-      health_emoji = if stats[:failed] > 10
-        "🔴"
-      else
-        (stats[:failed] > 5) ? "🟡" : "🟢"
-      end
-
-      <<~TEXT
-        *Queue Health #{health_emoji}*
-        • *Ready to Run:* #{stats[:ready]}
-        • *Scheduled:* #{stats[:scheduled]}
-        • *Failed (Retry Queue):* #{stats[:failed]}
-        • *Completed Today:* #{stats[:finished_today]}
-      TEXT
-    end
-
-    def no_jobs_section
-      {
-        type: "section",
-        text: {
-          type: "mrkdwn",
-          text: "*No jobs found in the queue*"
-        }
-      }
-    end
-  end
-end