dry-transaction 0.13.0 → 0.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 901e6ca3954acdc46da017a77ceb17014e0c5728d216fbf80b97995d9be03164
-  data.tar.gz: 501e37cccc173d5be0f654f5e4606c9d2db4e4737c0e004c569bab1bbadd04bd
+  metadata.gz: 6f40f750adc631d8bf596eaa4a2e1f57cdc0e5787104f23bab03888bff071aed
+  data.tar.gz: 1ae8d029a3f723e114cdf10b7e06b2f71ab899ff8c75b6bb48f5a42b259053b1
 SHA512:
-  metadata.gz: bcad8d5346e432e465310eeba9d79c32c2d2df024baf8d752ef5d2ad054685652f1851e3e55ec42d3937563dbaec2b93acd4f6a93e5e40d6cadee66332c6f80d
-  data.tar.gz: 6ff93e764b43ff80a578c2bb775a9a2d1db41a86b617ad2e62ffbcddef4bde69ba95bb8387824a2c96150d4729f0b7c80ab5464e87b4b29f2717ed05d383c246
+  metadata.gz: 591876e98732125f3f800958c3885f7458b9866e3346a5f322194bd0c3b697cd1ae42994614f9065f64dd5e2014a937195254863e2075ff538bc874176fd4f77
+  data.tar.gz: 287958b3d8ae478163ac45a4a6e17f4a7fa3d5e57fd778a710b5b5a1482b31e2c50690a43e63a843f4b56819bd693478ec40a05e3a1315c72ae03b095c860a79

data/CHANGELOG.md

@@ -0,0 +1,308 @@
+<!--- DO NOT EDIT THIS FILE - IT'S AUTOMATICALLY GENERATED VIA DEVTOOLS --->
+
+## 0.13.0 2018-06-13
+
+
+### Changed
+
+- Internal step operations (steps backed by instance methods) can now be replaced via constructor arguments. Using instance methods to wrap external step operations now only works if the step is defined using the `with:` option (timriley in [#109][pr109])
+
+[Compare v0.12.1...v0.13.0](https://github.com/dry-rb/dry-transaction/compare/v0.12.1...v0.13.0)
+
+## 0.12.1 2018-06-05
+
+
+### Fixed
+
+- Support result matching on step failures nested within around steps (flash-gordon in [#106][pr106])
+
+
+[Compare v0.12.0...v0.12.1](https://github.com/dry-rb/dry-transaction/compare/v0.12.0...v0.12.1)
+
+## 0.12.0 2018-05-16
+
+
+### Changed
+
+- Switch to `Dry::Monads::Result` API (away from `Either` API deprecated in dry-monads 1.0 betas) (Morozzzko in [#104][pr104])
+
+[Compare v0.11.2...v0.12.0](https://github.com/dry-rb/dry-transaction/compare/v0.11.2...v0.12.0)
+
+## 0.11.2 2018-05-15
+
+
+### Changed
+
+- Use `Dry::Monads::Result` instead of the deprecated `Dry::Monads::Either` in the `check` step adapter (PavelTkachenko in [#103][pr103])
+
+[Compare v0.11.1...v0.11.2](https://github.com/dry-rb/dry-transaction/compare/v0.11.1...v0.11.2)
+
+## 0.11.1 2018-03-15
+
+
+### Added
+
+- Include `operation_name:` in options passed to step adapters. This is helpful for 3rd party step adapters that need the operation's name to fetch it from the container again later. (timriley in [#94][pr94])
+
+
+[Compare v0.11.0...v0.11.1](https://github.com/dry-rb/dry-transaction/compare/v0.11.0...v0.11.1)
+
+## 0.11.0 2018-02-19
+
+
+### Added
+
+- Around steps, which allow control of the execution of subsequently called steps. If you know how middleware works in rack or how around callbacks can be used in RSpec, it's the same. A typical example of usage would be for DB transactions (now first class support!) or controlling side effects: rolling back the changes, cleaning garbage produced by a failed transaction, etc. See a more detailed explanation of how this works [in the PR][pr85] (flash-gordon in [#85][pr85])
+- Broadcast when a step has started by sending the event `step_called` (mihairadulescu in [#82][pr82])
+- Add new step `check` that returns `Success` or `Failure` base on conditions (semenovDL in [#84][pr84])
+- Support for transaction steps without input values (GustavoCaso and timriley in [#69][pr69])
+
+### Fixed
+
+- Pass arguments to a step with keyword arguments with default values (flash-gordon in [#74][pr74])
+- Steps can be wrapped with private methods (semenovDL in [#70][pr70])
+- Improved error message on missing transaction step (Morozzzko in [#79][pr79])
+
+### Changed
+
+- [BREAKING] Steps no longer broadcast events with their step name followed by `_success` or `_failure`. Now, more generic names are used for the broadcast events. Before each step runs, a `step` event is broadcast, with the step name and its arguments. After a step runs, a `step_succeeded` or `step_failed` event is broadcast, also with the step name, the arguments and the return value (GustavoCaso in [#83][pr83])
+- [BREAKING] Pub/sub support is now handled using [dry-events][dry-events] instead of wisper. Subscriber objects should now respond to `#on_step`, `#on_step_succeeded`, or `#on_step_failed` to receive broadcast events (GustavoCaso in [#90][pr90])
+- [BREAKING] The step adapter API has been changed in order to support around steps, although, the changes are not significant. Previously, an adapter received a `step` and a list of arguments for calling the operation. The list was passed as `*args` then you were needed to call `call_operation` on `step` and provide the list. From now on an adapter gets an `operation`, its `options`, and `args` (_without_ `*`). `operation` is an ordinary callable object so a typical call is as simple as `operation.(*args)`, that's it. If you want to turn your adapter into an around-like one you need to add `&block` parameter to the list of `call` arguments (e.g. `def call(operation, options, args, &block)`). `block` is responsible for calling the subsequent steps thus you can check or transform the return value and make some decisions based on it. Note capturing the block in the list of arguments is mandatory, a simple `yield` won't work, there are reasons, believe us. Check out the sources of [`around.rb`](https://github.com/dry-rb/dry-transaction/blob/master/lib/dry/transaction/step_adapters/around.rb) for reference, it's dead simple (flash-gordon in [#85][pr85])
+- Usages of the `Either` monad was updated with `Result` and its constructors. See [the changes](https://github.com/dry-rb/dry-monads/blob/master/CHANGELOG.md#v040-2017-11-11) in `dry-monads` for more details (flash-gordon in [#81][pr81])
+- Minimal Ruby version is 2.2 (flash-gordon in [#72][pr72])
+
+[Compare v0.10.2...v0.11.0](https://github.com/dry-rb/dry-transaction/compare/v0.10.2...v0.11.0)
+
+## 0.10.2 2017-07-10
+
+
+### Fixed
+
+- Only resolve an operation object from the container if the container reports that the key is present. This prevents exceptions from being raised when using dry-container and defining a transaction that includes steps both container-based and local method steps (jonolsson in [#64][pr64])
+
+
+[Compare v0.10.1...v0.10.2](https://github.com/dry-rb/dry-transaction/compare/v0.10.1...v0.10.2)
+
+## 0.10.1 2017-06-30
+
+
+### Fixed
+
+- Preserve step notification listeners when calling a transaction after passing extra step arguments (jcmfernandes in [#65](https://github.com/dry-rb/dry-transaction/pull/65))
+
+
+[Compare v0.10.0...v0.10.1](https://github.com/dry-rb/dry-transaction/compare/v0.10.0...v0.10.1)
+
+## 0.10.0 2017-06-15
+
+This release makes major changes to the dry-transaction API: transactions are now defined within your own class, support instance methods for defining or wrapping steps, and operation containers are now optional.
+
+### Added
+
+- Added `Dry::Transaction::Operation` convenience mixin. This gives easy access to `Right` and `Left` result builders within your operation objects, and also enables dry-matcher's block-based result matching API for when the operations are called individually. (timriley in [#58](https://github.com/dry-rb/dry-transaction/pull/58))
+
+    ```ruby
+    class MyOperation
+      include Dry::Transaction::Operation
+
+      def call(input)
+        Right(input)
+      end
+    end
+
+    my_op = MyOperation.new
+    my_op.("hello") do |m|
+      m.success do |v|
+        "Success: #{v}
+      end
+      m.failure do |v|
+        "Failure: #{v}"
+      end
+    end
+    # => "Success: hello"
+
+### Changed
+
+- [BREAKING] Transactions are now defined within your own classes using a mixin & class-level API for step definitions (GustavoCaso & timriley in [#58](https://github.com/dry-rb/dry-transaction/pull/58))
+
+    ```ruby
+    class CreateUser
+      include Dry::Transaction(container: Container)
+
+      step :process, with: "operations.process"
+      step :validate, with: "operations.validate"
+      step :persist, with: "operations.persist"
+    end
+
+    create_user = CreateUser.new
+    create_user.call("name" => "Jane Doe")
+    ```
+
+  Instance methods can wrap operations by calling `super`:
+
+    ```ruby
+    class CreateUser
+      include Dry::Transaction(container: Container)
+
+      step :process, with: "operations.process"
+      step :validate, with: "operations.validate"
+      step :persist, with: "operations.persist"
+
+      def process(input)
+        adjusted_input = do_something_with(input)
+        super(adjusted_input)
+      end
+    end
+    ```
+
+  Substitute operations can be injected when initializing objects (helpful for testing):
+
+    ```ruby
+    create_user = CreateUser.new(process: substitute_process_operation)
+    ```
+- Transactions can be defined without an operations container, using instance methods only.
+
+    ```ruby
+    class CreateUser
+      include Dry::Transaction
+
+      step :process
+      step :validate
+
+      def process(input)
+        input = do_something_with(input)
+        Right(input)
+      end
+
+      def validate(input)
+        if input[:email].include?("@")
+          Right(input)
+        else
+          Left(:not_valid)
+        end
+      end
+    end
+    ```
+- [BREAKING] You can no longer extend existing transactions with `#prepend`, `#append`, `#insert`, or `#remove`. Since transactions will now be instances of your own classes, with their own different behaviors, there’s no predictable way to combine the behaviors of two different classes. If you need the ability to add or remove steps, you can create separate transactions for the different behaviours you need to offer, or build into your own transaction class a way to skip steps based on input or step arguments.
+- [BREAKING] Blocks in step definitions are no longer accepted. If you want to wrap a step with some local behavior, wrap it with an instance method (see above).
+- [BREAKING] There is no longer an option for configuring the result matcher block API - we now use `Dry::Transaction::ResultMatcher` by default. If you want to provide your own matcher, you can do this by overriding `#call` in your transaction classes and using your own matcher when a block is given.
+
+[Compare v0.9.0...v0.10.0](https://github.com/dry-rb/dry-transaction/compare/v0.9.0...v0.10.0)
+
+## 0.9.0 2016-12-19
+
+
+### Added
+
+- Procs (or any callable objects) can be passed as a step's `with:` option instead of a container identifier string (AMHOL in [#44](https://github.com/dry-rb/dry-transaction/pull/44))
+
+    ```ruby
+    Dry.Transaction(container: MyContainer) do
+      step :some_step, with: "operations.some_thing"
+      step :another, with: -> input {
+        # your code here
+      }
+    end
+    ```
+- Support for passing blocks to step adapters (am-kantox in [#36](https://github.com/dry-rb/dry-transaction/pull/36))
+
+    ```ruby
+    Dry.Transaction(container: MyContainer) do
+      my_custom_step :some_step do
+        # this code is captured as a block and passed to the step adapter
+      end
+    end
+    ```
+
+### Changed
+
+- Whole step object is passed to `StepFailure` upon failure, which provides more information to custom matchers (mrbongiolo in [#35](https://github.com/dry-rb/dry-transaction/pull/35))
+- `#call` argument order for step operations is now `#call(input, *args)`, not `#call(*args, input)` (timriley in [#48](https://github.com/dry-rb/dry-transaction/pull/48))
+- `Dry::Transaction::Sequence` renamed to `Dry::Transaction` (timriley in [#49](https://github.com/dry-rb/dry-transaction/pull/49))
+
+[Compare v0.8.0...v0.9.0](https://github.com/dry-rb/dry-transaction/compare/v0.8.0...v0.9.0)
+
+## 0.8.0 2016-07-06
+
+
+### Added
+
+- Provide your own matcher object via a `matcher:` option passed to `Dry.Transaction` (timriley)
+
+### Changed
+
+- Match block API is now provided by `dry-matcher` gem (timriley)
+- Matching behaviour is clearer: match cases are run in order, the first match case “wins” and is executed, and all subsequent cases are ignored. This ensures a single, deterministic return value from the match block - the output of the single “winning” match case. (timriley)
+
+[Compare v0.7.0...v0.8.0](https://github.com/dry-rb/dry-transaction/compare/v0.7.0...v0.8.0)
+
+## 0.7.0 2016-06-06
+
+
+### Added
+
+- `try` steps support a `:raise` option, so a caught exception can be re-raised as a different (more domain-specific) exception (mrbongiolo)
+
+### Fixed
+
+- Add `#respond_to_missing?` to `StepFailure` wrapper class so it can more faithfully represent the failure object it wraps (flash-gordon)
+- Stop the DSL processing from conflicting with ActiveSupport's `Object#try` monkey-patch (joevandyk)
+
+### Changed
+
+- Use dry-monads (e.g. `Dry::Monads::Either::Right`) instead of kleisli (`Kleisli::Either::Right`) (flash-gordon)
+
+[Compare v0.6.0...v0.7.0](https://github.com/dry-rb/dry-transaction/compare/v0.6.0...v0.7.0)
+
+## 0.6.0 2016-04-06
+
+
+### Added
+
+- Allow custom step adapters to be supplied via a container of adapters being passed as a `step_adapters:` option to `Dry.Transaction` (timriley)
+- Raise a meaningful error if a `step` step returns a non-`Either` object (davidpelaez)
+- ## Internal
+- Change the step adapter API so more step-related information remains available at the time of the step being called (timriley)
+
+
+[Compare v0.5.0...v0.6.0](https://github.com/dry-rb/dry-transaction/compare/v0.5.0...v0.6.0)
+
+## 0.5.0 2016-03-16
+
+
+
+[Compare v0.4.0...v0.5.0](https://github.com/dry-rb/dry-transaction/compare/v0.4.0...v0.5.0)
+
+## 0.4.0 2015-12-26
+
+
+
+[Compare v0.3.2...v0.4.0](https://github.com/dry-rb/dry-transaction/compare/v0.3.2...v0.4.0)
+
+## 0.3.2 2015-11-13
+
+
+
+[Compare v0.3.1...v0.3.2](https://github.com/dry-rb/dry-transaction/compare/v0.3.1...v0.3.2)
+
+## 0.3.1 2015-11-12
+
+
+
+[Compare v0.3.0...v0.3.1](https://github.com/dry-rb/dry-transaction/compare/v0.3.0...v0.3.1)
+
+## 0.3.0 2015-11-11
+
+
+
+[Compare v0.2.0...v0.3.0](https://github.com/dry-rb/dry-transaction/compare/v0.2.0...v0.3.0)
+
+## 0.2.0 2015-11-02
+
+
+
+[Compare v0.1.0...v0.2.0](https://github.com/dry-rb/dry-transaction/compare/v0.1.0...v0.2.0)
+
+## 0.1.0 2015-10-28
+
+Initial release.

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2015-2021 dry-rb team
+
+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

@@ -1,55 +1,29 @@
-[gitter]: https://gitter.im/dry-rb/chat
-[gem]: https://img.shields.io/gem/v/dry-transaction.svg]
-[travis]: https://travis-ci.org/dry-rb/dry-transaction
-[codeclimate]: https://codeclimate.com/github/dry-rb/dry-transaction
-[coveralls]: https://coveralls.io/r/dry-rb/dry-transaction
+[gem]: https://rubygems.org/gems/dry-transaction
+[actions]: https://github.com/dry-rb/dry-transaction/actions
+[codacy]: https://www.codacy.com/gh/dry-rb/dry-transaction
+[chat]: https://dry-rb.zulipchat.com
 [inchpages]: http://inch-ci.org/github/dry-rb/dry-transaction
 
-# dry-transaction [![Join the chat at https://gitter.im/dry-rb/chat](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/dry-rb/chat)
+# dry-transaction [![Join the chat at https://dry-rb.zulipchat.com](https://img.shields.io/badge/dry--rb-join%20chat-%23346b7a.svg)][chat]
 
 [![Gem Version](https://badge.fury.io/rb/dry-transaction.svg)][gem]
-[![Build Status](https://travis-ci.org/dry-rb/dry-transaction.svg?branch=master)][travis]
-[![Code Climate](https://codeclimate.com/github/dry-rb/dry-transaction/badges/gpa.svg)][codeclimate]
-[![Test Coverage](https://codeclimate.com/github/dry-rb/dry-transaction/badges/coverage.svg)][codeclimate]
+[![CI Status](https://github.com/dry-rb/dry-transaction/workflows/ci/badge.svg)][actions]
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/f2c8f3f2e96a477faee00109cfb2090d)][codacy]
+[![Codacy Badge](https://api.codacy.com/project/badge/Coverage/f2c8f3f2e96a477faee00109cfb2090d)][codacy]
 [![Inline docs](http://inch-ci.org/github/dry-rb/dry-transaction.svg?branch=master)][inchpages]
 
-dry-transaction is a business transaction DSL. It provides a simple way to define a complex business transaction that includes processing by many different objects.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'dry-transaction'
-```
-
-And then execute:
-
-```sh
-$ bundle
-```
-
-Or install it yourself as:
-
-```sh
-$ gem install dry-transaction
-```
-
 ## Links
 
-* [Documentation](http://dry-rb.org/gems/dry-transaction)
-* [API documentation](http://www.rubydoc.info/github/dry-rb/dry-transaction)
-
-## Development
+* [User documentation](http://dry-rb.org/gems/dry-transaction)
+* [API documentation](http://rubydoc.info/gems/dry-transaction)
 
-After checking out the repo, run `bundle install` 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.
+## Supported Ruby versions
 
-## Contributing
+This library officially supports the following Ruby versions:
 
-Bug reports and pull requests are welcome on GitHub at <https://github.com/dry-rb/dry-transaction>.
+* MRI >= `2.5`
+* jruby >= `9.2`
 
 ## License
 
-Copyright © 2015-2016 [Icelab](http://icelab.com.au/). dry-transaction is free software, and may be redistributed under the terms specified in the [license](LICENSE.md).
+See `LICENSE` file.

data/dry-transaction.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+# this file is managed by dry-rb/devtools project
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dry/transaction/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'dry-transaction'
+  spec.authors       = ["Tim Riley"]
+  spec.email         = ["tim@icelab.com.au"]
+  spec.license       = 'MIT'
+  spec.version       = Dry::Transaction::VERSION.dup
+
+  spec.summary       = "Business Transaction Flow DSL"
+  spec.description   = spec.summary
+  spec.homepage      = 'https://dry-rb.org/gems/dry-transaction'
+  spec.files         = Dir["CHANGELOG.md", "LICENSE", "README.md", "dry-transaction.gemspec", "lib/**/*"]
+  spec.bindir        = 'bin'
+  spec.executables   = []
+  spec.require_paths = ['lib']
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  spec.metadata['changelog_uri']     = 'https://github.com/dry-rb/dry-transaction/blob/master/CHANGELOG.md'
+  spec.metadata['source_code_uri']   = 'https://github.com/dry-rb/dry-transaction'
+  spec.metadata['bug_tracker_uri']   = 'https://github.com/dry-rb/dry-transaction/issues'
+
+  spec.required_ruby_version = ">= 2.5.0"
+
+  # to update dependencies edit project.yml
+  spec.add_runtime_dependency "dry-container", ">= 0.2.8"
+  spec.add_runtime_dependency "dry-events", ">= 0.1.0"
+  spec.add_runtime_dependency "dry-matcher", ">= 0.7.0"
+  spec.add_runtime_dependency "dry-monads", ">= 0.4.0"
+end

data/lib/dry-transaction.rb

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