Module: Metanorma::Config

Included in:

Metanorma

Defined in:

lib/metanorma/config/config.rb

Overview

Configuration mixin for the Metanorma module. Provides the Metanorma.configure block-based setup pattern and the Metanorma.configuration accessor for read access.

Examples:

Metanorma.configure do |c|
  c.logs = %i[error fatal]
end

Instance Method Summary

• #configuration ⇒ Metanorma::Configuration

  Lazily-instantiated singleton Configuration for the Metanorma module.

• #configure {|the| ... } ⇒ Metanorma::Configuration^?

  Yield the singleton Configuration for in-place mutation, e.g.

Instance Method Details

#configuration ⇒ Metanorma::Configuration

Lazily-instantiated singleton Metanorma::Configuration for the Metanorma module.

Returns:

• (Metanorma::Configuration)

# File 'lib/metanorma/config/config.rb', line 28

def configuration
  @configuration ||= Configuration.new
end

#configure {|the| ... } ⇒ Metanorma::Configuration^?

Yield the singleton Metanorma::Configuration for in-place mutation, e.g. flipping which log severities are printed.

Yield Parameters:

• the (Metanorma::Configuration) —

  singleton config.

Returns:

• (Metanorma::Configuration, nil) —

  the config if no block was given (preserving the original semantics), otherwise the block’s return value.

# File 'lib/metanorma/config/config.rb', line 18

def configure
  if block_given?
    yield configuration
  end
end