dry-types 0.15.0 → 1.5.1

data/lib/dry/types/constrained/coercible.rb

@@ -1,12 +1,42 @@
+# frozen_string_literal: true
+
 module Dry
   module Types
     class Constrained
+      # Common coercion-related API for constrained types
+      #
+      # @api public
       class Coercible < Constrained
-        # @param [Object] input
-        # @param [#call,nil] block
-        # @yieldparam [Failure] failure
-        # @yieldreturn [Result]
-        # @return [Result,nil]
+        # @return [Object]
+        #
+        # @api private
+        def call_unsafe(input)
+          coerced = type.call_unsafe(input)
+          result = rule.(coerced)
+
+          if result.success?
+            coerced
+          else
+            raise ConstraintError.new(result, input)
+          end
+        end
+
+        # @return [Object]
+        #
+        # @api private
+        def call_safe(input)
+          coerced = type.call_safe(input) { return yield }
+
+          if rule[coerced]
+            coerced
+          else
+            yield(coerced)
+          end
+        end
+
+        # @see Dry::Types::Constrained#try
+        #
+        # @api public
         def try(input, &block)
           result = type.try(input)
 
@@ -16,7 +46,7 @@ module Dry
             if validation.success?
               result
             else
-              failure = failure(result.input, validation)
+              failure = failure(result.input, ConstraintError.new(validation, input))
               block ? yield(failure) : failure
             end
           else

data/lib/dry/types/constrained.rb

@@ -1,94 +1,142 @@
-require 'dry/types/decorator'
-require 'dry/types/constraints'
-require 'dry/types/constrained/coercible'
+# frozen_string_literal: true
+
+require "dry/core/equalizer"
+require "dry/types/decorator"
+require "dry/types/constraints"
+require "dry/types/constrained/coercible"
 
 module Dry
   module Types
+    # Constrained types apply rules to the input
+    #
+    # @api public
     class Constrained
       include Type
       include Decorator
       include Builder
       include Printable
-      include Dry::Equalizer(:type, :options, :rule, :meta, inspect: false)
+      include Dry::Equalizer(:type, :rule, inspect: false, immutable: true)
 
       # @return [Dry::Logic::Rule]
       attr_reader :rule
 
       # @param [Type] type
+      #
       # @param [Hash] options
-      def initialize(type, options)
+      #
+      # @api public
+      def initialize(type, **options)
         super
         @rule = options.fetch(:rule)
       end
 
-      # @param [Object] input
       # @return [Object]
-      # @raise [ConstraintError]
-      def call(input)
-        try(input) { |result|
+      #
+      # @api private
+      def call_unsafe(input)
+        result = rule.(input)
+
+        if result.success?
+          type.call_unsafe(input)
+        else
           raise ConstraintError.new(result, input)
-        }.input
+        end
+      end
+
+      # @return [Object]
+      #
+      # @api private
+      def call_safe(input, &block)
+        if rule[input]
+          type.call_safe(input, &block)
+        else
+          yield
+        end
       end
-      alias_method :[], :call
-
-      # @param [Object] input
-      # @param [#call,nil] block
-      # @yieldparam [Failure] failure
-      # @yieldreturn [Result]
-      # @return [Logic::Result, Result]
-      # @return [Object] if block given and try fails
+
+      # Safe coercion attempt. It is similar to #call with a
+      # block given but returns a Result instance with metadata
+      # about errors (if any).
+      #
+      # @overload try(input)
+      #   @param [Object] input
+      #   @return [Logic::Result]
+      #
+      # @overload try(input)
+      #   @param [Object] input
+      #   @yieldparam [Failure] failure
+      #   @yieldreturn [Object]
+      #   @return [Object]
+      #
+      # @api public
       def try(input, &block)
         result = rule.(input)
 
         if result.success?
           type.try(input, &block)
         else
-          failure = failure(input, result)
-          block ? yield(failure) : failure
+          failure = failure(input, ConstraintError.new(result, input))
+          block_given? ? yield(failure) : failure
         end
       end
 
-      # @param [Object] value
-      # @return [Boolean]
-      def valid?(value)
-        rule.(value).success? && type.valid?(value)
-      end
-
       # @param [Hash] options
       #   The options hash provided to {Types.Rule} and combined
       #   using {&} with previous {#rule}
+      #
       # @return [Constrained]
+      #
       # @see Dry::Logic::Operators#and
+      #
+      # @api public
       def constrained(options)
         with(rule: rule & Types.Rule(options))
       end
 
       # @return [true]
+      #
+      # @api public
       def constrained?
         true
       end
 
       # @param [Object] value
+      #
       # @return [Boolean]
+      #
+      # @api public
       def ===(value)
         valid?(value)
       end
 
-      # @api public
+      # Build lax type. Constraints are not applicable to lax types hence unwrapping
       #
+      # @return [Lax]
+      # @api public
+      def lax
+        type.lax
+      end
+
       # @see Nominal#to_ast
+      # @api public
       def to_ast(meta: true)
-        [:constrained, [type.to_ast(meta: meta),
-                        rule.to_ast,
-                        meta ? self.meta : EMPTY_HASH]]
+        [:constrained, [type.to_ast(meta: meta), rule.to_ast]]
+      end
+
+      # @api private
+      def constructor_type
+        type.constructor_type
       end
 
       private
 
       # @param [Object] response
+      #
       # @return [Boolean]
+      #
+      # @api private
       def decorate?(response)
-        super || response.kind_of?(Constructor)
+        super || response.is_a?(Constructor)
       end
     end
   end

data/lib/dry/types/constraints.rb

@@ -1,18 +1,32 @@
-require 'dry/logic/rule_compiler'
-require 'dry/logic/predicates'
-require 'dry/logic/rule/predicate'
+# frozen_string_literal: true
+
+require "dry/logic/rule_compiler"
+require "dry/logic/predicates"
+require "dry/logic/rule/predicate"
 
 module Dry
+  # Helper methods for constraint types
+  #
+  # @api public
   module Types
     # @param [Hash] options
+    #
     # @return [Dry::Logic::Rule]
+    #
+    # @api public
     def self.Rule(options)
       rule_compiler.(
-        options.map { |key, val| Logic::Rule::Predicate.new(Logic::Predicates[:"#{key}?"]).curry(val).to_ast }
+        options.map { |key, val|
+          Logic::Rule::Predicate.build(
+            Logic::Predicates[:"#{key}?"]
+          ).curry(val).to_ast
+        }
       ).reduce(:and)
     end
 
     # @return [Dry::Logic::RuleCompiler]
+    #
+    # @api private
     def self.rule_compiler
       @rule_compiler ||= Logic::RuleCompiler.new(Logic::Predicates)
     end

data/lib/dry/types/constructor/function.rb

@@ -0,0 +1,216 @@
+# frozen_string_literal: true
+
+require "dry/core/equalizer"
+require "concurrent/map"
+
+module Dry
+  module Types
+    class Constructor < Nominal
+      # Function is used internally by Constructor types
+      #
+      # @api private
+      class Function
+        # Wrapper for unsafe coercion functions
+        #
+        # @api private
+        class Safe < Function
+          def call(input, &block)
+            @fn.(input, &block)
+          rescue ::NoMethodError, ::TypeError, ::ArgumentError => e
+            CoercionError.handle(e, &block)
+          end
+        end
+
+        # Coercion via a method call on a known object
+        #
+        # @api private
+        class MethodCall < Function
+          @cache = ::Concurrent::Map.new
+
+          # Choose or build the base class
+          #
+          # @return [Function]
+          def self.call_class(method, public, safe)
+            @cache.fetch_or_store([method, public, safe]) do
+              if public
+                ::Class.new(PublicCall) do
+                  include PublicCall.call_interface(method, safe)
+
+                  define_method(:__to_s__) do
+                    "#<PublicCall for :#{method}>"
+                  end
+                end
+              elsif safe
+                PrivateCall
+              else
+                PrivateSafeCall
+              end
+            end
+          end
+
+          # Coercion with a publicly accessible method call
+          #
+          # @api private
+          class PublicCall < MethodCall
+            @interfaces = ::Concurrent::Map.new
+
+            # Choose or build the interface
+            #
+            # @return [::Module]
+            def self.call_interface(method, safe)
+              @interfaces.fetch_or_store([method, safe]) do
+                ::Module.new do
+                  if safe
+                    module_eval(<<~RUBY, __FILE__, __LINE__ + 1)
+                      def call(input, &block)
+                        @target.#{method}(input, &block)
+                      end
+                    RUBY
+                  else
+                    module_eval(<<~RUBY, __FILE__, __LINE__ + 1)
+                      def call(input, &block)
+                        @target.#{method}(input)
+                      rescue ::NoMethodError, ::TypeError, ::ArgumentError => error
+                        CoercionError.handle(error, &block)
+                      end
+                    RUBY
+                  end
+                end
+              end
+            end
+          end
+
+          # Coercion via a private method call
+          #
+          # @api private
+          class PrivateCall < MethodCall
+            def call(input, &block)
+              @target.send(@name, input, &block)
+            end
+          end
+
+          # Coercion via an unsafe private method call
+          #
+          # @api private
+          class PrivateSafeCall < PrivateCall
+            def call(input, &block)
+              @target.send(@name, input)
+            rescue ::NoMethodError, ::TypeError, ::ArgumentError => e
+              CoercionError.handle(e, &block)
+            end
+          end
+
+          # @api private
+          #
+          # @return [MethodCall]
+          def self.[](fn, safe)
+            public = fn.receiver.respond_to?(fn.name)
+            MethodCall.call_class(fn.name, public, safe).new(fn)
+          end
+
+          attr_reader :target, :name
+
+          def initialize(fn)
+            super
+            @target = fn.receiver
+            @name = fn.name
+          end
+
+          def to_ast
+            [:method, target, name]
+          end
+        end
+
+        class Wrapper < Function
+          # @return [Object]
+          def call(input, type, &block)
+            @fn.(input, type, &block)
+          rescue ::NoMethodError, ::TypeError, ::ArgumentError => e
+            CoercionError.handle(e, &block)
+          end
+          alias_method :[], :call
+
+          def arity
+            2
+          end
+        end
+
+        # Choose or build specialized invokation code for a callable
+        #
+        # @param [#call] fn
+        # @return [Function]
+        def self.[](fn)
+          raise ::ArgumentError, "Missing constructor block" if fn.nil?
+
+          if fn.is_a?(Function)
+            fn
+          elsif fn.respond_to?(:arity) && fn.arity.equal?(2)
+            Wrapper.new(fn)
+          elsif fn.is_a?(::Method)
+            MethodCall[fn, yields_block?(fn)]
+          elsif yields_block?(fn)
+            new(fn)
+          else
+            Safe.new(fn)
+          end
+        end
+
+        # @return [Boolean]
+        def self.yields_block?(fn)
+          *, (last_arg,) =
+            if fn.respond_to?(:parameters)
+              fn.parameters
+            else
+              fn.method(:call).parameters
+            end
+
+          last_arg.equal?(:block)
+        end
+
+        include ::Dry::Equalizer(:fn, immutable: true)
+
+        attr_reader :fn
+
+        def initialize(fn)
+          @fn = fn
+        end
+
+        # @return [Object]
+        def call(input, &block)
+          @fn.(input, &block)
+        end
+        alias_method :[], :call
+
+        # @return [Integer]
+        def arity
+          1
+        end
+
+        def wrapper?
+          arity.equal?(2)
+        end
+
+        # @return [Array]
+        def to_ast
+          if fn.is_a?(::Proc)
+            [:id, FnContainer.register(fn)]
+          else
+            [:callable, fn]
+          end
+        end
+
+        # @return [Function]
+        def >>(other)
+          f = Function[other]
+          Function[-> x, &b { f.(self.(x, &b), &b) }]
+        end
+
+        # @return [Function]
+        def <<(other)
+          f = Function[other]
+          Function[-> x, &b { self.(f.(x, &b), &b) }]
+        end
+      end
+    end
+  end
+end

data/lib/dry/types/constructor/wrapper.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module Dry
+  module Types
+    # @api public
+    class Constructor < Nominal
+      module Wrapper
+        # @return [Object]
+        #
+        # @api private
+        def call_safe(input, &block)
+          fn.(input, type, &block)
+        end
+
+        # @return [Object]
+        #
+        # @api private
+        def call_unsafe(input)
+          fn.(input, type)
+        end
+
+        # @param [Object] input
+        # @param [#call,nil] block
+        #
+        # @return [Logic::Result, Types::Result]
+        # @return [Object] if block given and try fails
+        #
+        # @api public
+        def try(input, &block)
+          value = fn.(input, type)
+        rescue CoercionError => e
+          failure = failure(input, e)
+          block_given? ? yield(failure) : failure
+        else
+          type.try(value, &block)
+        end
+
+        # Define a constructor for the type
+        #
+        # @param [#call,nil] constructor
+        # @param [Hash] options
+        # @param [#call,nil] block
+        #
+        # @return [Constructor]
+        #
+        # @api public
+        define_method(:constructor, Builder.instance_method(:constructor))
+        alias_method :append, :constructor
+        alias_method :>>, :constructor
+
+        # Build a new constructor by prepending a block to the coercion function
+        #
+        # @param [#call, nil] new_fn
+        # @param [Hash] options
+        # @param [#call, nil] block
+        #
+        # @return [Constructor]
+        #
+        # @api public
+        def prepend(new_fn = nil, **options, &block)
+          prep_fn = Function[new_fn || block]
+
+          decorated =
+            if prep_fn.wrapper?
+              type.constructor(prep_fn, **options)
+            else
+              type.prepend(prep_fn, **options)
+            end
+
+          __new__(decorated)
+        end
+        alias_method :<<, :prepend
+
+        # @return [Constructor]
+        #
+        # @api public
+        def lax
+          # return self back because wrapping function
+          # can handle failed type check
+          self
+        end
+
+        private
+
+        # Replace underlying type
+        #
+        # @api private
+        def __new__(type)
+          self.class.new(type, *@__args__.drop(1), **@options)
+        end
+      end
+    end
+  end
+end