dry-types 0.15.0 → 1.2.0

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'
 end
+
+Dry::Types.register_extension(:monads) do
+  require 'dry/types/extensions/monads'
+end

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

@@ -1,31 +1,58 @@
+# frozen_string_literal: true
+
 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, inspect: false)
       include Decorator
       include Builder
+      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, &block)
         case input
         when Dry::Monads::Maybe
           input
         when Undefined
           None()
         else
-          Maybe(type[input])
+          Maybe(type.call_safe(input, &block))
         end
       end
-      alias_method :[], :call
 
       # @param [Object] input
+      #
       # @return [Result::Success]
+      #
+      # @api public
       def try(input = Undefined)
         res = if input.equal?(Undefined)
                 None()
@@ -37,16 +64,22 @@ module Dry
       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"
+          raise ArgumentError, 'nil cannot be used as a default of a maybe type'
         else
           super
         end
@@ -54,18 +87,32 @@ module Dry
     end
 
     module Builder
+      # Turn a type into a maybe type
+      #
       # @return [Maybe]
+      #
+      # @api public
       def maybe
         Maybe.new(Types['strict.nil'] | self)
       end
     end
 
+    # @api private
+    class Schema::Key
+      # @api private
+      def maybe
+        __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 }>"
+          yield "Maybe<#{type}>"
         end
       end
     end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'dry/monads/result'
+
+module Dry
+  module Types
+    # Monad extension for Result
+    #
+    # @api public
+    class Result
+      include Dry::Monads::Result::Mixin
+
+      # Turn result into a monad
+      #
+      # This makes result objects work with dry-monads (or anything with a compatible interface)
+      #
+      # @return [Dry::Monads::Success,Dry::Monads::Failure]
+      #
+      # @api public
+      def to_monad
+        if success?
+          Success(input)
+        else
+          Failure([error, input])
+        end
+      end
+    end
+  end
+end

data/lib/dry/types/fn_container.rb

@@ -1,7 +1,12 @@
+# frozen_string_literal: true
+
 require 'dry/types/container'
 
 module Dry
   module Types
+    # Internal container for constructor functions used by the built-in types
+    #
+    # @api private
     class FnContainer
       # @api private
       def self.container

data/lib/dry/types/hash.rb

@@ -1,18 +1,26 @@
+# frozen_string_literal: true
+
 require 'dry/types/hash/constructor'
 
 module Dry
   module Types
+    # Hash types can be used to define maps and schemas
+    #
+    # @api public
     class Hash < Nominal
       NOT_REQUIRED = { required: false }.freeze
 
-      # @overload schmea(type_map, meta = EMPTY_HASH)
+      # @overload schema(type_map, meta = EMPTY_HASH)
       #   @param [{Symbol => Dry::Types::Nominal}] type_map
       #   @param [Hash] meta
       #   @return [Dry::Types::Schema]
+      #
       # @overload schema(keys)
       #   @param [Array<Dry::Types::Schema::Key>] key List of schema keys
       #   @param [Hash] meta
       #   @return [Dry::Types::Schema]
+      #
+      # @api public
       def schema(keys_or_map, meta = EMPTY_HASH)
         if keys_or_map.is_a?(::Array)
           keys = keys_or_map
@@ -27,7 +35,10 @@ module Dry
       #
       # @param [Type] key_type
       # @param [Type] value_type
+      #
       # @return [Map]
+      #
+      # @api public
       def map(key_type, value_type)
         Map.new(
           primitive,
@@ -37,11 +48,10 @@ module Dry
         )
       end
 
-      # @param [{Symbol => Nominal}] type_map
-      # @return [Schema]
+      # @api private
       def weak(*)
-        raise "Support for old hash schemas was removed, please refer to the CHANGELOG "\
-              "on how to proceed with the new API https://github.com/dry-rb/dry-types/blob/master/CHANGELOG.md"
+        raise 'Support for old hash schemas was removed, please refer to the CHANGELOG '\
+              'on how to proceed with the new API https://github.com/dry-rb/dry-types/blob/master/CHANGELOG.md'
       end
       alias_method :permissive, :weak
       alias_method :strict, :weak
@@ -49,15 +59,17 @@ module Dry
       alias_method :symbolized, :weak
 
       # Injects a type transformation function for building schemas
+      #
       # @param [#call,nil] proc
       # @param [#call,nil] block
+      #
       # @return [Hash]
+      #
+      # @api public
       def with_type_transform(proc = nil, &block)
         fn = proc || block
 
-        if fn.nil?
-          raise ArgumentError, "a block or callable argument is required"
-        end
+        raise ArgumentError, 'a block or callable argument is required' if fn.nil?
 
         handle = Dry::Types::FnContainer.register(fn)
         with(type_transform_fn: handle)
@@ -69,20 +81,25 @@ module Dry
       end
 
       # Whether the type transforms types of schemas created by {Dry::Types::Hash#schema}
+      #
       # @return [Boolean]
+      #
       # @api public
       def transform_types?
         !options[:type_transform_fn].nil?
       end
 
       # @param meta [Boolean] Whether to dump the meta to the AST
+      #
       # @return [Array] An AST representation
+      #
+      # @api public
       def to_ast(meta: true)
-        if RUBY_VERSION >= "2.5"
-          opts = options.slice(:type_transform_fn)
-        else
-          opts = options.select { |k, _| k == :type_transform_fn }
-        end
+        opts = if RUBY_VERSION >= '2.5'
+                 options.slice(:type_transform_fn)
+               else
+                 options.select { |k, _| k == :type_transform_fn }
+               end
 
         [:hash, [opts, meta ? self.meta : EMPTY_HASH]]
       end
@@ -104,7 +121,8 @@ module Dry
       # @api private
       def resolve_type(type)
         case type
-        when String, Class then Types[type]
+        when Type then type
+        when ::Class, ::String then Types[type]
         else type
         end
       end

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

@@ -1,7 +1,12 @@
+# frozen_string_literal: true
+
 require 'dry/types/constructor'
 
 module Dry
   module Types
+    # Hash type exposes additional APIs for working with schema hashes
+    #
+    # @api public
     class Hash < Nominal
       class Constructor < ::Dry::Types::Constructor
         # @api private
@@ -9,10 +14,18 @@ module Dry
           ::Dry::Types::Hash::Constructor
         end
 
-        private
+        # @return [Lax]
+        #
+        # @api public
+        def lax
+          type.lax.constructor(fn, meta: meta)
+        end
 
-        def composable?(value)
-          super && !value.is_a?(Schema::Key)
+        # @see Dry::Types::Array#of
+        #
+        # @api public
+        def schema(*args)
+          type.schema(*args).constructor(fn, meta: meta)
         end
       end
     end

data/lib/dry/types/inflector.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'dry/inflector'
 
 module Dry

data/lib/dry/types/json.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'dry/types/coercions/json'
 
 module Dry
@@ -22,12 +24,12 @@ module Dry
       self['nominal.decimal'].constructor(Coercions::JSON.method(:to_decimal))
     end
 
-    register('json.array') do
-      self['nominal.array'].safe
+    register('json.symbol') do
+      self['nominal.symbol'].constructor(Coercions::JSON.method(:to_symbol))
     end
 
-    register('json.hash') do
-      self['nominal.hash'].safe
-    end
+    register('json.array') { self['array'] }
+
+    register('json.hash') { self['hash'] }
   end
 end

data/lib/dry/types/{safe.rb → lax.rb}

@@ -1,61 +1,78 @@
+# frozen_string_literal: true
+
+require 'dry/core/deprecations'
 require 'dry/types/decorator'
 
 module Dry
   module Types
-    class Safe
+    # Lax types rescue from type-related errors when constructors fail
+    #
+    # @api public
+    class Lax
       include Type
       include Decorator
       include Builder
       include Printable
       include Dry::Equalizer(:type, inspect: false)
 
-      private :options, :meta
+      undef :options, :constructor
 
       # @param [Object] input
+      #
       # @return [Object]
+      #
+      # @api public
       def call(input)
-        result = try(input)
-
-        if result.respond_to?(:input)
-          result.input
-        else
-          input
-        end
+        type.call_safe(input) { |output = input| output }
       end
       alias_method :[], :call
+      alias_method :call_safe, :call
+      alias_method :call_unsafe, :call
 
       # @param [Object] input
       # @param [#call,nil] block
+      #
       # @yieldparam [Failure] failure
       # @yieldreturn [Result]
+      #
       # @return [Result,Logic::Result]
+      #
+      # @api public
       def try(input, &block)
         type.try(input, &block)
-      rescue TypeError, ArgumentError => e
+      rescue CoercionError => e
         result = failure(input, e.message)
         block ? yield(result) : result
       end
 
-      # @api public
-      #
       # @see Nominal#to_ast
+      #
+      # @api public
       def to_ast(meta: true)
-        [:safe, [type.to_ast(meta: meta), EMPTY_HASH]]
+        [:lax, type.to_ast(meta: meta)]
       end
 
+      # @return [Lax]
+      #
       # @api public
-      # @return [Safe]
-      def safe
+      def lax
         self
       end
 
       private
 
       # @param [Object, Dry::Types::Constructor] response
+      #
       # @return [Boolean]
+      #
+      # @api private
       def decorate?(response)
-        super || response.kind_of?(Constructor)
+        super || response.is_a?(type.constructor_type)
       end
     end
+
+    extend ::Dry::Core::Deprecations[:'dry-types']
+    Safe = Lax
+    deprecate_constant(:Safe)
   end
 end