dry-monads 1.3.5 → 1.5.0

data/lib/dry/monads/try.rb

@@ -1,11 +1,5 @@
 # frozen_string_literal: true
 
-require 'dry/equalizer'
-require 'dry/core/deprecations'
-
-require 'dry/monads/right_biased'
-require 'dry/monads/conversion_stubs'
-
 module Dry
   module Monads
     # Represents a value which can be either success or a failure (an exception).
@@ -22,7 +16,7 @@ module Dry
       attr_reader :exception
 
       class << self
-        extend Core::Deprecations[:'dry-monads']
+        extend Core::Deprecations[:"dry-monads"]
 
         # Invokes a callable and if successful stores the result in the
         # {Try::Value} type, but if one of the specified exceptions was raised it stores
@@ -72,7 +66,7 @@ module Dry
         # @param exceptions [Array<Exception>]
         # @return [Try::Value,Try::Error]
         def [](*exceptions, &block)
-          raise ArgumentError, 'At least one exception type required' if exceptions.empty?
+          raise ArgumentError, "At least one exception type required" if exceptions.empty?
 
           run(exceptions, block)
         end
@@ -92,7 +86,7 @@ module Dry
 
       # Returns self.
       #
-      # @return [Maybe::Some, Maybe::None]
+      # @return [Try::Value, Try::Error]
       def to_monad
         self
       end
@@ -110,6 +104,8 @@ module Dry
         # @param exceptions [Array<Exception>] list of exceptions to be rescued
         # @param value [Object] the value to be stored in the monad
         def initialize(exceptions, value)
+          super()
+
           @catchable = exceptions
           @value = value
         end
@@ -133,7 +129,7 @@ module Dry
         #                             object and the rest of args will be passed
         #                             to this object along with the internal value
         # @return [Object, Try::Error]
-        def bind(*args)
+        def bind(...)
           super
         rescue *catchable => e
           Error.new(e)
@@ -151,8 +147,8 @@ module Dry
         # @param args [Array<Object>] extra arguments for the block, arguments are being processes
         #                             just as in #bind
         # @return [Try::Value, Try::Error]
-        def fmap(*args, &block)
-          Value.new(catchable, bind_call(*args, &block))
+        def fmap(...)
+          Value.new(catchable, bind_call(...))
         rescue *catchable => e
           Error.new(e)
         end
@@ -160,12 +156,21 @@ module Dry
         # @return [String]
         def to_s
           if Unit.equal?(@value)
-            'Try::Value()'
+            "Try::Value()"
           else
             "Try::Value(#{@value.inspect})"
           end
         end
         alias_method :inspect, :to_s
+
+        # Ignores values and returns self, see {Try::Error#recover}
+        #
+        # @param errors [Class] List of Exception subclasses
+        #
+        # @return [Try::Value]
+        def recover(*_errors)
+          self
+        end
       end
 
       # Represents a result of a failed execution.
@@ -175,10 +180,12 @@ module Dry
         include Dry::Equalizer(:exception)
         include RightBiased::Left
 
-        singleton_class.send(:alias_method, :call, :new)
+        singleton_class.alias_method(:call, :new)
 
         # @param exception [Exception]
         def initialize(exception)
+          super()
+
           @exception = exception
         end
 
@@ -211,6 +218,26 @@ module Dry
         def ===(other)
           Error === other && exception === other.exception
         end
+
+        # Acts in a similar way to `rescue`. It checks if
+        # {exception} is one of {errors} and yields the block if so.
+        #
+        # @param errors [Class] List of Exception subclasses
+        #
+        # @return [Try::Value]
+        def recover(*errors)
+          if errors.empty?
+            classes = DEFAULT_EXCEPTIONS
+          else
+            classes = errors
+          end
+
+          if classes.any? { _1 === exception }
+            Value.new([exception.class], yield(exception))
+          else
+            self
+          end
+        end
       end
 
       # A module that can be included for easier access to Try monads.
@@ -261,9 +288,9 @@ module Dry
         #
         def Value(value = Undefined, exceptions = DEFAULT_EXCEPTIONS, &block)
           v = Undefined.default(value, block)
-          raise ArgumentError, 'No value given' if !value.nil? && v.nil?
+          raise ArgumentError, "No value given" if !value.nil? && v.nil?
 
-          Value.new(exceptions, v)
+          Try::Value.new(exceptions, v)
         end
 
         # Error constructor
@@ -278,14 +305,14 @@ module Dry
         #
         def Error(error = Undefined, &block)
           v = Undefined.default(error, block)
-          raise ArgumentError, 'No value given' if v.nil?
+          raise ArgumentError, "No value given" if v.nil?
 
           Try::Error.new(v)
         end
       end
     end
 
-    require 'dry/monads/registry'
+    require "dry/monads/registry"
     register_mixin(:try, Try::Mixin)
   end
 end

data/lib/dry/monads/unit.rb

@@ -18,14 +18,20 @@ module Dry
     #   Maybe(Unit)
     #   => Some(Unit)
     #
-    Unit = Object.new.tap do |unit|
+    Unit = ::Object.new.tap do |unit|
       def unit.to_s
-        'Unit'
+        "Unit"
       end
 
       def unit.inspect
-        'Unit'
+        "Unit"
       end
+
+      def unit.deconstruct
+        EMPTY_ARRAY
+      end
+
+      unit.freeze
     end
   end
 end

data/lib/dry/monads/validated.rb

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-require 'dry/monads/conversion_stubs'
-require 'dry/monads/constants'
-require 'dry/monads/right_biased'
-
 module Dry
   module Monads
     # Validated is similar to Result and represents an outcome of a validation.
@@ -51,7 +47,8 @@ module Dry
       #
       def bind(*)
         # See https://typelevel.org/cats/datatypes/validated.html for details on why
-        raise NotImplementedError, 'Validated is not a monad because it would violate the monad laws'
+        raise NotImplementedError,
+              "Validated is not a monad because it would violate the monad laws"
       end
 
       # Valid result
@@ -60,6 +57,8 @@ module Dry
         include Dry::Equalizer(:value!)
 
         def initialize(value)
+          super()
+
           @value = value
         end
 
@@ -86,9 +85,8 @@ module Dry
         #   @yieldreturn [Validated::Valid,Validated::Invalid]
         #   @return [Validated::Valid,Validated::Invalid]
         #
-        # @return [Validated::Valid]
-        def apply(val = Undefined)
-          Undefined.default(val) { yield }.fmap(Curry.(value!))
+        def apply(val = Undefined, &block)
+          Undefined.default(val, &block).fmap(Curry.(value!))
         end
 
         # Lifts a block/proc over Valid
@@ -123,7 +121,7 @@ module Dry
         # @return [String]
         def inspect
           if Unit.equal?(@value)
-            'Valid()'
+            "Valid()"
           else
             "Valid(#{@value.inspect})"
           end
@@ -133,7 +131,7 @@ module Dry
         # @param other [Object]
         # @return [Boolean]
         def ===(other)
-          self.class == other.class && value! === other.value!
+          other.instance_of?(self.class) && value! === other.value!
         end
       end
 
@@ -154,6 +152,8 @@ module Dry
         include Dry::Equalizer(:error)
 
         def initialize(error, trace = RightBiased::Left.trace_caller)
+          super()
+
           @error = error
           @trace = trace
         end
@@ -168,10 +168,10 @@ module Dry
         #   @yieldreturn [Validated::Valid,Validated::Invalid]
         #   @return [Validated::Invalid]
         #
-        def apply(val = Undefined)
+        def apply(val = Undefined, &block)
           Undefined
-            .default(val) { yield }
-            .alt_map { |v| @error + v }
+            .default(val, &block)
+            .alt_map { @error + _1 }
             .fmap { return self }
         end
 
@@ -220,7 +220,7 @@ module Dry
         # @param other [Object]
         # @return [Boolean]
         def ===(other)
-          self.class == other.class && error === other.error
+          other.instance_of?(self.class) && error === other.error
         end
       end
 
@@ -250,7 +250,7 @@ module Dry
           #
           def Valid(value = Undefined, &block)
             v = Undefined.default(value, block)
-            raise ArgumentError, 'No value given' if !value.nil? && v.nil?
+            raise ArgumentError, "No value given" if !value.nil? && v.nil?
 
             Valid.new(v)
           end
@@ -267,7 +267,7 @@ module Dry
           #
           def Invalid(value = Undefined, &block)
             v = Undefined.default(value, block)
-            raise ArgumentError, 'No value given' if !value.nil? && v.nil?
+            raise ArgumentError, "No value given" if !value.nil? && v.nil?
 
             Invalid.new(v, RightBiased::Left.trace_caller)
           end
@@ -297,14 +297,14 @@ module Dry
       class Failure < Result
         # Transforms to Validated
         #
-        # @return [Validated::Valid]
+        # @return [Validated::Invalid]
         def to_validated
           Validated::Invalid.new(failure, trace)
         end
       end
     end
 
-    require 'dry/monads/registry'
+    require "dry/monads/registry"
     register_mixin(:validated, Validated::Mixin)
   end
 end

data/lib/dry/monads/version.rb

@@ -3,6 +3,6 @@
 module Dry
   module Monads
     # Gem version
-    VERSION = '1.3.5'
+    VERSION = "1.5.0"
   end
 end

data/lib/dry/monads.rb

@@ -1,13 +1,32 @@
 # frozen_string_literal: true
 
-require 'dry/core/constants'
-require 'dry/monads/registry'
+require "concurrent/map"
+require "zeitwerk"
+require "dry/core"
+require "dry/monads/constants"
+require "dry/monads/errors"
+require "dry/monads/registry"
 
 module Dry
   # Common, idiomatic monads for Ruby
   #
   # @api public
   module Monads
+    # @api private
+    def self.loader
+      @loader ||= Zeitwerk::Loader.new.tap do |loader|
+        root = File.expand_path("..", __dir__)
+        loader.tag = "dry-monads"
+        loader.inflector = Zeitwerk::GemInflector.new("#{root}/dry-monads.rb")
+        loader.push_dir(root)
+        loader.ignore(
+          "#{root}/dry-monads.rb",
+          "#{root}/dry/monads/{all,constants,errors,registry,version}.rb",
+          "#{root}/json/**/*.rb"
+        )
+      end
+    end
+
     # @private
     def self.included(base)
       if all_loaded?
@@ -49,10 +68,12 @@ module Dry
     def self.[](*monads)
       monads.sort!
       @mixins.fetch_or_store(monads.hash) do
-        monads.each { |m| load_monad(m) }
-        mixins = monads.map { |m| registry.fetch(m) }
+        monads.each { load_monad(_1) }
+        mixins = monads.map { registry.fetch(_1) }
         ::Module.new { include(*mixins) }.freeze
       end
     end
+
+    loader.setup
   end
 end

data/lib/dry-monads.rb

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

data/lib/json/add/dry/monads/maybe.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: false
 
-require 'json' unless defined?(::JSON::JSON_LOADED) && ::JSON::JSON_LOADED
+require "json" unless defined?(::JSON::JSON_LOADED) && ::JSON::JSON_LOADED
 
-require 'dry/monads'
+require "dry/monads"
 
 # Inspired by standard library implementation
 # for Time serialization/deserialization see (json/lib/json/add/time.rb)
@@ -12,7 +12,7 @@ module Dry
     class Maybe
       # Deserializes JSON string by using Dry::Monads::Maybe#lift method
       def self.json_create(serialized)
-        coerce(serialized.fetch('value'))
+        coerce(serialized.fetch("value"))
       end
 
       # Returns a hash, that will be turned into a JSON object and represent this
@@ -26,8 +26,8 @@ module Dry
 
       # Stores class name (Dry::Monads::Maybe::Some or Dry::Monads::Maybe::None)
       # with the monad value as JSON string
-      def to_json(*args)
-        as_json.to_json(*args)
+      def to_json(...)
+        as_json.to_json(...)
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dry-monads
 version: !ruby/object:Gem::Version
-  version: 1.3.5
+  version: 1.5.0
 platform: ruby
 authors:
 - Nikita Shilnikov
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2020-01-06 00:00:00.000000000 Z
+date: 2022-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -30,34 +30,34 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.4
+        version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.4
+        version: '0.9'
 - !ruby/object:Gem::Dependency
-  name: dry-equalizer
+  name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -78,14 +78,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: 0.1.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: 0.1.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -114,48 +114,16 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Common monads for Ruby.
+description: Common monads for Ruby
 email:
 - fg@flashgordon.ru
 executables: []
 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"
-- ".rubocop.yml"
-- ".yardopts"
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- CONTRIBUTING.md
-- Gemfile
-- Gemfile.devtools
 - LICENSE
 - README.md
-- Rakefile
-- bin/.gitkeep
-- 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
@@ -166,7 +134,6 @@ files:
 - lib/dry/monads/do.rb
 - lib/dry/monads/do/all.rb
 - lib/dry/monads/do/mixin.rb
-- lib/dry/monads/either.rb
 - lib/dry/monads/errors.rb
 - lib/dry/monads/lazy.rb
 - lib/dry/monads/list.rb
@@ -183,13 +150,14 @@ files:
 - lib/dry/monads/validated.rb
 - lib/dry/monads/version.rb
 - lib/json/add/dry/monads/maybe.rb
-- log/.gitkeep
-- project.yml
-homepage: https://github.com/dry-rb/dry-monads
+homepage: https://dry-rb.org/gems/dry-monads
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
+  changelog_uri: https://github.com/dry-rb/dry-monads/blob/main/CHANGELOG.md
+  source_code_uri: https://github.com/dry-rb/dry-monads
+  bug_tracker_uri: https://github.com/dry-rb/dry-monads/issues
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -198,15 +166,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
-summary: Common monads for Ruby.
+summary: Common monads for Ruby
 test_files: []

data/.codeclimate.yml

@@ -1,12 +0,0 @@
-# this file is managed by dry-rb/devtools project
-
-version: "2"
-
-exclude_patterns:
-  - "benchmarks/"
-  - "examples/"
-  - "spec/"
-
-plugins:
-  rubocop:
-    enabled: true

data/.github/ISSUE_TEMPLATE/----please-don-t-ask-for-support-via-issues.md

@@ -1,10 +0,0 @@
----
-name: "⚠️  Please don't ask for support via issues"
-about: See CONTRIBUTING.md for more information
-title: ''
-labels: ''
-assignees: ''
-
----
-
-

data/.github/ISSUE_TEMPLATE/---bug-report.md

@@ -1,30 +0,0 @@
----
-name: "\U0001F41B Bug report"
-about: See CONTRIBUTING.md for more information
-title: ''
-labels: bug
-assignees: ''
-
----
-
-**Before you submit this: WE ONLY ACCEPT BUG REPORTS AND FEATURE REQUESTS**
-
-For more information see `CONTRIBUTING.md`.
-
-**Describe the bug**
-
-A clear and concise description of what the bug is.
-
-**To Reproduce**
-
-Provide detailed steps to reproduce, an executable script would be best.
-
-**Expected behavior**
-
-A clear and concise description of what you expected to happen.
-
-**Your environment**
-
-- Affects my production application: **YES/NO**
-- Ruby version: ...
-- OS: ...

data/.github/ISSUE_TEMPLATE/---feature-request.md

@@ -1,18 +0,0 @@
----
-name: "\U0001F6E0 Feature request"
-about: See CONTRIBUTING.md for more information
-title: ''
-labels: feature
-assignees: ''
-
----
-
-Summary of what the feature is supposed to do.
-
-## Examples
-
-Code examples showing how the feature could be used.
-
-## Resources
-
-Additional information, like a link to the discussion forum thread where the feature was discussed etc.