servus 0.3.0 → 0.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/generators/servus/event/event_generator.rb +54 -0
- data/lib/generators/servus/event/templates/event.rb.erb +44 -0
- data/lib/generators/servus/event/templates/event_spec.rb.erb +20 -0
- data/lib/generators/servus/guard/guard_generator.rb +1 -1
- data/lib/generators/servus/guard/templates/guard.rb.erb +5 -3
- data/lib/generators/servus/service/service_generator.rb +1 -1
- data/lib/servus/base.rb +46 -3
- data/lib/servus/config.rb +85 -12
- data/lib/servus/event.rb +235 -0
- data/lib/servus/events/bus.rb +111 -72
- data/lib/servus/events/class_router.rb +40 -0
- data/lib/servus/events/emitter.rb +21 -6
- data/lib/servus/events/invocation.rb +94 -0
- data/lib/servus/events/router.rb +44 -0
- data/lib/servus/guard.rb +7 -6
- data/lib/servus/guards/falsey_guard.rb +3 -3
- data/lib/servus/guards/presence_guard.rb +4 -4
- data/lib/servus/guards/state_guard.rb +4 -5
- data/lib/servus/guards/truthy_guard.rb +3 -3
- data/lib/servus/helpers/controller_helpers.rb +40 -0
- data/lib/servus/railtie.rb +10 -8
- data/lib/servus/support/errors.rb +16 -0
- data/lib/servus/support/lockdown.rb +94 -0
- data/lib/servus/support/logger.rb +18 -0
- data/lib/servus/support/validator.rb +70 -40
- data/lib/servus/testing/example_builders.rb +52 -0
- data/lib/servus/testing/matchers.rb +103 -4
- data/lib/servus/version.rb +1 -1
- data/lib/servus.rb +7 -2
- metadata +14 -116
- data/.claude/commands/check-docs.md +0 -1
- data/.claude/commands/consistency-check.md +0 -1
- data/.claude/commands/fine-tooth-comb.md +0 -1
- data/.claude/commands/red-green-refactor.md +0 -5
- data/.claude/settings.json +0 -24
- data/.rspec +0 -3
- data/.rubocop.yml +0 -27
- data/.yardopts +0 -6
- data/CHANGELOG.md +0 -169
- data/CLAUDE.md +0 -10
- data/IDEAS.md +0 -5
- data/LICENSE.txt +0 -21
- data/READme.md +0 -856
- data/Rakefile +0 -45
- data/docs/core/1_overview.md +0 -81
- data/docs/core/2_architecture.md +0 -120
- data/docs/core/3_service_objects.md +0 -154
- data/docs/features/1_schema_validation.md +0 -161
- data/docs/features/2_error_handling.md +0 -129
- data/docs/features/3_async_execution.md +0 -81
- data/docs/features/4_logging.md +0 -64
- data/docs/features/5_event_bus.md +0 -244
- data/docs/features/6_guards.md +0 -356
- data/docs/features/7_lazy_resolvers.md +0 -238
- data/docs/features/guards_naming_convention.md +0 -540
- data/docs/guides/1_common_patterns.md +0 -90
- data/docs/guides/2_migration_guide.md +0 -225
- data/docs/integration/1_configuration.md +0 -154
- data/docs/integration/2_testing.md +0 -304
- data/docs/integration/3_rails_integration.md +0 -99
- data/docs/yard/Servus/Base.html +0 -1645
- data/docs/yard/Servus/Config.html +0 -582
- data/docs/yard/Servus/Extensions/Async/Call.html +0 -400
- data/docs/yard/Servus/Extensions/Async/Errors/AsyncError.html +0 -140
- data/docs/yard/Servus/Extensions/Async/Errors/JobEnqueueError.html +0 -154
- data/docs/yard/Servus/Extensions/Async/Errors/ServiceNotFoundError.html +0 -154
- data/docs/yard/Servus/Extensions/Async/Errors.html +0 -128
- data/docs/yard/Servus/Extensions/Async/Ext.html +0 -119
- data/docs/yard/Servus/Extensions/Async/Job.html +0 -310
- data/docs/yard/Servus/Extensions/Async.html +0 -141
- data/docs/yard/Servus/Extensions.html +0 -117
- data/docs/yard/Servus/Generators/ServiceGenerator.html +0 -261
- data/docs/yard/Servus/Generators.html +0 -115
- data/docs/yard/Servus/Helpers/ControllerHelpers.html +0 -457
- data/docs/yard/Servus/Helpers.html +0 -115
- data/docs/yard/Servus/Railtie.html +0 -134
- data/docs/yard/Servus/Support/Errors/AuthenticationError.html +0 -287
- data/docs/yard/Servus/Support/Errors/BadRequestError.html +0 -283
- data/docs/yard/Servus/Support/Errors/ForbiddenError.html +0 -284
- data/docs/yard/Servus/Support/Errors/InternalServerError.html +0 -283
- data/docs/yard/Servus/Support/Errors/NotFoundError.html +0 -284
- data/docs/yard/Servus/Support/Errors/ServiceError.html +0 -489
- data/docs/yard/Servus/Support/Errors/ServiceUnavailableError.html +0 -290
- data/docs/yard/Servus/Support/Errors/UnauthorizedError.html +0 -200
- data/docs/yard/Servus/Support/Errors/UnprocessableEntityError.html +0 -288
- data/docs/yard/Servus/Support/Errors/ValidationError.html +0 -200
- data/docs/yard/Servus/Support/Errors.html +0 -140
- data/docs/yard/Servus/Support/Logger.html +0 -856
- data/docs/yard/Servus/Support/Rescuer/BlockContext.html +0 -585
- data/docs/yard/Servus/Support/Rescuer/CallOverride.html +0 -257
- data/docs/yard/Servus/Support/Rescuer/ClassMethods.html +0 -343
- data/docs/yard/Servus/Support/Rescuer.html +0 -267
- data/docs/yard/Servus/Support/Response.html +0 -574
- data/docs/yard/Servus/Support/Validator.html +0 -1150
- data/docs/yard/Servus/Support.html +0 -119
- data/docs/yard/Servus/Testing/ExampleBuilders.html +0 -523
- data/docs/yard/Servus/Testing/ExampleExtractor.html +0 -578
- data/docs/yard/Servus/Testing.html +0 -142
- data/docs/yard/Servus.html +0 -343
- data/docs/yard/_index.html +0 -535
- data/docs/yard/class_list.html +0 -54
- data/docs/yard/css/common.css +0 -1
- data/docs/yard/css/full_list.css +0 -58
- data/docs/yard/css/style.css +0 -503
- data/docs/yard/file.1_common_patterns.html +0 -154
- data/docs/yard/file.1_configuration.html +0 -115
- data/docs/yard/file.1_overview.html +0 -142
- data/docs/yard/file.1_schema_validation.html +0 -188
- data/docs/yard/file.2_architecture.html +0 -157
- data/docs/yard/file.2_error_handling.html +0 -190
- data/docs/yard/file.2_migration_guide.html +0 -242
- data/docs/yard/file.2_testing.html +0 -227
- data/docs/yard/file.3_async_execution.html +0 -145
- data/docs/yard/file.3_rails_integration.html +0 -160
- data/docs/yard/file.3_service_objects.html +0 -191
- data/docs/yard/file.4_logging.html +0 -135
- data/docs/yard/file.ErrorHandling.html +0 -190
- data/docs/yard/file.READme.html +0 -674
- data/docs/yard/file.architecture.html +0 -157
- data/docs/yard/file.async_execution.html +0 -145
- data/docs/yard/file.common_patterns.html +0 -154
- data/docs/yard/file.configuration.html +0 -115
- data/docs/yard/file.error_handling.html +0 -190
- data/docs/yard/file.logging.html +0 -135
- data/docs/yard/file.migration_guide.html +0 -242
- data/docs/yard/file.overview.html +0 -142
- data/docs/yard/file.rails_integration.html +0 -160
- data/docs/yard/file.schema_validation.html +0 -188
- data/docs/yard/file.service_objects.html +0 -191
- data/docs/yard/file.testing.html +0 -227
- data/docs/yard/file_list.html +0 -119
- data/docs/yard/frames.html +0 -22
- data/docs/yard/index.html +0 -674
- data/docs/yard/js/app.js +0 -344
- data/docs/yard/js/full_list.js +0 -242
- data/docs/yard/js/jquery.js +0 -4
- data/docs/yard/method_list.html +0 -542
- data/docs/yard/top-level-namespace.html +0 -110
- data/lib/generators/servus/event_handler/event_handler_generator.rb +0 -59
- data/lib/generators/servus/event_handler/templates/handler.rb.erb +0 -86
- data/lib/generators/servus/event_handler/templates/handler_spec.rb.erb +0 -48
- data/lib/servus/event_handler.rb +0 -290
- data/lib/servus/events/errors.rb +0 -10
|
@@ -1,582 +0,0 @@
|
|
|
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: Servus::Config
|
|
8
|
-
|
|
9
|
-
— Servus | Service Object Framework
|
|
10
|
-
|
|
11
|
-
</title>
|
|
12
|
-
|
|
13
|
-
<link rel="stylesheet" href="../css/style.css" type="text/css" />
|
|
14
|
-
|
|
15
|
-
<link rel="stylesheet" href="../css/common.css" type="text/css" />
|
|
16
|
-
|
|
17
|
-
<script type="text/javascript">
|
|
18
|
-
pathId = "Servus::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?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> »
|
|
40
|
-
<span class='title'><span class='object_link'><a href="../Servus.html" title="Servus (module)">Servus</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
|
-
<div id="content"><h1>Class: Servus::Config
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
</h1>
|
|
67
|
-
<div class="box_info">
|
|
68
|
-
|
|
69
|
-
<dl>
|
|
70
|
-
<dt>Inherits:</dt>
|
|
71
|
-
<dd>
|
|
72
|
-
<span class="inheritName">Object</span>
|
|
73
|
-
|
|
74
|
-
<ul class="fullTree">
|
|
75
|
-
<li>Object</li>
|
|
76
|
-
|
|
77
|
-
<li class="next">Servus::Config</li>
|
|
78
|
-
|
|
79
|
-
</ul>
|
|
80
|
-
<a href="#" class="inheritanceTree">show all</a>
|
|
81
|
-
|
|
82
|
-
</dd>
|
|
83
|
-
</dl>
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
<dl>
|
|
96
|
-
<dt>Defined in:</dt>
|
|
97
|
-
<dd>lib/servus/config.rb</dd>
|
|
98
|
-
</dl>
|
|
99
|
-
|
|
100
|
-
</div>
|
|
101
|
-
|
|
102
|
-
<h2>Overview</h2><div class="docstring">
|
|
103
|
-
<div class="discussion">
|
|
104
|
-
<p>Configuration settings for the Servus gem.</p>
|
|
105
|
-
|
|
106
|
-
<p>Manages global configuration options including schema file locations.
|
|
107
|
-
Access the configuration via <span class='object_link'><a href="../Servus.html#config-class_method" title="Servus.config (method)">config</a></span> or modify via <span class='object_link'><a href="../Servus.html#configure-class_method" title="Servus.configure (method)">configure</a></span>.</p>
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
</div>
|
|
111
|
-
</div>
|
|
112
|
-
<div class="tags">
|
|
113
|
-
|
|
114
|
-
<div class="examples">
|
|
115
|
-
<h4 class="tag_title">Examples:</h4>
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
<h5 class="example_title"><div class='inline'><p>Customizing schema location</p>
|
|
119
|
-
</div></h5>
|
|
120
|
-
|
|
121
|
-
<pre class="example code"><code><span class='const'><span class='object_link'><a href="../Servus.html" title="Servus (module)">Servus</a></span></span><span class='period'>.</span><span class='id identifier rubyid_configure'><span class='object_link'><a href="../Servus.html#configure-class_method" title="Servus.configure (method)">configure</a></span></span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_config'>config</span><span class='op'>|</span>
|
|
122
|
-
<span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_schema_root'>schema_root</span> <span class='op'>=</span> <span class='const'>Rails</span><span class='period'>.</span><span class='id identifier rubyid_root'>root</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'>lib/schemas</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
123
|
-
<span class='kw'>end</span></code></pre>
|
|
124
|
-
|
|
125
|
-
</div>
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
<p class="tag_title">See Also:</p>
|
|
129
|
-
<ul class="see">
|
|
130
|
-
|
|
131
|
-
<li><span class='object_link'><a href="../Servus.html#config-class_method" title="Servus.config (method)">config</a></span></li>
|
|
132
|
-
|
|
133
|
-
<li><span class='object_link'><a href="../Servus.html#configure-class_method" title="Servus.configure (method)">configure</a></span></li>
|
|
134
|
-
|
|
135
|
-
</ul>
|
|
136
|
-
|
|
137
|
-
</div>
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
|
142
|
-
<ul class="summary">
|
|
143
|
-
|
|
144
|
-
<li class="public ">
|
|
145
|
-
<span class="summary_signature">
|
|
146
|
-
|
|
147
|
-
<a href="#schema_root-instance_method" title="#schema_root (instance method)">#<strong>schema_root</strong> ⇒ String </a>
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
</span>
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
<span class="note title readonly">readonly</span>
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
<span class="summary_desc"><div class='inline'><p>The root directory where schema files are located.</p>
|
|
167
|
-
</div></span>
|
|
168
|
-
|
|
169
|
-
</li>
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
</ul>
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
<h2>
|
|
179
|
-
Instance Method Summary
|
|
180
|
-
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
181
|
-
</h2>
|
|
182
|
-
|
|
183
|
-
<ul class="summary">
|
|
184
|
-
|
|
185
|
-
<li class="public ">
|
|
186
|
-
<span class="summary_signature">
|
|
187
|
-
|
|
188
|
-
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong> ⇒ Config </a>
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
</span>
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
<span class="note title constructor">constructor</span>
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
<span class="private note title">private</span>
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
<span class="summary_desc"><div class='inline'><p>Initializes a new configuration with default values.</p>
|
|
205
|
-
</div></span>
|
|
206
|
-
|
|
207
|
-
</li>
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
<li class="public ">
|
|
211
|
-
<span class="summary_signature">
|
|
212
|
-
|
|
213
|
-
<a href="#schema_dir_for-instance_method" title="#schema_dir_for (instance method)">#<strong>schema_dir_for</strong>(service_namespace) ⇒ String </a>
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
</span>
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
<span class="summary_desc"><div class='inline'><p>Returns the directory containing a service's schema files.</p>
|
|
228
|
-
</div></span>
|
|
229
|
-
|
|
230
|
-
</li>
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
<li class="public ">
|
|
234
|
-
<span class="summary_signature">
|
|
235
|
-
|
|
236
|
-
<a href="#schema_path_for-instance_method" title="#schema_path_for (instance method)">#<strong>schema_path_for</strong>(service_namespace, type) ⇒ String </a>
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
</span>
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
<span class="summary_desc"><div class='inline'><p>Returns the full path to a service's schema file.</p>
|
|
251
|
-
</div></span>
|
|
252
|
-
|
|
253
|
-
</li>
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
</ul>
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
<div id="constructor_details" class="method_details_list">
|
|
260
|
-
<h2>Constructor Details</h2>
|
|
261
|
-
|
|
262
|
-
<div class="method_details first">
|
|
263
|
-
<h3 class="signature first" id="initialize-instance_method">
|
|
264
|
-
|
|
265
|
-
#<strong>initialize</strong> ⇒ <tt><span class='object_link'><a href="" title="Servus::Config (class)">Config</a></span></tt>
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
</h3><div class="docstring">
|
|
272
|
-
<div class="discussion">
|
|
273
|
-
<p class="note private">
|
|
274
|
-
<strong>This method is part of a private API.</strong>
|
|
275
|
-
You should avoid using this method if possible, as it may be removed or be changed in the future.
|
|
276
|
-
</p>
|
|
277
|
-
<p>Initializes a new configuration with default values.</p>
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
</div>
|
|
281
|
-
</div>
|
|
282
|
-
<div class="tags">
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
</div><table class="source_code">
|
|
286
|
-
<tr>
|
|
287
|
-
<td>
|
|
288
|
-
<pre class="lines">
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
29
|
|
292
|
-
30
|
|
293
|
-
31
|
|
294
|
-
32</pre>
|
|
295
|
-
</td>
|
|
296
|
-
<td>
|
|
297
|
-
<pre class="code"><span class="info file"># File 'lib/servus/config.rb', line 29</span>
|
|
298
|
-
|
|
299
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
|
|
300
|
-
<span class='comment'># Default to Rails.root if available, otherwise use current working directory
|
|
301
|
-
</span> <span class='ivar'>@schema_root</span> <span class='op'>=</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='id identifier rubyid_root_path'>root_path</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>app/schemas/services</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
302
|
-
<span class='kw'>end</span></pre>
|
|
303
|
-
</td>
|
|
304
|
-
</tr>
|
|
305
|
-
</table>
|
|
306
|
-
</div>
|
|
307
|
-
|
|
308
|
-
</div>
|
|
309
|
-
|
|
310
|
-
<div id="instance_attr_details" class="attr_details">
|
|
311
|
-
<h2>Instance Attribute Details</h2>
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
<span id=""></span>
|
|
315
|
-
<div class="method_details first">
|
|
316
|
-
<h3 class="signature first" id="schema_root-instance_method">
|
|
317
|
-
|
|
318
|
-
#<strong>schema_root</strong> ⇒ <tt>String</tt> <span class="extras">(readonly)</span>
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
</h3><div class="docstring">
|
|
325
|
-
<div class="discussion">
|
|
326
|
-
<p>The root directory where schema files are located.</p>
|
|
327
|
-
|
|
328
|
-
<p>Defaults to <code>Rails.root/app/schemas/services</code> in Rails applications,
|
|
329
|
-
or a relative path from the gem installation otherwise.</p>
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
</div>
|
|
333
|
-
</div>
|
|
334
|
-
<div class="tags">
|
|
335
|
-
|
|
336
|
-
<p class="tag_title">Returns:</p>
|
|
337
|
-
<ul class="return">
|
|
338
|
-
|
|
339
|
-
<li>
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
—
|
|
347
|
-
<div class='inline'><p>the schema root directory path</p>
|
|
348
|
-
</div>
|
|
349
|
-
|
|
350
|
-
</li>
|
|
351
|
-
|
|
352
|
-
</ul>
|
|
353
|
-
|
|
354
|
-
</div><table class="source_code">
|
|
355
|
-
<tr>
|
|
356
|
-
<td>
|
|
357
|
-
<pre class="lines">
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
24
|
|
361
|
-
25
|
|
362
|
-
26</pre>
|
|
363
|
-
</td>
|
|
364
|
-
<td>
|
|
365
|
-
<pre class="code"><span class="info file"># File 'lib/servus/config.rb', line 24</span>
|
|
366
|
-
|
|
367
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_schema_root'>schema_root</span>
|
|
368
|
-
<span class='ivar'>@schema_root</span>
|
|
369
|
-
<span class='kw'>end</span></pre>
|
|
370
|
-
</td>
|
|
371
|
-
</tr>
|
|
372
|
-
</table>
|
|
373
|
-
</div>
|
|
374
|
-
|
|
375
|
-
</div>
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
<div id="instance_method_details" class="method_details_list">
|
|
379
|
-
<h2>Instance Method Details</h2>
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
<div class="method_details first">
|
|
383
|
-
<h3 class="signature first" id="schema_dir_for-instance_method">
|
|
384
|
-
|
|
385
|
-
#<strong>schema_dir_for</strong>(service_namespace) ⇒ <tt>String</tt>
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
</h3><div class="docstring">
|
|
392
|
-
<div class="discussion">
|
|
393
|
-
<p>Returns the directory containing a service's schema files.</p>
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
</div>
|
|
397
|
-
</div>
|
|
398
|
-
<div class="tags">
|
|
399
|
-
|
|
400
|
-
<div class="examples">
|
|
401
|
-
<h4 class="tag_title">Examples:</h4>
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
<pre class="example code"><code><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_schema_dir_for'>schema_dir_for</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>process_payment</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
405
|
-
<span class='comment'># => "/app/app/schemas/services/process_payment"</span></code></pre>
|
|
406
|
-
|
|
407
|
-
</div>
|
|
408
|
-
<p class="tag_title">Parameters:</p>
|
|
409
|
-
<ul class="param">
|
|
410
|
-
|
|
411
|
-
<li>
|
|
412
|
-
|
|
413
|
-
<span class='name'>service_namespace</span>
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
—
|
|
421
|
-
<div class='inline'><p>underscored service namespace</p>
|
|
422
|
-
</div>
|
|
423
|
-
|
|
424
|
-
</li>
|
|
425
|
-
|
|
426
|
-
</ul>
|
|
427
|
-
|
|
428
|
-
<p class="tag_title">Returns:</p>
|
|
429
|
-
<ul class="return">
|
|
430
|
-
|
|
431
|
-
<li>
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
—
|
|
439
|
-
<div class='inline'><p>directory path for the service's schemas</p>
|
|
440
|
-
</div>
|
|
441
|
-
|
|
442
|
-
</li>
|
|
443
|
-
|
|
444
|
-
</ul>
|
|
445
|
-
|
|
446
|
-
</div><table class="source_code">
|
|
447
|
-
<tr>
|
|
448
|
-
<td>
|
|
449
|
-
<pre class="lines">
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
58
|
|
453
|
-
59
|
|
454
|
-
60</pre>
|
|
455
|
-
</td>
|
|
456
|
-
<td>
|
|
457
|
-
<pre class="code"><span class="info file"># File 'lib/servus/config.rb', line 58</span>
|
|
458
|
-
|
|
459
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_schema_dir_for'>schema_dir_for</span><span class='lparen'>(</span><span class='id identifier rubyid_service_namespace'>service_namespace</span><span class='rparen'>)</span>
|
|
460
|
-
<span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='id identifier rubyid_schema_root'>schema_root</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='comma'>,</span> <span class='id identifier rubyid_service_namespace'>service_namespace</span><span class='rparen'>)</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="schema_path_for-instance_method">
|
|
469
|
-
|
|
470
|
-
#<strong>schema_path_for</strong>(service_namespace, type) ⇒ <tt>String</tt>
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
</h3><div class="docstring">
|
|
477
|
-
<div class="discussion">
|
|
478
|
-
<p>Returns the full path to a service's schema file.</p>
|
|
479
|
-
|
|
480
|
-
<p>Constructs the path by combining <span class='object_link'><a href="#schema_root-instance_method" title="Servus::Config#schema_root (method)">#schema_root</a></span> with the service namespace
|
|
481
|
-
and schema type.</p>
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
</div>
|
|
485
|
-
</div>
|
|
486
|
-
<div class="tags">
|
|
487
|
-
|
|
488
|
-
<div class="examples">
|
|
489
|
-
<h4 class="tag_title">Examples:</h4>
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
<pre class="example code"><code><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_schema_path_for'>schema_path_for</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>process_payment</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>arguments</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
493
|
-
<span class='comment'># => "/app/app/schemas/services/process_payment/arguments.json"</span></code></pre>
|
|
494
|
-
|
|
495
|
-
</div>
|
|
496
|
-
<p class="tag_title">Parameters:</p>
|
|
497
|
-
<ul class="param">
|
|
498
|
-
|
|
499
|
-
<li>
|
|
500
|
-
|
|
501
|
-
<span class='name'>service_namespace</span>
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
—
|
|
509
|
-
<div class='inline'><p>underscored service namespace (e.g., "process_payment")</p>
|
|
510
|
-
</div>
|
|
511
|
-
|
|
512
|
-
</li>
|
|
513
|
-
|
|
514
|
-
<li>
|
|
515
|
-
|
|
516
|
-
<span class='name'>type</span>
|
|
517
|
-
|
|
518
|
-
|
|
519
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
520
|
-
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
—
|
|
524
|
-
<div class='inline'><p>schema type ("arguments" or "result")</p>
|
|
525
|
-
</div>
|
|
526
|
-
|
|
527
|
-
</li>
|
|
528
|
-
|
|
529
|
-
</ul>
|
|
530
|
-
|
|
531
|
-
<p class="tag_title">Returns:</p>
|
|
532
|
-
<ul class="return">
|
|
533
|
-
|
|
534
|
-
<li>
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
—
|
|
542
|
-
<div class='inline'><p>full path to the schema JSON file</p>
|
|
543
|
-
</div>
|
|
544
|
-
|
|
545
|
-
</li>
|
|
546
|
-
|
|
547
|
-
</ul>
|
|
548
|
-
|
|
549
|
-
</div><table class="source_code">
|
|
550
|
-
<tr>
|
|
551
|
-
<td>
|
|
552
|
-
<pre class="lines">
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
46
|
|
556
|
-
47
|
|
557
|
-
48</pre>
|
|
558
|
-
</td>
|
|
559
|
-
<td>
|
|
560
|
-
<pre class="code"><span class="info file"># File 'lib/servus/config.rb', line 46</span>
|
|
561
|
-
|
|
562
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_schema_path_for'>schema_path_for</span><span class='lparen'>(</span><span class='id identifier rubyid_service_namespace'>service_namespace</span><span class='comma'>,</span> <span class='id identifier rubyid_type'>type</span><span class='rparen'>)</span>
|
|
563
|
-
<span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='id identifier rubyid_schema_root'>schema_root</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='comma'>,</span> <span class='id identifier rubyid_service_namespace'>service_namespace</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_type'>type</span><span class='embexpr_end'>}</span><span class='tstring_content'>.json</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
564
|
-
<span class='kw'>end</span></pre>
|
|
565
|
-
</td>
|
|
566
|
-
</tr>
|
|
567
|
-
</table>
|
|
568
|
-
</div>
|
|
569
|
-
|
|
570
|
-
</div>
|
|
571
|
-
|
|
572
|
-
</div>
|
|
573
|
-
|
|
574
|
-
<div id="footer">
|
|
575
|
-
Generated on Fri Nov 21 00:33:24 2025 by
|
|
576
|
-
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
577
|
-
0.9.37 (ruby-3.4.4).
|
|
578
|
-
</div>
|
|
579
|
-
|
|
580
|
-
</div>
|
|
581
|
-
</body>
|
|
582
|
-
</html>
|