dry-transaction 0.9.0 → 0.10.0

data/spec/spec_helper.rb

@@ -1,6 +1,8 @@
-if RUBY_ENGINE == "ruby" && RUBY_VERSION >= "2.3"
+if RUBY_ENGINE == "ruby" && RUBY_VERSION >= "2.4"
   require "simplecov"
-  SimpleCov.start
+  SimpleCov.start do
+    add_filter "/spec/"
+  end
 end
 
 begin
@@ -8,6 +10,8 @@ begin
 rescue LoadError; end
 
 require "dry-transaction"
+require "dry-matcher"
+require "dry-monads"
 
 # Requires supporting ruby files with custom matchers and macros, etc, in
 # spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are

data/spec/unit/step_spec.rb

@@ -48,6 +48,35 @@ RSpec.describe Dry::Transaction::Step do
     end
   end
 
+  describe "#with" do
+    let(:operation) { proc { |a, b| a + b } }
+    context "without arguments" do
+      it "returns itself" do
+        expect(step.with).to eq step
+      end
+    end
+
+    context "with operation argument" do
+      it "returns new instance with only operation changed" do
+        new_operation = proc { |a,b| a * b }
+        new_step = step.with(operation: new_operation)
+        expect(new_step).to_not eq step
+        expect(new_step.operation_name).to eq step.operation_name
+        expect(new_step.operation).to_not eq step.operation
+      end
+    end
+
+    context "with call_args argument" do
+      let(:call_args) { [12] }
+      it "returns new instance with only call_args changed" do
+        new_step = step.with(call_args: call_args)
+        expect(new_step).to_not eq step
+        expect(new_step.operation_name).to eq step.operation_name
+        expect(new_step.call_args).to_not eq step.call_args
+      end
+    end
+  end
+
   describe "#arity" do
     subject { step.arity }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dry-transaction
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Tim Riley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-18 00:00:00.000000000 Z
+date: 2017-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-container
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.13.1
+        version: '1.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.13.1
+        version: '1.15'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -150,8 +150,11 @@ files:
 - Rakefile
 - lib/dry-transaction.rb
 - lib/dry/transaction.rb
-- lib/dry/transaction/api.rb
+- lib/dry/transaction/builder.rb
 - lib/dry/transaction/dsl.rb
+- lib/dry/transaction/instance_methods.rb
+- lib/dry/transaction/operation.rb
+- lib/dry/transaction/operation_resolver.rb
 - lib/dry/transaction/result_matcher.rb
 - lib/dry/transaction/step.rb
 - lib/dry/transaction/step_adapters.rb
@@ -159,12 +162,11 @@ files:
 - lib/dry/transaction/step_adapters/raw.rb
 - lib/dry/transaction/step_adapters/tee.rb
 - lib/dry/transaction/step_adapters/try.rb
-- lib/dry/transaction/step_definition.rb
 - lib/dry/transaction/step_failure.rb
 - lib/dry/transaction/version.rb
 - spec/examples.txt
-- spec/integration/custom_matcher_spec.rb
 - spec/integration/custom_step_adapters_spec.rb
+- spec/integration/operation_spec.rb
 - spec/integration/passing_step_arguments_spec.rb
 - spec/integration/publishing_step_events_spec.rb
 - spec/integration/transaction_spec.rb
@@ -175,9 +177,7 @@ files:
 - spec/unit/step_adapters/raw_spec.rb
 - spec/unit/step_adapters/tee_spec.rb
 - spec/unit/step_adapters/try_spec.rb
-- spec/unit/step_definition_spec.rb
 - spec/unit/step_spec.rb
-- spec/unit/transaction_spec.rb
 homepage: https://github.com/dry-rb/dry-transaction
 licenses:
 - MIT
@@ -198,7 +198,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Business Transaction Flow DSL

data/lib/dry/transaction/api.rb

@@ -1,301 +0,0 @@
-require "dry/monads/either"
-
-module Dry
-  class Transaction
-    module API
-      # Run the transaction.
-      #
-      # Each operation will be called in the order it was specified, with its
-      # output passed as input to the next operation. Operations will only be
-      # called if the previous step was a success.
-      #
-      # If any of the operations require extra arguments beyond the main input
-      # e.g. with a signature like `#call(something_else, input)`, then you
-      # must pass the extra arguments as arrays for each step in the options
-      # hash.
-      #
-      # @example Running a transaction
-      #   my_transaction.call(some_input)
-      #
-      # @example Running a transaction with extra step arguments
-      #   my_transaction.call(some_input, step_name: [extra_argument])
-      #
-      # The return value will be the output from the last operation, wrapped
-      # in a [dry-monads](dry-monads) `Either` object, a `Right` for a successful
-      # transaction or a `Left` for a failed transaction.
-      #
-      # [dry-monads]: https://rubygems.org/gems/dry-monads
-      #
-      # @param input
-      # @param options [Hash] extra step arguments
-      #
-      # @return [Right, Left] output from the final step
-      #
-      # @api public
-      def call(input, options = {}, &block)
-        assert_valid_options(options)
-        assert_options_satisfy_step_arity(options)
-
-        steps = steps_with_options_applied(options)
-        result = steps.inject(Dry::Monads.Right(input), :bind)
-
-        if block
-          matcher.(result, &block)
-        else
-          result.or { |step_failure|
-            # Unwrap the value from the StepFailure and return it directly
-            Dry::Monads.Left(step_failure.value)
-          }
-        end
-      end
-      alias_method :[], :call
-
-      # Subscribe to notifications from steps.
-      #
-      # When each step completes, it will send a `[step_name]_success` or
-      # `[step_name]_failure` message to any subscribers.
-      #
-      # For example, if you had a step called `persist`, then it would send
-      # either `persist_success` or `persist_failure` messages to subscribers
-      # after the operation completes.
-      #
-      # Pass a single object to subscribe to notifications from all steps, or
-      # pass a hash with step names as keys to subscribe to notifications from
-      # specific steps.
-      #
-      # @example Subscribing to notifications from all steps
-      #   my_transaction.subscribe(my_listener)
-      #
-      # @example Subscribing to notifications from specific steps
-      #   my_transaction.subscribe(some_step: my_listener, another_step: another_listener)
-      #
-      # Notifications are implemented using the [Wisper](wisper) gem.
-      #
-      # [wisper]: https://rubygems.org/gems/wisper
-      #
-      # @param listeners [Object, Hash{Symbol => Object}] the listener object or
-      #     hash of steps and listeners
-      #
-      # @api public
-      def subscribe(listeners)
-        if listeners.is_a?(Hash)
-          listeners.each do |step_name, listener|
-            steps.detect { |step| step.step_name == step_name }.subscribe(listener)
-          end
-        else
-          steps.each do |step|
-            step.subscribe(listeners)
-          end
-        end
-
-        self
-      end
-
-      # Return a transaction with the steps from the provided transaction
-      # prepended onto the beginning of the steps in `self`.
-      #
-      # @example Prepend an existing transaction
-      #   my_transaction = Dry.Transaction(container: container) do
-      #     step :first
-      #     step :second
-      #   end
-      #
-      #   other_transaction = Dry.Transaction(container: container) do
-      #     step :another
-      #   end
-      #
-      #   my_transaction.prepend(other_transaction)
-      #
-      # @example Prepend a transaction defined inline
-      #   my_transaction = Dry.Transaction(container: container) do
-      #     step :first
-      #     step :second
-      #   end
-      #
-      #   my_transaction.prepend(container: container) do
-      #     step :another
-      #   end
-      #
-      # @param other [Dry::Transaction] the transaction to prepend.
-      #     Optional if you will define a transaction inline via a block.
-      # @param options [Hash] the options hash for defining a transaction inline
-      #     via a block. Optional if the transaction is passed directly as
-      #     `other`.
-      # @option options [#[]] :container the operations container
-      #
-      # @return [Dry::Transaction] the modified transaction object
-      #
-      # @api public
-      def prepend(other = nil, **options, &block)
-        other = accept_or_build_transaction(other, **options, &block)
-
-        self.class.new(other.steps + steps, matcher)
-      end
-
-      # Return a transaction with the steps from the provided transaction
-      # appended onto the end of the steps in `self`.
-      #
-      # @example Append an existing transaction
-      #   my_transaction = Dry.Transaction(container: container) do
-      #     step :first
-      #     step :second
-      #   end
-      #
-      #   other_transaction = Dry.Transaction(container: container) do
-      #     step :another
-      #   end
-      #
-      #   my_transaction.append(other_transaction)
-      #
-      # @example Append a transaction defined inline
-      #   my_transaction = Dry.Transaction(container: container) do
-      #     step :first
-      #     step :second
-      #   end
-      #
-      #   my_transaction.append(container: container) do
-      #     step :another
-      #   end
-      #
-      # @param other [Dry::Transaction] the transaction to append.
-      #     Optional if you will define a transaction inline via a block.
-      # @param options [Hash] the options hash for defining a transaction inline
-      #     via a block. Optional if the transaction is passed directly as
-      #     `other`.
-      # @option options [#[]] :container the operations container
-      #
-      # @return [Dry::Transaction] the modified transaction object
-      #
-      # @api public
-      def append(other = nil, **options, &block)
-        other = accept_or_build_transaction(other, **options, &block)
-
-        self.class.new(steps + other.steps, matcher)
-      end
-
-      # Return a transaction with the steps from the provided transaction
-      # inserted into a specific place among the steps in `self`.
-      #
-      # Transactions can be inserted either before or after a named step.
-      #
-      # @example Insert an existing transaction (before a step)
-      #   my_transaction = Dry.Transaction(container: container) do
-      #     step :first
-      #     step :second
-      #   end
-      #
-      #   other_transaction = Dry.Transaction(container: container) do
-      #     step :another
-      #   end
-      #
-      #   my_transaction.insert(other_transaction, before: :second)
-      #
-      # @example Append a transaction defined inline (after a step)
-      #   my_transaction = Dry.Transaction(container: container) do
-      #     step :first
-      #     step :second
-      #   end
-      #
-      #   my_transaction.insert(after: :first, container: container) do
-      #     step :another
-      #   end
-      #
-      # @param other [Dry::Transaction] the transaction to append.
-      #     Optional if you will define a transaction inline via a block.
-      # @param before [Symbol] the name of the step before which the
-      #     transaction should be inserted (provide either this or `after`)
-      # @param after [Symbol] the name of the step after which the transaction
-      #     should be inserted (provide either this or `before`)
-      # @param options [Hash] the options hash for defining a transaction
-      #     inline via a block. Optional if the transaction is passed directly
-      #     as `other`.
-      # @option options [#[]] :container the operations container
-      #
-      # @return [Dry::Transaction] the modified transaction object
-      #
-      # @api public
-      def insert(other = nil, before: nil, after: nil, **options, &block)
-        insertion_step = before || after
-        match_insertion_step = proc { |step| step.step_name == insertion_step }
-
-        unless steps.any?(&match_insertion_step)
-          raise ArgumentError, "+#{insertion_step}+ is not a valid step name"
-        end
-
-        other = accept_or_build_transaction(other, **options, &block)
-        index = steps.index(&match_insertion_step) + (after ? 1 : 0)
-
-        self.class.new(steps.dup.insert(index, *other.steps), matcher)
-      end
-
-      # @overload remove(step, ...)
-      #   Return a transaction with steps removed.
-      #
-      #   @example
-      #     my_transaction = Dry.Transaction(container: container) do
-      #       step :first
-      #       step :second
-      #       step :third
-      #     end
-      #
-      #     my_transaction.remove(:first, :third)
-      #
-      #   @param step [Symbol] the names of a step to remove
-      #   @param ... [Symbol] more names of steps to remove
-      #
-      #   @return [Dry::Transaction] the modified transaction object
-      #
-      #   @api public
-      def remove(*steps_to_remove)
-        self.class.new(steps.reject { |step| steps_to_remove.include?(step.step_name) }, matcher)
-      end
-
-      private
-
-      # @param options [Hash] step arguments keyed by step name
-      def assert_valid_options(options)
-        options.each_key do |step_name|
-          unless steps.any? { |step| step.step_name == step_name }
-            raise ArgumentError, "+#{step_name}+ is not a valid step name"
-          end
-        end
-      end
-
-      # @param options [Hash] step arguments keyed by step name
-      def assert_options_satisfy_step_arity(options)
-        steps.each do |step|
-          args_required = step.arity >= 0 ? step.arity : ~step.arity
-          args_supplied = options.fetch(step.step_name, []).length + 1 # add 1 for main `input`
-
-          if args_required > args_supplied
-            raise ArgumentError, "not enough options for step +#{step.step_name}+"
-          end
-        end
-      end
-
-      # @param options [Hash] step arguments keyed by step name
-      def steps_with_options_applied(options)
-        steps.map { |step|
-          if (args = options[step.step_name])
-            step.with_call_args(*args)
-          else
-            step
-          end
-        }
-      end
-
-      def accept_or_build_transaction(other_transaction = nil, **options, &block)
-        unless other_transaction || block
-          raise ArgumentError, "a transaction must be provided or defined in a block"
-        end
-
-        if other_transaction
-          other_transaction
-        else
-          require "dry/transaction/dsl"
-          DSL.new(**options, &block).call
-        end
-      end
-    end
-  end
-end

data/lib/dry/transaction/step_definition.rb

@@ -1,23 +0,0 @@
-module Dry
-  class Transaction
-    # @api private
-    class StepDefinition
-      include Dry::Monads::Either::Mixin
-
-      def initialize(container, &block)
-        @container = container
-        @block = block
-        freeze
-      end
-
-      def call(*args)
-        instance_exec(*args, &block)
-      end
-
-      private
-
-      attr_reader :block
-      attr_reader :container
-    end
-  end
-end