Class: Configature::Namespace

Inherits:
Object
  • Object
show all
Defined in:
lib/configature/namespace.rb

Constant Summary collapse

BOOLEAN_EQUIVALENT =

Constants ============================================================

begin
  h = {
    true => %w[ on yes 1 ],
    false => %w[ off no 0 ]
  }.flat_map do |k, a|
    a.map do |v|
      [ v, k ]
    end
  end.to_h

  -> (v) do
    b = h[v]

    b.nil? ? !!v : b
  end
end
RECAST_AS = 
{
  [ :array, Array ] => -> (v) { v.is_a?(Array) ? v : [ v ] },
  [ :string, String ] => :to_s.to_proc,
  [ :integer, Integer ] => :to_i.to_proc,
  [ :float, Float ] => :to_f.to_proc,
  [ :boolean ] => -> (v) { BOOLEAN_EQUIVALENT[v] },
  [ :date, Date ] => -> (v) { Date.parse(v) },
  [ :datetime, DateTime ] => -> (v) { DateTime.parse(v) },
  [ :time, Time ] => -> (v) { v.match?(/\A\d+\z/) ? Time.at(v.to_i) : Time.parse(v) }
}.flat_map do |a, v|
  a.map do |k|
    [ k, v ]
  end
end.to_h.freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name = nil, env_name_prefix: '', env_suffix: '', extends: nil) {|_self| ... } ⇒ Namespace

Instance Methods =====================================================

Yields:

  • (_self)

Yield Parameters:



52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/configature/namespace.rb', line 52

def initialize(name = nil, env_name_prefix: '', env_suffix: '', extends: nil)
  @name = name&.to_sym
  @extends = extends
  @env = extends&.instance_variable_get(:@env)
  @env_default = extends&.instance_variable_get(:@env_default)
  @namespaces = extends&.namespaces&.dup || { }
  @parameters = extends&.parameters&.dup || { }
  @env_suffix = env_suffix
  @env_name_prefix = name ? Configature::Support.extend_env_prefix(env_name_prefix, name) : ''

  @config_name = extends&.config_name || name

  yield(self) if (block_given?)
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(name, **options) ⇒ Object 



122
123
124
 
# File 'lib/configature/namespace.rb', line 122

def method_missing(name, **options)
  parameter(name, **options)
end

Instance Attribute Details

#config_name ⇒ Object (readonly)

Returns the value of attribute config_name.



43
44
45
 
# File 'lib/configature/namespace.rb', line 43

def config_name
  @config_name
end

#env_name_prefix ⇒ Object (readonly)

Returns the value of attribute env_name_prefix.



44
45
46
 
# File 'lib/configature/namespace.rb', line 44

def env_name_prefix
  @env_name_prefix
end

#name ⇒ Object (readonly)

Properties ===========================================================



42
43
44
 
# File 'lib/configature/namespace.rb', line 42

def name
  @name
end

#namespaces ⇒ Object (readonly)

Returns the value of attribute namespaces.



45
46
47
 
# File 'lib/configature/namespace.rb', line 45

def namespaces
  @namespaces
end

#parameters ⇒ Object (readonly)

Returns the value of attribute parameters.



46
47
48
 
# File 'lib/configature/namespace.rb', line 46

def parameters
  @parameters
end

Instance Method Details

#[](name) ⇒ Object 



118
119
120
 
# File 'lib/configature/namespace.rb', line 118

def [](name)
  @parameters[name] or @namespaces[name]
end

#__instantiate(source: nil, env: ENV) ⇒ Object 



126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/configature/namespace.rb', line 126

def __instantiate(source: nil, env: ENV)
  if (@env and source)
    env_key = @env.map { |e| env[e] }.first || @env_default

    if (@env_suffix)
      env_key += @env_suffix
    end

    source = source[env_key] || source[env_key.to_sym]
  end

  self.__instantiate_branch(source: source, env: env)
end

#__instantiate_branch(source: nil, env: nil) ⇒ Object 



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/configature/namespace.rb', line 140

def __instantiate_branch(source: nil, env: nil)
  Configature::Data.new(
    @parameters.values.map do |param|
      name = param[:name]
      name_s = name.to_s
      name_sym = name_s.to_sym

      value = (param[:env] && env && env[param[:env]]) ||
        source && (source[name_s] || source[name_sym])

      case (remap = param[:remap])
      when Hash, Proc
        value = remap[value] || value
      end

      if (!value.nil? and as = param[:as])
        value = as[value]
      end

      [ param[:name], value.nil? ? param[:default].call : value ]
    end.to_h.merge(
      @namespaces.map do |name, namespace|
        [
          name,
          namespace.__instantiate_branch(
            source: source && (source[name] || source[name.to_s]),
            env: env
          )
        ]
      end.to_h
    )
  )
end

#env(*names, default: 'development') ⇒ Object 



87
88
89
90
 
# File 'lib/configature/namespace.rb', line 87

def env(*names, default: 'development')
  @env = names.map(&:to_s).freeze
  @env_default = default
end

#namespace(name, env_suffix: '', extends: nil, &block) ⇒ Object 



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/configature/namespace.rb', line 67

def namespace(name, env_suffix: '', extends: nil, &block)
  name = name.to_sym

  @namespaces[name] = self.class.new(
    name,
    env_suffix: env_suffix,
    extends: extends && self.namespaces[extends],
    env_name_prefix: @env_name_prefix
  ).tap do |n|
    case (block&.arity)
    when nil
      nil
    when 1
      block[n]
    else
      n.instance_eval(&block)
    end
  end
end

#parameter(parameter_name, default: nil, as: nil, name: nil, env: nil, remap: nil) ⇒ Object 



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/configature/namespace.rb', line 92

def parameter(parameter_name, default: nil, as: nil, name: nil, env: nil, remap: nil)
  name ||= parameter_name
  as ||= default.is_a?(Array) ? :array : :string

  case (as)
  when Class, Symbol
    as = RECAST_AS[as]
  end

  @parameters[name] = {
    name: name,
    default: default.is_a?(Proc) ? default : -> { default },
    as: as,
    remap: remap,
    env:
      case (env)
      when false
        false
      when nil
        Configature::Support.extend_env_prefix(@env_name_prefix, name)
      else
        env
      end
  }
end