dry-monads 1.3.1 → 1.3.2

data/docsite/source/validated.html.md

@@ -0,0 +1,88 @@
+---
+title: Validated
+layout: gem-single
+name: dry-monads
+---
+
+Suppose you've got a form to validate. If you are using `Result` combined with `Do` your code might look like this:
+
+```ruby
+require 'dry/monads'
+
+class CreateAccount
+  include Dry::Monads[:result, :do]
+
+  def call(form)
+    name = yield validate_name(form)
+    email = yield validate_email(form)
+    password = yield validate_password(form)
+
+    user = repo.create_user(
+      name: name,
+      email: email,
+      password: password
+    )
+
+    Success(user)
+  end
+
+  def validate_name(form)
+    # Success(name) or Failure(:invalid_name)
+  end
+
+  def validate_email(form)
+    # Success(email) or Failure(:invalid_email)
+  end
+
+  def validate_password(form)
+    # Success(password) or Failure(:invalid_password)
+  end
+end
+```
+
+If any of the validation steps fails the user will see an error. The problem is if `name` is not valid the user won't see errors about invalid `email` and `password`, if any. `Validated` circumvents this particular problem.
+
+`Validated` is actually not a monad but an applicative functor. This means you can't call `bind` on it. Instead, it can accumulate values in combination with `List`:
+
+```ruby
+require 'dry/monads'
+
+class CreateAccount
+  include Dry::Monads[:list, :result, :validated, :do]
+
+  def call(form)
+    name, email, password = yield List::Validated[
+      validate_name(form),
+      validate_email(form),
+      validate_password(form)
+    ].traverse.to_result
+
+    user = repo.create_user(
+      name: name,
+      email: email,
+      password: password
+    )
+
+    Success(user)
+  end
+
+  def validate_name(form)
+    # Valid(name) or Invalid(:invalid_name)
+  end
+
+  def validate_email(form)
+    # Valid(email) or Invalid(:invalid_email)
+  end
+
+  def validate_password(form)
+    # Valid(password) or Invalid(:invalid_password)
+  end
+end
+```
+
+Here all validations will be processed at once, if any of them fails the result will be converted to a `Failure` wrapping the `List` of errors:
+
+```ruby
+create_account.(form)
+# => Failure(List[:invalid_name, :invalid_email])
+```

data/lib/dry/monads.rb

@@ -1,3 +1,4 @@
+require 'dry/core/constants'
 require 'dry/monads/registry'
 
 module Dry

data/lib/dry/monads/{undefined.rb → constants.rb}

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 require 'dry/core/constants'
 
 module Dry
   module Monads
     # @private
-    Undefined = Dry::Core::Constants::Undefined
+    include Core::Constants
   end
 end

data/lib/dry/monads/do.rb

@@ -1,5 +1,6 @@
 require 'dry/monads/list'
 require 'dry/monads/do/mixin'
+require 'dry/monads/constants'
 
 module Dry
   module Monads
@@ -130,7 +131,7 @@ module Dry
 
         # @api private
         def halt(result)
-          raise Halt.new(result)
+          raise Halt.new(result), EMPTY_STRING, EMPTY_ARRAY
         end
       end
     end

data/lib/dry/monads/do/all.rb

@@ -56,7 +56,7 @@ module Dry
       #
       module All
         # @private
-        class MethodTracker < Module
+        class MethodTracker < ::Module
           attr_reader :wrappers
 
           def initialize(wrappers)
@@ -80,7 +80,7 @@ module Dry
 
               def included(base)
                 super
-                Dry::Monads::Do::All.included(base)
+                All.included(base)
               end
             end
           end

data/lib/dry/monads/do/mixin.rb

@@ -43,14 +43,13 @@ module Dry
         # @api public
         def bind(monads)
           monads = Do.coerce_to_monad(Array(monads))
-          unwrapped = monads.map { |result|
+          unwrapped = monads.map do |result|
             monad = result.to_monad
             monad.or { Do.halt(monad) }.value!
-          }
+          end
           monads.size == 1 ? unwrapped[0] : unwrapped
         end
       end
     end
   end
 end
-

data/lib/dry/monads/maybe.rb

@@ -1,11 +1,10 @@
 require 'dry/equalizer'
-require 'dry/core/constants'
 require 'dry/core/deprecations'
 
 require 'dry/monads/right_biased'
 require 'dry/monads/transformer'
 require 'dry/monads/unit'
-require 'dry/monads/undefined'
+require 'dry/monads/constants'
 
 module Dry
   module Monads
@@ -16,7 +15,7 @@ module Dry
       include Transformer
 
       class << self
-        extend Dry::Core::Deprecations[:'dry-monads']
+        extend Core::Deprecations[:'dry-monads']
 
         # Wraps the given value with into a Maybe object.
         #
@@ -139,7 +138,6 @@ module Dry
       # @api public
       class None < Maybe
         include RightBiased::Left
-        include Core::Constants
 
         @instance = new.freeze
         singleton_class.send(:attr_reader, :instance)

data/lib/dry/monads/result.rb

@@ -1,6 +1,6 @@
 require 'dry/equalizer'
 
-require 'dry/monads/undefined'
+require 'dry/monads/constants'
 require 'dry/monads/right_biased'
 require 'dry/monads/transformer'
 require 'dry/monads/conversion_stubs'

data/lib/dry/monads/right_biased.rb

@@ -1,5 +1,4 @@
-require 'dry/core/constants'
-
+require 'dry/monads/constants'
 require 'dry/monads/unit'
 require 'dry/monads/curry'
 require 'dry/monads/errors'
@@ -12,8 +11,6 @@ module Dry
       #
       # @api public
       module Right
-        include Dry::Core::Constants
-
         # @private
         def self.included(m)
           super
@@ -194,6 +191,7 @@ module Dry
         #   in Success(2..100) then ...
         #   in Success(2..200 => code) then ...
         #   end
+        #
         # @api private
         def deconstruct
           if Unit.equal?(@value)
@@ -205,11 +203,41 @@ module Dry
           end
         end
 
+        # Pattern matching hash values
+        #
+        # @example
+        #   case Success(x)
+        #   in Success(code: 200...300) then :ok
+        #   in Success(code: 300...400) then :redirect
+        #   in Success(code: 400...500) then :user_error
+        #   in Success(code: 500...600) then :server_error
+        #   end
+        #
+        # @api private
+        def deconstruct_keys(_)
+          if @value.is_a?(::Hash)
+            @value
+          else
+            EMPTY_HASH
+          end
+        end
+
         private
 
-        # @api private
-        def destructure(*args, **kwargs)
-          [args, kwargs]
+        if RUBY_VERSION >= '2.7'
+          # @api private
+          def destructure(value)
+            if value.is_a?(::Hash)
+              [EMPTY_ARRAY, value]
+            else
+              [[value], EMPTY_HASH]
+            end
+          end
+        else
+          # @api private
+          def destructure(*args, **kwargs)
+            [args, kwargs]
+          end
         end
 
         # @api private
@@ -343,6 +371,23 @@ module Dry
             [@value]
           end
         end
+
+        # Pattern matching hash values
+        #
+        # @example
+        #   case Failure(x)
+        #   in Failure(code: 400...500) then :user_error
+        #   in Failure(code: 500...600) then :server_error
+        #   end
+        #
+        # @api private
+        def deconstruct_keys(_)
+          if @value.is_a?(::Hash)
+            @value
+          else
+            EMPTY_HASH
+          end
+        end
       end
     end
   end

data/lib/dry/monads/validated.rb

@@ -1,5 +1,5 @@
 require 'dry/monads/conversion_stubs'
-require 'dry/monads/undefined'
+require 'dry/monads/constants'
 require 'dry/monads/right_biased'
 
 module Dry

data/lib/dry/monads/version.rb

@@ -1,6 +1,6 @@
 module Dry
   module Monads
     # Gem version
-    VERSION = '1.3.1'.freeze
+    VERSION = '1.3.2'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dry-monads
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.2
 platform: ruby
 authors:
 - Nikita Shilnikov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-07 00:00:00.000000000 Z
+date: 2019-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-equalizer
@@ -122,11 +122,18 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".codeclimate.yml"
+- ".github/ISSUE_TEMPLATE/----please-don-t-ask-for-support-via-issues.md"
+- ".github/ISSUE_TEMPLATE/---bug-report.md"
+- ".github/ISSUE_TEMPLATE/---feature-request.md"
+- ".github/workflows/ci.yml"
+- ".github/workflows/docsite.yml"
+- ".github/workflows/sync_configs.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- ".rubocop.yml"
 - ".yardopts"
 - CHANGELOG.md
+- CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE
@@ -134,10 +141,24 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- docsite/source/case-equality.html.md
+- docsite/source/do-notation.html.md
+- docsite/source/getting-started.html.md
+- docsite/source/index.html.md
+- docsite/source/list.html.md
+- docsite/source/maybe.html.md
+- docsite/source/pattern-matching.html.md
+- docsite/source/result.html.md
+- docsite/source/task.html.md
+- docsite/source/tracing-failures.html.md
+- docsite/source/try.html.md
+- docsite/source/unit.html.md
+- docsite/source/validated.html.md
 - dry-monads.gemspec
 - lib/dry-monads.rb
 - lib/dry/monads.rb
 - lib/dry/monads/all.rb
+- lib/dry/monads/constants.rb
 - lib/dry/monads/conversion_stubs.rb
 - lib/dry/monads/curry.rb
 - lib/dry/monads/do.rb
@@ -156,7 +177,6 @@ files:
 - lib/dry/monads/transformer.rb
 - lib/dry/monads/traverse.rb
 - lib/dry/monads/try.rb
-- lib/dry/monads/undefined.rb
 - lib/dry/monads/unit.rb
 - lib/dry/monads/validated.rb
 - lib/dry/monads/version.rb
@@ -182,7 +202,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Common monads for Ruby.

data/.travis.yml

@@ -1,38 +0,0 @@
-language: ruby
-dist: trusty
-cache: bundler
-bundler_args: --without benchmarks docs
-script:
-  - bundle exec rspec spec
-before_install:
-  - gem update --system
-  - gem install bundler
-after_success:
-  - "[ -d coverage ] && bundle exec codeclimate-test-reporter"
-rvm:
-  - 2.4.7
-  - 2.5.6
-  - 2.6.4
-  - ruby-head
-  - jruby-9.2.7.0
-env:
-  global:
-    - JRUBY_OPTS='--dev -J-Xmx1024M'
-    - COVERAGE=true
-matrix:
-  allow_failures:
-    - rvm: ruby-head
-
-notifications:
-  email:
-    recipients:
-      - fg@flashgordon.ru
-    on_success: change
-    on_failure: always
-    on_start: false # default: false
-  webhooks:
-    urls:
-      - https://webhooks.gitter.im/e/19098b4253a72c9796db
-    on_success: change # options: [always|never|change] default: always
-    on_failure: always # options: [always|never|change] default: always
-    on_start: false # default: false