dry-types 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9bb3d91a31885a317b8fda3eef46f77b283abb3781c84124cc7ca0a5a2c30104
-  data.tar.gz: 88cd356e7878080570e5fa659f1403e01d8bc8a9654b3c5cfaf568c851d8e848
+  metadata.gz: 87e78ecf331ef9c4d95759bf28c2694e413df18fd0397d3c3c51380320328417
+  data.tar.gz: ca84bf0a23d37d7f0beda024d573852d2a0701a76f54dee2255166981bd716c5
 SHA512:
-  metadata.gz: 536386eba753a58a499c473d7f9e54da2bccf8597d80e3e225a036fb37acd886e0e9f75ceff497e81e6cb9a47141c2fdf4753f2bd521bf5a53424f768fc0cf0d
-  data.tar.gz: f74042df53c00159132ff2675206a393ca73a0d48ab84f7e6d58d56a51082e570932591279705ec993056b8e2720fd4572657b7bcb90596a16a7addaa7ac4bcf
+  metadata.gz: 8ae0d71644bfc391ada28229a68010a378b07e252c6ea5fdc27327065cdfc980b27a25bd9d63068966803a800a262958ef4ea0fc0296d4e865534e3fb3458dc8
+  data.tar.gz: a1e899fb498a414f3920f9a19bc8ca22fc4db2bf7e6063a7baca389c528c0fb4d9114522d57606d7143c872b6847b9f1134f04326d1dc5ba694853a0c3977390

data/.github/ISSUE_TEMPLATE/----please-don-t-ask-for-support-via-issues.md

@@ -0,0 +1,10 @@
+---
+name: "⚠️  Please don't ask for support via issues"
+about: See CONTRIBUTING.md for more information
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+

data/.github/ISSUE_TEMPLATE/---bug-report.md

@@ -0,0 +1,34 @@
+---
+name: "\U0001F41B Bug report"
+about: See CONTRIBUTING.md for more information
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Before you submit this: WE ONLY ACCEPT BUG REPORTS AND FEATURE REQUESTS**
+
+For more information see [our contribution guidelines](https://github.com/rom-rb/rom/blob/master/CONTRIBUTING.md)
+
+**Before you report**
+
+:warning: If you have a problem related to a schema, please **report it under [dry-schema issues](https://github.com/dry-rb/dry-schema/issues/new?assignees=&labels=bug&template=---bug-report.md&title=)** instead.
+
+**Describe the bug**
+
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+
+Provide detailed steps to reproduce, an executable script would be best.
+
+**Expected behavior**
+
+A clear and concise description of what you expected to happen.
+
+**Your environment**
+
+- Affects my production application: **YES/NO**
+- Ruby version: ...
+- OS: ...

data/.github/ISSUE_TEMPLATE/---feature-request.md

@@ -0,0 +1,18 @@
+---
+name: "\U0001F6E0 Feature request"
+about: See CONTRIBUTING.md for more information
+title: ''
+labels: feature
+assignees: ''
+
+---
+
+Summary of what the feature is supposed to do.
+
+## Examples
+
+Code examples showing how the feature could be used.
+
+## Resources
+
+Additional information, like a link to the discussion forum thread where the feature was discussed etc.

data/.travis.yml

@@ -10,13 +10,19 @@ after_script:
 script:
   - bundle exec rake
 rvm:
-  - 2.6.3
-  - 2.5.5
-  - 2.4.6
-  - jruby-9.2.7.0
+  - 2.6.5
+  - 2.5.7
+  - 2.4.9
+  - ruby-head
 env:
   global:
     - COVERAGE=true
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+  include:
+    - rvm: jruby-9.2.8.0
+      jdk: openjdk8
 notifications:
   email: false
   webhooks:

data/CHANGELOG.md

@@ -1,8 +1,98 @@
+# 1.2.0 2019-10-06
+
+## Changed
+
+- `Dry::Types.[]` used to work with classes, now it's deprecated (flash-gordon)
+
+## Fixed
+
+- Bug with using a `Bool`-named struct as a schema key (flash-gordon)
+- A bunch of issues related to using `meta` on complex types (flash-gordon)
+- `Types.Constructor(...)` returns a `Types::Array` as it should (flash-gordon)
+
+## Added
+
+- `Optional::Params` types that coerce empty strings to `nil` (flash-gordon)
+  ```ruby
+  Dry::Types['optional.params.integer'].('') # => nil
+  Dry::Types['optional.params.integer'].('140') # => 140
+  Dry::Types['optional.params.integer'].('asd') # => exception!
+  ```
+  Keep in mind, Dry::Types['optional.params.integer'] and Dry::Types['params.integer'].optional are not the same, the latter doesn't handle empty strings.
+- Predicate inferrer was ported from dry-schema (authored by solnic)
+  ```ruby
+  require 'dry/types/predicate_inferrer'
+  Dry::Types::PredicateInferrer.new[Types::String]
+  # => [:str?]
+  Dry::Types::PredicateInferrer.new[Types::String | Types::Integer]
+  # => [[[:str?], [:int?]]]
+  ```
+  Note that the API of the predicate inferrer can change in the stable version, it's dictated by the needs of dry-schema so it should be considered as semi-stable. If you depend on it, write specs covering the desired behavior. Another option is copy-and-paste the whole thing to your project.
+- Primitive inferrer was ported from dry-schema (authored by solnic)
+  ```ruby
+  require 'dry/types/primitive_inferrer'
+  Dry::Types::PrimitiveInferrer.new[Types::String]
+  # => [String]
+  Dry::Types::PrimitiveInferrer.new[Types::String | Types::Integer]
+  # => [String, Integer]
+  Dry::Types::PrimitiveInferrer.new[Types::String.optional]
+  # => [NilClass, String]
+  ```
+  The primitive inferrer should be stable by now, you can rely on it.
+- The `monads` extension adds `Dry::Types::Result#to_monad`. This makes it compatible with do notation from dry-monads. Load it with `Dry::Types.load_extensions(:monads)` (skryukov)
+
+  ```ruby
+  Types = Dry.Types
+  Dry::Types.load_extensions(:monads)
+
+  class AddTen
+    include Dry::Monads[:result, :do]
+
+    def call(input)
+      integer = yield Types::Coercible::Integer.try(input)
+
+      Success(integer + 10)
+    end
+  end
+  ```
+
+[Compare v1.1.1...v1.2.0](https://github.com/dry-rb/dry-types/compare/v1.1.1...v1.2.0)
+
+# 1.1.1 2019-07-26
+
+## Fixed
+
+- A bug where meta was lost for lax array types (flash-gordon)
+
+[Compare v1.1.0...v1.1.1](https://github.com/dry-rb/dry-types/compare/v1.1.0...v1.1.1)
+
+# 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 +111,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 +127,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 +252,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 +262,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 +274,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 +286,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,16 @@ end
 
 group :tools do
   gem 'pry-byebug', platform: :mri
+  gem 'rubocop'
 end
 
 group :benchmarks do
-  gem 'benchmark-ips'
-  gem 'hotch'
-  gem 'virtus'
-  gem 'fast_attributes'
-  gem 'attrio'
-  gem 'dry-struct'
+  platform :mri do
+    gem 'attrio'
+    gem 'benchmark-ips'
+    gem 'dry-struct'
+    gem 'fast_attributes'
+    gem 'hotch'
+    gem 'virtus'
+  end
 end

data/README.md

@@ -1,5 +1,5 @@
 [gem]: https://rubygems.org/gems/dry-types
-[travis]: https://travis-ci.org/dry-rb/dry-types
+[travis]: https://travis-ci.com/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
@@ -8,7 +8,7 @@
 # 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]
+[![Build Status](https://travis-ci.com/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]
 [![Inline docs](http://inch-ci.org/github/dry-rb/dry-types.svg?branch=master)][inchpages]

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/docsite/source/array-with-member.html.md

@@ -0,0 +1,13 @@
+---
+title: Array With Member
+layout: gem-single
+name: dry-types
+---
+
+The built-in array type supports defining the member's type:
+
+``` ruby
+PostStatuses = Types::Array.of(Types::Coercible::String)
+
+PostStatuses[[:foo, :bar]] # ["foo", "bar"]
+```

data/docsite/source/built-in-types.html.md

@@ -0,0 +1,116 @@
+---
+title: Built-in Types
+layout: gem-single
+name: dry-types
+---
+
+Built-in types are grouped under 6 categories:
+
+- `nominal` - base type definitions with a primitive class and options
+- `strict` - constrained types with a primitive type check applied to input
+- `coercible` - types with constructors using kernel coercions
+- `params` - types with constructors performing non-strict coercions specific to HTTP parameters
+- `json` - types with constructors performing non-strict coercions specific to JSON
+- `maybe` - types accepting either nil or a specific primitive type
+
+### Categories
+
+Assuming you included `Dry::Types` ([see instructions](/gems/dry-types/1.0/getting-started)) in a module called `Types`:
+
+* Nominal types:
+  - `Types::Nominal::Any`
+  - `Types::Nominal::Nil`
+  - `Types::Nominal::Symbol`
+  - `Types::Nominal::Class`
+  - `Types::Nominal::True`
+  - `Types::Nominal::False`
+  - `Types::Nominal::Bool`
+  - `Types::Nominal::Integer`
+  - `Types::Nominal::Float`
+  - `Types::Nominal::Decimal`
+  - `Types::Nominal::String`
+  - `Types::Nominal::Date`
+  - `Types::Nominal::DateTime`
+  - `Types::Nominal::Time`
+  - `Types::Nominal::Array`
+  - `Types::Nominal::Hash`
+
+* `Strict` types will raise an error if passed a value of the wrong type:
+  - `Types::Strict::Nil`
+  - `Types::Strict::Symbol`
+  - `Types::Strict::Class`
+  - `Types::Strict::True`
+  - `Types::Strict::False`
+  - `Types::Strict::Bool`
+  - `Types::Strict::Integer`
+  - `Types::Strict::Float`
+  - `Types::Strict::Decimal`
+  - `Types::Strict::String`
+  - `Types::Strict::Date`
+  - `Types::Strict::DateTime`
+  - `Types::Strict::Time`
+  - `Types::Strict::Array`
+  - `Types::Strict::Hash`
+
+> All types in the `strict` category are [constrained](/gems/dry-types/1.0/constraints) by a type-check that is applied to make sure that the input is an instance of the primitive:
+
+``` ruby
+Types::Strict::Integer[1] # => 1
+Types::Strict::Integer['1'] # => raises Dry::Types::ConstraintError
+```
+
+* `Coercible` types will attempt to cast values to the correct class using kernel coercion methods:
+  - `Types::Coercible::String`
+  - `Types::Coercible::Integer`
+  - `Types::Coercible::Float`
+  - `Types::Coercible::Decimal`
+  - `Types::Coercible::Array`
+  - `Types::Coercible::Hash`
+
+* Types suitable for `Params` param processing with coercions:
+  - `Types::Params::Nil`
+  - `Types::Params::Date`
+  - `Types::Params::DateTime`
+  - `Types::Params::Time`
+  - `Types::Params::True`
+  - `Types::Params::False`
+  - `Types::Params::Bool`
+  - `Types::Params::Integer`
+  - `Types::Params::Float`
+  - `Types::Params::Decimal`
+  - `Types::Params::Array`
+  - `Types::Params::Hash`
+
+* Types suitable for `JSON` processing with coercions:
+  - `Types::JSON::Nil`
+  - `Types::JSON::Date`
+  - `Types::JSON::DateTime`
+  - `Types::JSON::Time`
+  - `Types::JSON::Decimal`
+  - `Types::JSON::Array`
+  - `Types::JSON::Hash`
+
+* `Maybe` strict types:
+  - `Types::Maybe::Strict::Class`
+  - `Types::Maybe::Strict::String`
+  - `Types::Maybe::Strict::Symbol`
+  - `Types::Maybe::Strict::True`
+  - `Types::Maybe::Strict::False`
+  - `Types::Maybe::Strict::Integer`
+  - `Types::Maybe::Strict::Float`
+  - `Types::Maybe::Strict::Decimal`
+  - `Types::Maybe::Strict::Date`
+  - `Types::Maybe::Strict::DateTime`
+  - `Types::Maybe::Strict::Time`
+  - `Types::Maybe::Strict::Array`
+  - `Types::Maybe::Strict::Hash`
+
+* `Maybe` coercible types:
+  - `Types::Maybe::Coercible::String`
+  - `Types::Maybe::Coercible::Integer`
+  - `Types::Maybe::Coercible::Float`
+  - `Types::Maybe::Coercible::Decimal`
+  - `Types::Maybe::Coercible::Array`
+  - `Types::Maybe::Coercible::Hash`
+
+> `Maybe` types are not available by default - they must be loaded using `Dry::Types.load_extensions(:maybe)`. See [Optional Values](/gems/dry-types/1.0/optional-values) for more information.