dry-transaction-extra 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 655e43f9df76abfb9b93f04cf55ea437635662ffcfef58b78d1227f63d8560af
+  data.tar.gz: 8343148513834477223867d864b9270f85109780b64ccbcd182373694cc2bd6b
+SHA512:
+  metadata.gz: ff3ce715ed177028996635b2bac116604447266d0952f7ef8ed33c1b69f3d727b3171903310233768d086af583b3103d258910cc34365b012ef57450f6faccf5
+  data.tar.gz: 07012d6bbd9be48f99646389d020c90c92a9efdf02da014f66e3cccc04540fb122bf7ddbc26a2cbc5799a9c1d1671fb7399d2e0278f50b2a734004d7b816e73a

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,35 @@
+AllCops:
+  TargetRubyVersion: 3.2
+
+Layout/LineLength:
+  Max: 120
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - "spec/**/*"  # `expect { }.to change { }` is fine
+
+Metrics/BlockLength:
+  Exclude:
+    - Gemfile
+    - Guardfile
+  AllowedMethods:
+    - configure
+    - context
+    - define
+    - describe
+    - factory
+    - it
+    - namespace
+    - specify
+    - task
+    - shared_examples_for
+    - shared_context
+    - feature
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at psadauskas@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in dry-transaction-extra.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,112 @@
+PATH
+  remote: .
+  specs:
+    dry-transaction-extra (0.1.0)
+      dry-monads (~> 1.3)
+      dry-transaction (~> 0.15)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    concurrent-ruby (1.1.10)
+    diff-lcs (1.5.0)
+    dry-configurable (1.0.1)
+      dry-core (~> 1.0, < 2)
+      zeitwerk (~> 2.6)
+    dry-container (0.11.0)
+      concurrent-ruby (~> 1.0)
+    dry-core (1.0.0)
+      concurrent-ruby (~> 1.0)
+      zeitwerk (~> 2.6)
+    dry-events (1.0.1)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.0, < 2)
+    dry-inflector (1.0.0)
+    dry-initializer (3.1.1)
+    dry-logic (1.5.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.0, < 2)
+      zeitwerk (~> 2.6)
+    dry-matcher (0.10.0)
+      dry-core (~> 1.0)
+    dry-monads (1.6.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.0, < 2)
+      zeitwerk (~> 2.6)
+    dry-schema (1.13.0)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 1.0, >= 1.0.1)
+      dry-core (~> 1.0, < 2)
+      dry-initializer (~> 3.0)
+      dry-logic (>= 1.5, < 2)
+      dry-types (>= 1.7, < 2)
+      zeitwerk (~> 2.6)
+    dry-transaction (0.15.0)
+      dry-core (~> 1.0)
+      dry-events (~> 1.0)
+      dry-matcher (~> 0.10)
+      dry-monads (~> 1.6)
+    dry-types (1.7.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.0, < 2)
+      dry-inflector (~> 1.0, < 2)
+      dry-logic (>= 1.4, < 2)
+      zeitwerk (~> 2.6)
+    dry-validation (1.10.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.0, < 2)
+      dry-initializer (~> 3.0)
+      dry-schema (>= 1.12, < 2)
+      zeitwerk (~> 2.6)
+    json (2.6.3)
+    parallel (1.22.1)
+    parser (3.2.0.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.1)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.43.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.24.1)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.4.2)
+    zeitwerk (2.6.6)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  dry-container (~> 0.7)
+  dry-schema (~> 1.10)
+  dry-transaction-extra!
+  dry-validation (~> 1.8)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.4.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Paul Sadauskas
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,289 @@
+# Dry::Transaction::Extra
+
+Dry::Transaction comes with a limited set of steps. This gem defines a few more steps that are useful for getting the most out of Transactions.
+
+## Installation
+
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add dry-transaction-extra
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install dry-transaction-extra
+
+## Usage
+
+By requiring the gem, you get a few additional Step adapters registered with dry-transaction, and can begin using them immediately. 
+
+```ruby
+require "dry-transaction-extra"
+```
+
+### Additional Steps
+
+Dry::Transaction::Extra defines a few extra steps you can use:
+
+ * [merge][#merge] -- Merges the output of the step with the input args. Best used with keyword arguments.
+ * [tap][#tap] -- Similar to Ruby `Kernel#tap`, discards the return value of the step
+   and returns the original input. If the step fails, then returns the Failure
+   instead.
+ * [valid][#valid] -- Runs a Dry::Schema or Dry::Validation::Contract on the input, and transforms the validation Result to a Result monad.
+
+#### `merge`
+
+If you're using keyword args as the arguments to your steps, you often want a
+step to add its output to those args, while keeping the original kwargs intact.
+
+ * If the output of the step is a Hash, then that hash is merged into the input.
+ * If the output of the step is not a Hash, then a key is inferred from the
+   step name. The name of the key can be overridden with the `as:` option.
+
+##### Merging Hash output
+
+```ruby
+merge :add_context
+
+# Input: { user: #<User id:42>, account: #<Account id:1> }
+def add_context(user:, **)
+  {
+    email: user.email,
+    token: UserToken.lookup(user)
+  }
+end
+# Output: { user: #<User id:42>, account: #<Account id:1>, email: "paul@myapp.example", token: "1234" }
+```
+
+##### Merging non-Hash output, inferring the key from the step name
+
+```ruby
+merge :user
+
+# Input: { id: 42 }
+def user(id:, **)
+  User.find(id)
+end
+# Output: { id: 42, user: #<User id:42> }
+```
+
+##### Merging non-Hash output, specifying the key explicitly
+
+```ruby
+merge :find_user, as: :current_user
+
+# Input: { id: 42 }
+def find_user(id:, **)
+  User.find(id)
+end
+# Output: { id: 42, current_user: #<User id:42> }
+```
+
+#### `tap` 
+
+A step that mimics Ruby's builtin
+[Kernel#tap](https://ruby-doc.org/3.1.2/Kernel.html#method-i-tap) method. If
+the step succeeds, the step output is ignored and the original input is
+returned. However, if the step fails, then that Failure is returned instead.
+
+```ruby
+tap :track_user
+map :next_step
+
+def track_user(user)
+  response = Tracker.track(user_id: user.email)
+  return Failure(response.body) if response.status >= 400
+end
+
+def next_step(user)
+  # Normally, the return value if the previous step would be passed
+  # as the input to this step. In this case, we don't care, we want
+  # to keep going with the original input `user`.
+end
+```
+
+#### `use`
+
+Invokes another Transaction (or anything else `#call`-able), and merges the
+result. It can also lookup the item to invoke in a container, which allows it
+to be changed at runtime, or for tests.
+
+The output of the invoked item is merged with the input, following the same
+rules as the [`merge`][#merge] step.
+
+This also works well in conjunction with the [Class Callable][#class-callable]
+extension.
+
+```ruby
+use FindUser
+use AppContainer, :find_user
+use ->(id:, **) { User.find(id) }, as: "user"
+```
+
+*Note*: The Container-lookup form of this is functionally equivalent to the built-in Dry Container Dependency Inject that is a part of Dry-Transaction (but lacking the `merge` semantics. However, you may find this method to be more readable, particularly when combined with other step adapters with a similar structure.
+
+```ruby
+class CreateUser
+  step :validate, with: "validate"
+  step :create, with: "create"
+
+  # vs
+
+  use UserContainer, "validate"
+  use UserContainer, "create"
+end
+```
+
+#### `valid`
+
+Runs a Dry::Schema or Dry::Validation::Contract, either passed to the step
+directly, or returned from the step method. It runs the validator on the input
+arguments, and returns Success on the validator output, or the Failure with
+errors returned from the validator.
+
+```ruby
+valid :validate_params
+
+def validate_params(params)
+  Dry::Schema.Params do
+    required(:name).filled(:string)
+    required(:email).filled(:string)
+  end
+end
+```
+
+*This is essentially equivalent to:*
+
+```
+step :validate_params
+
+def validate_params(params)
+  Dry::Schema.Params do
+    required(:name).filled(:string)
+    required(:email).filled(:string)
+  end.call(params).to_monad
+end
+```
+
+You can also define the Schema/Contract elsewhere if you want to reuse it, and invoke it:
+
+```
+valid ParamsValidator
+```
+
+#### `maybe`
+
+Maybe combines the [`use`][#use] step with the [Validation
+extension][#validation]. Before attempting to run the provided transaction, it
+first runs its defined validator. If that validation passes, then it invokes
+the transaction. If the validation fails, however, then the transaction
+continues on, silently ignoring the failure. This is useful in several
+scenarios, like not running if there's insufficient data, or they've already
+been run.
+
+For example, when creating a user, if they provided an email address, we want
+to send a verification email. If they didn't provide an email, or we've already
+verified it, then we can skip that part. Given a `VerifyEmail` transaction with
+a `validation` block that requires an email address, and does something to
+check if we've already verified it, we can use a `maybe` to invoke it. If that
+validator fails, then we can ignore it and create the user anyway. 
+
+```ruby
+class VerifyEmail
+  include Dry::Transaction
+  include Dry::Transaction::Extra
+  load_extensions :validation, :class_callable
+
+  validate do
+    params do 
+      required(:email).filled(type?: EmailAddress)
+    end
+
+    rule(:email) do
+      !EmailValidation.exists?(value)
+    end
+  end
+
+  step :send_verification_email
+end
+
+class CreateUser
+  include Dry::Transaction
+  include Dry::Transaction::Extra
+  load_extensions :validation
+
+  validate do
+    params do 
+      optional(:email).filled(:string)
+    end
+  end
+
+  maybe VerifyEmail
+  step :create_user
+```
+
+
+### Extensions
+
+#### Validation
+
+In addition to the [valid][#valid] step adapter, Dry::Transaction::Extra has
+support for an explicit "pre-flight" validation that runs as the first step. 
+
+```ruby
+class CreateUser
+  include Dry::Transaction
+  include Dry::Transaction::Extra
+  load_extensions :validation
+
+  validate do
+    params do
+      required(:name).filled(:string)
+      optional(:email).maybe(:string)
+    end
+  end
+
+  step :create_user
+end
+```
+
+This is useful if you want to, for example, run the transaction as an async background job, but want to first verify the arguments to the job before enqueueing it. If the job is going to fail anyway, why bother creating it in the first place?
+
+```ruby
+result = CreateUser.validator.new.call(params)
+CreateUserJob.perform_async(params) unless result.failure?
+```
+
+#### Class Callable
+
+This is a nice shorthand to initialize and call a Transaction in a single method. If you don't need to pass any arguments to the initializer, then you can `#call` it directly on the class:
+
+```ruby
+MyTransaction.new.call(args)
+MyTransaction.call(args)
+```
+
+This is particularly useful when invoking transactions via the [`use`][#use] and [`maybe`][#maybe] steps:
+
+```
+use   MyTransaction
+maybe MyOptionalTransaction
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/paul/dry-transaction-extra. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/paul/dry-transaction-extra/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Dry::Transaction::Extra project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/paul/dry-transaction-extra/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/dry-transaction-extra.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative "lib/dry/transaction/extra/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "dry-transaction-extra"
+  spec.version = Dry::Transaction::Extra::VERSION
+  spec.authors = ["Paul Sadauskas"]
+  spec.email = ["psadauskas@gmail.com"]
+
+  spec.summary = "Extra steps and functionality for Dry::Transaction"
+  spec.description = "Dry::Transaction comes with a limited set of steps. This \
+  gem defines a few more steps that are useful for getting the most out of Transactions."
+  spec.homepage = "https://github.com/paul/dry-transaction-extra"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/paul/dry-transaction-extra"
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "dry-monads", "~> 1.3"
+  spec.add_dependency "dry-transaction", "~> 0.15"
+
+  spec.add_development_dependency "dry-container", "~> 0.7"
+  spec.add_development_dependency "dry-schema", "~> 1.10"
+  spec.add_development_dependency "dry-validation", "~> 1.8"
+end

data/lib/dry/transaction/extra/class_callable.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Dry
+  module Transaction
+    module Extra
+      # Creates a class-level call method, which creates a new instance and
+      # invokes #call on it, delegating all arguments.
+      #
+      # These are equivalent:
+      #
+      #     MyTransaction.new.call(id: 1234)
+      #     MyTransaction.call(id: 1234)
+      #
+      # Note that if you need to pass arguments to the initializer, you can't
+      # use this, but if you don't, then this is a nice shortcut.
+      #
+      module ClassCallable
+        def call(...)
+          new.call(...)
+        end
+      end
+    end
+  end
+end

data/lib/dry/transaction/extra/steps/maybe.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Dry
+  module Transaction
+    module Extra
+      module Steps
+        module Maybe
+          module DSL
+            class NoValidatorError < ArgumentError
+              def initialize(txn)
+                super "The object provided to the step (#{txn}) does not implement a `validator` method."
+              end
+            end
+
+            # Just like the `use` step, this invokes another transaction.
+            # However, it first checks to see if the transaction implements a
+            # `validator` method (usually provided by the validation_dsl
+            # extension), and if so, will call it before invoking the
+            # transaction.
+            #
+            # If the validation succeeds, then it invokes the transaction as
+            # normal. If it fails, it continues on with the next step, passing
+            # the original input through.
+            #
+            # @example
+            #
+            # step :create_user
+            # maybe VerifyEmail
+            #
+            def maybe(txn_or_container, key = nil, as: nil)
+              if key
+                container = txn_or_container
+                method_name = as || "#{container.name}.#{key}".to_sym
+              else
+                txn = txn_or_container
+                method_name = as || txn.name.to_sym
+              end
+
+              merge(method_name, as:)
+              define_method method_name do |*args|
+                txn = container[key] if key
+                raise NoValidatorError, txn unless txn.respond_to? :validator
+
+                result = txn.validator.new.call(*args).to_monad
+                result.bind { txn.call(*args) }
+                      .or { Success(*args) }
+              end
+            rescue NoMethodError => e
+              raise e unless e.name == :name
+
+              raise ArgumentError, "unable to determine step name from #{key_or_container}.\
+                  Pass an explicit step name using `as:` keyword argument."
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dry/transaction/extra/steps/merge.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module Dry
+  module Transaction
+    module Extra
+      module Steps
+        # If you're using keyword args as the arguments to your steps, you
+        # often want a step to add its output to those args, while keeping the
+        # original kwargs intact.
+        #
+        #  * If the output of the step is a Hash, then that hash is merged into the input.
+        #  * If the output of the step is not a Hash, then a key is inferred
+        #    from the step name. The name of the key can be overridden with the
+        #    `as:` option.
+        #
+        # @option as [Symbol] When merging the output, use this as the key
+        #
+        # @example Merging Hash output
+        #
+        #   merge :add_context
+        #
+        #   # Input: { user: #<User id:42>, account: #<Account id:1> }
+        #   def add_context(user:, **)
+        #     {
+        #       email: user.email,
+        #       token: UserToken.lookup(user)
+        #     }
+        #   end
+        #   # Output: { user: #<User id:42>,
+        #               account: #<Account id:1>,
+        #               email: "paul@myapp.example",
+        #               token: "1234" }
+        #
+        # @example Merging non-Hash output, inferring the key from the step name
+        #
+        #   merge :user
+        #
+        #   # Input: { id: 42 }
+        #   def user(id:, **)
+        #     User.find(id)
+        #   end
+        #   # Output: { id: 42, user: #<User id:42> }
+        #
+        # @example Merging non-Hash output, specifying the key explicitly
+        #
+        #   merge :find_user, as: :current_user
+        #
+        #   # Input: { id: 42 }
+        #   def find_user(id:, **)
+        #     User.find(id)
+        #   end
+        #   # Output: { id: 42, current_user: #<User id:42> }
+        #
+        class Merge
+          include Dry::Monads[:result]
+
+          def call(operation, options, args)
+            if args.size > 1 || (!args[0].is_a?(Hash) && !args[0].nil?)
+              raise ArgumentError,
+                    "the merge step only works with keyword arguments"
+            end
+
+            result = operation.call(*args)
+            return result if result.is_a?(Failure)
+
+            value = result.is_a?(Success) ? result.value! : result
+            unless value.is_a?(Hash)
+              key = options[:as] || options[:step_name]
+              value = { key.to_sym => value }
+            end
+
+            Success((args[0] || {}).merge(value))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dry/transaction/extra/steps/tap.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Dry
+  module Transaction
+    module Extra
+      module Steps
+        # A step that mimics Ruby's builtin
+        # [Kernel#tap](https://ruby-doc.org/3.1.2/Kernel.html#method-i-tap)
+        # method. If the step succeeds, the step output is ignored and the
+        # original input is returned. However, if the step fails, then that
+        # Failure is returned instead.
+        #
+        # @example
+        #
+        #   tap :track_user
+        #   map :next_step
+        #
+        #   def track_user(user)
+        #     response = Tracker.track(user_id: user.email)
+        #     return Failure(response.body) if response.status >= 400
+        #   end
+        #
+        #   def next_step(user)
+        #     # Normally, the return value if the previous step would be passed
+        #     # as the input to this step. In this case, we don't care, we want
+        #     # to keep going with the original input `user`.
+        #   end
+        class Tap
+          include Dry::Monads[:result]
+
+          def call(operation, _options, args)
+            result = operation.call(*args)
+            return result if result.is_a?(Failure)
+
+            Success(*args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dry/transaction/extra/steps/use.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Dry
+  module Transaction
+    module Extra
+      module Steps
+        module Use
+          module DSL
+            # Invokes another transaction, or anything else #callable. Result
+            # is merged, according to the same rules as the +merge+ step.
+            #
+            # Alternatively accepts a Contaner, and a key registered within
+            # that container. This allows you to declare the transaction to be
+            # used at runtime, instead of file load time.
+            #
+            # Note that this is basically equivalent to injecting the step into
+            # the initializer, or passing in a container. However, using this
+            # method may result in more readable code, and less surprise. See
+            # README for a more detailed discussion.
+            #
+            # @param txn_or_container [#call, Dry::Container] A callable, or a Container
+            # @param key [Symbol] If provided a Container, use this key for lookup
+            #
+            # @option as [Symbol] When merging the output, use this as the key
+            #
+            # @example
+            #
+            # use FindUser.new
+            # use FindUser     # When using :class_callable extension
+            #
+            # @example Find transaction in Container
+            #
+            # use UserContainer, :find
+            #
+            # @example Merging output using specified key
+            #
+            # use FindUser, as: "user"
+            #
+            # # => { user: #<User: id=1> }
+            #
+            def use(txn_or_container, key = nil, as: nil)
+              if key
+                container = txn_or_container
+                method_name = as || "#{container.name}.#{key}".to_sym
+              else
+                txn = txn_or_container
+                method_name = as || txn.name.to_sym
+              end
+
+              merge(method_name, as:)
+              define_method method_name do |*args|
+                txn = container[key] if key
+                txn.call(*args)
+              end
+            rescue NoMethodError => e
+              raise e unless e.name == :name
+
+              raise ArgumentError, "unable to determine step name from #{key_or_container}.\
+                  Pass an explicit step name using `as:` keyword argument."
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dry/transaction/extra/steps/valid.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Dry
+  module Transaction
+    module Extra
+      module Steps
+        # Runs a dry-schema or dry-validation Contract, either passed to the
+        # step directly, or returned from the step method. It runs the
+        # validator on the input arguments, and returns Success on the
+        # validator output, or the Failure with errors returned from the
+        # validator.
+        #
+        # @example Validator defined in step implementation
+        #
+        # valid :validate_params
+        #
+        # def validate_params(params)
+        #   Dry::Schema.Params do
+        #     required(:name).filled(:string)
+        #     required(:email).filled(:string)
+        #   end
+        # end
+        #
+        # This is essentially equivalent to:
+        #
+        # step :validate_params
+        #
+        # def validate_params(params)
+        #   Dry::Schema.Params do
+        #     required(:name).filled(:string)
+        #     required(:email).filled(:string)
+        #   end.call(params).to_monad
+        # end
+        #
+        #
+        # @example Validator provided to the step
+        #
+        # valid ParamsValidator
+        #
+        class Valid
+          include Dry::Monads[:result]
+          def call(operation, _options, args)
+            if args.size > 1 || (!args[0].is_a?(Hash) && !args[0].nil?)
+              raise ArgumentError,
+                    "the valid step only works with hash/keyword arguments"
+            end
+
+            # The operation is a callable that returns a schema/contract, which
+            # itself needs to be called
+            result = operation.call.call(args[0])
+            if result.success?
+              Success(result.to_h)
+            else
+              Failure(result)
+            end
+          end
+
+          module DSL
+            def valid(validator, name: nil)
+              return super(validator) if validator.is_a?(Symbol)
+
+              method_name = (name || validator.inspect || "validate").to_sym
+              define_method method_name do |**|
+                validator
+              end
+
+              super(method_name)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dry/transaction/extra/validation_dsl.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module Dry
+  module Transaction
+    module Extra
+      module ValidationDSL
+        def self.extended(klass)
+          klass.extend Dry::Core::ClassAttributes
+          # The Dry::Validation Contract to run as the first step in the
+          # Transaction. This exposes it publicly, so you can run it outside
+          # the context of the Transction. This is useful if, for example, you
+          # want to run the transaction in a job, but want to check if the
+          # arguments are valid before enqueueing the job.
+          #
+          # @example
+          #
+          # class MyTransaction
+          #   validate do
+          #     params do
+          #       required(:name).filled(:string)
+          #     end
+          #   end
+          # end
+          #
+          # MyTransaction.validator.new.call(name: "Jane")
+          # # => #<Dry::Validation::Result{name: "Jane"} errors={}>
+          klass.defines :validator
+
+          require "dry/validation"
+          Dry::Validation.load_extensions(:monads)
+        end
+
+        # Allows you to declare a class-level validator, and run it as the
+        # first step of the Transaction.
+        #
+        # @example Define the validation inline
+        #
+        # class CreateUser
+        #   include Dry::Transaction
+        #   include Dry::Transaction::Extra
+        #   load_extensions :validation
+        #
+        #   validate do
+        #     params do
+        #       required(:name).filled(:string)
+        #       optional(:email).maybe(:string)
+        #     end
+        #   end
+        # end
+        #
+        # @example Reference a Validation defined elsewhere
+        #
+        # class NewUserContract < Dry::Validation::Contract
+        #   params do
+        #     required(:name).filled(:string)
+        #     optional(:email).maybe(:string)
+        #   end
+        # end
+        #
+        # class CreateUser
+        #   include Dry::Transaction
+        #   include Dry::Transaction::Extra
+        #   load_extensions :validation
+        #
+        #   validate NewUserContract
+        # end
+        #
+        def validate(contract = nil, &block)
+          validator(contract || Class.new(Dry::Validation::Contract, &block))
+
+          valid(validator.new, name: "validate")
+        end
+      end
+    end
+  end
+end

data/lib/dry/transaction/extra/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Dry
+  module Transaction
+    module Extra
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/dry/transaction/extra.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative "extra/version"
+
+require "dry/monads"
+require "dry/transaction"
+
+require_relative "extra/steps/tap"
+require_relative "extra/steps/maybe"
+require_relative "extra/steps/merge"
+require_relative "extra/steps/use"
+require_relative "extra/steps/valid"
+
+require_relative "extra/class_callable"
+require_relative "extra/validation_dsl"
+
+module Dry
+  module Transaction
+    module Extra
+      def self.included(klass)
+        klass.extend Extra::Steps::Maybe::DSL
+        klass.extend Extra::Steps::Use::DSL
+        klass.extend Extra::Steps::Valid::DSL
+
+        klass.extend Dry::Core::Extensions
+
+        klass.register_extension :validation do
+          klass.extend ValidationDSL
+        end
+
+        klass.register_extension :class_callable do
+          klass.extend ClassCallable
+        end
+      end
+
+      adapters = Dry::Transaction::StepAdapters
+      {
+        merge: Extra::Steps::Merge.new,
+        tap: Extra::Steps::Tap.new,
+        valid: Extra::Steps::Valid.new
+      }.each do |key, impl|
+        adapters.register(key, impl) unless adapters.key?(key)
+      end
+    end
+  end
+end

data/sig/dry/transaction/extra.rbs

@@ -0,0 +1,8 @@
+module Dry
+  module Transaction
+    module Extra
+      VERSION: String
+      # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+    end
+  end
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: dry-transaction-extra
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Paul Sadauskas
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-01-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-monads
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: dry-transaction
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: dry-container
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: dry-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: dry-validation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: Dry::Transaction comes with a limited set of steps. This   gem defines
+  a few more steps that are useful for getting the most out of Transactions.
+email:
+- psadauskas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- dry-transaction-extra.gemspec
+- lib/dry/transaction/extra.rb
+- lib/dry/transaction/extra/class_callable.rb
+- lib/dry/transaction/extra/steps/maybe.rb
+- lib/dry/transaction/extra/steps/merge.rb
+- lib/dry/transaction/extra/steps/tap.rb
+- lib/dry/transaction/extra/steps/use.rb
+- lib/dry/transaction/extra/steps/valid.rb
+- lib/dry/transaction/extra/validation_dsl.rb
+- lib/dry/transaction/extra/version.rb
+- sig/dry/transaction/extra.rbs
+homepage: https://github.com/paul/dry-transaction-extra
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/paul/dry-transaction-extra
+  source_code_uri: https://github.com/paul/dry-transaction-extra
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.1
+signing_key:
+specification_version: 4
+summary: Extra steps and functionality for Dry::Transaction
+test_files: []