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.
Files changed (144) hide show
  1. checksums.yaml +4 -4
  2. data/lib/generators/servus/event/event_generator.rb +54 -0
  3. data/lib/generators/servus/event/templates/event.rb.erb +44 -0
  4. data/lib/generators/servus/event/templates/event_spec.rb.erb +20 -0
  5. data/lib/generators/servus/guard/guard_generator.rb +1 -1
  6. data/lib/generators/servus/guard/templates/guard.rb.erb +5 -3
  7. data/lib/generators/servus/service/service_generator.rb +1 -1
  8. data/lib/servus/base.rb +46 -3
  9. data/lib/servus/config.rb +85 -12
  10. data/lib/servus/event.rb +235 -0
  11. data/lib/servus/events/bus.rb +111 -72
  12. data/lib/servus/events/class_router.rb +40 -0
  13. data/lib/servus/events/emitter.rb +21 -6
  14. data/lib/servus/events/invocation.rb +94 -0
  15. data/lib/servus/events/router.rb +44 -0
  16. data/lib/servus/guard.rb +7 -6
  17. data/lib/servus/guards/falsey_guard.rb +3 -3
  18. data/lib/servus/guards/presence_guard.rb +4 -4
  19. data/lib/servus/guards/state_guard.rb +4 -5
  20. data/lib/servus/guards/truthy_guard.rb +3 -3
  21. data/lib/servus/helpers/controller_helpers.rb +40 -0
  22. data/lib/servus/railtie.rb +10 -8
  23. data/lib/servus/support/errors.rb +16 -0
  24. data/lib/servus/support/lockdown.rb +94 -0
  25. data/lib/servus/support/logger.rb +18 -0
  26. data/lib/servus/support/validator.rb +70 -40
  27. data/lib/servus/testing/example_builders.rb +52 -0
  28. data/lib/servus/testing/matchers.rb +103 -4
  29. data/lib/servus/version.rb +1 -1
  30. data/lib/servus.rb +7 -2
  31. metadata +14 -116
  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 -169
  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 -81
  47. data/docs/core/2_architecture.md +0 -120
  48. data/docs/core/3_service_objects.md +0 -154
  49. data/docs/features/1_schema_validation.md +0 -161
  50. data/docs/features/2_error_handling.md +0 -129
  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/7_lazy_resolvers.md +0 -238
  56. data/docs/features/guards_naming_convention.md +0 -540
  57. data/docs/guides/1_common_patterns.md +0 -90
  58. data/docs/guides/2_migration_guide.md +0 -225
  59. data/docs/integration/1_configuration.md +0 -154
  60. data/docs/integration/2_testing.md +0 -304
  61. data/docs/integration/3_rails_integration.md +0 -99
  62. data/docs/yard/Servus/Base.html +0 -1645
  63. data/docs/yard/Servus/Config.html +0 -582
  64. data/docs/yard/Servus/Extensions/Async/Call.html +0 -400
  65. data/docs/yard/Servus/Extensions/Async/Errors/AsyncError.html +0 -140
  66. data/docs/yard/Servus/Extensions/Async/Errors/JobEnqueueError.html +0 -154
  67. data/docs/yard/Servus/Extensions/Async/Errors/ServiceNotFoundError.html +0 -154
  68. data/docs/yard/Servus/Extensions/Async/Errors.html +0 -128
  69. data/docs/yard/Servus/Extensions/Async/Ext.html +0 -119
  70. data/docs/yard/Servus/Extensions/Async/Job.html +0 -310
  71. data/docs/yard/Servus/Extensions/Async.html +0 -141
  72. data/docs/yard/Servus/Extensions.html +0 -117
  73. data/docs/yard/Servus/Generators/ServiceGenerator.html +0 -261
  74. data/docs/yard/Servus/Generators.html +0 -115
  75. data/docs/yard/Servus/Helpers/ControllerHelpers.html +0 -457
  76. data/docs/yard/Servus/Helpers.html +0 -115
  77. data/docs/yard/Servus/Railtie.html +0 -134
  78. data/docs/yard/Servus/Support/Errors/AuthenticationError.html +0 -287
  79. data/docs/yard/Servus/Support/Errors/BadRequestError.html +0 -283
  80. data/docs/yard/Servus/Support/Errors/ForbiddenError.html +0 -284
  81. data/docs/yard/Servus/Support/Errors/InternalServerError.html +0 -283
  82. data/docs/yard/Servus/Support/Errors/NotFoundError.html +0 -284
  83. data/docs/yard/Servus/Support/Errors/ServiceError.html +0 -489
  84. data/docs/yard/Servus/Support/Errors/ServiceUnavailableError.html +0 -290
  85. data/docs/yard/Servus/Support/Errors/UnauthorizedError.html +0 -200
  86. data/docs/yard/Servus/Support/Errors/UnprocessableEntityError.html +0 -288
  87. data/docs/yard/Servus/Support/Errors/ValidationError.html +0 -200
  88. data/docs/yard/Servus/Support/Errors.html +0 -140
  89. data/docs/yard/Servus/Support/Logger.html +0 -856
  90. data/docs/yard/Servus/Support/Rescuer/BlockContext.html +0 -585
  91. data/docs/yard/Servus/Support/Rescuer/CallOverride.html +0 -257
  92. data/docs/yard/Servus/Support/Rescuer/ClassMethods.html +0 -343
  93. data/docs/yard/Servus/Support/Rescuer.html +0 -267
  94. data/docs/yard/Servus/Support/Response.html +0 -574
  95. data/docs/yard/Servus/Support/Validator.html +0 -1150
  96. data/docs/yard/Servus/Support.html +0 -119
  97. data/docs/yard/Servus/Testing/ExampleBuilders.html +0 -523
  98. data/docs/yard/Servus/Testing/ExampleExtractor.html +0 -578
  99. data/docs/yard/Servus/Testing.html +0 -142
  100. data/docs/yard/Servus.html +0 -343
  101. data/docs/yard/_index.html +0 -535
  102. data/docs/yard/class_list.html +0 -54
  103. data/docs/yard/css/common.css +0 -1
  104. data/docs/yard/css/full_list.css +0 -58
  105. data/docs/yard/css/style.css +0 -503
  106. data/docs/yard/file.1_common_patterns.html +0 -154
  107. data/docs/yard/file.1_configuration.html +0 -115
  108. data/docs/yard/file.1_overview.html +0 -142
  109. data/docs/yard/file.1_schema_validation.html +0 -188
  110. data/docs/yard/file.2_architecture.html +0 -157
  111. data/docs/yard/file.2_error_handling.html +0 -190
  112. data/docs/yard/file.2_migration_guide.html +0 -242
  113. data/docs/yard/file.2_testing.html +0 -227
  114. data/docs/yard/file.3_async_execution.html +0 -145
  115. data/docs/yard/file.3_rails_integration.html +0 -160
  116. data/docs/yard/file.3_service_objects.html +0 -191
  117. data/docs/yard/file.4_logging.html +0 -135
  118. data/docs/yard/file.ErrorHandling.html +0 -190
  119. data/docs/yard/file.READme.html +0 -674
  120. data/docs/yard/file.architecture.html +0 -157
  121. data/docs/yard/file.async_execution.html +0 -145
  122. data/docs/yard/file.common_patterns.html +0 -154
  123. data/docs/yard/file.configuration.html +0 -115
  124. data/docs/yard/file.error_handling.html +0 -190
  125. data/docs/yard/file.logging.html +0 -135
  126. data/docs/yard/file.migration_guide.html +0 -242
  127. data/docs/yard/file.overview.html +0 -142
  128. data/docs/yard/file.rails_integration.html +0 -160
  129. data/docs/yard/file.schema_validation.html +0 -188
  130. data/docs/yard/file.service_objects.html +0 -191
  131. data/docs/yard/file.testing.html +0 -227
  132. data/docs/yard/file_list.html +0 -119
  133. data/docs/yard/frames.html +0 -22
  134. data/docs/yard/index.html +0 -674
  135. data/docs/yard/js/app.js +0 -344
  136. data/docs/yard/js/full_list.js +0 -242
  137. data/docs/yard/js/jquery.js +0 -4
  138. data/docs/yard/method_list.html +0 -542
  139. data/docs/yard/top-level-namespace.html +0 -110
  140. data/lib/generators/servus/event_handler/event_handler_generator.rb +0 -59
  141. data/lib/generators/servus/event_handler/templates/handler.rb.erb +0 -86
  142. data/lib/generators/servus/event_handler/templates/handler_spec.rb.erb +0 -48
  143. data/lib/servus/event_handler.rb +0 -290
  144. data/lib/servus/events/errors.rb +0 -10
data/docs/yard/file.error_handling.html DELETED
@@ -1,190 +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
- File: Features / Error Handling
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 = "error_handling";
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: Features / Error Handling</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="error-handling">Error Handling</h1>
61
-
62
- <p>Servus distinguishes between expected business failures (return failure) and unexpected system errors (raise exceptions). This separation makes error handling predictable and explicit.</p>
63
-
64
- <h2 id="failures-vs-exceptions">Failures vs Exceptions</h2>
65
-
66
- <p><strong>Use <code>failure()</code></strong> for expected business conditions:</p>
67
-
68
- <ul>
69
- <li>User not found</li>
70
- <li>Insufficient balance</li>
71
- <li>Invalid state transition</li>
72
- </ul>
73
-
74
- <p><strong>Use <code>error!()</code> or raise</strong> for unexpected system errors:</p>
75
-
76
- <ul>
77
- <li>Database connection failure</li>
78
- <li>Nil reference error</li>
79
- <li>External API timeout</li>
80
- </ul>
81
-
82
- <p>Failures return a Response object so callers can handle them. Exceptions halt execution and bubble up.</p>
83
-
84
- <pre class="code ruby"><code class="ruby"><span class='kw'>def</span> <span class='id identifier rubyid_call'>call</span>
85
- <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_find_by'>find_by</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='id identifier rubyid_user_id'>user_id</span><span class='rparen'>)</span>
86
- <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'>User not found</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>type:</span> <span class='const'>NotFoundError</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_user'>user</span>
87
- <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'>Insufficient funds</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_user'>user</span><span class='period'>.</span><span class='id identifier rubyid_balance'>balance</span> <span class='op'>&gt;=</span> <span class='id identifier rubyid_amount'>amount</span>
88
-
89
- <span class='id identifier rubyid_user'>user</span><span class='period'>.</span><span class='id identifier rubyid_update!'>update!</span><span class='lparen'>(</span><span class='label'>balance:</span> <span class='id identifier rubyid_user'>user</span><span class='period'>.</span><span class='id identifier rubyid_balance'>balance</span> <span class='op'>-</span> <span class='id identifier rubyid_amount'>amount</span><span class='rparen'>)</span> <span class='comment'># Raises on system error
90
- </span> <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>
91
- <span class='kw'>end</span>
92
- </code></pre>
93
-
94
- <h2 id="error-classes">Error Classes</h2>
95
-
96
- <p>All error classes inherit from <code>ServiceError</code> and map to HTTP status codes. Use them for API-friendly errors.</p>
97
-
98
- <pre class="code ruby"><code class="ruby"><span class='comment'># Built-in errors
99
- </span><span class='const'>NotFoundError</span> <span class='comment'># 404
100
- </span><span class='const'>BadRequestError</span> <span class='comment'># 400
101
- </span><span class='const'>UnauthorizedError</span> <span class='comment'># 401
102
- </span><span class='const'>ForbiddenError</span> <span class='comment'># 403
103
- </span><span class='const'>ValidationError</span> <span class='comment'># 422
104
- </span><span class='const'>InternalServerError</span> <span class='comment'># 500
105
- </span><span class='const'>ServiceUnavailableError</span> <span class='comment'># 503
106
- </span>
107
- <span class='comment'># Usage
108
- </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'>Resource not found</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>type:</span> <span class='const'>NotFoundError</span><span class='rparen'>)</span>
109
- <span class='id identifier rubyid_error!'>error!</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Database corrupted</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>type:</span> <span class='const'>InternalServerError</span><span class='rparen'>)</span> <span class='comment'># Raises exception
110
- </span></code></pre>
111
-
112
- <p>Each error has an <code>api_error</code> method returning <code>{ code: :symbol, message: &quot;string&quot; }</code> for JSON APIs.</p>
113
-
114
- <h2 id="declarative-exception-handling">Declarative Exception Handling</h2>
115
-
116
- <p>Use <code>rescue_from</code> to convert specific exceptions into failures. Original exception details are preserved in error messages.</p>
117
-
118
- <pre class="code ruby"><code class="ruby">class CallExternalApi::Service &lt; Servus::Base
119
- rescue_from Net::HTTPError, Timeout::Error use: ServiceUnavailableError
120
- rescue_from JSON::ParserError, use: BadRequestError
121
-
122
- def call
123
- response = http_client.get(url) # May raise
124
- data = JSON.parse(response.body) # May raise
125
- success(data: data)
126
- end
127
- end
128
-
129
- # If Net::HTTPError is raised, service returns:
130
- # Response(success: false, error: ServiceUnavailableError(&quot;[Net::HTTPError]: original message&quot;))
131
- </code></pre>
132
-
133
- <p>The <code>rescue_from</code> pattern keeps business logic clean while ensuring consistent error handling across services.</p>
134
-
135
- <h3 id="custom-error-handling-with-blocks">Custom Error Handling with Blocks</h3>
136
-
137
- <p>For more control over error handling, provide a block to <code>rescue_from</code>. The block receives the exception and can return either success or failure:</p>
138
-
139
- <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>
140
- <span class='comment'># Custom failure with error details
141
- </span> <span class='id identifier rubyid_rescue_from'>rescue_from</span> <span class='const'>ActiveRecord</span><span class='op'>::</span><span class='const'>RecordInvalid</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_exception'>exception</span><span class='op'>|</span>
142
- <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'>Payment failed: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_exception'>exception</span><span class='period'>.</span><span class='id identifier rubyid_record'>record</span><span class='period'>.</span><span class='id identifier rubyid_errors'>errors</span><span class='period'>.</span><span class='id identifier rubyid_full_messages'>full_messages</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>, </span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
143
- <span class='label'>type:</span> <span class='const'>ValidationError</span><span class='rparen'>)</span>
144
- <span class='kw'>end</span>
145
-
146
- <span class='comment'># Recover from certain errors with success
147
- </span> <span class='id identifier rubyid_rescue_from'>rescue_from</span> <span class='const'>Stripe</span><span class='op'>::</span><span class='const'>CardError</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_exception'>exception</span><span class='op'>|</span>
148
- <span class='kw'>if</span> <span class='id identifier rubyid_exception'>exception</span><span class='period'>.</span><span class='id identifier rubyid_code'>code</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>card_declined</span><span class='tstring_end'>&#39;</span></span>
149
- <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'>Card was declined</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>type:</span> <span class='const'>BadRequestError</span><span class='rparen'>)</span>
150
- <span class='kw'>else</span>
151
- <span class='comment'># Log and continue for other card errors
152
- </span> <span class='const'>Rails</span><span class='period'>.</span><span class='id identifier rubyid_logger'>logger</span><span class='period'>.</span><span class='id identifier rubyid_warn'>warn</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Stripe error: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_exception'>exception</span><span class='period'>.</span><span class='id identifier rubyid_message'>message</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
153
- <span class='id identifier rubyid_success'>success</span><span class='lparen'>(</span><span class='label'>recovered:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>fallback_used:</span> <span class='kw'>true</span><span class='rparen'>)</span>
154
- <span class='kw'>end</span>
155
- <span class='kw'>end</span>
156
-
157
- <span class='kw'>def</span> <span class='id identifier rubyid_call'>call</span>
158
- <span class='comment'># Service logic that may raise exceptions
159
- </span> <span class='kw'>end</span>
160
- <span class='kw'>end</span>
161
- </code></pre>
162
-
163
- <p>The block has access to <code>success(data)</code> and <code>failure(message, type:)</code> methods. This allows conditional error handling and even recovering from exceptions.</p>
164
-
165
- <h2 id="custom-errors">Custom Errors</h2>
166
-
167
- <p>Create domain-specific errors by inheriting from <code>ServiceError</code>:</p>
168
-
169
- <pre class="code ruby"><code class="ruby"><span class='kw'>class</span> <span class='const'>InsufficientFundsError</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/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>
170
- <span class='const'>DEFAULT_MESSAGE</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Insufficient funds</span><span class='tstring_end'>&quot;</span></span>
171
-
172
- <span class='kw'>def</span> <span class='id identifier rubyid_api_error'>api_error</span>
173
- <span class='lbrace'>{</span> <span class='label'>code:</span> <span class='symbol'>:insufficient_funds</span><span class='comma'>,</span> <span class='label'>message:</span> <span class='id identifier rubyid_message'>message</span> <span class='rbrace'>}</span>
174
- <span class='kw'>end</span>
175
- <span class='kw'>end</span>
176
-
177
- <span class='comment'># Usage
178
- </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'>Account balance too low</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>type:</span> <span class='const'>InsufficientFundsError</span><span class='rparen'>)</span>
179
- </code></pre>
180
- </div></div>
181
-
182
- <div id="footer">
183
- Generated on Fri Nov 21 00:30:04 2025 by
184
- <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
185
- 0.9.37 (ruby-3.4.4).
186
- </div>
187
-
188
- </div>
189
- </body>
190
- </html>
data/docs/yard/file.logging.html DELETED
@@ -1,135 +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
- File: Features / Logging
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 = "logging";
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: Features / Logging</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="logging">Logging</h1>
61
-
62
- <p>Servus automatically logs all service executions with timing information. No instrumentation code needed in services.</p>
63
-
64
- <h2 id="what-gets-logged">What Gets Logged</h2>
65
-
66
- <p><strong>Service calls</strong> (DEBUG): Service class name and arguments</p>
67
-
68
- <pre class="code ruby"><code class="ruby">[Servus] Users::Create::Service called with {:email=&gt;&quot;user@example.com&quot;, :name=&gt;&quot;John&quot;}
69
- </code></pre>
70
-
71
- <p><strong>Successful completions</strong> (INFO): Service class name and duration</p>
72
-
73
- <pre class="code ruby"><code class="ruby">[Servus] Users::Create::Service completed successfully in 0.0243s
74
- </code></pre>
75
-
76
- <p><strong>Failures</strong> (WARN): Service class name, error type, message, and duration</p>
77
-
78
- <pre class="code ruby"><code class="ruby">[Servus] Users::Create::Service failed with NotFoundError: User not found (0.0125s)
79
- </code></pre>
80
-
81
- <p><strong>Exceptions</strong> (ERROR): Service class name, exception type, message, and duration</p>
82
-
83
- <pre class="code ruby"><code class="ruby">[Servus] Users::Create::Service raised ArgumentError: Missing required field (0.0089s)
84
- </code></pre>
85
-
86
- <h2 id="log-levels">Log Levels</h2>
87
-
88
- <p>Servus uses Rails.logger and respects application log level configuration:</p>
89
-
90
- <ul>
91
- <li><strong>DEBUG</strong>: Shows arguments (use in development, hide in production to avoid logging sensitive data)</li>
92
- <li><strong>INFO</strong>: Shows completions (normal operations)</li>
93
- <li><strong>WARN</strong>: Shows business failures</li>
94
- <li><strong>ERROR</strong>: Shows system exceptions</li>
95
- </ul>
96
-
97
- <p>Set production log level to INFO to hide argument logging:</p>
98
-
99
- <pre class="code ruby"><code class="ruby"><span class='comment'># config/environments/production.rb
100
- </span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_log_level'>log_level</span> <span class='op'>=</span> <span class='symbol'>:info</span>
101
- </code></pre>
102
-
103
- <h2 id="sensitive-data">Sensitive Data</h2>
104
-
105
- <p>Arguments are logged at DEBUG level. In production, either:</p>
106
-
107
- <ol>
108
- <li>Set log level to INFO (recommended)</li>
109
- <li>Use Rails parameter filtering: <code>config.filter_parameters += [:password, :ssn, :credit_card]</code></li>
110
- <li>Pass IDs instead of full objects: <code>Service.call(user_id: 1)</code> not <code>Service.call(user: user_object)</code></li>
111
- </ol>
112
-
113
- <h2 id="integration-with-logging-tools">Integration with Logging Tools</h2>
114
-
115
- <p>The <code>[Servus]</code> prefix makes service logs easy to grep and filter:</p>
116
-
117
- <pre class="code bash"><code class="bash"># Find all service calls
118
- grep &quot;\[Servus\]&quot; production.log
119
-
120
- # Find slow services
121
- grep &quot;completed&quot; production.log | grep &quot;Servus&quot; | awk &#39;{print $NF}&#39; | sort -n
122
- </code></pre>
123
-
124
- <p>Servus logs work with structured logging tools (Lograge, Datadog, Splunk) without modification.</p>
125
- </div></div>
126
-
127
- <div id="footer">
128
- Generated on Fri Nov 21 00:30:04 2025 by
129
- <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
130
- 0.9.37 (ruby-3.4.4).
131
- </div>
132
-
133
- </div>
134
- </body>
135
- </html>
data/docs/yard/file.migration_guide.html DELETED
@@ -1,242 +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
- File: Guides / Migration Guide
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 = "migration_guide";
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: Guides / Migration Guide</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="migration-guide">Migration Guide</h1>
61
-
62
- <p>Strategies for adopting Servus in existing Rails applications.</p>
63
-
64
- <h2 id="incremental-adoption">Incremental Adoption</h2>
65
-
66
- <p>Servus coexists with existing code - no need to rewrite your entire application. Start with one complex use case, validate the pattern works for your team, then expand gradually.</p>
67
-
68
- <h2 id="extracting-from-fat-controllers">Extracting from Fat Controllers</h2>
69
-
70
- <p>Identify controller actions with complex business logic and extract to services:</p>
71
-
72
- <p><strong>Before</strong>:</p>
73
-
74
- <pre class="code ruby"><code class="ruby"><span class='kw'>class</span> <span class='const'>OrdersController</span> <span class='op'>&lt;</span> <span class='const'>ApplicationController</span>
75
- <span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span>
76
- <span class='comment'># 50 lines of business logic
77
- </span> <span class='comment'># Multiple model operations
78
- </span> <span class='comment'># External API calls
79
- </span> <span class='comment'># Email sending
80
- </span> <span class='kw'>end</span>
81
- <span class='kw'>end</span>
82
- </code></pre>
83
-
84
- <p><strong>After</strong>:</p>
85
-
86
- <pre class="code ruby"><code class="ruby"><span class='kw'>class</span> <span class='const'>OrdersController</span> <span class='op'>&lt;</span> <span class='const'>ApplicationController</span>
87
- <span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span>
88
- <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='const'>Orders</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_order_params'>order_params</span><span class='rparen'>)</span>
89
- <span class='kw'>if</span> <span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_success?'>success?</span>
90
- <span class='id identifier rubyid_render'>render</span> <span class='label'>json:</span> <span class='lbrace'>{</span> <span class='label'>order:</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'>:order</span><span class='rbracket'>]</span> <span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>status:</span> <span class='symbol'>:created</span>
91
- <span class='kw'>else</span>
92
- <span class='id identifier rubyid_render'>render</span> <span class='label'>json:</span> <span class='lbrace'>{</span> <span class='label'>error:</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_api_error'>api_error</span> <span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>status:</span> <span class='symbol'>:unprocessable_entity</span>
93
- <span class='kw'>end</span>
94
- <span class='kw'>end</span>
95
- <span class='kw'>end</span>
96
-
97
- <span class='comment'># Or use the helper
98
- </span><span class='kw'>class</span> <span class='const'>OrdersController</span> <span class='op'>&lt;</span> <span class='const'>ApplicationController</span>
99
- <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/Helpers.html" title="Servus::Helpers (module)">Helpers</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Servus/Helpers/ControllerHelpers.html" title="Servus::Helpers::ControllerHelpers (module)">ControllerHelpers</a></span></span>
100
-
101
- <span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span>
102
- <span class='id identifier rubyid_run_service'>run_service</span><span class='lparen'>(</span><span class='const'>Orders</span><span class='op'>::</span><span class='const'>Create</span><span class='op'>::</span><span class='const'>Service</span><span class='comma'>,</span> <span class='id identifier rubyid_order_params'>order_params</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_result'>result</span><span class='op'>|</span>
103
- <span class='id identifier rubyid_render'>render</span> <span class='label'>json:</span> <span class='lbrace'>{</span> <span class='label'>order:</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'>:order</span><span class='rbracket'>]</span> <span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>status:</span> <span class='symbol'>:created</span>
104
- <span class='kw'>end</span>
105
- <span class='kw'>end</span>
106
- <span class='kw'>end</span>
107
- </code></pre>
108
-
109
- <h2 id="extracting-from-fat-models">Extracting from Fat Models</h2>
110
-
111
- <p>Move orchestration logic from models to services. Keep data-related methods in models:</p>
112
-
113
- <p><strong>Before</strong>:</p>
114
-
115
- <pre class="code ruby"><code class="ruby"><span class='kw'>class</span> <span class='const'>Order</span> <span class='op'>&lt;</span> <span class='const'>ApplicationRecord</span>
116
- <span class='kw'>def</span> <span class='id identifier rubyid_complete_purchase'>complete_purchase</span>
117
- <span class='id identifier rubyid_charge_payment'>charge_payment</span>
118
- <span class='id identifier rubyid_update_inventory'>update_inventory</span>
119
- <span class='id identifier rubyid_send_confirmation_email'>send_confirmation_email</span>
120
- <span class='id identifier rubyid_create_invoice'>create_invoice</span>
121
- <span class='kw'>end</span>
122
- <span class='kw'>end</span>
123
- </code></pre>
124
-
125
- <p><strong>After</strong>:</p>
126
-
127
- <pre class="code ruby"><code class="ruby"><span class='kw'>class</span> <span class='const'>Order</span> <span class='op'>&lt;</span> <span class='const'>ApplicationRecord</span>
128
- <span class='comment'># Model focuses on data
129
- </span> <span class='id identifier rubyid_validates'>validates</span> <span class='symbol'>:total</span><span class='comma'>,</span> <span class='label'>presence:</span> <span class='kw'>true</span>
130
- <span class='id identifier rubyid_belongs_to'>belongs_to</span> <span class='symbol'>:user</span>
131
- <span class='kw'>end</span>
132
-
133
- <span class='kw'>class</span> <span class='const'>Orders</span><span class='op'>::</span><span class='const'>CompletePurchase</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>
134
- <span class='comment'># Service handles orchestration
135
- </span> <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>order_id:</span><span class='rparen'>)</span>
136
- <span class='ivar'>@order_id</span> <span class='op'>=</span> <span class='id identifier rubyid_order_id'>order_id</span>
137
- <span class='kw'>end</span>
138
-
139
- <span class='kw'>def</span> <span class='id identifier rubyid_call'>call</span>
140
- <span class='id identifier rubyid_order'>order</span> <span class='op'>=</span> <span class='const'>Order</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span><span class='lparen'>(</span><span class='ivar'>@order_id</span><span class='rparen'>)</span>
141
- <span class='const'>Payments</span><span class='op'>::</span><span class='const'>Charge</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'>order_id:</span> <span class='id identifier rubyid_order'>order</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
142
- <span class='const'>Inventory</span><span class='op'>::</span><span class='const'>Update</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'>order_id:</span> <span class='id identifier rubyid_order'>order</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
143
- <span class='const'>Mailers</span><span class='op'>::</span><span class='const'>SendConfirmation</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'>order_id:</span> <span class='id identifier rubyid_order'>order</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
144
- <span class='id identifier rubyid_success'>success</span><span class='lparen'>(</span><span class='label'>order:</span> <span class='id identifier rubyid_order'>order</span><span class='rparen'>)</span>
145
- <span class='kw'>end</span>
146
- <span class='kw'>end</span>
147
- </code></pre>
148
-
149
- <h2 id="replacing-callbacks">Replacing Callbacks</h2>
150
-
151
- <p>Extract callback logic to explicit service calls:</p>
152
-
153
- <p><strong>Before</strong>:</p>
154
-
155
- <pre class="code ruby"><code class="ruby"><span class='kw'>class</span> <span class='const'>User</span> <span class='op'>&lt;</span> <span class='const'>ApplicationRecord</span>
156
- <span class='id identifier rubyid_after_create'>after_create</span> <span class='symbol'>:send_welcome_email</span>
157
- <span class='id identifier rubyid_after_create'>after_create</span> <span class='symbol'>:create_default_account</span>
158
- <span class='id identifier rubyid_after_update'>after_update</span> <span class='symbol'>:notify_changes</span><span class='comma'>,</span> <span class='label'>if:</span> <span class='symbol'>:email_changed?</span>
159
- <span class='kw'>end</span>
160
- </code></pre>
161
-
162
- <p><strong>After</strong>:</p>
163
-
164
- <pre class="code ruby"><code class="ruby"><span class='kw'>class</span> <span class='const'>User</span> <span class='op'>&lt;</span> <span class='const'>ApplicationRecord</span>
165
- <span class='comment'># Minimal or no callbacks
166
- </span><span class='kw'>end</span>
167
-
168
- <span class='kw'>class</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='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>
169
- <span class='kw'>def</span> <span class='id identifier rubyid_call'>call</span>
170
- <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='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
171
- <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>
172
- <span class='id identifier rubyid_create_default_account'>create_default_account</span><span class='lparen'>(</span><span class='id identifier rubyid_user'>user</span><span class='rparen'>)</span>
173
- <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>
174
- <span class='kw'>end</span>
175
- <span class='kw'>end</span>
176
- </code></pre>
177
-
178
- <h2 id="migrating-background-jobs">Migrating Background Jobs</h2>
179
-
180
- <p>Extract job logic to services, call via <code>.call_async</code>:</p>
181
-
182
- <p><strong>Before</strong>:</p>
183
-
184
- <pre class="code ruby"><code class="ruby"><span class='kw'>class</span> <span class='const'>ProcessOrderJob</span> <span class='op'>&lt;</span> <span class='const'>ApplicationJob</span>
185
- <span class='kw'>def</span> <span class='id identifier rubyid_perform'>perform</span><span class='lparen'>(</span><span class='id identifier rubyid_order_id'>order_id</span><span class='rparen'>)</span>
186
- <span class='comment'># 50 lines of business logic
187
- </span> <span class='kw'>end</span>
188
- <span class='kw'>end</span>
189
-
190
- <span class='const'>ProcessOrderJob</span><span class='period'>.</span><span class='id identifier rubyid_perform_later'>perform_later</span><span class='lparen'>(</span><span class='id identifier rubyid_order'>order</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
191
- </code></pre>
192
-
193
- <p><strong>After</strong>:</p>
194
-
195
- <pre class="code ruby"><code class="ruby"><span class='kw'>class</span> <span class='const'>Orders</span><span class='op'>::</span><span class='const'>Process</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>
196
- <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>order_id:</span><span class='rparen'>)</span>
197
- <span class='ivar'>@order_id</span> <span class='op'>=</span> <span class='id identifier rubyid_order_id'>order_id</span>
198
- <span class='kw'>end</span>
199
-
200
- <span class='kw'>def</span> <span class='id identifier rubyid_call'>call</span>
201
- <span class='comment'># Business logic
202
- </span> <span class='kw'>end</span>
203
- <span class='kw'>end</span>
204
-
205
- <span class='const'>Orders</span><span class='op'>::</span><span class='const'>Process</span><span class='op'>::</span><span class='const'>Service</span><span class='period'>.</span><span class='id identifier rubyid_call_async'>call_async</span><span class='lparen'>(</span><span class='label'>order_id:</span> <span class='id identifier rubyid_order'>order</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
206
- </code></pre>
207
-
208
- <p>Now the service can be called synchronously (from console, tests) or asynchronously (from controllers, jobs).</p>
209
-
210
- <h2 id="testing-during-migration">Testing During Migration</h2>
211
-
212
- <p>Keep existing tests working while adding service tests:</p>
213
-
214
- <pre class="code ruby"><code class="ruby"><span class='comment'># Keep existing controller test
215
- </span><span class='id identifier rubyid_describe'>describe</span> <span class='const'>OrdersController</span> <span class='kw'>do</span>
216
- <span class='id identifier rubyid_it'>it</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>creates order</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>do</span>
217
- <span class='id identifier rubyid_post'>post</span> <span class='symbol'>:create</span><span class='comma'>,</span> <span class='label'>params:</span> <span class='id identifier rubyid_params'>params</span>
218
- <span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be_successful'>be_successful</span>
219
- <span class='kw'>end</span>
220
- <span class='kw'>end</span>
221
-
222
- <span class='comment'># Add service test
223
- </span><span class='id identifier rubyid_describe'>describe</span> <span class='const'>Orders</span><span class='op'>::</span><span class='const'>Create</span><span class='op'>::</span><span class='const'>Service</span> <span class='kw'>do</span>
224
- <span class='id identifier rubyid_it'>it</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>creates order</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>do</span>
225
- <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='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
226
- <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>
227
- <span class='kw'>end</span>
228
- <span class='kw'>end</span>
229
- </code></pre>
230
-
231
- <p>Remove legacy tests after service tests prove comprehensive.</p>
232
- </div></div>
233
-
234
- <div id="footer">
235
- Generated on Fri Nov 21 00:30:04 2025 by
236
- <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
237
- 0.9.37 (ruby-3.4.4).
238
- </div>
239
-
240
- </div>
241
- </body>
242
- </html>