axn 0.1.0.pre.alpha.2.1 → 0.1.0.pre.alpha.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20198518e83064e97c25335dbcb2be0a88affe103dcd1aaf8ca3965a964cbeb4
-  data.tar.gz: 70707f0966255c4c0015953fea14a3b42d1bcc2c1e54b896a8ea20c4e5effb3b
+  metadata.gz: ac3f240b093cdf14fef16b5eb6993dbb8f6d49ba58c837245128a0efb3558f11
+  data.tar.gz: 40b631f49349b51811ebb0bbc60cbc7962a3f7d633bab1134b7b234b4f681123
 SHA512:
-  metadata.gz: 781768348b4b08267f34956a94b4a4ab0ef470123d9d084cfb6fd24fb1ab02b6c03f979206a57d828f675ec21b7754672bfbaed10acd8bf222f6efc374c90b39
-  data.tar.gz: d81788b26c3b313fa3d21fb2d7d763109839659eff4d0bc8af0251a7ee93ef77ee121df1f023dad4f71ed63eb94b355d7469cfcac5e21dab4fcbec126f40ea88
+  metadata.gz: c8ac8be69e70d72d04b0c5be89e4ec198223c4a1771a15d254b82b0a204543c627a80321b3de95d69fa97a244fc56c9c39ca59262600c6b991c363603e0a7beb
+  data.tar.gz: 4eba5152626d0417ff3be725da9512034276d4b034898f8ad331890499196c1851a1d3dcd1cde880955c42f425090ab6c5fe30cac1496835013c7bd6cda52cdb

data/CHANGELOG.md

@@ -3,6 +3,16 @@
 ## UNRELEASED
 * N/A
 
+## 0.1.0-alpha.2.3
+* `expects` / `exposes`: Add `type: :uuid` special case validation
+* [BUGFIX] Allow `hoist_errors` to pass the result through on success (allow access to subactions' exposures)
+* [`Axn::Factory`] Support error_from + rescues
+* `Action::Result.error` spec helper -- creation should NOT trigger global exception handler
+* [CHANGE] `expects` / `exposes`: The `default` key, if a callable, should be evaluated in the _instance_'s context
+
+## 0.1.0-alpha.2.2
+* Expands `Action::Result.ok` and `Action::Result.error` to better support mocking in specs
+
 ## 0.1.0-alpha.2.1
 * Expects/Exposes: Add `allow_nil` option
 * Expects/Exposes: Replace `boolean: true` with `type: :boolean`

data/docs/recipes/testing.md

@@ -4,7 +4,36 @@
 * TODO: document testing patterns
 :::
 
-Configuring rspec to treat files in spec/actions as service specs:
+## Mocking Axn calls
+
+Say you're writing unit specs for PrimaryAction that calls Subaction, and you want to mock out the Subaction call.
+
+To generate a successful Action::Result:
+
+* Base case: `Action::Result.ok`
+* [Optional] Custom message: `Action::Result.ok("It went awesome")`
+* [Optional] Custom exposures: `Action::Result.ok("It went awesome", some_var: 123)`
+
+To generate a failed Action::Result:
+
+* Base case: `Action::Result.error`
+* [Optional] Custom message: `Action::Result.error("It went poorly")`
+* [Optional] Custom exposures: `Action::Result.error("It went poorly", some_var: 123)`
+* [Optional] Custom exception: `Action::Result.error(some_var: 123) { raise FooBarException.new("bad thing") }`
+
+Either way, using those to mock an actual call would look something like this in your rspec:
+
+```ruby
+let(:subaction_response) { Action::Result.ok("custom message", foo: 1) }
+
+before do
+  expect(Subaction).to receive(:call).and_return(subaction_response)
+end
+```
+
+## RSpec configuration
+
+Configuring rspec to treat files in spec/actions as service specs (very optional):
 
 ```ruby
 RSpec.configure do |config|

data/docs/reference/class.md

@@ -25,6 +25,7 @@ While we _support_ complex interface validations, in practice you usually just w
 In addition to the [standard ActiveModel validations](https://guides.rubyonrails.org/active_record_validations.html), we also support two additional custom validators:
 * `type: Foo` - fails unless the provided value `.is_a?(Foo)`
   * Edge case: use `type: :boolean` to handle a boolean field (since ruby doesn't have a Boolean class to pass in directly)
+  * Edge case: use `type: :uuid` to handle a confirming given string is a UUID (with or without `-` chars)
 * `validate: [callable]` - Support custom validations (fails if any string is returned OR if it raises an exception)
   * Example:
     ```ruby

data/lib/action/core/context_facade.rb

@@ -94,11 +94,21 @@ module Action
   class Result < ContextFacade
     # For ease of mocking return results in tests
     class << self
-      def ok = Class.new { include(Action) }.call
+      def ok(msg = nil, **exposures)
+        Axn::Factory.build(exposes: exposures.keys, messages: { success: msg }) do
+          exposures.each do |key, value|
+            expose(key, value)
+          end
+        end.call
+      end
 
-      def error(msg = "Something went wrong")
-        Class.new { include(Action) }.tap do |klass|
-          klass.define_method(:call) { fail!(msg) }
+      def error(msg = nil, **exposures, &block)
+        Axn::Factory.build(exposes: exposures.keys, rescues: [-> { true }, msg]) do
+          exposures.each do |key, value|
+            expose(key, value)
+          end
+          block.call if block_given?
+          fail!
         end.call
       end
     end

data/lib/action/core/contract.rb

@@ -163,11 +163,12 @@ module Action
           hash[config.field] = config.default
         end.compact
 
-        defaults_mapping.each do |field, default_value|
-          unless @context.public_send(field)
-            @context.public_send("#{field}=",
-                                 default_value.respond_to?(:call) ? default_value.call : default_value)
-          end
+        defaults_mapping.each do |field, default_value_getter|
+          next if @context.public_send(field).present?
+
+          default_value = default_value_getter.respond_to?(:call) ? instance_exec(&default_value_getter) : default_value_getter
+
+          @context.public_send("#{field}=", default_value)
         end
       end
 

data/lib/action/core/contract_validator.rb

@@ -54,6 +54,8 @@ module Action
         record.errors.add attribute, (options[:message] || msg) unless types.any? do |type|
           if type == :boolean
             [true, false].include?(value)
+          elsif type == :uuid
+            value.is_a?(String) && value.match?(/\A[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}\z/i)
           else
             value.is_a?(type)
           end

data/lib/action/core/hoist_errors.rb

@@ -36,7 +36,9 @@ module Action
                 "#hoist_errors is expected to wrap an Action call, but it returned a #{result.class.name} instead"
         end
 
-        _handle_hoisted_errors(result, prefix:) unless result.ok?
+        return result if result.ok?
+
+        _handle_hoisted_errors(result, prefix:)
       end
 
       # Separate method to allow overriding in subclasses

data/lib/axn/factory.rb

@@ -14,6 +14,10 @@ module Axn
         exposes: [],
         expects: [],
         messages: {},
+        error_from: {},
+        rescues: {},
+
+        # Hooks
         before: nil,
         after: nil,
         around: nil,
@@ -71,7 +75,10 @@ module Axn
             axn.exposes(field, **opts)
           end
 
-          axn.messages(**messages) if messages.present?
+          axn.messages(**messages) if messages.present? && messages.values.any?(&:present?)
+
+          axn.error_from(**_array_to_hash(error_from)) if error_from.present?
+          axn.rescues(**_array_to_hash(rescues)) if rescues.present?
 
           # Hooks
           axn.before(before) if before.present?
@@ -98,6 +105,12 @@ module Axn
 
       def _hash_with_default_array = Hash.new { |h, k| h[k] = [] }
 
+      def _array_to_hash(given)
+        return given if given.is_a?(Hash)
+
+        [given].to_h
+      end
+
       def _hydrate_hash(given)
         return given if given.is_a?(Hash)
 

data/lib/axn/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Axn
-  VERSION = "0.1.0-alpha.2.1"
+  VERSION = "0.1.0-alpha.2.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: axn
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.alpha.2.1
+  version: 0.1.0.pre.alpha.2.3
 platform: ruby
 authors:
 - Kali Donovan
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-05-12 00:00:00.000000000 Z
+date: 2025-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel