newshound 0.2.2 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65debb3ae756e51f870de0872ff54d2332ee71e9c05aa6ac174c9525336c46b5
-  data.tar.gz: 8667bbc9ff8695b5191bccbbe066190bb9e6f86f7c7ef0d6508a312420258167
+  metadata.gz: 3d9a10844e45f2216a4e2f9a3aa895d72a2cbffb09c157460ce989e7a390564b
+  data.tar.gz: e271a3cd7916ec4eee93274e7601f14e4c7dd55d6db92ae55dce2f74f9c31245
 SHA512:
-  metadata.gz: 7bb18eaf72c010172a7c80c13f782b6736620cef9855ee81f0faaa2ad32d1659b02d0970a4381adad7b42d72eb80663b8c93e0eefebd58d61ec75d45c2c31081
-  data.tar.gz: '07722335323043284857b615205ec4def0f167f4f77308ffce3eeb1911afe85c963e6a62987f88d88d59e8385a4998d30e33835211c6c7d70f52e111f46ae5bb'
+  metadata.gz: a3c24e8dcf33ef8ea5c346e566f6a5441afa0657ab338b2599806133088f0f19ed36af407cf3d93da087bc76965dc35b3d135b222d6b0aa53f5caa610e015954
+  data.tar.gz: 3f2197e8a8bd9d99a2968df964bfd0c471d1c344a365c31a8e092ea9d5c09dfe9f4a87f97da14b3e92e32f9b9219327414998c3f36779b6780ef56b0f03cd9fd

data/CHANGELOG.md

@@ -5,45 +5,31 @@ 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.2] - 2025-10-23
+## [0.2.5] - 2025-12-12
 
 ### Added
 
-- CI workflow to run tests on Ruby 3.0-3.4 (b3ebc7a)
-- Separate linter job for RuboCop (b3ebc7a)
-- Coverage reporting with SimpleCov (b3ebc7a)
-- CI workflow to run tests on Ruby 3.0-3.4 (782cc57)
-- Separate linter job for RuboCop (782cc57)
-- Coverage reporting with SimpleCov (782cc57)
-- .claude/settings.local.json to .gitignore (701d802)
-- Reissue gem dependency for automated versioning (feac98a)
-- Git trailer support for changelog management (feac98a)
-- Initial CHANGELOG.md with Keep a Changelog format (feac98a)
-- CODEOWNERS file for SOFware/engineers (1a0a1f5)
-- Newshound::Exceptions::Base for standard API to interact with exception data (9dce846)
-- Configuration exception_source to allow for future alternative exception backends (9dce846)
-- SolidErrors support (8b5b48a)
+- Add `Newshound::Warnings` module with registry-based adapter pattern for custom warning sources
+- Add `Newshound::Warnings::Base` abstract class for warning adapters
+- Add `Newshound::WarningReporter` for fetching and formatting warnings
+- Display warnings in banner alongside exceptions and job stats
 
-### Changed
+### Fixed
 
-- Replaced RuboCop with StandardRB for simpler linting (09292ed)
-- Updated GitHub Actions workflow to use standardrb (09292ed)
-- Auto-corrected all StandardRB violations (09292ed)
-- Simplified test setup by removing unused mocks (701d802)
-- Rakefile to use reissue tasks instead of manual versioning (feac98a)
-- Removed Ruby 3.0 from test matrix (now testing 3.1-3.4) (4beafd2)
-- Updated gemspec required_ruby_version to >= 3.1.0 (4beafd2)
+- Fixed summary badge to show combined warnings and failed jobs count
+
+## [0.2.4] - 2025-12-12
 
 ### Fixed
 
-- Workflow now only runs once per PR (removed duplicate triggers) (09292ed)
-- Mock ActiveRecord::Base.connection and its methods (701d802)
-- Mock connection.execute to return database-like results (701d802)
-- Mock connection.quote and connection.select_value properly (701d802)
-- Name and email in gemspec authors (ab44f30)
+- Fixed release workflow to properly create version bump PRs using gh pr create instead of peter-evans/create-pull-request action, resolving compatibility issue with reissue gem
 
-### Removed
+## [0.2.3] - 2025-10-29
 
-- Dependency on exception-track (8b5b48a)
+### Fixed
+
+- Updated styling in banner injector to attempt to keep newshound banner above other application's menus, instead of hovering over them.
+
+### Changed
 
-## [0.2.2] - Unreleased
+- Consolidated exception data extraction in ExceptionTrack and SolidErrors (55cffd3)

data/README.md

@@ -203,18 +203,12 @@ bin/console
 
 ## Release Management
 
-This gem uses [Reissue](https://github.com/rails/reissue) for release management. To release a new version, perform
-the following steps as you would with any other ruby gem:
+This gem uses [Reissue](https://github.com/rails/reissue) for release management. Releases are automated via GitHub Actions:
 
-```bash
-bundle exec rake bump:checksum
-```
-And then create a new release:
-```bash
-bundle exec rake release
-```
-
-The final step is to push your version bump branch, open a PR, and merge it.
+1. Navigate to Actions → "Release gem to RubyGems.org"
+2. Click "Run workflow"
+3. Select version segment to bump (patch, minor, major)
+4. Review and merge the auto-generated PR
 
 ## Dependencies
 

data/Rakefile

@@ -8,6 +8,7 @@ require "standard/rake"
 Reissue::Task.create :reissue do |task|
   task.version_file = "lib/newshound/version.rb"
   task.fragment = :git
+  task.commit_finalize = false # Let workflow handle commits
 end
 
 RSpec::Core::RakeTask.new(:spec)

data/checksums/newshound-0.2.3.gem.sha512

@@ -0,0 +1 @@
+4b38b6628a214ff2cf66a400e184a5659a2ba82ccf46efde37293d93dd77534ffe87d3dd41220e0cac43aabaed66318cbdb70b8cbf66988f744f04ead452bbc5

data/checksums/newshound-0.2.5.gem.sha512

@@ -0,0 +1 @@
+e17f9781dfbe16702fdda1809ec0e69eacbb3ed762d8df8fb0c471b79860989a0dfedebbb22923bf699c4b243ad8a543bdab374b3ab6c296b67cae3c4b5c305a

data/lib/newshound/configuration.rb

@@ -3,7 +3,8 @@
 module Newshound
   class Configuration
     attr_accessor :exception_limit, :enabled, :authorized_roles,
-      :current_user_method, :authorization_block, :exception_source
+      :current_user_method, :authorization_block, :exception_source,
+      :warning_source, :warning_limit
 
     def initialize
       @exception_limit = 10
@@ -12,6 +13,8 @@ module Newshound
       @current_user_method = :current_user
       @authorization_block = nil
       @exception_source = :exception_track
+      @warning_source = nil
+      @warning_limit = 10
     end
 
     # Allow custom authorization logic

data/lib/newshound/exceptions/exception_track.rb

@@ -12,53 +12,41 @@ module Newshound
         details = parse_exception_details(exception)
 
         <<~TEXT
-          *#{number}. #{exception_title(exception)}*
+          *#{number}. #{details[:title]}*
           • *Time:* #{exception.created_at.strftime("%I:%M %p")}
           #{format_controller(details)}
-          #{format_message(exception, details)}
+          #{format_message(details)}
         TEXT
       end
 
       def format_for_banner(exception)
         details = parse_exception_details(exception)
 
-        # Extract message
-        message = if details["message"].present?
-          details["message"].to_s
-        elsif exception.respond_to?(:message) && exception.message.present?
-          exception.message.to_s
-        else
-          +""
-        end
-
-        # Extract location
-        location = if details["controller_name"] && details["action_name"]
-          "#{details["controller_name"]}##{details["action_name"]}"
-        else
-          +""
-        end
-
         {
-          title: exception_title(exception),
-          message: message.truncate(100),
-          location: location,
+          title: details[:title],
+          message: details[:message].truncate(100),
+          location: details[:location],
           time: exception.created_at.strftime("%I:%M %p")
         }
       end
 
       private
 
-      def exception_title(exception)
-        if exception.respond_to?(:title) && exception.title.present?
-          exception.title
-        elsif exception.respond_to?(:exception_class) && exception.exception_class.present?
-          exception.exception_class
-        else
-          "Unknown Exception"
-        end
+      def parse_exception_details(exception)
+        body_data = parse_body(exception)
+        controller_name = body_data["controller_name"]
+        action_name = body_data["action_name"]
+
+        {
+          title: exception.try(:title).presence || exception.try(:exception_class).presence || "Unknown Exception",
+          message: body_data["message"].presence&.to_s || exception.try(:message).presence&.to_s || +"",
+          location: (controller_name && action_name) ? "#{controller_name}##{action_name}" : +"",
+          controller_name: controller_name,
+          action_name: action_name
+        }
       end
 
-      def parse_exception_details(exception)
+      def parse_body(exception)
         return {} unless exception.respond_to?(:body) && exception.body.present?
 
         JSON.parse(exception.body)
@@ -67,24 +55,15 @@ module Newshound
       end
 
       def format_controller(details)
-        return +"" unless details["controller_name"] && details["action_name"]
+        return +"" unless details in {controller_name: String, action_name: String}
 
-        "• *Controller:* #{details["controller_name"]}##{details["action_name"]}\n"
+        "• *Controller:* #{details[:location]}\n"
       end
 
-      def format_message(exception, details = nil)
-        details ||= parse_exception_details(exception)
-
-        # Try to get message from different sources
-        message = if details["message"].present?
-          details["message"]
-        elsif exception.respond_to?(:message) && exception.message.present?
-          exception.message
-        end
-
-        return +"" unless message.present?
+      def format_message(details)
+        return +"" unless details in {message: String}
 
-        message = message.to_s.truncate(100)
+        message = details[:message].to_s.truncate(100)
         "• *Message:* `#{message}`"
       end
     end

data/lib/newshound/exceptions/solid_errors.rb

@@ -9,60 +9,50 @@ module Newshound
       end
 
       def format_for_report(exception, number)
-        context = parse_context(exception)
+        details = parse_exception_details(exception)
 
         <<~TEXT
-          *#{number}. #{exception_title(exception)}*
+          *#{number}. #{details[:title]}*
           • *Time:* #{exception.created_at.strftime("%I:%M %p")}
-          #{format_controller(context)}
-          #{format_message(exception, context)}
+          #{format_controller(details)}
+          #{format_message(details)}
         TEXT
       end
 
       def format_for_banner(exception)
-        context = parse_context(exception)
-
-        # Extract message
-        message = if exception.respond_to?(:message) && exception.message.present?
-          exception.message.to_s
-        elsif context["message"].present?
-          context["message"].to_s
-        else
-          +""
-        end
-
-        # Extract location from context
-        location = if context["controller"] && context["action"]
-          "#{context["controller"]}##{context["action"]}"
-        else
-          +""
-        end
+        details = parse_exception_details(exception)
 
         {
-          title: exception_title(exception),
-          message: message.truncate(100),
-          location: location,
+          title: details[:title],
+          message: details[:message].truncate(100),
+          location: details[:location],
           time: exception.created_at.strftime("%I:%M %p")
         }
       end
 
       private
 
-      def exception_title(exception)
-        if exception.respond_to?(:error_class) && exception.error_class.present?
-          exception.error_class
-        else
-          "Unknown Exception"
-        end
+      def parse_exception_details(exception)
+        context_data = parse_context(exception)
+        controller = context_data["controller"]
+        action = context_data["action"]
+
+        {
+          title: exception.try(:error_class).presence || "Unknown Exception",
+          message: exception.try(:message).presence&.to_s || context_data["message"].presence&.to_s || +"",
+          location: (controller && action) ? "#{controller}##{action}" : +"",
+          controller: controller,
+          action: action
+        }
       end
 
       def parse_context(exception)
         return {} unless exception.respond_to?(:context) && exception.context.present?
 
-        # SolidErrors context might be a hash or JSON string
-        if exception.context.is_a?(Hash)
+        case exception.context
+        when Hash
           exception.context
-        elsif exception.context.is_a?(String)
+        when String
           JSON.parse(exception.context)
         else
           {}
@@ -71,25 +61,16 @@ module Newshound
         {}
       end
 
-      def format_controller(context)
-        return +"" unless context["controller"] && context["action"]
+      def format_controller(details)
+        return +"" unless details in {controller: String, action: String}
 
-        "• *Controller:* #{context["controller"]}##{context["action"]}\n"
+        "• *Controller:* #{details[:location]}\n"
       end
 
-      def format_message(exception, context = nil)
-        context ||= parse_context(exception)
-
-        # Try to get message from different sources
-        message = if exception.respond_to?(:message) && exception.message.present?
-          exception.message
-        elsif context["message"].present?
-          context["message"]
-        end
-
-        return +"" unless message.present?
+      def format_message(details)
+        return +"" unless details in {message: String}
 
-        message = message.to_s.truncate(100)
+        message = details[:message].to_s.truncate(100)
         "• *Message:* `#{message}`"
       end
     end

data/lib/newshound/middleware/banner_injector.rb

@@ -56,27 +56,30 @@ module Newshound
       def generate_banner_html
         exception_reporter = Newshound::ExceptionReporter.new
         que_reporter = Newshound::QueReporter.new
+        warning_reporter = Newshound::WarningReporter.new
 
         exception_data = exception_reporter.banner_data
         job_data = que_reporter.banner_data
+        warning_data = warning_reporter.banner_data
 
         # Generate HTML from template
-        render_banner(exception_data, job_data)
+        render_banner(exception_data, job_data, warning_data)
       end
 
-      def render_banner(exception_data, job_data)
+      def render_banner(exception_data, job_data, warning_data = {})
         <<~HTML
           <div id="newshound-banner" class="newshound-banner newshound-collapsed">
             #{render_styles}
             <div class="newshound-header" onclick="document.getElementById('newshound-banner').classList.toggle('newshound-collapsed'); window.newshoundUpdatePadding();">
               <span class="newshound-title">
                 🐕 Newshound
-                #{summary_badge(exception_data, job_data)}
+                #{summary_badge(exception_data, job_data, warning_data)}
               </span>
               <span class="newshound-toggle">▼</span>
             </div>
             <div class="newshound-content">
               #{render_exceptions(exception_data)}
+              #{render_warnings(warning_data)}
               #{render_jobs(job_data)}
             </div>
           </div>
@@ -117,7 +120,7 @@ module Newshound
         <<~CSS
           <style>
             body {
-              padding-top: 0;
+              padding-top: 50px;
               transition: padding-top 0.3s ease-out;
             }
             .newshound-banner {
@@ -236,16 +239,20 @@ module Newshound
         CSS
       end
 
-      def summary_badge(exception_data, job_data)
+      def summary_badge(exception_data, job_data, warning_data = {})
         exception_count = exception_data[:exceptions]&.length || 0
         failed_jobs = job_data.dig(:queue_stats, :failed) || 0
+        warning_count = warning_data[:warnings]&.length || 0
 
         if exception_count > 0 || failed_jobs > 10
           badge_class = "error"
           text = "#{exception_count} exceptions, #{failed_jobs} failed jobs"
-        elsif failed_jobs > 5
+        elsif warning_count > 0 || failed_jobs > 5
           badge_class = "warning"
-          text = "#{failed_jobs} failed jobs"
+          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"
           text = "All clear"
@@ -280,6 +287,30 @@ module Newshound
         HTML
       end
 
+      def render_warnings(data)
+        warnings = data[:warnings] || []
+
+        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>
+            </div>
+          HTML
+        end.join
+
+        <<~HTML
+          <div class="newshound-section">
+            <div class="newshound-section-title">⚠️ Warnings (#{warnings.length})</div>
+            #{items}
+          </div>
+        HTML
+      end
+
       def render_jobs(data)
         stats = data[:queue_stats] || {}
 

data/lib/newshound/version.rb

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

data/lib/newshound/warning_reporter.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module Newshound
+  class WarningReporter
+    attr_reader :warning_source, :configuration, :time_range
+
+    def initialize(warning_source: nil, configuration: nil, time_range: 24.hours)
+      @configuration = configuration || Newshound.configuration
+      @warning_source = resolve_warning_source(warning_source)
+      @time_range = time_range
+    end
+
+    def generate_report
+      return no_warnings_block if recent_warnings.empty?
+
+      [
+        {
+          type: "section",
+          text: {
+            type: "mrkdwn",
+            text: "*⚠️ Recent Warnings (Last 24 Hours)*"
+          }
+        },
+        *format_warnings
+      ]
+    end
+    alias_method :report, :generate_report
+
+    # Returns data formatted for the banner UI
+    def banner_data
+      return {warnings: []} unless warning_source
+
+      {
+        warnings: recent_warnings.map { |warning| warning_source.format_for_banner(warning) }
+      }
+    end
+
+    private
+
+    def resolve_warning_source(source)
+      source ||= @configuration.warning_source
+      return nil if source.nil?
+
+      source.is_a?(Symbol) ? Warnings.source(source) : source
+    end
+
+    def recent_warnings
+      return [] unless warning_source
+
+      @recent_warnings ||= warning_source.recent(
+        time_range: time_range,
+        limit: configuration.warning_limit
+      )
+    end
+
+    def format_warnings
+      recent_warnings.map.with_index do |warning, index|
+        {
+          type: "section",
+          text: {
+            type: "mrkdwn",
+            text: warning_source.format_for_report(warning, index + 1)
+          }
+        }
+      end
+    end
+
+    def no_warnings_block
+      [
+        {
+          type: "section",
+          text: {
+            type: "mrkdwn",
+            text: "*✅ No Warnings in the Last 24 Hours*"
+          }
+        }
+      ]
+    end
+  end
+end

data/lib/newshound/warnings/base.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Newshound
+  module Warnings
+    # Base class for warning source adapters
+    # Each adapter is responsible for:
+    # 1. Fetching recent warnings from its specific data source
+    # 2. Formatting warning data for reports and banners
+    #
+    # Subclasses must implement:
+    # - #recent(time_range:, limit:) - Returns a collection of warning records
+    # - #format_for_report(warning, number) - Formats a single warning for Slack/report display
+    # - #format_for_banner(warning) - Formats a single warning for banner UI
+    class Base
+      # Fetches recent warnings from the data source
+      #
+      # @param time_range [ActiveSupport::Duration] Time duration to look back (e.g., 24.hours)
+      # @param limit [Integer] Maximum number of warnings to return
+      # @return [Array] Collection of warning records
+      def recent(time_range:, limit:)
+        raise NotImplementedError, "#{self.class} must implement #recent"
+      end
+
+      # Formats a warning for report/Slack display
+      #
+      # @param warning [Object] Warning record from the data source
+      # @param number [Integer] Position number in the list
+      # @return [String] Formatted markdown text for display
+      def format_for_report(warning, number)
+        raise NotImplementedError, "#{self.class} must implement #format_for_report"
+      end
+
+      # 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
+      def format_for_banner(warning)
+        raise NotImplementedError, "#{self.class} must implement #format_for_banner"
+      end
+    end
+  end
+end

data/lib/newshound/warnings.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+Dir[File.join(__dir__, "warnings", "*.rb")].each { |file| require file }
+
+module Newshound
+  module Warnings
+    # Registry for warning adapters
+    # Allows applications to register custom warning sources without
+    # needing to create classes within the Newshound namespace
+    @registry = {}
+
+    class << self
+      # Access the registry of registered adapters
+      # @return [Hash] The registry hash mapping names to adapter classes
+      attr_reader :registry
+
+      # Register a warning 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 Warnings::Base)
+      # @example
+      #   Newshound::Warnings.register(:unprocessable_events, MyApp::UnprocessableEventsWarning)
+      def register(name, adapter_class)
+        @registry[name.to_sym] = adapter_class
+      end
+
+      # Get a warning source adapter instance
+      #
+      # @param source [Symbol, Object] Either a symbolic name to look up, or an adapter instance
+      # @return [Warnings::Base] An instance of the warning adapter
+      # @raise [RuntimeError] If the source symbol cannot be resolved
+      # @example
+      #   Newshound::Warnings.source(:unprocessable_events)
+      #   Newshound::Warnings.source(MyAdapter.new)
+      def source(source)
+        return source unless source.is_a?(Symbol)
+
+        # First check the registry
+        if @registry.key?(source)
+          return @registry[source].new
+        end
+
+        # Fall back to constant lookup (like Exceptions module)
+        constant = constants.find { |c| c.to_s.gsub(/(?<!^)([A-Z])/, "_\\1").downcase == source.to_s }
+        raise "Invalid warning source: #{source}" unless constant
+
+        const_get(constant).new
+      end
+
+      # Clear the registry (primarily for testing)
+      def clear_registry!
+        @registry = {}
+      end
+    end
+  end
+end

data/lib/newshound.rb

@@ -4,6 +4,8 @@ require_relative "newshound/version"
 require_relative "newshound/configuration"
 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/authorization"
 require_relative "newshound/middleware/banner_injector"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: newshound
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.5
 platform: ruby
 authors:
 - Savannah Moore
@@ -52,6 +52,8 @@ files:
 - README.md
 - Rakefile
 - TRANSPORT_USAGE.md
+- checksums/newshound-0.2.3.gem.sha512
+- checksums/newshound-0.2.5.gem.sha512
 - lib/generators/newshound/install/install_generator.rb
 - lib/generators/newshound/install/templates/newshound.rb
 - lib/newshound.rb
@@ -66,6 +68,9 @@ files:
 - lib/newshound/que_reporter.rb
 - lib/newshound/railtie.rb
 - lib/newshound/version.rb
+- lib/newshound/warning_reporter.rb
+- lib/newshound/warnings.rb
+- lib/newshound/warnings/base.rb
 - newshound.gemspec
 homepage: https://github.com/SOFware/newshound
 licenses: