active_model_validations_reflection 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 03df2721bd43802064e8365a8409e6a3e9f4016c17cfc3cc03ec544269a4b560
+  data.tar.gz: 03163f128e2fcf350c481e9dc4023a7c2c8409ee4a50308d5c4548228314cb8e
+SHA512:
+  metadata.gz: e301c7c80c86cd343f8e077488cee4d6cd4cc160485a54379cead37ad3aed8f9e8b4f22f6e91353c1fff89bd2da84afcab37ba2525b52cf6868ced1cbb96f7f1
+  data.tar.gz: 36ba3ec7d564406e0c70e721330a1f726a9883b022248353c7da368752d705545a6bffa06264412434ab39d0da19d2c9b2a5fb4c671685a99abe9c59160ac5e2

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,11 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+
+# DSLs produce long blocks
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*_spec.rb'

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+cache: bundler
+sudo: false
+
+rvm:
+  - 2.6
+  - 2.7
+  - 3.0
+
+gemfile:
+  - Gemfile

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in active_model_validations_reflection.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,80 @@
+PATH
+  remote: .
+  specs:
+    active_model_validations_reflection (0.1.0)
+      activemodel (>= 3.2)
+      activesupport (>= 3.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.1.3.2)
+      activesupport (= 6.1.3.2)
+    activesupport (6.1.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
+    concurrent-ruby (1.1.8)
+    diff-lcs (1.4.4)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.4)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.14.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.5.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.5.0)
+      parser (>= 3.0.1.1)
+    rubocop-rake (0.5.1)
+      rubocop
+    rubocop-rspec (2.3.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.0.0)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  active_model_validations_reflection!
+  bundler (~> 2.1)
+  rake (~> 13.0)
+  rspec (~> 3.10.0)
+  rubocop
+  rubocop-rake
+  rubocop-rspec
+
+BUNDLED WITH
+   2.2.3

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2021 notus.sh
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,90 @@
+# ActiveModel::Validations::Reflection
+
+[![Build Status](https://travis-ci.org/notus-sh/active_model_validations_reflection.svg?branch=master)](https://travis-ci.org/notus-sh/active_model_validations_reflection)
+[![Gem Version](https://badge.fury.io/rb/active_model_validations_reflection.svg)](https://badge.fury.io/rb/active_model_validations_reflection)
+
+`ActiveModel::Validations::Reflection` extends `ActiveModel` reflection capabilities on validations.
+
+## Installation
+
+`Rack::AddressMunging` is distributed as a gem and available on [rubygems.org](https://rubygems.org/gems/rack-address_munging) so you can add it to your `Gemfile` or install it manually with:
+
+```ruby
+gem install active_model_validations_reflection
+```
+
+## Usage
+
+`ActiveModel`, at least since 3.0, provide a basic mechanism to inspect validations on a model through [`ActiveModel::Validations::ClassMethods#validators`](https://api.rubyonrails.org/classes/ActiveModel/Validations/ClassMethods.html#method-i-validators) and [`ActiveModel::Validations::ClassMethods#validators_on`](https://api.rubyonrails.org/classes/ActiveModel/Validations/ClassMethods.html#method-i-validators_on).
+
+This extends it with easier filtering on validators on class level and contextual filtering on instance level.
+
+### `.validators_of_kinds(*kinds)` & `.validators_on_of_kinds(attribute, *kinds)`
+
+`.validators_of_kinds` & `.validators_on_of_kinds` are class methods to filter validators by kind, respectively on all or a single attribute.
+
+Any kind supported by [`validates`](https://api.rubyonrails.org/classes/ActiveModel/Validations/ClassMethods.html#method-i-validates) (`:presence` , `:inclusion`, `:uniqueness`, or custom validator's kind) can be used to filter validators.
+
+```ruby
+class Article < ApplicationRecord
+  include ActiveModel::Validations::Reflection
+  
+  validates :date,
+            presence: true,
+            timeliness: { type: :date }
+end
+
+Article.validators_of_kinds(:presence)
+# => [#<ActiveModel::Validations::PresenceValidator […]>]
+Article.validators_on_of_kinds(:date, :timeliness)
+# => [#<ValidatesTimeliness::Validator […]>]
+```
+
+### `.flat_validators_of_kinds(*kinds)` & `.flat_validators_on_of_kinds(attribute, *kinds)`
+
+Same as the above two but only return validators without conditions (`:if` / `:unless`).
+
+```ruby
+class Article < ApplicationRecord
+  include ActiveModel::Validations::Reflection
+  
+  enum :status, %i[draft published]
+  
+  validates :date,
+            presence: true,
+            timeliness: { type: :date, if: :published? }
+end
+
+Article.validators_of_kinds(:presence)
+# => [#<ActiveModel::Validations::PresenceValidator […]>]
+Article.validators_on_of_kinds(:date, :timeliness)
+# => []
+```
+
+### `#relevant_validators_on(attribute, *kinds)`
+
+Returns validator that will be applied to the named attribute considering the instance current state: flat validators and conditional validators whose condition is met.  
+
+```ruby
+class Article < ApplicationRecord
+  include ActiveModel::Validations::Reflection
+  
+  enum :status, %i[draft published]
+  
+  validates :date,
+            presence: true,
+            timeliness: { type: :date, if: :published? }
+end
+
+article = Article.new
+article.relevant_validators_on(:date)
+# => [#<ActiveModel::Validations::PresenceValidator […]>]
+
+article.status = :published
+article.relevant_validators_on(:date)
+# => [#<ActiveModel::Validations::PresenceValidator […]>, #<ValidatesTimeliness::Validator […]>]
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at <https://github.com/notus-sh/active_model_validations_reflection>.

data/Rakefile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+task default: :spec

data/active_model_validations_reflection.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'lib/active_model_validations_reflection/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'active_model_validations_reflection'
+  spec.version       = ActiveModelValidationsReflection::VERSION
+  spec.licenses      = ['Apache-2.0']
+  spec.authors       = ['Gaël-Ian Havard']
+  spec.email         = ['gael-ian@notus.sh']
+
+  spec.summary       = 'ActiveModel extension on validations reflection'
+  spec.description   = 'An ActiveModel extension for more expressive validations reflection'
+  spec.homepage      = 'https://github.com/notus-sh/active_model_validations_reflection'
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.require_paths = ['lib']
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.6.0')
+
+  spec.add_dependency  'activemodel',    '>= 3.2'
+  spec.add_dependency  'activesupport',  '>= 3.2'
+
+  spec.add_development_dependency 'bundler',  '~> 2.1'
+  spec.add_development_dependency 'rake',     '~> 13.0'
+  spec.add_development_dependency 'rspec',    '~> 3.10.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-rake'
+  spec.add_development_dependency 'rubocop-rspec'
+end

data/lib/active_model/validations/reflection.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+
+module ActiveModel
+  module Validations
+    module Reflection
+      extend ActiveSupport::Concern
+
+      module Helpers
+        class << self
+          def flat_validator?(validator)
+            !(validator.options.key?(:if) || validator.options.key?(:unless))
+          end
+
+          def relevant_validator?(validator, instance)
+            condition = validator.options.key?(:if) ? validator.options[:if] : validator.options[:unless]
+            result = evaluate_condition(condition, instance)
+
+            (validator.options.key?(:unless) ? !result : !!result)
+          end
+
+          def evaluate_condition(condition, instance)
+            return condition.call(instance) if condition.respond_to?(:call)
+            return instance.send(condition) if condition.is_a?(::Symbol) && instance.respond_to?(condition)
+
+            condition
+          end
+        end
+      end
+
+      module ClassMethods
+        def validators_of_kinds(*kinds)
+          return validators if kinds.size.zero?
+
+          validators.select do |validator|
+            kinds.include?(validator.kind)
+          end
+        end
+
+        def flat_validators_of_kinds(*kinds)
+          validators_of_kinds(*kinds).select do |validator|
+            Helpers.flat_validator?(validator)
+          end
+        end
+
+        def validators_on_of_kinds(attribute, *kinds)
+          return validators_on(attribute) if kinds.size.zero?
+
+          validators_on(attribute).select do |validator|
+            kinds.include?(validator.kind)
+          end
+        end
+
+        def flat_validators_on_of_kinds(attribute, *kinds)
+          validators_on_of_kinds(attribute, *kinds).select do |validator|
+            Helpers.flat_validator?(validator)
+          end
+        end
+      end
+
+      def relevant_validators_on(attribute, *kinds)
+        self.class.validators_on_of_kinds(attribute, *kinds).select do |validator|
+          next true if Helpers.flat_validator?(validator)
+
+          Helpers.relevant_validator?(validator, self)
+        end
+      end
+    end
+  end
+end

data/lib/active_model_validations_reflection.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'active_model'
+require 'active_model/validations/reflection'
+
+module ActiveModelValidationsReflection
+end

data/lib/active_model_validations_reflection/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ActiveModelValidationsReflection
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: active_model_validations_reflection
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gaël-Ian Havard
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An ActiveModel extension for more expressive validations reflection
+email:
+- gael-ian@notus.sh
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- active_model_validations_reflection.gemspec
+- lib/active_model/validations/reflection.rb
+- lib/active_model_validations_reflection.rb
+- lib/active_model_validations_reflection/version.rb
+homepage: https://github.com/notus-sh/active_model_validations_reflection
+licenses:
+- Apache-2.0
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: ActiveModel extension on validations reflection
+test_files: []