dry-types 0.13.2 → 1.5.1

data/lib/dry/types/default.rb

@@ -1,30 +1,46 @@
-require 'dry/types/decorator'
+# frozen_string_literal: true
+
+require "dry/core/equalizer"
+require "dry/types/decorator"
 
 module Dry
   module Types
+    # Default types are useful when a missing value should be replaced by a default one
+    #
+    # @api public
     class Default
-      include Type
-      include Dry::Equalizer(:type, :options, :value)
-      include Decorator
-      include Builder
-
+      # @api private
       class Callable < Default
-        include Dry::Equalizer(:type, :options)
+        include Dry::Equalizer(:type, inspect: false, immutable: true)
 
         # Evaluates given callable
         # @return [Object]
         def evaluate
           value.call(type)
         end
+
+        # @return [true]
+        def callable?
+          true
+        end
       end
 
+      include Type
+      include Decorator
+      include Builder
+      include Printable
+      include Dry::Equalizer(:type, :value, inspect: false, immutable: true)
+
       # @return [Object]
       attr_reader :value
 
       alias_method :evaluate, :value
 
       # @param [Object, #call] value
+      #
       # @return [Class] {Default} or {Default::Callable}
+      #
+      # @api private
       def self.[](value)
         if value.respond_to?(:call)
           Callable
@@ -35,49 +51,78 @@ module Dry
 
       # @param [Type] type
       # @param [Object] value
+      #
+      # @api private
       def initialize(type, value, **options)
         super
         @value = value
       end
 
+      # Build a constrained type
+      #
       # @param [Array] args see {Dry::Types::Builder#constrained}
+      #
       # @return [Default]
+      #
+      # @api public
       def constrained(*args)
         type.constrained(*args).default(value)
       end
 
       # @return [true]
+      #
+      # @api public
       def default?
         true
       end
 
       # @param [Object] input
+      #
       # @return [Result::Success]
+      #
+      # @api public
       def try(input)
         success(call(input))
       end
 
+      # @return [Boolean]
+      #
+      # @api public
       def valid?(value = Undefined)
-        value.equal?(Undefined) || super
+        Undefined.equal?(value) || super
       end
 
       # @param [Object] input
+      #
       # @return [Object] value passed through {#type} or {#default} value
-      def call(input = Undefined)
+      #
+      # @api private
+      def call_unsafe(input = Undefined)
         if input.equal?(Undefined)
           evaluate
         else
-          output = type[input]
-          output.nil? ? evaluate : output
+          Undefined.default(type.call_unsafe(input)) { evaluate }
         end
       end
-      alias_method :[], :call
 
-      private
+      # @param [Object] input
+      #
+      # @return [Object] value passed through {#type} or {#default} value
+      #
+      # @api private
+      def call_safe(input = Undefined, &block)
+        if input.equal?(Undefined)
+          evaluate
+        else
+          Undefined.default(type.call_safe(input, &block)) { evaluate }
+        end
+      end
 
-      # Replace underlying type
-      def __new__(type)
-        self.class.new(type, value, options)
+      # @return [false]
+      #
+      # @api private
+      def callable?
+        false
       end
     end
   end

data/lib/dry/types/enum.rb

@@ -1,11 +1,18 @@
-require 'dry/types/decorator'
+# frozen_string_literal: true
+
+require "dry/core/equalizer"
+require "dry/types/decorator"
 
 module Dry
   module Types
+    # Enum types can be used to define an enum on top of an existing type
+    #
+    # @api public
     class Enum
       include Type
-      include Dry::Equalizer(:type, :options, :mapping)
+      include Dry::Equalizer(:type, :mapping, inspect: false, immutable: true)
       include Decorator
+      include Builder
 
       # @return [Array]
       attr_reader :values
@@ -19,7 +26,9 @@ module Dry
       # @param [Type] type
       # @param [Hash] options
       # @option options [Array] :values
-      def initialize(type, options)
+      #
+      # @api private
+      def initialize(type, **options)
         super
         @mapping = options.fetch(:mapping).freeze
         @values = @mapping.keys.freeze
@@ -27,45 +36,59 @@ module Dry
         freeze
       end
 
-      # @param [Object] input
       # @return [Object]
-      def call(input = Undefined)
-        type[map_value(input)]
+      #
+      # @api private
+      def call_unsafe(input)
+        type.call_unsafe(map_value(input))
+      end
+
+      # @return [Object]
+      #
+      # @api private
+      def call_safe(input, &block)
+        type.call_safe(map_value(input), &block)
       end
-      alias_method :[], :call
 
-      # @param [Object] input
-      # @yieldparam [Failure] failure
-      # @yieldreturn [Result]
-      # @return [Logic::Result]
-      # @return [Object] if coercion fails and a block is given
+      # @see Dry::Types::Constrained#try
+      #
+      # @api public
       def try(input)
         super(map_value(input))
       end
 
+      # @api private
       def default(*)
-        raise '.enum(*values).default(value) is not supported. Call '\
-              '.default(value).enum(*values) instead'
+        raise ".enum(*values).default(value) is not supported. Call "\
+              ".default(value).enum(*values) instead"
       end
 
       # Check whether a value is in the enum
       alias_method :include?, :valid?
 
-      # @api public
+      # @see Nominal#to_ast
       #
-      # @see Definition#to_ast
+      # @api public
       def to_ast(meta: true)
-        [:enum, [type.to_ast(meta: meta),
-                 mapping,
-                 meta ? self.meta : EMPTY_HASH]]
+        [:enum, [type.to_ast(meta: meta), mapping]]
+      end
+
+      # @return [String]
+      #
+      # @api public
+      def to_s
+        PRINTER.(self)
       end
+      alias_method :inspect, :to_s
 
       private
 
       # Maps a value
       #
-      # @params [Object]
+      # @param [Object] input
+      #
       # @return [Object]
+      #
       # @api private
       def map_value(input)
         if input.equal?(Undefined)

data/lib/dry/types/errors.rb

@@ -1,14 +1,71 @@
+# frozen_string_literal: true
+
 module Dry
   module Types
-    extend Dry::Core::ClassAttributes
+    extend ::Dry::Core::ClassAttributes
 
     # @!attribute [r] namespace
-    #   @return [Container{String => Definition}]
+    #   @return [Container{String => Nominal}]
     defines :namespace
 
     namespace self
 
-    class SchemaError < TypeError
+    # Base class for coercion errors raise by dry-types
+    #
+    class CoercionError < ::StandardError
+      # @api private
+      def self.handle(exception, meta: Undefined)
+        if block_given?
+          yield
+        else
+          raise new(
+            exception.message,
+            meta: meta,
+            backtrace: exception.backtrace
+          )
+        end
+      end
+
+      # Metadata associated with the error
+      #
+      # @return [Object]
+      attr_reader :meta
+
+      # @api private
+      def initialize(message, meta: Undefined, backtrace: Undefined)
+        unless message.is_a?(::String)
+          raise ::ArgumentError, "message must be a string, #{message.class} given"
+        end
+
+        super(message)
+        @meta = Undefined.default(meta, nil)
+        set_backtrace(backtrace) unless Undefined.equal?(backtrace)
+      end
+    end
+
+    # Collection of multiple errors
+    #
+    class MultipleError < CoercionError
+      # @return [Array<CoercionError>]
+      attr_reader :errors
+
+      # @param [Array<CoercionError>] errors
+      def initialize(errors)
+        @errors = errors
+      end
+
+      # @return string
+      def message
+        errors.map(&:message).join(", ")
+      end
+
+      # @return [Array]
+      def meta
+        errors.map(&:meta)
+      end
+    end
+
+    class SchemaError < CoercionError
       # @param [String,Symbol] key
       # @param [Object] value
       # @param [String, #to_s] result
@@ -17,26 +74,34 @@ module Dry
       end
     end
 
-    MapError = Class.new(TypeError)
+    MapError = ::Class.new(CoercionError)
 
-    SchemaKeyError = Class.new(KeyError)
+    SchemaKeyError = ::Class.new(CoercionError)
     private_constant(:SchemaKeyError)
 
     class MissingKeyError < SchemaKeyError
+      # @return [Symbol]
+      attr_reader :key
+
       # @param [String,Symbol] key
       def initialize(key)
-        super(":#{key} is missing in Hash input")
+        @key = key
+        super("#{key.inspect} is missing in Hash input")
       end
     end
 
     class UnknownKeysError < SchemaKeyError
+      # @return [Array<Symbol>]
+      attr_reader :keys
+
       # @param [<String, Symbol>] keys
-      def initialize(*keys)
+      def initialize(keys)
+        @keys = keys
         super("unexpected keys #{keys.inspect} in Hash input")
       end
     end
 
-    class ConstraintError < TypeError
+    class ConstraintError < CoercionError
       # @return [String, #to_s]
       attr_reader :result
       # @return [Object]
@@ -56,9 +121,10 @@ module Dry
       end
 
       # @return [String]
-      def to_s
+      def message
         "#{input.inspect} violates constraints (#{result} failed)"
       end
+      alias_method :to_s, :message
     end
   end
 end

data/lib/dry/types/extensions.rb

@@ -1,3 +1,9 @@
+# frozen_string_literal: true
+
 Dry::Types.register_extension(:maybe) do
-  require 'dry/types/extensions/maybe'
+  require "dry/types/extensions/maybe"
+end
+
+Dry::Types.register_extension(:monads) do
+  require "dry/types/extensions/monads"
 end

data/lib/dry/types/extensions/maybe.rb

@@ -1,49 +1,83 @@
-require 'dry/monads/maybe'
-require 'dry/types/decorator'
+# frozen_string_literal: true
+
+require "dry/core/equalizer"
+require "dry/monads/maybe"
+require "dry/types/decorator"
 
 module Dry
   module Types
+    # Maybe extension provides Maybe types where values are wrapped using `Either` monad
+    #
+    # @api public
     class Maybe
       include Type
-      include Dry::Equalizer(:type, :options)
+      include ::Dry::Equalizer(:type, :options, inspect: false, immutable: true)
       include Decorator
       include Builder
-      include Dry::Monads::Maybe::Mixin
+      include Printable
+      include ::Dry::Monads::Maybe::Mixin
+
+      # @param [Dry::Monads::Maybe, Object] input
+      #
+      # @return [Dry::Monads::Maybe]
+      #
+      # @api private
+      def call_unsafe(input = Undefined)
+        case input
+        when ::Dry::Monads::Maybe
+          input
+        when Undefined
+          None()
+        else
+          Maybe(type.call_unsafe(input))
+        end
+      end
 
       # @param [Dry::Monads::Maybe, Object] input
+      #
       # @return [Dry::Monads::Maybe]
-      def call(input = Undefined)
+      #
+      # @api private
+      def call_safe(input = Undefined)
         case input
-        when Dry::Monads::Maybe
+        when ::Dry::Monads::Maybe
           input
         when Undefined
           None()
         else
-          Maybe(type[input])
+          Maybe(type.call_safe(input) { |output = input| return yield(output) })
         end
       end
-      alias_method :[], :call
 
       # @param [Object] input
+      #
       # @return [Result::Success]
+      #
+      # @api public
       def try(input = Undefined)
-        res = if input.equal?(Undefined)
-                None()
-              else
-                Maybe(type[input])
-              end
+        result = type.try(input)
 
-        Result::Success.new(res)
+        if result.success?
+          Result::Success.new(Maybe(result.input))
+        else
+          result
+        end
       end
 
       # @return [true]
+      #
+      # @api public
       def default?
         true
       end
 
       # @param [Object] value
+      #
       # @see Dry::Types::Builder#default
+      #
       # @raise [ArgumentError] if nil provided as default value
+      #
+      # @api public
       def default(value)
         if value.nil?
           raise ArgumentError, "nil cannot be used as a default of a maybe type"
@@ -54,15 +88,39 @@ module Dry
     end
 
     module Builder
+      # Turn a type into a maybe type
+      #
       # @return [Maybe]
+      #
+      # @api public
+      def maybe
+        Maybe.new(Types["nil"] | self)
+      end
+    end
+
+    # @api private
+    class Schema::Key
+      # @api private
       def maybe
-        Maybe.new(Types['strict.nil'] | self)
+        __new__(type.maybe)
+      end
+    end
+
+    # @api private
+    class Printer
+      MAPPING[Maybe] = :visit_maybe
+
+      # @api private
+      def visit_maybe(maybe)
+        visit(maybe.type) do |type|
+          yield "Maybe<#{type}>"
+        end
       end
     end
 
     # Register non-coercible maybe types
     NON_NIL.each_key do |name|
-      register("maybe.strict.#{name}", self["strict.#{name}"].maybe)
+      register("maybe.strict.#{name}", self[name.to_s].maybe)
     end
 
     # Register coercible maybe types