Contents

# frozen_string_literal: true

module ROM
  module Plugins
    module Relation
      # Experimental plugin for configuring relations with an external
      # instrumentation system like dry-monitor or ActiveSupport::Notifications
      #
      # @api public
      module Instrumentation
        extend Dry::Core::ClassAttributes

        # This hooks sets up a relation class with injectible notifications object
        #
        # @api private
        def self.included(klass)
          super
          klass.option :notifications
          klass.extend(ClassInterface)
          klass.prepend(mixin)
          klass.instrument(:to_a)
        end

        defines :mixin
        mixin Module.new

        # Instrumentation extension for relation classes
        #
        # @api private
        module ClassInterface
          # Configure provided methods for instrumentation
          #
          # @param [Array<Symbol>] methods A list of method names
          #
          # @api public
          def instrument(*methods)
            (methods - Instrumentation.mixin.instance_methods).each do |meth|
              Instrumentation.mixin.send(:define_method, meth) do
                instrument { super() }
              end
            end
          end
        end

        # Execute a block using instrumentation
        #
        # @api public
        def instrument(&block)
          notifications.instrument(self.class.adapter, name: name.relation, **notification_payload(self), &block)
        end

        private

        # @api private
        def notification_payload(_relation)
          EMPTY_HASH
        end
      end
    end
  end
end

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
rom-core-5.3.2	lib/rom/plugins/relation/instrumentation.rb
rom-core-5.3.1	lib/rom/plugins/relation/instrumentation.rb
rom-core-5.3.0	lib/rom/plugins/relation/instrumentation.rb