class Submarine::Configuration

Attributes

format_key[RW]

Acceptable accessors.

left_delimiter[RW]

Acceptable accessors.

right_delimiter[RW]

Acceptable accessors.

substitutions[RW]

Acceptable accessors.

Public Class Methods

defaults() click to toggle source

Configuration defaults.

# File lib/submarine/configuration.rb, line 17
def self.defaults
  {
    format_key:      :text, # The key representing the string to be formatted
    left_delimiter:  '[[',  # The left-side matching string, ie: '[[name]]'
    right_delimiter: ']]',  # The right-side matching string, ie: '[[name]]'
    substitutions:   {}     # Optional global default substitutions
  }
end
new(*attrs) click to toggle source

Constructs a new Configuration instance. Merges passed in options hash, sets instance variables.

# File lib/submarine/configuration.rb, line 9
def initialize *attrs
  options = attrs.empty? ? {} : attrs.first
  options = self.class.defaults.merge(options)
  set_instance_variables options
end

Public Instance Methods

reload!() click to toggle source

Reload the Configuration instance variables to defaults.

# File lib/submarine/configuration.rb, line 28
def reload!
  set_instance_variables(self.class.defaults)
end

Private Instance Methods

set_instance_variables(options) click to toggle source

Set the instance variables from passed in options hash.

# File lib/submarine/configuration.rb, line 36
def set_instance_variables options
  @format_key      = options[:format_key].to_sym
  @left_delimiter  = options[:left_delimiter].to_s
  @right_delimiter = options[:right_delimiter].to_s
  @substitutions   = options[:substitutions]
end