RubyGems - servus - Versions diffs - 0.3.0 → 0.4.0 - Mend

servus 0.3.0 → 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 (132) hide show

checksums.yaml +4 -4
data/lib/generators/servus/event_handler/event_handler_generator.rb +1 -1
data/lib/generators/servus/guard/guard_generator.rb +1 -1
data/lib/generators/servus/guard/templates/guard.rb.erb +5 -3
data/lib/generators/servus/service/service_generator.rb +1 -1
data/lib/servus/base.rb +46 -3
data/lib/servus/config.rb +71 -3
data/lib/servus/events/bus.rb +29 -0
data/lib/servus/events/emitter.rb +15 -0
data/lib/servus/guard.rb +7 -6
data/lib/servus/guards/falsey_guard.rb +3 -3
data/lib/servus/guards/presence_guard.rb +4 -4
data/lib/servus/guards/state_guard.rb +4 -5
data/lib/servus/guards/truthy_guard.rb +3 -3
data/lib/servus/helpers/controller_helpers.rb +40 -0
data/lib/servus/support/errors.rb +16 -0
data/lib/servus/support/lockdown.rb +94 -0
data/lib/servus/support/logger.rb +16 -0
data/lib/servus/support/validator.rb +65 -34
data/lib/servus/testing/example_builders.rb +52 -0
data/lib/servus/testing/matchers.rb +99 -0
data/lib/servus/version.rb +1 -1
data/lib/servus.rb +1 -0
metadata +7 -111
data/.claude/commands/check-docs.md +0 -1
data/.claude/commands/consistency-check.md +0 -1
data/.claude/commands/fine-tooth-comb.md +0 -1
data/.claude/commands/red-green-refactor.md +0 -5
data/.claude/settings.json +0 -24
data/.rspec +0 -3
data/.rubocop.yml +0 -27
data/.yardopts +0 -6
data/CHANGELOG.md +0 -169
data/CLAUDE.md +0 -10
data/IDEAS.md +0 -5
data/LICENSE.txt +0 -21
data/READme.md +0 -856
data/Rakefile +0 -45
data/docs/core/1_overview.md +0 -81
data/docs/core/2_architecture.md +0 -120
data/docs/core/3_service_objects.md +0 -154
data/docs/features/1_schema_validation.md +0 -161
data/docs/features/2_error_handling.md +0 -129
data/docs/features/3_async_execution.md +0 -81
data/docs/features/4_logging.md +0 -64
data/docs/features/5_event_bus.md +0 -244
data/docs/features/6_guards.md +0 -356
data/docs/features/7_lazy_resolvers.md +0 -238
data/docs/features/guards_naming_convention.md +0 -540
data/docs/guides/1_common_patterns.md +0 -90
data/docs/guides/2_migration_guide.md +0 -225
data/docs/integration/1_configuration.md +0 -154
data/docs/integration/2_testing.md +0 -304
data/docs/integration/3_rails_integration.md +0 -99
data/docs/yard/Servus/Base.html +0 -1645
data/docs/yard/Servus/Config.html +0 -582
data/docs/yard/Servus/Extensions/Async/Call.html +0 -400
data/docs/yard/Servus/Extensions/Async/Errors/AsyncError.html +0 -140
data/docs/yard/Servus/Extensions/Async/Errors/JobEnqueueError.html +0 -154
data/docs/yard/Servus/Extensions/Async/Errors/ServiceNotFoundError.html +0 -154
data/docs/yard/Servus/Extensions/Async/Errors.html +0 -128
data/docs/yard/Servus/Extensions/Async/Ext.html +0 -119
data/docs/yard/Servus/Extensions/Async/Job.html +0 -310
data/docs/yard/Servus/Extensions/Async.html +0 -141
data/docs/yard/Servus/Extensions.html +0 -117
data/docs/yard/Servus/Generators/ServiceGenerator.html +0 -261
data/docs/yard/Servus/Generators.html +0 -115
data/docs/yard/Servus/Helpers/ControllerHelpers.html +0 -457
data/docs/yard/Servus/Helpers.html +0 -115
data/docs/yard/Servus/Railtie.html +0 -134
data/docs/yard/Servus/Support/Errors/AuthenticationError.html +0 -287
data/docs/yard/Servus/Support/Errors/BadRequestError.html +0 -283
data/docs/yard/Servus/Support/Errors/ForbiddenError.html +0 -284
data/docs/yard/Servus/Support/Errors/InternalServerError.html +0 -283
data/docs/yard/Servus/Support/Errors/NotFoundError.html +0 -284
data/docs/yard/Servus/Support/Errors/ServiceError.html +0 -489
data/docs/yard/Servus/Support/Errors/ServiceUnavailableError.html +0 -290
data/docs/yard/Servus/Support/Errors/UnauthorizedError.html +0 -200
data/docs/yard/Servus/Support/Errors/UnprocessableEntityError.html +0 -288
data/docs/yard/Servus/Support/Errors/ValidationError.html +0 -200
data/docs/yard/Servus/Support/Errors.html +0 -140
data/docs/yard/Servus/Support/Logger.html +0 -856
data/docs/yard/Servus/Support/Rescuer/BlockContext.html +0 -585
data/docs/yard/Servus/Support/Rescuer/CallOverride.html +0 -257
data/docs/yard/Servus/Support/Rescuer/ClassMethods.html +0 -343
data/docs/yard/Servus/Support/Rescuer.html +0 -267
data/docs/yard/Servus/Support/Response.html +0 -574
data/docs/yard/Servus/Support/Validator.html +0 -1150
data/docs/yard/Servus/Support.html +0 -119
data/docs/yard/Servus/Testing/ExampleBuilders.html +0 -523
data/docs/yard/Servus/Testing/ExampleExtractor.html +0 -578
data/docs/yard/Servus/Testing.html +0 -142
data/docs/yard/Servus.html +0 -343
data/docs/yard/_index.html +0 -535
data/docs/yard/class_list.html +0 -54
data/docs/yard/css/common.css +0 -1
data/docs/yard/css/full_list.css +0 -58
data/docs/yard/css/style.css +0 -503
data/docs/yard/file.1_common_patterns.html +0 -154
data/docs/yard/file.1_configuration.html +0 -115
data/docs/yard/file.1_overview.html +0 -142
data/docs/yard/file.1_schema_validation.html +0 -188
data/docs/yard/file.2_architecture.html +0 -157
data/docs/yard/file.2_error_handling.html +0 -190
data/docs/yard/file.2_migration_guide.html +0 -242
data/docs/yard/file.2_testing.html +0 -227
data/docs/yard/file.3_async_execution.html +0 -145
data/docs/yard/file.3_rails_integration.html +0 -160
data/docs/yard/file.3_service_objects.html +0 -191
data/docs/yard/file.4_logging.html +0 -135
data/docs/yard/file.ErrorHandling.html +0 -190
data/docs/yard/file.READme.html +0 -674
data/docs/yard/file.architecture.html +0 -157
data/docs/yard/file.async_execution.html +0 -145
data/docs/yard/file.common_patterns.html +0 -154
data/docs/yard/file.configuration.html +0 -115
data/docs/yard/file.error_handling.html +0 -190
data/docs/yard/file.logging.html +0 -135
data/docs/yard/file.migration_guide.html +0 -242
data/docs/yard/file.overview.html +0 -142
data/docs/yard/file.rails_integration.html +0 -160
data/docs/yard/file.schema_validation.html +0 -188
data/docs/yard/file.service_objects.html +0 -191
data/docs/yard/file.testing.html +0 -227
data/docs/yard/file_list.html +0 -119
data/docs/yard/frames.html +0 -22
data/docs/yard/index.html +0 -674
data/docs/yard/js/app.js +0 -344
data/docs/yard/js/full_list.js +0 -242
data/docs/yard/js/jquery.js +0 -4
data/docs/yard/method_list.html +0 -542
data/docs/yard/top-level-namespace.html +0 -110

data/docs/yard/Servus/Support/Response.html DELETED Viewed

@@ -1,574 +0,0 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1.0">
-<title>
-  Class: Servus::Support::Response
-    &mdash; Servus | Service Object Framework
-</title>
-  <link rel="stylesheet" href="../../css/style.css" type="text/css" />
-  <link rel="stylesheet" href="../../css/common.css" type="text/css" />
-<script type="text/javascript">
-  pathId = "Servus::Support::Response";
-  relpath = '../../';
-</script>
-  <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
-  <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
-  </head>
-  <body>
-    <div class="nav_wrap">
-      <iframe id="nav" src="../../class_list.html?1"></iframe>
-      <div id="resizer"></div>
-    </div>
-    <div id="main" tabindex="-1">
-      <div id="header">
-        <div id="menu">
-    <a href="../../_index.html">Index (R)</a> &raquo;
-    <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="../Support.html" title="Servus::Support (module)">Support</a></span></span>
-     &raquo;
-    <span class="title">Response</span>
-</div>
-        <div id="search">
-    <a class="full_list_link" id="class_list_link"
-        href="../../class_list.html">
-        <svg width="24" height="24">
-          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
-          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
-          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
-        </svg>
-    </a>
-</div>
-        <div class="clear"></div>
-      </div>
-      <div id="content"><h1>Class: Servus::Support::Response
-</h1>
-<div class="box_info">
-  <dl>
-    <dt>Inherits:</dt>
-    <dd>
-      <span class="inheritName">Object</span>
-        <ul class="fullTree">
-          <li>Object</li>
-            <li class="next">Servus::Support::Response</li>
-        </ul>
-        <a href="#" class="inheritanceTree">show all</a>
-    </dd>
-  </dl>
-  <dl>
-    <dt>Defined in:</dt>
-    <dd>lib/servus/support/response.rb</dd>
-  </dl>
-</div>
-<h2>Overview</h2><div class="docstring">
-  <div class="discussion">
-    <p>Encapsulates the result of a service execution.</p>
-<p>Response objects are returned by all service calls and contain either
-successful data or an error, never both. Use <span class='object_link'><a href="#success%3F-instance_method" title="Servus::Support::Response#success? (method)">#success?</a></span> to determine
-which path to take when handling results.</p>
-  </div>
-</div>
-<div class="tags">
-  <div class="examples">
-    <h4 class="tag_title">Examples:</h4>
-        <h5 class="example_title"><div class='inline'><p>Handling a successful response</p>
-</div></h5>
-      <pre class="example code"><code><span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='const'>MyService</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='int'>123</span><span class='rparen'>)</span>
-<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>
-  <span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Data: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_data'>data</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
-  <span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Error: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_error'>error</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span> <span class='comment'># =&gt; nil
-</span><span class='kw'>end</span></code></pre>
-        <h5 class="example_title"><div class='inline'><p>Handling a failed response</p>
-</div></h5>
-      <pre class="example code"><code><span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='const'>MyService</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='op'>-</span><span class='int'>1</span><span class='rparen'>)</span>
-<span class='kw'>unless</span> <span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_success?'>success?</span>
-  <span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Error: </span><span class='embexpr_beg'>#{</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='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
-  <span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Data: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_data'>data</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span> <span class='comment'># =&gt; nil
-</span><span class='kw'>end</span></code></pre>
-        <h5 class="example_title"><div class='inline'><p>Pattern matching in controllers</p>
-</div></h5>
-      <pre class="example code"><code><span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='const'>MyService</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>
-<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>
-  <span class='id identifier rubyid_render'>render</span> <span class='label'>json:</span> <span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>status:</span> <span class='symbol'>:ok</span>
-<span class='kw'>else</span>
-  <span class='id identifier rubyid_render'>render</span> <span class='label'>json:</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='comma'>,</span> <span class='label'>status:</span> <span class='symbol'>:unprocessable_entity</span>
-<span class='kw'>end</span></code></pre>
-  </div>
-  <p class="tag_title">See Also:</p>
-  <ul class="see">
-      <li><span class='object_link'><a href="../Base.html#success-instance_method" title="Servus::Base#success (method)">Base#success</a></span></li>
-      <li><span class='object_link'><a href="../Base.html#failure-instance_method" title="Servus::Base#failure (method)">Base#failure</a></span></li>
-  </ul>
-</div>
-  <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
-  <ul class="summary">
-      <li class="public ">
-  <span class="summary_signature">
-      <a href="#data-instance_method" title="#data (instance method)">#<strong>data</strong>  &#x21d2; Object </a>
-  </span>
-      <span class="note title readonly">readonly</span>
-    <span class="summary_desc"><div class='inline'><p>[Object] The data returned by the service.</p>
-</div></span>
-</li>
-      <li class="public ">
-  <span class="summary_signature">
-      <a href="#error-instance_method" title="#error (instance method)">#<strong>error</strong>  &#x21d2; Object </a>
-  </span>
-      <span class="note title readonly">readonly</span>
-    <span class="summary_desc"><div class='inline'><p>[Servus::Support::Errors::ServiceError] The error returned by the service.</p>
-</div></span>
-</li>
-  </ul>
-    <h2>
-      Instance Method Summary
-      <small><a href="#" class="summary_toggle">collapse</a></small>
-    </h2>
-    <ul class="summary">
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(success, data, error)  &#x21d2; Response </a>
-  </span>
-    <span class="note title constructor">constructor</span>
-  <span class="private note title">private</span>
-    <span class="summary_desc"><div class='inline'><p>Creates a new response object.</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#success%3F-instance_method" title="#success? (instance method)">#<strong>success?</strong>  &#x21d2; Boolean </a>
-  </span>
-    <span class="summary_desc"><div class='inline'><p>Checks if the service execution was successful.</p>
-</div></span>
-</li>
-    </ul>
-<div id="constructor_details" class="method_details_list">
-  <h2>Constructor Details</h2>
-    <div class="method_details first">
-  <h3 class="signature first" id="initialize-instance_method">
-    #<strong>initialize</strong>(success, data, error)  &#x21d2; <tt><span class='object_link'><a href="" title="Servus::Support::Response (class)">Response</a></span></tt>
-</h3><div class="docstring">
-  <div class="discussion">
-    <p class="note private">
-  <strong>This method is part of a private API.</strong>
-  You should avoid using this method if possible, as it may be removed or be changed in the future.
-</p>
-  <div class="note notetag">
-    <strong>Note:</strong>
-    <div class='inline'><p>This is typically called by <span class='object_link'><a href="../Base.html#success-instance_method" title="Servus::Base#success (method)">Base#success</a></span> or <span class='object_link'><a href="../Base.html#failure-instance_method" title="Servus::Base#failure (method)">Base#failure</a></span>
-rather than being instantiated directly.</p>
-</div>
-  </div>
-<p>Creates a new response object.</p>
-  </div>
-</div>
-<div class="tags">
-  <p class="tag_title">Parameters:</p>
-<ul class="param">
-    <li>
-        <span class='name'>success</span>
-        <span class='type'>(<tt>Boolean</tt>)</span>
-        &mdash;
-        <div class='inline'><p>true for successful responses, false for failures</p>
-</div>
-    </li>
-    <li>
-        <span class='name'>data</span>
-        <span class='type'>(<tt>Object</tt>, <tt>nil</tt>)</span>
-        &mdash;
-        <div class='inline'><p>the result data (nil for failures)</p>
-</div>
-    </li>
-    <li>
-        <span class='name'>error</span>
-        <span class='type'>(<tt><span class='object_link'><a href="Errors/ServiceError.html" title="Servus::Support::Errors::ServiceError (class)">Servus::Support::Errors::ServiceError</a></span></tt>, <tt>nil</tt>)</span>
-        &mdash;
-        <div class='inline'><p>the error (nil for successes)</p>
-</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-52
-53
-54
-55
-56</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/servus/support/response.rb', line 52</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_success'>success</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='id identifier rubyid_error'>error</span><span class='rparen'>)</span>
-  <span class='ivar'>@success</span> <span class='op'>=</span> <span class='id identifier rubyid_success'>success</span>
-  <span class='ivar'>@data</span> <span class='op'>=</span> <span class='id identifier rubyid_data'>data</span>
-  <span class='ivar'>@error</span> <span class='op'>=</span> <span class='id identifier rubyid_error'>error</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-</div>
-  <div id="instance_attr_details" class="attr_details">
-    <h2>Instance Attribute Details</h2>
-      <span id=""></span>
-      <div class="method_details first">
-  <h3 class="signature first" id="data-instance_method">
-    #<strong>data</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>
-</h3><div class="docstring">
-  <div class="discussion">
-    <p>[Object] The data returned by the service</p>
-  </div>
-</div>
-<div class="tags">
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-37
-38
-39</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/servus/support/response.rb', line 37</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_data'>data</span>
-  <span class='ivar'>@data</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <span id=""></span>
-      <div class="method_details ">
-  <h3 class="signature " id="error-instance_method">
-    #<strong>error</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>
-</h3><div class="docstring">
-  <div class="discussion">
-    <p>[Servus::Support::Errors::ServiceError] The error returned by the service</p>
-  </div>
-</div>
-<div class="tags">
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-40
-41
-42</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/servus/support/response.rb', line 40</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_error'>error</span>
-  <span class='ivar'>@error</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-  </div>
-  <div id="instance_method_details" class="method_details_list">
-    <h2>Instance Method Details</h2>
-      <div class="method_details first">
-  <h3 class="signature first" id="success?-instance_method">
-    #<strong>success?</strong>  &#x21d2; <tt>Boolean</tt>
-</h3><div class="docstring">
-  <div class="discussion">
-    <p>Checks if the service execution was successful.</p>
-  </div>
-</div>
-<div class="tags">
-  <div class="examples">
-    <h4 class="tag_title">Examples:</h4>
-      <pre class="example code"><code><span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='const'>MyService</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>
-<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>
-  <span class='comment'># Handle success - result.data is available
-</span><span class='kw'>else</span>
-  <span class='comment'># Handle failure - result.error is available
-</span><span class='kw'>end</span></code></pre>
-  </div>
-<p class="tag_title">Returns:</p>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>Boolean</tt>)</span>
-        &mdash;
-        <div class='inline'><p>true if the service succeeded, false if it failed</p>
-</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-69
-70
-71</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/servus/support/response.rb', line 69</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_success?'>success?</span>
-  <span class='ivar'>@success</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-  </div>
-</div>
-      <div id="footer">
-  Generated on Fri Nov 21 00:33:24 2025 by
-  <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.37 (ruby-3.4.4).
-</div>
-    </div>
-  </body>
-</html>