dry-types 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9bb3d91a31885a317b8fda3eef46f77b283abb3781c84124cc7ca0a5a2c30104
-  data.tar.gz: 88cd356e7878080570e5fa659f1403e01d8bc8a9654b3c5cfaf568c851d8e848
+  metadata.gz: 689634e9152c629af622ef69379633b674b6c60b7f5cd87093894de7ee8ce571
+  data.tar.gz: a23593e6c4d904343dadd46f919cfead42b45fbe963995380712f4c6a8e719fd
 SHA512:
-  metadata.gz: 536386eba753a58a499c473d7f9e54da2bccf8597d80e3e225a036fb37acd886e0e9f75ceff497e81e6cb9a47141c2fdf4753f2bd521bf5a53424f768fc0cf0d
-  data.tar.gz: f74042df53c00159132ff2675206a393ca73a0d48ab84f7e6d58d56a51082e570932591279705ec993056b8e2720fd4572657b7bcb90596a16a7addaa7ac4bcf
+  metadata.gz: 88fd3e79ea403515fe242baa57c6824757bdc0b04f99054a9da2394c745cce54415fc3c260b35e49eed8a5240f78614efe92e052f6e6bde0e1f9b961a04f41ac
+  data.tar.gz: 3445b5726dd5325261965409883b6830450f3d710ae2b0a7be411b0d45cb25d3550a25827d9f0661dfbfd0fd55f15954d77335312237c3bf754ca7af5eae6079

data/CHANGELOG.md

@@ -1,8 +1,30 @@
+# 1.1.0 2019-07-02
+
+## Added
+
+- New builder method `Interface` constructs a type which accepts objects that respond to the given methods (waiting-for-dev)
+  ```ruby
+  Types = Dry.Types()
+  Types::Callable = Types.Interface(:call)
+  Types::Callable.valid?(Object.new) # => false
+  Types::Callable.valid?(proc {})    # => true
+  ```
+- New types: `coercible.symbol`, `params.symbol`, and `json.symbol`, all use `.to_sym` for coercion (waiting-for-dev)
+
+## Fixed
+
+- Converting schema keys to maybe types (flash-gordon)
+- Using `Schema#key` and `Array#member` on constuctors (flash-gordon)
+- Using `meta(omittable: true)` within `transform_types` works again but produces a warning, please migrate to `.omittable` or `.required(false)` (flash-gordon)
+- Bug with a constructror defined on top of enum (flash-gordon)
+
+[Compare v1.0.1...v1.1.0](https://github.com/dry-rb/dry-types/compare/v1.0.1...v1.1.0)
+
 # 1.0.1 2019-06-04
 
 ## Added
 
-- In the case of failure the constructor block can now pass a different value (flash-gordon)
+- In a case of failure the constructor block can now pass a different value (flash-gordon)
   ```ruby
   not_empty_string = Types::String.constructor do |value, &failure|
     value.strip.empty? ? failure.(nil) : value.strip
@@ -21,6 +43,7 @@
 
 - [BREAKING] Behavior of built-in constructor types was changed to be more strict. They will always raise an error on failed coercion (flash-gordon)
   Compare:
+
   ```ruby
   # 0.15.0
   Types::Params::Integer.('foo')
@@ -36,7 +59,9 @@
   ```ruby
   Types::Params::Integer.('foo') { :invalid } # => :invalid
   ```
+
   This makes work with coercions more straightforward and way faster.
+
 - [BREAKING] Safe types were renamed to Lax, this name better serves their purpose. The previous name is available but prints a warning (flash-gordon)
 - [BREAKING] Metadata is now pushed down to the decorated type. It is not likely you will notice a difference but this a breaking change that enables some use cases in rom related to the usage of default types in relations (flash-gordon)
 - Nominal types are now completely unconstrained. This fixes some inconsistencies when using them with constraints. `Nominal#try` will always return a successful result, for the previous behavior use `Nominal#try_coerce` or switch to strict types with passing a block to `#call` (flash-gordon)
@@ -159,6 +184,7 @@
   )
   ```
 - Key types have API for making keys omittable and back (flash-gordon)
+
   ```ruby
   # defining a base schema with optional keys
   lax_hash = Dry::Types['hash'].with_type_transform { |key| key.required(false) }
@@ -168,8 +194,10 @@
   # keys in user_schema are not required
   user_schema = lax_hash.schema(name: 'string', age: 'integer')
   ```
+
 - `Type#optional?` now recognizes more cases where `nil` is an allowed value (flash-gordon)
 - `Constructor#{prepend,append}` with `<<` and `>>` as aliases. `Constructor#append` works the same way `Constructor#constrcutor` does. `Constuctor#prepend` chains functions in the reverse order, see examples (flash-gordon)
+
   ```ruby
   to_int = Types::Coercible::Integer
   inc = to_int.append { |x| x + 2 }
@@ -178,6 +206,7 @@
   inc = to_int.prepend { |x| x + "2" }
   inc.("1") # => "1" -> "12" -> 12
   ```
+
 - Partial schema application for cases when you want to validate only a subset of keys (flash-gordon)
   This is useful when you want to update a key or two in an already-validated hash. A perfect example is `Dry::Struct#new` where this feature is now used.
   ```ruby
@@ -189,14 +218,15 @@
 
 ## Fixed
 
-* `Hash::Map` now behaves as a constrained type if its values are constrained (flash-gordon)
-* `coercible.integer` now doesn't blow up on invalid strings (exterm)
+- `Hash::Map` now behaves as a constrained type if its values are constrained (flash-gordon)
+- `coercible.integer` now doesn't blow up on invalid strings (exterm)
 
 [Compare v0.14.0...v0.15.0](https://github.com/dry-rb/dry-types/compare/v0.14.0...v0.15.0)
 
 # v0.14.1 2019-03-25
 
 ## Fixed
+
 - `coercible.integer` now doesn't blow up on invalid strings (exterm)
 
 [Compare v0.14.0...v0.14.1](https://github.com/dry-rb/dry-types/compare/v0.14.0...v0.14.1)

data/Gemfile

@@ -14,13 +14,14 @@ end
 
 group :tools do
   gem 'pry-byebug', platform: :mri
+  gem 'rubocop'
 end
 
 group :benchmarks do
+  gem 'attrio'
   gem 'benchmark-ips'
+  gem 'dry-struct'
+  gem 'fast_attributes'
   gem 'hotch'
   gem 'virtus'
-  gem 'fast_attributes'
-  gem 'attrio'
-  gem 'dry-struct'
 end

data/Rakefile

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 task :run_specs do
   require 'rspec/core'

data/benchmarks/hash_schemas.rb

@@ -7,11 +7,13 @@ require 'dry-types'
 
 module SchemaBench
   def self.hash_schema(type)
-    Dry::Types['nominal.hash'].public_send(type,
-      email:   Dry::Types['nominal.string'],
-      age:     Dry::Types['params.integer'],
-      admin:   Dry::Types['params.bool'],
-      address: Dry::Types['nominal.hash'].public_send(type,
+    Dry::Types['nominal.hash'].public_send(
+      type,
+      email: Dry::Types['nominal.string'],
+      age: Dry::Types['params.integer'],
+      admin: Dry::Types['params.bool'],
+      address: Dry::Types['nominal.hash'].public_send(
+        type,
         city: Dry::Types['nominal.string'],
         street: Dry::Types['nominal.string']
       )
@@ -31,7 +33,7 @@ module SchemaBench
     age: '20',
     admin: '1',
     address: { city: 'NYC', street: 'Street 1/2' }
-  }
+  }.freeze
 end
 
 require 'benchmark/ips'

data/benchmarks/lax_schema.rb

@@ -13,4 +13,3 @@ Benchmark.ips do |x|
   x.report("valid input") { schema.(params) }
   x.compare!
 end
-

data/benchmarks/profile_invalid_input.rb

@@ -6,7 +6,7 @@ INVALID_INPUT = {
   name: :John,
   age: '20',
   email: nil
-}
+}.freeze
 
 profile do
   10_000.times do

data/benchmarks/profile_lax_schema_valid.rb

@@ -7,7 +7,7 @@ Schema = Dry::Types['params.hash'].schema(
   age?: 'coercible.integer'
 ).lax
 
-ValidInput = { email: 'jane@doe.org', age: '19' }
+ValidInput = { email: 'jane@doe.org', age: '19' }.freeze
 
 profile do
   10_000.times do

data/benchmarks/profile_valid_input.rb

@@ -6,7 +6,7 @@ VALID_INPUT = {
   name: 'John',
   age: 20,
   email: 'john@doe.com'
-}
+}.freeze
 
 profile do
   10_000.times do

data/dry-types.gemspec

@@ -1,47 +1,47 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
+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.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.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://github.com/dry-rb/dry-types'
 
   # 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"
+    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."
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
   end
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) } - ['bin/console', 'bin/setup']
-  spec.bindir        = "exe"
+  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.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.4.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-core', '~> 0.4', '>= 0.4.4'
   spec.add_runtime_dependency 'dry-equalizer', '~> 0.2', '>= 0.2.2'
-  spec.add_runtime_dependency 'dry-logic', '~> 1.0'
+  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 "rake", "~> 11.0"
-  spec.add_development_dependency "rspec", "~> 3.3"
+  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'
 end

data/lib/dry/types.rb

@@ -33,7 +33,7 @@ module Dry
     extend Dry::Core::Deprecations[:'dry-types']
     include Dry::Core::Constants
 
-    TYPE_SPEC_REGEX = %r[(.+)<(.+)>].freeze
+    TYPE_SPEC_REGEX = /(.+)<(.+)>/.freeze
 
     # @see Dry.Types
     def self.module(*namespaces, default: :nominal, **aliases)
@@ -45,7 +45,7 @@ module Dry
 
     # @api private
     def self.included(*)
-      raise RuntimeError, "Import Dry.Types, not Dry::Types"
+      raise 'Import Dry.Types, not Dry::Types'
     end
 
     # Return container with registered built-in type objects

data/lib/dry/types/array.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'dry/types/array/member'
+require 'dry/types/array/constructor'
 
 module Dry
   module Types
@@ -24,6 +25,11 @@ module Dry
 
         Array::Member.new(primitive, **options, member: member)
       end
+
+      # @api private
+      def constructor_type
+        ::Dry::Types::Array::Constructor
+      end
     end
   end
 end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'dry/types/constructor'
+
+module Dry
+  module Types
+    # @api public
+    class Array < Nominal
+      # @api private
+      class Constructor < ::Dry::Types::Constructor
+        # @api private
+        def constructor_type
+          ::Dry::Types::Array::Constructor
+        end
+
+        # @return [Lax]
+        #
+        # @api public
+        def lax
+          Lax.new(type.lax.constructor(fn, meta: meta))
+        end
+
+        # @see Dry::Types::Array#of
+        #
+        # @api public
+        def of(member)
+          type.of(member).constructor(fn, meta: meta)
+        end
+      end
+    end
+  end
+end

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'dry/types/array/constructor'
+
 module Dry
   module Types
     class Array < Nominal
@@ -111,6 +113,11 @@ module Dry
             [:array, [member, meta ? self.meta : EMPTY_HASH]]
           end
         end
+
+        # @api private
+        def constructor_type
+          ::Dry::Types::Array::Constructor
+        end
       end
     end
   end

data/lib/dry/types/builder.rb

@@ -75,7 +75,7 @@ module Dry
             ' 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 }",
+            "\n#{where}",
             tag: :'dry-types'
           )
         end

data/lib/dry/types/builder_methods.rb

@@ -108,21 +108,21 @@ module Dry
         Types['nominal.hash'].map(key_type, value_type)
       end
 
-      # # Builds a constrained nominal type accepting any value that
-      # # responds to given methods
-      # #
-      # # @example
-      # #   Types::Callable = Types.Contract(:call)
-      # #   Types::Contact = Types.Contract(:name, :address)
-      # #
-      # # @param methods [Array<String, Symbol>] Method names
-      # #
-      # # @return [Dry::Types::Contrained]
-      # def Contract(*methods)
-      #   methods.reduce(Types['nominal.any']) do |type, method|
-      #     type.constrained(respond_to: method)
-      #   end
-      # end
+      # Builds a constrained nominal type accepting any value that
+      # responds to given methods
+      #
+      # @example
+      #   Types::Callable = Types.Interface(:call)
+      #   Types::Contact = Types.Interface(:name, :address)
+      #
+      # @param methods [Array<String, Symbol>] Method names
+      #
+      # @return [Dry::Types::Contrained]
+      def Interface(*methods)
+        methods.reduce(Types['nominal.any']) do |type, method|
+          type.constrained(respond_to: method)
+        end
+      end
     end
   end
 end

data/lib/dry/types/coercions.rb

@@ -36,8 +36,8 @@ module Dry
         if input.respond_to?(:to_str)
           begin
             ::Date.parse(input)
-          rescue ArgumentError, RangeError => error
-            CoercionError.handle(error, &block)
+          rescue ArgumentError, RangeError => e
+            CoercionError.handle(e, &block)
           end
         elsif block_given?
           yield
@@ -57,8 +57,8 @@ module Dry
         if input.respond_to?(:to_str)
           begin
             ::DateTime.parse(input)
-          rescue ArgumentError => error
-            CoercionError.handle(error, &block)
+          rescue ArgumentError => e
+            CoercionError.handle(e, &block)
           end
         elsif block_given?
           yield
@@ -78,8 +78,8 @@ module Dry
         if input.respond_to?(:to_str)
           begin
             ::Time.parse(input)
-          rescue ArgumentError => error
-            CoercionError.handle(error, &block)
+          rescue ArgumentError => e
+            CoercionError.handle(e, &block)
           end
         elsif block_given?
           yield
@@ -88,6 +88,19 @@ module Dry
         end
       end
 
+      # @param [#to_sym, Object] input
+      #
+      # @return [Symbol, Object]
+      #
+      # @raise CoercionError
+      #
+      # @api public
+      def to_symbol(input, &block)
+        input.to_sym
+      rescue NoMethodError => e
+        CoercionError.handle(e, &block)
+      end
+
       private
 
       # Checks whether String is empty