dry-monads 1.3.5 → 1.4.0

data/.github/workflows/sync_configs.yml

@@ -1,56 +0,0 @@
-# this file is managed by dry-rb/devtools project
-
-name: sync_configs
-
-on:
-  repository_dispatch:
-
-jobs:
-  sync-configs:
-    runs-on: ubuntu-latest
-    if: github.event.action == 'sync_configs'
-    steps:
-      - uses: actions/checkout@v1
-      - name: Set up Ruby
-        uses: eregon/use-ruby-action@master
-        with:
-          ruby-version: 2.6
-      - name: Install latest bundler
-        run: |
-          gem install bundler
-          bundle config set without 'tools benchmarks docs'
-      - name: Install dependencies
-        run: bundle install --jobs 4 --retry 3 --without tools test benchmarks docs
-      - name: Symlink ossy
-        run: ln -sf "$(bundle info ossy --path)/bin/ossy" bin/ossy
-      - name: Clone devtools
-        run: git clone https://github.com/dry-rb/devtools.git tmp/devtools
-      - name: Compile file templates
-        env:
-          GITHUB_LOGIN: dry-bot
-          GITHUB_TOKEN: ${{ secrets.GH_PAT }}
-        run: |
-          if [ -f "project.yml" ]; then
-            for t in `ls tmp/devtools/templates`
-            do
-              bin/ossy t c tmp/devtools/templates/$t $(basename $t .erb) project.yml
-            done
-          fi
-      - name: Update configuration files from devtools
-        run: |
-          if [ -f ".github/workflows/custom_ci.yml" ]; then
-            rsync -arv --exclude '.github/workflows/ci.yml' tmp/devtools/shared/ . ;
-          else
-            rsync -arv tmp/devtools/shared/ . ;
-          fi
-      - name: Commit changes
-        run: |
-          rm bin/ossy
-          git config --local user.email "dry-bot@dry-rb.org"
-          git config --local user.name "dry-bot"
-          git add -A
-          git commit -m "[devtools] sync configs" || echo "nothing changed"
-      - name: Push changes
-        uses: ad-m/github-push-action@master
-        with:
-          github_token: ${{ secrets.GH_PAT }}

data/.gitignore

@@ -1,10 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-log/

data/.rspec

@@ -1,4 +0,0 @@
---color
---require spec_helper
---order random
---warnings

data/.rubocop.yml

@@ -1,101 +0,0 @@
-# this file is managed by dry-rb/devtools project
-
-AllCops:
-  TargetRubyVersion: 2.4
-
-Style/EachWithObject:
-  Enabled: false
-
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: single_quotes
-
-Style/ParallelAssignment:
-  Enabled: false
-
-Style/Alias:
-  Enabled: false
-
-Style/LambdaCall:
-  Enabled: false
-
-Style/StabbyLambdaParentheses:
-  Enabled: false
-
-Style/FormatString:
-  Enabled: false
-
-Style/Documentation:
-  Enabled: false
-
-Layout/SpaceInLambdaLiteral:
-  Enabled: false
-
-Layout/MultilineMethodCallIndentation:
-  Enabled: true
-  EnforcedStyle: indented
-
-Metrics/LineLength:
-  Max: 100
-
-Metrics/MethodLength:
-  Enabled: false
-
-Metrics/ClassLength:
-  Enabled: false
-
-Metrics/BlockLength:
-  Enabled: false
-
-Metrics/AbcSize:
-  Max: 20
-
-Metrics/CyclomaticComplexity:
-  Enabled: true
-  Max: 10
-
-Lint/BooleanSymbol:
-  Enabled: false
-
-Style/AccessModifierDeclarations:
-  Enabled: false
-
-Style/BlockDelimiters:
-  Enabled: false
-
-Layout/IndentFirstArrayElement:
-  EnforcedStyle: consistent
-
-Style/ClassAndModuleChildren:
-  Exclude:
-    - "spec/**/*_spec.rb"
-
-Lint/HandleExceptions:
-  Exclude:
-    - "spec/spec_helper.rb"
-
-Naming/PredicateName:
-  Enabled: false
-
-Naming/FileName:
-  Exclude:
-    - "lib/dry-*.rb"
-
-Style/SymbolArray:
-  Exclude:
-    - "spec/**/*_spec.rb"
-
-Style/ConditionalAssignment:
-  Enabled: false
-
-Naming/MethodName:
-  Enabled: false
-
-Style/AsciiComments:
-  Enabled: false
-
-Style/DateTime:
-  Enabled: false
-
-Style/IfUnlessModifier:
-  Enabled: false

data/.yardopts

@@ -1,4 +0,0 @@
---markup-provider=redcarpet
---markup=markdown
---plugin junk
-lib/**/*.rb

data/CODE_OF_CONDUCT.md

@@ -1,13 +0,0 @@
-# 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

@@ -1,29 +0,0 @@
-# Issue Guidelines
-
-## Reporting bugs
-
-If you found a bug, report an issue and describe what's the expected behavior versus what actually happens. If the bug causes a crash, attach a full backtrace. If possible, a reproduction script showing the problem is highly appreciated.
-
-## Reporting feature requests
-
-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](http://discourse.dry-rb.org) instead.
-
-# Pull Request Guidelines
-
-A Pull Request will only be accepted if it addresses a specific issue that was reported previously, or fixes typos, mistakes in documentation etc.
-
-Other requirements:
-
-1) Do not open a pull request if you can't provide tests along with it. If you have problems writing tests, ask for help in the related issue.
-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](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) or join [our chat](https://dry-rb.zulipchat.com).

data/Gemfile

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

data/Gemfile.devtools

@@ -1,14 +0,0 @@
-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/Rakefile

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-task default: :spec

data/bin/console

@@ -1,17 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'bundler/setup'
-require 'dry/monads/all'
-
-M = Dry::Monads
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-require 'pry'
-
-binding.pry
-
-p

data/bin/setup

@@ -1,7 +0,0 @@
-#!/bin/bash
-set -euo pipefail
-IFS=$'\n\t'
-
-bundle install
-
-# Do any other automated setup that you need to do here

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

@@ -1,42 +0,0 @@
----
-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

@@ -1,207 +0,0 @@
----
-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)
-```