ae_easy-router 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (45) hide show
  1. checksums.yaml +7 -0
  2. data/.gitignore +12 -0
  3. data/.travis.yml +7 -0
  4. data/.yardopts +1 -0
  5. data/CODE_OF_CONDUCT.md +74 -0
  6. data/Gemfile +6 -0
  7. data/LICENSE +21 -0
  8. data/README.md +16 -0
  9. data/Rakefile +22 -0
  10. data/ae_easy-router.gemspec +50 -0
  11. data/doc/AeEasy.html +117 -0
  12. data/doc/AeEasy/Core.html +117 -0
  13. data/doc/AeEasy/Core/Plugin.html +117 -0
  14. data/doc/AeEasy/Core/Plugin/ParserBehavior.html +196 -0
  15. data/doc/AeEasy/Core/Plugin/SeederBehavior.html +196 -0
  16. data/doc/AeEasy/Router.html +146 -0
  17. data/doc/AeEasy/Router/Parser.html +366 -0
  18. data/doc/AeEasy/Router/Plugin.html +117 -0
  19. data/doc/AeEasy/Router/Plugin/Router.html +778 -0
  20. data/doc/AeEasy/Router/Seeder.html +345 -0
  21. data/doc/_index.html +202 -0
  22. data/doc/class_list.html +51 -0
  23. data/doc/css/common.css +1 -0
  24. data/doc/css/full_list.css +58 -0
  25. data/doc/css/style.css +496 -0
  26. data/doc/file.README.html +92 -0
  27. data/doc/file_list.html +56 -0
  28. data/doc/frames.html +17 -0
  29. data/doc/index.html +92 -0
  30. data/doc/js/app.js +292 -0
  31. data/doc/js/full_list.js +216 -0
  32. data/doc/js/jquery.js +4 -0
  33. data/doc/method_list.html +131 -0
  34. data/doc/top-level-namespace.html +110 -0
  35. data/lib/ae_easy/router.rb +13 -0
  36. data/lib/ae_easy/router/parser.rb +48 -0
  37. data/lib/ae_easy/router/plugin.rb +8 -0
  38. data/lib/ae_easy/router/plugin/router.rb +74 -0
  39. data/lib/ae_easy/router/seeder.rb +38 -0
  40. data/lib/ae_easy/router/version.rb +6 -0
  41. data/lib/ae_easy_override/core.rb +6 -0
  42. data/lib/ae_easy_override/core/plugin.rb +9 -0
  43. data/lib/ae_easy_override/core/plugin/parser_behavior.rb +11 -0
  44. data/lib/ae_easy_override/core/plugin/seeder_behavior.rb +11 -0
  45. metadata +216 -0
data/doc/AeEasy/Router/Plugin.html ADDED
@@ -0,0 +1,117 @@
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
+ Module: AeEasy::Router::Plugin
8
+
9
+ &mdash; Documentation by YARD 0.9.18
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 = "AeEasy::Router::Plugin";
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?1"></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 (P)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../../AeEasy.html" title="AeEasy (module)">AeEasy</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Router.html" title="AeEasy::Router (module)">Router</a></span></span>
41
+ &raquo;
42
+ <span class="title">Plugin</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
+ <div id="content"><h1>Module: AeEasy::Router::Plugin
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+
70
+
71
+
72
+
73
+
74
+
75
+
76
+
77
+
78
+
79
+ <dl>
80
+ <dt>Defined in:</dt>
81
+ <dd>lib/ae_easy/router/plugin.rb<span class="defines">,<br />
82
+ lib/ae_easy/router/plugin/router.rb</span>
83
+ </dd>
84
+ </dl>
85
+
86
+ </div>
87
+
88
+ <h2>Defined Under Namespace</h2>
89
+ <p class="children">
90
+
91
+
92
+ <strong class="modules">Modules:</strong> <span class='object_link'><a href="Plugin/Router.html" title="AeEasy::Router::Plugin::Router (module)">Router</a></span>
93
+
94
+
95
+
96
+
97
+ </p>
98
+
99
+
100
+
101
+
102
+
103
+
104
+
105
+
106
+
107
+ </div>
108
+
109
+ <div id="footer">
110
+ Generated on Tue Feb 26 17:02:32 2019 by
111
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
112
+ 0.9.18 (ruby-2.5.3).
113
+ </div>
114
+
115
+ </div>
116
+ </body>
117
+ </html>
data/doc/AeEasy/Router/Plugin/Router.html ADDED
@@ -0,0 +1,778 @@
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
+ Module: AeEasy::Router::Plugin::Router
8
+
9
+ &mdash; Documentation by YARD 0.9.18
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 = "AeEasy::Router::Plugin::Router";
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?1"></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 (R)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../../../AeEasy.html" title="AeEasy (module)">AeEasy</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Router.html" title="AeEasy::Router (module)">Router</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Plugin.html" title="AeEasy::Router::Plugin (module)">Plugin</a></span></span>
41
+ &raquo;
42
+ <span class="title">Router</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
+ <div id="content"><h1>Module: AeEasy::Router::Plugin::Router
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+
70
+
71
+
72
+
73
+
74
+ <dl>
75
+ <dt>Includes:</dt>
76
+ <dd>Core::Plugin::InitializeHook</dd>
77
+ </dl>
78
+
79
+
80
+
81
+
82
+ <dl>
83
+ <dt>Included in:</dt>
84
+ <dd><span class='object_link'><a href="../Parser.html" title="AeEasy::Router::Parser (class)">AeEasy::Router::Parser</a></span>, <span class='object_link'><a href="../Seeder.html" title="AeEasy::Router::Seeder (class)">Seeder</a></span></dd>
85
+ </dl>
86
+
87
+
88
+
89
+ <dl>
90
+ <dt>Defined in:</dt>
91
+ <dd>lib/ae_easy/router/plugin/router.rb</dd>
92
+ </dl>
93
+
94
+ </div>
95
+
96
+ <h2>Overview</h2><div class="docstring">
97
+ <div class="discussion">
98
+
99
+ <p>Base router providing the basic functionalities from a router.</p>
100
+
101
+
102
+ </div>
103
+ </div>
104
+ <div class="tags">
105
+
106
+
107
+ </div>
108
+
109
+
110
+
111
+ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
112
+ <ul class="summary">
113
+
114
+ <li class="public ">
115
+ <span class="summary_signature">
116
+
117
+ <a href="#local_config-instance_method" title="#local_config (instance method)">#<strong>local_config</strong> &#x21d2; Object </a>
118
+
119
+
120
+
121
+ </span>
122
+
123
+
124
+
125
+
126
+ <span class="note title readonly">readonly</span>
127
+
128
+
129
+
130
+
131
+
132
+
133
+
134
+
135
+
136
+ <span class="summary_desc"><div class='inline'>
137
+ <p>Local configuration (see AeEasy::Core::Config).</p>
138
+ </div></span>
139
+
140
+ </li>
141
+
142
+
143
+ </ul>
144
+
145
+
146
+
147
+
148
+
149
+ <h2>
150
+ Instance Method Summary
151
+ <small><a href="#" class="summary_toggle">collapse</a></small>
152
+ </h2>
153
+
154
+ <ul class="summary">
155
+
156
+ <li class="public ">
157
+ <span class="summary_signature">
158
+
159
+ <a href="#class_defined%3F-instance_method" title="#class_defined? (instance method)">#<strong>class_defined?</strong>(name) &#x21d2; Boolean </a>
160
+
161
+
162
+
163
+ </span>
164
+
165
+
166
+
167
+
168
+
169
+
170
+
171
+
172
+
173
+ <span class="summary_desc"><div class='inline'>
174
+ <p>Validates when a class name exists.</p>
175
+ </div></span>
176
+
177
+ </li>
178
+
179
+
180
+ <li class="public ">
181
+ <span class="summary_signature">
182
+
183
+ <a href="#config-instance_method" title="#config (instance method)">#<strong>config</strong> &#x21d2; Hash </a>
184
+
185
+
186
+
187
+ </span>
188
+
189
+
190
+
191
+
192
+
193
+
194
+
195
+
196
+
197
+ <span class="summary_desc"><div class='inline'>
198
+ <p>Router configuration.</p>
199
+ </div></span>
200
+
201
+ </li>
202
+
203
+
204
+ <li class="public ">
205
+ <span class="summary_signature">
206
+
207
+ <a href="#get_class-instance_method" title="#get_class (instance method)">#<strong>get_class</strong>(name) &#x21d2; Class<sup>?</sup> </a>
208
+
209
+
210
+
211
+ </span>
212
+
213
+
214
+
215
+
216
+
217
+
218
+
219
+
220
+
221
+ <span class="summary_desc"><div class='inline'>
222
+ <p>Get a class from a class name.</p>
223
+ </div></span>
224
+
225
+ </li>
226
+
227
+
228
+ <li class="public ">
229
+ <span class="summary_signature">
230
+
231
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(opts = {}) &#x21d2; Object </a>
232
+
233
+
234
+
235
+ </span>
236
+
237
+
238
+
239
+
240
+
241
+
242
+
243
+
244
+
245
+ <span class="summary_desc"><div class='inline'>
246
+ <p>Initialize router and hooks.</p>
247
+ </div></span>
248
+
249
+ </li>
250
+
251
+
252
+ <li class="public ">
253
+ <span class="summary_signature">
254
+
255
+ <a href="#initialize_hook_router_plugin_router-instance_method" title="#initialize_hook_router_plugin_router (instance method)">#<strong>initialize_hook_router_plugin_router</strong>(opts = {}) &#x21d2; Object </a>
256
+
257
+
258
+
259
+ </span>
260
+
261
+
262
+
263
+
264
+
265
+
266
+
267
+
268
+
269
+ <span class="summary_desc"><div class='inline'>
270
+ <p>Hook to initialize router configuration.</p>
271
+ </div></span>
272
+
273
+ </li>
274
+
275
+
276
+ </ul>
277
+
278
+
279
+
280
+
281
+ <div id="instance_attr_details" class="attr_details">
282
+ <h2>Instance Attribute Details</h2>
283
+
284
+
285
+ <span id=""></span>
286
+ <div class="method_details first">
287
+ <h3 class="signature first" id="local_config-instance_method">
288
+
289
+ #<strong>local_config</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
290
+
291
+
292
+
293
+
294
+
295
+ </h3><div class="docstring">
296
+ <div class="discussion">
297
+
298
+ <p>Local configuration (see AeEasy::Core::Config).</p>
299
+
300
+
301
+ </div>
302
+ </div>
303
+ <div class="tags">
304
+
305
+
306
+ </div><table class="source_code">
307
+ <tr>
308
+ <td>
309
+ <pre class="lines">
310
+
311
+
312
+ 9
313
+ 10
314
+ 11</pre>
315
+ </td>
316
+ <td>
317
+ <pre class="code"><span class="info file"># File 'lib/ae_easy/router/plugin/router.rb', line 9</span>
318
+
319
+ <span class='kw'>def</span> <span class='id identifier rubyid_local_config'>local_config</span>
320
+ <span class='ivar'>@local_config</span>
321
+ <span class='kw'>end</span></pre>
322
+ </td>
323
+ </tr>
324
+ </table>
325
+ </div>
326
+
327
+ </div>
328
+
329
+
330
+ <div id="instance_method_details" class="method_details_list">
331
+ <h2>Instance Method Details</h2>
332
+
333
+
334
+ <div class="method_details first">
335
+ <h3 class="signature first" id="class_defined?-instance_method">
336
+
337
+ #<strong>class_defined?</strong>(name) &#x21d2; <tt>Boolean</tt>
338
+
339
+
340
+
341
+
342
+
343
+ </h3><div class="docstring">
344
+ <div class="discussion">
345
+
346
+ <p>Validates when a class name exists</p>
347
+
348
+
349
+ </div>
350
+ </div>
351
+ <div class="tags">
352
+ <p class="tag_title">Parameters:</p>
353
+ <ul class="param">
354
+
355
+ <li>
356
+
357
+ <span class='name'>name</span>
358
+
359
+
360
+ <span class='type'>(<tt>String</tt>)</span>
361
+
362
+
363
+
364
+ &mdash;
365
+ <div class='inline'>
366
+ <p>Class name to validate.</p>
367
+ </div>
368
+
369
+ </li>
370
+
371
+ </ul>
372
+
373
+ <p class="tag_title">Returns:</p>
374
+ <ul class="return">
375
+
376
+ <li>
377
+
378
+
379
+ <span class='type'>(<tt>Boolean</tt>)</span>
380
+
381
+
382
+
383
+ &mdash;
384
+ <div class='inline'>
385
+ <p>`true` when exists, else `false`.</p>
386
+ </div>
387
+
388
+ </li>
389
+
390
+ </ul>
391
+
392
+ </div><table class="source_code">
393
+ <tr>
394
+ <td>
395
+ <pre class="lines">
396
+
397
+
398
+ 58
399
+ 59
400
+ 60</pre>
401
+ </td>
402
+ <td>
403
+ <pre class="code"><span class="info file"># File 'lib/ae_easy/router/plugin/router.rb', line 58</span>
404
+
405
+ <span class='kw'>def</span> <span class='id identifier rubyid_class_defined?'>class_defined?</span> <span class='id identifier rubyid_name'>name</span>
406
+ <span class='const'>Object</span><span class='period'>.</span><span class='id identifier rubyid_const_defined?'>const_defined?</span> <span class='id identifier rubyid_name'>name</span>
407
+ <span class='kw'>end</span></pre>
408
+ </td>
409
+ </tr>
410
+ </table>
411
+ </div>
412
+
413
+ <div class="method_details ">
414
+ <h3 class="signature " id="config-instance_method">
415
+
416
+ #<strong>config</strong> &#x21d2; <tt>Hash</tt>
417
+
418
+
419
+
420
+
421
+
422
+ </h3><div class="docstring">
423
+ <div class="discussion">
424
+
425
+ <p>Router configuration.</p>
426
+
427
+
428
+ </div>
429
+ </div>
430
+ <div class="tags">
431
+
432
+ <p class="tag_title">Returns:</p>
433
+ <ul class="return">
434
+
435
+ <li>
436
+
437
+
438
+ <span class='type'>(<tt>Hash</tt>)</span>
439
+
440
+
441
+
442
+ </li>
443
+
444
+ </ul>
445
+
446
+ </div><table class="source_code">
447
+ <tr>
448
+ <td>
449
+ <pre class="lines">
450
+
451
+
452
+ 49
453
+ 50
454
+ 51</pre>
455
+ </td>
456
+ <td>
457
+ <pre class="code"><span class="info file"># File 'lib/ae_easy/router/plugin/router.rb', line 49</span>
458
+
459
+ <span class='kw'>def</span> <span class='id identifier rubyid_config'>config</span>
460
+ <span class='id identifier rubyid_local_config'>local_config</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>router</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
461
+ <span class='kw'>end</span></pre>
462
+ </td>
463
+ </tr>
464
+ </table>
465
+ </div>
466
+
467
+ <div class="method_details ">
468
+ <h3 class="signature " id="get_class-instance_method">
469
+
470
+ #<strong>get_class</strong>(name) &#x21d2; <tt>Class</tt><sup>?</sup>
471
+
472
+
473
+
474
+
475
+
476
+ </h3><div class="docstring">
477
+ <div class="discussion">
478
+
479
+ <p>Get a class from a class name.</p>
480
+
481
+
482
+ </div>
483
+ </div>
484
+ <div class="tags">
485
+ <p class="tag_title">Parameters:</p>
486
+ <ul class="param">
487
+
488
+ <li>
489
+
490
+ <span class='name'>name</span>
491
+
492
+
493
+ <span class='type'>(<tt>String</tt>)</span>
494
+
495
+
496
+
497
+ &mdash;
498
+ <div class='inline'>
499
+ <p>Class name to validate.</p>
500
+ </div>
501
+
502
+ </li>
503
+
504
+ </ul>
505
+
506
+ <p class="tag_title">Returns:</p>
507
+ <ul class="return">
508
+
509
+ <li>
510
+
511
+
512
+ <span class='type'>(<tt>Class</tt>, <tt>nil</tt>)</span>
513
+
514
+
515
+
516
+ &mdash;
517
+ <div class='inline'>
518
+ <p>`nil` when class doesn&#39;t exists.</p>
519
+ </div>
520
+
521
+ </li>
522
+
523
+ </ul>
524
+
525
+ </div><table class="source_code">
526
+ <tr>
527
+ <td>
528
+ <pre class="lines">
529
+
530
+
531
+ 67
532
+ 68
533
+ 69
534
+ 70</pre>
535
+ </td>
536
+ <td>
537
+ <pre class="code"><span class="info file"># File 'lib/ae_easy/router/plugin/router.rb', line 67</span>
538
+
539
+ <span class='kw'>def</span> <span class='id identifier rubyid_get_class'>get_class</span> <span class='id identifier rubyid_name'>name</span>
540
+ <span class='kw'>return</span> <span class='kw'>nil</span> <span class='kw'>unless</span> <span class='id identifier rubyid_class_defined?'>class_defined?</span> <span class='id identifier rubyid_name'>name</span>
541
+ <span class='const'>Object</span><span class='period'>.</span><span class='id identifier rubyid_const_get'>const_get</span> <span class='id identifier rubyid_name'>name</span>
542
+ <span class='kw'>end</span></pre>
543
+ </td>
544
+ </tr>
545
+ </table>
546
+ </div>
547
+
548
+ <div class="method_details ">
549
+ <h3 class="signature " id="initialize-instance_method">
550
+
551
+ #<strong>initialize</strong>(opts = {}) &#x21d2; <tt>Object</tt>
552
+
553
+
554
+
555
+
556
+
557
+ </h3><div class="docstring">
558
+ <div class="discussion">
559
+
560
+ <p>Initialize router and hooks.</p>
561
+
562
+
563
+ </div>
564
+ </div>
565
+ <div class="tags">
566
+ <p class="tag_title">Parameters:</p>
567
+ <ul class="param">
568
+
569
+ <li>
570
+
571
+ <span class='name'>opts</span>
572
+
573
+
574
+ <span class='type'>(<tt>Hash</tt>)</span>
575
+
576
+
577
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
578
+
579
+
580
+ &mdash;
581
+ <div class='inline'>
582
+ <p>({}) Configuration options.</p>
583
+ </div>
584
+
585
+ </li>
586
+
587
+ </ul>
588
+
589
+
590
+ <p class="tag_title">See Also:</p>
591
+ <ul class="see">
592
+
593
+ <li><span class='object_link'><a href="#initialize_hook_router_plugin_router-instance_method" title="AeEasy::Router::Plugin::Router#initialize_hook_router_plugin_router (method)">#initialize_hook_router_plugin_router</a></span></li>
594
+
595
+ </ul>
596
+
597
+ </div><table class="source_code">
598
+ <tr>
599
+ <td>
600
+ <pre class="lines">
601
+
602
+
603
+ 42
604
+ 43
605
+ 44</pre>
606
+ </td>
607
+ <td>
608
+ <pre class="code"><span class="info file"># File 'lib/ae_easy/router/plugin/router.rb', line 42</span>
609
+
610
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span> <span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
611
+ <span class='id identifier rubyid_initialize_hooks'>initialize_hooks</span> <span class='id identifier rubyid_opts'>opts</span>
612
+ <span class='kw'>end</span></pre>
613
+ </td>
614
+ </tr>
615
+ </table>
616
+ </div>
617
+
618
+ <div class="method_details ">
619
+ <h3 class="signature " id="initialize_hook_router_plugin_router-instance_method">
620
+
621
+ #<strong>initialize_hook_router_plugin_router</strong>(opts = {}) &#x21d2; <tt>Object</tt>
622
+
623
+
624
+
625
+
626
+
627
+ </h3><div class="docstring">
628
+ <div class="discussion">
629
+
630
+ <div class="note notetag">
631
+ <strong>Note:</strong>
632
+ <div class='inline'>
633
+ <p>`<a href=":config">opts</a>` will be prioritize over `<a
634
+ href=":config_file_path">opts</a>` and `<a href=":force">opts</a>`.</p>
635
+ </div>
636
+ </div>
637
+
638
+
639
+ <p>Hook to initialize router configuration.</p>
640
+
641
+
642
+ </div>
643
+ </div>
644
+ <div class="tags">
645
+ <p class="tag_title">Parameters:</p>
646
+ <ul class="param">
647
+
648
+ <li>
649
+
650
+ <span class='name'>opts</span>
651
+
652
+
653
+ <span class='type'>(<tt>Hash</tt>)</span>
654
+
655
+
656
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
657
+
658
+
659
+ &mdash;
660
+ <div class='inline'>
661
+ <p>({}) Configuration options.</p>
662
+ </div>
663
+
664
+ </li>
665
+
666
+ </ul>
667
+
668
+
669
+
670
+
671
+ <p class="tag_title">Options Hash (<tt>opts</tt>):</p>
672
+ <ul class="option">
673
+
674
+ <li>
675
+ <span class="name">:config</span>
676
+ <span class="type">(<tt>AeEasy::Config::Local</tt>, <tt>nil</tt>)</span>
677
+ <span class="default">
678
+
679
+ &mdash; default:
680
+ <tt>nil</tt>
681
+
682
+ </span>
683
+
684
+ &mdash; <div class='inline'>
685
+ <p>Configuration to use.</p>
686
+ </div>
687
+
688
+ </li>
689
+
690
+ <li>
691
+ <span class="name">:config_file_path</span>
692
+ <span class="type">(<tt>String</tt>)</span>
693
+ <span class="default">
694
+
695
+ &mdash; default:
696
+ <tt>nil</tt>
697
+
698
+ </span>
699
+
700
+ &mdash; <div class='inline'>
701
+ <p>Configuration file to load when no <code>:config</code> was provided (see
702
+ AeEasy::Core::Config#file_path for default file).</p>
703
+ </div>
704
+
705
+ </li>
706
+
707
+ <li>
708
+ <span class="name">:force</span>
709
+ <span class="type">(<tt>Boolean</tt>)</span>
710
+ <span class="default">
711
+
712
+ &mdash; default:
713
+ <tt>false</tt>
714
+
715
+ </span>
716
+
717
+ &mdash; <div class='inline'>
718
+ <p>Will reload configuration file when `true`.</p>
719
+ </div>
720
+
721
+ </li>
722
+
723
+ </ul>
724
+
725
+
726
+
727
+ </div><table class="source_code">
728
+ <tr>
729
+ <td>
730
+ <pre class="lines">
731
+
732
+
733
+ 24
734
+ 25
735
+ 26
736
+ 27
737
+ 28
738
+ 29
739
+ 30
740
+ 31
741
+ 32
742
+ 33
743
+ 34
744
+ 35</pre>
745
+ </td>
746
+ <td>
747
+ <pre class="code"><span class="info file"># File 'lib/ae_easy/router/plugin/router.rb', line 24</span>
748
+
749
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize_hook_router_plugin_router'>initialize_hook_router_plugin_router</span> <span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
750
+ <span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span>
751
+ <span class='label'>config:</span> <span class='kw'>nil</span><span class='comma'>,</span>
752
+ <span class='label'>config_file_path:</span> <span class='kw'>nil</span><span class='comma'>,</span>
753
+ <span class='label'>force:</span> <span class='kw'>false</span>
754
+ <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span> <span class='id identifier rubyid_opts'>opts</span>
755
+ <span class='ivar'>@local_config</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:config</span><span class='rbracket'>]</span>
756
+ <span class='ivar'>@local_config</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../../../AeEasy.html" title="AeEasy (module)">AeEasy</a></span></span><span class='op'>::</span><span class='const'>Config</span><span class='op'>::</span><span class='const'>Local</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span>
757
+ <span class='label'>file_path:</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:config_file_path</span><span class='rbracket'>]</span><span class='comma'>,</span>
758
+ <span class='label'>force:</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:force</span><span class='rbracket'>]</span>
759
+ <span class='rparen'>)</span>
760
+ <span class='kw'>end</span></pre>
761
+ </td>
762
+ </tr>
763
+ </table>
764
+ </div>
765
+
766
+ </div>
767
+
768
+ </div>
769
+
770
+ <div id="footer">
771
+ Generated on Tue Feb 26 17:02:32 2019 by
772
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
773
+ 0.9.18 (ruby-2.5.3).
774
+ </div>
775
+
776
+ </div>
777
+ </body>
778
+ </html>