dry-monads 1.3.1 → 1.3.2

data/LICENSE

@@ -1,20 +1,20 @@
-Copyright (c) 2016-2018 Nikita Shilnikov
+The MIT License (MIT)
 
-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:
+Copyright (c) 2015-2019 dry-rb team
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+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 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.
+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,6 +1,6 @@
 [gitter]: https://gitter.im/dry-rb/chat
 [gem]: https://rubygems.org/gems/dry-monads
-[travis]: https://travis-ci.com/dry-rb/dry-monads
+[ci]: https://github.com/dry-rb/dry-monads/actions?query=workflow%3Aci
 [code_climate]: https://codeclimate.com/github/dry-rb/dry-monads
 [inch]: http://inch-ci.org/github/dry-rb/dry-monads
 [chat]: https://dry-rb.zulipchat.com
@@ -8,7 +8,7 @@
 # dry-monads [![Join the chat at https://dry-rb.zulipchat.com](https://img.shields.io/badge/dry--rb-join%20chat-%23346b7a.svg)][chat]
 
 [![Gem Version](https://img.shields.io/gem/v/dry-monads.svg)][gem]
-[![Build Status](https://img.shields.io/travis/dry-rb/dry-monads.svg)][travis]
+[![Build Status](https://github.com/dry-rb/dry-monads/workflows/ci/badge.svg)][ci]
 [![Code Climate](https://api.codeclimate.com/v1/badges/b0ea4d8023d53b7f0f50/maintainability)][code_climate]
 [![Test Coverage](https://api.codeclimate.com/v1/badges/b0ea4d8023d53b7f0f50/test_coverage)][code_climate]
 [![API Documentation Coverage](http://inch-ci.org/github/dry-rb/dry-monads.svg)][inch]

data/docsite/source/case-equality.html.md

@@ -0,0 +1,42 @@
+---
+title: Case equality
+layout: gem-single
+name: dry-monads
+---
+
+### Case equality
+
+Monads allow to use default ruby `case` operator for matching result:
+
+```ruby
+case value
+when Some(1), Some(2) then :one_or_two
+when Some(3..5) then :three_to_five
+else
+  :something_else
+end
+```
+
+You can use specific `Failure` options too:
+
+```ruby
+case value
+when Success then [:ok, value.value!]
+when Failure(TimeoutError) then [:timeout]
+when Failure(ConnectionClosed) then [:net_error]
+when Failure then [:generic_error]
+else
+  raise "Unhandled case"
+end
+```
+
+#### Nested structures
+
+```ruby
+case value
+when Success(None()) then :nothing
+when Success(Some { |x| x > 10 }) then :something
+when Success(Some) then :something_else
+when Failure then :error
+end
+```

data/docsite/source/do-notation.html.md

@@ -0,0 +1,207 @@
+---
+title: Do notation
+layout: gem-single
+name: dry-monads
+---
+
+Composing several monadic values can become tedious because you need to pass around unwrapped values in lambdas (aka blocks). Haskell was one of the first languages faced this problem. To work around it Haskell has a special syntax for combining monadic operations called the "do notation". If you're familiar with Scala it has `for`-comprehensions for a similar purpose. It is not possible to implement `do` in Ruby but it is possible to emulate it to some extent, i.e. achieve comparable usefulness.
+
+What `Do` does is passing an unwrapping block to certain methods. The block tries to extract the underlying value from a monadic object and either short-circuits the execution (in case of a failure) or returns the unwrapped value back.
+
+See the following example written using `bind` and `fmap`:
+
+```ruby
+require 'dry/monads'
+
+class CreateAccount
+  include Dry::Monads[:result]
+
+  def call(params)
+    validate(params).bind { |values|
+      create_account(values[:account]).bind { |account|
+        create_owner(account, values[:owner]).fmap { |owner|
+          [account, owner]
+        }
+      }
+    }
+  end
+
+  def validate(params)
+    # returns Success(values) or Failure(:invalid_data)
+  end
+
+  def create_account(account_values)
+    # returns Success(account) or Failure(:account_not_created)
+  end
+
+  def create_owner(account, owner_values)
+    # returns Success(owner) or Failure(:owner_not_created)
+  end
+end
+```
+
+The more monadic steps you need to combine the harder it becomes, not to mention how difficult it can be to refactor code written in such way.
+
+Embrace `Do`:
+
+```ruby
+require 'dry/monads'
+require 'dry/monads/do'
+
+class CreateAccount
+  include Dry::Monads[:result]
+  include Dry::Monads::Do.for(:call)
+
+  def call(params)
+    values = yield validate(params)
+    account = yield create_account(values[:account])
+    owner = yield create_owner(account, values[:owner])
+
+    Success([account, owner])
+  end
+
+  def validate(params)
+    # returns Success(values) or Failure(:invalid_data)
+  end
+
+  def create_account(account_values)
+    # returns Success(account) or Failure(:account_not_created)
+  end
+
+  def create_owner(account, owner_values)
+    # returns Success(owner) or Failure(:owner_not_created)
+  end
+end
+```
+
+Both snippets do the same thing yet the second one is a lot easier to deal with. All what `Do` does here is prepending `CreateAccount` with a module which passes a block to `CreateAccount#call`. That simple.
+
+### Transaction safety
+
+Under the hood, `Do` uses exceptions to halt unsuccessful operations, this can be slower if you are dealing with unsuccessful paths a lot, but usually, this is not an issue. Check out [this article](https://www.morozov.is/2018/05/27/do-notation-ruby.html) for actual benchmarks.
+
+One particular reason to use exceptions is the ability to make code transaction-friendly. In the example above, this piece of code is not atomic:
+
+```ruby
+account = yield create_account(values[:account])
+owner = yield create_owner(account, values[:owner])
+
+Success[account, owner]
+```
+
+What if `create_account` succeeds and `create_owner` fails? This will leave your database in an inconsistent state. Let's wrap it with a transaction block:
+
+```ruby
+repo.transaction do
+  account = yield create_account(values[:account])
+  owner = yield create_owner(account, values[:owner])
+
+  Success[account, owner]
+end
+```
+
+Since `yield` internally uses exceptions to control the flow, the exception will be detected by the `transaction` call and the whole operation will be rolled back. No more garbage in your database, yay!
+
+### Limitations
+
+`Do` only works with single-value monads, i.e. most of them. At the moment, there is no way to make it work with `List`, though.
+
+### Adding batteries
+
+The `Do::All` module takes one step ahead, it tracks all new methods defined in the class and passes a block to every one of them. However, if you pass a block yourself then it takes precedence. This way, in most cases you can use `Do::All` instead of listing methods with `Do.for(...)`:
+
+```ruby
+require 'dry/monads'
+
+class CreateAccount
+  # This will include Do::All by default
+  include Dry::Monads[:result, :do]
+
+  def call(account_params, owner_params)
+    repo.transaction do
+      account = yield create_account(account_params)
+      owner = yield create_owner(account, owner_params)
+
+      Success[account, owner]
+    end
+  end
+
+  def create_account(params)
+    values = yield validate_account(params)
+    account = repo.create_account(values)
+
+    Success(account)
+  end
+
+  def create_owner(account, params)
+    values = yield validate_owner(params)
+    owner = repo.create_owner(account, values)
+
+    Success(owner)
+  end
+
+  def validate_account(params)
+    # returns Success/Failure
+  end
+
+  def validate_owner(params)
+    # returns Success/Failure
+  end
+end
+```
+
+### Using `Do` methods in other contexts
+
+You can use methods from the `Do` module directly (starting with 1.3):
+
+```ruby
+require 'dry/monads/do'
+require 'dry/monads/result'
+
+# some random place in your code
+Dry::Monads.Do.() do
+  user = Dry::Monads::Do.bind create_user
+  account = Dry::Monads::Do.bind create_account(user)
+
+  Dry::Monads::Success[user, account]
+end
+```
+
+Or you can use `extend`:
+
+```ruby
+require 'dry/monads'
+
+class VeryComplexAndUglyCode
+  extend Dry::Monads::Do::Mixin
+  extend Dry::Monads[:result]
+
+  def self.create_something(result_value)
+    call do
+      extracted = bind result_value
+      processed = bind process(extracted)
+
+      Success(processed)
+    end
+  end
+end
+```
+
+`Do::All` also works with class methods:
+
+```ruby
+require 'dry/monads'
+
+class SomeClassLevelLogic
+  extend Dry::Monads[:result, :do]
+
+  def self.call
+    x = yield Success(5)
+    y = yield Success(20)
+
+    Success(x * y)
+  end
+end
+
+SomeClassLevelLogic.() # => Success(100)
+```

data/docsite/source/getting-started.html.md

@@ -0,0 +1,142 @@
+---
+title: Getting started
+layout: gem-single
+name: dry-monads
+---
+
+### Installation
+
+Add this line to your Gemfile
+
+```ruby
+gem 'dry-monads'
+```
+
+Then run
+
+```
+$ bundle
+```
+
+### Usage
+
+Every monad has corresponding value constructors. For example, the `Maybe` monad has two of them: `Some(...)` and `None()`. It also has the `Maybe(...)` method. All three methods start with a capital letter similarly to built-in Ruby methods like `Kernel#Array(...)` and `Kernel#Hash(...)`. Value constructors are not available globally, you need to add them with a mixin.
+
+To add the `Maybe` constructors add `Dry::Monads[:maybe]` to your class:
+
+```ruby
+require 'dry/monads'
+
+class CreateUser
+  # this line loads the Maybe monad and adds
+  # Some(...), None(), and Maybe(...) to CreateUser
+  include Dry::Monads[:maybe]
+
+  def call(params)
+    # ...
+    if valid?(params)
+      None()
+    else
+      Some(create_user(params))
+    end
+  end
+end
+```
+
+Example in the docs may use `extend Dry::Monads[...]` for brevity but you normally want to use `include` in production code.
+
+### Including multiple monads
+
+```ruby
+require 'dry/monads'
+
+class CreateUser
+  # Adds Maybe and Result. The order doesn't matter
+  include Dry::Monads[:maybe, :result]
+end
+```
+
+### Using with do notation
+
+A very common case is using the [Result](docs::result) monad with [do notation](docs::do-notation):
+
+```ruby
+require 'dry/monads'
+
+class ResultCalculator
+  include Dry::Monads[:result, :do]
+
+  def calculate(input)
+    value = Integer(input)
+
+    value = yield add_3(value)
+    value = yield mult_2(value)
+
+    Success(value)
+  end
+
+  def add_3(value)
+    if value > 1
+      Success(value + 3)
+    else
+      Failure("value was less than 1")
+    end
+  end
+
+  def mult_2(value)
+    if value % 2 == 0
+      Success(value * 2)
+    else
+      Failure("value was not even")
+    end
+  end
+end
+
+
+c = ResultCalculator.new
+c.calculate(3) # => Success(12)
+c.calculate(0) # => Failure("value was less than 1")
+c.calculate(2) # => Failure("value was not even")
+```
+
+### Constructing array values
+
+Some constructors have shortcuts for wrapping arrays:
+
+```ruby
+require 'dry/monads'
+
+class CreateUser
+  include Dry::Monads[:result]
+
+  def call(params)
+    # ...
+    # Same as Failure([:user_exists, params: params])
+    Failure[:user_exists, params: params]
+  end
+end
+```
+
+### Interaction between monads and constructors availability
+
+Some values can be converted to others or they can have methods that use other monads. By default, dry-monads doesn't load all monads so you may have troubles like this:
+
+```ruby
+extend Dry::Monads[:result]
+
+Success(:foo).to_maybe # RuntimeError: Load Maybe first with require 'dry/monads/maybe'
+```
+
+To work around you may either load `dry/monads/maybe` add `maybe` to the mixin:
+
+```ruby
+extend Dry::Monads[:result, :maybe]
+
+Success(:foo).to_maybe # => Some(:foo)
+```
+
+For the same reason `Dry::Monads.Some(...)`, `Dry::Monads.Success(...)`, and some other constructors are not available until you explicitly load the monads with `require 'dry/monads/%{monad_name}'`.
+
+### Loading everything
+
+Just `require 'dry/monads/all'`