dry-monads 1.3.5 → 1.4.0

data/lib/dry/monads/result/fixed.rb

@@ -1,37 +1,46 @@
 # frozen_string_literal: true
 
-module Dry::Monads
-  class Result
-    # @see Monads#Result
-    # @private
-    class Fixed < Module
-      def self.[](error, **options)
-        new(error, **options)
-      end
+require "dry/monads/constants"
+
+module Dry
+  module Monads
+    class Result
+      # @see Monads#Result
+      # @private
+      class Fixed < ::Module
+        def self.[](error, **options)
+          new(error, **options)
+        end
+
+        def initialize(error, **_options)
+          super()
 
-      def initialize(error, **_options)
-        @mod = Module.new do
-          define_method(:Failure) do |value|
-            if error === value
-              Failure.new(value, RightBiased::Left.trace_caller)
-            else
-              raise InvalidFailureTypeError, value
+          @mod = ::Module.new do
+            define_method(:Failure) do |value|
+              if error === value
+                Failure.new(value, RightBiased::Left.trace_caller)
+              else
+                # rubocop:disable Style/RaiseArgs
+                # per https://github.com/dry-rb/dry-monads/pull/142
+                raise InvalidFailureTypeError.new(value)
+                # rubocop:enable Style/RaiseArgs
+              end
             end
-          end
 
-          def Success(value = Undefined, &block)
-            v = Undefined.default(value, block || Unit)
-            Success.new(v)
+            def Success(value = Undefined, &block)
+              v = Undefined.default(value, block || Unit)
+              Success.new(v)
+            end
           end
         end
-      end
 
-      private
+        private
 
-      def included(base)
-        super
+        def included(base)
+          super
 
-        base.include(@mod)
+          base.include(@mod)
+        end
       end
     end
   end

data/lib/dry/monads/right_biased.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require 'dry/monads/constants'
-require 'dry/monads/unit'
-require 'dry/monads/curry'
-require 'dry/monads/errors'
+require "dry/monads/constants"
+require "dry/monads/unit"
+require "dry/monads/curry"
+require "dry/monads/errors"
 
 module Dry
   module Monads
@@ -12,7 +12,7 @@ module Dry
       # Right part
       #
       # @api public
-      module Right
+      module Right # rubocop:disable Metrics/ModuleLength
         # @private
         def self.included(m)
           super
@@ -90,6 +90,16 @@ module Dry
           self
         end
 
+        # Ignores arguments and returns self. It exists to keep the interface
+        # identical to that of {RightBiased::Left}.
+        #
+        # @param _alt [RightBiased::Right, RightBiased::Left]
+        #
+        # @return [RightBiased::Right]
+        def |(_alt)
+          self
+        end
+
         # A lifted version of `#or`. For {RightBiased::Right} acts in the same way as `#or`,
         # that is returns itselt.
         #
@@ -118,18 +128,18 @@ module Dry
         #   create_user.apply(name) # => Failure(:name_missing)
         #
         # @return [RightBiased::Left,RightBiased::Right]
-        def apply(val = Undefined)
+        def apply(val = Undefined, &block)
           unless @value.respond_to?(:call)
             raise TypeError, "Cannot apply #{val.inspect} to #{@value.inspect}"
           end
 
-          Undefined.default(val) { yield }.fmap { |unwrapped| curry.(unwrapped) }
+          Undefined.default(val, &block).fmap { |unwrapped| curry.(unwrapped) }
         end
 
         # @param other [Object]
         # @return [Boolean]
         def ===(other)
-          self.class == other.class && value! === other.value!
+          other.instance_of?(self.class) && value! === other.value!
         end
 
         # Maps the value to Dry::Monads::Unit, useful when you don't care
@@ -197,11 +207,11 @@ module Dry
         # @api private
         def deconstruct
           if Unit.equal?(@value)
-            []
-          elsif @value.is_a?(::Array)
-            @value
-          else
+            EMPTY_ARRAY
+          elsif !@value.is_a?(::Array)
             [@value]
+          else
+            @value
           end
         end
 
@@ -226,7 +236,7 @@ module Dry
 
         private
 
-        if RUBY_VERSION >= '2.7'
+        if RUBY_VERSION >= "2.7"
           # @api private
           def destructure(value)
             if value.is_a?(::Hash)
@@ -255,7 +265,7 @@ module Dry
         # @private
         # @return [String] Caller location
         def self.trace_caller
-          caller_locations(2, 2)[0].to_s
+          caller_locations(2, 1)[0].to_s
         end
 
         # Raises an error on accessing internal value
@@ -299,11 +309,20 @@ module Dry
           raise NotImplementedError
         end
 
+        # Returns the passed value. Works in pair with {RightBiased::Right#|}.
+        #
+        # @param alt [RightBiased::Right, RightBiased::Left]
+        #
+        # @return [RightBiased::Right, RightBiased::Left]
+        def |(alt)
+          self.or(alt)
+        end
+
         # A lifted version of `#or`. This is basically `#or` + `#fmap`.
         #
         # @example
-        #   Dry::Monads.None.or('no value') # => Some("no value")
-        #   Dry::Monads.None.or { Time.now } # => Some(current time)
+        #   Dry::Monads.None.or_fmap('no value') # => Some("no value")
+        #   Dry::Monads.None.or_fmap { Time.now } # => Some(current time)
         #
         # @return [RightBiased::Left, RightBiased::Right]
         def or_fmap(*)

data/lib/dry/monads/task.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require 'concurrent/promise'
+require "concurrent/promise"
 
-require 'dry/monads/unit'
-require 'dry/monads/curry'
-require 'dry/monads/conversion_stubs'
+require "dry/monads/unit"
+require "dry/monads/curry"
+require "dry/monads/conversion_stubs"
 
 module Dry
   module Monads
@@ -48,9 +48,11 @@ module Dry
         # @example using a predefined executor
         #    Task[:fast] { do_quick_task }
         #
-        # @param executor [Concurrent::AbstractExecutorService,Symbol] Either an executor instance
-        #                                                              or a name of predefined global
-        #                                                              from concurrent-ruby
+        # @param executor [Concurrent::AbstractExecutorService,Symbol]
+        #   Either an executor instance
+        #   or a name of predefined global
+        #   from concurrent-ruby
+        #
         # @return [Task]
         def [](executor, &block)
           new(Promise.execute(executor: executor, &block))
@@ -131,14 +133,14 @@ module Dry
         state = case promise.state
                 when :fulfilled
                   if Unit.equal?(value!)
-                    'value=()'
+                    "value=()"
                   else
                     "value=#{value!.inspect}"
                   end
                 when :rejected
                   "error=#{promise.reason.inspect}"
                 else
-                  '?'
+                  "?"
                 end
 
         "Task(#{state})"
@@ -164,14 +166,12 @@ module Dry
         )
 
         promise.on_error do |v|
-          begin
-            inner = block.(v).promise
-            inner.execute
-            inner.on_success { |r| child.on_fulfill(r) }
-            inner.on_error { |e| child.on_reject(e) }
-          rescue StandardError => e
-            child.on_reject(e)
-          end
+          inner = block.(v).promise
+          inner.execute
+          inner.on_success { |r| child.on_fulfill(r) }
+          inner.on_error { |e| child.on_reject(e) }
+        rescue StandardError => e
+          child.on_reject(e)
         end
         promise.on_success { |v| child.on_fulfill(v) }
 
@@ -236,8 +236,8 @@ module Dry
       #
       # @param val [Task]
       # @return [Task]
-      def apply(val = Undefined)
-        arg = Undefined.default(val) { yield }
+      def apply(val = Undefined, &block)
+        arg = Undefined.default(val, &block)
         bind { |f| arg.fmap { |v| curry(f).(v) } }
       end
 
@@ -314,7 +314,7 @@ module Dry
       end
     end
 
-    require 'dry/monads/registry'
+    require "dry/monads/registry"
     register_mixin(:task, Task::Mixin)
   end
 end

data/lib/dry/monads/transformer.rb

@@ -27,7 +27,8 @@ module Dry
       # Lifts a block/proc over the 3-level nested structure.
       #
       # @example
-      #   List[Right(Some(1)), Left(Some(1))].fmap3 { |x| x + 1 } # => List[Right(Some(2)), Left(Some(1))]
+      #   List[Right(Some(1)), Left(Some(1))].fmap3 { |x| x + 1 }
+      #   # => List[Right(Some(2)), Left(Some(1))]
       #   Right(None).fmap3 { |x| x + 1 } # => Right(None)
       #
       # @param args [Array<Object>] arguments will be passed to the block or the proc

data/lib/dry/monads/traverse.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
-require 'dry/monads/validated'
+# rubocop:disable Naming/ConstantName
+# rubocop:disable Style/MutableConstant
+
+require "dry/monads/validated"
 
 module Dry
   module Monads
@@ -20,3 +23,6 @@ module Dry
     Traverse.freeze
   end
 end
+
+# rubocop:enable Style/MutableConstant
+# rubocop:enable Naming/ConstantName

data/lib/dry/monads/try.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require 'dry/equalizer'
-require 'dry/core/deprecations'
+require "dry/core/equalizer"
+require "dry/core/deprecations"
 
-require 'dry/monads/right_biased'
-require 'dry/monads/conversion_stubs'
+require "dry/monads/right_biased"
+require "dry/monads/conversion_stubs"
 
 module Dry
   module Monads
@@ -22,7 +22,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 +72,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 +92,7 @@ module Dry
 
       # Returns self.
       #
-      # @return [Maybe::Some, Maybe::None]
+      # @return [Try::Value, Try::Error]
       def to_monad
         self
       end
@@ -110,6 +110,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
@@ -160,12 +162,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.
@@ -179,6 +190,8 @@ module Dry
 
         # @param exception [Exception]
         def initialize(exception)
+          super()
+
           @exception = exception
         end
 
@@ -211,6 +224,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? { |c| c === 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 +294,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 +311,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

@@ -20,11 +20,15 @@ module Dry
     #
     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
     end
   end