dry-types 0.13.2 → 1.5.1

data/LICENSE

@@ -1,20 +1,20 @@
-Copyright (c) 2013-2014 Piotr Solnica
+The MIT License (MIT)
 
-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 the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
+Copyright (c) 2015-2021 dry-rb team
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+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
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,27 +1,29 @@
 [gem]: https://rubygems.org/gems/dry-types
-[travis]: https://travis-ci.org/dry-rb/dry-types
-[codeclimate]: https://codeclimate.com/github/dry-rb/dry-types
-[coveralls]: https://coveralls.io/r/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://gitter.im/dry-rb/chat](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/dry-rb/chat)
+# 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.org/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,42 +1,42 @@
-lib = File.expand_path('../lib', __FILE__)
+# 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)
 require 'dry/types/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "dry-types"
-  spec.version       = Dry::Types::VERSION.dup
+  spec.name          = 'dry-types'
   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"
-  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.2.0"
+  spec.required_ruby_version = ">= 2.5.0"
 
-  spec.add_runtime_dependency 'concurrent-ruby', '~> 1.0'
-  spec.add_runtime_dependency 'dry-core', '~> 0.4', '>= 0.4.4'
-  spec.add_runtime_dependency 'dry-inflector', '~> 0.1', '>= 0.1.2'
-  spec.add_runtime_dependency 'dry-container', '~> 0.3'
-  spec.add_runtime_dependency 'dry-equalizer', '~> 0.2'
-  spec.add_runtime_dependency 'dry-logic', '~> 0.4', '>= 0.4.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", "~> 1.6"
-  spec.add_development_dependency "rake", "~> 11.0"
-  spec.add_development_dependency "rspec", "~> 3.3"
-  spec.add_development_dependency 'dry-monads', '~> 0.2'
-  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 +1,3 @@
-require 'dry/types'
+# frozen_string_literal: true
+
+require "dry/types"

data/lib/dry/types.rb

@@ -1,81 +1,94 @@
-require 'bigdecimal'
-require 'date'
-require 'set'
+# frozen_string_literal: true
 
-require 'concurrent'
+require "bigdecimal"
+require "date"
+require "set"
 
-require 'dry-container'
-require 'dry-equalizer'
-require 'dry/core/extensions'
-require 'dry/core/constants'
-require 'dry/core/class_attributes'
+require "concurrent/map"
 
-require 'dry/types/version'
-require 'dry/types/container'
-require 'dry/types/inflector'
-require 'dry/types/type'
-require 'dry/types/definition'
-require 'dry/types/constructor'
-require 'dry/types/builder_methods'
+require "dry/container"
+require "dry/core/extensions"
+require "dry/core/constants"
+require "dry/core/class_attributes"
 
-require 'dry/types/errors'
+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"
 
 module Dry
+  # Main library namespace
+  #
+  # @api public
   module Types
     extend Dry::Core::Extensions
     extend Dry::Core::ClassAttributes
+    extend Dry::Core::Deprecations[:'dry-types']
     include Dry::Core::Constants
 
-    # @!attribute [r] namespace
-    #   @return [Container{String => Definition}]
-    defines :namespace
-
-    namespace self
-
-    TYPE_SPEC_REGEX = %r[(.+)<(.+)>].freeze
+    TYPE_SPEC_REGEX = /(.+)<(.+)>/.freeze
 
-    # @return [Module]
-    def self.module
-      namespace = Module.new
-      define_constants(namespace, type_keys)
-      namespace.extend(BuilderMethods)
-      namespace
+    # @see Dry.Types
+    def self.module(*namespaces, default: :nominal, **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
+    DEPRECATION
 
-    # @deprecated Include {Dry::Types.module} instead
-    def self.finalize
-      warn 'Dry::Types.finalize and configuring namespace is deprecated. Just'\
-       ' do `include Dry::Types.module` in places where you want to have access'\
-       ' to built-in types'
-
-      define_constants(self.namespace, type_keys)
+    # @api private
+    def self.included(*)
+      raise "Import Dry.Types, not Dry::Types"
     end
 
-    # @return [Container{String => Definition}]
+    # Return container with registered built-in type objects
+    #
+    # @return [Container{String => Nominal}]
+    #
+    # @api private
     def self.container
       @container ||= Container.new
     end
 
+    # Check if a give type is registered
+    #
+    # @return [Boolean]
+    #
     # @api private
     def self.registered?(class_or_identifier)
       container.key?(identifier(class_or_identifier))
     end
 
+    # Register a new built-in type
+    #
     # @param [String] name
     # @param [Type] type
     # @param [#call,nil] block
-    # @return [Container{String => Definition}]
+    #
+    # @return [Container{String => Nominal}]
+    #
     # @api private
     def self.register(name, type = nil, &block)
       container.register(name, type || block.call)
     end
 
+    # Get a built-in type by its name
+    #
     # @param [String,Class] name
+    #
     # @return [Type,Class]
+    #
+    # @api public
     def self.[](name)
       type_map.fetch_or_store(name) do
         case name
-        when String
+        when ::String
           result = name.match(TYPE_SPEC_REGEX)
 
           if result
@@ -84,7 +97,12 @@ module Dry
           else
             container[name]
           end
-        when Class
+        when ::Class
+          warn(<<~DEPRECATION)
+            Using Dry::Types.[] with a class is deprecated, please use string identifiers: Dry::Types[Integer] -> Dry::Types['integer'].
+            If you're using dry-struct this means changing `attribute :counter, Integer` to `attribute :counter, Dry::Types['integer']` or to `attribute :counter, 'integer'`.
+          DEPRECATION
+
           type_name = identifier(name)
 
           if container.key?(type_name)
@@ -96,58 +114,120 @@ module Dry
       end
     end
 
-    # @param [Module] namespace
-    # @param [<String>] identifiers
-    # @return [<Definition>]
-    def self.define_constants(namespace, identifiers)
-      names = identifiers.map do |id|
-        parts = id.split('.')
-        [Inflector.camelize(parts.pop), parts.map(&Inflector.method(:camelize))]
-      end
-
-      names.map do |(klass, parts)|
-        mod = parts.reduce(namespace) do |a, e|
-          a.constants.include?(e.to_sym) ? a.const_get(e) : a.const_set(e, Module.new)
-        end
-
-        mod.const_set(klass, self[identifier((parts + [klass]).join('::'))])
-      end
-    end
-
+    # Infer a type identifier from the provided class
+    #
     # @param [#to_s] klass
+    #
     # @return [String]
     def self.identifier(klass)
-      Inflector.underscore(klass).tr('/', '.')
+      Inflector.underscore(klass).tr("/", ".")
     end
 
+    # Cached type map
+    #
     # @return [Concurrent::Map]
+    #
+    # @api private
     def self.type_map
-      @type_map ||= Concurrent::Map.new
+      @type_map ||= ::Concurrent::Map.new
     end
 
-    # List of type keys defined in {Dry::Types.container}
-    # @return [<String>]
-    def self.type_keys
-      container.keys
-    end
-
-    private
-
     # @api private
     def self.const_missing(const)
       underscored = Inflector.underscore(const)
 
-      if type_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["strict.integer"] '\
-              'or generate a module with types using Dry::Types.module'
+      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()"
       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
+  #
+  # @example no options
+  #
+  #   module Types
+  #     # imports all types as constants, uses modules for namespaces
+  #     include Dry::Types()
+  #   end
+  #   # strict types are exported by default
+  #   Types::Integer
+  #   # => #<Dry::Types[Constrained<Nominal<Integer> rule=[type?(Integer)]>]>
+  #   Types::Nominal::Integer
+  #   # => #<Dry::Types[Nominal<Integer>]>
+  #
+  # @example changing default types
+  #
+  #   module Types
+  #     include Dry::Types(default: :nominal)
+  #   end
+  #   Types::Integer
+  #   # => #<Dry::Types[Nominal<Integer>]>
+  #
+  # @example cherry-picking namespaces
+  #
+  #   module Types
+  #     include Dry::Types(:strict, :coercible)
+  #   end
+  #   # cherry-picking discards default types,
+  #   # provide the :default option along with the list of
+  #   # namespaces if you want the to be exported
+  #   Types.constants # => [:Coercible, :Strict]
+  #
+  # @example custom names
+  #   module Types
+  #     include Dry::Types(coercible: :Kernel)
+  #   end
+  #   Types::Kernel::Integer
+  #   # => #<Dry::Types[Constructor<Nominal<Integer> fn=Kernel.Integer>]>
+  #
+  # @param [Array<Symbol>] namespaces List of type namespaces to export
+  # @param [Symbol] default Default namespace to export
+  # @param [Hash{Symbol => Symbol}] aliases Optional renamings, like strict: :Draconian
+  #
+  # @return [Dry::Types::Module]
+  #
+  # @see Dry::Types::Module
+  #
+  # @api public
+  #
+  def self.Types(*namespaces, default: Types::Undefined, **aliases)
+    Types::Module.new(Types.container, *namespaces, default: default, **aliases)
   end
 end
 
-require 'dry/types/core' # load built-in types
-require 'dry/types/extensions'
+require "dry/types/core" # load built-in types
+require "dry/types/extensions"
+require "dry/types/printer"