hubbado-trailblazer 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec0cd7706778cadb1bb1bb2627e3883b39662f6ff761c317fddad4efc2ef586d
-  data.tar.gz: dce6665b9dfba888fe406ab7db73e34f2626b427fad5a1bd05478f174aa45da1
+  metadata.gz: 236eb296eba6cbbfe62d8501dbb1a9984a3f286de4d3f1e61ec494713cc6fcc8
+  data.tar.gz: ae8c2c869e63aba3503902e6d1b229d414f1a33d78378d20c1dcca9b48a7da2d
 SHA512:
-  metadata.gz: be2c721e83a16d26f37a2b33e6c14700a5dbf436a7b4550a4ef1f73755aea5228a27541d177e3567621a901e3710eec93a6894b5a53e4b36fa9d3e6c746c556c
-  data.tar.gz: 044d2a714de04d0a85a6cfa7c1ddefc736273dc7dfcf2cb2eb32a22b8fbd927cc79fa5330bd9d85a17a672a2133544031cb548c8f68ad3faed4e94f5634f2783
+  metadata.gz: 4fff16b5816e5ece06716e01e9bf44f6fa6fc20d2db1abff64af8d526824ed1d47668bfbc6d3912e50697151e8582647d219973c86ecbcef53bb5a954a5f82e4
+  data.tar.gz: 415fcc8495e1e3c9c099b502cf8dc4ed0a14dab9fc4dc66a4ff452f5c37eb76bcc558dc0d93a9449009f39df54c859031103b29f7f8f63d92a2fc8ed79ca94cf

data/CHANGELOG.md

@@ -5,6 +5,22 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.3.0] - 2025-11-26
+
+### Added
+
+- Support for `result.not_found { ... }` block to handle operations with `:not_found` terminus.
+
+## [1.2.0] - 2025-07-19
+
+### Added
+
+- rspec matcher `:have_deserialized_params` for DeserializeContractParams
+
+### Changed
+
+- PrepopulateContract is renamed to DeserializeContractParams
+
 ## [1.1.0] - 2025-07-08
 
 ### Changed

data/README.md

@@ -137,10 +137,16 @@ Prepopulate Reform contracts with values from params without validation:
 class Users::Edit < Trailblazer::Operation
   step Model(User, :find)
   step Contract::Build(constant: Users::UpdateContract)
-  step Hubbado::Trailblazer::Macro::PrepopulateContract()
+  step Hubbado::Trailblazer::Macro::DeserializeContractParams()
 end
 ```
 
+In addition, there is a RSpec matcher `have_deserialized_params` for this macro and
+has to be required manually:
+```ruby
+require 'hubbado/trailblazer/rspec_matchers/have_deserialized_params'
+```
+
 ## Operation Tracing
 
 Debug operation execution by setting the `TRACE_OPERATION` environment variable:

data/hubbado-trailblazer.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "hubbado-trailblazer"
-  s.version = "1.1.0"
+  s.version = "1.3.0"
   s.summary = "Enhanced Trailblazer operation utilities for Ruby applications with improved error handling, operation execution patterns, and ActiveRecord integration."
 
   s.authors = ["Hubbado Devs"]

data/lib/hubbado/trailblazer/macro/{prepopulate_contract.rb → deserialize_contract_params.rb}

@@ -7,9 +7,9 @@ module Hubbado
       # For example, a contract, for a not yet saved assignment, might have
       # timesheet approvers that depend on the client company ID in the
       # contract
-      def self.PrepopulateContract(key: nil)
+      def self.DeserializeContractParams(key: nil)
         task = ->((ctx, flow_options), _) do
-          ctx[:prepopulated_contract] = key ? key : true
+          ctx[:deserialized_params] = key || true
 
           params = key ? ctx[:params][key] : ctx[:params]
 
@@ -20,7 +20,7 @@ module Hubbado
           [::Trailblazer::Activity::Right, [ctx, flow_options]]
         end
 
-        { task: task, id: "PrepopulateContract" }
+        { task: task, id: "DeserializeContractParams" }
       end
     end
   end

data/lib/hubbado/trailblazer/rspec_matchers/have_deserialized_params.rb

@@ -0,0 +1,19 @@
+module Hubbado
+  module Trailblazer
+    module RspecMatchers
+      module DeserializeContractParams
+        extend RSpec::Matchers::DSL
+
+        matcher :have_deserialized_params do |key: nil|
+          match(notify_expectation_failures: true) do |ctx|
+            expect(ctx[:deserialized_params]).to eq(key || true)
+          end
+        end
+
+        RSpec.configure do |rspec|
+          rspec.include self, type: :operation
+        end
+      end
+    end
+  end
+end

data/lib/hubbado/trailblazer/run_operation.rb

@@ -16,6 +16,10 @@ module Hubbado
     #    result.raise_policy_failed
     #  end
     #
+    #  result.not_found do |ctx|
+    #    ...
+    #  end
+    #
     #  result.validation_failed do |ctx|
     #    ...
     #  end
@@ -34,6 +38,9 @@ module Hubbado
     # If there is a policy failure and you have not implemented
     # `result.policy_failed` then an exception will be raised.
     #
+    # If the operation has not_found terminus and you have not
+    # implemented `result.not_found` then ActiveRecord::RecordNotFound will be raised.
+    #
     # If the operation fails (due to non-policy error) and you have not
     # implemented `result.otherwise` then an exception will be raised.
     #
@@ -87,7 +94,9 @@ module Hubbado
 
         if ctx['result.policy.default']&.failure?
           result.raise_policy_failed unless result.policy_failed_executed?
-        elsif ctx.failure? && !result.validation_failed_executed? && !result.otherwise_executed?
+        elsif !result.not_found_executed? && ctx.terminus.to_h[:semantic] == :not_found
+          result.raise_not_found
+        elsif ctx.failure? && !result.validation_failed_executed? && !result.not_found_executed? && !result.otherwise_executed?
           result.raise_operation_failed
         end
 
@@ -159,6 +168,16 @@ module Hubbado
           @returned
         end
 
+        def not_found
+          return unless ctx.terminus.to_h[:semantic] == :not_found
+
+          @not_found_executed = true
+          @returned = yield(ctx)
+
+          logger.send(log_level, "Not found block executed for operation #{operation}")
+          @returned
+        end
+
         def otherwise
           return if executed?
 
@@ -169,6 +188,12 @@ module Hubbado
           @returned
         end
 
+        def raise_not_found
+          msg = "Record for operation #{operation.name} not found"
+
+          raise ActiveRecord::RecordNotFound, msg
+        end
+
         def raise_operation_failed
           msg = "Operation #{operation.name} failed"
 
@@ -203,6 +228,10 @@ module Hubbado
           !!@validation_failed_executed
         end
 
+        def not_found_executed?
+          !!@not_found_executed
+        end
+
         def otherwise_executed?
           !!@otherwise_executed
         end
@@ -211,6 +240,7 @@ module Hubbado
           success_executed? ||
             policy_failed_executed? ||
             validation_failed_executed? ||
+            not_found_executed? ||
             otherwise_executed?
         end
 

data/lib/hubbado-trailblazer.rb

@@ -11,4 +11,4 @@ require 'hubbado/trailblazer/trace_operation'
 
 require 'hubbado/trailblazer/macro/decorate_model'
 require 'hubbado/trailblazer/macro/policy'
-require 'hubbado/trailblazer/macro/prepopulate_contract'
+require 'hubbado/trailblazer/macro/deserialize_contract_params'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hubbado-trailblazer
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Hubbado Devs
@@ -191,8 +191,9 @@ files:
 - lib/hubbado/trailblazer.rb
 - lib/hubbado/trailblazer/errors.rb
 - lib/hubbado/trailblazer/macro/decorate_model.rb
+- lib/hubbado/trailblazer/macro/deserialize_contract_params.rb
 - lib/hubbado/trailblazer/macro/policy.rb
-- lib/hubbado/trailblazer/macro/prepopulate_contract.rb
+- lib/hubbado/trailblazer/rspec_matchers/have_deserialized_params.rb
 - lib/hubbado/trailblazer/run_operation.rb
 - lib/hubbado/trailblazer/trace_operation.rb
 - lib/hubbado/trailblazer/transaction.rb
@@ -216,7 +217,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.7.2
 specification_version: 4
 summary: Enhanced Trailblazer operation utilities for Ruby applications with improved
   error handling, operation execution patterns, and ActiveRecord integration.