dry-types 1.2.1 → 1.5.0

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015-2019 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

@@ -1,28 +1,29 @@
 [gem]: https://rubygems.org/gems/dry-types
-[travis]: https://travis-ci.com/dry-rb/dry-types
-[codeclimate]: https://codeclimate.com/github/dry-rb/dry-types
-[coveralls]: https://coveralls.io/r/dry-rb/dry-types
-[inchpages]: http://inch-ci.org/github/dry-rb/dry-types
+[actions]: https://github.com/dry-rb/dry-types/actions
+[codacy]: https://www.codacy.com/gh/dry-rb/dry-types
 [chat]: https://dry-rb.zulipchat.com
+[inchpages]: http://inch-ci.org/github/dry-rb/dry-types
 
 # dry-types [![Join the chat at https://dry-rb.zulipchat.com](https://img.shields.io/badge/dry--rb-join%20chat-%23346b7a.svg)][chat]
 
 [![Gem Version](https://badge.fury.io/rb/dry-types.svg)][gem]
-[![Build Status](https://travis-ci.com/dry-rb/dry-types.svg?branch=master)][travis]
-[![Code Climate](https://codeclimate.com/github/dry-rb/dry-types/badges/gpa.svg)][codeclimate]
-[![Test Coverage](https://codeclimate.com/github/dry-rb/dry-types/badges/coverage.svg)][codeclimate]
+[![CI Status](https://github.com/dry-rb/dry-types/workflows/ci/badge.svg)][actions]
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/f2d71613195f4da993acb9ac9d6ea336)][codacy]
+[![Codacy Badge](https://api.codacy.com/project/badge/Coverage/f2d71613195f4da993acb9ac9d6ea336)][codacy]
 [![Inline docs](http://inch-ci.org/github/dry-rb/dry-types.svg?branch=master)][inchpages]
 
 ## Links
 
-* [Documentation](http://dry-rb.org/gems/dry-types)
+* [User documentation](http://dry-rb.org/gems/dry-types)
+* [API documentation](http://rubydoc.info/gems/dry-types)
 
-## Development
+## Supported Ruby versions
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake run_specs` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+This library officially supports the following Ruby versions:
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+* MRI >= `2.5`
+* jruby >= `9.2`
 
-## Contributing
+## License
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/dry-rb/dry-types.
+See `LICENSE` file.

data/dry-types.gemspec

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# this file is managed by dry-rb/devtools project
 
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
@@ -6,42 +7,36 @@ require 'dry/types/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'dry-types'
-  spec.version       = Dry::Types::VERSION.dup
-  spec.authors       = ['Piotr Solnica']
-  spec.email         = ['piotr.solnica@gmail.com']
+  spec.authors       = ["Piotr Solnica"]
+  spec.email         = ["piotr.solnica@gmail.com"]
   spec.license       = 'MIT'
+  spec.version       = Dry::Types::VERSION.dup
 
-  spec.summary       = 'Type system for Ruby supporting coercions, constraints and complex types like structs, value objects, enums etc.'
+  spec.summary       = "Type system for Ruby supporting coercions, constraints and complex types like structs, value objects, enums etc"
   spec.description   = spec.summary
-  spec.homepage      = 'https://github.com/dry-rb/dry-types'
+  spec.homepage      = 'https://dry-rb.org/gems/dry-types'
+  spec.files         = Dir["CHANGELOG.md", "LICENSE", "README.md", "dry-types.gemspec", "lib/**/*"]
+  spec.bindir        = 'bin'
+  spec.executables   = []
+  spec.require_paths = ['lib']
 
-  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
-  # delete this section to allow pushing this gem to any host.
-  if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
-    spec.metadata['changelog_uri'] = 'https://github.com/dry-rb/dry-types/blob/master/CHANGELOG.md'
-    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'
-  else
-    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
-  end
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  spec.metadata['changelog_uri']     = 'https://github.com/dry-rb/dry-types/blob/master/CHANGELOG.md'
+  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.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) } - ['bin/console', 'bin/setup']
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-  spec.required_ruby_version = '>= 2.4.0'
+  spec.required_ruby_version = ">= 2.5.0"
 
-  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.2', '>= 0.2.2'
-  spec.add_runtime_dependency 'dry-inflector', '~> 0.1', '>= 0.1.2'
-  spec.add_runtime_dependency 'dry-logic', '~> 1.0', '>= 1.0.2'
+  # 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.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"
 
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'dry-monads', '~> 0.2'
-  spec.add_development_dependency 'rake', '~> 11.0'
-  spec.add_development_dependency 'rspec', '~> 3.3'
-  spec.add_development_dependency 'yard', '~> 0.9.5'
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "dry-monads", "~> 1.0"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "yard"
 end

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,31 +129,49 @@ module Dry
     #
     # @api private
     def self.type_map
-      @type_map ||= Concurrent::Map.new
-    end
-
-    # List of type keys defined in {Dry::Types.container}
-    #
-    # @return [String]
-    #
-    # @api private
-    def self.type_keys
-      container.keys
+      @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
@@ -206,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,14 +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"