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

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

checksums.yaml +4 -4
data/lib/generators/servus/event/event_generator.rb +54 -0
data/lib/generators/servus/event/templates/event.rb.erb +44 -0
data/lib/generators/servus/event/templates/event_spec.rb.erb +20 -0
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 +85 -12
data/lib/servus/event.rb +235 -0
data/lib/servus/events/bus.rb +111 -72
data/lib/servus/events/class_router.rb +40 -0
data/lib/servus/events/emitter.rb +21 -6
data/lib/servus/events/invocation.rb +94 -0
data/lib/servus/events/router.rb +44 -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/railtie.rb +10 -8
data/lib/servus/support/errors.rb +16 -0
data/lib/servus/support/lockdown.rb +94 -0
data/lib/servus/support/logger.rb +18 -0
data/lib/servus/support/validator.rb +70 -40
data/lib/servus/testing/example_builders.rb +52 -0
data/lib/servus/testing/matchers.rb +103 -4
data/lib/servus/version.rb +1 -1
data/lib/servus.rb +7 -2
metadata +14 -116
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/lib/generators/servus/event_handler/event_handler_generator.rb +0 -59
data/lib/generators/servus/event_handler/templates/handler.rb.erb +0 -86
data/lib/generators/servus/event_handler/templates/handler_spec.rb.erb +0 -48
data/lib/servus/event_handler.rb +0 -290
data/lib/servus/events/errors.rb +0 -10

data/docs/yard/file.1_schema_validation.html DELETED Viewed

@@ -1,188 +0,0 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <meta charset="UTF-8">
-<meta name="viewport" content="width=device-width, initial-scale=1.0">
-<title>
-  File: Features / 1. Schema Validation
-    &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 = "1_schema_validation";
-  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="file_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</a> &raquo;
-    <span class="title">File: Features / 1. Schema Validation</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"><div id='filecontents'><h1 id="schema-validation">Schema Validation</h1>
-<p>Servus provides optional JSON Schema validation for service arguments and results. Validation is opt-in - services work fine without schemas.</p>
-<h2 id="how-it-works">How It Works</h2>
-<p>Define schemas using the <code>schema</code> DSL method (recommended) or as constants. The framework validates arguments before execution and results after execution. Invalid data raises <code>ValidationError</code>.</p>
-<h3 id="preferred-schema-dsl-method">Preferred: Schema DSL Method</h3>
-<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>
-  <span class='id identifier rubyid_schema'>schema</span><span class='lparen'>(</span>
-    <span class='label'>arguments:</span> <span class='lbrace'>{</span>
-      <span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>object</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
-      <span class='label'>required:</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>user_id</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>amount</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
-      <span class='label'>properties:</span> <span class='lbrace'>{</span>
-        <span class='label'>user_id:</span> <span class='lbrace'>{</span> <span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>integer</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>example:</span> <span class='int'>123</span> <span class='rbrace'>}</span><span class='comma'>,</span>
-        <span class='label'>amount:</span> <span class='lbrace'>{</span> <span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>number</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>minimum:</span> <span class='float'>0.01</span><span class='comma'>,</span> <span class='label'>example:</span> <span class='float'>100.0</span> <span class='rbrace'>}</span>
-      <span class='rbrace'>}</span>
-    <span class='rbrace'>}</span><span class='comma'>,</span>
-    <span class='label'>result:</span> <span class='lbrace'>{</span>
-      <span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>object</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
-      <span class='label'>required:</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>transaction_id</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>new_balance</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
-      <span class='label'>properties:</span> <span class='lbrace'>{</span>
-        <span class='label'>transaction_id:</span> <span class='lbrace'>{</span> <span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>string</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>example:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>txn_abc123</span><span class='tstring_end'>&quot;</span></span> <span class='rbrace'>}</span><span class='comma'>,</span>
-        <span class='label'>new_balance:</span> <span class='lbrace'>{</span> <span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>number</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>example:</span> <span class='float'>950.0</span> <span class='rbrace'>}</span>
-      <span class='rbrace'>}</span>
-    <span class='rbrace'>}</span>
-  <span class='rparen'>)</span>
-<span class='kw'>end</span>
-</code></pre>
-<p><strong>Pro tip:</strong> Add <code>example</code> or <code>examples</code> keywords to your schemas. These values can be automatically extracted in tests using <code>servus_arguments_example()</code> and <code>servus_result_example()</code> helpers. See the <a href="../integration/testing.md#schema-example-helpers">Testing documentation</a> for details.</p>
-<p>You can define just one schema if needed:</p>
-<pre class="code ruby"><code class="ruby"><span class='kw'>class</span> <span class='const'>SendEmail</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>
-  <span class='id identifier rubyid_schema'>schema</span> <span class='label'>arguments:</span> <span class='lbrace'>{</span>
-    <span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>object</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
-    <span class='label'>required:</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>email</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>subject</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
-    <span class='label'>properties:</span> <span class='lbrace'>{</span>
-      <span class='label'>email:</span> <span class='lbrace'>{</span> <span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>string</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>format:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>email</span><span class='tstring_end'>&quot;</span></span> <span class='rbrace'>}</span><span class='comma'>,</span>
-      <span class='label'>subject:</span> <span class='lbrace'>{</span> <span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>string</span><span class='tstring_end'>&quot;</span></span> <span class='rbrace'>}</span>
-    <span class='rbrace'>}</span>
-  <span class='rbrace'>}</span>
-<span class='kw'>end</span>
-</code></pre>
-<h3 id="alternative-inline-constants">Alternative: Inline Constants</h3>
-<p>Constants are still supported for backwards compatibility:</p>
-<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>
-  <span class='const'>ARGUMENTS_SCHEMA</span> <span class='op'>=</span> <span class='lbrace'>{</span>
-    <span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>object</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
-    <span class='label'>required:</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>user_id</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>amount</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
-    <span class='label'>properties:</span> <span class='lbrace'>{</span>
-      <span class='label'>user_id:</span> <span class='lbrace'>{</span> <span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>integer</span><span class='tstring_end'>&quot;</span></span> <span class='rbrace'>}</span><span class='comma'>,</span>
-      <span class='label'>amount:</span> <span class='lbrace'>{</span> <span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>number</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>minimum:</span> <span class='float'>0.01</span> <span class='rbrace'>}</span>
-    <span class='rbrace'>}</span>
-  <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span>
-  <span class='const'>RESULT_SCHEMA</span> <span class='op'>=</span> <span class='lbrace'>{</span>
-    <span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>object</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
-    <span class='label'>required:</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>transaction_id</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>new_balance</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
-    <span class='label'>properties:</span> <span class='lbrace'>{</span>
-      <span class='label'>transaction_id:</span> <span class='lbrace'>{</span> <span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>string</span><span class='tstring_end'>&quot;</span></span> <span class='rbrace'>}</span><span class='comma'>,</span>
-      <span class='label'>new_balance:</span> <span class='lbrace'>{</span> <span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>number</span><span class='tstring_end'>&quot;</span></span> <span class='rbrace'>}</span>
-    <span class='rbrace'>}</span>
-  <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span>
-<span class='kw'>end</span>
-</code></pre>
-<h2 id="file-based-schemas">File-Based Schemas</h2>
-<p>For complex schemas, use JSON files instead of inline definitions. Create files at:</p>
-<ul>
-<li><code>app/schemas/services/service_name/arguments.json</code></li>
-<li><code>app/schemas/services/service_name/result.json</code></li>
-</ul>
-<h3 id="schema-lookup-precedence">Schema Lookup Precedence</h3>
-<p>Servus checks for schemas in this order:</p>
-<ol>
-<li><strong>schema DSL method</strong> (if defined)</li>
-<li><strong>Inline constants</strong> (ARGUMENTS_SCHEMA, RESULT_SCHEMA)</li>
-<li><strong>JSON files</strong> (in schema_root directory)</li>
-</ol>
-<p>Schemas are cached after first load for performance.</p>
-<h2 id="three-layers-of-validation">Three Layers of Validation</h2>
-<p><strong>Schema Validation</strong> (Servus): Type safety and structure at service boundaries</p>
-<p><strong>Business Rules</strong> (Service Logic): Domain-specific constraints during execution</p>
-<p><strong>Model Validation</strong> (ActiveRecord): Database constraints before persistence</p>
-<p>Each layer has a different purpose - don&#39;t duplicate validation across layers.</p>
-<h2 id="configuration">Configuration</h2>
-<p>Change the schema file location if needed:</p>
-<pre class="code ruby"><code class="ruby"><span class='comment'># config/initializers/servus.rb
-</span><span class='const'><span class='object_link'><a href="Servus.html" title="Servus (module)">Servus</a></span></span><span class='period'>.</span><span class='id identifier rubyid_configure'><span class='object_link'><a href="Servus.html#configure-class_method" title="Servus.configure (method)">configure</a></span></span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_config'>config</span><span class='op'>|</span>
-  <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_schema_root'>schema_root</span> <span class='op'>=</span> <span class='const'>Rails</span><span class='period'>.</span><span class='id identifier rubyid_root'>root</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'>config/schemas</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
-<span class='kw'>end</span>
-</code></pre>
-<p>Clear the schema cache during development when schemas change:</p>
-<pre class="code ruby"><code class="ruby"><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/Validator.html" title="Servus::Support::Validator (class)">Validator</a></span></span><span class='period'>.</span><span class='id identifier rubyid_clear_cache!'><span class='object_link'><a href="Servus/Support/Validator.html#clear_cache!-class_method" title="Servus::Support::Validator.clear_cache! (method)">clear_cache!</a></span></span>
-</code></pre>
-</div></div>
-      <div id="footer">
-  Generated on Fri Nov 21 00:33:23 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>

data/docs/yard/file.2_architecture.html DELETED Viewed

@@ -1,157 +0,0 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <meta charset="UTF-8">
-<meta name="viewport" content="width=device-width, initial-scale=1.0">
-<title>
-  File: Core / 2. Architecture
-    &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 = "2_architecture";
-  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="file_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</a> &raquo;
-    <span class="title">File: Core / 2. Architecture</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"><div id='filecontents'><h1 id="architecture">Architecture</h1>
-<p>Servus wraps service execution with automatic validation, logging, and error handling. When you call <code>Service.call(**args)</code>, the framework orchestrates these concerns transparently.</p>
-<h2 id="execution-flow">Execution Flow</h2>
-<pre class="code ruby"><code class="ruby"><span class='const'>Arguments</span> <span class='id identifier rubyid_→'>→</span> <span class='const'>Validation</span> <span class='id identifier rubyid_→'>→</span> <span class='const'>Service</span><span class='comment'>#call → Result Validation → Logging → Response
-</span>                <span class='id identifier rubyid_↓'>↓</span>                              <span class='id identifier rubyid_↓'>↓</span>                <span class='id identifier rubyid_↓'>↓</span>
-          <span class='const'>ValidationError</span>                <span class='const'>ValidationError</span>     <span class='const'>Benchmark</span>
-</code></pre>
-<p>The framework intercepts the <code>.call</code> class method to inject cross-cutting concerns before and after your business logic runs. Your <code>call</code> instance method contains only business logic - validation, logging, and timing happen automatically.</p>
-<h2 id="core-components">Core Components</h2>
-<p><strong>Servus::Base</strong> (<code>lib/servus/base.rb</code>): Foundation class providing <code>.call()</code> orchestration and response helpers (<code>success</code>, <code>failure</code>, <code>error!</code>)</p>
-<p><strong>Support::Response</strong> (<code>lib/servus/support/response.rb</code>): Immutable result object with <code>success?</code>, <code>data</code>, and <code>error</code> attributes</p>
-<p><strong>Support::Validator</strong> (<code>lib/servus/support/validator.rb</code>): JSON Schema validation for arguments (before execution) and results (after execution). Schemas are cached after first load.</p>
-<p><strong>Support::Logger</strong> (<code>lib/servus/support/logger.rb</code>): Automatic logging at DEBUG (calls with args), INFO (success), WARN (failures), ERROR (exceptions)</p>
-<p><strong>Support::Rescuer</strong> (<code>lib/servus/support/rescuer.rb</code>): Declarative exception handling via <code>rescue_from</code> class method</p>
-<p><strong>Support::Errors</strong> (<code>lib/servus/support/errors.rb</code>): HTTP-aligned error hierarchy (ServiceError, NotFoundError, ValidationError, etc.)</p>
-<h2 id="extension-points">Extension Points</h2>
-<h3 id="schema-validation">Schema Validation</h3>
-<p>Use the <code>schema</code> DSL method to define JSON Schema validation for arguments and results:</p>
-<pre class="code ruby"><code class="ruby"><span class='kw'>class</span> <span class='const'>Service</span> <span class='op'>&lt;</span> <span class='const'><span class='object_link'><a href="Servus.html" title="Servus (module)">Servus</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Servus/Base.html" title="Servus::Base (class)">Base</a></span></span>
-  <span class='id identifier rubyid_schema'>schema</span><span class='lparen'>(</span>
-    <span class='label'>arguments:</span> <span class='lbrace'>{</span> <span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>object</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>required:</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>user_id</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='rbrace'>}</span><span class='comma'>,</span>
-    <span class='label'>result:</span> <span class='lbrace'>{</span> <span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>object</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>required:</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>user</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='rbrace'>}</span>
-  <span class='rparen'>)</span>
-<span class='kw'>end</span>
-</code></pre>
-<h3 id="declarative-error-handling">Declarative Error Handling</h3>
-<p>Use <code>rescue_from</code> to convert exceptions into failures. Provide a custom error type or use a block for custom handling.</p>
-<pre class="code ruby"><code class="ruby"><span class='kw'>class</span> <span class='const'>Service</span> <span class='op'>&lt;</span> <span class='const'><span class='object_link'><a href="Servus.html" title="Servus (module)">Servus</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Servus/Base.html" title="Servus::Base (class)">Base</a></span></span>
-  <span class='comment'># Default error type
-</span>  <span class='id identifier rubyid_rescue_from'>rescue_from</span> <span class='const'>Net</span><span class='op'>::</span><span class='const'>HTTPError</span><span class='comma'>,</span> <span class='const'>Timeout</span><span class='op'>::</span><span class='const'>Error</span><span class='comma'>,</span> <span class='label'>use:</span> <span class='const'>ServiceUnavailableError</span>
-  <span class='comment'># Custom handling with block
-</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>
-    <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'>Validation failed: </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='comma'>,</span> <span class='label'>type:</span> <span class='const'>ValidationError</span><span class='rparen'>)</span>
-  <span class='kw'>end</span>
-<span class='kw'>end</span>
-</code></pre>
-<h3 id="support-classes">Support Classes</h3>
-<p>Create helper classes in <code>app/services/service_name/support/*.rb</code>. These are namespaced to your service.</p>
-<pre class="code ruby"><code class="ruby">app/services/process_payment/
-├── service.rb
-└── support/
-    ├── payment_gateway.rb
-    └── receipt_formatter.rb
-</code></pre>
-<h2 id="async-execution">Async Execution</h2>
-<p><code>Service.call_async(**args)</code> enqueues execution via ActiveJob. The service runs identically whether called sync or async.</p>
-<pre class="code ruby"><code class="ruby"><span class='const'>ProcessPayment</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'>user_id:</span> <span class='int'>1</span><span class='comma'>,</span>
-  <span class='label'>amount:</span> <span class='int'>50</span><span class='comma'>,</span>
-  <span class='label'>queue:</span> <span class='symbol'>:critical</span><span class='comma'>,</span>
-  <span class='label'>wait:</span> <span class='int'>5</span><span class='period'>.</span><span class='id identifier rubyid_minutes'>minutes</span>
-<span class='rparen'>)</span>
-</code></pre>
-<h2 id="performance">Performance</h2>
-<ul>
-<li>Schema loading: Cached per class after first use</li>
-<li>Validation overhead: ~1-5ms when schemas defined</li>
-<li>Logging overhead: ~0.1ms per call</li>
-<li>Total framework overhead: &lt; 10ms per service call</li>
-</ul>
-</div></div>
-      <div id="footer">
-  Generated on Fri Nov 21 00:33:23 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>

data/docs/yard/file.2_error_handling.html DELETED Viewed

@@ -1,190 +0,0 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <meta charset="UTF-8">
-<meta name="viewport" content="width=device-width, initial-scale=1.0">
-<title>
-  File: Features / 2. Error Handling
-    &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 = "2_error_handling";
-  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="file_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</a> &raquo;
-    <span class="title">File: Features / 2. Error Handling</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"><div id='filecontents'><h1 id="error-handling">Error Handling</h1>
-<p>Servus distinguishes between expected business failures (return failure) and unexpected system errors (raise exceptions). This separation makes error handling predictable and explicit.</p>
-<h2 id="failures-vs-exceptions">Failures vs Exceptions</h2>
-<p><strong>Use <code>failure()</code></strong> for expected business conditions:</p>
-<ul>
-<li>User not found</li>
-<li>Insufficient balance</li>
-<li>Invalid state transition</li>
-</ul>
-<p><strong>Use <code>error!()</code> or raise</strong> for unexpected system errors:</p>
-<ul>
-<li>Database connection failure</li>
-<li>Nil reference error</li>
-<li>External API timeout</li>
-</ul>
-<p>Failures return a Response object so callers can handle them. Exceptions halt execution and bubble up.</p>
-<pre class="code ruby"><code class="ruby"><span class='kw'>def</span> <span class='id identifier rubyid_call'>call</span>
-  <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>
-  <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>
-  <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>
-  <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
-</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>
-<span class='kw'>end</span>
-</code></pre>
-<h2 id="error-classes">Error Classes</h2>
-<p>All error classes inherit from <code>ServiceError</code> and map to HTTP status codes. Use them for API-friendly errors.</p>
-<pre class="code ruby"><code class="ruby"><span class='comment'># Built-in errors
-</span><span class='const'>NotFoundError</span>          <span class='comment'># 404
-</span><span class='const'>BadRequestError</span>        <span class='comment'># 400
-</span><span class='const'>UnauthorizedError</span>      <span class='comment'># 401
-</span><span class='const'>ForbiddenError</span>         <span class='comment'># 403
-</span><span class='const'>ValidationError</span>        <span class='comment'># 422
-</span><span class='const'>InternalServerError</span>    <span class='comment'># 500
-</span><span class='const'>ServiceUnavailableError</span> <span class='comment'># 503
-</span>
-<span class='comment'># Usage
-</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>
-<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
-</span></code></pre>
-<p>Each error has an <code>api_error</code> method returning <code>{ code: :symbol, message: &quot;string&quot; }</code> for JSON APIs.</p>
-<h2 id="declarative-exception-handling">Declarative Exception Handling</h2>
-<p>Use <code>rescue_from</code> to convert specific exceptions into failures. Original exception details are preserved in error messages.</p>
-<pre class="code ruby"><code class="ruby">class CallExternalApi::Service &lt; Servus::Base
-  rescue_from Net::HTTPError, Timeout::Error use: ServiceUnavailableError
-  rescue_from JSON::ParserError, use: BadRequestError
-  def call
-    response = http_client.get(url)  # May raise
-    data = JSON.parse(response.body) # May raise
-    success(data: data)
-  end
-end
-# If Net::HTTPError is raised, service returns:
-# Response(success: false, error: ServiceUnavailableError(&quot;[Net::HTTPError]: original message&quot;))
-</code></pre>
-<p>The <code>rescue_from</code> pattern keeps business logic clean while ensuring consistent error handling across services.</p>
-<h3 id="custom-error-handling-with-blocks">Custom Error Handling with Blocks</h3>
-<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>
-<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>
-  <span class='comment'># Custom failure with error details
-</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>
-    <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>
-            <span class='label'>type:</span> <span class='const'>ValidationError</span><span class='rparen'>)</span>
-  <span class='kw'>end</span>
-  <span class='comment'># Recover from certain errors with success
-</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>
-    <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>
-      <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>
-    <span class='kw'>else</span>
-      <span class='comment'># Log and continue for other card errors
-</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>
-      <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>
-    <span class='kw'>end</span>
-  <span class='kw'>end</span>
-  <span class='kw'>def</span> <span class='id identifier rubyid_call'>call</span>
-    <span class='comment'># Service logic that may raise exceptions
-</span>  <span class='kw'>end</span>
-<span class='kw'>end</span>
-</code></pre>
-<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>
-<h2 id="custom-errors">Custom Errors</h2>
-<p>Create domain-specific errors by inheriting from <code>ServiceError</code>:</p>
-<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>
-  <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>
-  <span class='kw'>def</span> <span class='id identifier rubyid_api_error'>api_error</span>
-    <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>
-  <span class='kw'>end</span>
-<span class='kw'>end</span>
-<span class='comment'># Usage
-</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>
-</code></pre>
-</div></div>
-      <div id="footer">
-  Generated on Fri Nov 21 00:33:23 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>