Sha256: 69f76db1e390aecf2c8dc0b256ba76d705db8061b7bfe5538ee56d2c95a05c3d

Contents?: true

Size: 973 Bytes

Versions: 10

Compression:

Stored size: 973 Bytes

Contents

# frozen_string_literal: true

require 'rom/initializer'
require 'rom/constants'
require 'rom/support/configurable'

module ROM
  # Plugin is a simple object used to store plugin configurations
  #
  # @private
  class Plugin
    extend Initializer
    include Configurable

    # @!attribute [r] name
    #   @return [Symbol] plugin name
    # @api private
    param :name

    # @!attribute [r] mod
    #   @return [Module] a module representing the plugin
    # @api private
    param :mod

    # @!attribute [r] type
    #   @return [Symbol] plugin type
    # @api private
    option :type

    # Apply this plugin to the target
    #
    # @param [Class,Object] target
    #
    # @api private
    def apply_to(target, **options)
      if mod.respond_to?(:apply)
        mod.apply(target, **options)
      elsif mod.respond_to?(:new)
        target.include(mod.new(**options))
      elsif target.is_a?(::Module)
        target.include(mod)
      end
    end
  end
end

Version data entries

10 entries across 10 versions & 1 rubygems

Version Path
rom-core-5.4.0 lib/rom/plugin.rb
rom-core-5.3.2 lib/rom/plugin.rb
rom-core-5.3.1 lib/rom/plugin.rb
rom-core-5.3.0 lib/rom/plugin.rb
rom-core-5.2.6 lib/rom/plugin.rb
rom-core-5.2.5 lib/rom/plugin.rb
rom-core-5.2.4 lib/rom/plugin.rb
rom-core-5.2.3 lib/rom/plugin.rb
rom-core-5.2.2 lib/rom/plugin.rb
rom-core-5.2.1 lib/rom/plugin.rb