dry-types 1.1.1 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f4827f984803481533626b7ebe6e51fe6b5cf5da3691a7e0f9681c4d321bd1a
-  data.tar.gz: 755af2027b59115fd97e1051bdea5eb400ca1a76cf39b19953538e4fb5bb28dc
+  metadata.gz: 6a22d275ce9f27a5be0edd1ce02714dbf571ee95abab2ab8e127b88e61317ac3
+  data.tar.gz: 8708d3ceb67ff3a726ae0363fe04fd08da440f3fdf7ae4e2f5632104fdf33810
 SHA512:
-  metadata.gz: 18aa4a59b9fbe19721d65c57ca91f29b4f3935298e5947182953b9ffe92c7213fe4f209e55d3472a86d3d4645e8e0ccd200e5456af492026570b0f28f9255973
-  data.tar.gz: e9b2886e43868b544ec1e4cb9c30949bbd3bec9dba1089dcd08c7ba36e456458a8746ea2537d5241c63322b38505ddc86fecda4035ab0f545e675cbc4188ba15
+  metadata.gz: 5ff0c69309f200eef77442aef6e9452046f75394c16b00f0be12cdbad04a8c34a1a02e87e0347fb1875fc0241a83f79e1b70576ad4d4e5202cde40257af3e3bb
+  data.tar.gz: 6eef147d7238f8ead4f254f37a0f018d5fc932ea3dd87bf334c06c3f0eb4110372078c4dcfad27c80a1dcfe161cc6955942d1daeffda6cd8980f3770b7a3c8b1

data/.codeclimate.yml

@@ -1,9 +1,6 @@
-version: "2"
+# this file is managed by dry-rb/devtools project
 
-prepare:
-  fetch:
-  - url: "https://raw.githubusercontent.com/dry-rb/devtools/master/.rubocop.yml"
-    path: ".rubocop.yml"
+version: "2"
 
 exclude_patterns:
   - "benchmarks/"

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/.github/workflows/custom_ci.yml

@@ -0,0 +1,76 @@
+name: ci
+
+on:
+  push:
+    paths:
+      - .github/workflows/ci.yml
+      - lib/**
+      - spec/**
+
+jobs:
+  tests-mri:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ["2.6.x", "2.5.x", "2.4.x"]
+        dry_logic_from_master: ["true", "false"]
+        include:
+          - ruby: "2.6.x"
+            dry_logic_from_master: "false"
+            coverage: "true"
+    steps:
+      - uses: actions/checkout@v1
+      - name: Set up Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{matrix.ruby}}
+      - name: Download test reporter
+        if: "matrix.coverage == 'true'"
+        run: |
+          mkdir -p tmp/
+          curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./tmp/cc-test-reporter
+          chmod +x ./tmp/cc-test-reporter
+          ./tmp/cc-test-reporter before-build
+      - name: Run all tests
+        env:
+          COVERAGE: ${{matrix.coverage}}
+          DRY_LOGIC_FROM_MASTER: ${{matrix.dry_logic_from_master}}
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3 --without tools docs
+          bundle exec rake
+      - name: Send coverage results
+        if: "matrix.coverage == 'true'"
+        env:
+          CC_TEST_REPORTER_ID: ${{secrets.CC_TEST_REPORTER_ID}}
+          GIT_COMMIT_SHA: ${{github.sha}}
+          GIT_BRANCH: ${{github.ref}}
+          GIT_COMMITTED_AT: ${{github.event.head_commit.timestamp}}
+        run: |
+          GIT_BRANCH=`ruby -e "puts ENV['GITHUB_REF'].split('/', 3).last"` \
+          GIT_COMMITTED_AT=`ruby -r time -e "puts Time.iso8601(ENV['GIT_COMMITTED_AT']).to_i"` \
+          ./tmp/cc-test-reporter after-build
+
+  tests-others:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        image: ["jruby:9.2.8", "ruby:rc"]
+        dry_logic_from_master: ["true", "false"]
+    container:
+      image: ${{matrix.image}}
+    steps:
+      - uses: actions/checkout@v1
+      - name: Install git
+        run: |
+          apt-get update
+          apt-get install -y --no-install-recommends git
+      - name: Run all tests
+        env:
+          DRY_LOGIC_FROM_MASTER: ${{matrix.dry_logic_from_master}}
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3 --without tools docs
+          bundle exec rspec

data/.github/workflows/docsite.yml

@@ -0,0 +1,34 @@
+# this file is managed by dry-rb/devtools project
+
+name: docsite
+
+on:
+  push:
+    paths:
+      - docsite/**
+      - .github/workflows/docsite.yml
+    branches:
+      - master
+      - release-**
+    tags:
+
+jobs:
+  update-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - name: Set up Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: "2.6.x"
+      - name: Install dependencies
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3 --without benchmarks sql
+      - name: Symlink ossy
+        run: mkdir -p bin && ln -sf "$(bundle show ossy)/bin/ossy" bin/ossy
+      - name: Trigger dry-rb.org deploy
+        env:
+          GITHUB_LOGIN: dry-bot
+          GITHUB_TOKEN: ${{ secrets.GH_PAT }}
+        run: bin/ossy github workflow dry-rb/dry-rb.org ci

data/.github/workflows/sync_configs.yml

@@ -0,0 +1,34 @@
+# this file is managed by dry-rb/devtools project
+
+name: sync_configs
+
+on:
+  repository_dispatch:
+
+jobs:
+  sync-configs:
+    runs-on: ubuntu-latest
+    if: github.event.action == 'sync_configs'
+    steps:
+      - uses: actions/checkout@v1
+      - name: Update configuration files from devtools
+        env:
+          GITHUB_LOGIN: dry-bot
+          GITHUB_TOKEN: ${{ secrets.GH_PAT }}
+        run: |
+          git clone https://github.com/dry-rb/devtools.git tmp/devtools
+
+          if [ -f ".github/workflows/custom_ci.yml" ]; then
+            rsync -av --exclude '.github/workflows/ci.yml' tmp/devtools/shared/ . ;
+          else
+            rsync -av tmp/devtools/shared/ . ;
+          fi
+
+          git config --local user.email "dry-bot@dry-rb.org"
+          git config --local user.name "dry-bot"
+          git add -A
+          git commit -m "[devtools] config sync" || echo "nothing changed"
+      - name: Push changes
+        uses: ad-m/github-push-action@master
+        with:
+          github_token: ${{ secrets.GH_PAT }}

data/.gitignore

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

data/.rspec

@@ -1,2 +1,4 @@
 --color
---require ./spec/spec_helper
+--require spec_helper
+--order random
+

data/.rubocop.yml

@@ -1,3 +1,5 @@
+# this file is managed by dry-rb/devtools project
+
 AllCops:
   TargetRubyVersion: 2.4
 
@@ -20,6 +22,9 @@ Style/StabbyLambdaParentheses:
 Style/FormatString:
   Enabled: false
 
+Style/Documentation:
+  Enabled: false
+
 Layout/SpaceInLambdaLiteral:
   Enabled: false
 
@@ -40,9 +45,7 @@ Metrics/AbcSize:
   Max: 20
 
 Metrics/BlockLength:
-  Enabled: true
-  Exclude:
-    - 'spec/**/*_spec.rb'
+  Enabled: false
 
 Metrics/CyclomaticComplexity:
   Enabled: true
@@ -55,5 +58,32 @@ Style/AccessModifierDeclarations:
   Enabled: false
 
 Style/BlockDelimiters:
-  EnforcedStyle: semantic
+  Enabled: false
+
+Layout/IndentFirstArrayElement:
+  EnforcedStyle: consistent
 
+Style/ClassAndModuleChildren:
+  Exclude:
+    - "spec/**/*_spec.rb"
+
+Lint/HandleExceptions:
+  Exclude:
+    - "spec/spec_helper.rb"
+
+Naming/FileName:
+  Exclude:
+    - "lib/dry-*.rb"
+
+Style/SymbolArray:
+  Exclude:
+    - "spec/**/*_spec.rb"
+
+Style/ConditionalAssignment:
+  Enabled: false
+
+Naming/MethodName:
+  Enabled: false
+
+Style/AsciiComments:
+  Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,72 @@
+# 1.2.1 2019-11-07
+
+## Fixed
+
+- Fix keyword warnings reported by Ruby 2.7 (flash-gordon)
+- Error type in failing case in `Array::Member` (esparta)
+
+[Compare v1.2.0...v1.2.1](https://github.com/dry-rb/dry-types/compare/v1.2.0...v1.2.1)
+
+# 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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.4.0, available at [https://www.contributor-covenant.org/version/1/4/code-of-conduct](https://www.contributor-covenant.org/version/1/4/code-of-conduct)

data/CONTRIBUTING.md

@@ -10,7 +10,7 @@ Report a feature request **only after discussing it first on [discourse.dry-rb.o
 
 ## Reporting questions, support requests, ideas, concerns etc.
 
-**PLEASE DON'T** - use [discourse.dry-rb.org](https://discourse.dry-rb.org) instead.
+**PLEASE DON'T** - use [discourse.dry-rb.org](http://discourse.dry-rb.org) instead.
 
 # Pull Request Guidelines
 
@@ -26,4 +26,4 @@ Other requirements:
 
 # Asking for help
 
-If these guidelines aren't helpful, and you're stuck, please post a message on [discourse.dry-rb.org](https://discourse.dry-rb.org).
+If these guidelines aren't helpful, and you're stuck, please post a message on [discourse.dry-rb.org](https://discourse.dry-rb.org) or join [our chat](https://dry-rb.zulipchat.com).

data/Gemfile

@@ -6,6 +6,8 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 gemspec
 
+gem 'dry-logic', github: 'dry-rb/dry-logic', branch: 'master' if ENV['DRY_LOGIC_FROM_MASTER'].eql?('true')
+
 group :test do
   platform :mri do
     gem 'simplecov', require: false
@@ -15,13 +17,16 @@ end
 group :tools do
   gem 'pry-byebug', platform: :mri
   gem 'rubocop'
+  gem 'ossy', github: 'solnic/ossy', branch: 'master'
 end
 
 group :benchmarks do
-  gem 'attrio'
-  gem 'benchmark-ips'
-  gem 'dry-struct'
-  gem 'fast_attributes'
-  gem 'hotch'
-  gem 'virtus'
+  platform :mri do
+    gem 'attrio'
+    gem 'benchmark-ips'
+    gem 'dry-struct'
+    gem 'fast_attributes'
+    gem 'hotch'
+    gem 'virtus'
+  end
 end

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-2019 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/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](docs::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](docs::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 [Maybe extension](docs::extensions/maybe) for more information.

data/docsite/source/constraints.html.md

@@ -0,0 +1,31 @@
+---
+title: Constraints
+layout: gem-single
+name: dry-types
+---
+
+You can create constrained types that will use validation rules to check that the input is not violating any of the configured constraints. You can treat it as a lower level guarantee that you're not instantiating objects that are broken.
+
+All types support the constraints API, but not all constraints are suitable for a particular primitive, it's up to you to set up constraints that make sense.
+
+Under the hood it uses [`dry-logic`](/gems/dry-logic) and all of its predicates are supported.
+
+``` ruby
+string = Types::String.constrained(min_size: 3)
+
+string['foo']
+# => "foo"
+
+string['fo']
+# => Dry::Types::ConstraintError: "fo" violates constraints
+
+email = Types::String.constrained(
+  format: /\A[\w+\-.]+@[a-z\d\-]+(\.[a-z]+)*\.[a-z]+\z/i
+)
+
+email["jane@doe.org"]
+# => "jane@doe.org"
+
+email["jane"]
+# => Dry::Types::ConstraintError: "jane" violates constraints
+```