dry-monads 1.3.0 → 1.3.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers 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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.4.0, available at [https://www.contributor-covenant.org/version/1/4/code-of-conduct](https://www.contributor-covenant.org/version/1/4/code-of-conduct)

data/CONTRIBUTING.md

@@ -6,11 +6,11 @@ If you found a bug, report an issue and describe what's the expected behavior ve
 
 ## Reporting feature requests
 
-Report a feature request **only after discourseing it first on [discourse.dry-rb.org](https://discourse.dry-rb.org)** where it was accepted. Please provide a concise description of the feature, don't link to a discourseion thread, and instead summarize what was discourseed.
+Report a feature request **only after discussing it first on [discourse.dry-rb.org](https://discourse.dry-rb.org)** where it was accepted. Please provide a concise description of the feature, don't link to a discussion thread, and instead summarize what was discussed.
 
 ## Reporting questions, support requests, ideas, concerns etc.
 
-**PLEASE DON'T** - use [discourse.dry-rb.org](https://discourse.dry-rb.org) instead.
+**PLEASE DON'T** - use [discourse.dry-rb.org](http://discourse.dry-rb.org) instead.
 
 # Pull Request Guidelines
 
@@ -22,8 +22,8 @@ Other requirements:
 2) Follow the style conventions of the surrounding code. In most cases, this is standard ruby style.
 3) Add API documentation if it's a new feature
 4) Update API documentation if it changes an existing feature
-5) Bonus points for sending a PR to [github.com/dry-rb/dry-rb.org](https://github.com/dry-rb/dry-rb.org) which updates user documentation and guides
+5) Bonus points for sending a PR to [github.com/dry-rb/dry-rb.org](github.com/dry-rb/dry-rb.org) which updates user documentation and guides
 
 # Asking for help
 
-If these guidelines aren't helpful, and you're stuck, please post a message on [discourse.dry-rb.org](https://discourse.dry-rb.org).
+If these guidelines aren't helpful, and you're stuck, please post a message on [discourse.dry-rb.org](https://discourse.dry-rb.org) or join [our chat](https://dry-rb.zulipchat.com).

data/Gemfile

@@ -1,20 +1,19 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
-gemspec
+eval_gemfile 'Gemfile.devtools'
 
-group :test do
-  gem 'codeclimate-test-reporter', require: false
-  gem 'simplecov', require: false
-  gem 'warning'
-end
+gemspec
 
 group :tools do
-  gem 'pry-byebug', platform: :mri
+  gem 'benchmark-ips'
   gem 'pry', platform: :jruby
+  gem 'pry-byebug', platform: :mri
 end
 
 group :docs do
+  gem 'redcarpet'
   gem 'yard'
   gem 'yard-junk'
-  gem 'redcarpet'
 end

data/Gemfile.devtools

@@ -0,0 +1,14 @@
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gem "ossy", github: "solnic/ossy", branch: "master", platforms: :ruby
+
+group :test do
+  gem 'codacy-coverage', require: false, platforms: :ruby
+  gem 'simplecov', require: false, platforms: :ruby
+  gem 'warning'
+end
+
+group :tools do
+  # this is the same version that we use on codacy
+  gem 'rubocop', '0.71.0'
+end

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-2020 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,50 +1,29 @@
-[gitter]: https://gitter.im/dry-rb/chat
 [gem]: https://rubygems.org/gems/dry-monads
-[travis]: https://travis-ci.com/dry-rb/dry-monads
-[code_climate]: https://codeclimate.com/github/dry-rb/dry-monads
-[inch]: http://inch-ci.org/github/dry-rb/dry-monads
+[actions]: https://github.com/dry-rb/dry-monads/actions
+[codacy]: https://www.codacy.com/gh/dry-rb/dry-monads
 [chat]: https://dry-rb.zulipchat.com
+[inchpages]: http://inch-ci.org/github/dry-rb/dry-monads
 
 # 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]
-[![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]
-
-Monads for Ruby.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'dry-monads'
-```
-
-And then execute:
-
-```sh
-$ bundle
-```
-
-Or install it yourself as:
-
-```sh
-$ gem install dry-monads
-```
+[![Gem Version](https://badge.fury.io/rb/dry-monads.svg)][gem]
+[![CI Status](https://github.com/dry-rb/dry-monads/workflows/ci/badge.svg)][actions]
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/f2eed41bf7f04b38b0a7691c2cf6e73c)][codacy]
+[![Codacy Badge](https://api.codacy.com/project/badge/Coverage/f2eed41bf7f04b38b0a7691c2cf6e73c)][codacy]
+[![Inline docs](http://inch-ci.org/github/dry-rb/dry-monads.svg?branch=master)][inchpages]
 
 ## Links
 
-- [Documentation](http://dry-rb.org/gems/dry-monads)
+* [User documentation](http://dry-rb.org/gems/dry-monads)
+* [API documentation](http://rubydoc.info/gems/dry-monads)
+
+## Supported Ruby versions
 
-## Development
+This library officially supports the following Ruby versions:
 
-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.
+* MRI >= `2.4`
+* jruby >= `9.2`
 
-## Contributing
+## License
 
-Bug reports and pull requests are welcome on GitHub at <https://github.com/dry-rb/dry-monads>.
+See `LICENSE` file.

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'dry/monads/all'

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)
+```