Class: Configatron::Store

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

Instance Method Summary collapse

Constructor Details

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

Takes an optional Hash of parameters



5
6
7
8
9
10
11
 
# File 'lib/gems/configatron-2.1.5/lib/configatron/store.rb', line 5

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:



93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/gems/configatron-2.1.5/lib/configatron/store.rb', line 93

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) || self.methods.include?(name.to_s)
    @_store[name] = parse_options(*args)
  elsif @_store.has_key?(sym)
    return @_store[sym]
  else
    store = Configatron::Store.new({}, sym, self)
    @_store[sym] = store
    return store
  end
end

Instance Method Details

#==(other) ⇒ Object

:nodoc:



107
108
109
 
# File 'lib/gems/configatron-2.1.5/lib/configatron/store.rb', line 107

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

#configure_from_hash(options) ⇒ Object

Allows for the configuration of the system via a Hash



50
51
52
 
# File 'lib/gems/configatron-2.1.5/lib/configatron/store.rb', line 50

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.



58
59
60
61
62
63
64
65
66
 
# File 'lib/gems/configatron-2.1.5/lib/configatron/store.rb', line 58

def configure_from_yaml(path, opts = {})
  begin
    yml = YAML.load(File.read(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.



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/gems/configatron-2.1.5/lib/configatron/store.rb', line 176

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 )
        v_cl = deep_clone( v, cloned )
        cl.instance_eval( "#{var} = v_cl" )
      end
      return cl
    end
  end
end

#inspect ⇒ Object 



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/gems/configatron-2.1.5/lib/configatron/store.rb', line 18

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 do |line|
        if line.match(/\n/)
          line.each 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

#nil? ⇒ Boolean

Returns true if there are no configuration parameters

Returns:

  • (Boolean) 


69
70
71
 
# File 'lib/gems/configatron-2.1.5/lib/configatron/store.rb', line 69

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.



113
114
115
 
# File 'lib/gems/configatron-2.1.5/lib/configatron/store.rb', line 113

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

#protect_all! ⇒ Object

Prevents all parameters from being reassigned.



118
119
120
121
122
123
124
125
 
# File 'lib/gems/configatron-2.1.5/lib/configatron/store.rb', line 118

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.



81
82
83
 
# File 'lib/gems/configatron-2.1.5/lib/configatron/store.rb', line 81

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.



75
76
77
 
# File 'lib/gems/configatron-2.1.5/lib/configatron/store.rb', line 75

def retrieve(name, default_value = nil)
  @_store[name.to_sym] || default_value
end

#set_default(name, default_value) ⇒ Object

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



87
88
89
90
91
 
# File 'lib/gems/configatron-2.1.5/lib/configatron/store.rb', line 87

def set_default(name, default_value)
  unless @_store[name.to_sym]
    @_store[name.to_sym] = parse_options(default_value)
  end
end

#to_hash ⇒ Object

Returns a Hash representing the configurations



14
15
16
 
# File 'lib/gems/configatron-2.1.5/lib/configatron/store.rb', line 14

def to_hash
  @_store
end

#unprotect(name) ⇒ Object

Removes the protection of a parameter.



128
129
130
 
# File 'lib/gems/configatron-2.1.5/lib/configatron/store.rb', line 128

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

#unprotect_all! ⇒ Object 



132
133
134
135
136
137
138
 
# File 'lib/gems/configatron-2.1.5/lib/configatron/store.rb', line 132

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