configatron 2.2.1 → 2.2.2
Sign up to get free protection for your applications and to get access to all the features.
- data/doc/classes/Class.html +170 -0
- data/doc/classes/Configatron.html +30 -30
- data/doc/classes/Configatron/LockedNamespace.html +6 -6
- data/doc/classes/Configatron/ProtectedParameter.html +6 -6
- data/doc/classes/Configatron/Store.html +111 -111
- data/doc/classes/Kernel.html +9 -9
- data/doc/created.rid +1 -1
- data/doc/files/lib/configatron/core_ext/class_rb.html +101 -0
- data/doc/files/lib/configatron/{kernel_rb.html → core_ext/kernel_rb.html} +2 -2
- data/doc/files/lib/configatron/core_ext/object_rb.html +101 -0
- data/doc/files/lib/configatron/core_ext/string_rb.html +101 -0
- data/doc/files/lib/configatron_rb.html +1 -1
- data/doc/fr_class_index.html +1 -0
- data/doc/fr_file_index.html +4 -1
- data/doc/fr_method_index.html +27 -26
- data/lib/configatron.rb +5 -2
- data/lib/configatron/core_ext/class.rb +26 -0
- data/lib/configatron/{kernel.rb → core_ext/kernel.rb} +0 -0
- data/lib/configatron/core_ext/object.rb +9 -0
- data/lib/configatron/core_ext/string.rb +84 -0
- data/spec/lib/class_spec.rb +28 -0
- metadata +12 -4
@@ -0,0 +1,170 @@
|
|
1
|
+
<?xml version="1.0" encoding="iso-8859-1"?>
|
2
|
+
<!DOCTYPE html
|
3
|
+
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
4
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
5
|
+
|
6
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
7
|
+
<head>
|
8
|
+
<title>Class: Class</title>
|
9
|
+
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
10
|
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
11
|
+
<link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
|
12
|
+
<script type="text/javascript">
|
13
|
+
// <![CDATA[
|
14
|
+
|
15
|
+
function popupCode( url ) {
|
16
|
+
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
|
17
|
+
}
|
18
|
+
|
19
|
+
function toggleCode( id ) {
|
20
|
+
if ( document.getElementById )
|
21
|
+
elem = document.getElementById( id );
|
22
|
+
else if ( document.all )
|
23
|
+
elem = eval( "document.all." + id );
|
24
|
+
else
|
25
|
+
return false;
|
26
|
+
|
27
|
+
elemStyle = elem.style;
|
28
|
+
|
29
|
+
if ( elemStyle.display != "block" ) {
|
30
|
+
elemStyle.display = "block"
|
31
|
+
} else {
|
32
|
+
elemStyle.display = "none"
|
33
|
+
}
|
34
|
+
|
35
|
+
return true;
|
36
|
+
}
|
37
|
+
|
38
|
+
// Make codeblocks hidden by default
|
39
|
+
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
|
40
|
+
|
41
|
+
// ]]>
|
42
|
+
</script>
|
43
|
+
|
44
|
+
</head>
|
45
|
+
<body>
|
46
|
+
|
47
|
+
|
48
|
+
|
49
|
+
<div id="classHeader">
|
50
|
+
<table class="header-table">
|
51
|
+
<tr class="top-aligned-row">
|
52
|
+
<td><strong>Class</strong></td>
|
53
|
+
<td class="class-name-in-header">Class</td>
|
54
|
+
</tr>
|
55
|
+
<tr class="top-aligned-row">
|
56
|
+
<td><strong>In:</strong></td>
|
57
|
+
<td>
|
58
|
+
<a href="../files/lib/configatron/core_ext/class_rb.html">
|
59
|
+
lib/configatron/core_ext/class.rb
|
60
|
+
</a>
|
61
|
+
<br />
|
62
|
+
</td>
|
63
|
+
</tr>
|
64
|
+
|
65
|
+
<tr class="top-aligned-row">
|
66
|
+
<td><strong>Parent:</strong></td>
|
67
|
+
<td>
|
68
|
+
Object
|
69
|
+
</td>
|
70
|
+
</tr>
|
71
|
+
</table>
|
72
|
+
</div>
|
73
|
+
<!-- banner header -->
|
74
|
+
|
75
|
+
<div id="bodyContent">
|
76
|
+
|
77
|
+
|
78
|
+
|
79
|
+
<div id="contextContent">
|
80
|
+
|
81
|
+
|
82
|
+
|
83
|
+
</div>
|
84
|
+
|
85
|
+
<div id="method-list">
|
86
|
+
<h3 class="section-bar">Methods</h3>
|
87
|
+
|
88
|
+
<div class="name-list">
|
89
|
+
<a href="#M000001">to_configatron</a>
|
90
|
+
</div>
|
91
|
+
</div>
|
92
|
+
|
93
|
+
</div>
|
94
|
+
|
95
|
+
|
96
|
+
<!-- if includes -->
|
97
|
+
|
98
|
+
<div id="section">
|
99
|
+
|
100
|
+
|
101
|
+
|
102
|
+
|
103
|
+
|
104
|
+
|
105
|
+
|
106
|
+
|
107
|
+
<!-- if method_list -->
|
108
|
+
<div id="methods">
|
109
|
+
<h3 class="section-bar">Public Instance methods</h3>
|
110
|
+
|
111
|
+
<div id="method-M000001" class="method-detail">
|
112
|
+
<a name="M000001"></a>
|
113
|
+
|
114
|
+
<div class="method-heading">
|
115
|
+
<a href="#M000001" class="method-signature">
|
116
|
+
<span class="method-name">to_configatron</span><span class="method-args">()</span>
|
117
|
+
</a>
|
118
|
+
</div>
|
119
|
+
|
120
|
+
<div class="method-description">
|
121
|
+
<p>
|
122
|
+
Returns access to configuration parameters named after the class.
|
123
|
+
</p>
|
124
|
+
<p>
|
125
|
+
Examples:
|
126
|
+
</p>
|
127
|
+
<pre>
|
128
|
+
configatron.foo.bar = :bar
|
129
|
+
configatron.a.b.c.d = 'D'
|
130
|
+
|
131
|
+
class Foo
|
132
|
+
end
|
133
|
+
|
134
|
+
module A
|
135
|
+
module B
|
136
|
+
class C
|
137
|
+
end
|
138
|
+
end
|
139
|
+
end
|
140
|
+
|
141
|
+
Foo.to_configatron.bar # => :bar
|
142
|
+
A::B::C.to_configatron.d # => 'D'
|
143
|
+
</pre>
|
144
|
+
<p><a class="source-toggle" href="#"
|
145
|
+
onclick="toggleCode('M000001-source');return false;">[Source]</a></p>
|
146
|
+
<div class="method-source-code" id="M000001-source">
|
147
|
+
<pre>
|
148
|
+
<span class="ruby-comment cmt"># File lib/configatron/core_ext/class.rb, line 21</span>
|
149
|
+
21: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_configatron</span>
|
150
|
+
22: <span class="ruby-identifier">name_spaces</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">name</span>.<span class="ruby-identifier">split</span>(<span class="ruby-value str">"::"</span>).<span class="ruby-identifier">collect</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span> <span class="ruby-identifier">s</span>.<span class="ruby-identifier">methodize</span>}
|
151
|
+
23: <span class="ruby-identifier">configatron</span>.<span class="ruby-identifier">send_with_chain</span>(<span class="ruby-identifier">name_spaces</span>)
|
152
|
+
24: <span class="ruby-keyword kw">end</span>
|
153
|
+
</pre>
|
154
|
+
</div>
|
155
|
+
</div>
|
156
|
+
</div>
|
157
|
+
|
158
|
+
|
159
|
+
</div>
|
160
|
+
|
161
|
+
|
162
|
+
</div>
|
163
|
+
|
164
|
+
|
165
|
+
<div id="validator-badges">
|
166
|
+
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
|
167
|
+
</div>
|
168
|
+
|
169
|
+
</body>
|
170
|
+
</html>
|
@@ -94,11 +94,11 @@
|
|
94
94
|
<h3 class="section-bar">Methods</h3>
|
95
95
|
|
96
96
|
<div class="name-list">
|
97
|
-
<a href="#
|
98
|
-
<a href="#
|
99
|
-
<a href="#
|
100
|
-
<a href="#
|
101
|
-
<a href="#
|
97
|
+
<a href="#M000002">method_missing</a>
|
98
|
+
<a href="#M000003">reset!</a>
|
99
|
+
<a href="#M000004">temp</a>
|
100
|
+
<a href="#M000006">temp_end</a>
|
101
|
+
<a href="#M000005">temp_start</a>
|
102
102
|
</div>
|
103
103
|
</div>
|
104
104
|
|
@@ -148,11 +148,11 @@ Class <a href="Configatron/Store.html" class="link">Configatron::Store</a><br />
|
|
148
148
|
<div id="methods">
|
149
149
|
<h3 class="section-bar">Public Instance methods</h3>
|
150
150
|
|
151
|
-
<div id="method-
|
152
|
-
<a name="
|
151
|
+
<div id="method-M000002" class="method-detail">
|
152
|
+
<a name="M000002"></a>
|
153
153
|
|
154
154
|
<div class="method-heading">
|
155
|
-
<a href="#
|
155
|
+
<a href="#M000002" class="method-signature">
|
156
156
|
<span class="method-name">method_missing</span><span class="method-args">(sym, *args)</span>
|
157
157
|
</a>
|
158
158
|
</div>
|
@@ -163,8 +163,8 @@ Forwards the method call onto the ‘namespaced’ <a
|
|
163
163
|
href="Configatron/Store.html">Configatron::Store</a>
|
164
164
|
</p>
|
165
165
|
<p><a class="source-toggle" href="#"
|
166
|
-
onclick="toggleCode('
|
167
|
-
<div class="method-source-code" id="
|
166
|
+
onclick="toggleCode('M000002-source');return false;">[Source]</a></p>
|
167
|
+
<div class="method-source-code" id="M000002-source">
|
168
168
|
<pre>
|
169
169
|
<span class="ruby-comment cmt"># File lib/configatron/configatron.rb, line 14</span>
|
170
170
|
14: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">method_missing</span>(<span class="ruby-identifier">sym</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
|
@@ -175,11 +175,11 @@ href="Configatron/Store.html">Configatron::Store</a>
|
|
175
175
|
</div>
|
176
176
|
</div>
|
177
177
|
|
178
|
-
<div id="method-
|
179
|
-
<a name="
|
178
|
+
<div id="method-M000003" class="method-detail">
|
179
|
+
<a name="M000003"></a>
|
180
180
|
|
181
181
|
<div class="method-heading">
|
182
|
-
<a href="#
|
182
|
+
<a href="#M000003" class="method-signature">
|
183
183
|
<span class="method-name">reset!</span><span class="method-args">()</span>
|
184
184
|
</a>
|
185
185
|
</div>
|
@@ -189,8 +189,8 @@ href="Configatron/Store.html">Configatron::Store</a>
|
|
189
189
|
Removes ALL configuration parameters
|
190
190
|
</p>
|
191
191
|
<p><a class="source-toggle" href="#"
|
192
|
-
onclick="toggleCode('
|
193
|
-
<div class="method-source-code" id="
|
192
|
+
onclick="toggleCode('M000003-source');return false;">[Source]</a></p>
|
193
|
+
<div class="method-source-code" id="M000003-source">
|
194
194
|
<pre>
|
195
195
|
<span class="ruby-comment cmt"># File lib/configatron/configatron.rb, line 19</span>
|
196
196
|
19: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">reset!</span>
|
@@ -201,11 +201,11 @@ Removes ALL configuration parameters
|
|
201
201
|
</div>
|
202
202
|
</div>
|
203
203
|
|
204
|
-
<div id="method-
|
205
|
-
<a name="
|
204
|
+
<div id="method-M000004" class="method-detail">
|
205
|
+
<a name="M000004"></a>
|
206
206
|
|
207
207
|
<div class="method-heading">
|
208
|
-
<a href="#
|
208
|
+
<a href="#M000004" class="method-signature">
|
209
209
|
<span class="method-name">temp</span><span class="method-args">(options = nil) {|| ...}</span>
|
210
210
|
</a>
|
211
211
|
</div>
|
@@ -218,8 +218,8 @@ called. At the end of the block, the temporary settings are deleted and the
|
|
218
218
|
original settings are reinstated.
|
219
219
|
</p>
|
220
220
|
<p><a class="source-toggle" href="#"
|
221
|
-
onclick="toggleCode('
|
222
|
-
<div class="method-source-code" id="
|
221
|
+
onclick="toggleCode('M000004-source');return false;">[Source]</a></p>
|
222
|
+
<div class="method-source-code" id="M000004-source">
|
223
223
|
<pre>
|
224
224
|
<span class="ruby-comment cmt"># File lib/configatron/configatron.rb, line 27</span>
|
225
225
|
27: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">temp</span>(<span class="ruby-identifier">options</span> = <span class="ruby-keyword kw">nil</span>)
|
@@ -237,19 +237,19 @@ original settings are reinstated.
|
|
237
237
|
</div>
|
238
238
|
</div>
|
239
239
|
|
240
|
-
<div id="method-
|
241
|
-
<a name="
|
240
|
+
<div id="method-M000006" class="method-detail">
|
241
|
+
<a name="M000006"></a>
|
242
242
|
|
243
243
|
<div class="method-heading">
|
244
|
-
<a href="#
|
244
|
+
<a href="#M000006" class="method-signature">
|
245
245
|
<span class="method-name">temp_end</span><span class="method-args">()</span>
|
246
246
|
</a>
|
247
247
|
</div>
|
248
248
|
|
249
249
|
<div class="method-description">
|
250
250
|
<p><a class="source-toggle" href="#"
|
251
|
-
onclick="toggleCode('
|
252
|
-
<div class="method-source-code" id="
|
251
|
+
onclick="toggleCode('M000006-source');return false;">[Source]</a></p>
|
252
|
+
<div class="method-source-code" id="M000006-source">
|
253
253
|
<pre>
|
254
254
|
<span class="ruby-comment cmt"># File lib/configatron/configatron.rb, line 47</span>
|
255
255
|
47: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">temp_end</span>
|
@@ -260,19 +260,19 @@ original settings are reinstated.
|
|
260
260
|
</div>
|
261
261
|
</div>
|
262
262
|
|
263
|
-
<div id="method-
|
264
|
-
<a name="
|
263
|
+
<div id="method-M000005" class="method-detail">
|
264
|
+
<a name="M000005"></a>
|
265
265
|
|
266
266
|
<div class="method-heading">
|
267
|
-
<a href="#
|
267
|
+
<a href="#M000005" class="method-signature">
|
268
268
|
<span class="method-name">temp_start</span><span class="method-args">(options = nil)</span>
|
269
269
|
</a>
|
270
270
|
</div>
|
271
271
|
|
272
272
|
<div class="method-description">
|
273
273
|
<p><a class="source-toggle" href="#"
|
274
|
-
onclick="toggleCode('
|
275
|
-
<div class="method-source-code" id="
|
274
|
+
onclick="toggleCode('M000005-source');return false;">[Source]</a></p>
|
275
|
+
<div class="method-source-code" id="M000005-source">
|
276
276
|
<pre>
|
277
277
|
<span class="ruby-comment cmt"># File lib/configatron/configatron.rb, line 38</span>
|
278
278
|
38: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">temp_start</span>(<span class="ruby-identifier">options</span> = <span class="ruby-keyword kw">nil</span>)
|
@@ -86,7 +86,7 @@
|
|
86
86
|
<h3 class="section-bar">Methods</h3>
|
87
87
|
|
88
88
|
<div class="name-list">
|
89
|
-
<a href="#
|
89
|
+
<a href="#M000025">new</a>
|
90
90
|
</div>
|
91
91
|
</div>
|
92
92
|
|
@@ -108,19 +108,19 @@
|
|
108
108
|
<div id="methods">
|
109
109
|
<h3 class="section-bar">Public Class methods</h3>
|
110
110
|
|
111
|
-
<div id="method-
|
112
|
-
<a name="
|
111
|
+
<div id="method-M000025" class="method-detail">
|
112
|
+
<a name="M000025"></a>
|
113
113
|
|
114
114
|
<div class="method-heading">
|
115
|
-
<a href="#
|
115
|
+
<a href="#M000025" class="method-signature">
|
116
116
|
<span class="method-name">new</span><span class="method-args">(name)</span>
|
117
117
|
</a>
|
118
118
|
</div>
|
119
119
|
|
120
120
|
<div class="method-description">
|
121
121
|
<p><a class="source-toggle" href="#"
|
122
|
-
onclick="toggleCode('
|
123
|
-
<div class="method-source-code" id="
|
122
|
+
onclick="toggleCode('M000025-source');return false;">[Source]</a></p>
|
123
|
+
<div class="method-source-code" id="M000025-source">
|
124
124
|
<pre>
|
125
125
|
<span class="ruby-comment cmt"># File lib/configatron/errors.rb, line 9</span>
|
126
126
|
9: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">name</span>)
|
@@ -86,7 +86,7 @@
|
|
86
86
|
<h3 class="section-bar">Methods</h3>
|
87
87
|
|
88
88
|
<div class="name-list">
|
89
|
-
<a href="#
|
89
|
+
<a href="#M000026">intialize</a>
|
90
90
|
</div>
|
91
91
|
</div>
|
92
92
|
|
@@ -108,19 +108,19 @@
|
|
108
108
|
<div id="methods">
|
109
109
|
<h3 class="section-bar">Public Instance methods</h3>
|
110
110
|
|
111
|
-
<div id="method-
|
112
|
-
<a name="
|
111
|
+
<div id="method-M000026" class="method-detail">
|
112
|
+
<a name="M000026"></a>
|
113
113
|
|
114
114
|
<div class="method-heading">
|
115
|
-
<a href="#
|
115
|
+
<a href="#M000026" class="method-signature">
|
116
116
|
<span class="method-name">intialize</span><span class="method-args">(name)</span>
|
117
117
|
</a>
|
118
118
|
</div>
|
119
119
|
|
120
120
|
<div class="method-description">
|
121
121
|
<p><a class="source-toggle" href="#"
|
122
|
-
onclick="toggleCode('
|
123
|
-
<div class="method-source-code" id="
|
122
|
+
onclick="toggleCode('M000026-source');return false;">[Source]</a></p>
|
123
|
+
<div class="method-source-code" id="M000026-source">
|
124
124
|
<pre>
|
125
125
|
<span class="ruby-comment cmt"># File lib/configatron/errors.rb, line 3</span>
|
126
126
|
3: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">intialize</span>(<span class="ruby-identifier">name</span>)
|
@@ -86,24 +86,24 @@
|
|
86
86
|
<h3 class="section-bar">Methods</h3>
|
87
87
|
|
88
88
|
<div class="name-list">
|
89
|
-
<a href="#
|
90
|
-
<a href="#
|
91
|
-
<a href="#
|
92
|
-
<a href="#
|
93
|
-
<a href="#
|
94
|
-
<a href="#
|
95
|
-
<a href="#
|
96
|
-
<a href="#
|
97
|
-
<a href="#
|
98
|
-
<a href="#
|
99
|
-
<a href="#
|
100
|
-
<a href="#
|
101
|
-
<a href="#
|
102
|
-
<a href="#
|
103
|
-
<a href="#
|
104
|
-
<a href="#
|
105
|
-
<a href="#
|
106
|
-
<a href="#
|
89
|
+
<a href="#M000010">configure_from_hash</a>
|
90
|
+
<a href="#M000011">configure_from_yaml</a>
|
91
|
+
<a href="#M000022">deep_clone</a>
|
92
|
+
<a href="#M000009">inspect</a>
|
93
|
+
<a href="#M000020">lock</a>
|
94
|
+
<a href="#M000023">lock!</a>
|
95
|
+
<a href="#M000007">new</a>
|
96
|
+
<a href="#M000012">nil?</a>
|
97
|
+
<a href="#M000016">protect</a>
|
98
|
+
<a href="#M000017">protect_all!</a>
|
99
|
+
<a href="#M000014">remove</a>
|
100
|
+
<a href="#M000013">retrieve</a>
|
101
|
+
<a href="#M000015">set_default</a>
|
102
|
+
<a href="#M000008">to_hash</a>
|
103
|
+
<a href="#M000021">unlock</a>
|
104
|
+
<a href="#M000024">unlock!</a>
|
105
|
+
<a href="#M000018">unprotect</a>
|
106
|
+
<a href="#M000019">unprotect_all!</a>
|
107
107
|
</div>
|
108
108
|
</div>
|
109
109
|
|
@@ -138,11 +138,11 @@
|
|
138
138
|
<div id="methods">
|
139
139
|
<h3 class="section-bar">Public Class methods</h3>
|
140
140
|
|
141
|
-
<div id="method-
|
142
|
-
<a name="
|
141
|
+
<div id="method-M000007" class="method-detail">
|
142
|
+
<a name="M000007"></a>
|
143
143
|
|
144
144
|
<div class="method-heading">
|
145
|
-
<a href="#
|
145
|
+
<a href="#M000007" class="method-signature">
|
146
146
|
<span class="method-name">new</span><span class="method-args">(options = {}, name = nil, parent = nil)</span>
|
147
147
|
</a>
|
148
148
|
</div>
|
@@ -152,8 +152,8 @@
|
|
152
152
|
Takes an optional Hash of parameters
|
153
153
|
</p>
|
154
154
|
<p><a class="source-toggle" href="#"
|
155
|
-
onclick="toggleCode('
|
156
|
-
<div class="method-source-code" id="
|
155
|
+
onclick="toggleCode('M000007-source');return false;">[Source]</a></p>
|
156
|
+
<div class="method-source-code" id="M000007-source">
|
157
157
|
<pre>
|
158
158
|
<span class="ruby-comment cmt"># File lib/configatron/store.rb, line 6</span>
|
159
159
|
6: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">options</span> = {}, <span class="ruby-identifier">name</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">parent</span> = <span class="ruby-keyword kw">nil</span>)
|
@@ -170,11 +170,11 @@ Takes an optional Hash of parameters
|
|
170
170
|
|
171
171
|
<h3 class="section-bar">Public Instance methods</h3>
|
172
172
|
|
173
|
-
<div id="method-
|
174
|
-
<a name="
|
173
|
+
<div id="method-M000010" class="method-detail">
|
174
|
+
<a name="M000010"></a>
|
175
175
|
|
176
176
|
<div class="method-heading">
|
177
|
-
<a href="#
|
177
|
+
<a href="#M000010" class="method-signature">
|
178
178
|
<span class="method-name">configure_from_hash</span><span class="method-args">(options)</span>
|
179
179
|
</a>
|
180
180
|
</div>
|
@@ -184,8 +184,8 @@ Takes an optional Hash of parameters
|
|
184
184
|
Allows for the configuration of the system via a Hash
|
185
185
|
</p>
|
186
186
|
<p><a class="source-toggle" href="#"
|
187
|
-
onclick="toggleCode('
|
188
|
-
<div class="method-source-code" id="
|
187
|
+
onclick="toggleCode('M000010-source');return false;">[Source]</a></p>
|
188
|
+
<div class="method-source-code" id="M000010-source">
|
189
189
|
<pre>
|
190
190
|
<span class="ruby-comment cmt"># File lib/configatron/store.rb, line 51</span>
|
191
191
|
51: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">configure_from_hash</span>(<span class="ruby-identifier">options</span>)
|
@@ -196,11 +196,11 @@ Allows for the configuration of the system via a Hash
|
|
196
196
|
</div>
|
197
197
|
</div>
|
198
198
|
|
199
|
-
<div id="method-
|
200
|
-
<a name="
|
199
|
+
<div id="method-M000011" class="method-detail">
|
200
|
+
<a name="M000011"></a>
|
201
201
|
|
202
202
|
<div class="method-heading">
|
203
|
-
<a href="#
|
203
|
+
<a href="#M000011" class="method-signature">
|
204
204
|
<span class="method-name">configure_from_yaml</span><span class="method-args">(path, opts = {})</span>
|
205
205
|
</a>
|
206
206
|
</div>
|
@@ -212,8 +212,8 @@ to the YAML file. Also takes an optional parameter, <tt>:hash</tt>, that
|
|
212
212
|
indicates a specific hash that should be loaded from the file.
|
213
213
|
</p>
|
214
214
|
<p><a class="source-toggle" href="#"
|
215
|
-
onclick="toggleCode('
|
216
|
-
<div class="method-source-code" id="
|
215
|
+
onclick="toggleCode('M000011-source');return false;">[Source]</a></p>
|
216
|
+
<div class="method-source-code" id="M000011-source">
|
217
217
|
<pre>
|
218
218
|
<span class="ruby-comment cmt"># File lib/configatron/store.rb, line 59</span>
|
219
219
|
59: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">configure_from_yaml</span>(<span class="ruby-identifier">path</span>, <span class="ruby-identifier">opts</span> = {})
|
@@ -230,11 +230,11 @@ indicates a specific hash that should be loaded from the file.
|
|
230
230
|
</div>
|
231
231
|
</div>
|
232
232
|
|
233
|
-
<div id="method-
|
234
|
-
<a name="
|
233
|
+
<div id="method-M000022" class="method-detail">
|
234
|
+
<a name="M000022"></a>
|
235
235
|
|
236
236
|
<div class="method-heading">
|
237
|
-
<a href="#
|
237
|
+
<a href="#M000022" class="method-signature">
|
238
238
|
<span class="method-name">deep_clone</span><span class="method-args">( obj=self, cloned={} )</span>
|
239
239
|
</a>
|
240
240
|
</div>
|
@@ -282,8 +282,8 @@ href="http://simplypowerful.1984.cz/goodlibs/1.2006.05.23">simplypowerful.1984.c
|
|
282
282
|
either the dual license version in 2003, or any later version.
|
283
283
|
</pre>
|
284
284
|
<p><a class="source-toggle" href="#"
|
285
|
-
onclick="toggleCode('
|
286
|
-
<div class="method-source-code" id="
|
285
|
+
onclick="toggleCode('M000022-source');return false;">[Source]</a></p>
|
286
|
+
<div class="method-source-code" id="M000022-source">
|
287
287
|
<pre>
|
288
288
|
<span class="ruby-comment cmt"># File lib/configatron/store.rb, line 192</span>
|
289
289
|
192: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">deep_clone</span>( <span class="ruby-identifier">obj</span>=<span class="ruby-keyword kw">self</span>, <span class="ruby-identifier">cloned</span>={} )
|
@@ -322,19 +322,19 @@ href="http://simplypowerful.1984.cz/goodlibs/1.2006.05.23">simplypowerful.1984.c
|
|
322
322
|
</div>
|
323
323
|
</div>
|
324
324
|
|
325
|
-
<div id="method-
|
326
|
-
<a name="
|
325
|
+
<div id="method-M000009" class="method-detail">
|
326
|
+
<a name="M000009"></a>
|
327
327
|
|
328
328
|
<div class="method-heading">
|
329
|
-
<a href="#
|
329
|
+
<a href="#M000009" class="method-signature">
|
330
330
|
<span class="method-name">inspect</span><span class="method-args">()</span>
|
331
331
|
</a>
|
332
332
|
</div>
|
333
333
|
|
334
334
|
<div class="method-description">
|
335
335
|
<p><a class="source-toggle" href="#"
|
336
|
-
onclick="toggleCode('
|
337
|
-
<div class="method-source-code" id="
|
336
|
+
onclick="toggleCode('M000009-source');return false;">[Source]</a></p>
|
337
|
+
<div class="method-source-code" id="M000009-source">
|
338
338
|
<pre>
|
339
339
|
<span class="ruby-comment cmt"># File lib/configatron/store.rb, line 19</span>
|
340
340
|
19: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">inspect</span>
|
@@ -372,24 +372,24 @@ href="http://simplypowerful.1984.cz/goodlibs/1.2006.05.23">simplypowerful.1984.c
|
|
372
372
|
</div>
|
373
373
|
</div>
|
374
374
|
|
375
|
-
<div id="method-
|
376
|
-
<a name="
|
375
|
+
<div id="method-M000020" class="method-detail">
|
376
|
+
<a name="M000020"></a>
|
377
377
|
|
378
378
|
<div class="method-heading">
|
379
|
-
<a href="#
|
379
|
+
<a href="#M000020" class="method-signature">
|
380
380
|
<span class="method-name">lock</span><span class="method-args">(name)</span>
|
381
381
|
</a>
|
382
382
|
</div>
|
383
383
|
|
384
384
|
<div class="method-description">
|
385
385
|
<p>
|
386
|
-
Prevents a namespace from having <a href="Store.html#
|
387
|
-
parameters set. The <a href="Store.html#
|
386
|
+
Prevents a namespace from having <a href="Store.html#M000007">new</a>
|
387
|
+
parameters set. The <a href="Store.html#M000020">lock</a> is applied
|
388
388
|
recursively to any namespaces below it.
|
389
389
|
</p>
|
390
390
|
<p><a class="source-toggle" href="#"
|
391
|
-
onclick="toggleCode('
|
392
|
-
<div class="method-source-code" id="
|
391
|
+
onclick="toggleCode('M000020-source');return false;">[Source]</a></p>
|
392
|
+
<div class="method-source-code" id="M000020-source">
|
393
393
|
<pre>
|
394
394
|
<span class="ruby-comment cmt"># File lib/configatron/store.rb, line 144</span>
|
395
395
|
144: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">lock</span>(<span class="ruby-identifier">name</span>)
|
@@ -402,11 +402,11 @@ recursively to any namespaces below it.
|
|
402
402
|
</div>
|
403
403
|
</div>
|
404
404
|
|
405
|
-
<div id="method-
|
406
|
-
<a name="
|
405
|
+
<div id="method-M000012" class="method-detail">
|
406
|
+
<a name="M000012"></a>
|
407
407
|
|
408
408
|
<div class="method-heading">
|
409
|
-
<a href="#
|
409
|
+
<a href="#M000012" class="method-signature">
|
410
410
|
<span class="method-name">nil?</span><span class="method-args">()</span>
|
411
411
|
</a>
|
412
412
|
</div>
|
@@ -416,8 +416,8 @@ recursively to any namespaces below it.
|
|
416
416
|
Returns true if there are no configuration parameters
|
417
417
|
</p>
|
418
418
|
<p><a class="source-toggle" href="#"
|
419
|
-
onclick="toggleCode('
|
420
|
-
<div class="method-source-code" id="
|
419
|
+
onclick="toggleCode('M000012-source');return false;">[Source]</a></p>
|
420
|
+
<div class="method-source-code" id="M000012-source">
|
421
421
|
<pre>
|
422
422
|
<span class="ruby-comment cmt"># File lib/configatron/store.rb, line 70</span>
|
423
423
|
70: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">nil?</span>
|
@@ -428,11 +428,11 @@ Returns true if there are no configuration parameters
|
|
428
428
|
</div>
|
429
429
|
</div>
|
430
430
|
|
431
|
-
<div id="method-
|
432
|
-
<a name="
|
431
|
+
<div id="method-M000016" class="method-detail">
|
432
|
+
<a name="M000016"></a>
|
433
433
|
|
434
434
|
<div class="method-heading">
|
435
|
-
<a href="#
|
435
|
+
<a href="#M000016" class="method-signature">
|
436
436
|
<span class="method-name">protect</span><span class="method-args">(name)</span>
|
437
437
|
</a>
|
438
438
|
</div>
|
@@ -444,8 +444,8 @@ Prevents a parameter from being reassigned. If called on a
|
|
444
444
|
well.
|
445
445
|
</p>
|
446
446
|
<p><a class="source-toggle" href="#"
|
447
|
-
onclick="toggleCode('
|
448
|
-
<div class="method-source-code" id="
|
447
|
+
onclick="toggleCode('M000016-source');return false;">[Source]</a></p>
|
448
|
+
<div class="method-source-code" id="M000016-source">
|
449
449
|
<pre>
|
450
450
|
<span class="ruby-comment cmt"># File lib/configatron/store.rb, line 115</span>
|
451
451
|
115: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">protect</span>(<span class="ruby-identifier">name</span>)
|
@@ -456,11 +456,11 @@ well.
|
|
456
456
|
</div>
|
457
457
|
</div>
|
458
458
|
|
459
|
-
<div id="method-
|
460
|
-
<a name="
|
459
|
+
<div id="method-M000017" class="method-detail">
|
460
|
+
<a name="M000017"></a>
|
461
461
|
|
462
462
|
<div class="method-heading">
|
463
|
-
<a href="#
|
463
|
+
<a href="#M000017" class="method-signature">
|
464
464
|
<span class="method-name">protect_all!</span><span class="method-args">()</span>
|
465
465
|
</a>
|
466
466
|
</div>
|
@@ -470,8 +470,8 @@ well.
|
|
470
470
|
Prevents all parameters from being reassigned.
|
471
471
|
</p>
|
472
472
|
<p><a class="source-toggle" href="#"
|
473
|
-
onclick="toggleCode('
|
474
|
-
<div class="method-source-code" id="
|
473
|
+
onclick="toggleCode('M000017-source');return false;">[Source]</a></p>
|
474
|
+
<div class="method-source-code" id="M000017-source">
|
475
475
|
<pre>
|
476
476
|
<span class="ruby-comment cmt"># File lib/configatron/store.rb, line 120</span>
|
477
477
|
120: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">protect_all!</span>
|
@@ -487,11 +487,11 @@ Prevents all parameters from being reassigned.
|
|
487
487
|
</div>
|
488
488
|
</div>
|
489
489
|
|
490
|
-
<div id="method-
|
491
|
-
<a name="
|
490
|
+
<div id="method-M000014" class="method-detail">
|
491
|
+
<a name="M000014"></a>
|
492
492
|
|
493
493
|
<div class="method-heading">
|
494
|
-
<a href="#
|
494
|
+
<a href="#M000014" class="method-signature">
|
495
495
|
<span class="method-name">remove</span><span class="method-args">(name)</span>
|
496
496
|
</a>
|
497
497
|
</div>
|
@@ -499,11 +499,11 @@ Prevents all parameters from being reassigned.
|
|
499
499
|
<div class="method-description">
|
500
500
|
<p>
|
501
501
|
Removes a parameter. In the case of a nested parameter it will <a
|
502
|
-
href="Store.html#
|
502
|
+
href="Store.html#M000014">remove</a> all below it.
|
503
503
|
</p>
|
504
504
|
<p><a class="source-toggle" href="#"
|
505
|
-
onclick="toggleCode('
|
506
|
-
<div class="method-source-code" id="
|
505
|
+
onclick="toggleCode('M000014-source');return false;">[Source]</a></p>
|
506
|
+
<div class="method-source-code" id="M000014-source">
|
507
507
|
<pre>
|
508
508
|
<span class="ruby-comment cmt"># File lib/configatron/store.rb, line 82</span>
|
509
509
|
82: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">remove</span>(<span class="ruby-identifier">name</span>)
|
@@ -514,11 +514,11 @@ href="Store.html#M000013">remove</a> all below it.
|
|
514
514
|
</div>
|
515
515
|
</div>
|
516
516
|
|
517
|
-
<div id="method-
|
518
|
-
<a name="
|
517
|
+
<div id="method-M000013" class="method-detail">
|
518
|
+
<a name="M000013"></a>
|
519
519
|
|
520
520
|
<div class="method-heading">
|
521
|
-
<a href="#
|
521
|
+
<a href="#M000013" class="method-signature">
|
522
522
|
<span class="method-name">retrieve</span><span class="method-args">(name, default_value = nil)</span>
|
523
523
|
</a>
|
524
524
|
</div>
|
@@ -529,8 +529,8 @@ Retrieves a certain parameter and if that parameter doesn‘t exist it
|
|
529
529
|
will return the default_value specified.
|
530
530
|
</p>
|
531
531
|
<p><a class="source-toggle" href="#"
|
532
|
-
onclick="toggleCode('
|
533
|
-
<div class="method-source-code" id="
|
532
|
+
onclick="toggleCode('M000013-source');return false;">[Source]</a></p>
|
533
|
+
<div class="method-source-code" id="M000013-source">
|
534
534
|
<pre>
|
535
535
|
<span class="ruby-comment cmt"># File lib/configatron/store.rb, line 76</span>
|
536
536
|
76: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">retrieve</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">default_value</span> = <span class="ruby-keyword kw">nil</span>)
|
@@ -541,11 +541,11 @@ will return the default_value specified.
|
|
541
541
|
</div>
|
542
542
|
</div>
|
543
543
|
|
544
|
-
<div id="method-
|
545
|
-
<a name="
|
544
|
+
<div id="method-M000015" class="method-detail">
|
545
|
+
<a name="M000015"></a>
|
546
546
|
|
547
547
|
<div class="method-heading">
|
548
|
-
<a href="#
|
548
|
+
<a href="#M000015" class="method-signature">
|
549
549
|
<span class="method-name">set_default</span><span class="method-args">(name, default_value)</span>
|
550
550
|
</a>
|
551
551
|
</div>
|
@@ -556,8 +556,8 @@ Sets a ‘default’ value. If there is already a value specified
|
|
556
556
|
it won‘t set the value.
|
557
557
|
</p>
|
558
558
|
<p><a class="source-toggle" href="#"
|
559
|
-
onclick="toggleCode('
|
560
|
-
<div class="method-source-code" id="
|
559
|
+
onclick="toggleCode('M000015-source');return false;">[Source]</a></p>
|
560
|
+
<div class="method-source-code" id="M000015-source">
|
561
561
|
<pre>
|
562
562
|
<span class="ruby-comment cmt"># File lib/configatron/store.rb, line 88</span>
|
563
563
|
88: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">set_default</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">default_value</span>)
|
@@ -570,11 +570,11 @@ it won‘t set the value.
|
|
570
570
|
</div>
|
571
571
|
</div>
|
572
572
|
|
573
|
-
<div id="method-
|
574
|
-
<a name="
|
573
|
+
<div id="method-M000008" class="method-detail">
|
574
|
+
<a name="M000008"></a>
|
575
575
|
|
576
576
|
<div class="method-heading">
|
577
|
-
<a href="#
|
577
|
+
<a href="#M000008" class="method-signature">
|
578
578
|
<span class="method-name">to_hash</span><span class="method-args">()</span>
|
579
579
|
</a>
|
580
580
|
</div>
|
@@ -584,8 +584,8 @@ it won‘t set the value.
|
|
584
584
|
Returns a Hash representing the configurations
|
585
585
|
</p>
|
586
586
|
<p><a class="source-toggle" href="#"
|
587
|
-
onclick="toggleCode('
|
588
|
-
<div class="method-source-code" id="
|
587
|
+
onclick="toggleCode('M000008-source');return false;">[Source]</a></p>
|
588
|
+
<div class="method-source-code" id="M000008-source">
|
589
589
|
<pre>
|
590
590
|
<span class="ruby-comment cmt"># File lib/configatron/store.rb, line 15</span>
|
591
591
|
15: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_hash</span>
|
@@ -596,19 +596,19 @@ Returns a Hash representing the configurations
|
|
596
596
|
</div>
|
597
597
|
</div>
|
598
598
|
|
599
|
-
<div id="method-
|
600
|
-
<a name="
|
599
|
+
<div id="method-M000021" class="method-detail">
|
600
|
+
<a name="M000021"></a>
|
601
601
|
|
602
602
|
<div class="method-heading">
|
603
|
-
<a href="#
|
603
|
+
<a href="#M000021" class="method-signature">
|
604
604
|
<span class="method-name">unlock</span><span class="method-args">(name)</span>
|
605
605
|
</a>
|
606
606
|
</div>
|
607
607
|
|
608
608
|
<div class="method-description">
|
609
609
|
<p><a class="source-toggle" href="#"
|
610
|
-
onclick="toggleCode('
|
611
|
-
<div class="method-source-code" id="
|
610
|
+
onclick="toggleCode('M000021-source');return false;">[Source]</a></p>
|
611
|
+
<div class="method-source-code" id="M000021-source">
|
612
612
|
<pre>
|
613
613
|
<span class="ruby-comment cmt"># File lib/configatron/store.rb, line 150</span>
|
614
614
|
150: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">unlock</span>(<span class="ruby-identifier">name</span>)
|
@@ -621,11 +621,11 @@ Returns a Hash representing the configurations
|
|
621
621
|
</div>
|
622
622
|
</div>
|
623
623
|
|
624
|
-
<div id="method-
|
625
|
-
<a name="
|
624
|
+
<div id="method-M000018" class="method-detail">
|
625
|
+
<a name="M000018"></a>
|
626
626
|
|
627
627
|
<div class="method-heading">
|
628
|
-
<a href="#
|
628
|
+
<a href="#M000018" class="method-signature">
|
629
629
|
<span class="method-name">unprotect</span><span class="method-args">(name)</span>
|
630
630
|
</a>
|
631
631
|
</div>
|
@@ -635,8 +635,8 @@ Returns a Hash representing the configurations
|
|
635
635
|
Removes the protection of a parameter.
|
636
636
|
</p>
|
637
637
|
<p><a class="source-toggle" href="#"
|
638
|
-
onclick="toggleCode('
|
639
|
-
<div class="method-source-code" id="
|
638
|
+
onclick="toggleCode('M000018-source');return false;">[Source]</a></p>
|
639
|
+
<div class="method-source-code" id="M000018-source">
|
640
640
|
<pre>
|
641
641
|
<span class="ruby-comment cmt"># File lib/configatron/store.rb, line 130</span>
|
642
642
|
130: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">unprotect</span>(<span class="ruby-identifier">name</span>)
|
@@ -647,19 +647,19 @@ Removes the protection of a parameter.
|
|
647
647
|
</div>
|
648
648
|
</div>
|
649
649
|
|
650
|
-
<div id="method-
|
651
|
-
<a name="
|
650
|
+
<div id="method-M000019" class="method-detail">
|
651
|
+
<a name="M000019"></a>
|
652
652
|
|
653
653
|
<div class="method-heading">
|
654
|
-
<a href="#
|
654
|
+
<a href="#M000019" class="method-signature">
|
655
655
|
<span class="method-name">unprotect_all!</span><span class="method-args">()</span>
|
656
656
|
</a>
|
657
657
|
</div>
|
658
658
|
|
659
659
|
<div class="method-description">
|
660
660
|
<p><a class="source-toggle" href="#"
|
661
|
-
onclick="toggleCode('
|
662
|
-
<div class="method-source-code" id="
|
661
|
+
onclick="toggleCode('M000019-source');return false;">[Source]</a></p>
|
662
|
+
<div class="method-source-code" id="M000019-source">
|
663
663
|
<pre>
|
664
664
|
<span class="ruby-comment cmt"># File lib/configatron/store.rb, line 134</span>
|
665
665
|
134: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">unprotect_all!</span>
|
@@ -676,19 +676,19 @@ Removes the protection of a parameter.
|
|
676
676
|
|
677
677
|
<h3 class="section-bar">Protected Instance methods</h3>
|
678
678
|
|
679
|
-
<div id="method-
|
680
|
-
<a name="
|
679
|
+
<div id="method-M000023" class="method-detail">
|
680
|
+
<a name="M000023"></a>
|
681
681
|
|
682
682
|
<div class="method-heading">
|
683
|
-
<a href="#
|
683
|
+
<a href="#M000023" class="method-signature">
|
684
684
|
<span class="method-name">lock!</span><span class="method-args">()</span>
|
685
685
|
</a>
|
686
686
|
</div>
|
687
687
|
|
688
688
|
<div class="method-description">
|
689
689
|
<p><a class="source-toggle" href="#"
|
690
|
-
onclick="toggleCode('
|
691
|
-
<div class="method-source-code" id="
|
690
|
+
onclick="toggleCode('M000023-source');return false;">[Source]</a></p>
|
691
|
+
<div class="method-source-code" id="M000023-source">
|
692
692
|
<pre>
|
693
693
|
<span class="ruby-comment cmt"># File lib/configatron/store.rb, line 225</span>
|
694
694
|
225: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">lock!</span>
|
@@ -700,19 +700,19 @@ Removes the protection of a parameter.
|
|
700
700
|
</div>
|
701
701
|
</div>
|
702
702
|
|
703
|
-
<div id="method-
|
704
|
-
<a name="
|
703
|
+
<div id="method-M000024" class="method-detail">
|
704
|
+
<a name="M000024"></a>
|
705
705
|
|
706
706
|
<div class="method-heading">
|
707
|
-
<a href="#
|
707
|
+
<a href="#M000024" class="method-signature">
|
708
708
|
<span class="method-name">unlock!</span><span class="method-args">()</span>
|
709
709
|
</a>
|
710
710
|
</div>
|
711
711
|
|
712
712
|
<div class="method-description">
|
713
713
|
<p><a class="source-toggle" href="#"
|
714
|
-
onclick="toggleCode('
|
715
|
-
<div class="method-source-code" id="
|
714
|
+
onclick="toggleCode('M000024-source');return false;">[Source]</a></p>
|
715
|
+
<div class="method-source-code" id="M000024-source">
|
716
716
|
<pre>
|
717
717
|
<span class="ruby-comment cmt"># File lib/configatron/store.rb, line 230</span>
|
718
718
|
230: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">unlock!</span>
|