dh_easy-core 0.2.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (79) 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 +20 -0
  9. data/Rakefile +22 -0
  10. data/dh_easy-core.gemspec +50 -0
  11. data/doc/DhEasy.html +117 -0
  12. data/doc/DhEasy/Core.html +1590 -0
  13. data/doc/DhEasy/Core/Config.html +311 -0
  14. data/doc/DhEasy/Core/Exception.html +117 -0
  15. data/doc/DhEasy/Core/Exception/OutdatedError.html +135 -0
  16. data/doc/DhEasy/Core/Helper.html +117 -0
  17. data/doc/DhEasy/Core/Helper/Cookie.html +1070 -0
  18. data/doc/DhEasy/Core/Mock.html +282 -0
  19. data/doc/DhEasy/Core/Mock/FakeDb.html +3779 -0
  20. data/doc/DhEasy/Core/Mock/FakeExecutor.html +3289 -0
  21. data/doc/DhEasy/Core/Mock/FakeFinisher.html +160 -0
  22. data/doc/DhEasy/Core/Mock/FakeParser.html +160 -0
  23. data/doc/DhEasy/Core/Mock/FakeSeeder.html +160 -0
  24. data/doc/DhEasy/Core/Plugin.html +117 -0
  25. data/doc/DhEasy/Core/Plugin/CollectionVault.html +299 -0
  26. data/doc/DhEasy/Core/Plugin/ConfigBehavior.html +541 -0
  27. data/doc/DhEasy/Core/Plugin/ContextIntegrator.html +445 -0
  28. data/doc/DhEasy/Core/Plugin/Executor.html +259 -0
  29. data/doc/DhEasy/Core/Plugin/ExecutorBehavior.html +344 -0
  30. data/doc/DhEasy/Core/Plugin/Finisher.html +265 -0
  31. data/doc/DhEasy/Core/Plugin/FinisherBehavior.html +142 -0
  32. data/doc/DhEasy/Core/Plugin/InitializeHook.html +220 -0
  33. data/doc/DhEasy/Core/Plugin/Parser.html +270 -0
  34. data/doc/DhEasy/Core/Plugin/ParserBehavior.html +235 -0
  35. data/doc/DhEasy/Core/Plugin/Seeder.html +674 -0
  36. data/doc/DhEasy/Core/Plugin/SeederBehavior.html +142 -0
  37. data/doc/DhEasy/Core/SmartCollection.html +1087 -0
  38. data/doc/_index.html +364 -0
  39. data/doc/class_list.html +51 -0
  40. data/doc/css/common.css +1 -0
  41. data/doc/css/full_list.css +58 -0
  42. data/doc/css/style.css +496 -0
  43. data/doc/file.README.html +91 -0
  44. data/doc/file_list.html +56 -0
  45. data/doc/frames.html +17 -0
  46. data/doc/index.html +91 -0
  47. data/doc/js/app.js +303 -0
  48. data/doc/js/full_list.js +216 -0
  49. data/doc/js/jquery.js +4 -0
  50. data/doc/method_list.html +939 -0
  51. data/doc/top-level-namespace.html +110 -0
  52. data/lib/dh_easy/core.rb +257 -0
  53. data/lib/dh_easy/core/config.rb +27 -0
  54. data/lib/dh_easy/core/exception.rb +8 -0
  55. data/lib/dh_easy/core/exception/outdated_error.rb +9 -0
  56. data/lib/dh_easy/core/helper.rb +8 -0
  57. data/lib/dh_easy/core/helper/cookie.rb +209 -0
  58. data/lib/dh_easy/core/mock.rb +45 -0
  59. data/lib/dh_easy/core/mock/fake_db.rb +561 -0
  60. data/lib/dh_easy/core/mock/fake_executor.rb +373 -0
  61. data/lib/dh_easy/core/mock/fake_finisher.rb +28 -0
  62. data/lib/dh_easy/core/mock/fake_parser.rb +33 -0
  63. data/lib/dh_easy/core/mock/fake_seeder.rb +28 -0
  64. data/lib/dh_easy/core/plugin.rb +19 -0
  65. data/lib/dh_easy/core/plugin/collection_vault.rb +23 -0
  66. data/lib/dh_easy/core/plugin/config_behavior.rb +43 -0
  67. data/lib/dh_easy/core/plugin/context_integrator.rb +60 -0
  68. data/lib/dh_easy/core/plugin/executor.rb +19 -0
  69. data/lib/dh_easy/core/plugin/executor_behavior.rb +32 -0
  70. data/lib/dh_easy/core/plugin/finisher.rb +19 -0
  71. data/lib/dh_easy/core/plugin/finisher_behavior.rb +9 -0
  72. data/lib/dh_easy/core/plugin/initialize_hook.rb +17 -0
  73. data/lib/dh_easy/core/plugin/parser.rb +19 -0
  74. data/lib/dh_easy/core/plugin/parser_behavior.rb +17 -0
  75. data/lib/dh_easy/core/plugin/seeder.rb +44 -0
  76. data/lib/dh_easy/core/plugin/seeder_behavior.rb +9 -0
  77. data/lib/dh_easy/core/smart_collection.rb +236 -0
  78. data/lib/dh_easy/core/version.rb +6 -0
  79. metadata +249 -0
data/doc/DhEasy/Core/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: DhEasy::Core::Plugin
8
+
9
+ &mdash; Documentation by YARD 0.9.20
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 = "DhEasy::Core::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="../../DhEasy.html" title="DhEasy (module)">DhEasy</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Core.html" title="DhEasy::Core (module)">Core</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: DhEasy::Core::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/dh_easy/core/plugin.rb<span class="defines">,<br />
82
+ lib/dh_easy/core/plugin/parser.rb,<br /> lib/dh_easy/core/plugin/seeder.rb,<br /> lib/dh_easy/core/plugin/executor.rb,<br /> lib/dh_easy/core/plugin/finisher.rb,<br /> lib/dh_easy/core/plugin/config_behavior.rb,<br /> lib/dh_easy/core/plugin/initialize_hook.rb,<br /> lib/dh_easy/core/plugin/parser_behavior.rb,<br /> lib/dh_easy/core/plugin/seeder_behavior.rb,<br /> lib/dh_easy/core/plugin/collection_vault.rb,<br /> lib/dh_easy/core/plugin/executor_behavior.rb,<br /> lib/dh_easy/core/plugin/finisher_behavior.rb,<br /> lib/dh_easy/core/plugin/context_integrator.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/CollectionVault.html" title="DhEasy::Core::Plugin::CollectionVault (module)">CollectionVault</a></span>, <span class='object_link'><a href="Plugin/ConfigBehavior.html" title="DhEasy::Core::Plugin::ConfigBehavior (module)">ConfigBehavior</a></span>, <span class='object_link'><a href="Plugin/ContextIntegrator.html" title="DhEasy::Core::Plugin::ContextIntegrator (module)">ContextIntegrator</a></span>, <span class='object_link'><a href="Plugin/Executor.html" title="DhEasy::Core::Plugin::Executor (module)">Executor</a></span>, <span class='object_link'><a href="Plugin/ExecutorBehavior.html" title="DhEasy::Core::Plugin::ExecutorBehavior (module)">ExecutorBehavior</a></span>, <span class='object_link'><a href="Plugin/Finisher.html" title="DhEasy::Core::Plugin::Finisher (module)">Finisher</a></span>, <span class='object_link'><a href="Plugin/FinisherBehavior.html" title="DhEasy::Core::Plugin::FinisherBehavior (module)">FinisherBehavior</a></span>, <span class='object_link'><a href="Plugin/InitializeHook.html" title="DhEasy::Core::Plugin::InitializeHook (module)">InitializeHook</a></span>, <span class='object_link'><a href="Plugin/Parser.html" title="DhEasy::Core::Plugin::Parser (module)">Parser</a></span>, <span class='object_link'><a href="Plugin/ParserBehavior.html" title="DhEasy::Core::Plugin::ParserBehavior (module)">ParserBehavior</a></span>, <span class='object_link'><a href="Plugin/Seeder.html" title="DhEasy::Core::Plugin::Seeder (module)">Seeder</a></span>, <span class='object_link'><a href="Plugin/SeederBehavior.html" title="DhEasy::Core::Plugin::SeederBehavior (module)">SeederBehavior</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 Wed Dec 4 23:00:02 2019 by
111
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
112
+ 0.9.20 (ruby-2.5.3).
113
+ </div>
114
+
115
+ </div>
116
+ </body>
117
+ </html>
data/doc/DhEasy/Core/Plugin/CollectionVault.html ADDED
@@ -0,0 +1,299 @@
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: DhEasy::Core::Plugin::CollectionVault
8
+
9
+ &mdash; Documentation by YARD 0.9.20
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 = "DhEasy::Core::Plugin::CollectionVault";
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 (C)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../../../DhEasy.html" title="DhEasy (module)">DhEasy</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Core.html" title="DhEasy::Core (module)">Core</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Plugin.html" title="DhEasy::Core::Plugin (module)">Plugin</a></span></span>
41
+ &raquo;
42
+ <span class="title">CollectionVault</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: DhEasy::Core::Plugin::CollectionVault
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+
70
+
71
+
72
+
73
+
74
+
75
+
76
+
77
+ <dl>
78
+ <dt>Included in:</dt>
79
+ <dd><span class='object_link'><a href="ConfigBehavior.html" title="DhEasy::Core::Plugin::ConfigBehavior (module)">ConfigBehavior</a></span></dd>
80
+ </dl>
81
+
82
+
83
+
84
+ <dl>
85
+ <dt>Defined in:</dt>
86
+ <dd>lib/dh_easy/core/plugin/collection_vault.rb</dd>
87
+ </dl>
88
+
89
+ </div>
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+
98
+
99
+ <h2>
100
+ Instance Method Summary
101
+ <small><a href="#" class="summary_toggle">collapse</a></small>
102
+ </h2>
103
+
104
+ <ul class="summary">
105
+
106
+ <li class="public ">
107
+ <span class="summary_signature">
108
+
109
+ <a href="#add_collection-instance_method" title="#add_collection (instance method)">#<strong>add_collection</strong>(key, name) &#x21d2; Object </a>
110
+
111
+
112
+
113
+ </span>
114
+
115
+
116
+
117
+
118
+
119
+
120
+
121
+
122
+
123
+ <span class="summary_desc"><div class='inline'>
124
+ <p>Add a new collection.</p>
125
+ </div></span>
126
+
127
+ </li>
128
+
129
+
130
+ <li class="public ">
131
+ <span class="summary_signature">
132
+
133
+ <a href="#collections-instance_method" title="#collections (instance method)">#<strong>collections</strong> &#x21d2; Object </a>
134
+
135
+
136
+
137
+ </span>
138
+
139
+
140
+
141
+
142
+
143
+
144
+
145
+
146
+
147
+ <span class="summary_desc"><div class='inline'>
148
+ <p>Stored collections info as hash.</p>
149
+ </div></span>
150
+
151
+ </li>
152
+
153
+
154
+ </ul>
155
+
156
+
157
+
158
+
159
+ <div id="instance_method_details" class="method_details_list">
160
+ <h2>Instance Method Details</h2>
161
+
162
+
163
+ <div class="method_details first">
164
+ <h3 class="signature first" id="add_collection-instance_method">
165
+
166
+ #<strong>add_collection</strong>(key, name) &#x21d2; <tt>Object</tt>
167
+
168
+
169
+
170
+
171
+
172
+ </h3><div class="docstring">
173
+ <div class="discussion">
174
+
175
+ <p>Add a new collection</p>
176
+
177
+
178
+ </div>
179
+ </div>
180
+ <div class="tags">
181
+ <p class="tag_title">Parameters:</p>
182
+ <ul class="param">
183
+
184
+ <li>
185
+
186
+ <span class='name'>key</span>
187
+
188
+
189
+ <span class='type'>(<tt>Symbol</tt>)</span>
190
+
191
+
192
+
193
+ &mdash;
194
+ <div class='inline'>
195
+ <p>Collection key used to lookup for collection name.</p>
196
+ </div>
197
+
198
+ </li>
199
+
200
+ <li>
201
+
202
+ <span class='name'>name</span>
203
+
204
+
205
+ <span class='type'>(<tt>String</tt>)</span>
206
+
207
+
208
+
209
+ &mdash;
210
+ <div class='inline'>
211
+ <p>Collection name used on outputs.</p>
212
+ </div>
213
+
214
+ </li>
215
+
216
+ </ul>
217
+
218
+
219
+ </div><table class="source_code">
220
+ <tr>
221
+ <td>
222
+ <pre class="lines">
223
+
224
+
225
+ 14
226
+ 15
227
+ 16
228
+ 17
229
+ 18
230
+ 19</pre>
231
+ </td>
232
+ <td>
233
+ <pre class="code"><span class="info file"># File 'lib/dh_easy/core/plugin/collection_vault.rb', line 14</span>
234
+
235
+ <span class='kw'>def</span> <span class='id identifier rubyid_add_collection'>add_collection</span> <span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_name'>name</span>
236
+ <span class='kw'>if</span> <span class='id identifier rubyid_collections'>collections</span><span class='period'>.</span><span class='id identifier rubyid_has_key?'>has_key?</span> <span class='id identifier rubyid_key'>key</span>
237
+ <span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Can&#39;t add \&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_key'>key</span><span class='embexpr_end'>}</span><span class='tstring_content'>\&quot; collection, it already exists!</span><span class='tstring_end'>&quot;</span></span>
238
+ <span class='kw'>end</span>
239
+ <span class='id identifier rubyid_collections'>collections</span><span class='lbracket'>[</span><span class='id identifier rubyid_key'>key</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_name'>name</span>
240
+ <span class='kw'>end</span></pre>
241
+ </td>
242
+ </tr>
243
+ </table>
244
+ </div>
245
+
246
+ <div class="method_details ">
247
+ <h3 class="signature " id="collections-instance_method">
248
+
249
+ #<strong>collections</strong> &#x21d2; <tt>Object</tt>
250
+
251
+
252
+
253
+
254
+
255
+ </h3><div class="docstring">
256
+ <div class="discussion">
257
+
258
+ <p>Stored collections info as hash.</p>
259
+
260
+
261
+ </div>
262
+ </div>
263
+ <div class="tags">
264
+
265
+
266
+ </div><table class="source_code">
267
+ <tr>
268
+ <td>
269
+ <pre class="lines">
270
+
271
+
272
+ 6
273
+ 7
274
+ 8</pre>
275
+ </td>
276
+ <td>
277
+ <pre class="code"><span class="info file"># File 'lib/dh_easy/core/plugin/collection_vault.rb', line 6</span>
278
+
279
+ <span class='kw'>def</span> <span class='id identifier rubyid_collections'>collections</span>
280
+ <span class='ivar'>@collections</span> <span class='op'>||=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
281
+ <span class='kw'>end</span></pre>
282
+ </td>
283
+ </tr>
284
+ </table>
285
+ </div>
286
+
287
+ </div>
288
+
289
+ </div>
290
+
291
+ <div id="footer">
292
+ Generated on Wed Dec 4 23:00:02 2019 by
293
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
294
+ 0.9.20 (ruby-2.5.3).
295
+ </div>
296
+
297
+ </div>
298
+ </body>
299
+ </html>
data/doc/DhEasy/Core/Plugin/ConfigBehavior.html ADDED
@@ -0,0 +1,541 @@
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: DhEasy::Core::Plugin::ConfigBehavior
8
+
9
+ &mdash; Documentation by YARD 0.9.20
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 = "DhEasy::Core::Plugin::ConfigBehavior";
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 (C)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../../../DhEasy.html" title="DhEasy (module)">DhEasy</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Core.html" title="DhEasy::Core (module)">Core</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Plugin.html" title="DhEasy::Core::Plugin (module)">Plugin</a></span></span>
41
+ &raquo;
42
+ <span class="title">ConfigBehavior</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: DhEasy::Core::Plugin::ConfigBehavior
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+
70
+
71
+
72
+
73
+
74
+ <dl>
75
+ <dt>Includes:</dt>
76
+ <dd><span class='object_link'><a href="CollectionVault.html" title="DhEasy::Core::Plugin::CollectionVault (module)">CollectionVault</a></span>, <span class='object_link'><a href="ContextIntegrator.html" title="DhEasy::Core::Plugin::ContextIntegrator (module)">ContextIntegrator</a></span></dd>
77
+ </dl>
78
+
79
+
80
+
81
+
82
+ <dl>
83
+ <dt>Included in:</dt>
84
+ <dd><span class='object_link'><a href="../Config.html" title="DhEasy::Core::Config (class)">Config</a></span></dd>
85
+ </dl>
86
+
87
+
88
+
89
+ <dl>
90
+ <dt>Defined in:</dt>
91
+ <dd>lib/dh_easy/core/plugin/config_behavior.rb</dd>
92
+ </dl>
93
+
94
+ </div>
95
+
96
+
97
+
98
+
99
+
100
+ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
101
+ <ul class="summary">
102
+
103
+ <li class="public ">
104
+ <span class="summary_signature">
105
+
106
+ <a href="#config_collection_key-instance_method" title="#config_collection_key (instance method)">#<strong>config_collection_key</strong> &#x21d2; Object </a>
107
+
108
+
109
+
110
+ </span>
111
+
112
+
113
+
114
+
115
+ <span class="note title readonly">readonly</span>
116
+
117
+
118
+
119
+
120
+
121
+
122
+
123
+
124
+
125
+ <span class="summary_desc"><div class='inline'>
126
+ <p>Returns the value of attribute config_collection_key.</p>
127
+ </div></span>
128
+
129
+ </li>
130
+
131
+
132
+ </ul>
133
+
134
+
135
+
136
+
137
+
138
+ <h3 class="inherited">Attributes included from <span class='object_link'><a href="ContextIntegrator.html" title="DhEasy::Core::Plugin::ContextIntegrator (module)">ContextIntegrator</a></span></h3>
139
+ <p class="inherited"><span class='object_link'><a href="ContextIntegrator.html#context-instance_method" title="DhEasy::Core::Plugin::ContextIntegrator#context (method)">#context</a></span></p>
140
+
141
+
142
+
143
+ <h2>
144
+ Instance Method Summary
145
+ <small><a href="#" class="summary_toggle">collapse</a></small>
146
+ </h2>
147
+
148
+ <ul class="summary">
149
+
150
+ <li class="public ">
151
+ <span class="summary_signature">
152
+
153
+ <a href="#config_collection-instance_method" title="#config_collection (instance method)">#<strong>config_collection</strong> &#x21d2; String </a>
154
+
155
+
156
+
157
+ </span>
158
+
159
+
160
+
161
+
162
+
163
+
164
+
165
+
166
+
167
+ <span class="summary_desc"><div class='inline'>
168
+ <p>Get config collection name.</p>
169
+ </div></span>
170
+
171
+ </li>
172
+
173
+
174
+ <li class="public ">
175
+ <span class="summary_signature">
176
+
177
+ <a href="#find_config-instance_method" title="#find_config (instance method)">#<strong>find_config</strong>(key) &#x21d2; Object </a>
178
+
179
+
180
+
181
+ </span>
182
+
183
+
184
+
185
+
186
+
187
+
188
+
189
+
190
+
191
+ <span class="summary_desc"><div class='inline'>
192
+ <p>Find a configuration value by item key.</p>
193
+ </div></span>
194
+
195
+ </li>
196
+
197
+
198
+ <li class="public ">
199
+ <span class="summary_signature">
200
+
201
+ <a href="#initialize_hook_core_config_behavior-instance_method" title="#initialize_hook_core_config_behavior (instance method)">#<strong>initialize_hook_core_config_behavior</strong>(opts = {}) &#x21d2; Object </a>
202
+
203
+
204
+
205
+ </span>
206
+
207
+
208
+
209
+
210
+
211
+
212
+
213
+
214
+
215
+ <span class="summary_desc"><div class='inline'>
216
+ <p>Hook to map config behavior on self.</p>
217
+ </div></span>
218
+
219
+ </li>
220
+
221
+
222
+ </ul>
223
+
224
+
225
+
226
+
227
+
228
+
229
+
230
+
231
+
232
+
233
+
234
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="CollectionVault.html" title="DhEasy::Core::Plugin::CollectionVault (module)">CollectionVault</a></span></h3>
235
+ <p class="inherited"><span class='object_link'><a href="CollectionVault.html#add_collection-instance_method" title="DhEasy::Core::Plugin::CollectionVault#add_collection (method)">#add_collection</a></span>, <span class='object_link'><a href="CollectionVault.html#collections-instance_method" title="DhEasy::Core::Plugin::CollectionVault#collections (method)">#collections</a></span></p>
236
+
237
+
238
+
239
+
240
+
241
+
242
+
243
+
244
+
245
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="ContextIntegrator.html" title="DhEasy::Core::Plugin::ContextIntegrator (module)">ContextIntegrator</a></span></h3>
246
+ <p class="inherited"><span class='object_link'><a href="ContextIntegrator.html#initialize_hook_core_context_integrator-instance_method" title="DhEasy::Core::Plugin::ContextIntegrator#initialize_hook_core_context_integrator (method)">#initialize_hook_core_context_integrator</a></span>, <span class='object_link'><a href="ContextIntegrator.html#mock_context-instance_method" title="DhEasy::Core::Plugin::ContextIntegrator#mock_context (method)">#mock_context</a></span></p>
247
+
248
+ <div id="instance_attr_details" class="attr_details">
249
+ <h2>Instance Attribute Details</h2>
250
+
251
+
252
+ <span id=""></span>
253
+ <div class="method_details first">
254
+ <h3 class="signature first" id="config_collection_key-instance_method">
255
+
256
+ #<strong>config_collection_key</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
257
+
258
+
259
+
260
+
261
+
262
+ </h3><div class="docstring">
263
+ <div class="discussion">
264
+
265
+ <p>Returns the value of attribute config_collection_key</p>
266
+
267
+
268
+ </div>
269
+ </div>
270
+ <div class="tags">
271
+
272
+
273
+ </div><table class="source_code">
274
+ <tr>
275
+ <td>
276
+ <pre class="lines">
277
+
278
+
279
+ 8
280
+ 9
281
+ 10</pre>
282
+ </td>
283
+ <td>
284
+ <pre class="code"><span class="info file"># File 'lib/dh_easy/core/plugin/config_behavior.rb', line 8</span>
285
+
286
+ <span class='kw'>def</span> <span class='id identifier rubyid_config_collection_key'>config_collection_key</span>
287
+ <span class='ivar'>@config_collection_key</span>
288
+ <span class='kw'>end</span></pre>
289
+ </td>
290
+ </tr>
291
+ </table>
292
+ </div>
293
+
294
+ </div>
295
+
296
+
297
+ <div id="instance_method_details" class="method_details_list">
298
+ <h2>Instance Method Details</h2>
299
+
300
+
301
+ <div class="method_details first">
302
+ <h3 class="signature first" id="config_collection-instance_method">
303
+
304
+ #<strong>config_collection</strong> &#x21d2; <tt>String</tt>
305
+
306
+
307
+
308
+
309
+
310
+ </h3><div class="docstring">
311
+ <div class="discussion">
312
+
313
+ <p>Get config collection name.</p>
314
+
315
+
316
+ </div>
317
+ </div>
318
+ <div class="tags">
319
+
320
+ <p class="tag_title">Returns:</p>
321
+ <ul class="return">
322
+
323
+ <li>
324
+
325
+
326
+ <span class='type'>(<tt>String</tt>)</span>
327
+
328
+
329
+
330
+ </li>
331
+
332
+ </ul>
333
+
334
+ </div><table class="source_code">
335
+ <tr>
336
+ <td>
337
+ <pre class="lines">
338
+
339
+
340
+ 26
341
+ 27
342
+ 28</pre>
343
+ </td>
344
+ <td>
345
+ <pre class="code"><span class="info file"># File 'lib/dh_easy/core/plugin/config_behavior.rb', line 26</span>
346
+
347
+ <span class='kw'>def</span> <span class='id identifier rubyid_config_collection'>config_collection</span>
348
+ <span class='id identifier rubyid_collections'>collections</span><span class='lbracket'>[</span><span class='id identifier rubyid_config_collection_key'>config_collection_key</span><span class='rbracket'>]</span>
349
+ <span class='kw'>end</span></pre>
350
+ </td>
351
+ </tr>
352
+ </table>
353
+ </div>
354
+
355
+ <div class="method_details ">
356
+ <h3 class="signature " id="find_config-instance_method">
357
+
358
+ #<strong>find_config</strong>(key) &#x21d2; <tt>Object</tt>
359
+
360
+
361
+
362
+
363
+
364
+ </h3><div class="docstring">
365
+ <div class="discussion">
366
+
367
+ <div class="note notetag">
368
+ <strong>Note:</strong>
369
+ <div class='inline'>
370
+ <p>Instance must implement:</p>
371
+ <ul><li>
372
+ <p>`find_output(collection, query)`</p>
373
+ </li></ul>
374
+ </div>
375
+ </div>
376
+
377
+
378
+ <p>Find a configuration value by item key.</p>
379
+
380
+
381
+ </div>
382
+ </div>
383
+ <div class="tags">
384
+ <p class="tag_title">Parameters:</p>
385
+ <ul class="param">
386
+
387
+ <li>
388
+
389
+ <span class='name'>key</span>
390
+
391
+
392
+ <span class='type'>(<tt>Symbol</tt>)</span>
393
+
394
+
395
+
396
+ &mdash;
397
+ <div class='inline'>
398
+ <p>Item key to find.</p>
399
+ </div>
400
+
401
+ </li>
402
+
403
+ </ul>
404
+
405
+
406
+ </div><table class="source_code">
407
+ <tr>
408
+ <td>
409
+ <pre class="lines">
410
+
411
+
412
+ 36
413
+ 37
414
+ 38
415
+ 39</pre>
416
+ </td>
417
+ <td>
418
+ <pre class="code"><span class="info file"># File 'lib/dh_easy/core/plugin/config_behavior.rb', line 36</span>
419
+
420
+ <span class='kw'>def</span> <span class='id identifier rubyid_find_config'>find_config</span> <span class='id identifier rubyid_key'>key</span>
421
+ <span class='id identifier rubyid_value'>value</span> <span class='op'>=</span> <span class='id identifier rubyid_find_output'>find_output</span> <span class='id identifier rubyid_config_collection'>config_collection</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>_id</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_key'>key</span>
422
+ <span class='id identifier rubyid_value'>value</span> <span class='op'>||=</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>_collection</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_config_collection'>config_collection</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>_id</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_key'>key</span><span class='rbrace'>}</span>
423
+ <span class='kw'>end</span></pre>
424
+ </td>
425
+ </tr>
426
+ </table>
427
+ </div>
428
+
429
+ <div class="method_details ">
430
+ <h3 class="signature " id="initialize_hook_core_config_behavior-instance_method">
431
+
432
+ #<strong>initialize_hook_core_config_behavior</strong>(opts = {}) &#x21d2; <tt>Object</tt>
433
+
434
+
435
+
436
+
437
+
438
+ </h3><div class="docstring">
439
+ <div class="discussion">
440
+
441
+ <p>Hook to map config behavior on self</p>
442
+
443
+
444
+ </div>
445
+ </div>
446
+ <div class="tags">
447
+
448
+ <div class="examples">
449
+ <p class="tag_title">Examples:</p>
450
+
451
+
452
+ <pre class="example code"><code><span class='id identifier rubyid_initialize_hook_core_config_behavior'>initialize_hook_core_config_behavior</span> <span class='label'>config_collection:</span> <span class='lbracket'>[</span><span class='symbol'>:my_config</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>abc</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
453
+ <span class='id identifier rubyid_config_collection'>config_collection</span>
454
+ <span class='comment'># =&gt; &#39;abc&#39;</span></code></pre>
455
+
456
+ </div>
457
+ <p class="tag_title">Parameters:</p>
458
+ <ul class="param">
459
+
460
+ <li>
461
+
462
+ <span class='name'>opts</span>
463
+
464
+
465
+ <span class='type'>(<tt>Hash</tt>)</span>
466
+
467
+
468
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
469
+
470
+
471
+ &mdash;
472
+ <div class='inline'>
473
+ <p>({}) Configuration options.</p>
474
+ </div>
475
+
476
+ </li>
477
+
478
+ </ul>
479
+
480
+
481
+
482
+
483
+ <p class="tag_title">Options Hash (<tt>opts</tt>):</p>
484
+ <ul class="option">
485
+
486
+ <li>
487
+ <span class="name">:config_collection</span>
488
+ <span class="type">(<tt>Array</tt>)</span>
489
+ <span class="default">
490
+
491
+ &mdash; default:
492
+ <tt>[:config</tt>, <tt>&#39;config&#39;]</tt>
493
+
494
+ </span>
495
+
496
+ &mdash; <div class='inline'>
497
+ <p>Key value pair array to se a custom collection.</p>
498
+ </div>
499
+
500
+ </li>
501
+
502
+ </ul>
503
+
504
+
505
+
506
+ </div><table class="source_code">
507
+ <tr>
508
+ <td>
509
+ <pre class="lines">
510
+
511
+
512
+ 19
513
+ 20
514
+ 21
515
+ 22</pre>
516
+ </td>
517
+ <td>
518
+ <pre class="code"><span class="info file"># File 'lib/dh_easy/core/plugin/config_behavior.rb', line 19</span>
519
+
520
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize_hook_core_config_behavior'>initialize_hook_core_config_behavior</span> <span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
521
+ <span class='ivar'>@config_collection_key</span><span class='comma'>,</span> <span class='id identifier rubyid_collection'>collection</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:config_collection</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='lbracket'>[</span><span class='symbol'>:config</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>config</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
522
+ <span class='id identifier rubyid_add_collection'>add_collection</span> <span class='id identifier rubyid_config_collection_key'>config_collection_key</span><span class='comma'>,</span> <span class='id identifier rubyid_collection'>collection</span>
523
+ <span class='kw'>end</span></pre>
524
+ </td>
525
+ </tr>
526
+ </table>
527
+ </div>
528
+
529
+ </div>
530
+
531
+ </div>
532
+
533
+ <div id="footer">
534
+ Generated on Wed Dec 4 23:00:02 2019 by
535
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
536
+ 0.9.20 (ruby-2.5.3).
537
+ </div>
538
+
539
+ </div>
540
+ </body>
541
+ </html>