servus 0.2.1 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (138) hide show
  1. checksums.yaml +4 -4
  2. data/lib/generators/servus/event_handler/event_handler_generator.rb +1 -1
  3. data/lib/generators/servus/guard/guard_generator.rb +1 -1
  4. data/lib/generators/servus/guard/templates/guard.rb.erb +5 -3
  5. data/lib/generators/servus/service/service_generator.rb +1 -1
  6. data/lib/servus/base.rb +67 -9
  7. data/lib/servus/config.rb +71 -3
  8. data/lib/servus/events/bus.rb +29 -0
  9. data/lib/servus/events/emitter.rb +15 -0
  10. data/lib/servus/extensions/lazily/call.rb +82 -0
  11. data/lib/servus/extensions/lazily/errors.rb +37 -0
  12. data/lib/servus/extensions/lazily/ext.rb +23 -0
  13. data/lib/servus/extensions/lazily/resolver.rb +32 -0
  14. data/lib/servus/guard.rb +7 -6
  15. data/lib/servus/guards/falsey_guard.rb +3 -3
  16. data/lib/servus/guards/presence_guard.rb +4 -4
  17. data/lib/servus/guards/state_guard.rb +4 -5
  18. data/lib/servus/guards/truthy_guard.rb +3 -3
  19. data/lib/servus/helpers/controller_helpers.rb +40 -0
  20. data/lib/servus/railtie.rb +7 -1
  21. data/lib/servus/support/data_object.rb +80 -0
  22. data/lib/servus/support/errors.rb +16 -0
  23. data/lib/servus/support/lockdown.rb +94 -0
  24. data/lib/servus/support/logger.rb +16 -0
  25. data/lib/servus/support/response.rb +12 -1
  26. data/lib/servus/support/validator.rb +79 -34
  27. data/lib/servus/testing/example_builders.rb +74 -0
  28. data/lib/servus/testing/matchers.rb +99 -0
  29. data/lib/servus/version.rb +1 -1
  30. data/lib/servus.rb +2 -0
  31. metadata +16 -114
  32. data/.claude/commands/check-docs.md +0 -1
  33. data/.claude/commands/consistency-check.md +0 -1
  34. data/.claude/commands/fine-tooth-comb.md +0 -1
  35. data/.claude/commands/red-green-refactor.md +0 -5
  36. data/.claude/settings.json +0 -24
  37. data/.rspec +0 -3
  38. data/.rubocop.yml +0 -27
  39. data/.yardopts +0 -6
  40. data/CHANGELOG.md +0 -122
  41. data/CLAUDE.md +0 -10
  42. data/IDEAS.md +0 -5
  43. data/LICENSE.txt +0 -21
  44. data/READme.md +0 -856
  45. data/Rakefile +0 -45
  46. data/docs/core/1_overview.md +0 -77
  47. data/docs/core/2_architecture.md +0 -120
  48. data/docs/core/3_service_objects.md +0 -121
  49. data/docs/features/1_schema_validation.md +0 -119
  50. data/docs/features/2_error_handling.md +0 -121
  51. data/docs/features/3_async_execution.md +0 -81
  52. data/docs/features/4_logging.md +0 -64
  53. data/docs/features/5_event_bus.md +0 -244
  54. data/docs/features/6_guards.md +0 -356
  55. data/docs/features/guards_naming_convention.md +0 -540
  56. data/docs/guides/1_common_patterns.md +0 -90
  57. data/docs/guides/2_migration_guide.md +0 -175
  58. data/docs/integration/1_configuration.md +0 -154
  59. data/docs/integration/2_testing.md +0 -287
  60. data/docs/integration/3_rails_integration.md +0 -99
  61. data/docs/yard/Servus/Base.html +0 -1645
  62. data/docs/yard/Servus/Config.html +0 -582
  63. data/docs/yard/Servus/Extensions/Async/Call.html +0 -400
  64. data/docs/yard/Servus/Extensions/Async/Errors/AsyncError.html +0 -140
  65. data/docs/yard/Servus/Extensions/Async/Errors/JobEnqueueError.html +0 -154
  66. data/docs/yard/Servus/Extensions/Async/Errors/ServiceNotFoundError.html +0 -154
  67. data/docs/yard/Servus/Extensions/Async/Errors.html +0 -128
  68. data/docs/yard/Servus/Extensions/Async/Ext.html +0 -119
  69. data/docs/yard/Servus/Extensions/Async/Job.html +0 -310
  70. data/docs/yard/Servus/Extensions/Async.html +0 -141
  71. data/docs/yard/Servus/Extensions.html +0 -117
  72. data/docs/yard/Servus/Generators/ServiceGenerator.html +0 -261
  73. data/docs/yard/Servus/Generators.html +0 -115
  74. data/docs/yard/Servus/Helpers/ControllerHelpers.html +0 -457
  75. data/docs/yard/Servus/Helpers.html +0 -115
  76. data/docs/yard/Servus/Railtie.html +0 -134
  77. data/docs/yard/Servus/Support/Errors/AuthenticationError.html +0 -287
  78. data/docs/yard/Servus/Support/Errors/BadRequestError.html +0 -283
  79. data/docs/yard/Servus/Support/Errors/ForbiddenError.html +0 -284
  80. data/docs/yard/Servus/Support/Errors/InternalServerError.html +0 -283
  81. data/docs/yard/Servus/Support/Errors/NotFoundError.html +0 -284
  82. data/docs/yard/Servus/Support/Errors/ServiceError.html +0 -489
  83. data/docs/yard/Servus/Support/Errors/ServiceUnavailableError.html +0 -290
  84. data/docs/yard/Servus/Support/Errors/UnauthorizedError.html +0 -200
  85. data/docs/yard/Servus/Support/Errors/UnprocessableEntityError.html +0 -288
  86. data/docs/yard/Servus/Support/Errors/ValidationError.html +0 -200
  87. data/docs/yard/Servus/Support/Errors.html +0 -140
  88. data/docs/yard/Servus/Support/Logger.html +0 -856
  89. data/docs/yard/Servus/Support/Rescuer/BlockContext.html +0 -585
  90. data/docs/yard/Servus/Support/Rescuer/CallOverride.html +0 -257
  91. data/docs/yard/Servus/Support/Rescuer/ClassMethods.html +0 -343
  92. data/docs/yard/Servus/Support/Rescuer.html +0 -267
  93. data/docs/yard/Servus/Support/Response.html +0 -574
  94. data/docs/yard/Servus/Support/Validator.html +0 -1150
  95. data/docs/yard/Servus/Support.html +0 -119
  96. data/docs/yard/Servus/Testing/ExampleBuilders.html +0 -523
  97. data/docs/yard/Servus/Testing/ExampleExtractor.html +0 -578
  98. data/docs/yard/Servus/Testing.html +0 -142
  99. data/docs/yard/Servus.html +0 -343
  100. data/docs/yard/_index.html +0 -535
  101. data/docs/yard/class_list.html +0 -54
  102. data/docs/yard/css/common.css +0 -1
  103. data/docs/yard/css/full_list.css +0 -58
  104. data/docs/yard/css/style.css +0 -503
  105. data/docs/yard/file.1_common_patterns.html +0 -154
  106. data/docs/yard/file.1_configuration.html +0 -115
  107. data/docs/yard/file.1_overview.html +0 -142
  108. data/docs/yard/file.1_schema_validation.html +0 -188
  109. data/docs/yard/file.2_architecture.html +0 -157
  110. data/docs/yard/file.2_error_handling.html +0 -190
  111. data/docs/yard/file.2_migration_guide.html +0 -242
  112. data/docs/yard/file.2_testing.html +0 -227
  113. data/docs/yard/file.3_async_execution.html +0 -145
  114. data/docs/yard/file.3_rails_integration.html +0 -160
  115. data/docs/yard/file.3_service_objects.html +0 -191
  116. data/docs/yard/file.4_logging.html +0 -135
  117. data/docs/yard/file.ErrorHandling.html +0 -190
  118. data/docs/yard/file.READme.html +0 -674
  119. data/docs/yard/file.architecture.html +0 -157
  120. data/docs/yard/file.async_execution.html +0 -145
  121. data/docs/yard/file.common_patterns.html +0 -154
  122. data/docs/yard/file.configuration.html +0 -115
  123. data/docs/yard/file.error_handling.html +0 -190
  124. data/docs/yard/file.logging.html +0 -135
  125. data/docs/yard/file.migration_guide.html +0 -242
  126. data/docs/yard/file.overview.html +0 -142
  127. data/docs/yard/file.rails_integration.html +0 -160
  128. data/docs/yard/file.schema_validation.html +0 -188
  129. data/docs/yard/file.service_objects.html +0 -191
  130. data/docs/yard/file.testing.html +0 -227
  131. data/docs/yard/file_list.html +0 -119
  132. data/docs/yard/frames.html +0 -22
  133. data/docs/yard/index.html +0 -674
  134. data/docs/yard/js/app.js +0 -344
  135. data/docs/yard/js/full_list.js +0 -242
  136. data/docs/yard/js/jquery.js +0 -4
  137. data/docs/yard/method_list.html +0 -542
  138. data/docs/yard/top-level-namespace.html +0 -110
data/docs/yard/Servus/Helpers/ControllerHelpers.html DELETED
@@ -1,457 +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
- Module: Servus::Helpers::ControllerHelpers
8
-
9
- &mdash; Servus | Service Object Framework
10
-
11
- </title>
12
-
13
- <link rel="stylesheet" href="../../css/style.css" type="text/css" />
14
-
15
- <link rel="stylesheet" href="../../css/common.css" type="text/css" />
16
-
17
- <script type="text/javascript">
18
- pathId = "Servus::Helpers::ControllerHelpers";
19
- relpath = '../../';
20
- </script>
21
-
22
-
23
- <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
24
-
25
- <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
26
-
27
-
28
- </head>
29
- <body>
30
- <div class="nav_wrap">
31
- <iframe id="nav" src="../../class_list.html?1"></iframe>
32
- <div id="resizer"></div>
33
- </div>
34
-
35
- <div id="main" tabindex="-1">
36
- <div id="header">
37
- <div id="menu">
38
-
39
- <a href="../../_index.html">Index (C)</a> &raquo;
40
- <span class='title'><span class='object_link'><a href="../../Servus.html" title="Servus (module)">Servus</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Helpers.html" title="Servus::Helpers (module)">Helpers</a></span></span>
41
- &raquo;
42
- <span class="title">ControllerHelpers</span>
43
-
44
- </div>
45
-
46
- <div id="search">
47
-
48
- <a class="full_list_link" id="class_list_link"
49
- href="../../class_list.html">
50
-
51
- <svg width="24" height="24">
52
- <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
- <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
- <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
- </svg>
56
- </a>
57
-
58
- </div>
59
- <div class="clear"></div>
60
- </div>
61
-
62
- <div id="content"><h1>Module: Servus::Helpers::ControllerHelpers
63
-
64
-
65
-
66
- </h1>
67
- <div class="box_info">
68
-
69
-
70
-
71
-
72
-
73
-
74
-
75
-
76
-
77
-
78
-
79
- <dl>
80
- <dt>Defined in:</dt>
81
- <dd>lib/servus/helpers/controller_helpers.rb</dd>
82
- </dl>
83
-
84
- </div>
85
-
86
- <h2>Overview</h2><div class="docstring">
87
- <div class="discussion">
88
- <p>Rails controller helper methods for service integration.</p>
89
-
90
- <p>Provides convenient methods for calling services from controllers and
91
- handling their responses. Automatically included in ActionController::Base
92
- when Servus is loaded in a Rails application.</p>
93
-
94
-
95
- </div>
96
- </div>
97
- <div class="tags">
98
-
99
- <div class="examples">
100
- <h4 class="tag_title">Examples:</h4>
101
-
102
-
103
- <h5 class="example_title"><div class='inline'><p>Including in a controller</p>
104
- </div></h5>
105
-
106
- <pre class="example code"><code><span class='kw'>class</span> <span class='const'>ApplicationController</span> <span class='op'>&lt;</span> <span class='const'>ActionController</span><span class='op'>::</span><span class='const'>Base</span>
107
- <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="../Helpers.html" title="Servus::Helpers (module)">Helpers</a></span></span><span class='op'>::</span><span class='const'>ControllerHelpers</span>
108
- <span class='kw'>end</span></code></pre>
109
-
110
- </div>
111
-
112
-
113
- <p class="tag_title">See Also:</p>
114
- <ul class="see">
115
-
116
- <li><span class='object_link'><a href="#run_service-instance_method" title="Servus::Helpers::ControllerHelpers#run_service (method)">#run_service</a></span></li>
117
-
118
- <li><span class='object_link'><a href="#render_service_object_error-instance_method" title="Servus::Helpers::ControllerHelpers#render_service_object_error (method)">#render_service_object_error</a></span></li>
119
-
120
- </ul>
121
-
122
- </div>
123
-
124
-
125
-
126
-
127
-
128
-
129
-
130
- <h2>
131
- Instance Method Summary
132
- <small><a href="#" class="summary_toggle">collapse</a></small>
133
- </h2>
134
-
135
- <ul class="summary">
136
-
137
- <li class="public ">
138
- <span class="summary_signature">
139
-
140
- <a href="#render_service_object_error-instance_method" title="#render_service_object_error (instance method)">#<strong>render_service_object_error</strong>(api_error) &#x21d2; void </a>
141
-
142
-
143
-
144
- </span>
145
-
146
-
147
-
148
-
149
-
150
-
151
-
152
-
153
-
154
- <span class="summary_desc"><div class='inline'><p>Renders a service error as a JSON response.</p>
155
- </div></span>
156
-
157
- </li>
158
-
159
-
160
- <li class="public ">
161
- <span class="summary_signature">
162
-
163
- <a href="#run_service-instance_method" title="#run_service (instance method)">#<strong>run_service</strong>(klass, params) &#x21d2; Servus::Support::Response<sup>?</sup> </a>
164
-
165
-
166
-
167
- </span>
168
-
169
-
170
-
171
-
172
-
173
-
174
-
175
-
176
-
177
- <span class="summary_desc"><div class='inline'><p>Executes a service and handles success/failure automatically.</p>
178
- </div></span>
179
-
180
- </li>
181
-
182
-
183
- </ul>
184
-
185
-
186
-
187
-
188
- <div id="instance_method_details" class="method_details_list">
189
- <h2>Instance Method Details</h2>
190
-
191
-
192
- <div class="method_details first">
193
- <h3 class="signature first" id="render_service_object_error-instance_method">
194
-
195
- #<strong>render_service_object_error</strong>(api_error) &#x21d2; <tt>void</tt>
196
-
197
-
198
-
199
-
200
-
201
- </h3><div class="docstring">
202
- <div class="discussion">
203
- <p class="note returns_void">This method returns an undefined value.</p><p>Renders a service error as a JSON response.</p>
204
-
205
- <p>This method is called automatically by <span class='object_link'><a href="#run_service-instance_method" title="Servus::Helpers::ControllerHelpers#run_service (method)">#run_service</a></span> when a service fails,
206
- but can also be called manually for custom error handling. It renders the
207
- error&#39;s api_error hash with the appropriate HTTP status code.</p>
208
-
209
- <p>Override this method in your controller to customize error response format.</p>
210
-
211
-
212
- </div>
213
- </div>
214
- <div class="tags">
215
-
216
- <div class="examples">
217
- <h4 class="tag_title">Examples:</h4>
218
-
219
-
220
- <h5 class="example_title"><div class='inline'><p>Default behavior</p>
221
- </div></h5>
222
-
223
- <pre class="example code"><code><span class='comment'># Renders: { code: :not_found, message: &quot;User not found&quot; }
224
- </span><span class='comment'># With status: 404
225
- </span><span class='id identifier rubyid_render_service_object_error'>render_service_object_error</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_api_error'>api_error</span><span class='rparen'>)</span></code></pre>
226
-
227
-
228
- <h5 class="example_title"><div class='inline'><p>Custom error rendering</p>
229
- </div></h5>
230
-
231
- <pre class="example code"><code><span class='kw'>class</span> <span class='const'>ApplicationController</span> <span class='op'>&lt;</span> <span class='const'>ActionController</span><span class='op'>::</span><span class='const'>Base</span>
232
- <span class='kw'>def</span> <span class='id identifier rubyid_render_service_object_error'>render_service_object_error</span><span class='lparen'>(</span><span class='id identifier rubyid_api_error'>api_error</span><span class='rparen'>)</span>
233
- <span class='id identifier rubyid_render'>render</span> <span class='label'>json:</span> <span class='lbrace'>{</span>
234
- <span class='label'>error:</span> <span class='lbrace'>{</span>
235
- <span class='label'>type:</span> <span class='id identifier rubyid_api_error'>api_error</span><span class='lbracket'>[</span><span class='symbol'>:code</span><span class='rbracket'>]</span><span class='comma'>,</span>
236
- <span class='label'>details:</span> <span class='id identifier rubyid_api_error'>api_error</span><span class='lbracket'>[</span><span class='symbol'>:message</span><span class='rbracket'>]</span><span class='comma'>,</span>
237
- <span class='label'>timestamp:</span> <span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_current'>current</span>
238
- <span class='rbrace'>}</span>
239
- <span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>status:</span> <span class='id identifier rubyid_api_error'>api_error</span><span class='lbracket'>[</span><span class='symbol'>:code</span><span class='rbracket'>]</span>
240
- <span class='kw'>end</span>
241
- <span class='kw'>end</span></code></pre>
242
-
243
- </div>
244
- <p class="tag_title">Parameters:</p>
245
- <ul class="param">
246
-
247
- <li>
248
-
249
- <span class='name'>api_error</span>
250
-
251
-
252
- <span class='type'>(<tt>Hash</tt>)</span>
253
-
254
-
255
-
256
- &mdash;
257
- <div class='inline'><p>error hash with :code and :message keys from <span class='object_link'><a href="../Support/Errors/ServiceError.html#api_error-instance_method" title="Servus::Support::Errors::ServiceError#api_error (method)">Support::Errors::ServiceError#api_error</a></span></p>
258
- </div>
259
-
260
- </li>
261
-
262
- </ul>
263
-
264
-
265
- <p class="tag_title">See Also:</p>
266
- <ul class="see">
267
-
268
- <li><span class='object_link'><a href="../Support/Errors/ServiceError.html#api_error-instance_method" title="Servus::Support::Errors::ServiceError#api_error (method)">Support::Errors::ServiceError#api_error</a></span></li>
269
-
270
- <li><span class='object_link'><a href="#run_service-instance_method" title="Servus::Helpers::ControllerHelpers#run_service (method)">#run_service</a></span></li>
271
-
272
- </ul>
273
-
274
- </div><table class="source_code">
275
- <tr>
276
- <td>
277
- <pre class="lines">
278
-
279
-
280
- 97
281
- 98
282
- 99</pre>
283
- </td>
284
- <td>
285
- <pre class="code"><span class="info file"># File 'lib/servus/helpers/controller_helpers.rb', line 97</span>
286
-
287
- <span class='kw'>def</span> <span class='id identifier rubyid_render_service_object_error'>render_service_object_error</span><span class='lparen'>(</span><span class='id identifier rubyid_api_error'>api_error</span><span class='rparen'>)</span>
288
- <span class='id identifier rubyid_render'>render</span> <span class='label'>json:</span> <span class='id identifier rubyid_api_error'>api_error</span><span class='comma'>,</span> <span class='label'>status:</span> <span class='id identifier rubyid_api_error'>api_error</span><span class='lbracket'>[</span><span class='symbol'>:code</span><span class='rbracket'>]</span>
289
- <span class='kw'>end</span></pre>
290
- </td>
291
- </tr>
292
- </table>
293
- </div>
294
-
295
- <div class="method_details ">
296
- <h3 class="signature " id="run_service-instance_method">
297
-
298
- #<strong>run_service</strong>(klass, params) &#x21d2; <tt><span class='object_link'><a href="../Support/Response.html" title="Servus::Support::Response (class)">Servus::Support::Response</a></span></tt><sup>?</sup>
299
-
300
-
301
-
302
-
303
-
304
- </h3><div class="docstring">
305
- <div class="discussion">
306
- <p>Executes a service and handles success/failure automatically.</p>
307
-
308
- <p>This method runs the service with the provided parameters. On success,
309
- it stores the result in @result for use in views. On failure, it
310
- automatically calls <span class='object_link'><a href="#render_service_object_error-instance_method" title="Servus::Helpers::ControllerHelpers#render_service_object_error (method)">#render_service_object_error</a></span> with the error details.</p>
311
-
312
- <p>The result is always stored in the @result instance variable, making it
313
- available in views for rendering successful responses.</p>
314
-
315
-
316
- </div>
317
- </div>
318
- <div class="tags">
319
-
320
- <div class="examples">
321
- <h4 class="tag_title">Examples:</h4>
322
-
323
-
324
- <h5 class="example_title"><div class='inline'><p>Basic usage</p>
325
- </div></h5>
326
-
327
- <pre class="example code"><code><span class='kw'>class</span> <span class='const'>UsersController</span> <span class='op'>&lt;</span> <span class='const'>ApplicationController</span>
328
- <span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span>
329
- <span class='id identifier rubyid_run_service'>run_service</span> <span class='const'>Services</span><span class='op'>::</span><span class='const'>CreateUser</span><span class='op'>::</span><span class='const'>Service</span><span class='comma'>,</span> <span class='id identifier rubyid_user_params'>user_params</span>
330
- <span class='comment'># If successful, @result is available for rendering
331
- </span> <span class='comment'># If failed, error response is automatically rendered
332
- </span> <span class='kw'>end</span>
333
- <span class='kw'>end</span></code></pre>
334
-
335
-
336
- <h5 class="example_title"><div class='inline'><p>Using @result in views</p>
337
- </div></h5>
338
-
339
- <pre class="example code"><code><span class='comment'># In your Jbuilder view (create.json.jbuilder)
340
- </span><span class='id identifier rubyid_json'>json</span><span class='period'>.</span><span class='id identifier rubyid_user'>user</span> <span class='kw'>do</span>
341
- <span class='id identifier rubyid_json'>json</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span> <span class='ivar'>@result</span><span class='period'>.</span><span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:user_id</span><span class='rbracket'>]</span>
342
- <span class='id identifier rubyid_json'>json</span><span class='period'>.</span><span class='id identifier rubyid_email'>email</span> <span class='ivar'>@result</span><span class='period'>.</span><span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:email</span><span class='rbracket'>]</span>
343
- <span class='kw'>end</span></code></pre>
344
-
345
-
346
- <h5 class="example_title"><div class='inline'><p>Manual success handling</p>
347
- </div></h5>
348
-
349
- <pre class="example code"><code><span class='kw'>class</span> <span class='const'>UsersController</span> <span class='op'>&lt;</span> <span class='const'>ApplicationController</span>
350
- <span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span>
351
- <span class='id identifier rubyid_run_service'>run_service</span> <span class='const'>Services</span><span class='op'>::</span><span class='const'>CreateUser</span><span class='op'>::</span><span class='const'>Service</span><span class='comma'>,</span> <span class='id identifier rubyid_user_params'>user_params</span>
352
- <span class='kw'>return</span> <span class='kw'>unless</span> <span class='ivar'>@result</span><span class='period'>.</span><span class='id identifier rubyid_success?'>success?</span>
353
-
354
- <span class='comment'># Custom success handling
355
- </span> <span class='id identifier rubyid_redirect_to'>redirect_to</span> <span class='id identifier rubyid_user_path'>user_path</span><span class='lparen'>(</span><span class='ivar'>@result</span><span class='period'>.</span><span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:user_id</span><span class='rbracket'>]</span><span class='rparen'>)</span>
356
- <span class='kw'>end</span>
357
- <span class='kw'>end</span></code></pre>
358
-
359
- </div>
360
- <p class="tag_title">Parameters:</p>
361
- <ul class="param">
362
-
363
- <li>
364
-
365
- <span class='name'>klass</span>
366
-
367
-
368
- <span class='type'>(<tt>Class</tt>)</span>
369
-
370
-
371
-
372
- &mdash;
373
- <div class='inline'><p>service class to execute (must inherit from <span class='object_link'><a href="../Base.html" title="Servus::Base (class)">Base</a></span>)</p>
374
- </div>
375
-
376
- </li>
377
-
378
- <li>
379
-
380
- <span class='name'>params</span>
381
-
382
-
383
- <span class='type'>(<tt>Hash</tt>)</span>
384
-
385
-
386
-
387
- &mdash;
388
- <div class='inline'><p>keyword arguments to pass to the service</p>
389
- </div>
390
-
391
- </li>
392
-
393
- </ul>
394
-
395
- <p class="tag_title">Returns:</p>
396
- <ul class="return">
397
-
398
- <li>
399
-
400
-
401
- <span class='type'>(<tt><span class='object_link'><a href="../Support/Response.html" title="Servus::Support::Response (class)">Servus::Support::Response</a></span></tt>, <tt>nil</tt>)</span>
402
-
403
-
404
-
405
- &mdash;
406
- <div class='inline'><p>the service result, or nil if error rendered</p>
407
- </div>
408
-
409
- </li>
410
-
411
- </ul>
412
-
413
- <p class="tag_title">See Also:</p>
414
- <ul class="see">
415
-
416
- <li><span class='object_link'><a href="#render_service_object_error-instance_method" title="Servus::Helpers::ControllerHelpers#render_service_object_error (method)">#render_service_object_error</a></span></li>
417
-
418
- <li><span class='object_link'><a href="../Base.html#call-class_method" title="Servus::Base.call (method)">Base.call</a></span></li>
419
-
420
- </ul>
421
-
422
- </div><table class="source_code">
423
- <tr>
424
- <td>
425
- <pre class="lines">
426
-
427
-
428
- 61
429
- 62
430
- 63
431
- 64</pre>
432
- </td>
433
- <td>
434
- <pre class="code"><span class="info file"># File 'lib/servus/helpers/controller_helpers.rb', line 61</span>
435
-
436
- <span class='kw'>def</span> <span class='id identifier rubyid_run_service'>run_service</span><span class='lparen'>(</span><span class='id identifier rubyid_klass'>klass</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
437
- <span class='ivar'>@result</span> <span class='op'>=</span> <span class='id identifier rubyid_klass'>klass</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_params'>params</span><span class='rparen'>)</span>
438
- <span class='id identifier rubyid_render_service_object_error'>render_service_object_error</span><span class='lparen'>(</span><span class='ivar'>@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='rparen'>)</span> <span class='kw'>unless</span> <span class='ivar'>@result</span><span class='period'>.</span><span class='id identifier rubyid_success?'>success?</span>
439
- <span class='kw'>end</span></pre>
440
- </td>
441
- </tr>
442
- </table>
443
- </div>
444
-
445
- </div>
446
-
447
- </div>
448
-
449
- <div id="footer">
450
- Generated on Fri Nov 21 00:33:23 2025 by
451
- <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
452
- 0.9.37 (ruby-3.4.4).
453
- </div>
454
-
455
- </div>
456
- </body>
457
- </html>
data/docs/yard/Servus/Helpers.html DELETED
@@ -1,115 +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
- Module: Servus::Helpers
8
-
9
- &mdash; Servus | Service Object Framework
10
-
11
- </title>
12
-
13
- <link rel="stylesheet" href="../css/style.css" type="text/css" />
14
-
15
- <link rel="stylesheet" href="../css/common.css" type="text/css" />
16
-
17
- <script type="text/javascript">
18
- pathId = "Servus::Helpers";
19
- relpath = '../';
20
- </script>
21
-
22
-
23
- <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
24
-
25
- <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
26
-
27
-
28
- </head>
29
- <body>
30
- <div class="nav_wrap">
31
- <iframe id="nav" src="../class_list.html?1"></iframe>
32
- <div id="resizer"></div>
33
- </div>
34
-
35
- <div id="main" tabindex="-1">
36
- <div id="header">
37
- <div id="menu">
38
-
39
- <a href="../_index.html">Index (H)</a> &raquo;
40
- <span class='title'><span class='object_link'><a href="../Servus.html" title="Servus (module)">Servus</a></span></span>
41
- &raquo;
42
- <span class="title">Helpers</span>
43
-
44
- </div>
45
-
46
- <div id="search">
47
-
48
- <a class="full_list_link" id="class_list_link"
49
- href="../class_list.html">
50
-
51
- <svg width="24" height="24">
52
- <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
- <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
- <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
- </svg>
56
- </a>
57
-
58
- </div>
59
- <div class="clear"></div>
60
- </div>
61
-
62
- <div id="content"><h1>Module: Servus::Helpers
63
-
64
-
65
-
66
- </h1>
67
- <div class="box_info">
68
-
69
-
70
-
71
-
72
-
73
-
74
-
75
-
76
-
77
-
78
-
79
- <dl>
80
- <dt>Defined in:</dt>
81
- <dd>lib/servus/helpers/controller_helpers.rb</dd>
82
- </dl>
83
-
84
- </div>
85
-
86
- <h2>Defined Under Namespace</h2>
87
- <p class="children">
88
-
89
-
90
- <strong class="modules">Modules:</strong> <span class='object_link'><a href="Helpers/ControllerHelpers.html" title="Servus::Helpers::ControllerHelpers (module)">ControllerHelpers</a></span>
91
-
92
-
93
-
94
-
95
- </p>
96
-
97
-
98
-
99
-
100
-
101
-
102
-
103
-
104
-
105
- </div>
106
-
107
- <div id="footer">
108
- Generated on Fri Nov 21 00:33:23 2025 by
109
- <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
110
- 0.9.37 (ruby-3.4.4).
111
- </div>
112
-
113
- </div>
114
- </body>
115
- </html>