Module: Coradoc::Configurable

Included in:
Coradoc
Defined in:
lib/coradoc/configurable.rb

Overview

Global configuration system for Coradoc.

Provides centralized configuration management with support for:

  • Configuration files (.coradoc.yml)

  • Environment-specific settings

  • Per-module configuration merging

  • Validation of configuration values

Examples:

Basic configuration

Coradoc.configure do |config|
  config.default_format = :asciidoc
  config.cache.enabled = true
  config.cache.max_size = 1000
end

Environment-specific configuration

Coradoc.configure do |config|
  config.environment = ENV.fetch("RACK_ENV", "development")
  config.cache.enabled = config.production?
end

Loading from file

Coradoc::Configuration.load_file(".coradoc.yml")

Defined Under Namespace

Classes: CacheConfig, ConfigSection, Configuration, ConfigurationError, LoggingConfig, OutputConfig, ParserConfig, TransformerConfig

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.configuration ⇒ Configuration

Get current global configuration

Returns:



470
471
472
 
# File 'lib/coradoc/configurable.rb', line 470

def configuration
  @configuration ||= Configuration.new
end

Class Method Details

.configure {|Configuration| ... } ⇒ void

This method returns an undefined value.

Configure Coradoc

Yields:



484
485
486
 
# File 'lib/coradoc/configurable.rb', line 484

def configure
  yield configuration if block_given?
end

.load_configuration(path) ⇒ void

This method returns an undefined value.

Load configuration from file

Parameters:

  • path (String) —

    Path to configuration file



499
500
501
502
 
# File 'lib/coradoc/configurable.rb', line 499

def load_configuration(path)
  config = Configuration.load_file(path)
  configuration.merge!(config)
end

.reset_configuration! ⇒ void

This method returns an undefined value.

Reset configuration to defaults



491
492
493
 
# File 'lib/coradoc/configurable.rb', line 491

def reset_configuration!
  @configuration = Configuration.new
end