servus 0.1.3 → 0.1.5

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 (139) hide show
  1. checksums.yaml +4 -4
  2. data/.claude/commands/check-docs.md +1 -0
  3. data/.claude/commands/consistency-check.md +1 -0
  4. data/.claude/commands/fine-tooth-comb.md +1 -0
  5. data/.claude/commands/red-green-refactor.md +5 -0
  6. data/.claude/settings.json +15 -0
  7. data/.rubocop.yml +18 -2
  8. data/.yardopts +6 -0
  9. data/CHANGELOG.md +47 -0
  10. data/CLAUDE.md +10 -0
  11. data/IDEAS.md +5 -0
  12. data/READme.md +300 -47
  13. data/Rakefile +33 -0
  14. data/builds/servus-0.1.3.gem +0 -0
  15. data/builds/servus-0.1.4.gem +0 -0
  16. data/builds/servus-0.1.5.gem +0 -0
  17. data/docs/core/1_overview.md +77 -0
  18. data/docs/core/2_architecture.md +120 -0
  19. data/docs/core/3_service_objects.md +121 -0
  20. data/docs/current_focus.md +569 -0
  21. data/docs/features/1_schema_validation.md +119 -0
  22. data/docs/features/2_error_handling.md +121 -0
  23. data/docs/features/3_async_execution.md +81 -0
  24. data/docs/features/4_logging.md +64 -0
  25. data/docs/features/5_event_bus.md +244 -0
  26. data/docs/guides/1_common_patterns.md +90 -0
  27. data/docs/guides/2_migration_guide.md +175 -0
  28. data/docs/integration/1_configuration.md +104 -0
  29. data/docs/integration/2_testing.md +287 -0
  30. data/docs/integration/3_rails_integration.md +99 -0
  31. data/docs/yard/Servus/Base.html +1645 -0
  32. data/docs/yard/Servus/Config.html +582 -0
  33. data/docs/yard/Servus/Extensions/Async/Call.html +400 -0
  34. data/docs/yard/Servus/Extensions/Async/Errors/AsyncError.html +140 -0
  35. data/docs/yard/Servus/Extensions/Async/Errors/JobEnqueueError.html +154 -0
  36. data/docs/yard/Servus/Extensions/Async/Errors/ServiceNotFoundError.html +154 -0
  37. data/docs/yard/Servus/Extensions/Async/Errors.html +128 -0
  38. data/docs/yard/Servus/Extensions/Async/Ext.html +119 -0
  39. data/docs/yard/Servus/Extensions/Async/Job.html +310 -0
  40. data/docs/yard/Servus/Extensions/Async.html +141 -0
  41. data/docs/yard/Servus/Extensions.html +117 -0
  42. data/docs/yard/Servus/Generators/ServiceGenerator.html +261 -0
  43. data/docs/yard/Servus/Generators.html +115 -0
  44. data/docs/yard/Servus/Helpers/ControllerHelpers.html +457 -0
  45. data/docs/yard/Servus/Helpers.html +115 -0
  46. data/docs/yard/Servus/Railtie.html +134 -0
  47. data/docs/yard/Servus/Support/Errors/AuthenticationError.html +287 -0
  48. data/docs/yard/Servus/Support/Errors/BadRequestError.html +283 -0
  49. data/docs/yard/Servus/Support/Errors/ForbiddenError.html +284 -0
  50. data/docs/yard/Servus/Support/Errors/InternalServerError.html +283 -0
  51. data/docs/yard/Servus/Support/Errors/NotFoundError.html +284 -0
  52. data/docs/yard/Servus/Support/Errors/ServiceError.html +489 -0
  53. data/docs/yard/Servus/Support/Errors/ServiceUnavailableError.html +290 -0
  54. data/docs/yard/Servus/Support/Errors/UnauthorizedError.html +200 -0
  55. data/docs/yard/Servus/Support/Errors/UnprocessableEntityError.html +288 -0
  56. data/docs/yard/Servus/Support/Errors/ValidationError.html +200 -0
  57. data/docs/yard/Servus/Support/Errors.html +140 -0
  58. data/docs/yard/Servus/Support/Logger.html +856 -0
  59. data/docs/yard/Servus/Support/Rescuer/BlockContext.html +585 -0
  60. data/docs/yard/Servus/Support/Rescuer/CallOverride.html +257 -0
  61. data/docs/yard/Servus/Support/Rescuer/ClassMethods.html +343 -0
  62. data/docs/yard/Servus/Support/Rescuer.html +267 -0
  63. data/docs/yard/Servus/Support/Response.html +574 -0
  64. data/docs/yard/Servus/Support/Validator.html +1150 -0
  65. data/docs/yard/Servus/Support.html +119 -0
  66. data/docs/yard/Servus/Testing/ExampleBuilders.html +523 -0
  67. data/docs/yard/Servus/Testing/ExampleExtractor.html +578 -0
  68. data/docs/yard/Servus/Testing.html +142 -0
  69. data/docs/yard/Servus.html +343 -0
  70. data/docs/yard/_index.html +535 -0
  71. data/docs/yard/class_list.html +54 -0
  72. data/docs/yard/css/common.css +1 -0
  73. data/docs/yard/css/full_list.css +58 -0
  74. data/docs/yard/css/style.css +503 -0
  75. data/docs/yard/file.1_common_patterns.html +154 -0
  76. data/docs/yard/file.1_configuration.html +115 -0
  77. data/docs/yard/file.1_overview.html +142 -0
  78. data/docs/yard/file.1_schema_validation.html +188 -0
  79. data/docs/yard/file.2_architecture.html +157 -0
  80. data/docs/yard/file.2_error_handling.html +190 -0
  81. data/docs/yard/file.2_migration_guide.html +242 -0
  82. data/docs/yard/file.2_testing.html +227 -0
  83. data/docs/yard/file.3_async_execution.html +145 -0
  84. data/docs/yard/file.3_rails_integration.html +160 -0
  85. data/docs/yard/file.3_service_objects.html +191 -0
  86. data/docs/yard/file.4_logging.html +135 -0
  87. data/docs/yard/file.ErrorHandling.html +190 -0
  88. data/docs/yard/file.READme.html +674 -0
  89. data/docs/yard/file.architecture.html +157 -0
  90. data/docs/yard/file.async_execution.html +145 -0
  91. data/docs/yard/file.common_patterns.html +154 -0
  92. data/docs/yard/file.configuration.html +115 -0
  93. data/docs/yard/file.error_handling.html +190 -0
  94. data/docs/yard/file.logging.html +135 -0
  95. data/docs/yard/file.migration_guide.html +242 -0
  96. data/docs/yard/file.overview.html +142 -0
  97. data/docs/yard/file.rails_integration.html +160 -0
  98. data/docs/yard/file.schema_validation.html +188 -0
  99. data/docs/yard/file.service_objects.html +191 -0
  100. data/docs/yard/file.testing.html +227 -0
  101. data/docs/yard/file_list.html +119 -0
  102. data/docs/yard/frames.html +22 -0
  103. data/docs/yard/index.html +674 -0
  104. data/docs/yard/js/app.js +344 -0
  105. data/docs/yard/js/full_list.js +242 -0
  106. data/docs/yard/js/jquery.js +4 -0
  107. data/docs/yard/method_list.html +542 -0
  108. data/docs/yard/top-level-namespace.html +110 -0
  109. data/lib/generators/servus/event_handler/event_handler_generator.rb +59 -0
  110. data/lib/generators/servus/event_handler/templates/handler.rb.erb +86 -0
  111. data/lib/generators/servus/event_handler/templates/handler_spec.rb.erb +48 -0
  112. data/lib/generators/servus/service/service_generator.rb +68 -1
  113. data/lib/generators/servus/service/templates/arguments.json.erb +19 -10
  114. data/lib/generators/servus/service/templates/result.json.erb +8 -2
  115. data/lib/generators/servus/service/templates/service.rb.erb +102 -5
  116. data/lib/generators/servus/service/templates/service_spec.rb.erb +67 -6
  117. data/lib/servus/base.rb +275 -58
  118. data/lib/servus/config.rb +83 -17
  119. data/lib/servus/event_handler.rb +275 -0
  120. data/lib/servus/events/bus.rb +137 -0
  121. data/lib/servus/events/emitter.rb +162 -0
  122. data/lib/servus/events/errors.rb +10 -0
  123. data/lib/servus/extensions/async/call.rb +50 -18
  124. data/lib/servus/extensions/async/errors.rb +23 -3
  125. data/lib/servus/extensions/async/ext.rb +10 -2
  126. data/lib/servus/extensions/async/job.rb +30 -9
  127. data/lib/servus/helpers/controller_helpers.rb +73 -37
  128. data/lib/servus/railtie.rb +16 -0
  129. data/lib/servus/support/errors.rb +135 -45
  130. data/lib/servus/support/rescuer.rb +189 -36
  131. data/lib/servus/support/response.rb +49 -7
  132. data/lib/servus/support/validator.rb +147 -19
  133. data/lib/servus/testing/example_builders.rb +133 -0
  134. data/lib/servus/testing/example_extractor.rb +309 -0
  135. data/lib/servus/testing/matchers.rb +88 -0
  136. data/lib/servus/testing.rb +19 -0
  137. data/lib/servus/version.rb +1 -1
  138. data/lib/servus.rb +6 -0
  139. metadata +135 -19
data/docs/yard/file.service_objects.html ADDED
@@ -0,0 +1,191 @@
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
+ File: Core / Service Objects
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 = "service_objects";
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="file_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</a> &raquo;
40
+ <span class="title">File: Core / Service Objects</span>
41
+
42
+ </div>
43
+
44
+ <div id="search">
45
+
46
+ <a class="full_list_link" id="class_list_link"
47
+ href="class_list.html">
48
+
49
+ <svg width="24" height="24">
50
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
51
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
52
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
53
+ </svg>
54
+ </a>
55
+
56
+ </div>
57
+ <div class="clear"></div>
58
+ </div>
59
+
60
+ <div id="content"><div id='filecontents'><h1 id="service-objects">Service Objects</h1>
61
+
62
+ <p>Service objects encapsulate one business operation into a testable, reusable class. They sit between controllers and models, handling orchestration logic that doesn&#39;t belong in either.</p>
63
+
64
+ <h2 id="the-pattern">The Pattern</h2>
65
+
66
+ <p>Services implement two methods: <code>initialize</code> (sets up dependencies) and <code>call</code> (executes business logic). All services return a <code>Response</code> object indicating success or failure.</p>
67
+
68
+ <pre class="code ruby"><code class="ruby"><span class='kw'>module</span> <span class='const'>Users</span>
69
+ <span class='kw'>module</span> <span class='const'>Create</span>
70
+ <span class='kw'>class</span> <span class='const'>Service</span> <span class='op'>&lt;</span> <span class='const'><span class='object_link'><a href="Servus.html" title="Servus (module)">Servus</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Servus/Base.html" title="Servus::Base (class)">Base</a></span></span>
71
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>email:</span><span class='comma'>,</span> <span class='label'>name:</span><span class='rparen'>)</span>
72
+ <span class='ivar'>@email</span> <span class='op'>=</span> <span class='id identifier rubyid_email'>email</span>
73
+ <span class='ivar'>@name</span> <span class='op'>=</span> <span class='id identifier rubyid_name'>name</span>
74
+ <span class='kw'>end</span>
75
+
76
+ <span class='kw'>def</span> <span class='id identifier rubyid_call'>call</span>
77
+ <span class='kw'>return</span> <span class='id identifier rubyid_failure'>failure</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Email taken</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='const'>User</span><span class='period'>.</span><span class='id identifier rubyid_exists?'>exists?</span><span class='lparen'>(</span><span class='label'>email:</span> <span class='ivar'>@email</span><span class='rparen'>)</span>
78
+
79
+ <span class='id identifier rubyid_user'>user</span> <span class='op'>=</span> <span class='const'>User</span><span class='period'>.</span><span class='id identifier rubyid_create!'>create!</span><span class='lparen'>(</span><span class='label'>email:</span> <span class='ivar'>@email</span><span class='comma'>,</span> <span class='label'>name:</span> <span class='ivar'>@name</span><span class='rparen'>)</span>
80
+ <span class='id identifier rubyid_send_welcome_email'>send_welcome_email</span><span class='lparen'>(</span><span class='id identifier rubyid_user'>user</span><span class='rparen'>)</span>
81
+
82
+ <span class='id identifier rubyid_success'>success</span><span class='lparen'>(</span><span class='label'>user:</span> <span class='id identifier rubyid_user'>user</span><span class='rparen'>)</span>
83
+ <span class='kw'>end</span>
84
+ <span class='kw'>end</span>
85
+ <span class='kw'>end</span>
86
+ <span class='kw'>end</span>
87
+
88
+ <span class='comment'># Usage
89
+ </span><span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='const'>Users</span><span class='op'>::</span><span class='const'>Create</span><span class='op'>::</span><span class='const'>Service</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='label'>email:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>user@example.com</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>name:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>John</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
90
+ <span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_success?'>success?</span> <span class='comment'># =&gt; true
91
+ </span><span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:user</span><span class='rbracket'>]</span> <span class='comment'># =&gt; #&lt;User&gt;
92
+ </span></code></pre>
93
+
94
+ <h2 id="service-composition">Service Composition</h2>
95
+
96
+ <p>Services can call other services. Use the returned Response to decide whether to continue or propagate the failure.</p>
97
+
98
+ <pre class="code ruby"><code class="ruby"><span class='kw'>def</span> <span class='id identifier rubyid_call'>call</span>
99
+ <span class='id identifier rubyid_user_result'>user_result</span> <span class='op'>=</span> <span class='const'>Users</span><span class='op'>::</span><span class='const'>Create</span><span class='op'>::</span><span class='const'>Service</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_user_params'>user_params</span><span class='rparen'>)</span>
100
+ <span class='kw'>return</span> <span class='id identifier rubyid_user_result'>user_result</span> <span class='kw'>unless</span> <span class='id identifier rubyid_user_result'>user_result</span><span class='period'>.</span><span class='id identifier rubyid_success?'>success?</span> <span class='comment'># propogates result failure
101
+ </span>
102
+ <span class='id identifier rubyid_account_result'>account_result</span> <span class='op'>=</span> <span class='const'>Accounts</span><span class='op'>::</span><span class='const'>Create</span><span class='op'>::</span><span class='const'>Service</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span>
103
+ <span class='label'>user:</span> <span class='id identifier rubyid_user_result'>user_result</span><span class='period'>.</span><span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:user</span><span class='rbracket'>]</span><span class='comma'>,</span>
104
+ <span class='label'>plan:</span> <span class='ivar'>@plan</span>
105
+ <span class='rparen'>)</span>
106
+ <span class='kw'>return</span> <span class='id identifier rubyid_account_result'>account_result</span> <span class='kw'>unless</span> <span class='id identifier rubyid_account_result'>account_result</span><span class='period'>.</span><span class='id identifier rubyid_success?'>success?</span> <span class='comment'># propogates result failure
107
+ </span>
108
+ <span class='id identifier rubyid_success'>success</span><span class='lparen'>(</span>
109
+ <span class='label'>user:</span> <span class='id identifier rubyid_user_result'>user_result</span><span class='period'>.</span><span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:user</span><span class='rbracket'>]</span><span class='comma'>,</span>
110
+ <span class='label'>account:</span> <span class='id identifier rubyid_account_result'>account_result</span><span class='period'>.</span><span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:account</span><span class='rbracket'>]</span>
111
+ <span class='rparen'>)</span>
112
+ <span class='kw'>end</span>
113
+ </code></pre>
114
+
115
+ <h2 id="when-to-extract-to-services">When to Extract to Services</h2>
116
+
117
+ <p><strong>Extract when</strong>:</p>
118
+
119
+ <ul>
120
+ <li>Logic spans multiple models</li>
121
+ <li>Complex conditional branching</li>
122
+ <li>External API calls</li>
123
+ <li>Background processing needed</li>
124
+ <li>Testing requires extensive setup</li>
125
+ </ul>
126
+
127
+ <p><strong>Don&#39;t extract when</strong>:</p>
128
+
129
+ <ul>
130
+ <li>Simple CRUD operations</li>
131
+ <li>Single-model updates</li>
132
+ <li>Logic naturally belongs in model</li>
133
+ </ul>
134
+
135
+ <h2 id="directory-structure">Directory Structure</h2>
136
+
137
+ <p>Each service lives in its own namespace to avoid naming collisions and allow for support classes.</p>
138
+
139
+ <pre class="code ruby"><code class="ruby">app/services/
140
+ ├── users/
141
+ │ └── create/
142
+ │ ├── service.rb
143
+ │ └── support/
144
+ │ └── welcome_email.rb
145
+ └── orders/
146
+ └── process/
147
+ ├── service.rb
148
+ └── support/
149
+ ├── payment_gateway.rb
150
+ └── inventory_updater.rb
151
+ </code></pre>
152
+
153
+ <p>Support classes are private to their service - they should never be used by other services.</p>
154
+
155
+ <h2 id="testing">Testing</h2>
156
+
157
+ <p>Services are designed for easy testing with explicit inputs and outputs.</p>
158
+
159
+ <pre class="code ruby"><code class="ruby"><span class='const'>RSpec</span><span class='period'>.</span><span class='id identifier rubyid_describe'>describe</span> <span class='const'>Users</span><span class='op'>::</span><span class='const'>Create</span><span class='op'>::</span><span class='const'>Service</span> <span class='kw'>do</span>
160
+ <span class='id identifier rubyid_describe'>describe</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>.call</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>do</span>
161
+ <span class='id identifier rubyid_context'>context</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>with valid params</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>do</span>
162
+ <span class='id identifier rubyid_it'>it</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>creates user</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>do</span>
163
+ <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='id identifier rubyid_described_class'>described_class</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='label'>email:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>test@example.com</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>name:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Test</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
164
+ <span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_success?'>success?</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be'>be</span> <span class='kw'>true</span>
165
+ <span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:user</span><span class='rbracket'>]</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be_persisted'>be_persisted</span>
166
+ <span class='kw'>end</span>
167
+ <span class='kw'>end</span>
168
+
169
+ <span class='id identifier rubyid_context'>context</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>with duplicate email</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>do</span>
170
+ <span class='id identifier rubyid_before'>before</span> <span class='lbrace'>{</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='symbol'>:user</span><span class='comma'>,</span> <span class='label'>email:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>test@example.com</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='rbrace'>}</span>
171
+
172
+ <span class='id identifier rubyid_it'>it</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>returns failure</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>do</span>
173
+ <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='id identifier rubyid_described_class'>described_class</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='label'>email:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>test@example.com</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>name:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Test</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
174
+ <span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_success?'>success?</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be'>be</span> <span class='kw'>false</span>
175
+ <span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_error'>error</span><span class='period'>.</span><span class='id identifier rubyid_message'>message</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_eq'>eq</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Email taken</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
176
+ <span class='kw'>end</span>
177
+ <span class='kw'>end</span>
178
+ <span class='kw'>end</span>
179
+ <span class='kw'>end</span>
180
+ </code></pre>
181
+ </div></div>
182
+
183
+ <div id="footer">
184
+ Generated on Fri Nov 21 00:28:16 2025 by
185
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
186
+ 0.9.37 (ruby-3.4.4).
187
+ </div>
188
+
189
+ </div>
190
+ </body>
191
+ </html>
data/docs/yard/file.testing.html ADDED
@@ -0,0 +1,227 @@
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
+ File: Integration / Testing
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 = "testing";
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="file_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</a> &raquo;
40
+ <span class="title">File: Integration / Testing</span>
41
+
42
+ </div>
43
+
44
+ <div id="search">
45
+
46
+ <a class="full_list_link" id="class_list_link"
47
+ href="class_list.html">
48
+
49
+ <svg width="24" height="24">
50
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
51
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
52
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
53
+ </svg>
54
+ </a>
55
+
56
+ </div>
57
+ <div class="clear"></div>
58
+ </div>
59
+
60
+ <div id="content"><div id='filecontents'><h1 id="testing">Testing</h1>
61
+
62
+ <p>Services are designed for easy testing with explicit inputs (arguments) and outputs (Response objects). No special test infrastructure needed.</p>
63
+
64
+ <h2 id="schema-example-helpers">Schema Example Helpers</h2>
65
+
66
+ <p>Servus provides test helpers that extract <code>example</code> values from your JSON schemas, making it easy to generate test fixtures without maintaining separate factories.</p>
67
+
68
+ <h3 id="setup">Setup</h3>
69
+
70
+ <p>Include the helpers in your test suite:</p>
71
+
72
+ <pre class="code ruby"><code class="ruby"><span class='comment'># spec/spec_helper.rb
73
+ </span><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>servus/testing</span><span class='tstring_end'>&#39;</span></span>
74
+
75
+ <span class='const'>RSpec</span><span class='period'>.</span><span class='id identifier rubyid_configure'>configure</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_config'>config</span><span class='op'>|</span>
76
+ <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_include'>include</span> <span class='const'><span class='object_link'><a href="Servus.html" title="Servus (module)">Servus</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Servus/Testing.html" title="Servus::Testing (module)">Testing</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Servus/Testing/ExampleBuilders.html" title="Servus::Testing::ExampleBuilders (module)">ExampleBuilders</a></span></span>
77
+ <span class='kw'>end</span>
78
+ </code></pre>
79
+
80
+ <h3 id="using-schema-examples">Using Schema Examples</h3>
81
+
82
+ <p>Add <code>example</code> or <code>examples</code> keywords to your schemas:</p>
83
+
84
+ <pre class="code ruby"><code class="ruby"><span class='kw'>class</span> <span class='const'>ProcessPayment</span><span class='op'>::</span><span class='const'>Service</span> <span class='op'>&lt;</span> <span class='const'><span class='object_link'><a href="Servus.html" title="Servus (module)">Servus</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Servus/Base.html" title="Servus::Base (class)">Base</a></span></span>
85
+ <span class='id identifier rubyid_schema'>schema</span><span class='lparen'>(</span>
86
+ <span class='label'>arguments:</span> <span class='lbrace'>{</span>
87
+ <span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>object</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
88
+ <span class='label'>properties:</span> <span class='lbrace'>{</span>
89
+ <span class='label'>user_id:</span> <span class='lbrace'>{</span> <span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>integer</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>example:</span> <span class='int'>123</span> <span class='rbrace'>}</span><span class='comma'>,</span>
90
+ <span class='label'>amount:</span> <span class='lbrace'>{</span> <span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>number</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>example:</span> <span class='float'>100.0</span> <span class='rbrace'>}</span><span class='comma'>,</span>
91
+ <span class='label'>currency:</span> <span class='lbrace'>{</span> <span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>string</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>examples:</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>USD</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>EUR</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>GBP</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='rbrace'>}</span>
92
+ <span class='rbrace'>}</span>
93
+ <span class='rbrace'>}</span><span class='comma'>,</span>
94
+ <span class='label'>result:</span> <span class='lbrace'>{</span>
95
+ <span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>object</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
96
+ <span class='label'>properties:</span> <span class='lbrace'>{</span>
97
+ <span class='label'>transaction_id:</span> <span class='lbrace'>{</span> <span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>string</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>example:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>txn_abc123</span><span class='tstring_end'>&quot;</span></span> <span class='rbrace'>}</span><span class='comma'>,</span>
98
+ <span class='label'>status:</span> <span class='lbrace'>{</span> <span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>string</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>example:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>approved</span><span class='tstring_end'>&quot;</span></span> <span class='rbrace'>}</span>
99
+ <span class='rbrace'>}</span>
100
+ <span class='rbrace'>}</span>
101
+ <span class='rparen'>)</span>
102
+ <span class='kw'>end</span>
103
+ </code></pre>
104
+
105
+ <p>Then use the helpers in your tests:</p>
106
+
107
+ <pre class="code ruby"><code class="ruby"><span class='const'>RSpec</span><span class='period'>.</span><span class='id identifier rubyid_describe'>describe</span> <span class='const'>ProcessPayment</span><span class='op'>::</span><span class='const'>Service</span> <span class='kw'>do</span>
108
+ <span class='id identifier rubyid_it'>it</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>processes payment successfully</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>do</span>
109
+ <span class='comment'># Extract examples from schema and override specific values
110
+ </span> <span class='id identifier rubyid_args'>args</span> <span class='op'>=</span> <span class='id identifier rubyid_servus_arguments_example'>servus_arguments_example</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='label'>amount:</span> <span class='float'>50.0</span><span class='rparen'>)</span>
111
+ <span class='comment'># =&gt; { user_id: 123, amount: 50.0, currency: &quot;USD&quot; }
112
+ </span>
113
+ <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='const'>ProcessPayment</span><span class='op'>::</span><span class='const'>Service</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='op'>**</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
114
+
115
+ <span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be_success'>be_success</span>
116
+ <span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_keys'>keys</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_match_array'>match_array</span><span class='lparen'>(</span>
117
+ <span class='id identifier rubyid_servus_result_example'>servus_result_example</span><span class='lparen'>(</span><span class='const'>ProcessPayment</span><span class='op'>::</span><span class='const'>Service</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_keys'>keys</span>
118
+ <span class='rparen'>)</span>
119
+ <span class='kw'>end</span>
120
+
121
+ <span class='id identifier rubyid_it'>it</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>handles different currencies</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>do</span>
122
+ <span class='qwords_beg'>%w[</span><span class='tstring_content'>USD</span><span class='words_sep'> </span><span class='tstring_content'>EUR</span><span class='words_sep'> </span><span class='tstring_content'>GBP</span><span class='tstring_end'>]</span></span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_currency'>currency</span><span class='op'>|</span>
123
+ <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='const'>ProcessPayment</span><span class='op'>::</span><span class='const'>Service</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span>
124
+ <span class='op'>**</span><span class='id identifier rubyid_servus_arguments_example'>servus_arguments_example</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='label'>currency:</span> <span class='id identifier rubyid_currency'>currency</span><span class='rparen'>)</span>
125
+ <span class='rparen'>)</span>
126
+ <span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be_success'>be_success</span>
127
+ <span class='kw'>end</span>
128
+ <span class='kw'>end</span>
129
+ <span class='kw'>end</span>
130
+ </code></pre>
131
+
132
+ <h3 id="deep-merging">Deep Merging</h3>
133
+
134
+ <p>Overrides are deep-merged with schema examples, allowing you to override nested values:</p>
135
+
136
+ <pre class="code ruby"><code class="ruby"><span class='comment'># Schema has nested structure
137
+ </span><span class='id identifier rubyid_args'>args</span> <span class='op'>=</span> <span class='id identifier rubyid_servus_arguments_example'>servus_arguments_example</span><span class='lparen'>(</span>
138
+ <span class='const'>CreateUser</span><span class='op'>::</span><span class='const'>Service</span><span class='comma'>,</span>
139
+ <span class='label'>user:</span> <span class='lbrace'>{</span> <span class='label'>profile:</span> <span class='lbrace'>{</span> <span class='label'>age:</span> <span class='int'>35</span> <span class='rbrace'>}</span> <span class='rbrace'>}</span>
140
+ <span class='rparen'>)</span>
141
+ <span class='comment'># =&gt; { user: { id: 1, profile: { name: &#39;Alice&#39;, age: 35 } } }
142
+ </span></code></pre>
143
+
144
+ <h3 id="available-helpers">Available Helpers</h3>
145
+
146
+ <ul>
147
+ <li><code>servus_arguments_example(ServiceClass, **overrides)</code> - Returns hash of argument examples</li>
148
+ <li><code>servus_result_example(ServiceClass, **overrides)</code> - Returns Response object with result examples</li>
149
+ </ul>
150
+
151
+ <h2 id="basic-testing-pattern">Basic Testing Pattern</h2>
152
+
153
+ <pre class="code ruby"><code class="ruby"><span class='const'>RSpec</span><span class='period'>.</span><span class='id identifier rubyid_describe'>describe</span> <span class='const'>ProcessPayment</span><span class='op'>::</span><span class='const'>Service</span> <span class='kw'>do</span>
154
+ <span class='id identifier rubyid_describe'>describe</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>.call</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>do</span>
155
+ <span class='id identifier rubyid_let'>let</span><span class='lparen'>(</span><span class='symbol'>:user</span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='symbol'>:user</span><span class='comma'>,</span> <span class='label'>balance:</span> <span class='int'>1000</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
156
+
157
+ <span class='id identifier rubyid_subject'>subject</span><span class='lparen'>(</span><span class='symbol'>:result</span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='id identifier rubyid_described_class'>described_class</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='label'>user_id:</span> <span class='id identifier rubyid_user'>user</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='label'>amount:</span> <span class='id identifier rubyid_amount'>amount</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
158
+
159
+ <span class='id identifier rubyid_context'>context</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>with sufficient balance</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>do</span>
160
+ <span class='id identifier rubyid_let'>let</span><span class='lparen'>(</span><span class='symbol'>:amount</span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='int'>50</span> <span class='rbrace'>}</span>
161
+
162
+ <span class='id identifier rubyid_it'>it</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>processes payment</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>do</span>
163
+ <span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_success?'>success?</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be'>be</span> <span class='kw'>true</span>
164
+ <span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:new_balance</span><span class='rbracket'>]</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_eq'>eq</span><span class='lparen'>(</span><span class='int'>950</span><span class='rparen'>)</span>
165
+ <span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_reload'>reload</span><span class='period'>.</span><span class='id identifier rubyid_balance'>balance</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_eq'>eq</span><span class='lparen'>(</span><span class='int'>950</span><span class='rparen'>)</span>
166
+ <span class='kw'>end</span>
167
+ <span class='kw'>end</span>
168
+
169
+ <span class='id identifier rubyid_context'>context</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>with insufficient balance</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>do</span>
170
+ <span class='id identifier rubyid_let'>let</span><span class='lparen'>(</span><span class='symbol'>:amount</span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='int'>2000</span> <span class='rbrace'>}</span>
171
+
172
+ <span class='id identifier rubyid_it'>it</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>returns failure</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>do</span>
173
+ <span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_success?'>success?</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be'>be</span> <span class='kw'>false</span>
174
+ <span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_error'>error</span><span class='period'>.</span><span class='id identifier rubyid_message'>message</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_eq'>eq</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Insufficient funds</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
175
+ <span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_error'>error</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be_a'>be_a</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="Servus.html" title="Servus (module)">Servus</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Servus/Support.html" title="Servus::Support (module)">Support</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Servus/Support/Errors.html" title="Servus::Support::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Servus/Support/Errors/ServiceError.html" title="Servus::Support::Errors::ServiceError (class)">ServiceError</a></span></span><span class='rparen'>)</span>
176
+ <span class='kw'>end</span>
177
+ <span class='kw'>end</span>
178
+ <span class='kw'>end</span>
179
+ <span class='kw'>end</span>
180
+ </code></pre>
181
+
182
+ <h2 id="testing-service-composition">Testing Service Composition</h2>
183
+
184
+ <p>When testing services that call other services, mock the child services:</p>
185
+
186
+ <pre class="code ruby"><code class="ruby">describe Users::CreateWithAccount::Service do
187
+ # Make local or global helpers to clean up tests
188
+ def servus_success_result(data)
189
+ Servus::Support::Response.new(success: true, data: data, error: nil)
190
+ end
191
+
192
+ it &quot;calls both create services&quot; do
193
+ # Mock child services
194
+ allow(Users::Create::Service).to receive(:call).and_return(servus_success_result{ user: user })
195
+ allow(Accounts::Create::Service).to receive(:call).and_return(servus_success_result{ account: account })
196
+
197
+ result = described_class.call(email: &quot;test@example.com&quot;, plan: &quot;premium&quot;)
198
+
199
+ expect(Users::Create::Service).to have_received(:call)
200
+ expect(Accounts::Create::Service).to have_received(:call)
201
+
202
+ expect(result.success?).to be true
203
+ end
204
+ end
205
+ </code></pre>
206
+
207
+ <h2 id="testing-schema-validation">Testing Schema Validation</h2>
208
+
209
+ <p>Don&#39;t test that valid arguments pass validation - that&#39;s testing the framework. Do test that your schema catches invalid inputs:</p>
210
+
211
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_it'>it</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>validates required fields</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>do</span>
212
+ <span class='id identifier rubyid_expect'>expect</span> <span class='lbrace'>{</span>
213
+ <span class='const'>Service</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='label'>invalid:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>params</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
214
+ <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_raise_error'>raise_error</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="Servus.html" title="Servus (module)">Servus</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Servus/Support.html" title="Servus::Support (module)">Support</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Servus/Support/Errors.html" title="Servus::Support::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Servus/Support/Errors/ValidationError.html" title="Servus::Support::Errors::ValidationError (class)">ValidationError</a></span></span><span class='comma'>,</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>required</span><span class='regexp_end'>/</span></span><span class='rparen'>)</span>
215
+ <span class='kw'>end</span>
216
+ </code></pre>
217
+ </div></div>
218
+
219
+ <div id="footer">
220
+ Generated on Fri Nov 21 00:30:04 2025 by
221
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
222
+ 0.9.37 (ruby-3.4.4).
223
+ </div>
224
+
225
+ </div>
226
+ </body>
227
+ </html>
data/docs/yard/file_list.html ADDED
@@ -0,0 +1,119 @@
1
+ <!DOCTYPE html>
2
+ <html >
3
+ <head>
4
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
5
+ <meta charset="utf-8" />
6
+
7
+ <link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" />
8
+
9
+ <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" />
10
+
11
+
12
+
13
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
14
+
15
+ <script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
16
+
17
+
18
+ <title>File List</title>
19
+ <base id="base_target" target="_parent" />
20
+ </head>
21
+ <body>
22
+ <div id="content">
23
+ <div class="fixed_header">
24
+ <h1 id="full_list_header">File List</h1>
25
+ <div id="full_list_nav">
26
+
27
+ <span><a target="_self" href="class_list.html">
28
+ Classes
29
+ </a></span>
30
+
31
+ <span><a target="_self" href="method_list.html">
32
+ Methods
33
+ </a></span>
34
+
35
+ <span><a target="_self" href="file_list.html">
36
+ Files
37
+ </a></span>
38
+
39
+ </div>
40
+
41
+ <div id="search">
42
+ <label for="search-class">Search:</label>
43
+ <input id="search-class" type="text" />
44
+ </div>
45
+ </div>
46
+
47
+ <ul id="full_list" class="file">
48
+
49
+
50
+ <li id="object_READme" class="odd">
51
+ <div class="item"><span class="object_link"><a href="index.html" title="READme">READme</a></span></div>
52
+ </li>
53
+
54
+
55
+ <li id="object_1_overview" class="even">
56
+ <div class="item"><span class="object_link"><a href="file.1_overview.html" title="Core / 1. Overview">Core / 1. Overview</a></span></div>
57
+ </li>
58
+
59
+
60
+ <li id="object_2_architecture" class="odd">
61
+ <div class="item"><span class="object_link"><a href="file.2_architecture.html" title="Core / 2. Architecture">Core / 2. Architecture</a></span></div>
62
+ </li>
63
+
64
+
65
+ <li id="object_3_service_objects" class="even">
66
+ <div class="item"><span class="object_link"><a href="file.3_service_objects.html" title="Core / 3. Service Objects">Core / 3. Service Objects</a></span></div>
67
+ </li>
68
+
69
+
70
+ <li id="object_1_schema_validation" class="odd">
71
+ <div class="item"><span class="object_link"><a href="file.1_schema_validation.html" title="Features / 1. Schema Validation">Features / 1. Schema Validation</a></span></div>
72
+ </li>
73
+
74
+
75
+ <li id="object_2_error_handling" class="even">
76
+ <div class="item"><span class="object_link"><a href="file.2_error_handling.html" title="Features / 2. Error Handling">Features / 2. Error Handling</a></span></div>
77
+ </li>
78
+
79
+
80
+ <li id="object_3_async_execution" class="odd">
81
+ <div class="item"><span class="object_link"><a href="file.3_async_execution.html" title="Features / 3. Async Execution">Features / 3. Async Execution</a></span></div>
82
+ </li>
83
+
84
+
85
+ <li id="object_4_logging" class="even">
86
+ <div class="item"><span class="object_link"><a href="file.4_logging.html" title="Features / 4. Logging">Features / 4. Logging</a></span></div>
87
+ </li>
88
+
89
+
90
+ <li id="object_1_common_patterns" class="odd">
91
+ <div class="item"><span class="object_link"><a href="file.1_common_patterns.html" title="Guides / 1. Common Patterns">Guides / 1. Common Patterns</a></span></div>
92
+ </li>
93
+
94
+
95
+ <li id="object_2_migration_guide" class="even">
96
+ <div class="item"><span class="object_link"><a href="file.2_migration_guide.html" title="Guides / 2. Migration Guide">Guides / 2. Migration Guide</a></span></div>
97
+ </li>
98
+
99
+
100
+ <li id="object_1_configuration" class="odd">
101
+ <div class="item"><span class="object_link"><a href="file.1_configuration.html" title="Integration / 1. Configuration">Integration / 1. Configuration</a></span></div>
102
+ </li>
103
+
104
+
105
+ <li id="object_2_testing" class="even">
106
+ <div class="item"><span class="object_link"><a href="file.2_testing.html" title="Integration / 2. Testing">Integration / 2. Testing</a></span></div>
107
+ </li>
108
+
109
+
110
+ <li id="object_3_rails_integration" class="odd">
111
+ <div class="item"><span class="object_link"><a href="file.3_rails_integration.html" title="Integration / 3. Rails Integration">Integration / 3. Rails Integration</a></span></div>
112
+ </li>
113
+
114
+
115
+
116
+ </ul>
117
+ </div>
118
+ </body>
119
+ </html>
data/docs/yard/frames.html ADDED
@@ -0,0 +1,22 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <title>Servus | Service Object Framework</title>
6
+ </head>
7
+ <script type="text/javascript">
8
+ var mainUrl = 'index.html';
9
+ try {
10
+ var match = decodeURIComponent(window.location.hash).match(/^#!(.+)/);
11
+ var name = match ? match[1] : mainUrl;
12
+ var url = new URL(name, location.href);
13
+ window.top.location.replace(url.origin === location.origin ? name : mainUrl);
14
+ } catch (e) {
15
+ window.top.location.replace(mainUrl);
16
+ }
17
+ </script>
18
+ <noscript>
19
+ <h1>Oops!</h1>
20
+ <h2>YARD requires JavaScript!</h2>
21
+ </noscript>
22
+ </html>