dry-transaction 0.11.2 → 0.13.2

data/lib/dry-transaction.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require "dry/transaction"

data/lib/dry/transaction.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "dry/monads/result"
 require "dry/transaction/version"
 require "dry/transaction/step_adapters"

data/lib/dry/transaction/builder.rb

@@ -1,7 +1,9 @@
-require "dry/transaction/step"
-require "dry/transaction/dsl"
-require "dry/transaction/instance_methods"
-require "dry/transaction/operation_resolver"
+# frozen_string_literal: true
+
+require 'dry/transaction/step'
+require 'dry/transaction/dsl'
+require 'dry/transaction/instance_methods'
+require 'dry/transaction/operation_resolver'
 
 module Dry
   module Transaction

data/lib/dry/transaction/callable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dry
   module Transaction
     # @api private
@@ -29,10 +31,26 @@ module Dry
       def call(*args, &block)
         if arity.zero?
           operation.(&block)
+        elsif ruby_27_last_arg_hash?(args)
+          *prefix, last = args
+          operation.(*prefix, **last, &block)
         else
           operation.(*args, &block)
         end
       end
+
+      private
+
+      # Ruby 2.7 gives a deprecation warning about passing a hash of parameters as the last argument
+      # to a method. Ruby 3.0 outright disallows it. This checks for that condition, but explicitly
+      # uses instance_of? rather than is_a? or kind_of?, because Hash like objects, specifically
+      # HashWithIndifferentAccess objects are provided by Rails as controller parameters, and often
+      # passed to dry-rb validators.
+      # In this case, it's better to leave the object as it's existing type, rather than implicitly
+      # convert it in to a hash with the double-splat (**) operator.
+      def ruby_27_last_arg_hash?(args)
+        args.last.instance_of?(Hash) && Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("2.7.0")
+      end
     end
   end
 end

data/lib/dry/transaction/dsl.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dry
   module Transaction
     class DSL < Module
@@ -24,16 +26,16 @@ module Dry
 
       def define_dsl
         module_exec(@step_adapters) do |step_adapters|
-          step_adapters.keys.each do |adapter_name|
+          step_adapters.each do |adapter_name, adapter|
             define_method(adapter_name) do |step_name, with: nil, **options|
-              operation_name = with || step_name
+              operation_name = with
 
               steps << Step.new(
-                step_adapters[adapter_name],
-                step_name,
-                operation_name,
-                nil, # operations are resolved only when transactions are instantiated
-                options,
+                adapter: adapter,
+                name: step_name,
+                operation_name: operation_name,
+                operation: nil, # operations are resolved only when transactions are instantiated
+                options: options,
               )
             end
           end

data/lib/dry/transaction/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dry
   module Transaction
     class InvalidStepError < ArgumentError

data/lib/dry/transaction/instance_methods.rb

@@ -1,6 +1,8 @@
-require "dry/monads/result"
-require "dry/transaction/result_matcher"
-require "dry/transaction/stack"
+# frozen_string_literal: true
+
+require 'dry/monads/result'
+require 'dry/transaction/result_matcher'
+require 'dry/transaction/stack'
 
 module Dry
   module Transaction
@@ -14,7 +16,7 @@ module Dry
 
       def initialize(steps: (self.class.steps), listeners: nil, **operations)
         @steps = steps.map { |step|
-          operation = resolve_operation(step, operations)
+          operation = resolve_operation(step, **operations)
           step.with(operation: operation)
         }
         @operations = operations
@@ -42,7 +44,7 @@ module Dry
 
         if listeners.is_a?(Hash)
           listeners.each do |step_name, listener|
-            steps.detect { |step| step.step_name == step_name }.subscribe(listener)
+            steps.detect { |step| step.name == step_name }.subscribe(listener)
           end
         else
           steps.each do |step|
@@ -55,8 +57,8 @@ module Dry
         assert_valid_step_args(step_args)
 
         new_steps = steps.map { |step|
-          if step_args[step.step_name]
-            step.with(call_args: step_args[step.step_name])
+          if step_args[step.name]
+            step.with(call_args: step_args[step.name])
           else
             step
           end
@@ -68,34 +70,36 @@ module Dry
       private
 
       def respond_to_missing?(name, _include_private = false)
-        steps.any? { |step| step.step_name == name }
+        steps.any? { |step| step.name == name }
       end
 
       def method_missing(name, *args, &block)
-        step = steps.detect { |s| s.step_name == name }
+        step = steps.detect { |s| s.name == name }
         super unless step
 
-        operation = operations[step.step_name]
-        raise NotImplementedError, "no operation +#{step.operation_name}+ defined for step +#{step.step_name}+" unless operation
+        operation = operations[step.name]
+        raise NotImplementedError, "no operation +#{step.operation_name}+ defined for step +#{step.name}+" unless operation
 
         operation.(*args, &block)
       end
 
       def resolve_operation(step, **operations)
-        if methods.include?(step.step_name) || private_methods.include?(step.step_name)
-          method(step.step_name)
-        elsif operations[step.step_name].nil?
-          raise MissingStepError.new(step.step_name)
-        elsif operations[step.step_name].respond_to?(:call)
-          operations[step.step_name]
+        if step.internal? && operations[step.name]
+          operations[step.name]
+        elsif methods.include?(step.name) || private_methods.include?(step.name)
+          method(step.name)
+        elsif operations[step.name].respond_to?(:call)
+          operations[step.name]
+        elsif operations[step.name]
+          raise InvalidStepError.new(step.name)
         else
-          raise InvalidStepError.new(step.step_name)
+          raise MissingStepError.new(step.name)
         end
       end
 
       def assert_valid_step_args(step_args)
         step_args.each_key do |step_name|
-          unless steps.any? { |step| step.step_name == step_name }
+          unless steps.any? { |step| step.name == step_name }
             raise ArgumentError, "+#{step_name}+ is not a valid step name"
           end
         end
@@ -107,7 +111,7 @@ module Dry
           num_args_supplied = step.call_args.length + 1 # add 1 for main `input`
 
           if num_args_required > num_args_supplied
-            raise ArgumentError, "not enough arguments supplied for step +#{step.step_name}+"
+            raise ArgumentError, "not enough arguments supplied for step +#{step.name}+"
           end
         end
       end

data/lib/dry/transaction/operation.rb

@@ -1,6 +1,8 @@
-require "dry/monads/result"
-require "dry/matcher"
-require "dry/matcher/result_matcher"
+# frozen_string_literal: true
+
+require 'dry/monads/result'
+require 'dry/matcher'
+require 'dry/matcher/result_matcher'
 
 module Dry
   module Transaction

data/lib/dry/transaction/operation_resolver.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dry
   module Transaction
     class OperationResolver < Module
@@ -5,7 +7,7 @@ module Dry
         module_exec(container) do |ops_container|
           define_method :initialize do |**kwargs|
             operation_kwargs = self.class.steps.select(&:operation_name).map { |step|
-              operation = kwargs.fetch(step.step_name) {
+              operation = kwargs.fetch(step.name) {
                 if ops_container && ops_container.key?(step.operation_name)
                   ops_container[step.operation_name]
                 else
@@ -13,7 +15,7 @@ module Dry
                 end
               }
 
-              [step.step_name, operation]
+              [step.name, operation]
             }.to_h
 
             super(**kwargs, **operation_kwargs)

data/lib/dry/transaction/result_matcher.rb

@@ -1,21 +1,23 @@
-require "dry/matcher"
+# frozen_string_literal: true
+
+require 'dry/matcher'
 
 module Dry
   module Transaction
     ResultMatcher = Dry::Matcher.new(
       success: Dry::Matcher::Case.new(
-        match: -> result { result.right? },
+        match: -> result { result.success? },
         resolve: -> result { result.value! }
       ),
       failure: Dry::Matcher::Case.new(
         match: -> result, step_name = nil {
           if step_name
-            result.left? && result.left.step.step_name == step_name
+            result.failure? && result.failure.step.name == step_name
           else
-            result.left?
+            result.failure?
           end
         },
-        resolve: -> result { result.left.value }
+        resolve: -> result { result.failure.value }
       )
     )
   end

data/lib/dry/transaction/stack.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dry
   module Transaction
     # @api private

data/lib/dry/transaction/step.rb

@@ -1,7 +1,9 @@
-require "dry/monads/result"
+# frozen_string_literal: true
+
+require 'dry/monads/result'
 require 'dry/events/publisher'
-require "dry/transaction/step_failure"
-require "dry/transaction/step_adapter"
+require 'dry/transaction/step_failure'
+require 'dry/transaction/step_adapter'
 
 module Dry
   module Transaction
@@ -17,14 +19,14 @@ module Dry
       register_event(:step_succeeded)
       register_event(:step_failed)
 
-      attr_reader :step_adapter
-      attr_reader :step_name
+      attr_reader :adapter
+      attr_reader :name
       attr_reader :operation_name
       attr_reader :call_args
 
-      def initialize(step_adapter, step_name, operation_name, operation, options, call_args = [])
-        @step_adapter = StepAdapter[step_adapter, operation, **options, step_name: step_name, operation_name: operation_name]
-        @step_name = step_name
+      def initialize(adapter:, name:, operation_name:, operation: nil, options:, call_args: [])
+        @adapter = StepAdapter[adapter, operation, { **options, step_name: name, operation_name: operation_name }]
+        @name = name
         @operation_name = operation_name
         @call_args = call_args
       end
@@ -32,47 +34,58 @@ module Dry
       def with(operation: UNDEFINED, call_args: UNDEFINED)
         return self if operation == UNDEFINED && call_args == UNDEFINED
 
-        new_operation = operation == UNDEFINED ? step_adapter.operation : operation
+        new_operation = operation == UNDEFINED ? adapter.operation : operation
         new_call_args = call_args == UNDEFINED ? self.call_args : Array(call_args)
 
         self.class.new(
-          step_adapter,
-          step_name,
-          operation_name,
-          new_operation,
-          step_adapter.options,
-          new_call_args
+          adapter: adapter,
+          name: name,
+          operation_name: operation_name,
+          operation: new_operation,
+          options: adapter.options,
+          call_args: new_call_args,
         )
       end
 
       def call(input, continue = RETURN)
         args = [input, *call_args]
 
-        if step_adapter.yields?
-          with_broadcast(args) { step_adapter.(args, &continue) }
+        if adapter.yields?
+          with_broadcast(args) { adapter.(args, &continue) }
         else
-          continue.(with_broadcast(args) { step_adapter.(args) })
+          continue.(with_broadcast(args) { adapter.(args) })
         end
       end
 
       def with_broadcast(args)
-        publish(:step, step_name: step_name, args: args)
+        publish(:step, step_name: name, args: args)
 
         yield.fmap { |value|
-          publish(:step_succeeded, step_name: step_name, args: args, value: value)
+          publish(:step_succeeded, step_name: name, args: args, value: value)
           value
         }.or { |value|
-          publish(:step_failed, step_name: step_name, args: args, value: value)
-          Failure(StepFailure.new(self, value))
+          Failure(
+            StepFailure.(self, value) {
+              publish(:step_failed, step_name: name, args: args, value: value)
+            }
+          )
         }
       end
 
+      def internal?
+        !external?
+      end
+
+      def external?
+        !!operation_name
+      end
+
       def arity
-        step_adapter.operation.arity
+        adapter.operation.arity
       end
 
       def operation
-        step_adapter.operation
+        adapter.operation
       end
     end
   end

data/lib/dry/transaction/step_adapter.rb

@@ -1,4 +1,6 @@
-require "dry/transaction/callable"
+# frozen_string_literal: true
+
+require 'dry/transaction/callable'
 
 module Dry
   module Transaction
@@ -28,9 +30,9 @@ module Dry
 
         @options = options
 
-        @yields = @adapter.
-                    parameters.
-                    any? { |type, _| type == :block }
+        @yields = @adapter
+          .parameters
+          .any? { |type, _| type == :block }
       end
 
       def yields?

data/lib/dry/transaction/step_adapters.rb

@@ -1,4 +1,6 @@
-require "dry-container"
+# frozen_string_literal: true
+
+require 'dry-container'
 
 module Dry
   module Transaction
@@ -8,9 +10,9 @@ module Dry
   end
 end
 
-require "dry/transaction/step_adapters/check"
-require "dry/transaction/step_adapters/map"
-require "dry/transaction/step_adapters/raw"
-require "dry/transaction/step_adapters/tee"
-require "dry/transaction/step_adapters/try"
-require "dry/transaction/step_adapters/around"
+require 'dry/transaction/step_adapters/check'
+require 'dry/transaction/step_adapters/map'
+require 'dry/transaction/step_adapters/raw'
+require 'dry/transaction/step_adapters/tee'
+require 'dry/transaction/step_adapters/try'
+require 'dry/transaction/step_adapters/around'

data/lib/dry/transaction/step_adapters/around.rb

@@ -1,5 +1,7 @@
-require "dry/monads/result"
-require "dry/transaction/errors"
+# frozen_string_literal: true
+
+require 'dry/monads/result'
+require 'dry/transaction/errors'
 
 module Dry
   module Transaction

data/lib/dry/transaction/step_adapters/check.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dry
   module Transaction
     class StepAdapters

data/lib/dry/transaction/step_adapters/map.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dry
   module Transaction
     class StepAdapters