Contents

require "kleisli"
require "dry/transaction/version"
require "dry/transaction/dsl"

module Dry
  # Define a business transaction.
  #
  # A business transaction is a series of callable operation objects that
  # receive input and produce an output.
  #
  # The operations should be addressable via `#[]` in a container object that
  # you pass when creating the transaction. The operations must respond to
  # `#call(*args, input)`.
  #
  # Each operation will be called in the order it was specified in your
  # transaction, with its output is passed as the input to the next operation.
  # Operations will only be called if the previous step was a success.
  #
  # A step is successful when it returns a [Kleisli](kleisli) `Right` object
  # wrapping its output value. A step is a failure when it returns a `Left`
  # object.  If your operations already return a `Right` or `Left`, they can be
  # added to your operation as plain `step` steps.
  #
  # If your operations don't already return `Right` or `Left`, then they can be
  # added to the transaction with the following steps:
  #
  # * `map` --- wrap the output of the operation in a `Right`
  # * `try` --- wrap the output of the operation in a `Right`, unless a certain
  #   exception is raised, which will be caught and returned as a `Left`.
  # * `tee` --- ignore the output of the operation and pass through its original
  #   input as a `Right`.
  #
  # [kleisli]: https://rubygems.org/gems/kleisli
  #
  # @example
  #   container = {do_first: some_obj, do_second: some_obj}
  #
  #   my_transaction = Dry.Transaction(container: container) do
  #     step :do_first
  #     step :do_second
  #   end
  #
  #   my_transaction.call(some_input)
  #
  # @param options [Hash] the options hash
  # @option options [#[]] :container the operations container
  #
  # @return [Dry::Transaction::Steps] the transaction object
  #
  # @api public
  def self.Transaction(options = {}, &block)
    Transaction::DSL.new(options, &block).call
  end
end

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
dry-transaction-0.6.0	lib/dry/transaction.rb
dry-transaction-0.5.0	lib/dry/transaction.rb
dry-transaction-0.4.0	lib/dry/transaction.rb