DRY refactor: extract shared ComponentAccess module

Co-authored-by: GrantBirki <[email protected]>

Author: Copilot

lib/hooks.rb

@@ -7,6 +7,7 @@
 require_relative "hooks/core/logger_factory"
 require_relative "hooks/core/plugin_loader"
 require_relative "hooks/core/global_components"
+require_relative "hooks/core/component_access"
 require_relative "hooks/core/log"
 require_relative "hooks/core/failbot"
 require_relative "hooks/core/stats"

lib/hooks/core/component_access.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Hooks
+  module Core
+    # Shared module providing access to global components (logger, stats, failbot)
+    #
+    # This module provides a consistent interface for accessing global components
+    # across all plugin types, eliminating code duplication and ensuring consistent
+    # behavior throughout the application.
+    #
+    # @example Usage in a class that needs instance methods
+    #   class MyHandler
+    #     include Hooks::Core::ComponentAccess
+    #
+    #     def process
+    #       log.info("Processing request")
+    #       stats.increment("requests.processed")
+    #       failbot.report("Error occurred") if error?
+    #     end
+    #   end
+    #
+    # @example Usage in a class that needs class methods
+    #   class MyValidator
+    #     extend Hooks::Core::ComponentAccess
+    #
+    #     def self.validate
+    #       log.info("Validating request")
+    #       stats.increment("requests.validated")
+    #     end
+    #   end
+    module ComponentAccess
+      # Short logger accessor
+      # @return [Hooks::Log] Logger instance for logging messages
+      #
+      # Provides a convenient way to log messages without needing
+      # to reference the full Hooks::Log namespace.
+      #
+      # @example Logging an error
+      #   log.error("Something went wrong")
+      def log
+        Hooks::Log.instance
+      end
+
+      # Global stats component accessor
+      # @return [Hooks::Plugins::Instruments::Stats] Stats instance for metrics reporting
+      #
+      # Provides access to the global stats component for reporting metrics
+      # to services like DataDog, New Relic, etc.
+      #
+      # @example Recording a metric
+      #   stats.increment("webhook.processed", { handler: "MyHandler" })
+      def stats
+        Hooks::Core::GlobalComponents.stats
+      end
+
+      # Global failbot component accessor
+      # @return [Hooks::Plugins::Instruments::Failbot] Failbot instance for error reporting
+      #
+      # Provides access to the global failbot component for reporting errors
+      # to services like Sentry, Rollbar, etc.
+      #
+      # @example Reporting an error
+      #   failbot.report("Something went wrong", { context: "additional info" })
+      def failbot
+        Hooks::Core::GlobalComponents.failbot
+      end
+    end
+  end
+end

lib/hooks/plugins/auth/base.rb

@@ -3,6 +3,7 @@
 require "rack/utils"
 require_relative "../../core/log"
 require_relative "../../core/global_components"
+require_relative "../../core/component_access"
 
 module Hooks
   module Plugins
@@ -11,6 +12,8 @@ module Auth
       #
       # All custom Auth plugins must inherit from this class
       class Base
+        extend Hooks::Core::ComponentAccess
+
         # Validate request
         #
         # @param payload [String] Raw request body
@@ -22,42 +25,6 @@ def self.valid?(payload:, headers:, config:)
           raise NotImplementedError, "Validator must implement .valid? class method"
         end
 
-        # Short logger accessor for all subclasses
-        # @return [Hooks::Log] Logger instance for request validation
-        #
-        # Provides a convenient way for validators to log messages without needing
-        # to reference the full Hooks::Log namespace.
-        #
-        # @example Logging an error in an inherited class
-        #   log.error("oh no an error occured")
-        def self.log
-          Hooks::Log.instance
-        end
-
-        # Global stats component accessor
-        # @return [Hooks::Core::Stats] Stats instance for metrics reporting
-        #
-        # Provides access to the global stats component for reporting metrics
-        # to services like DataDog, New Relic, etc.
-        #
-        # @example Recording a metric in an inherited class
-        #   stats.increment("auth.validation", { plugin: "hmac" })
-        def self.stats
-          Hooks::Core::GlobalComponents.stats
-        end
-
-        # Global failbot component accessor
-        # @return [Hooks::Core::Failbot] Failbot instance for error reporting
-        #
-        # Provides access to the global failbot component for reporting errors
-        # to services like Sentry, Rollbar, etc.
-        #
-        # @example Reporting an error in an inherited class
-        #   failbot.report("Auth validation failed", { plugin: "hmac" })
-        def self.failbot
-          Hooks::Core::GlobalComponents.failbot
-        end
-
         # Retrieve the secret from the environment variable based on the key set in the configuration
         #
         # Note: This method is intended to be used by subclasses

lib/hooks/plugins/handlers/base.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "../../core/global_components"
+require_relative "../../core/component_access"
 
 module Hooks
   module Plugins
@@ -9,6 +10,8 @@ module Handlers
       #
       # All custom handlers must inherit from this class and implement the #call method
       class Base
+        include Hooks::Core::ComponentAccess
+
         # Process a webhook request
         #
         # @param payload [Hash, String] Parsed request body (JSON Hash) or raw string
@@ -19,42 +22,6 @@ class Base
         def call(payload:, headers:, config:)
           raise NotImplementedError, "Handler must implement #call method"
         end
-
-        # Short logger accessor for all subclasses
-        # @return [Hooks::Log] Logger instance
-        #
-        # Provides a convenient way for handlers to log messages without needing
-        # to reference the full Hooks::Log namespace.
-        #
-        # @example Logging an error in an inherited class
-        #   log.error("oh no an error occured")
-        def log
-          Hooks::Log.instance
-        end
-
-        # Global stats component accessor
-        # @return [Hooks::Core::Stats] Stats instance for metrics reporting
-        #
-        # Provides access to the global stats component for reporting metrics
-        # to services like DataDog, New Relic, etc.
-        #
-        # @example Recording a metric in an inherited class
-        #   stats.increment("webhook.processed", { handler: "MyHandler" })
-        def stats
-          Hooks::Core::GlobalComponents.stats
-        end
-
-        # Global failbot component accessor
-        # @return [Hooks::Core::Failbot] Failbot instance for error reporting
-        #
-        # Provides access to the global failbot component for reporting errors
-        # to services like Sentry, Rollbar, etc.
-        #
-        # @example Reporting an error in an inherited class
-        #   failbot.report("Something went wrong", { handler: "MyHandler" })
-        def failbot
-          Hooks::Core::GlobalComponents.failbot
-        end
       end
     end
   end

lib/hooks/plugins/lifecycle.rb

@@ -1,13 +1,16 @@
 # frozen_string_literal: true
 
 require_relative "../core/global_components"
+require_relative "../core/component_access"
 
 module Hooks
   module Plugins
     # Base class for global lifecycle plugins
     #
     # Plugins can hook into request/response/error lifecycle events
     class Lifecycle
+      include Hooks::Core::ComponentAccess
+
       # Called before handler execution
       #
       # @param env [Hash] Rack environment
@@ -30,42 +33,6 @@ def on_response(env, response)
       def on_error(exception, env)
         # Override in subclass for error handling logic
       end
-
-      # Short logger accessor for all subclasses
-      # @return [Hooks::Log] Logger instance
-      #
-      # Provides a convenient way for lifecycle plugins to log messages without needing
-      # to reference the full Hooks::Log namespace.
-      #
-      # @example Logging an error in an inherited class
-      #   log.error("oh no an error occured")
-      def log
-        Hooks::Log.instance
-      end
-
-      # Global stats component accessor
-      # @return [Hooks::Core::Stats] Stats instance for metrics reporting
-      #
-      # Provides access to the global stats component for reporting metrics
-      # to services like DataDog, New Relic, etc.
-      #
-      # @example Recording a metric in an inherited class
-      #   stats.increment("lifecycle.request_processed")
-      def stats
-        Hooks::Core::GlobalComponents.stats
-      end
-
-      # Global failbot component accessor
-      # @return [Hooks::Core::Failbot] Failbot instance for error reporting
-      #
-      # Provides access to the global failbot component for reporting errors
-      # to services like Sentry, Rollbar, etc.
-      #
-      # @example Reporting an error in an inherited class
-      #   failbot.report("Lifecycle hook failed")
-      def failbot
-        Hooks::Core::GlobalComponents.failbot
-      end
     end
   end
 end

spec/unit/lib/hooks/core/component_access_spec.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+describe Hooks::Core::ComponentAccess do
+  let(:test_class_with_include) do
+    Class.new do
+      include Hooks::Core::ComponentAccess
+    end
+  end
+
+  let(:test_class_with_extend) do
+    Class.new do
+      extend Hooks::Core::ComponentAccess
+    end
+  end
+
+  describe "when included" do
+    let(:instance) { test_class_with_include.new }
+
+    describe "#log" do
+      it "provides access to global logger" do
+        expect(instance.log).to be(Hooks::Log.instance)
+      end
+    end
+
+    describe "#stats" do
+      it "provides access to global stats" do
+        expect(instance.stats).to be_a(Hooks::Plugins::Instruments::Stats)
+        expect(instance.stats).to eq(Hooks::Core::GlobalComponents.stats)
+      end
+    end
+
+    describe "#failbot" do
+      it "provides access to global failbot" do
+        expect(instance.failbot).to be_a(Hooks::Plugins::Instruments::Failbot)
+        expect(instance.failbot).to eq(Hooks::Core::GlobalComponents.failbot)
+      end
+    end
+  end
+
+  describe "when extended" do
+    describe ".log" do
+      it "provides access to global logger" do
+        expect(test_class_with_extend.log).to be(Hooks::Log.instance)
+      end
+    end
+
+    describe ".stats" do
+      it "provides access to global stats" do
+        expect(test_class_with_extend.stats).to be_a(Hooks::Plugins::Instruments::Stats)
+        expect(test_class_with_extend.stats).to eq(Hooks::Core::GlobalComponents.stats)
+      end
+    end
+
+    describe ".failbot" do
+      it "provides access to global failbot" do
+        expect(test_class_with_extend.failbot).to be_a(Hooks::Plugins::Instruments::Failbot)
+        expect(test_class_with_extend.failbot).to eq(Hooks::Core::GlobalComponents.failbot)
+      end
+    end
+  end
+end

spec/unit/lib/hooks/handlers/base_spec.rb

@@ -145,7 +145,7 @@ def call(payload:, headers:, config:)
 
   describe "documentation compliance" do
     it "has the expected public interface" do
-      expect(described_class.instance_methods(false)).to include(:call, :log, :stats, :failbot)
+      expect(described_class.instance_methods).to include(:call, :log, :stats, :failbot)
     end
 
     it "call method accepts the documented parameters" do

spec/unit/lib/hooks/plugins/auth/base_spec.rb

@@ -206,7 +206,7 @@ def self.valid?(payload:, headers:, config:)
 
   describe "documentation compliance" do
     it "has the expected public interface" do
-      expect(described_class.methods(false)).to include(:valid?, :log, :stats, :failbot, :fetch_secret)
+      expect(described_class.methods).to include(:valid?, :log, :stats, :failbot, :fetch_secret)
     end
 
     it "valid? method accepts the documented parameters" do