dry-types 0.15.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e14386ca189be49fd569c297a7d1ac385806569218fb172a63761ba0045a7fd6
-  data.tar.gz: 353f074f3cf5fe2718eb4e5eb4f3ff4273f3c565a67f2267f0b2014ba67f22dd
+  metadata.gz: '09c9bc944d01d8cb892cd29f540352981bc6e266ac7d2017cbd1827b7ca81b3c'
+  data.tar.gz: 9a652f7888d52bdc6684b9ba142792460b45c1d27157d0176c0daa322af1826f
 SHA512:
-  metadata.gz: cff40f66df4f87bee0bed14f033c49d8e6b1ffa98200f6f076def32a4bb4fdecf5906e9d3be6ee5a6cb611a21fa2f1fae6653c40ef49e3f21cfaf285ae4455b4
-  data.tar.gz: 0cdadfae930f5833efd33f8e73189b9880d4606b0ebf3f1fe0f2e948d1eec8cb4896abccd2b0e4f2d9269c92d6b5aa41c29431fb247f56337b9dc82a7d998488
+  metadata.gz: 3252ede1f749a14dfd09dcc5ab6c9872a7dc5f50cb31858712dd76f4f927d133b9ce8d03bce042bfd2bd832b5e21cae7723abf93618d6d746b38506a0aeeefc1
+  data.tar.gz: 1e71e67c449fadfa5989f211a019bf75b0c5dac6240934d819af2f4401622833e31304906f99dd8a2d9ac6e9f14a6bb07d37e2c63ce28408b7b685bd4d88a1dd

data/.gitignore

@@ -8,3 +8,4 @@
 /spec/reports/
 /tmp/
 log/
+.rubocop.yml

data/.rubocop.yml

@@ -1,6 +1,9 @@
 AllCops:
   TargetRubyVersion: 2.4
 
+Style/EachWithObject:
+  Enabled: false
+
 Style/StringLiterals:
   Enabled: true
   EnforcedStyle: single_quotes
@@ -14,12 +17,18 @@ Style/LambdaCall:
 Style/StabbyLambdaParentheses:
   Enabled: false
 
+Style/FormatString:
+  Enabled: false
+
+Layout/SpaceInLambdaLiteral:
+  Enabled: false
+
 Layout/MultilineMethodCallIndentation:
   Enabled: true
   EnforcedStyle: indented
 
-Metrics/LineLength:                                                             
-  Max: 100 
+Metrics/LineLength:
+  Max: 100
 
 Metrics/MethodLength:
   Max: 22
@@ -41,3 +50,10 @@ Metrics/CyclomaticComplexity:
 
 Lint/BooleanSymbol:
   Enabled: false
+
+Style/AccessModifierDeclarations:
+  Enabled: false
+
+Style/BlockDelimiters:
+  EnforcedStyle: semantic
+

data/.travis.yml

@@ -1,6 +1,5 @@
 language: ruby
 cache: bundler
-sudo: false
 bundler_args: --without benchmarks tools
 before_script:
   - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
@@ -11,10 +10,10 @@ after_script:
 script:
   - bundle exec rake
 rvm:
-  - 2.6.1
-  - 2.5.3
-  - 2.4.5
-  - jruby-9.2.6.0
+  - 2.6.3
+  - 2.5.5
+  - 2.4.6
+  - jruby-9.2.7.0
 env:
   global:
     - COVERAGE=true

data/.yardopts

@@ -1,5 +1,9 @@
 --title 'dry-types'
---markup markdown
+--query '@api.text != "private"'
+--embed-mixins
+--output doc
 --readme README.md
---private
+--files CHANGELOG.md
+--markup markdown
+--markup-provider=redcarpet
 lib/**/*.rb

data/CHANGELOG.md

@@ -1,3 +1,64 @@
+# 1.0.0 2019-04-23
+
+## Changed
+
+- [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')
+  # => "foo"
+
+  # 1.0.0
+  Types::Params::Integer.('foo')
+  # => Dry::Types::CoercionError: invalid value for Integer(): "foo"
+  ```
+
+  To handle coercion errors `Type#call` now yields a block:
+
+  ```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)
+
+## Performance improvements
+
+- During the work on this release, a lot of performance improvements were made. dry-types 1.0 combined with dry-logic 1.0 are multiple times faster than dry-types 0.15 and dry-logic 0.5 for common cases including constraints checking and coercion (flash-gordon)
+
+## Added
+
+- API for custom constructor types was enhanced. If you pass your own callable to `.constructor` it can have a block in its signature. If a block is passed, you must call it on failied coercion, otherwise raise a type coercion error (flash-gordon)
+  Example:
+  ```ruby
+  proc do |input, &block|
+    if input.is_a? String
+      Integer(input, 10)
+    else
+      Integer(input)
+    end
+  rescue ArgumentError, TypeError => error
+    if block
+      block.call
+    else
+      raise Dry::Types::CoercionError.new(
+        error.message,
+        backtrace: error.backtrace
+      )
+    end
+  end
+  ```
+  This makes the exception handling your job so that dry-types won't have to catch and re-wrap all possible errors (this is not safe, generally speaking).
+- Types now can be converted to procs thus you can pass them as blocks (flash-gordon)
+  ```ruby
+  %w(1 2 3).map(&Types::Coercible::Integer)
+  # => [1, 2, 3]
+  ```
+
+[Compare v0.15.0...v1.0.0](https://github.com/dry-rb/dry-types/compare/v0.15.0...v1.0.0)
+
 # 0.15.0 2019-03-22
 
 ## Changed
@@ -116,7 +177,14 @@
 
 [Compare v0.14.0...v0.15.0](https://github.com/dry-rb/dry-types/compare/v0.14.0...v0.15.0)
 
-# 0.14.0 2019-01-29
+# 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)
+
+# v0.14.0 2019-01-29
 
 ## Changed
 

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
@@ -16,6 +18,7 @@ end
 
 group :benchmarks do
   gem 'benchmark-ips'
+  gem 'hotch'
   gem 'virtus'
   gem 'fast_attributes'
   gem 'attrio'

data/README.md

@@ -3,8 +3,9 @@
 [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
+[chat]: https://dry-rb.zulipchat.com
 
-# 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]

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 

data/benchmarks/hash_schemas.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 $LOAD_PATH.unshift('lib')
 
 require 'bundler/setup'

data/benchmarks/lax_schema.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative 'setup'
+
+schema = Dry::Types['params.hash'].schema(
+  email?: 'string',
+  age?: 'params.integer'
+).lax
+
+params = { email: 'jane@doe.org', age: '19' }
+
+Benchmark.ips do |x|
+  x.report("valid input") { schema.(params) }
+  x.compare!
+end
+

data/benchmarks/profile_invalid_input.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative 'setup'
+
+INVALID_INPUT = {
+  name: :John,
+  age: '20',
+  email: nil
+}
+
+profile do
+  10_000.times do
+    PersonSchema.(INVALID_INPUT)
+  end
+end

data/benchmarks/profile_lax_schema_valid.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative 'setup'
+
+Schema = Dry::Types['params.hash'].schema(
+  email?: 'string',
+  age?: 'coercible.integer'
+).lax
+
+ValidInput = { email: 'jane@doe.org', age: '19' }
+
+profile do
+  10_000.times do
+    Schema.(ValidInput)
+  end
+end

data/benchmarks/profile_valid_input.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative 'setup'
+
+VALID_INPUT = {
+  name: 'John',
+  age: 20,
+  email: 'john@doe.com'
+}
+
+profile do
+  10_000.times do
+    PersonSchema.(VALID_INPUT)
+  end
+end

data/benchmarks/schema_valid_vs_invalid.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative 'setup'
+
+VALID_INPUT = {
+  name: 'John',
+  age: 20,
+  email: 'john@doe.com'
+}
+
+INVALID_INPUT = {
+  name: :John,
+  age: '20',
+  email: nil
+}
+
+Benchmark.ips do |x|
+  x.report("valid input") { PersonSchema.(VALID_INPUT) }
+  x.report("invalid input") { PersonSchema.(INVALID_INPUT) }
+  x.compare!
+end

data/benchmarks/setup.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'benchmark/ips'
+require 'hotch'
+ENV['HOTCH_VIEWER'] ||= 'open'
+
+require 'dry/types'
+
+PersonSchema = Dry::Types['hash'].schema(
+  name: 'string',
+  age: 'integer',
+  email: 'string'
+).lax
+
+def profile(&block)
+  Hotch(filter: 'Dry', &block)
+end

data/dry-types.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'dry/types/version'
@@ -28,14 +30,14 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-  spec.required_ruby_version = ">= 2.3.0"
+  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-equalizer', '~> 0.2', '>= 0.2.2'
-  spec.add_runtime_dependency 'dry-logic', '~> 0.5', '>= 0.5'
+  spec.add_runtime_dependency 'dry-logic', '~> 1.0'
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", "~> 11.0"

data/lib/dry-types.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require 'dry/types'

data/lib/dry/types.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bigdecimal'
 require 'date'
 require 'set'
@@ -22,6 +24,9 @@ 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
@@ -43,27 +48,44 @@ module Dry
       raise RuntimeError, "Import Dry.Types, not Dry::Types"
     end
 
+    # 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 => 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
@@ -88,19 +110,29 @@ module Dry
       end
     end
 
+    # Infer a type identifier from the provided class
+    #
     # @param [#to_s] klass
+    #
     # @return [String]
     def self.identifier(klass)
       Inflector.underscore(klass).tr('/', '.')
     end
 
+    # Cached type map
+    #
     # @return [Concurrent::Map]
+    #
+    # @api private
     def self.type_map
       @type_map ||= Concurrent::Map.new
     end
 
-   # List of type keys defined in {Dry::Types.container}
-    # @return [<String>]
+    # List of type keys defined in {Dry::Types.container}
+    #
+    # @return [String]
+    #
+    # @api private
     def self.type_keys
       container.keys
     end
@@ -112,8 +144,8 @@ module Dry
       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["strict.integer"] '\
-              'or generate a module with types using Dry::Types.module'
+              'You can access the predefined types with [], e.g. Dry::Types["integer"] '\
+              'or generate a module with types using Dry.Types()'
       else
         super
       end
@@ -126,26 +158,26 @@ module Dry
   #
   #   module Types
   #     # imports all types as constants, uses modules for namespaces
-  #     include Dry::Types.module
+  #     include Dry::Types()
   #   end
-  #   # nominal types are exported by default
+  #   # strict types are exported by default
   #   Types::Integer
-  #   # => #<Dry::Types[Nominal<Integer>]>
-  #   Types::Strict::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: :strict)
+  #     include Dry::Types(default: :nominal)
   #   end
   #   Types::Integer
-  #   # => #<Dry::Types[Constrained<Nominal<Integer> rule=[type?(Integer)]>]>
+  #   # => #<Dry::Types[Nominal<Integer>]>
   #
   # @example cherry-picking namespaces
   #
   #   module Types
-  #     include Dry::Types.module(:strict, :coercible)
+  #     include Dry::Types(:strict, :coercible)
   #   end
   #   # cherry-picking discards default types,
   #   # provide the :default option along with the list of
@@ -154,7 +186,7 @@ module Dry
   #
   # @example custom names
   #   module Types
-  #     include Dry::Types.module(coercible: :Kernel)
+  #     include Dry::Types(coercible: :Kernel)
   #   end
   #   Types::Kernel::Integer
   #   # => #<Dry::Types[Constructor<Nominal<Integer> fn=Kernel.Integer>]>
@@ -162,12 +194,18 @@ module Dry
   # @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
+  # @see Dry::Types::Module
+  #
+  # @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