Class: Configatron::Store

Inherits:
Object show all
Defined in:
lib/configatron/store.rb

Instance Method Summary collapse

Constructor Details

#initialize(options = {}, name = nil, parent = nil) ⇒ Store

Takes an optional Hash of parameters



6
7
8
9
10
11
12
 
# File 'lib/configatron/store.rb', line 6

def initialize(options = {}, name = nil, parent = nil)
  @_name = name
  @_parent = parent
  @_store = {}
  configure_from_hash(options)
  @_protected = []
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(sym, *args) ⇒ Object

:nodoc:



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/configatron/store.rb', line 127

def method_missing(sym, *args) # :nodoc:
  if sym.to_s.match(/(.+)=$/)
    name = sym.to_s.gsub("=", '').to_sym
    raise Configatron::ProtectedParameter.new(name) if @_protected.include?(name) || methods_include?(name)
    raise Configatron::LockedNamespace.new(@_name) if @_locked && !@_store.has_key?(name)
    @_store[name] = parse_options(*args)
  elsif @_store.has_key?(sym)
    val = @_store[sym]
    if val.is_a?(Configatron::Proc)
      res = val.execute
      if val.finalize?
        @_store[sym] = res
      end
      return res
    end
    return val
  else
    store = Configatron::Store.new({}, sym, self)
    @_store[sym] = store
    return store
  end
end

Instance Method Details

#==(other) ⇒ Object

:nodoc:



150
151
152
 
# File 'lib/configatron/store.rb', line 150

def ==(other) # :nodoc:
  self.to_hash == other
end

#configatron_keys ⇒ Object 



36
37
38
 
# File 'lib/configatron/store.rb', line 36

def configatron_keys
  return @_store.keys.collect{|k| k.to_s}.sort
end

#configure_from_hash(options) ⇒ Object

Allows for the configuration of the system via a Hash



82
83
84
 
# File 'lib/configatron/store.rb', line 82

def configure_from_hash(options)
  parse_options(options)
end

#configure_from_yaml(path, opts = {}) ⇒ Object

Allows for the configuration of the system from a YAML file. Takes the path to the YAML file. Also takes an optional parameter, :hash, that indicates a specific hash that should be loaded from the file.



90
91
92
93
94
95
96
97
98
 
# File 'lib/configatron/store.rb', line 90

def configure_from_yaml(path, opts = {})
  begin
    yml = ::Yamler.load(path)
    yml = yml[opts[:hash]] unless opts[:hash].nil?
    configure_from_hash(yml)
  rescue Errno::ENOENT => e
    puts e.message
  end
end

#deep_clone(obj = self, cloned = {}) ⇒ Object

DeepClone

Version

1.2006.05.23 (change of the first number means Big Change)

Description

Adds deep_clone method to an object which produces deep copy of it. It means
if you clone a Hash, every nested items and their nested items will be cloned.
Moreover deep_clone checks if the object is already cloned to prevent endless recursion.

Usage

(see examples directory under the ruby gems root directory)

 require 'rubygems'
 require 'deep_clone'

 include DeepClone

 obj = []
 a = [ true, false, obj ]
 b = a.deep_clone
 obj.push( 'foo' )
 p obj   # >> [ 'foo' ]
 p b[2]  # >> []

Source

simplypowerful.1984.cz/goodlibs/1.2006.05.23

Author

jan molic (/mig/at_sign/1984/dot/cz/)

Licence

You can redistribute it and/or modify it under the same terms of Ruby's license;
either the dual license version in 2003, or any later version.



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/configatron/store.rb', line 233

def deep_clone( obj=self, cloned={} )
  if cloned.has_key?( obj.object_id )
    return cloned[obj.object_id]
  else
    begin
      cl = obj.clone
    rescue Exception
      # unclonnable (TrueClass, Fixnum, ...)
      cloned[obj.object_id] = obj
      return obj
    else
      cloned[obj.object_id] = cl
      cloned[cl.object_id] = cl
      if cl.is_a?( Hash )
        cl.clone.each { |k,v|
          cl[k] = deep_clone( v, cloned )
        }
      elsif cl.is_a?( Array )
        cl.collect! { |v|
          deep_clone( v, cloned )
        }
      end
      cl.instance_variables.each do |var|
        v = cl.instance_eval( var.to_s )
        v_cl = deep_clone( v, cloned )
        cl.instance_eval( "#{var} = v_cl" )
      end
      return cl
    end
  end
end

#exists?(name) ⇒ Boolean

Checks whether or not a parameter exists

Examples:

configatron.i.am.alive = 'alive!'
configatron.i.am.exists?(:alive) # => true
configatron.i.am.exists?(:dead) # => false

Returns:

  • (Boolean) 


46
47
48
 
# File 'lib/configatron/store.rb', line 46

def exists?(name)
  @_store.has_key?(name.to_sym) || @_store.has_key?(name.to_s)
end

#heirarchy ⇒ Object 



24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/configatron/store.rb', line 24

def heirarchy
  path = [@_name]
  parent = @_parent
  until parent.nil?
    path << parent.instance_variable_get('@_name')
    parent = parent.instance_variable_get('@_parent')
  end
  path.compact!
  path.reverse!
  path.join('.')
end

#inspect ⇒ Object 



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/configatron/store.rb', line 50

def inspect
  path = [@_name]
  parent = @_parent
  until parent.nil?
    path << parent.instance_variable_get('@_name')
    parent = parent.instance_variable_get('@_parent')
  end
  path << 'configatron'
  path.compact!
  path.reverse!
  f_out = []
  @_store.each do |k, v|
    if v.is_a?(Configatron::Store)
      v.inspect.each_line do |line|
        if line.match(/\n/)
          line.each_line do |l|
            l.strip!
            f_out << l
          end
        else
          line.strip!
          f_out << line
        end
      end
    else
      f_out << "#{path.join('.')}.#{k} = #{v.inspect}"
    end
  end
  f_out.compact.sort.join("\n")
end

#lock(name) ⇒ Object

Prevents a namespace from having new parameters set. The lock is applied recursively to any namespaces below it.

Raises:

  • (ArgumentError) 


185
186
187
188
189
 
# File 'lib/configatron/store.rb', line 185

def lock(name)
  namespace = @_store[name.to_sym]
  raise ArgumentError, "Namespace #{name.inspect} does not exist" if namespace.nil?
  namespace.lock!
end

#nil? ⇒ Boolean

Returns true if there are no configuration parameters

Returns:

  • (Boolean) 


101
102
103
 
# File 'lib/configatron/store.rb', line 101

def nil?
  return @_store.empty?
end

#protect(name) ⇒ Object

Prevents a parameter from being reassigned. If called on a ‘namespace’ then all parameters below it will be protected as well.



156
157
158
 
# File 'lib/configatron/store.rb', line 156

def protect(name)
  @_protected << name.to_sym
end

#protect_all! ⇒ Object

Prevents all parameters from being reassigned.



161
162
163
164
165
166
167
168
 
# File 'lib/configatron/store.rb', line 161

def protect_all!
  @_protected.clear
  @_store.keys.each do |k|
    val = self.send(k)
    val.protect_all! if val.class == Configatron::Store
    @_protected << k
  end
end

#remove(name) ⇒ Object

Removes a parameter. In the case of a nested parameter it will remove all below it.



114
115
116
 
# File 'lib/configatron/store.rb', line 114

def remove(name)
  @_store.delete(name.to_sym)
end

#retrieve(name, default_value = nil) ⇒ Object

Retrieves a certain parameter and if that parameter doesn’t exist it will return the default_value specified.



107
108
109
110
 
# File 'lib/configatron/store.rb', line 107

def retrieve(name, default_value = nil)
  val = method_missing(name.to_sym)
  return val.is_a?(Configatron::Store) ? default_value : val
end

#set_default(name, default_value) ⇒ Object

Sets a ‘default’ value. If there is already a value specified it won’t set the value.



120
121
122
123
124
125
 
# File 'lib/configatron/store.rb', line 120

def set_default(name, default_value)
  unless @_store[name.to_sym]
    # @_store[name.to_sym] = parse_options(default_value)
    self.send("#{name}=", default_value)
  end
end

#to_hash ⇒ Object

Returns a Hash representing the configurations



15
16
17
18
19
20
21
22
 
# File 'lib/configatron/store.rb', line 15

def to_hash
  h = Hash.new
  @_store.each { |k,v|
    # Descend the tree and hashify each node
    h[k] = v.is_a?(Store) ? v.to_hash : v
  }
  h 
end

#unlock(name) ⇒ Object

Raises:

  • (ArgumentError) 


191
192
193
194
195
 
# File 'lib/configatron/store.rb', line 191

def unlock(name)
  namespace = @_store[name.to_sym]
  raise ArgumentError, "Namespace #{name.inspect} does not exist" if namespace.nil?
  namespace.unlock!
end

#unprotect(name) ⇒ Object

Removes the protection of a parameter.



171
172
173
 
# File 'lib/configatron/store.rb', line 171

def unprotect(name)
  @_protected.reject! { |e| e == name.to_sym }
end

#unprotect_all! ⇒ Object 



175
176
177
178
179
180
181
 
# File 'lib/configatron/store.rb', line 175

def unprotect_all!
  @_protected.clear
  @_store.keys.each do |k|
    val = self.send(k)
    val.unprotect_all! if val.class == Configatron::Store
  end
end