dry-types 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f734c560178356c131ffab93f54a26d5e3cd48c0493c5defba166773fa17d992
-  data.tar.gz: 3920839f32bbe474d2e99776dc631bfa079139b099aeb9cbb3c00c45f0e56cbf
+  metadata.gz: 8ffbb2a3ad9a5c532228eccc2c56690e1e7ea8808b579a140f804a46a5263d69
+  data.tar.gz: 04e2f92495290236be6daf9be2963649f5350c38f69c16a992649610986bbe5e
 SHA512:
-  metadata.gz: 86397faca01543a8836b9d48f6c5bb70084c51219651f137e308d968de42e1f04cb2a8f3b53e3aa362537a35818a0ba54c3fa731521a87e33e62afc2f5ac94d8
-  data.tar.gz: 8b97e1b888936595ef5808a6d5ad6ef5d9e0cf0f52c44f5802831e8dbd1c6bbba2ef4a60ad896b505ed086869ba8977bc87a8053aff10b582ab16316f5829900
+  metadata.gz: 53f6b6604552a3dacfbfdb64713e8cfdbc47e51b0b0061b6ab186c948ec207b7159c2a076dd17dead3f4d55e4cc300d2133831590f6b56105ac0754bbfd36e99
+  data.tar.gz: d7050f2070155e72c560f35392121d0de222da270495cbf7f65f0b7c9dcb91f9d9c3db20b119b9a9f1a62c8fae58e49474beaebf81b7df47095cf518607df25c

data/CHANGELOG.md

@@ -1,3 +1,71 @@
+<!--- DO NOT EDIT THIS FILE - IT'S AUTOMATICALLY GENERATED VIA DEVTOOLS --->
+
+## 1.5.0 2020-01-21
+
+
+### Added
+
+- Wrapping constructor types :tada: (@flash-gordon)
+
+  Constructor blocks can have a second argument.
+  The second argument is the underlying type itself:
+  ```ruby
+  age_from_year = Dry::Types['coercible.integer'].constructor do |input, type|
+    Date.today.year - type.(input)
+  end
+  age_from_year.('2000') # => 21
+  ```
+  With wrapping constructors you have control over "type application". You can even
+  run it more than once:
+  ```ruby
+  inc = Dry::Types['integer'].constructor(&:succ)
+  inc2x = inc.constructor { _2.(_2.(_2.(_1))) }
+  inc2x.(10) # => 13
+  ```
+- Fallbacks :tada: (@flash-gordon)
+
+  ```ruby
+  age = Dry::Types['coercible.ineger'].fallback(18)
+  age.('10') # => 10
+  age.('20') # => 20
+  age.('abc') # => 18
+  ```
+
+  Fallbacks are different from default values: the later will be evaluated
+  only when *no input* provided.
+
+  Under the hood, `.fallback` creates a wrapping constructor.
+- `params.string` as an alias for `strict.string`. This addition should be non-breaking (@flash-gordon)
+- API for defining custom type builders similar to `.default`, `.constructor`, or `.optional` (@flash-gordon)
+
+  ```ruby
+  # Making an alias for `.fallback`
+  Dry::Types.define_builder(:or) { |type, v| type.fallback(v) }
+
+  # Using new builder
+  type = Dry::Types['integer'].or(-273)
+  type.(:invalid) # => -273
+  ```
+
+### Changed
+
+- Inferring predicates from class names is deprecated. It's very unlikely your code depends on it,
+  however, if it does, you'll get an exception with instructions. (@flash-gordon)
+
+  If you don't rely on inferring, just disable it with:
+
+  ```ruby
+  Dry::Types::PredicateInferrer::Compiler.infer_predicate_by_class_name false
+  ```
+
+  Otherwise, enable it explicitly:
+
+  ```ruby
+  Dry::Types::PredicateInferrer::Compiler.infer_predicate_by_class_name true
+  ```
+
+[Compare v1.4.0...v1.5.0](https://github.com/dry-rb/dry-types/compare/v1.4.0...v1.5.0)
+
 ## 1.4.0 2020-03-09
 
 

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015-2020 dry-rb team
+Copyright (c) 2015-2021 dry-rb team
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

data/README.md

@@ -21,7 +21,7 @@
 
 This library officially supports the following Ruby versions:
 
-* MRI >= `2.4`
+* MRI >= `2.5`
 * jruby >= `9.2`
 
 ## License

data/dry-types.gemspec

@@ -25,13 +25,12 @@ Gem::Specification.new do |spec|
   spec.metadata['source_code_uri']   = 'https://github.com/dry-rb/dry-types'
   spec.metadata['bug_tracker_uri']   = 'https://github.com/dry-rb/dry-types/issues'
 
-  spec.required_ruby_version = ">= 2.4.0"
+  spec.required_ruby_version = ">= 2.5.0"
 
   # to update dependencies edit project.yml
   spec.add_runtime_dependency "concurrent-ruby", "~> 1.0"
   spec.add_runtime_dependency "dry-container", "~> 0.3"
-  spec.add_runtime_dependency "dry-core", "~> 0.4", ">= 0.4.4"
-  spec.add_runtime_dependency "dry-equalizer", "~> 0.3"
+  spec.add_runtime_dependency "dry-core", "~> 0.5", ">= 0.5"
   spec.add_runtime_dependency "dry-inflector", "~> 0.1", ">= 0.1.2"
   spec.add_runtime_dependency "dry-logic", "~> 1.0", ">= 1.0.2"
 

data/lib/dry-types.rb

@@ -1,3 +1,3 @@
 # frozen_string_literal: true
 
-require 'dry/types'
+require "dry/types"

data/lib/dry/types.rb

@@ -1,27 +1,26 @@
 # frozen_string_literal: true
 
-require 'bigdecimal'
-require 'date'
-require 'set'
+require "bigdecimal"
+require "date"
+require "set"
 
-require 'concurrent'
+require "concurrent/map"
 
-require 'dry-container'
-require 'dry-equalizer'
-require 'dry/core/extensions'
-require 'dry/core/constants'
-require 'dry/core/class_attributes'
+require "dry/container"
+require "dry/core/extensions"
+require "dry/core/constants"
+require "dry/core/class_attributes"
 
-require 'dry/types/version'
-require 'dry/types/container'
-require 'dry/types/inflector'
-require 'dry/types/type'
-require 'dry/types/printable'
-require 'dry/types/nominal'
-require 'dry/types/constructor'
-require 'dry/types/module'
+require "dry/types/version"
+require "dry/types/container"
+require "dry/types/inflector"
+require "dry/types/type"
+require "dry/types/printable"
+require "dry/types/nominal"
+require "dry/types/constructor"
+require "dry/types/module"
 
-require 'dry/types/errors'
+require "dry/types/errors"
 
 module Dry
   # Main library namespace
@@ -37,7 +36,7 @@ module Dry
 
     # @see Dry.Types
     def self.module(*namespaces, default: :nominal, **aliases)
-      Module.new(container, *namespaces, default: default, **aliases)
+      ::Module.new(container, *namespaces, default: default, **aliases)
     end
     deprecate_class_method :module, message: <<~DEPRECATION
       Use Dry.Types() instead. Beware, it exports strict types by default, for old behavior use Dry.Types(default: :nominal). See more options in the changelog
@@ -45,7 +44,7 @@ module Dry
 
     # @api private
     def self.included(*)
-      raise 'Import Dry.Types, not Dry::Types'
+      raise "Import Dry.Types, not Dry::Types"
     end
 
     # Return container with registered built-in type objects
@@ -121,7 +120,7 @@ module Dry
     #
     # @return [String]
     def self.identifier(klass)
-      Inflector.underscore(klass).tr('/', '.')
+      Inflector.underscore(klass).tr("/", ".")
     end
 
     # Cached type map
@@ -130,22 +129,49 @@ module Dry
     #
     # @api private
     def self.type_map
-      @type_map ||= Concurrent::Map.new
+      @type_map ||= ::Concurrent::Map.new
     end
 
     # @api private
     def self.const_missing(const)
       underscored = Inflector.underscore(const)
 
-      if container.keys.any? { |key| key.split('.')[0] == underscored }
-        raise NameError,
-              'dry-types does not define constants for default types. '\
+      if container.keys.any? { |key| key.split(".")[0] == underscored }
+        raise ::NameError,
+              "dry-types does not define constants for default types. "\
               'You can access the predefined types with [], e.g. Dry::Types["integer"] '\
-              'or generate a module with types using Dry.Types()'
+              "or generate a module with types using Dry.Types()"
       else
         super
       end
     end
+
+    # Add a new type builder method. This is a public API for defining custom
+    # type constructors
+    #
+    # @example simple custom type constructor
+    #   Dry::Types.define_builder(:or_nil) do |type|
+    #     type.optional.fallback(nil)
+    #   end
+    #
+    #   Dry::Types["integer"].or_nil.("foo") # => nil
+    #
+    # @example fallback alias
+    #   Dry::Types.define_builder(:or) do |type, fallback|
+    #     type.fallback(fallback)
+    #   end
+    #
+    #   Dry::Types["integer"].or(100).("foo") # => 100
+    #
+    # @param [Symbol] method
+    # @param [#call] block
+    #
+    # @api public
+    def self.define_builder(method, &block)
+      Builder.define_method(method) do |*args|
+        block.(self, *args)
+      end
+    end
   end
 
   # Export registered types as a module with constants
@@ -197,13 +223,11 @@ module Dry
   #
   # @api public
   #
-  # rubocop:disable Naming/MethodName
   def self.Types(*namespaces, default: Types::Undefined, **aliases)
     Types::Module.new(Types.container, *namespaces, default: default, **aliases)
   end
-  # rubocop:enable Naming/MethodName
 end
 
-require 'dry/types/core' # load built-in types
-require 'dry/types/extensions'
-require 'dry/types/printer'
+require "dry/types/core" # load built-in types
+require "dry/types/extensions"
+require "dry/types/printer"

data/lib/dry/types/any.rb

@@ -10,7 +10,7 @@ module Dry
     # @api public
     class AnyClass < Nominal
       def self.name
-        'Any'
+        "Any"
       end
 
       # @api private
@@ -22,7 +22,7 @@ module Dry
       #
       # @api public
       def name
-        'Any'
+        "Any"
       end
 
       # @param [Hash] new_options

data/lib/dry/types/array.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'dry/types/array/member'
-require 'dry/types/array/constructor'
+require "dry/types/array/member"
+require "dry/types/array/constructor"
 
 module Dry
   module Types

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'dry/types/constructor'
+require "dry/types/constructor"
 
 module Dry
   module Types

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'dry/types/array/constructor'
+require "dry/types/array/constructor"
 
 module Dry
   module Types

data/lib/dry/types/builder.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'dry/core/deprecations'
+require "dry/core/deprecations"
 
 module Dry
   module Types
@@ -42,7 +42,7 @@ module Dry
       #
       # @api public
       def optional
-        Types['strict.nil'] | self
+        Types["nil"] | self
       end
 
       # Turn a type into a constrained type
@@ -59,7 +59,7 @@ module Dry
       # Turn a type into a type with a default value
       #
       # @param [Object] input
-      # @param [Hash] options
+      # @option [Boolean] shared Whether it's safe to share the value across type applications
       # @param [#call,nil] block
       #
       # @raise [ConstraintError]
@@ -69,23 +69,27 @@ module Dry
       # @api public
       def default(input = Undefined, options = EMPTY_HASH, &block)
         unless input.frozen? || options[:shared]
-          where = Dry::Core::Deprecations::STACK.()
-          Dry::Core::Deprecations.warn(
+          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.'\
+            " 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 = input.equal?(Undefined) ? block : input
+        value = Undefined.default(input, block)
+        type = Default[value].new(self, value)
 
-        if value.respond_to?(:call) || 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
 
@@ -127,18 +131,62 @@ module Dry
       #
       # @api public
       def constructor(constructor = nil, **options, &block)
-        constructor_type.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/lax'
-require 'dry/types/sum'
+require "dry/types/default"
+require "dry/types/constrained"
+require "dry/types/enum"
+require "dry/types/lax"
+require "dry/types/sum"

data/lib/dry/types/builder_methods.rb

@@ -4,7 +4,6 @@ module Dry
   module Types
     # Common API for building type objects in a convenient way
     #
-    # rubocop:disable Naming/MethodName
     #
     # @api public
     module BuilderMethods
@@ -133,7 +132,7 @@ module Dry
       #
       # @return [Dry::Types::Contrained]
       def Interface(*methods)
-        methods.reduce(Types['nominal.any']) do |type, method|
+        methods.reduce(Types["nominal.any"]) do |type, method|
           type.constrained(respond_to: method)
         end
       end