servus 0.2.1 → 0.4.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.
Files changed (138) hide show
  1. checksums.yaml +4 -4
  2. data/lib/generators/servus/event_handler/event_handler_generator.rb +1 -1
  3. data/lib/generators/servus/guard/guard_generator.rb +1 -1
  4. data/lib/generators/servus/guard/templates/guard.rb.erb +5 -3
  5. data/lib/generators/servus/service/service_generator.rb +1 -1
  6. data/lib/servus/base.rb +67 -9
  7. data/lib/servus/config.rb +71 -3
  8. data/lib/servus/events/bus.rb +29 -0
  9. data/lib/servus/events/emitter.rb +15 -0
  10. data/lib/servus/extensions/lazily/call.rb +82 -0
  11. data/lib/servus/extensions/lazily/errors.rb +37 -0
  12. data/lib/servus/extensions/lazily/ext.rb +23 -0
  13. data/lib/servus/extensions/lazily/resolver.rb +32 -0
  14. data/lib/servus/guard.rb +7 -6
  15. data/lib/servus/guards/falsey_guard.rb +3 -3
  16. data/lib/servus/guards/presence_guard.rb +4 -4
  17. data/lib/servus/guards/state_guard.rb +4 -5
  18. data/lib/servus/guards/truthy_guard.rb +3 -3
  19. data/lib/servus/helpers/controller_helpers.rb +40 -0
  20. data/lib/servus/railtie.rb +7 -1
  21. data/lib/servus/support/data_object.rb +80 -0
  22. data/lib/servus/support/errors.rb +16 -0
  23. data/lib/servus/support/lockdown.rb +94 -0
  24. data/lib/servus/support/logger.rb +16 -0
  25. data/lib/servus/support/response.rb +12 -1
  26. data/lib/servus/support/validator.rb +79 -34
  27. data/lib/servus/testing/example_builders.rb +74 -0
  28. data/lib/servus/testing/matchers.rb +99 -0
  29. data/lib/servus/version.rb +1 -1
  30. data/lib/servus.rb +2 -0
  31. metadata +16 -114
  32. data/.claude/commands/check-docs.md +0 -1
  33. data/.claude/commands/consistency-check.md +0 -1
  34. data/.claude/commands/fine-tooth-comb.md +0 -1
  35. data/.claude/commands/red-green-refactor.md +0 -5
  36. data/.claude/settings.json +0 -24
  37. data/.rspec +0 -3
  38. data/.rubocop.yml +0 -27
  39. data/.yardopts +0 -6
  40. data/CHANGELOG.md +0 -122
  41. data/CLAUDE.md +0 -10
  42. data/IDEAS.md +0 -5
  43. data/LICENSE.txt +0 -21
  44. data/READme.md +0 -856
  45. data/Rakefile +0 -45
  46. data/docs/core/1_overview.md +0 -77
  47. data/docs/core/2_architecture.md +0 -120
  48. data/docs/core/3_service_objects.md +0 -121
  49. data/docs/features/1_schema_validation.md +0 -119
  50. data/docs/features/2_error_handling.md +0 -121
  51. data/docs/features/3_async_execution.md +0 -81
  52. data/docs/features/4_logging.md +0 -64
  53. data/docs/features/5_event_bus.md +0 -244
  54. data/docs/features/6_guards.md +0 -356
  55. data/docs/features/guards_naming_convention.md +0 -540
  56. data/docs/guides/1_common_patterns.md +0 -90
  57. data/docs/guides/2_migration_guide.md +0 -175
  58. data/docs/integration/1_configuration.md +0 -154
  59. data/docs/integration/2_testing.md +0 -287
  60. data/docs/integration/3_rails_integration.md +0 -99
  61. data/docs/yard/Servus/Base.html +0 -1645
  62. data/docs/yard/Servus/Config.html +0 -582
  63. data/docs/yard/Servus/Extensions/Async/Call.html +0 -400
  64. data/docs/yard/Servus/Extensions/Async/Errors/AsyncError.html +0 -140
  65. data/docs/yard/Servus/Extensions/Async/Errors/JobEnqueueError.html +0 -154
  66. data/docs/yard/Servus/Extensions/Async/Errors/ServiceNotFoundError.html +0 -154
  67. data/docs/yard/Servus/Extensions/Async/Errors.html +0 -128
  68. data/docs/yard/Servus/Extensions/Async/Ext.html +0 -119
  69. data/docs/yard/Servus/Extensions/Async/Job.html +0 -310
  70. data/docs/yard/Servus/Extensions/Async.html +0 -141
  71. data/docs/yard/Servus/Extensions.html +0 -117
  72. data/docs/yard/Servus/Generators/ServiceGenerator.html +0 -261
  73. data/docs/yard/Servus/Generators.html +0 -115
  74. data/docs/yard/Servus/Helpers/ControllerHelpers.html +0 -457
  75. data/docs/yard/Servus/Helpers.html +0 -115
  76. data/docs/yard/Servus/Railtie.html +0 -134
  77. data/docs/yard/Servus/Support/Errors/AuthenticationError.html +0 -287
  78. data/docs/yard/Servus/Support/Errors/BadRequestError.html +0 -283
  79. data/docs/yard/Servus/Support/Errors/ForbiddenError.html +0 -284
  80. data/docs/yard/Servus/Support/Errors/InternalServerError.html +0 -283
  81. data/docs/yard/Servus/Support/Errors/NotFoundError.html +0 -284
  82. data/docs/yard/Servus/Support/Errors/ServiceError.html +0 -489
  83. data/docs/yard/Servus/Support/Errors/ServiceUnavailableError.html +0 -290
  84. data/docs/yard/Servus/Support/Errors/UnauthorizedError.html +0 -200
  85. data/docs/yard/Servus/Support/Errors/UnprocessableEntityError.html +0 -288
  86. data/docs/yard/Servus/Support/Errors/ValidationError.html +0 -200
  87. data/docs/yard/Servus/Support/Errors.html +0 -140
  88. data/docs/yard/Servus/Support/Logger.html +0 -856
  89. data/docs/yard/Servus/Support/Rescuer/BlockContext.html +0 -585
  90. data/docs/yard/Servus/Support/Rescuer/CallOverride.html +0 -257
  91. data/docs/yard/Servus/Support/Rescuer/ClassMethods.html +0 -343
  92. data/docs/yard/Servus/Support/Rescuer.html +0 -267
  93. data/docs/yard/Servus/Support/Response.html +0 -574
  94. data/docs/yard/Servus/Support/Validator.html +0 -1150
  95. data/docs/yard/Servus/Support.html +0 -119
  96. data/docs/yard/Servus/Testing/ExampleBuilders.html +0 -523
  97. data/docs/yard/Servus/Testing/ExampleExtractor.html +0 -578
  98. data/docs/yard/Servus/Testing.html +0 -142
  99. data/docs/yard/Servus.html +0 -343
  100. data/docs/yard/_index.html +0 -535
  101. data/docs/yard/class_list.html +0 -54
  102. data/docs/yard/css/common.css +0 -1
  103. data/docs/yard/css/full_list.css +0 -58
  104. data/docs/yard/css/style.css +0 -503
  105. data/docs/yard/file.1_common_patterns.html +0 -154
  106. data/docs/yard/file.1_configuration.html +0 -115
  107. data/docs/yard/file.1_overview.html +0 -142
  108. data/docs/yard/file.1_schema_validation.html +0 -188
  109. data/docs/yard/file.2_architecture.html +0 -157
  110. data/docs/yard/file.2_error_handling.html +0 -190
  111. data/docs/yard/file.2_migration_guide.html +0 -242
  112. data/docs/yard/file.2_testing.html +0 -227
  113. data/docs/yard/file.3_async_execution.html +0 -145
  114. data/docs/yard/file.3_rails_integration.html +0 -160
  115. data/docs/yard/file.3_service_objects.html +0 -191
  116. data/docs/yard/file.4_logging.html +0 -135
  117. data/docs/yard/file.ErrorHandling.html +0 -190
  118. data/docs/yard/file.READme.html +0 -674
  119. data/docs/yard/file.architecture.html +0 -157
  120. data/docs/yard/file.async_execution.html +0 -145
  121. data/docs/yard/file.common_patterns.html +0 -154
  122. data/docs/yard/file.configuration.html +0 -115
  123. data/docs/yard/file.error_handling.html +0 -190
  124. data/docs/yard/file.logging.html +0 -135
  125. data/docs/yard/file.migration_guide.html +0 -242
  126. data/docs/yard/file.overview.html +0 -142
  127. data/docs/yard/file.rails_integration.html +0 -160
  128. data/docs/yard/file.schema_validation.html +0 -188
  129. data/docs/yard/file.service_objects.html +0 -191
  130. data/docs/yard/file.testing.html +0 -227
  131. data/docs/yard/file_list.html +0 -119
  132. data/docs/yard/frames.html +0 -22
  133. data/docs/yard/index.html +0 -674
  134. data/docs/yard/js/app.js +0 -344
  135. data/docs/yard/js/full_list.js +0 -242
  136. data/docs/yard/js/jquery.js +0 -4
  137. data/docs/yard/method_list.html +0 -542
  138. data/docs/yard/top-level-namespace.html +0 -110
data/docs/yard/Servus/Testing/ExampleExtractor.html DELETED
@@ -1,578 +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::Testing::ExampleExtractor
8
-
9
- &mdash; 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::Testing::ExampleExtractor";
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 (E)</a> &raquo;
40
- <span class='title'><span class='object_link'><a href="../../Servus.html" title="Servus (module)">Servus</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Testing.html" title="Servus::Testing (module)">Testing</a></span></span>
41
- &raquo;
42
- <span class="title">ExampleExtractor</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::Testing::ExampleExtractor
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::Testing::ExampleExtractor</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/testing/example_extractor.rb</dd>
98
- </dl>
99
-
100
- </div>
101
-
102
- <h2>Overview</h2><div class="docstring">
103
- <div class="discussion">
104
- <p>Extracts example values from JSON Schema definitions for use in testing.</p>
105
-
106
- <p>This class understands both OpenAPI-style <code>example</code> (singular) and
107
- JSON Schema-style <code>examples</code> (plural, array) keywords. It can handle
108
- nested objects, arrays, and complex schema structures.</p>
109
-
110
-
111
- </div>
112
- </div>
113
- <div class="tags">
114
-
115
- <div class="examples">
116
- <h4 class="tag_title">Examples:</h4>
117
-
118
-
119
- <h5 class="example_title"><div class='inline'><p>Basic extraction</p>
120
- </div></h5>
121
-
122
- <pre class="example code"><code><span class='id identifier rubyid_schema'>schema</span> <span class='op'>=</span> <span class='lbrace'>{</span>
123
- <span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>object</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
124
- <span class='label'>properties:</span> <span class='lbrace'>{</span>
125
- <span class='label'>name:</span> <span class='lbrace'>{</span> <span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>string</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>example:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>John Doe</span><span class='tstring_end'>&#39;</span></span> <span class='rbrace'>}</span><span class='comma'>,</span>
126
- <span class='label'>age:</span> <span class='lbrace'>{</span> <span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>integer</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>example:</span> <span class='int'>30</span> <span class='rbrace'>}</span>
127
- <span class='rbrace'>}</span>
128
- <span class='rbrace'>}</span>
129
-
130
- <span class='id identifier rubyid_extractor'>extractor</span> <span class='op'>=</span> <span class='const'>ExampleExtractor</span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Servus::Testing::ExampleExtractor#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_schema'>schema</span><span class='rparen'>)</span>
131
- <span class='id identifier rubyid_extractor'>extractor</span><span class='period'>.</span><span class='id identifier rubyid_extract'>extract</span>
132
- <span class='comment'># =&gt; { name: &#39;John Doe&#39;, age: 30 }</span></code></pre>
133
-
134
-
135
- <h5 class="example_title"><div class='inline'><p>With service class</p>
136
- </div></h5>
137
-
138
- <pre class="example code"><code><span class='id identifier rubyid_examples'>examples</span> <span class='op'>=</span> <span class='const'>ExampleExtractor</span><span class='period'>.</span><span class='id identifier rubyid_extract'><span class='object_link'><a href="#extract-class_method" title="Servus::Testing::ExampleExtractor.extract (method)">extract</a></span></span><span class='lparen'>(</span><span class='const'>MyService</span><span class='comma'>,</span> <span class='symbol'>:arguments</span><span class='rparen'>)</span>
139
- <span class='comment'># =&gt; { user_id: 123, amount: 100.0 }</span></code></pre>
140
-
141
- </div>
142
-
143
-
144
- <p class="tag_title">See Also:</p>
145
- <ul class="see">
146
-
147
- <li><a href="https://json-schema.org/understanding-json-schema/reference/annotations" target="_parent" title="https://json-schema.org/understanding-json-schema/reference/annotations">https://json-schema.org/understanding-json-schema/reference/annotations</a></li>
148
-
149
- <li><a href="https://spec.openapis.org/oas/v3.1.0#schema-object" target="_parent" title="https://spec.openapis.org/oas/v3.1.0#schema-object">https://spec.openapis.org/oas/v3.1.0#schema-object</a></li>
150
-
151
- </ul>
152
-
153
- </div>
154
-
155
-
156
-
157
-
158
-
159
-
160
-
161
- <h2>
162
- Class Method Summary
163
- <small><a href="#" class="summary_toggle">collapse</a></small>
164
- </h2>
165
-
166
- <ul class="summary">
167
-
168
- <li class="public ">
169
- <span class="summary_signature">
170
-
171
- <a href="#extract-class_method" title="extract (class method)">.<strong>extract</strong>(service_class, schema_type) &#x21d2; Hash&lt;Symbol, Object&gt; </a>
172
-
173
-
174
-
175
- </span>
176
-
177
-
178
-
179
-
180
-
181
-
182
-
183
-
184
-
185
- <span class="summary_desc"><div class='inline'><p>Extracts example values from a service class&#39;s schema.</p>
186
- </div></span>
187
-
188
- </li>
189
-
190
-
191
- </ul>
192
-
193
- <h2>
194
- Instance Method Summary
195
- <small><a href="#" class="summary_toggle">collapse</a></small>
196
- </h2>
197
-
198
- <ul class="summary">
199
-
200
- <li class="public ">
201
- <span class="summary_signature">
202
-
203
- <a href="#extract-instance_method" title="#extract (instance method)">#<strong>extract</strong> &#x21d2; Hash&lt;Symbol, Object&gt; </a>
204
-
205
-
206
-
207
- </span>
208
-
209
-
210
-
211
-
212
-
213
-
214
-
215
-
216
-
217
- <span class="summary_desc"><div class='inline'><p>Extracts all example values from the schema.</p>
218
- </div></span>
219
-
220
- </li>
221
-
222
-
223
- <li class="public ">
224
- <span class="summary_signature">
225
-
226
- <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(schema) &#x21d2; ExampleExtractor </a>
227
-
228
-
229
-
230
- </span>
231
-
232
-
233
- <span class="note title constructor">constructor</span>
234
-
235
-
236
-
237
-
238
-
239
-
240
-
241
-
242
- <span class="summary_desc"><div class='inline'><p>Initializes a new ExampleExtractor with a schema.</p>
243
- </div></span>
244
-
245
- </li>
246
-
247
-
248
- </ul>
249
-
250
-
251
- <div id="constructor_details" class="method_details_list">
252
- <h2>Constructor Details</h2>
253
-
254
- <div class="method_details first">
255
- <h3 class="signature first" id="initialize-instance_method">
256
-
257
- #<strong>initialize</strong>(schema) &#x21d2; <tt><span class='object_link'><a href="" title="Servus::Testing::ExampleExtractor (class)">ExampleExtractor</a></span></tt>
258
-
259
-
260
-
261
-
262
-
263
- </h3><div class="docstring">
264
- <div class="discussion">
265
- <p>Initializes a new ExampleExtractor with a schema.</p>
266
-
267
- <p>The schema is deeply symbolized on initialization to normalize all keys,
268
- eliminating the need for double lookups throughout extraction.</p>
269
-
270
-
271
- </div>
272
- </div>
273
- <div class="tags">
274
-
275
- <div class="examples">
276
- <h4 class="tag_title">Examples:</h4>
277
-
278
-
279
- <pre class="example code"><code><span class='id identifier rubyid_schema'>schema</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>object</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>properties:</span> <span class='lbrace'>{</span> <span class='label'>name:</span> <span class='lbrace'>{</span> <span class='label'>example:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Test</span><span class='tstring_end'>&#39;</span></span> <span class='rbrace'>}</span> <span class='rbrace'>}</span> <span class='rbrace'>}</span>
280
- <span class='id identifier rubyid_extractor'>extractor</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="Servus::Testing::ExampleExtractor (class)">ExampleExtractor</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_schema'>schema</span><span class='rparen'>)</span></code></pre>
281
-
282
- </div>
283
- <p class="tag_title">Parameters:</p>
284
- <ul class="param">
285
-
286
- <li>
287
-
288
- <span class='name'>schema</span>
289
-
290
-
291
- <span class='type'>(<tt>Hash</tt>, <tt>nil</tt>)</span>
292
-
293
-
294
-
295
- &mdash;
296
- <div class='inline'><p>A JSON Schema hash with properties and examples</p>
297
- </div>
298
-
299
- </li>
300
-
301
- </ul>
302
-
303
-
304
- </div><table class="source_code">
305
- <tr>
306
- <td>
307
- <pre class="lines">
308
-
309
-
310
- 64
311
- 65
312
- 66</pre>
313
- </td>
314
- <td>
315
- <pre class="code"><span class="info file"># File 'lib/servus/testing/example_extractor.rb', line 64</span>
316
-
317
- <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_schema'>schema</span><span class='rparen'>)</span>
318
- <span class='ivar'>@schema</span> <span class='op'>=</span> <span class='id identifier rubyid_deep_symbolize_keys'>deep_symbolize_keys</span><span class='lparen'>(</span><span class='id identifier rubyid_schema'>schema</span><span class='rparen'>)</span>
319
- <span class='kw'>end</span></pre>
320
- </td>
321
- </tr>
322
- </table>
323
- </div>
324
-
325
- </div>
326
-
327
-
328
- <div id="class_method_details" class="method_details_list">
329
- <h2>Class Method Details</h2>
330
-
331
-
332
- <div class="method_details first">
333
- <h3 class="signature first" id="extract-class_method">
334
-
335
- .<strong>extract</strong>(service_class, schema_type) &#x21d2; <tt>Hash&lt;Symbol, Object&gt;</tt>
336
-
337
-
338
-
339
-
340
-
341
- </h3><div class="docstring">
342
- <div class="discussion">
343
- <p>Extracts example values from a service class&#39;s schema.</p>
344
-
345
- <p>This is a convenience class method that loads the schema via the
346
- Validator and extracts examples in one call.</p>
347
-
348
-
349
- </div>
350
- </div>
351
- <div class="tags">
352
-
353
- <div class="examples">
354
- <h4 class="tag_title">Examples:</h4>
355
-
356
-
357
- <h5 class="example_title"><div class='inline'><p>Extract argument examples</p>
358
- </div></h5>
359
-
360
- <pre class="example code"><code><span class='const'><span class='object_link'><a href="" title="Servus::Testing::ExampleExtractor (class)">ExampleExtractor</a></span></span><span class='period'>.</span><span class='id identifier rubyid_extract'>extract</span><span class='lparen'>(</span><span class='const'>ProcessPayment</span><span class='op'>::</span><span class='const'>Service</span><span class='comma'>,</span> <span class='symbol'>:arguments</span><span class='rparen'>)</span>
361
- <span class='comment'># =&gt; { user_id: 123, amount: 100.0, currency: &#39;USD&#39; }</span></code></pre>
362
-
363
-
364
- <h5 class="example_title"><div class='inline'><p>Extract result examples</p>
365
- </div></h5>
366
-
367
- <pre class="example code"><code><span class='const'><span class='object_link'><a href="" title="Servus::Testing::ExampleExtractor (class)">ExampleExtractor</a></span></span><span class='period'>.</span><span class='id identifier rubyid_extract'>extract</span><span class='lparen'>(</span><span class='const'>ProcessPayment</span><span class='op'>::</span><span class='const'>Service</span><span class='comma'>,</span> <span class='symbol'>:result</span><span class='rparen'>)</span>
368
- <span class='comment'># =&gt; { transaction_id: &#39;txn_123&#39;, status: &#39;approved&#39; }</span></code></pre>
369
-
370
- </div>
371
- <p class="tag_title">Parameters:</p>
372
- <ul class="param">
373
-
374
- <li>
375
-
376
- <span class='name'>service_class</span>
377
-
378
-
379
- <span class='type'>(<tt>Class</tt>)</span>
380
-
381
-
382
-
383
- &mdash;
384
- <div class='inline'><p>The service class to extract examples from</p>
385
- </div>
386
-
387
- </li>
388
-
389
- <li>
390
-
391
- <span class='name'>schema_type</span>
392
-
393
-
394
- <span class='type'>(<tt>Symbol</tt>)</span>
395
-
396
-
397
-
398
- &mdash;
399
- <div class='inline'><p>Either :arguments or :result</p>
400
- </div>
401
-
402
- </li>
403
-
404
- </ul>
405
-
406
- <p class="tag_title">Returns:</p>
407
- <ul class="return">
408
-
409
- <li>
410
-
411
-
412
- <span class='type'>(<tt>Hash&lt;Symbol, Object&gt;</tt>)</span>
413
-
414
-
415
-
416
- &mdash;
417
- <div class='inline'><p>Extracted example values with symbolized keys</p>
418
- </div>
419
-
420
- </li>
421
-
422
- </ul>
423
-
424
- </div><table class="source_code">
425
- <tr>
426
- <td>
427
- <pre class="lines">
428
-
429
-
430
- 47
431
- 48
432
- 49
433
- 50
434
- 51
435
- 52</pre>
436
- </td>
437
- <td>
438
- <pre class="code"><span class="info file"># File 'lib/servus/testing/example_extractor.rb', line 47</span>
439
-
440
- <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_extract'>extract</span><span class='lparen'>(</span><span class='id identifier rubyid_service_class'>service_class</span><span class='comma'>,</span> <span class='id identifier rubyid_schema_type'>schema_type</span><span class='rparen'>)</span>
441
- <span class='id identifier rubyid_schema'>schema</span> <span class='op'>=</span> <span class='id identifier rubyid_load_schema'>load_schema</span><span class='lparen'>(</span><span class='id identifier rubyid_service_class'>service_class</span><span class='comma'>,</span> <span class='id identifier rubyid_schema_type'>schema_type</span><span class='rparen'>)</span>
442
- <span class='kw'>return</span> <span class='lbrace'>{</span><span class='rbrace'>}</span> <span class='kw'>unless</span> <span class='id identifier rubyid_schema'>schema</span>
443
-
444
- <span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_schema'>schema</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_extract'>extract</span>
445
- <span class='kw'>end</span></pre>
446
- </td>
447
- </tr>
448
- </table>
449
- </div>
450
-
451
- </div>
452
-
453
- <div id="instance_method_details" class="method_details_list">
454
- <h2>Instance Method Details</h2>
455
-
456
-
457
- <div class="method_details first">
458
- <h3 class="signature first" id="extract-instance_method">
459
-
460
- #<strong>extract</strong> &#x21d2; <tt>Hash&lt;Symbol, Object&gt;</tt>
461
-
462
-
463
-
464
-
465
-
466
- </h3><div class="docstring">
467
- <div class="discussion">
468
- <p>Extracts all example values from the schema.</p>
469
-
470
- <p>Traverses the schema structure and collects example values from:</p>
471
-
472
- <ul>
473
- <li>Simple properties with <code>example</code> or <code>examples</code> keywords</li>
474
- <li>Nested objects (recursively)</li>
475
- <li>Arrays (using array-level examples or generating from item schemas)</li>
476
- </ul>
477
-
478
-
479
- </div>
480
- </div>
481
- <div class="tags">
482
-
483
- <div class="examples">
484
- <h4 class="tag_title">Examples:</h4>
485
-
486
-
487
- <h5 class="example_title"><div class='inline'><p>Simple properties</p>
488
- </div></h5>
489
-
490
- <pre class="example code"><code><span class='id identifier rubyid_schema'>schema</span> <span class='op'>=</span> <span class='lbrace'>{</span>
491
- <span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>object</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
492
- <span class='label'>properties:</span> <span class='lbrace'>{</span>
493
- <span class='label'>name:</span> <span class='lbrace'>{</span> <span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>string</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>example:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>John</span><span class='tstring_end'>&#39;</span></span> <span class='rbrace'>}</span><span class='comma'>,</span>
494
- <span class='label'>age:</span> <span class='lbrace'>{</span> <span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>integer</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>examples:</span> <span class='lbracket'>[</span><span class='int'>30</span><span class='comma'>,</span> <span class='int'>25</span><span class='comma'>,</span> <span class='int'>40</span><span class='rbracket'>]</span> <span class='rbrace'>}</span>
495
- <span class='rbrace'>}</span>
496
- <span class='rbrace'>}</span>
497
- <span class='id identifier rubyid_extractor'>extractor</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="Servus::Testing::ExampleExtractor (class)">ExampleExtractor</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Servus::Testing::ExampleExtractor#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_schema'>schema</span><span class='rparen'>)</span>
498
- <span class='id identifier rubyid_extractor'>extractor</span><span class='period'>.</span><span class='id identifier rubyid_extract'>extract</span>
499
- <span class='comment'># =&gt; { name: &#39;John&#39;, age: 30 }</span></code></pre>
500
-
501
-
502
- <h5 class="example_title"><div class='inline'><p>Nested objects</p>
503
- </div></h5>
504
-
505
- <pre class="example code"><code><span class='id identifier rubyid_schema'>schema</span> <span class='op'>=</span> <span class='lbrace'>{</span>
506
- <span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>object</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
507
- <span class='label'>properties:</span> <span class='lbrace'>{</span>
508
- <span class='label'>user:</span> <span class='lbrace'>{</span>
509
- <span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>object</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
510
- <span class='label'>properties:</span> <span class='lbrace'>{</span>
511
- <span class='label'>id:</span> <span class='lbrace'>{</span> <span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>integer</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>example:</span> <span class='int'>123</span> <span class='rbrace'>}</span><span class='comma'>,</span>
512
- <span class='label'>name:</span> <span class='lbrace'>{</span> <span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>string</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>example:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Jane</span><span class='tstring_end'>&#39;</span></span> <span class='rbrace'>}</span>
513
- <span class='rbrace'>}</span>
514
- <span class='rbrace'>}</span>
515
- <span class='rbrace'>}</span>
516
- <span class='rbrace'>}</span>
517
- <span class='id identifier rubyid_extractor'>extractor</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="Servus::Testing::ExampleExtractor (class)">ExampleExtractor</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Servus::Testing::ExampleExtractor#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_schema'>schema</span><span class='rparen'>)</span>
518
- <span class='id identifier rubyid_extractor'>extractor</span><span class='period'>.</span><span class='id identifier rubyid_extract'>extract</span>
519
- <span class='comment'># =&gt; { user: { id: 123, name: &#39;Jane&#39; } }</span></code></pre>
520
-
521
- </div>
522
-
523
- <p class="tag_title">Returns:</p>
524
- <ul class="return">
525
-
526
- <li>
527
-
528
-
529
- <span class='type'>(<tt>Hash&lt;Symbol, Object&gt;</tt>)</span>
530
-
531
-
532
-
533
- &mdash;
534
- <div class='inline'><p>Hash of example values with symbolized keys</p>
535
- </div>
536
-
537
- </li>
538
-
539
- </ul>
540
-
541
- </div><table class="source_code">
542
- <tr>
543
- <td>
544
- <pre class="lines">
545
-
546
-
547
- 105
548
- 106
549
- 107
550
- 108
551
- 109</pre>
552
- </td>
553
- <td>
554
- <pre class="code"><span class="info file"># File 'lib/servus/testing/example_extractor.rb', line 105</span>
555
-
556
- <span class='kw'>def</span> <span class='id identifier rubyid_extract'>extract</span>
557
- <span class='kw'>return</span> <span class='lbrace'>{</span><span class='rbrace'>}</span> <span class='kw'>unless</span> <span class='ivar'>@schema</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Hash</span><span class='rparen'>)</span>
558
-
559
- <span class='id identifier rubyid_extract_examples_from_properties'>extract_examples_from_properties</span><span class='lparen'>(</span><span class='ivar'>@schema</span><span class='rparen'>)</span>
560
- <span class='kw'>end</span></pre>
561
- </td>
562
- </tr>
563
- </table>
564
- </div>
565
-
566
- </div>
567
-
568
- </div>
569
-
570
- <div id="footer">
571
- Generated on Fri Nov 21 00:33:24 2025 by
572
- <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
573
- 0.9.37 (ruby-3.4.4).
574
- </div>
575
-
576
- </div>
577
- </body>
578
- </html>