dry-types 0.15.0 → 1.2.0

data/lib/dry/types/map.rb

@@ -1,96 +1,134 @@
+# frozen_string_literal: true
+
 module Dry
   module Types
+    # Homogeneous mapping. It describes a hash with unknown keys that match a certain type.
+    #
+    # @example
+    #   type = Dry::Types['hash'].map(
+    #     Dry::Types['integer'].constrained(gteq: 1, lteq: 10),
+    #     Dry::Types['string']
+    #   )
+    #
+    #   type.(1 => 'right')
+    #   # => {1 => 'right'}
+    #
+    #   type.('1' => 'wrong')
+    #   # Dry::Types::MapError: "1" violates constraints (type?(Integer, "1") AND gteq?(1, "1") AND lteq?(10, "1") failed)
+    #
+    #   type.(11 => 'wrong')
+    #   # Dry::Types::MapError: 11 violates constraints (lteq?(10, 11) failed)
+    #
+    # @api public
     class Map < Nominal
       def initialize(_primitive, key_type: Types['any'], value_type: Types['any'], meta: EMPTY_HASH)
         super(_primitive, key_type: key_type, value_type: value_type, meta: meta)
-        validate_options!
       end
 
       # @return [Type]
+      #
+      # @api public
       def key_type
         options[:key_type]
       end
 
       # @return [Type]
+      #
+      # @api public
       def value_type
         options[:value_type]
       end
 
       # @return [String]
+      #
+      # @api public
       def name
-        "Map"
+        'Map'
       end
 
       # @param [Hash] hash
+      #
       # @return [Hash]
-      def call(hash)
-        try(hash) do |failure|
-          raise MapError, failure.error.join("\n")
-        end.input
+      #
+      # @api private
+      def call_unsafe(hash)
+        try(hash) { |failure|
+          raise MapError, failure.error.message
+        }.input
       end
-      alias_method :[], :call
 
       # @param [Hash] hash
-      # @return [Boolean]
-      def valid?(hash)
-        coerce(hash).success?
+      #
+      # @return [Hash]
+      #
+      # @api private
+      def call_safe(hash)
+        try(hash) { return yield }.input
       end
-      alias_method :===, :valid?
 
       # @param [Hash] hash
+      #
       # @return [Result]
+      #
+      # @api public
       def try(hash)
         result = coerce(hash)
         return result if result.success? || !block_given?
+
         yield(result)
       end
 
       # @param meta [Boolean] Whether to dump the meta to the AST
+      #
       # @return [Array] An AST representation
+      #
+      # @api public
       def to_ast(meta: true)
         [:map,
-         [key_type.to_ast(meta: true), value_type.to_ast(meta: true),
+         [key_type.to_ast(meta: true),
+          value_type.to_ast(meta: true),
           meta ? self.meta : EMPTY_HASH]]
       end
 
       # @return [Boolean]
+      #
+      # @api public
       def constrained?
         value_type.constrained?
       end
 
       private
 
+      # @api private
       def coerce(input)
-        return failure(
-          input, "#{input.inspect} must be an instance of #{primitive}"
-        ) unless primitive?(input)
+        unless primitive?(input)
+          return failure(
+            input, CoercionError.new("#{input.inspect} must be an instance of #{primitive}")
+          )
+        end
 
-        output, failures = {}, []
+        output = {}
+        failures = []
+
+        input.each do |k, v|
+          res_k = key_type.try(k)
+          res_v = value_type.try(v)
 
-        input.each do |k,v|
-          res_k = options[:key_type].try(k)
-          res_v = options[:value_type].try(v)
           if res_k.failure?
-            failures << "input key #{k.inspect} is invalid: #{res_k.error}"
+            failures << res_k.error
           elsif output.key?(res_k.input)
-            failures << "duplicate coerced hash key #{res_k.input.inspect}"
+            failures << CoercionError.new("duplicate coerced hash key #{res_k.input.inspect}")
           elsif res_v.failure?
-            failures << "input value #{v.inspect} for key #{k.inspect} is invalid: #{res_v.error}"
+            failures << res_v.error
           else
             output[res_k.input] = res_v.input
           end
         end
 
-        return success(output) if failures.empty?
-
-        failure(input, failures)
-      end
-
-      def validate_options!
-        %i(key_type value_type).each do |opt|
-          type = send(opt)
-          next if type.is_a?(Type)
-          raise MapError, ":#{opt} must be a #{Type}, got: #{type.inspect}"
+        if failures.empty?
+          success(output)
+        else
+          failure(input, MultipleError.new(failures))
         end
       end
     end

data/lib/dry/types/meta.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Dry
+  module Types
+    # Storage for meta-data
+    #
+    # @api public
+    module Meta
+      def initialize(*args, meta: EMPTY_HASH, **options)
+        super(*args, **options)
+        @meta = meta.freeze
+      end
+
+      # @param [Hash] new_options
+      #
+      # @return [Type]
+      #
+      # @api public
+      def with(options)
+        super(meta: @meta, **options)
+      end
+
+      # @overload meta
+      #   @return [Hash] metadata associated with type
+      #
+      # @overload meta(data)
+      #   @param [Hash] new metadata to merge into existing metadata
+      #   @return [Type] new type with added metadata
+      #
+      # @api public
+      def meta(data = nil)
+        if !data
+          @meta
+        elsif data.empty?
+          self
+        else
+          with(meta: @meta.merge(data))
+        end
+      end
+
+      # Resets meta
+      #
+      # @return [Dry::Types::Type]
+      #
+      # @api public
+      def pristine
+        with(meta: EMPTY_HASH)
+      end
+    end
+  end
+end

data/lib/dry/types/module.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'dry/core/deprecations'
 require 'dry/types/builder_methods'
 
@@ -6,12 +8,15 @@ module Dry
     # Export types registered in a container as module constants.
     # @example
     #   module Types
-    #     include Dry::Types.module(:strict, :coercible, :nominal, default: :strict)
+    #     include Dry::Types(:strict, :coercible, :nominal, default: :strict)
     #   end
-    #   # Types.constants
+    #
+    #   Types.constants
     #   # => [:Class, :Strict, :Symbol, :Integer, :Float, :String, :Array, :Hash,
     #   #     :Decimal, :Nil, :True, :False, :Bool, :Date, :Nominal, :DateTime, :Range,
     #   #     :Coercible, :Time]
+    #
+    # @api public
     class Module < ::Module
       def initialize(registry, *args)
         @registry = registry
@@ -26,7 +31,7 @@ module Dry
             base.instance_exec(const_get(:Nominal, false)) do |nominal|
               extend Dry::Core::Deprecations[:'dry-types']
               const_set(:Definition, nominal)
-              deprecate_constant(:Definition, message: "Nominal")
+              deprecate_constant(:Definition, message: 'Nominal')
             end
           end
         end
@@ -88,8 +93,8 @@ module Dry
 
         (referenced.uniq - known).each do |name|
           raise ArgumentError,
-                "#{ name.inspect } is not a known type namespace. "\
-                "Supported options are #{ known.map(&:inspect).join(', ') }"
+                "#{name.inspect} is not a known type namespace. "\
+                "Supported options are #{known.map(&:inspect).join(', ')}"
         end
       end
 

data/lib/dry/types/nominal.rb

@@ -1,13 +1,22 @@
+# frozen_string_literal: true
+
 require 'dry/core/deprecations'
 require 'dry/types/builder'
 require 'dry/types/result'
 require 'dry/types/options'
+require 'dry/types/meta'
 
 module Dry
   module Types
+    # Nominal types define a primitive class and do not apply any constructors or constraints
+    #
+    # Use these types for annotations and the base for building more complex types on top of them.
+    #
+    # @api public
     class Nominal
       include Type
       include Options
+      include Meta
       include Builder
       include Printable
       include Dry::Equalizer(:primitive, :options, :meta, inspect: false)
@@ -16,7 +25,10 @@ module Dry
       attr_reader :primitive
 
       # @param [Class] primitive
+      #
       # @return [Type]
+      #
+      # @api private
       def self.[](primitive)
         if primitive == ::Array
           Types::Array
@@ -27,8 +39,12 @@ module Dry
         end
       end
 
+      ALWAYS = proc { true }
+
       # @param [Type,Class] primitive
       # @param [Hash] options
+      #
+      # @api private
       def initialize(primitive, **options)
         super
         @primitive = primitive
@@ -36,81 +52,156 @@ module Dry
       end
 
       # @return [String]
+      #
+      # @api public
       def name
         primitive.name
       end
 
       # @return [false]
+      #
+      # @api public
       def default?
         false
       end
 
       # @return [false]
+      #
+      # @api public
       def constrained?
         false
       end
 
       # @return [false]
+      #
+      # @api public
       def optional?
         false
       end
 
       # @param [BasicObject] input
+      #
+      # @return [BasicObject]
+      #
+      # @api private
+      def call_unsafe(input)
+        input
+      end
+
+      # @param [BasicObject] input
+      #
       # @return [BasicObject]
-      def call(input)
+      #
+      # @api private
+      def call_safe(input)
         input
       end
-      alias_method :[], :call
 
       # @param [Object] input
       # @param [#call,nil] block
+      #
       # @yieldparam [Failure] failure
       # @yieldreturn [Result]
+      #
       # @return [Result,Logic::Result] when a block is not provided
       # @return [nil] otherwise
-      def try(input, &block)
-        if valid?(input)
-          success(input)
-        else
-          failure = failure(input, "#{input.inspect} must be an instance of #{primitive}")
-          block ? yield(failure) : failure
-        end
+      #
+      # @api public
+      def try(input)
+        success(input)
       end
 
       # @param (see Dry::Types::Success#initialize)
+      #
       # @return [Result::Success]
+      #
+      # @api public
       def success(input)
         Result::Success.new(input)
       end
 
       # @param (see Failure#initialize)
+      #
       # @return [Result::Failure]
+      #
+      # @api public
       def failure(input, error)
+        raise ArgumentError, 'error must be a CoercionError' unless error.is_a?(CoercionError)
+
         Result::Failure.new(input, error)
       end
 
       # Checks whether value is of a #primitive class
+      #
       # @param [Object] value
+      #
       # @return [Boolean]
+      #
+      # @api public
       def primitive?(value)
         value.is_a?(primitive)
       end
-      alias_method :valid?, :primitive?
-      alias_method :===, :primitive?
+
+      # @api private
+      def coerce(input, &_block)
+        if primitive?(input)
+          input
+        elsif block_given?
+          yield
+        else
+          raise CoercionError, "#{input.inspect} must be an instance of #{primitive}"
+        end
+      end
+
+      # @api private
+      def try_coerce(input)
+        result = success(input)
+
+        coerce(input) do
+          result = failure(
+            input,
+            CoercionError.new("#{input.inspect} must be an instance of #{primitive}")
+          )
+        end
+
+        if block_given?
+          yield(result)
+        else
+          result
+        end
+      end
 
       # Return AST representation of a type nominal
       #
-      # @api public
-      #
       # @return [Array]
+      #
+      # @api public
       def to_ast(meta: true)
         [:nominal, [primitive, meta ? self.meta : EMPTY_HASH]]
       end
+
+      # Return self. Nominal types are lax by definition
+      #
+      # @return [Nominal]
+      #
+      # @api public
+      def lax
+        self
+      end
+
+      # Wrap the type with a proc
+      #
+      # @return [Proc]
+      #
+      # @api public
+      def to_proc
+        ALWAYS
+      end
     end
 
     extend Dry::Core::Deprecations[:'dry-types']
     Definition = Nominal
-    deprecate_constant(:Definition, message: "Nominal")
+    deprecate_constant(:Definition, message: 'Nominal')
   end
 end