aaronmallen/activeinteractor

View on GitHub
lib/active_interactor/config.rb

Summary

Maintainability
A
0 mins
Test Coverage
# frozen_string_literal: true

module ActiveInteractor
  # The ActiveInteractor configuration object
  #
  # @author Aaron Allen <hello@aaronmallen.me>
  # @since 1.0.0
  #
  # @!attribute [rw] logger
  #  The logger instance to use for logging.
  #
  #  @since 1.0.0
  #
  #  @return [Class] an instance of Logger.
  #
  # @!method initialize(options = {})
  #  Initialize a new instance of {Config}
  #
  #  @since 1.0.0
  #
  #  @param options [Hash{Symbol=>*}] the attributes to assign to {Config}
  #  @option options [Class] :logger (Logger.new(STDOUT)) the {Config#logger} attribute
  #  @return [Config] a new instance of {Config}
  class Config
    include ActiveInteractor::Configurable
    defaults logger: Logger.new($stdout)
  end

  # The ActiveInteractor configuration
  #
  # @since 0.1.0
  #
  # @return [Config] a {Config} instance
  def self.config
    @config ||= ActiveInteractor::Config.new
  end

  # Configure the ActiveInteractor gem
  #
  # @since 0.1.0
  #
  # @example Configure ActiveInteractor
  #   require 'active_interactor'
  #   ActiveInteractor.configure do |config|
  #     config.logger = ::Rails.logger
  #   end
  # @yield [#config]
  def self.configure
    yield config
  end

  # The logger instance to use for logging
  #
  # @since 0.1.0
  #
  # @return [Class] the {Config#logger #config#logger} instance
  def self.logger
    config.logger
  end
end