dry-monads 1.3.2 → 1.4.0

data/lib/dry/monads/result.rb

@@ -1,10 +1,12 @@
-require 'dry/equalizer'
+# frozen_string_literal: true
 
-require 'dry/monads/constants'
-require 'dry/monads/right_biased'
-require 'dry/monads/transformer'
-require 'dry/monads/conversion_stubs'
-require 'dry/monads/unit'
+require "dry/core/equalizer"
+
+require "dry/monads/constants"
+require "dry/monads/right_biased"
+require "dry/monads/transformer"
+require "dry/monads/conversion_stubs"
+require "dry/monads/unit"
 
 module Dry
   module Monads
@@ -84,6 +86,7 @@ module Dry
 
         # @param value [Object] a value of a successful operation
         def initialize(value)
+          super()
           @value = value
         end
 
@@ -132,7 +135,7 @@ module Dry
         # @return [String]
         def to_s
           if Unit.equal?(@value)
-            'Success()'
+            "Success()"
           else
             "Success(#{@value.inspect})"
           end
@@ -145,6 +148,13 @@ module Dry
         def flip
           Failure.new(@value, RightBiased::Left.trace_caller)
         end
+
+        # Ignores values and returns self, see {Failure#alt_map}
+        #
+        # @return [Result::Success]
+        def alt_map(_ = nil)
+          self
+        end
       end
 
       # Represents a value of a failed operation.
@@ -186,6 +196,7 @@ module Dry
         # @param value [Object] failure value
         # @param trace [String] caller line
         def initialize(value, trace = RightBiased::Left.trace_caller)
+          super()
           @value = value
           @trace = trace
         end
@@ -216,7 +227,8 @@ module Dry
         # otherwise simply returns the first argument.
         #
         # @example
-        #   Dry::Monads.Failure(ArgumentError.new('error message')).or(&:message) # => "error message"
+        #   Dry::Monads.Failure(ArgumentError.new('error message')).or(&:message)
+        #   # => "error message"
         #
         # @param args [Array<Object>] arguments that will be passed to a block
         #                             if one was given, otherwise the first
@@ -230,7 +242,8 @@ module Dry
           end
         end
 
-        # A lifted version of `#or`. Wraps the passed value or the block result with Result::Success.
+        # A lifted version of `#or`. Wraps the passed value or the block
+        # result with Result::Success.
         #
         # @example
         #   Dry::Monads.Failure.new('no value').or_fmap('value') # => Success("value")
@@ -245,7 +258,7 @@ module Dry
         # @return [String]
         def to_s
           if Unit.equal?(@value)
-            'Failure()'
+            "Failure()"
           else
             "Failure(#{@value.inspect})"
           end
@@ -285,6 +298,21 @@ module Dry
         def either(_, g)
           g.(failure)
         end
+
+        # Lifts a block/proc over Failure
+        #
+        # @overload alt_map(proc)
+        #   @param proc [#call]
+        #   @return [Result::Failure]
+        #
+        # @overload alt_map
+        #   @param block [Proc]
+        #   @return [Result::Failure]
+        #
+        def alt_map(proc = Undefined, &block)
+          f = Undefined.default(proc, block)
+          self.class.new(f.(failure), RightBiased::Left.trace_caller)
+        end
       end
 
       # A module that can be included for easier access to Result monads.
@@ -299,7 +327,6 @@ module Dry
         # Value constructors
         #
         module Constructors
-
           # Success constructor
           #
           # @overload Success(value)
@@ -386,7 +413,7 @@ module Dry
         # @param fail [#call] Fallback value
         # @param block [Proc] Fallback block
         # @return [Success<Any>]
-        def to_result(fail = Unit, &block)
+        def to_result(_fail = Unit)
           Result::Success.new(@value)
         end
       end
@@ -397,7 +424,7 @@ module Dry
         # @param fail [#call] Fallback value
         # @param block [Proc] Fallback block
         # @return [Failure<Any>]
-        def to_result(fail = Unit, &block)
+        def to_result(fail = Unit)
           if block_given?
             Result::Failure.new(yield)
           else
@@ -447,7 +474,7 @@ module Dry
       end
 
       class Invalid < Validated
-        # Concerts to Result::Failure
+        # Converts to Result::Failure
         #
         # @return [Result::Failure]
         def to_result
@@ -456,7 +483,7 @@ module Dry
       end
     end
 
-    require 'dry/monads/registry'
+    require "dry/monads/registry"
     register_mixin(:result, Result::Mixin)
   end
 end

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

@@ -1,35 +1,46 @@
-module Dry::Monads
-  class Result
-    # @see Monads#Result
-    # @private
-    class Fixed < Module
-      def self.[](error, **options)
-        new(error, **options)
-      end
+# frozen_string_literal: true
+
+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.new(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,7 +1,9 @@
-require 'dry/monads/constants'
-require 'dry/monads/unit'
-require 'dry/monads/curry'
-require 'dry/monads/errors'
+# frozen_string_literal: true
+
+require "dry/monads/constants"
+require "dry/monads/unit"
+require "dry/monads/curry"
+require "dry/monads/errors"
 
 module Dry
   module Monads
@@ -10,7 +12,7 @@ module Dry
       # Right part
       #
       # @api public
-      module Right
+      module Right # rubocop:disable Metrics/ModuleLength
         # @private
         def self.included(m)
           super
@@ -88,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.
         #
@@ -116,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 }"
+            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
@@ -195,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
 
@@ -214,9 +226,9 @@ module Dry
         #   end
         #
         # @api private
-        def deconstruct_keys(_)
-          if @value.is_a?(::Hash)
-            @value
+        def deconstruct_keys(keys)
+          if @value.respond_to?(:deconstruct_keys)
+            @value.deconstruct_keys(keys)
           else
             EMPTY_HASH
           end
@@ -224,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)
@@ -253,12 +265,12 @@ 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
         def value!
-          raise UnwrapError.new(self)
+          raise UnwrapError, self
         end
 
         # Ignores the input parameter and returns self. It exists to keep the interface
@@ -297,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(*)
@@ -381,9 +402,9 @@ module Dry
         #   end
         #
         # @api private
-        def deconstruct_keys(_)
-          if @value.is_a?(::Hash)
-            @value
+        def deconstruct_keys(keys)
+          if @value.respond_to?(:deconstruct_keys)
+            @value.deconstruct_keys(keys)
           else
             EMPTY_HASH
           end

data/lib/dry/monads/task.rb

@@ -1,8 +1,10 @@
-require 'concurrent/promise'
+# frozen_string_literal: true
 
-require 'dry/monads/unit'
-require 'dry/monads/curry'
-require 'dry/monads/conversion_stubs'
+require "concurrent/promise"
+
+require "dry/monads/unit"
+require "dry/monads/curry"
+require "dry/monads/conversion_stubs"
 
 module Dry
   module Monads
@@ -46,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))
@@ -129,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 }"
+                  "error=#{promise.reason.inspect}"
                 else
-                  '?'
+                  "?"
                 end
 
         "Task(#{state})"
@@ -162,16 +166,14 @@ 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 => 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) }
+        promise.on_success { |v| child.on_fulfill(v) }
 
         self.class.new(child)
       end
@@ -200,6 +202,7 @@ module Dry
       def ==(other)
         return true if equal?(other)
         return false unless self.class == other.class
+
         compare_promises(promise, other.promise)
       end
 
@@ -233,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
 
@@ -311,7 +314,7 @@ module Dry
       end
     end
 
-    require 'dry/monads/registry'
+    require "dry/monads/registry"
     register_mixin(:task, Task::Mixin)
   end
 end