halation 0.1.0 → 0.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +211 -0
- data/bin/halation +4 -1
- data/doc/Halation.html +14 -4
- data/doc/Halation/AttrHelpers.html +288 -0
- data/doc/Halation/Coerce.html +373 -0
- data/doc/Halation/Config.html +732 -0
- data/doc/Halation/Config/Camera.html +628 -0
- data/doc/Halation/Config/Lens.html +540 -0
- data/doc/Halation/Engine.html +928 -0
- data/doc/Halation/ExifToolImage.html +486 -0
- data/doc/Halation/Roll.html +916 -0
- data/doc/Halation/Roll/Frame.html +842 -0
- data/doc/Halation/Script.html +506 -0
- data/doc/_index.html +112 -1
- data/doc/class_list.html +1 -1
- data/doc/file.LICENSE.html +1 -1
- data/doc/file.README.html +211 -1
- data/doc/index.html +211 -1
- data/doc/method_list.html +432 -0
- data/doc/top-level-namespace.html +1 -1
- data/lib/halation.rb +4 -0
- data/lib/halation/coerce.rb +21 -0
- data/lib/halation/config.rb +53 -0
- data/lib/halation/config/camera.rb +42 -0
- data/lib/halation/config/lens.rb +32 -0
- data/lib/halation/engine.rb +91 -0
- data/lib/halation/roll.rb +57 -0
- data/lib/halation/roll/frame.rb +47 -0
- data/lib/halation/script.rb +150 -0
- data/lib/halation/tools/exif_tool/image.rb +33 -0
- data/lib/halation/version.rb +1 -1
- metadata +42 -3
@@ -0,0 +1,373 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html>
|
3
|
+
<head>
|
4
|
+
<meta charset="utf-8">
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
6
|
+
<title>
|
7
|
+
Class: Halation::Coerce
|
8
|
+
|
9
|
+
— Documentation by YARD 0.8.7.6
|
10
|
+
|
11
|
+
</title>
|
12
|
+
|
13
|
+
<link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
|
14
|
+
|
15
|
+
<link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
|
16
|
+
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
18
|
+
pathId = "Halation::Coerce";
|
19
|
+
relpath = '../';
|
20
|
+
</script>
|
21
|
+
|
22
|
+
|
23
|
+
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
|
24
|
+
|
25
|
+
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
|
26
|
+
|
27
|
+
|
28
|
+
</head>
|
29
|
+
<body>
|
30
|
+
<div class="nav_wrap">
|
31
|
+
<iframe id="nav" src="../class_list.html"></iframe>
|
32
|
+
<div id="resizer"></div>
|
33
|
+
</div>
|
34
|
+
|
35
|
+
<div id="main" tabindex="-1">
|
36
|
+
<div id="header">
|
37
|
+
<div id="menu">
|
38
|
+
|
39
|
+
<a href="../_index.html">Index (C)</a> »
|
40
|
+
<span class='title'><span class='object_link'><a href="../Halation.html" title="Halation (module)">Halation</a></span></span>
|
41
|
+
»
|
42
|
+
<span class="title">Coerce</span>
|
43
|
+
|
44
|
+
</div>
|
45
|
+
|
46
|
+
<div id="search">
|
47
|
+
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
49
|
+
href="../class_list.html">
|
50
|
+
|
51
|
+
<svg width="24" height="24">
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
55
|
+
</svg>
|
56
|
+
</a>
|
57
|
+
|
58
|
+
</div>
|
59
|
+
<div class="clear"></div>
|
60
|
+
</div>
|
61
|
+
|
62
|
+
<iframe id="search_frame" src="../class_list.html"></iframe>
|
63
|
+
|
64
|
+
<div id="content"><h1>Class: Halation::Coerce
|
65
|
+
|
66
|
+
|
67
|
+
|
68
|
+
</h1>
|
69
|
+
<div class="box_info">
|
70
|
+
|
71
|
+
<dl>
|
72
|
+
<dt>Inherits:</dt>
|
73
|
+
<dd>
|
74
|
+
<span class="inheritName">Object</span>
|
75
|
+
|
76
|
+
<ul class="fullTree">
|
77
|
+
<li>Object</li>
|
78
|
+
|
79
|
+
<li class="next">Halation::Coerce</li>
|
80
|
+
|
81
|
+
</ul>
|
82
|
+
<a href="#" class="inheritanceTree">show all</a>
|
83
|
+
|
84
|
+
</dd>
|
85
|
+
</dl>
|
86
|
+
|
87
|
+
|
88
|
+
|
89
|
+
|
90
|
+
|
91
|
+
|
92
|
+
|
93
|
+
|
94
|
+
|
95
|
+
|
96
|
+
|
97
|
+
<dl>
|
98
|
+
<dt>Defined in:</dt>
|
99
|
+
<dd>lib/halation/coerce.rb</dd>
|
100
|
+
</dl>
|
101
|
+
|
102
|
+
</div>
|
103
|
+
|
104
|
+
<h2>Overview</h2><div class="docstring">
|
105
|
+
<div class="discussion">
|
106
|
+
|
107
|
+
<p>A collection of methods to coerce values into a desired type.</p>
|
108
|
+
|
109
|
+
|
110
|
+
</div>
|
111
|
+
</div>
|
112
|
+
<div class="tags">
|
113
|
+
|
114
|
+
|
115
|
+
</div>
|
116
|
+
|
117
|
+
|
118
|
+
|
119
|
+
|
120
|
+
|
121
|
+
|
122
|
+
|
123
|
+
<h2>
|
124
|
+
Class Method Summary
|
125
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
126
|
+
</h2>
|
127
|
+
|
128
|
+
<ul class="summary">
|
129
|
+
|
130
|
+
<li class="public ">
|
131
|
+
<span class="summary_signature">
|
132
|
+
|
133
|
+
<a href="#boolean-class_method" title="boolean (class method)">.<strong>boolean</strong>(value) ⇒ Boolean </a>
|
134
|
+
|
135
|
+
|
136
|
+
|
137
|
+
</span>
|
138
|
+
|
139
|
+
|
140
|
+
|
141
|
+
|
142
|
+
|
143
|
+
|
144
|
+
|
145
|
+
|
146
|
+
|
147
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
148
|
+
|
149
|
+
</li>
|
150
|
+
|
151
|
+
|
152
|
+
<li class="public ">
|
153
|
+
<span class="summary_signature">
|
154
|
+
|
155
|
+
<a href="#integer-class_method" title="integer (class method)">.<strong>integer</strong>(value) ⇒ Integer<sup>?</sup> </a>
|
156
|
+
|
157
|
+
|
158
|
+
|
159
|
+
</span>
|
160
|
+
|
161
|
+
|
162
|
+
|
163
|
+
|
164
|
+
|
165
|
+
|
166
|
+
|
167
|
+
|
168
|
+
|
169
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
170
|
+
|
171
|
+
</li>
|
172
|
+
|
173
|
+
|
174
|
+
<li class="public ">
|
175
|
+
<span class="summary_signature">
|
176
|
+
|
177
|
+
<a href="#string-class_method" title="string (class method)">.<strong>string</strong>(value) ⇒ String<sup>?</sup> </a>
|
178
|
+
|
179
|
+
|
180
|
+
|
181
|
+
</span>
|
182
|
+
|
183
|
+
|
184
|
+
|
185
|
+
|
186
|
+
|
187
|
+
|
188
|
+
|
189
|
+
|
190
|
+
|
191
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
192
|
+
|
193
|
+
</li>
|
194
|
+
|
195
|
+
|
196
|
+
</ul>
|
197
|
+
|
198
|
+
|
199
|
+
|
200
|
+
|
201
|
+
<div id="class_method_details" class="method_details_list">
|
202
|
+
<h2>Class Method Details</h2>
|
203
|
+
|
204
|
+
|
205
|
+
<div class="method_details first">
|
206
|
+
<h3 class="signature first" id="boolean-class_method">
|
207
|
+
|
208
|
+
.<strong>boolean</strong>(value) ⇒ <tt>Boolean</tt>
|
209
|
+
|
210
|
+
|
211
|
+
|
212
|
+
|
213
|
+
|
214
|
+
</h3><div class="docstring">
|
215
|
+
<div class="discussion">
|
216
|
+
|
217
|
+
|
218
|
+
</div>
|
219
|
+
</div>
|
220
|
+
<div class="tags">
|
221
|
+
|
222
|
+
<p class="tag_title">Returns:</p>
|
223
|
+
<ul class="return">
|
224
|
+
|
225
|
+
<li>
|
226
|
+
|
227
|
+
|
228
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
229
|
+
|
230
|
+
|
231
|
+
|
232
|
+
</li>
|
233
|
+
|
234
|
+
</ul>
|
235
|
+
|
236
|
+
</div><table class="source_code">
|
237
|
+
<tr>
|
238
|
+
<td>
|
239
|
+
<pre class="lines">
|
240
|
+
|
241
|
+
|
242
|
+
16
|
243
|
+
17
|
244
|
+
18</pre>
|
245
|
+
</td>
|
246
|
+
<td>
|
247
|
+
<pre class="code"><span class="info file"># File 'lib/halation/coerce.rb', line 16</span>
|
248
|
+
|
249
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_boolean'>boolean</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
|
250
|
+
<span class='op'>!</span><span class='op'>!</span><span class='id identifier rubyid_value'>value</span>
|
251
|
+
<span class='kw'>end</span></pre>
|
252
|
+
</td>
|
253
|
+
</tr>
|
254
|
+
</table>
|
255
|
+
</div>
|
256
|
+
|
257
|
+
<div class="method_details ">
|
258
|
+
<h3 class="signature " id="integer-class_method">
|
259
|
+
|
260
|
+
.<strong>integer</strong>(value) ⇒ <tt>Integer</tt><sup>?</sup>
|
261
|
+
|
262
|
+
|
263
|
+
|
264
|
+
|
265
|
+
|
266
|
+
</h3><div class="docstring">
|
267
|
+
<div class="discussion">
|
268
|
+
|
269
|
+
|
270
|
+
</div>
|
271
|
+
</div>
|
272
|
+
<div class="tags">
|
273
|
+
|
274
|
+
<p class="tag_title">Returns:</p>
|
275
|
+
<ul class="return">
|
276
|
+
|
277
|
+
<li>
|
278
|
+
|
279
|
+
|
280
|
+
<span class='type'>(<tt>Integer</tt>, <tt>nil</tt>)</span>
|
281
|
+
|
282
|
+
|
283
|
+
|
284
|
+
</li>
|
285
|
+
|
286
|
+
</ul>
|
287
|
+
|
288
|
+
</div><table class="source_code">
|
289
|
+
<tr>
|
290
|
+
<td>
|
291
|
+
<pre class="lines">
|
292
|
+
|
293
|
+
|
294
|
+
11
|
295
|
+
12
|
296
|
+
13</pre>
|
297
|
+
</td>
|
298
|
+
<td>
|
299
|
+
<pre class="code"><span class="info file"># File 'lib/halation/coerce.rb', line 11</span>
|
300
|
+
|
301
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_integer'>integer</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
|
302
|
+
<span class='id identifier rubyid_value'>value</span> <span class='op'>&&=</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span>
|
303
|
+
<span class='kw'>end</span></pre>
|
304
|
+
</td>
|
305
|
+
</tr>
|
306
|
+
</table>
|
307
|
+
</div>
|
308
|
+
|
309
|
+
<div class="method_details ">
|
310
|
+
<h3 class="signature " id="string-class_method">
|
311
|
+
|
312
|
+
.<strong>string</strong>(value) ⇒ <tt>String</tt><sup>?</sup>
|
313
|
+
|
314
|
+
|
315
|
+
|
316
|
+
|
317
|
+
|
318
|
+
</h3><div class="docstring">
|
319
|
+
<div class="discussion">
|
320
|
+
|
321
|
+
|
322
|
+
</div>
|
323
|
+
</div>
|
324
|
+
<div class="tags">
|
325
|
+
|
326
|
+
<p class="tag_title">Returns:</p>
|
327
|
+
<ul class="return">
|
328
|
+
|
329
|
+
<li>
|
330
|
+
|
331
|
+
|
332
|
+
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
|
333
|
+
|
334
|
+
|
335
|
+
|
336
|
+
</li>
|
337
|
+
|
338
|
+
</ul>
|
339
|
+
|
340
|
+
</div><table class="source_code">
|
341
|
+
<tr>
|
342
|
+
<td>
|
343
|
+
<pre class="lines">
|
344
|
+
|
345
|
+
|
346
|
+
6
|
347
|
+
7
|
348
|
+
8</pre>
|
349
|
+
</td>
|
350
|
+
<td>
|
351
|
+
<pre class="code"><span class="info file"># File 'lib/halation/coerce.rb', line 6</span>
|
352
|
+
|
353
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_string'>string</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
|
354
|
+
<span class='id identifier rubyid_value'>value</span> <span class='op'>&&=</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
|
355
|
+
<span class='kw'>end</span></pre>
|
356
|
+
</td>
|
357
|
+
</tr>
|
358
|
+
</table>
|
359
|
+
</div>
|
360
|
+
|
361
|
+
</div>
|
362
|
+
|
363
|
+
</div>
|
364
|
+
|
365
|
+
<div id="footer">
|
366
|
+
Generated on Sat May 28 22:28:56 2016 by
|
367
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
368
|
+
0.8.7.6 (ruby-2.1.7).
|
369
|
+
</div>
|
370
|
+
|
371
|
+
</div>
|
372
|
+
</body>
|
373
|
+
</html>
|
@@ -0,0 +1,732 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html>
|
3
|
+
<head>
|
4
|
+
<meta charset="utf-8">
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
6
|
+
<title>
|
7
|
+
Class: Halation::Config
|
8
|
+
|
9
|
+
— Documentation by YARD 0.8.7.6
|
10
|
+
|
11
|
+
</title>
|
12
|
+
|
13
|
+
<link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
|
14
|
+
|
15
|
+
<link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
|
16
|
+
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
18
|
+
pathId = "Halation::Config";
|
19
|
+
relpath = '../';
|
20
|
+
</script>
|
21
|
+
|
22
|
+
|
23
|
+
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
|
24
|
+
|
25
|
+
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
|
26
|
+
|
27
|
+
|
28
|
+
</head>
|
29
|
+
<body>
|
30
|
+
<div class="nav_wrap">
|
31
|
+
<iframe id="nav" src="../class_list.html"></iframe>
|
32
|
+
<div id="resizer"></div>
|
33
|
+
</div>
|
34
|
+
|
35
|
+
<div id="main" tabindex="-1">
|
36
|
+
<div id="header">
|
37
|
+
<div id="menu">
|
38
|
+
|
39
|
+
<a href="../_index.html">Index (C)</a> »
|
40
|
+
<span class='title'><span class='object_link'><a href="../Halation.html" title="Halation (module)">Halation</a></span></span>
|
41
|
+
»
|
42
|
+
<span class="title">Config</span>
|
43
|
+
|
44
|
+
</div>
|
45
|
+
|
46
|
+
<div id="search">
|
47
|
+
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
49
|
+
href="../class_list.html">
|
50
|
+
|
51
|
+
<svg width="24" height="24">
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
55
|
+
</svg>
|
56
|
+
</a>
|
57
|
+
|
58
|
+
</div>
|
59
|
+
<div class="clear"></div>
|
60
|
+
</div>
|
61
|
+
|
62
|
+
<iframe id="search_frame" src="../class_list.html"></iframe>
|
63
|
+
|
64
|
+
<div id="content"><h1>Class: Halation::Config
|
65
|
+
|
66
|
+
|
67
|
+
|
68
|
+
</h1>
|
69
|
+
<div class="box_info">
|
70
|
+
|
71
|
+
<dl>
|
72
|
+
<dt>Inherits:</dt>
|
73
|
+
<dd>
|
74
|
+
<span class="inheritName">Object</span>
|
75
|
+
|
76
|
+
<ul class="fullTree">
|
77
|
+
<li>Object</li>
|
78
|
+
|
79
|
+
<li class="next">Halation::Config</li>
|
80
|
+
|
81
|
+
</ul>
|
82
|
+
<a href="#" class="inheritanceTree">show all</a>
|
83
|
+
|
84
|
+
</dd>
|
85
|
+
</dl>
|
86
|
+
|
87
|
+
|
88
|
+
|
89
|
+
|
90
|
+
|
91
|
+
|
92
|
+
|
93
|
+
|
94
|
+
|
95
|
+
|
96
|
+
|
97
|
+
<dl>
|
98
|
+
<dt>Defined in:</dt>
|
99
|
+
<dd>lib/halation/config.rb<span class="defines">,<br />
|
100
|
+
lib/halation/config/lens.rb,<br /> lib/halation/config/camera.rb</span>
|
101
|
+
</dd>
|
102
|
+
</dl>
|
103
|
+
|
104
|
+
</div>
|
105
|
+
|
106
|
+
<h2>Overview</h2><div class="docstring">
|
107
|
+
<div class="discussion">
|
108
|
+
|
109
|
+
<p>Application-wide configuraton.</p>
|
110
|
+
|
111
|
+
|
112
|
+
</div>
|
113
|
+
</div>
|
114
|
+
<div class="tags">
|
115
|
+
|
116
|
+
|
117
|
+
</div><h2>Defined Under Namespace</h2>
|
118
|
+
<p class="children">
|
119
|
+
|
120
|
+
|
121
|
+
|
122
|
+
|
123
|
+
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Config/Camera.html" title="Halation::Config::Camera (class)">Camera</a></span>, <span class='object_link'><a href="Config/Lens.html" title="Halation::Config::Lens (class)">Lens</a></span>
|
124
|
+
|
125
|
+
|
126
|
+
</p>
|
127
|
+
|
128
|
+
<h2>Constant Summary</h2>
|
129
|
+
|
130
|
+
<dl class="constants">
|
131
|
+
|
132
|
+
<dt id="DEFAULT_CONFIG_PATH-constant" class="">DEFAULT_CONFIG_PATH =
|
133
|
+
<div class="docstring">
|
134
|
+
<div class="discussion">
|
135
|
+
|
136
|
+
<p>:nodoc:</p>
|
137
|
+
|
138
|
+
|
139
|
+
</div>
|
140
|
+
</div>
|
141
|
+
<div class="tags">
|
142
|
+
|
143
|
+
|
144
|
+
</div>
|
145
|
+
</dt>
|
146
|
+
<dd><pre class="code"><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_expand_path'>expand_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>~/.halation/config.yml</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
|
147
|
+
|
148
|
+
</dl>
|
149
|
+
|
150
|
+
|
151
|
+
|
152
|
+
|
153
|
+
|
154
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
155
|
+
<ul class="summary">
|
156
|
+
|
157
|
+
<li class="public ">
|
158
|
+
<span class="summary_signature">
|
159
|
+
|
160
|
+
<a href="#artist-instance_method" title="#artist (instance method)">#<strong>artist</strong> ⇒ Object </a>
|
161
|
+
|
162
|
+
|
163
|
+
|
164
|
+
</span>
|
165
|
+
|
166
|
+
|
167
|
+
|
168
|
+
|
169
|
+
<span class="note title readonly">readonly</span>
|
170
|
+
|
171
|
+
|
172
|
+
|
173
|
+
|
174
|
+
|
175
|
+
|
176
|
+
|
177
|
+
|
178
|
+
|
179
|
+
<span class="summary_desc"><div class='inline'>
|
180
|
+
<p>Returns the value of attribute artist.</p>
|
181
|
+
</div></span>
|
182
|
+
|
183
|
+
</li>
|
184
|
+
|
185
|
+
|
186
|
+
<li class="public ">
|
187
|
+
<span class="summary_signature">
|
188
|
+
|
189
|
+
<a href="#cameras-instance_method" title="#cameras (instance method)">#<strong>cameras</strong> ⇒ Object </a>
|
190
|
+
|
191
|
+
|
192
|
+
|
193
|
+
</span>
|
194
|
+
|
195
|
+
|
196
|
+
|
197
|
+
|
198
|
+
<span class="note title readonly">readonly</span>
|
199
|
+
|
200
|
+
|
201
|
+
|
202
|
+
|
203
|
+
|
204
|
+
|
205
|
+
|
206
|
+
|
207
|
+
|
208
|
+
<span class="summary_desc"><div class='inline'>
|
209
|
+
<p>Returns the value of attribute cameras.</p>
|
210
|
+
</div></span>
|
211
|
+
|
212
|
+
</li>
|
213
|
+
|
214
|
+
|
215
|
+
<li class="public ">
|
216
|
+
<span class="summary_signature">
|
217
|
+
|
218
|
+
<a href="#copyright-instance_method" title="#copyright (instance method)">#<strong>copyright</strong> ⇒ Object </a>
|
219
|
+
|
220
|
+
|
221
|
+
|
222
|
+
</span>
|
223
|
+
|
224
|
+
|
225
|
+
|
226
|
+
|
227
|
+
<span class="note title readonly">readonly</span>
|
228
|
+
|
229
|
+
|
230
|
+
|
231
|
+
|
232
|
+
|
233
|
+
|
234
|
+
|
235
|
+
|
236
|
+
|
237
|
+
<span class="summary_desc"><div class='inline'>
|
238
|
+
<p>Returns the value of attribute copyright.</p>
|
239
|
+
</div></span>
|
240
|
+
|
241
|
+
</li>
|
242
|
+
|
243
|
+
|
244
|
+
</ul>
|
245
|
+
|
246
|
+
|
247
|
+
|
248
|
+
|
249
|
+
|
250
|
+
<h2>
|
251
|
+
Instance Method Summary
|
252
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
253
|
+
</h2>
|
254
|
+
|
255
|
+
<ul class="summary">
|
256
|
+
|
257
|
+
<li class="public ">
|
258
|
+
<span class="summary_signature">
|
259
|
+
|
260
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong> ⇒ Config </a>
|
261
|
+
|
262
|
+
|
263
|
+
|
264
|
+
</span>
|
265
|
+
|
266
|
+
|
267
|
+
<span class="note title constructor">constructor</span>
|
268
|
+
|
269
|
+
|
270
|
+
|
271
|
+
|
272
|
+
|
273
|
+
|
274
|
+
|
275
|
+
|
276
|
+
<span class="summary_desc"><div class='inline'>
|
277
|
+
<p>A new instance of Config.</p>
|
278
|
+
</div></span>
|
279
|
+
|
280
|
+
</li>
|
281
|
+
|
282
|
+
|
283
|
+
<li class="public ">
|
284
|
+
<span class="summary_signature">
|
285
|
+
|
286
|
+
<a href="#load_file-instance_method" title="#load_file (instance method)">#<strong>load_file</strong>(file_path = nil) ⇒ Object </a>
|
287
|
+
|
288
|
+
|
289
|
+
|
290
|
+
</span>
|
291
|
+
|
292
|
+
|
293
|
+
|
294
|
+
|
295
|
+
|
296
|
+
|
297
|
+
|
298
|
+
|
299
|
+
|
300
|
+
<span class="summary_desc"><div class='inline'>
|
301
|
+
<p>Load the configuration from a YAML file.</p>
|
302
|
+
</div></span>
|
303
|
+
|
304
|
+
</li>
|
305
|
+
|
306
|
+
|
307
|
+
<li class="public ">
|
308
|
+
<span class="summary_signature">
|
309
|
+
|
310
|
+
<a href="#reset-instance_method" title="#reset (instance method)">#<strong>reset</strong> ⇒ Object </a>
|
311
|
+
|
312
|
+
|
313
|
+
|
314
|
+
</span>
|
315
|
+
|
316
|
+
|
317
|
+
|
318
|
+
|
319
|
+
|
320
|
+
|
321
|
+
|
322
|
+
|
323
|
+
|
324
|
+
<span class="summary_desc"><div class='inline'>
|
325
|
+
<p>Reset the configuration to default values.</p>
|
326
|
+
</div></span>
|
327
|
+
|
328
|
+
</li>
|
329
|
+
|
330
|
+
|
331
|
+
<li class="public ">
|
332
|
+
<span class="summary_signature">
|
333
|
+
|
334
|
+
<a href="#to_s-instance_method" title="#to_s (instance method)">#<strong>to_s</strong> ⇒ String </a>
|
335
|
+
|
336
|
+
|
337
|
+
|
338
|
+
</span>
|
339
|
+
|
340
|
+
|
341
|
+
|
342
|
+
|
343
|
+
|
344
|
+
|
345
|
+
|
346
|
+
|
347
|
+
|
348
|
+
<span class="summary_desc"><div class='inline'>
|
349
|
+
<p>List of configuration settings.</p>
|
350
|
+
</div></span>
|
351
|
+
|
352
|
+
</li>
|
353
|
+
|
354
|
+
|
355
|
+
</ul>
|
356
|
+
|
357
|
+
|
358
|
+
<div id="constructor_details" class="method_details_list">
|
359
|
+
<h2>Constructor Details</h2>
|
360
|
+
|
361
|
+
<div class="method_details first">
|
362
|
+
<h3 class="signature first" id="initialize-instance_method">
|
363
|
+
|
364
|
+
#<strong>initialize</strong> ⇒ <tt><span class='object_link'><a href="" title="Halation::Config (class)">Config</a></span></tt>
|
365
|
+
|
366
|
+
|
367
|
+
|
368
|
+
|
369
|
+
|
370
|
+
</h3><div class="docstring">
|
371
|
+
<div class="discussion">
|
372
|
+
|
373
|
+
<p>Returns a new instance of Config</p>
|
374
|
+
|
375
|
+
|
376
|
+
</div>
|
377
|
+
</div>
|
378
|
+
<div class="tags">
|
379
|
+
|
380
|
+
|
381
|
+
</div><table class="source_code">
|
382
|
+
<tr>
|
383
|
+
<td>
|
384
|
+
<pre class="lines">
|
385
|
+
|
386
|
+
|
387
|
+
15
|
388
|
+
16
|
389
|
+
17</pre>
|
390
|
+
</td>
|
391
|
+
<td>
|
392
|
+
<pre class="code"><span class="info file"># File 'lib/halation/config.rb', line 15</span>
|
393
|
+
|
394
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
|
395
|
+
<span class='id identifier rubyid_reset'>reset</span>
|
396
|
+
<span class='kw'>end</span></pre>
|
397
|
+
</td>
|
398
|
+
</tr>
|
399
|
+
</table>
|
400
|
+
</div>
|
401
|
+
|
402
|
+
</div>
|
403
|
+
|
404
|
+
<div id="instance_attr_details" class="attr_details">
|
405
|
+
<h2>Instance Attribute Details</h2>
|
406
|
+
|
407
|
+
|
408
|
+
<span id=""></span>
|
409
|
+
<div class="method_details first">
|
410
|
+
<h3 class="signature first" id="artist-instance_method">
|
411
|
+
|
412
|
+
#<strong>artist</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
413
|
+
|
414
|
+
|
415
|
+
|
416
|
+
|
417
|
+
|
418
|
+
</h3><div class="docstring">
|
419
|
+
<div class="discussion">
|
420
|
+
|
421
|
+
<p>Returns the value of attribute artist</p>
|
422
|
+
|
423
|
+
|
424
|
+
</div>
|
425
|
+
</div>
|
426
|
+
<div class="tags">
|
427
|
+
|
428
|
+
|
429
|
+
</div><table class="source_code">
|
430
|
+
<tr>
|
431
|
+
<td>
|
432
|
+
<pre class="lines">
|
433
|
+
|
434
|
+
|
435
|
+
11
|
436
|
+
12
|
437
|
+
13</pre>
|
438
|
+
</td>
|
439
|
+
<td>
|
440
|
+
<pre class="code"><span class="info file"># File 'lib/halation/config.rb', line 11</span>
|
441
|
+
|
442
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_artist'>artist</span>
|
443
|
+
<span class='ivar'>@artist</span>
|
444
|
+
<span class='kw'>end</span></pre>
|
445
|
+
</td>
|
446
|
+
</tr>
|
447
|
+
</table>
|
448
|
+
</div>
|
449
|
+
|
450
|
+
|
451
|
+
<span id=""></span>
|
452
|
+
<div class="method_details ">
|
453
|
+
<h3 class="signature " id="cameras-instance_method">
|
454
|
+
|
455
|
+
#<strong>cameras</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
456
|
+
|
457
|
+
|
458
|
+
|
459
|
+
|
460
|
+
|
461
|
+
</h3><div class="docstring">
|
462
|
+
<div class="discussion">
|
463
|
+
|
464
|
+
<p>Returns the value of attribute cameras</p>
|
465
|
+
|
466
|
+
|
467
|
+
</div>
|
468
|
+
</div>
|
469
|
+
<div class="tags">
|
470
|
+
|
471
|
+
|
472
|
+
</div><table class="source_code">
|
473
|
+
<tr>
|
474
|
+
<td>
|
475
|
+
<pre class="lines">
|
476
|
+
|
477
|
+
|
478
|
+
13
|
479
|
+
14
|
480
|
+
15</pre>
|
481
|
+
</td>
|
482
|
+
<td>
|
483
|
+
<pre class="code"><span class="info file"># File 'lib/halation/config.rb', line 13</span>
|
484
|
+
|
485
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_cameras'>cameras</span>
|
486
|
+
<span class='ivar'>@cameras</span>
|
487
|
+
<span class='kw'>end</span></pre>
|
488
|
+
</td>
|
489
|
+
</tr>
|
490
|
+
</table>
|
491
|
+
</div>
|
492
|
+
|
493
|
+
|
494
|
+
<span id=""></span>
|
495
|
+
<div class="method_details ">
|
496
|
+
<h3 class="signature " id="copyright-instance_method">
|
497
|
+
|
498
|
+
#<strong>copyright</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
499
|
+
|
500
|
+
|
501
|
+
|
502
|
+
|
503
|
+
|
504
|
+
</h3><div class="docstring">
|
505
|
+
<div class="discussion">
|
506
|
+
|
507
|
+
<p>Returns the value of attribute copyright</p>
|
508
|
+
|
509
|
+
|
510
|
+
</div>
|
511
|
+
</div>
|
512
|
+
<div class="tags">
|
513
|
+
|
514
|
+
|
515
|
+
</div><table class="source_code">
|
516
|
+
<tr>
|
517
|
+
<td>
|
518
|
+
<pre class="lines">
|
519
|
+
|
520
|
+
|
521
|
+
12
|
522
|
+
13
|
523
|
+
14</pre>
|
524
|
+
</td>
|
525
|
+
<td>
|
526
|
+
<pre class="code"><span class="info file"># File 'lib/halation/config.rb', line 12</span>
|
527
|
+
|
528
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_copyright'>copyright</span>
|
529
|
+
<span class='ivar'>@copyright</span>
|
530
|
+
<span class='kw'>end</span></pre>
|
531
|
+
</td>
|
532
|
+
</tr>
|
533
|
+
</table>
|
534
|
+
</div>
|
535
|
+
|
536
|
+
</div>
|
537
|
+
|
538
|
+
|
539
|
+
<div id="instance_method_details" class="method_details_list">
|
540
|
+
<h2>Instance Method Details</h2>
|
541
|
+
|
542
|
+
|
543
|
+
<div class="method_details first">
|
544
|
+
<h3 class="signature first" id="load_file-instance_method">
|
545
|
+
|
546
|
+
#<strong>load_file</strong>(file_path = nil) ⇒ <tt>Object</tt>
|
547
|
+
|
548
|
+
|
549
|
+
|
550
|
+
|
551
|
+
|
552
|
+
</h3><div class="docstring">
|
553
|
+
<div class="discussion">
|
554
|
+
|
555
|
+
<p>Load the configuration from a YAML file.</p>
|
556
|
+
|
557
|
+
|
558
|
+
</div>
|
559
|
+
</div>
|
560
|
+
<div class="tags">
|
561
|
+
|
562
|
+
|
563
|
+
</div><table class="source_code">
|
564
|
+
<tr>
|
565
|
+
<td>
|
566
|
+
<pre class="lines">
|
567
|
+
|
568
|
+
|
569
|
+
27
|
570
|
+
28
|
571
|
+
29
|
572
|
+
30
|
573
|
+
31
|
574
|
+
32
|
575
|
+
33
|
576
|
+
34
|
577
|
+
35
|
578
|
+
36
|
579
|
+
37
|
580
|
+
38
|
581
|
+
39
|
582
|
+
40
|
583
|
+
41</pre>
|
584
|
+
</td>
|
585
|
+
<td>
|
586
|
+
<pre class="code"><span class="info file"># File 'lib/halation/config.rb', line 27</span>
|
587
|
+
|
588
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_load_file'>load_file</span><span class='lparen'>(</span><span class='id identifier rubyid_file_path'>file_path</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
589
|
+
<span class='id identifier rubyid_file_path'>file_path</span> <span class='op'>||=</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_expand_path'>expand_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>./config.yml</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_exists?'>exists?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>./config.yml</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
590
|
+
<span class='id identifier rubyid_file_path'>file_path</span> <span class='op'>||=</span> <span class='const'>DEFAULT_CONFIG_PATH</span>
|
591
|
+
|
592
|
+
<span class='id identifier rubyid_reset'>reset</span>
|
593
|
+
|
594
|
+
<span class='const'>YAML</span><span class='period'>.</span><span class='id identifier rubyid_load_file'>load_file</span><span class='lparen'>(</span><span class='id identifier rubyid_file_path'>file_path</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_tap'>tap</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_config'>config</span><span class='op'>|</span>
|
595
|
+
<span class='ivar'>@artist</span> <span class='op'>=</span> <span class='const'>Coerce</span><span class='period'>.</span><span class='id identifier rubyid_string'>string</span><span class='lparen'>(</span><span class='id identifier rubyid_config'>config</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>artist</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
|
596
|
+
<span class='ivar'>@copyright</span> <span class='op'>=</span> <span class='const'>Coerce</span><span class='period'>.</span><span class='id identifier rubyid_string'>string</span><span class='lparen'>(</span><span class='id identifier rubyid_config'>config</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>copyright</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
|
597
|
+
|
598
|
+
<span class='lparen'>(</span><span class='id identifier rubyid_config'>config</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>cameras</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_camera'>camera</span><span class='op'>|</span>
|
599
|
+
<span class='ivar'>@cameras</span> <span class='op'><<</span> <span class='const'>Camera</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_camera'>camera</span><span class='rparen'>)</span>
|
600
|
+
<span class='kw'>end</span>
|
601
|
+
<span class='kw'>end</span>
|
602
|
+
<span class='kw'>end</span></pre>
|
603
|
+
</td>
|
604
|
+
</tr>
|
605
|
+
</table>
|
606
|
+
</div>
|
607
|
+
|
608
|
+
<div class="method_details ">
|
609
|
+
<h3 class="signature " id="reset-instance_method">
|
610
|
+
|
611
|
+
#<strong>reset</strong> ⇒ <tt>Object</tt>
|
612
|
+
|
613
|
+
|
614
|
+
|
615
|
+
|
616
|
+
|
617
|
+
</h3><div class="docstring">
|
618
|
+
<div class="discussion">
|
619
|
+
|
620
|
+
<p>Reset the configuration to default values.</p>
|
621
|
+
|
622
|
+
|
623
|
+
</div>
|
624
|
+
</div>
|
625
|
+
<div class="tags">
|
626
|
+
|
627
|
+
|
628
|
+
</div><table class="source_code">
|
629
|
+
<tr>
|
630
|
+
<td>
|
631
|
+
<pre class="lines">
|
632
|
+
|
633
|
+
|
634
|
+
20
|
635
|
+
21
|
636
|
+
22
|
637
|
+
23
|
638
|
+
24</pre>
|
639
|
+
</td>
|
640
|
+
<td>
|
641
|
+
<pre class="code"><span class="info file"># File 'lib/halation/config.rb', line 20</span>
|
642
|
+
|
643
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_reset'>reset</span>
|
644
|
+
<span class='ivar'>@artist</span> <span class='op'>=</span> <span class='kw'>nil</span>
|
645
|
+
<span class='ivar'>@copyright</span> <span class='op'>=</span> <span class='kw'>nil</span>
|
646
|
+
<span class='ivar'>@cameras</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
|
647
|
+
<span class='kw'>end</span></pre>
|
648
|
+
</td>
|
649
|
+
</tr>
|
650
|
+
</table>
|
651
|
+
</div>
|
652
|
+
|
653
|
+
<div class="method_details ">
|
654
|
+
<h3 class="signature " id="to_s-instance_method">
|
655
|
+
|
656
|
+
#<strong>to_s</strong> ⇒ <tt>String</tt>
|
657
|
+
|
658
|
+
|
659
|
+
|
660
|
+
|
661
|
+
|
662
|
+
</h3><div class="docstring">
|
663
|
+
<div class="discussion">
|
664
|
+
|
665
|
+
<p>Returns list of configuration settings.</p>
|
666
|
+
|
667
|
+
|
668
|
+
</div>
|
669
|
+
</div>
|
670
|
+
<div class="tags">
|
671
|
+
|
672
|
+
<p class="tag_title">Returns:</p>
|
673
|
+
<ul class="return">
|
674
|
+
|
675
|
+
<li>
|
676
|
+
|
677
|
+
|
678
|
+
<span class='type'>(<tt>String</tt>)</span>
|
679
|
+
|
680
|
+
|
681
|
+
|
682
|
+
—
|
683
|
+
<div class='inline'>
|
684
|
+
<p>list of configuration settings.</p>
|
685
|
+
</div>
|
686
|
+
|
687
|
+
</li>
|
688
|
+
|
689
|
+
</ul>
|
690
|
+
|
691
|
+
</div><table class="source_code">
|
692
|
+
<tr>
|
693
|
+
<td>
|
694
|
+
<pre class="lines">
|
695
|
+
|
696
|
+
|
697
|
+
44
|
698
|
+
45
|
699
|
+
46
|
700
|
+
47
|
701
|
+
48
|
702
|
+
49
|
703
|
+
50</pre>
|
704
|
+
</td>
|
705
|
+
<td>
|
706
|
+
<pre class="code"><span class="info file"># File 'lib/halation/config.rb', line 44</span>
|
707
|
+
|
708
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span>
|
709
|
+
<span class='lbracket'>[</span>
|
710
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Artist: </span><span class='embexpr_beg'>#{</span><span class='ivar'>@artist</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
711
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Copyright: </span><span class='embexpr_beg'>#{</span><span class='ivar'>@copyright</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
712
|
+
<span class='ivar'>@cameras</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lparen'>(</span><span class='op'>&</span><span class='symbol'>:to_s</span><span class='rparen'>)</span>
|
713
|
+
<span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
714
|
+
<span class='kw'>end</span></pre>
|
715
|
+
</td>
|
716
|
+
</tr>
|
717
|
+
</table>
|
718
|
+
</div>
|
719
|
+
|
720
|
+
</div>
|
721
|
+
|
722
|
+
</div>
|
723
|
+
|
724
|
+
<div id="footer">
|
725
|
+
Generated on Sat May 28 22:28:56 2016 by
|
726
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
727
|
+
0.8.7.6 (ruby-2.1.7).
|
728
|
+
</div>
|
729
|
+
|
730
|
+
</div>
|
731
|
+
</body>
|
732
|
+
</html>
|