dry-types 1.2.1 → 1.5.0

data/.github/workflows/sync_configs.yml

@@ -1,34 +0,0 @@
-# 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

@@ -1,11 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-log/
-

data/.rspec

@@ -1,4 +0,0 @@
---color
---require spec_helper
---order random
-

data/.rubocop.yml

@@ -1,89 +0,0 @@
-# this file is managed by dry-rb/devtools project
-
-AllCops:
-  TargetRubyVersion: 2.4
-
-Style/EachWithObject:
-  Enabled: false
-
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: single_quotes
-
-Style/Alias:
-  Enabled: false
-
-Style/LambdaCall:
-  Enabled: false
-
-Style/StabbyLambdaParentheses:
-  Enabled: false
-
-Style/FormatString:
-  Enabled: false
-
-Style/Documentation:
-  Enabled: false
-
-Layout/SpaceInLambdaLiteral:
-  Enabled: false
-
-Layout/MultilineMethodCallIndentation:
-  Enabled: true
-  EnforcedStyle: indented
-
-Metrics/LineLength:
-  Max: 100
-
-Metrics/MethodLength:
-  Max: 22
-
-Metrics/ClassLength:
-  Max: 150
-
-Metrics/AbcSize:
-  Max: 20
-
-Metrics/BlockLength:
-  Enabled: false
-
-Metrics/CyclomaticComplexity:
-  Enabled: true
-  Max: 10
-
-Lint/BooleanSymbol:
-  Enabled: false
-
-Style/AccessModifierDeclarations:
-  Enabled: false
-
-Style/BlockDelimiters:
-  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/.yardopts

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

data/CODE_OF_CONDUCT.md

@@ -1,13 +0,0 @@
-# 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

@@ -1,29 +0,0 @@
-# Issue Guidelines
-
-## Reporting bugs
-
-If you found a bug, report an issue and describe what's the expected behavior versus what actually happens. If the bug causes a crash, attach a full backtrace. If possible, a reproduction script showing the problem is highly appreciated.
-
-## Reporting feature requests
-
-Report a feature request **only after discussing it first on [discourse.dry-rb.org](https://discourse.dry-rb.org)** where it was accepted. Please provide a concise description of the feature, don't link to a discussion thread, and instead summarize what was discussed.
-
-## Reporting questions, support requests, ideas, concerns etc.
-
-**PLEASE DON'T** - use [discourse.dry-rb.org](http://discourse.dry-rb.org) instead.
-
-# Pull Request Guidelines
-
-A Pull Request will only be accepted if it addresses a specific issue that was reported previously, or fixes typos, mistakes in documentation etc.
-
-Other requirements:
-
-1) Do not open a pull request if you can't provide tests along with it. If you have problems writing tests, ask for help in the related issue.
-2) Follow the style conventions of the surrounding code. In most cases, this is standard ruby style.
-3) Add API documentation if it's a new feature
-4) Update API documentation if it changes an existing feature
-5) Bonus points for sending a PR to [github.com/dry-rb/dry-rb.org](github.com/dry-rb/dry-rb.org) which updates user documentation and guides
-
-# 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) or join [our chat](https://dry-rb.zulipchat.com).

data/Gemfile

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-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
-  end
-end
-
-group :tools do
-  gem 'pry-byebug', platform: :mri
-  gem 'rubocop'
-  gem 'ossy', github: 'solnic/ossy', branch: 'master'
-end
-
-group :benchmarks do
-  platform :mri do
-    gem 'attrio'
-    gem 'benchmark-ips'
-    gem 'dry-struct'
-    gem 'fast_attributes'
-    gem 'hotch'
-    gem 'virtus'
-  end
-end

data/Rakefile

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-
-task :run_specs do
-  require 'rspec/core'
-
-  types_result = RSpec::Core::Runner.run(['spec/dry'])
-  RSpec.clear_examples
-
-  Dry::Types.load_extensions(:maybe)
-  ext_result = RSpec::Core::Runner.run(['spec'])
-
-  exit [types_result, ext_result].max
-end
-
-task default: :run_specs
-
-require 'yard'
-require 'yard/rake/yardoc_task'
-YARD::Rake::YardocTask.new(:doc)

data/benchmarks/hash_schemas.rb

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-$LOAD_PATH.unshift('lib')
-
-require 'bundler/setup'
-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,
-        city: Dry::Types['nominal.string'],
-        street: Dry::Types['nominal.string']
-      )
-    )
-  end
-
-  private_class_method(:hash_schema)
-
-  SCHEMAS =
-    Dry::Types::Hash
-      .public_instance_methods(false)
-      .map { |schema_type| [schema_type, hash_schema(schema_type)] }
-      .to_h
-
-  INPUT = {
-    email: 'jane@doe.org',
-    age: '20',
-    admin: '1',
-    address: { city: 'NYC', street: 'Street 1/2' }
-  }.freeze
-end
-
-require 'benchmark/ips'
-
-Benchmark.ips do |x|
-  SchemaBench::SCHEMAS.each do |schema_type, schema|
-    x.report("#{schema_type}#call") do
-      schema.call(SchemaBench::INPUT)
-    end
-  end
-
-  SchemaBench::SCHEMAS.each do |schema_type, schema|
-    x.report("#{schema_type}#try") do
-      schema.try(SchemaBench::INPUT)
-    end
-  end
-
-  x.compare!
-end

data/benchmarks/lax_schema.rb

@@ -1,15 +0,0 @@
-# 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

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

data/benchmarks/profile_lax_schema_valid.rb

@@ -1,16 +0,0 @@
-# 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' }.freeze
-
-profile do
-  10_000.times do
-    Schema.(ValidInput)
-  end
-end

data/benchmarks/profile_valid_input.rb

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

data/benchmarks/schema_valid_vs_invalid.rb

@@ -1,21 +0,0 @@
-# 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

@@ -1,17 +0,0 @@
-# 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/docsite/source/array-with-member.html.md

@@ -1,13 +0,0 @@
----
-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

@@ -1,116 +0,0 @@
----
-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.