dry-logic 1.0.4 → 1.1.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,9 +0,0 @@
-.DS_Store
-coverage
-/.bundle
-vendor/bundle
-tmp/
-pkg/
-.idea/
-Gemfile.lock
-

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/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,16 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-gemspec
-
-group :test do
-  gem 'simplecov', require: false, platform: :mri
-end
-
-group :tools do
-  gem 'pry-byebug', platform: :mri
-  gem 'benchmark-ips', platform: :mri
-  gem 'hotch', platform: :mri
-  gem 'ossy', git: 'https://github.com/solnic/ossy.git', branch: 'master'
-end

data/Rakefile

@@ -1,14 +0,0 @@
-#!/usr/bin/env rake
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'
-
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'lib'))
-
-require 'rspec/core'
-require 'rspec/core/rake_task'
-
-task default: :spec
-
-desc 'Run all specs in spec directory'
-RSpec::Core::RakeTask.new(:spec)

data/benchmarks/rule_application.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'setup'
-
-unless Dry::Logic::Rule.respond_to?(:build)
-  Dry::Logic::Rule.singleton_class.alias_method(:build, :new)
-end
-
-predicates = Dry::Logic::Predicates
-
-type_check = Dry::Logic::Rule.build(predicates[:type?]).curry(Integer)
-int_check = Dry::Logic::Rule.build(predicates[:int?])
-key_check = Dry::Logic::Rule.build(predicates[:key?]).curry(:user)
-with_user = { user: {} }
-without_user = {}
-
-comparison = Dry::Logic::Rule.build(predicates[:gteq?]).curry(18)
-
-Benchmark.ips do |x|
-  x.report("type check - success") { type_check.(0) }
-  x.report("type check - failure") { type_check.('0') }
-  x.report("int check - success") { int_check.(0) }
-  x.report("int check - failure") { int_check.('0') }
-  x.report("key check - success") { key_check.(with_user) }
-  x.report("key check - failure") { key_check.(without_user) }
-  x.report("comparison - success") { comparison.(20) }
-  x.report("comparison - failure") { comparison.(17) }
-
-  x.compare!
-end

data/benchmarks/setup.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-require 'benchmark/ips'
-require 'hotch'
-ENV['HOTCH_VIEWER'] ||= 'open'
-
-require 'dry/logic'
-require 'dry/logic/predicates'
-
-def profile(&block)
-  Hotch(filter: 'Dry', &block)
-end
-

data/bin/console

@@ -1,11 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "bundler/setup"
-require 'dry/logic'
-require 'dry/logic/predicates'
-
-include Dry::Logic
-
-require "irb"
-IRB.start

data/docsite/source/index.html.md

@@ -1,54 +0,0 @@
----
-title: Introduction
-description: Predicate logic with composable rules
-layout: gem-single
-type: gem
-name: dry-logic
-sections:
-  - predicates
-  - operations
----
-
-Predicate logic and rule composition used by:
-
-* [dry-types](https://github.com/dry-rb/dry-types) for constrained types
-* [dry-validation](https://github.com/dry-rb/dry-validation) for composing validation rules
-* your project...?
-
-## Synopsis
-
-``` ruby
-require 'dry/logic'
-require 'dry/logic/predicates'
-
-include Dry::Logic
-
-# Rule::Predicate will only apply its predicate to its input, that’s all
-
-# require input to have the key :user
-user_present = Rule::Predicate.new(Predicates[:key?]).curry(:user)
-# curry allows us to prepare predicates with args, without the input
-
-# require value to be greater than 18
-min_18 = Rule::Predicate.new(Predicates[:gt?]).curry(18)
-
-# use the min_18 predicate on the the value of user[:age]
-has_min_age = Operations::Key.new(min_18, name: [:user, :age])
-
-user_rule = user_present & has_min_age
-
-user_rule.(user: { age: 19 }).success?
-# => true
-
-user_rule.(user: { age: 18 }).success?
-# => false
-
-user_rule.(user: { age: 'seventeen' })
-# => ArgumentError: comparison of String with 18 failed
-
-user_rule.(user: { })
-# => NoMethodError: undefined method `>' for nil:NilClass
-
-user_rule.({}).success?
-# => false
-```

data/docsite/source/operations.html.md

@@ -1,62 +0,0 @@
----
-title: Operations
-layout: gem-single
-name: dry-logic
----
-
-Dry-logic uses operations to interact with the input passed to the different rules.
-
-``` ruby
-require 'dry/logic'
-require 'dry/logic/predicates'
-
-include Dry::Logic
-
-user_present = Rule::Predicate.new(Predicates[:key?]).curry(:user)
-
-min_18 = Rule::Predicate.new(Predicates[:gt?]).curry(18)
-
-# Here Operations::Key and Rule::Predicate are use to compose and logic based on the value of a given key e.g [:user, :age]
-has_min_age = Operations::Key.new(min_18, name: [:user, :age])
-# => #<Dry::Logic::Operations::Key rules=[#<Dry::Logic::Rule::Predicate predicate=#<Method: Module(Dry::Logic::Predicates::Methods)#gt?> options={:args=>[18]}>] options={:name=>[:user, :age], :evaluator=>#<Dry::Logic::Evaluator::Key path=[:user, :age]>, :path=>[:user, :age]}>
-
-# Thanks to the composable structure of the library we can use multiple Rules and Operations to create custom logic
-user_rule = user_present & has_min_age
-
-user_rule.(user: { age: 19 }).success?
-# => true
-```
-
-* Built-in:
-  - `and`
-  - `or`
-  - `key`
-  - `attr`
-  - `binary`
-  - `check`
-  - `each`
-  - `implication`
-  - `negation`
-  - `set`
-  - `xor`
-
-Another example, lets create the `all?` method from the `Enumerable` module.
-
-``` ruby
-require 'dry/logic'
-require 'dry/logic/predicates'
-
-include Dry::Logic
-
-def all?(value)
-  Operations::Each.new(Rule::Predicate.new(Predicates[:gt?]).curry(value))
-end
-
-all_6 = all?(6)
-
-all_6.([6,7,8,9]).success?
-# => true
-
-all_6.([1,2,3,4]).success?
-# => false
-```

data/docsite/source/predicates.html.md

@@ -1,102 +0,0 @@
----
-title: Predicates
-layout: gem-single
-name: dry-logic
----
-
-Dry-logic comes with a lot predicates to compose multiple rules:
-
-``` ruby
-require 'dry/logic'
-require 'dry/logic/predicates'
-
-include Dry::Logic
-```
-
-Now you can access all built-in predicates:
-
-``` ruby
-Predicates[:key?]
-# => #<Method: Module(Dry::Logic::Predicates::Methods)#key?>
-```
-
-In the end predicates return true or false.
-
-```ruby
-Predicates[:key?].(:name, {name: 'John'})
-# => true
-```
-
-* Built-in:
-  - `type?`
-  - `none?`
-  - `key?`
-  - `attr?`
-  - `empty?`
-  - `filled?`
-  - `bool?`
-  - `date?`
-  - `date_time?`
-  - `time?`
-  - `number?`
-  - `int?`
-  - `float?`
-  - `decimal?`
-  - `str?`
-  - `hash?`
-  - `array?`
-  - `odd?`
-  - `even?`
-  - `lt?`
-  - `gt?`
-  - `lteq?`
-  - `gteq?`
-  - `size?`
-  - `min_size?`
-  - `max_size?`
-  - `bytesize?`
-  - `min_bytesize?`
-  - `max_bytesize?`
-  - `inclusion?`
-  - `exclusion?`
-  - `included_in?`
-  - `excluded_from?`
-  - `includes?`
-  - `excludes?`
-  - `eql?`
-  - `not_eql?`
-  - `is?`
-  - `case?`
-  - `true?`
-  - `false?`
-  - `format?`
-  - `respond_to?`
-  - `predicate`
-  - `uuid_v4?`
-
-With predicates you can build more composable and complex operations:
-For example, let's say we want to check that a given input is a hash and has a specify key.
-
-``` ruby
-require 'dry/logic'
-require 'dry/logic/predicates'
-
-include Dry::Logic
-
-is_hash = Rule::Predicate.new(Predicates[:type?]).curry(Hash)
-# => #<Dry::Logic::Rule::Predicate predicate=#<Method: Module(Dry::Logic::Predicates::Methods)#type?> options={:args=>[:hash]}>
-name_key = Rule::Predicate.new(Predicates[:key?]).curry(:name)
-# => #<Dry::Logic::Rule::Predicate predicate=#<Method: Module(Dry::Logic::Predicates::Methods)#key?> options={:args=>[:name]}>
-
-hash_with_key = is_hash & name_key
-# => #<Dry::Logic::Operations::And rules=[#<Dry::Logic::Rule::Predicate predicate=#<Method: Module(Dry::Logic::Predicates::Methods)#type?> options={:args=>[:hash]}>, #<Dry::Logic::Rule::Predicate predicate=#<Method: Module(Dry::Logic::Predicates::Methods)#key?> options={:args=>[:name]}>] options={}>
-
-hash_with_key.(name: 'John').success?
-# => true
-
-hash_with_key.(not_valid: 'John').success?
-# => false
-
-hash_with_key.([1,2]).success?
-# => false
-```