dry-types 1.1.0 → 1.3.0

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-2020 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,28 +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
-[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.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.4`
+* 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,37 @@ 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.4.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.4", ">= 0.4.4"
+  spec.add_runtime_dependency "dry-equalizer", "~> 0.3"
+  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

@@ -89,7 +89,7 @@ module Dry
     def self.[](name)
       type_map.fetch_or_store(name) do
         case name
-        when String
+        when ::String
           result = name.match(TYPE_SPEC_REGEX)
 
           if result
@@ -98,7 +98,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)
@@ -128,15 +133,6 @@ module Dry
       @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
-    end
-
     # @api private
     def self.const_missing(const)
       underscored = Inflector.underscore(const)

data/lib/dry/types/any.rb

@@ -15,7 +15,7 @@ module Dry
 
       # @api private
       def initialize(**options)
-        super(::Object, options)
+        super(::Object, **options)
       end
 
       # @return [String]
@@ -30,7 +30,7 @@ module Dry
       # @return [Type]
       #
       # @api public
-      def with(new_options)
+      def with(**new_options)
         self.class.new(**options, meta: @meta, **new_options)
       end
 

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

@@ -18,7 +18,7 @@ module Dry
         # @option options [Type] :member
         #
         # @api private
-        def initialize(primitive, options = {})
+        def initialize(primitive, **options)
           @member = options.fetch(:member)
           super
         end
@@ -89,7 +89,7 @@ module Dry
               block ? yield(failure) : failure
             end
           else
-            failure = failure(input, "#{input} is not an array")
+            failure = failure(input, CoercionError.new("#{input} is not an array"))
             block ? yield(failure) : failure
           end
         end
@@ -100,7 +100,7 @@ module Dry
         #
         # @api public
         def lax
-          Lax.new(Member.new(primitive, { **options, member: member.lax }))
+          Lax.new(Member.new(primitive, **options, member: member.lax, meta: meta))
         end
 
         # @see Nominal#to_ast

data/lib/dry/types/builder.rb

@@ -127,8 +127,12 @@ module Dry
       #
       # @api public
       def constructor(constructor = nil, **options, &block)
-        constructor_type.new(with(options), fn: constructor || block)
+        constructor_type.new(with(**options), fn: constructor || block)
       end
+      alias_method :append, :constructor
+      alias_method :prepend, :constructor
+      alias_method :>>, :constructor
+      alias_method :<<, :constructor
     end
   end
 end

data/lib/dry/types/builder_methods.rb

@@ -25,7 +25,7 @@ module Dry
       #
       # @return [Dry::Types::Array]
       def Array(type)
-        self::Array.of(type)
+        Strict(::Array).of(type)
       end
 
       # Build a hash schema
@@ -34,7 +34,7 @@ module Dry
       #
       # @return [Dry::Types::Array]
       def Hash(type_map)
-        self::Hash.schema(type_map)
+        Strict(::Hash).schema(type_map)
       end
 
       # Build a type which values are instances of a given class
@@ -49,7 +49,7 @@ module Dry
       #
       # @return [Dry::Types::Type]
       def Instance(klass)
-        Nominal.new(klass).constrained(type: klass)
+        Nominal(klass).constrained(type: klass)
       end
       alias_method :Strict, :Instance
 
@@ -60,7 +60,7 @@ module Dry
       #
       # @return [Dry::Types::Type]
       def Value(value)
-        Nominal.new(value.class).constrained(eql: value)
+        Nominal(value.class).constrained(eql: value)
       end
 
       # Build a type with a single value
@@ -70,7 +70,7 @@ module Dry
       #
       # @return [Dry::Types::Type]
       def Constant(object)
-        Nominal.new(object.class).constrained(is: object)
+        Nominal(object.class).constrained(is: object)
       end
 
       # Build a constructor type
@@ -82,7 +82,15 @@ module Dry
       #
       # @return [Dry::Types::Type]
       def Constructor(klass, cons = nil, &block)
-        Nominal.new(klass).constructor(cons || block || klass.method(:new))
+        if klass.is_a?(Type)
+          if cons || block
+            klass.constructor(cons || block)
+          else
+            klass
+          end
+        else
+          Nominal(klass).constructor(cons || block || klass.method(:new))
+        end
       end
 
       # Build a nominal type
@@ -91,7 +99,13 @@ module Dry
       #
       # @return [Dry::Types::Type]
       def Nominal(klass)
-        Nominal.new(klass)
+        if klass <= ::Array
+          Array.new(klass)
+        elsif klass <= ::Hash
+          Hash.new(klass)
+        else
+          Nominal.new(klass)
+        end
       end
 
       # Build a map type
@@ -105,7 +119,7 @@ module Dry
       #
       # @return [Dry::Types::Map]
       def Map(key_type, value_type)
-        Types['nominal.hash'].map(key_type, value_type)
+        Nominal(::Hash).map(key_type, value_type)
       end
 
       # Builds a constrained nominal type accepting any value that

data/lib/dry/types/coercions.rb

@@ -39,6 +39,8 @@ module Dry
           rescue ArgumentError, RangeError => e
             CoercionError.handle(e, &block)
           end
+        elsif input.is_a?(::Date)
+          input
         elsif block_given?
           yield
         else
@@ -60,6 +62,8 @@ module Dry
           rescue ArgumentError => e
             CoercionError.handle(e, &block)
           end
+        elsif input.is_a?(::DateTime)
+          input
         elsif block_given?
           yield
         else
@@ -81,6 +85,8 @@ module Dry
           rescue ArgumentError => e
             CoercionError.handle(e, &block)
           end
+        elsif input.is_a?(::Time)
+          input
         elsif block_given?
           yield
         else

data/lib/dry/types/coercions/params.rb

@@ -14,7 +14,7 @@ module Dry
         FALSE_VALUES = %w[0 off Off OFF f false False FALSE F n no No NO N].freeze
         BOOLEAN_MAP = ::Hash[
           TRUE_VALUES.product([true]) + FALSE_VALUES.product([false])
-        ].freeze
+        ].merge(true => true, false => false).freeze
 
         extend Coercions
 

data/lib/dry/types/compiler.rb

@@ -68,12 +68,12 @@ module Dry
 
       def visit_hash(node)
         opts, meta = node
-        registry['nominal.hash'].with(opts.merge(meta: meta))
+        registry['nominal.hash'].with(**opts, meta: meta)
       end
 
       def visit_schema(node)
         keys, options, meta = node
-        registry['nominal.hash'].schema(keys.map { |key| visit(key) }).with(options.merge(meta: meta))
+        registry['nominal.hash'].schema(keys.map { |key| visit(key) }).with(**options, meta: meta)
       end
 
       def visit_json_hash(node)

data/lib/dry/types/constrained.rb

@@ -14,7 +14,7 @@ module Dry
       include Decorator
       include Builder
       include Printable
-      include Dry::Equalizer(:type, :rule, inspect: false)
+      include Dry::Equalizer(:type, :rule, inspect: false, immutable: true)
 
       # @return [Dry::Logic::Rule]
       attr_reader :rule
@@ -24,7 +24,7 @@ module Dry
       # @param [Hash] options
       #
       # @api public
-      def initialize(type, options)
+      def initialize(type, **options)
         super
         @rule = options.fetch(:rule)
       end

data/lib/dry/types/constructor.rb

@@ -10,9 +10,7 @@ module Dry
     #
     # @api public
     class Constructor < Nominal
-      include Dry::Equalizer(:type, :options, inspect: false)
-
-      private :meta
+      include Dry::Equalizer(:type, :options, inspect: false, immutable: true)
 
       # @return [#call]
       attr_reader :fn
@@ -20,7 +18,7 @@ module Dry
       # @return [Type]
       attr_reader :type
 
-      undef :constrained?
+      undef :constrained?, :meta, :optional?, :primitive, :default?, :name
 
       # @param [Builder, Object] input
       # @param [Hash] options
@@ -46,31 +44,6 @@ module Dry
         super(type, **options, fn: fn)
       end
 
-      # Return the inner type's primitive
-      #
-      # @return [Class]
-      #
-      # @api public
-      def primitive
-        type.primitive
-      end
-
-      # Return the inner type's name
-      #
-      # @return [String]
-      #
-      # @api public
-      def name
-        type.name
-      end
-
-      # @return [Boolean]
-      #
-      # @api public
-      def default?
-        type.default?
-      end
-
       # @return [Object]
       #
       # @api private
@@ -112,7 +85,7 @@ module Dry
       #
       # @api public
       def constructor(new_fn = nil, **options, &block)
-        with({**options, fn: fn >> (new_fn || block)})
+        with(**options, fn: fn >> (new_fn || block))
       end
       alias_method :append, :constructor
       alias_method :>>, :constructor
@@ -141,7 +114,7 @@ module Dry
       #
       # @api public
       def prepend(new_fn = nil, **options, &block)
-        with({**options, fn: fn << (new_fn || block)})
+        with(**options, fn: fn << (new_fn || block))
       end
       alias_method :<<, :prepend
 
@@ -150,7 +123,7 @@ module Dry
       # @return [Lax]
       # @api public
       def lax
-        Lax.new(Constructor.new(type.lax, options))
+        Lax.new(Constructor.new(type.lax, **options))
       end
 
       # Wrap the type with a proc
@@ -182,10 +155,10 @@ module Dry
       # @api private
       def method_missing(method, *args, &block)
         if type.respond_to?(method)
-          response = type.__send__(method, *args, &block)
+          response = type.public_send(method, *args, &block)
 
           if response.is_a?(Type) && type.class == response.class
-            response.constructor_type.new(response, options)
+            response.constructor_type.new(response, **options)
           else
             response
           end