dry-types 0.13.2 → 1.5.1

data/lib/dry/types/any.rb

@@ -1,27 +1,47 @@
+# frozen_string_literal: true
+
 module Dry
   module Types
-    Any = Class.new(Definition) do
+    # Any is a nominal type that defines Object as the primitive class
+    #
+    # This type is useful in places where you can't be specific about the type
+    # and anything is acceptable.
+    #
+    # @api public
+    class AnyClass < Nominal
+      def self.name
+        "Any"
+      end
+
+      # @api private
       def initialize(**options)
-        super(::Object, options)
+        super(::Object, **options)
       end
 
       # @return [String]
+      #
+      # @api public
       def name
-        'Any'
-      end
-
-      # @param [Object] any input is valid
-      # @return [true]
-      def valid?(_)
-        true
+        "Any"
       end
-      alias_method :===, :valid?
 
       # @param [Hash] new_options
+      #
       # @return [Type]
-      def with(new_options)
+      #
+      # @api public
+      def with(**new_options)
         self.class.new(**options, meta: @meta, **new_options)
       end
-    end.new
+
+      # @return [Array]
+      #
+      # @api public
+      def to_ast(meta: true)
+        [:any, meta ? self.meta : EMPTY_HASH]
+      end
+    end
+
+    Any = AnyClass.new
   end
 end

data/lib/dry/types/array.rb

@@ -1,13 +1,21 @@
-require 'dry/types/array/member'
-require 'dry/core/deprecations'
+# frozen_string_literal: true
+
+require "dry/types/array/member"
+require "dry/types/array/constructor"
 
 module Dry
   module Types
-    class Array < Definition
-      extend Dry::Core::Deprecations[:'dry-types']
-
-      # @param [Type] type
+    # Array type can be used to define an array with optional member type
+    #
+    # @api public
+    class Array < Nominal
+      # Build an array type with a member type
+      #
+      # @param [Type,#call] type
+      #
       # @return [Array::Member]
+      #
+      # @api public
       def of(type)
         member =
           case type
@@ -17,6 +25,11 @@ module Dry
 
         Array::Member.new(primitive, **options, member: member)
       end
+
+      # @api private
+      def constructor_type
+        ::Dry::Types::Array::Constructor
+      end
     end
   end
 end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "dry/types/constructor"
+
+module Dry
+  module Types
+    # @api public
+    class Array < Nominal
+      # @api private
+      class Constructor < ::Dry::Types::Constructor
+        # @api private
+        def constructor_type
+          ::Dry::Types::Array::Constructor
+        end
+
+        # @return [Lax]
+        #
+        # @api public
+        def lax
+          Lax.new(type.lax.constructor(fn, meta: meta))
+        end
+
+        # @see Dry::Types::Array#of
+        #
+        # @api public
+        def of(member)
+          type.of(member).constructor(fn, meta: meta)
+        end
+      end
+    end
+  end
+end

data/lib/dry/types/array/member.rb

@@ -1,57 +1,111 @@
+# frozen_string_literal: true
+
+require "dry/types/array/constructor"
+
 module Dry
   module Types
-    class Array < Definition
+    class Array < Nominal
+      # Member arrays define their member type that is applied to each element
+      #
+      # @api public
       class Member < Array
         # @return [Type]
         attr_reader :member
 
         # @param [Class] primitive
         # @param [Hash] options
+        #
         # @option options [Type] :member
-        def initialize(primitive, options = {})
+        #
+        # @api private
+        def initialize(primitive, **options)
           @member = options.fetch(:member)
           super
         end
 
         # @param [Object] input
-        # @param [Symbol] meth
+        #
         # @return [Array]
-        def call(input, meth = :call)
-          input.map { |el| member.__send__(meth, el) }
+        #
+        # @api private
+        def call_unsafe(input)
+          if primitive?(input)
+            input.each_with_object([]) do |el, output|
+              coerced = member.call_unsafe(el)
+
+              output << coerced unless Undefined.equal?(coerced)
+            end
+          else
+            super
+          end
         end
-        alias_method :[], :call
 
-        # @param [Array, #all?, Object] value
-        # @return [Boolean]
-        def valid?(value)
-          super && value.all? { |el| member.valid?(el) }
+        # @param [Object] input
+        # @return [Array]
+        #
+        # @api private
+        def call_safe(input)
+          if primitive?(input)
+            failed = false
+
+            result = input.each_with_object([]) do |el, output|
+              coerced = member.call_safe(el) { |out = el|
+                failed = true
+                out
+              }
+
+              output << coerced unless Undefined.equal?(coerced)
+            end
+
+            failed ? yield(result) : result
+          else
+            yield
+          end
         end
 
         # @param [Array, Object] input
         # @param [#call,nil] block
+        #
         # @yieldparam [Failure] failure
         # @yieldreturn [Result]
+        #
         # @return [Result,Logic::Result]
+        #
+        # @api public
         def try(input, &block)
-          if input.is_a?(::Array)
-            result = call(input, :try).reject { |r| r.input.equal?(Undefined) }
-            output = result.map(&:input)
+          if primitive?(input)
+            output = []
+
+            result = input.map { |el| member.try(el) }
+            result.each do |r|
+              output << r.input unless Undefined.equal?(r.input)
+            end
 
             if result.all?(&:success?)
               success(output)
             else
-              failure = failure(output, result.select(&:failure?))
+              error = result.find(&:failure?).error
+              failure = failure(output, error)
               block ? yield(failure) : failure
             end
           else
-            failure = failure(input, "#{input} is not an array")
+            failure = failure(input, CoercionError.new("#{input} is not an array"))
             block ? yield(failure) : failure
           end
         end
 
+        # Build a lax type
+        #
+        # @return [Lax]
+        #
         # @api public
+        def lax
+          Lax.new(Member.new(primitive, **options, member: member.lax, meta: meta))
+        end
+
+        # @see Nominal#to_ast
         #
-        # @see Definition#to_ast
+        # @api public
         def to_ast(meta: true)
           if member.respond_to?(:to_ast)
             [:array, [member.to_ast(meta: meta), meta ? self.meta : EMPTY_HASH]]
@@ -59,6 +113,11 @@ module Dry
             [:array, [member, meta ? self.meta : EMPTY_HASH]]
           end
         end
+
+        # @api private
+        def constructor_type
+          ::Dry::Types::Array::Constructor
+        end
       end
     end
   end

data/lib/dry/types/builder.rb

@@ -1,47 +1,105 @@
+# frozen_string_literal: true
+
+require "dry/core/deprecations"
+
 module Dry
   module Types
+    # Common API for building types and composition
+    #
+    # @api public
     module Builder
       include Dry::Core::Constants
 
       # @return [Class]
+      #
+      # @api private
       def constrained_type
         Constrained
       end
 
+      # @return [Class]
+      #
+      # @api private
+      def constructor_type
+        Constructor
+      end
+
+      # Compose two types into a Sum type
+      #
       # @param [Type] other
+      #
       # @return [Sum, Sum::Constrained]
+      #
+      # @api private
       def |(other)
         klass = constrained? && other.constrained? ? Sum::Constrained : Sum
         klass.new(self, other)
       end
 
+      # Turn a type into an optional type
+      #
       # @return [Sum]
+      #
+      # @api public
       def optional
-        Types['strict.nil'] | self
+        Types["nil"] | self
       end
 
+      # Turn a type into a constrained type
+      #
       # @param [Hash] options constraining rule (see {Types.Rule})
+      #
       # @return [Constrained]
+      #
+      # @api public
       def constrained(options)
         constrained_type.new(self, rule: Types.Rule(options))
       end
 
+      # Turn a type into a type with a default value
+      #
       # @param [Object] input
+      # @option [Boolean] shared Whether it's safe to share the value across type applications
       # @param [#call,nil] block
+      #
       # @raise [ConstraintError]
+      #
       # @return [Default]
-      def default(input = Undefined, &block)
-        value = input.equal?(Undefined) ? block : input
+      #
+      # @api public
+      def default(input = Undefined, options = EMPTY_HASH, &block)
+        unless input.frozen? || options[:shared]
+          where = Core::Deprecations::STACK.()
+          Core::Deprecations.warn(
+            "#{input.inspect} is mutable."\
+            " Be careful: types will return the same instance of the default"\
+            " value every time. Call `.freeze` when setting the default"\
+            " or pass `shared: true` to discard this warning."\
+            "\n#{where}",
+            tag: :'dry-types'
+          )
+        end
+
+        value = Undefined.default(input, block)
+        type = Default[value].new(self, value)
 
-        if value.is_a?(Proc) || valid?(value)
-          Default[value].new(self, value)
+        if !type.callable? && !valid?(value)
+          raise ConstraintError.new(
+            "default value #{value.inspect} violates constraints",
+            value
+          )
         else
-          raise ConstraintError.new("default value #{value.inspect} violates constraints", value)
+          type
         end
       end
 
+      # Define an enum on top of the existing type
+      #
       # @param [Array] values
+      #
       # @return [Enum]
+      #
+      # @api public
       def enum(*values)
         mapping =
           if values.length == 1 && values[0].is_a?(::Hash)
@@ -53,24 +111,82 @@ module Dry
         Enum.new(constrained(included_in: mapping.keys), mapping: mapping)
       end
 
-      # @return [Safe]
-      def safe
-        Safe.new(self)
+      # Turn a type into a lax type that will rescue from type-errors and
+      # return the original input
+      #
+      # @return [Lax]
+      #
+      # @api public
+      def lax
+        Lax.new(self)
       end
 
+      # Define a constructor for the type
+      #
       # @param [#call,nil] constructor
       # @param [Hash] options
       # @param [#call,nil] block
+      #
       # @return [Constructor]
+      #
+      # @api public
       def constructor(constructor = nil, **options, &block)
-        Constructor.new(with(options), fn: constructor || block)
+        constructor_type[with(**options), fn: constructor || block]
+      end
+      alias_method :append, :constructor
+      alias_method :prepend, :constructor
+      alias_method :>>, :constructor
+      alias_method :<<, :constructor
+
+      # Use the given value on type mismatch
+      #
+      # @param [Object] value
+      # @option [Boolean] shared Whether it's safe to share the value across type applications
+      # @param [#call,nil] fallback
+      #
+      # @return [Constructor]
+      #
+      # @api public
+      def fallback(value = Undefined, shared: false, &_fallback)
+        if Undefined.equal?(value) && !block_given?
+          raise ::ArgumentError, "fallback value or a block must be given"
+        end
+
+        if !block_given? && !valid?(value)
+          raise ConstraintError.new(
+            "fallback value #{value.inspect} violates constraints",
+            value
+          )
+        end
+
+        unless value.frozen? || shared
+          where = Core::Deprecations::STACK.()
+          Core::Deprecations.warn(
+            "#{value.inspect} is mutable."\
+            " Be careful: types will return the same instance of the fallback"\
+            " value every time. Call `.freeze` when setting the fallback"\
+            " or pass `shared: true` to discard this warning."\
+            "\n#{where}",
+            tag: :'dry-types'
+          )
+        end
+
+        constructor do |input, type, &_block|
+          type.(input) do |output = input|
+            if block_given?
+              yield(output)
+            else
+              value
+            end
+          end
+        end
       end
     end
   end
 end
 
-require 'dry/types/default'
-require 'dry/types/constrained'
-require 'dry/types/enum'
-require 'dry/types/safe'
-require 'dry/types/sum'
+require "dry/types/default"
+require "dry/types/constrained"
+require "dry/types/enum"
+require "dry/types/lax"
+require "dry/types/sum"