dry-types 1.2.2 → 1.3.0

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015-2019 dry-rb team
+Copyright (c) 2015-2020 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,27 +1,29 @@
 [gem]: https://rubygems.org/gems/dry-types
-[ci]: https://github.com/dry-rb/dry-types/actions?query=workflow%3Aci
-[codeclimate]: https://codeclimate.com/github/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://github.com/dry-rb/dry-types/workflows/ci/badge.svg)][ci]
-[![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.3'
-  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

@@ -133,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/builder.rb

@@ -129,6 +129,10 @@ module Dry
       def constructor(constructor = nil, **options, &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/constructor/function.rb

@@ -15,7 +15,7 @@ module Dry
         class Safe < Function
           def call(input, &block)
             @fn.(input, &block)
-          rescue NoMethodError, TypeError, ArgumentError => e
+          rescue ::NoMethodError, ::TypeError, ::ArgumentError => e
             CoercionError.handle(e, &block)
           end
         end
@@ -30,7 +30,7 @@ module Dry
           #
           # @return [Function]
           def self.call_class(method, public, safe)
-            @cache.fetch_or_store([method, public, safe].hash) do
+            @cache.fetch_or_store([method, public, safe]) do
               if public
                 ::Class.new(PublicCall) do
                   include PublicCall.call_interface(method, safe)
@@ -53,7 +53,7 @@ module Dry
             #
             # @return [::Module]
             def self.call_interface(method, safe)
-              @interfaces.fetch_or_store([method, safe].hash) do
+              @interfaces.fetch_or_store([method, safe]) do
                 ::Module.new do
                   if safe
                     module_eval(<<~RUBY, __FILE__, __LINE__ + 1)
@@ -65,7 +65,7 @@ module Dry
                     module_eval(<<~RUBY, __FILE__, __LINE__ + 1)
                       def call(input, &block)
                         @target.#{method}(input)
-                      rescue NoMethodError, TypeError, ArgumentError => error
+                      rescue ::NoMethodError, ::TypeError, ::ArgumentError => error
                         CoercionError.handle(error, &block)
                       end
                     RUBY
@@ -90,7 +90,7 @@ module Dry
           class PrivateSafeCall < PrivateCall
             def call(input, &block)
               @target.send(@name, input)
-            rescue NoMethodError, TypeError, ArgumentError => e
+            rescue ::NoMethodError, ::TypeError, ::ArgumentError => e
               CoercionError.handle(e, &block)
             end
           end
@@ -121,7 +121,7 @@ module Dry
         # @param [#call] fn
         # @return [Function]
         def self.[](fn)
-          raise ArgumentError, 'Missing constructor block' if fn.nil?
+          raise ::ArgumentError, 'Missing constructor block' if fn.nil?
 
           if fn.is_a?(Function)
             fn
@@ -146,7 +146,7 @@ module Dry
           last_arg.equal?(:block)
         end
 
-        include Dry::Equalizer(:fn, immutable: true)
+        include ::Dry::Equalizer(:fn, immutable: true)
 
         attr_reader :fn
 
@@ -163,36 +163,22 @@ module Dry
         # @return [Array]
         def to_ast
           if fn.is_a?(::Proc)
-            [:id, Dry::Types::FnContainer.register(fn)]
+            [:id, FnContainer.register(fn)]
           else
             [:callable, fn]
           end
         end
 
-        if RUBY_VERSION >= '2.6'
-          # @return [Function]
-          def >>(other)
-            proc = other.is_a?(::Proc) ? other : other.fn
-            Function[@fn >> proc]
-          end
-
-          # @return [Function]
-          def <<(other)
-            proc = other.is_a?(::Proc) ? other : other.fn
-            Function[@fn << proc]
-          end
-        else
-          # @return [Function]
-          def >>(other)
-            proc = other.is_a?(::Proc) ? other : other.fn
-            Function[-> x { proc[@fn[x]] }]
-          end
+        # @return [Function]
+        def >>(other)
+          f = Function[other]
+          Function[-> x, &b { f.(self.(x, &b), &b) }]
+        end
 
-          # @return [Function]
-          def <<(other)
-            proc = other.is_a?(::Proc) ? other : other.fn
-            Function[-> x { @fn[proc[x]] }]
-          end
+        # @return [Function]
+        def <<(other)
+          f = Function[other]
+          Function[-> x, &b { self.(f.(x, &b), &b) }]
         end
       end
     end

data/lib/dry/types/core.rb

@@ -72,7 +72,9 @@ module Dry
 
     # Register optional strict {NON_NIL} types
     NON_NIL.each_key do |name|
-      register("optional.strict.#{name}", self["strict.#{name}"].optional)
+      type = self[name.to_s].optional
+      register("optional.strict.#{name}", type)
+      register("optional.#{name}", type)
     end
 
     # Register optional {COERCIBLE} types

data/lib/dry/types/decorator.rb

@@ -44,13 +44,6 @@ module Dry
         type.constrained?
       end
 
-      # @return [Sum]
-      #
-      # @api public
-      def optional
-        Types['strict.nil'] | self
-      end
-
       # @param [Symbol] meth
       # @param [Boolean] include_private
       #

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

@@ -10,11 +10,11 @@ module Dry
     # @api public
     class Maybe
       include Type
-      include Dry::Equalizer(:type, :options, inspect: false, immutable: true)
+      include ::Dry::Equalizer(:type, :options, inspect: false, immutable: true)
       include Decorator
       include Builder
       include Printable
-      include Dry::Monads::Maybe::Mixin
+      include ::Dry::Monads::Maybe::Mixin
 
       # @param [Dry::Monads::Maybe, Object] input
       #
@@ -23,7 +23,7 @@ module Dry
       # @api private
       def call_unsafe(input = Undefined)
         case input
-        when Dry::Monads::Maybe
+        when ::Dry::Monads::Maybe
           input
         when Undefined
           None()
@@ -37,14 +37,14 @@ module Dry
       # @return [Dry::Monads::Maybe]
       #
       # @api private
-      def call_safe(input = Undefined, &block)
+      def call_safe(input = Undefined)
         case input
-        when Dry::Monads::Maybe
+        when ::Dry::Monads::Maybe
           input
         when Undefined
           None()
         else
-          Maybe(type.call_safe(input, &block))
+          Maybe(type.call_safe(input) { |output = input| return yield(output) })
         end
       end
 
@@ -54,13 +54,13 @@ module Dry
       #
       # @api public
       def try(input = Undefined)
-        res = if input.equal?(Undefined)
-                None()
-              else
-                Maybe(type[input])
-              end
+        result = type.try(input)
 
-        Result::Success.new(res)
+        if result.success?
+          Result::Success.new(Maybe(result.input))
+        else
+          result
+        end
       end
 
       # @return [true]
@@ -93,7 +93,7 @@ module Dry
       #
       # @api public
       def maybe
-        Maybe.new(Types['strict.nil'] | self)
+        Maybe.new(Types['nil'] | self)
       end
     end
 
@@ -119,7 +119,7 @@ module Dry
 
     # Register non-coercible maybe types
     NON_NIL.each_key do |name|
-      register("maybe.strict.#{name}", self["strict.#{name}"].maybe)
+      register("maybe.strict.#{name}", self[name.to_s].maybe)
     end
 
     # Register coercible maybe types

data/lib/dry/types/lax.rb

@@ -15,7 +15,7 @@ module Dry
       include Printable
       include Dry::Equalizer(:type, inspect: false, immutable: true)
 
-      undef :options, :constructor
+      undef :options, :constructor, :<<, :>>, :prepend, :append
 
       # @param [Object] input
       #
@@ -40,9 +40,6 @@ module Dry
       # @api public
       def try(input, &block)
         type.try(input, &block)
-      rescue CoercionError => e
-        result = failure(input, e.message)
-        block ? yield(result) : result
       end
 
       # @see Nominal#to_ast

data/lib/dry/types/meta.rb

@@ -28,8 +28,8 @@ module Dry
       #   @return [Type] new type with added metadata
       #
       # @api public
-      def meta(data = nil)
-        if !data
+      def meta(data = Undefined)
+        if Undefined.equal?(data)
           @meta
         elsif data.empty?
           self

data/lib/dry/types/params.rb

@@ -58,6 +58,7 @@ module Dry
 
     COERCIBLE.each_key do |name|
       next if name.equal?(:string)
+
       register("optional.params.#{name}", self['params.nil'] | self["params.#{name}"])
     end
   end

data/lib/dry/types/result.rb

@@ -8,7 +8,7 @@ module Dry
     #
     # @api public
     class Result
-      include Dry::Equalizer(:input, inspect: false, immutable: true)
+      include ::Dry::Equalizer(:input, immutable: true)
 
       # @return [Object]
       attr_reader :input
@@ -43,7 +43,7 @@ module Dry
       #
       # @api public
       class Failure < Result
-        include Dry::Equalizer(:input, :error, inspect: false, immutable: true)
+        include ::Dry::Equalizer(:input, :error, immutable: true)
 
         # @return [#to_s]
         attr_reader :error

data/lib/dry/types/schema.rb

@@ -145,7 +145,7 @@ module Dry
       #
       # @api public
       def to_ast(meta: true)
-        if RUBY_VERSION >= "2.5"
+        if RUBY_VERSION >= '2.5'
           opts = options.slice(:key_transform_fn, :type_transform_fn, :strict)
         else
           opts = options.select { |k, _|
@@ -179,7 +179,7 @@ module Dry
         with(strict: strict)
       end
 
-      # Injects a key transformation function
+      # Inject a key transformation function
       #
       # @param [#call,nil] proc
       # @param [#call,nil] block
@@ -284,6 +284,27 @@ module Dry
         Lax.new(schema(keys.map(&:lax)))
       end
 
+      # Merge given schema keys into current schema
+      #
+      # A new instance is returned.
+      #
+      # @param schema [Schema]
+      # @return [Schema]
+      #
+      # @api public
+      def merge(other)
+        schema(other.keys)
+      end
+
+      # Empty schema with the same options
+      #
+      # @return [Schema]
+      #
+      # @api public
+      def clear
+        with(keys: EMPTY_ARRAY)
+      end
+
       private
 
       # @param [Array<Dry::Types::Schema::Keys>] keys