soft_validator 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64db8fb56e161e44e7a584528a2c8dd5831ce1c6e10f77d0a02305ff51ae2aea
-  data.tar.gz: 403ef75272880d067ab2657ae678bee52b7f9ff3d1297230e1ed8ae5b7025227
+  metadata.gz: 2914d0f077469311e25bce9c99d506c2f61ae2d298f5b4b16822186ca91566df
+  data.tar.gz: bce8ec1c4fedbc091b355821b270b11ac1d93affd25350a9cc316e5933a65dba
 SHA512:
-  metadata.gz: 7e62f0f978d8850a29119294f1a56cc6b52d0114c093644f7d61cb893feb5998e1ff9916d90c58be37bd6e9b5105e58943adee8b8ae8836fda06c8350864d68b
-  data.tar.gz: 9bcbfe1be63d91adad556557b50cb6dfa2babe13b851df51f3cd0fd1869cd14652dbc36d3945a1c004d6df14388a14412ddfe7e39e1bc189db7603f10292495a
+  metadata.gz: 543464c8e692cb122d2ba14674336c5947577ec65fd40a3da9cfea289e65d0eb8081b5101d209231b514e4c1ac339ff79d17a38e1271bd00302dc194b95e3c0d
+  data.tar.gz: baca486b0040cc4a5d281a81cfc42a0e8bb278fe5ef7191543957b05bd28c7b90b5b13370c35530f7f2005b3966db67798ce4d756592f1bc2bbd93168f0ffb97

data/CHANGELOG.md

@@ -4,6 +4,16 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 1.0.1
+
+### Fixed
+
+- Soft validation errors are now removed by object identity instead of by matching attribute, type, and options. Previously a soft validation could delete errors added by hard validations of the same type on the same attribute, and a soft error identical to an existing hard error would be left on the record as a duplicate.
+- Setting `enforced: false` on a soft validation now overrides the global `SoftValidator.enforced` setting.
+- The `:allow_nil`, `:allow_blank`, `:strict`, and `:prepend` options can now be used on a soft validation without raising an unknown validator error.
+- Wrapped validators with falsy options (e.g. `soft: {presence: false}`) are now skipped, matching the behavior of `validates`.
+- The `:enforced` option is now evaluated once per attribute validation instead of once per wrapped validator, so a `Proc` value (e.g. a feature flag) cannot produce inconsistent enforcement within a single validation pass.
+
 ## 1.0.0
 
 ### Added

data/README.md

@@ -1,7 +1,6 @@
 # SoftValidator
 
 [![Continuous Integration](https://github.com/bdurand/soft_validator/actions/workflows/continuous_integration.yml/badge.svg)](https://github.com/bdurand/soft_validator/actions/workflows/continuous_integration.yml)
-[![Regression Test](https://github.com/bdurand/soft_validator/actions/workflows/regression_test.yml/badge.svg)](https://github.com/bdurand/soft_validator/actions/workflows/regression_test.yml)
 [![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
 [![Gem Version](https://badge.fury.io/rb/soft_validator.svg)](https://badge.fury.io/rb/soft_validator)
 
@@ -21,21 +20,21 @@ Each of the validations in the `:soft` validation will still be run when the rec
 
 ### Notifications
 
-Soft validation errors are published via ActiveSupport notifications. You can handle errors generted from soft validations by subscribing to the `validation_error.soft_validator` event. For instance, you could log the errors to the Rails logger by adding this code to an initializer:
+Soft validation errors are published via ActiveSupport notifications. You can handle errors generated from soft validations by subscribing to the `validation_error.soft_validator` event. For instance, you could log the errors to the Rails logger by adding this code to an initializer:
 
 ```ruby
 ActiveSupport::Notifications.subscribe("validation_error.soft_validator") do |event|
   error = event.payload[:error]
-  message = "Soft validation error on {error.base.class.name}(#{error.base.id}): #{error.full_message}"
+  message = "Soft validation error on #{error.base.class.name}(#{error.base.id}): #{error.full_message}"
   Rails.logger.warn(message)
 end
 ```
 
-You can also the `SoftValidator.subscribe` helper method to set up subscriptions. This code will do the same thing as the code above:
+You can also use the `SoftValidator.subscribe` helper method to set up subscriptions. This code will do the same thing as the code above:
 
 ```ruby
 SoftValidator.subscribe do |error|
-  message = "Soft validation error on {error.base.class.name}(#{error.base.id}): #{error.full_message}"
+  message = "Soft validation error on #{error.base.class.name}(#{error.base.id}): #{error.full_message}"
   Rails.logger.warn(message)
 end
 ```
@@ -50,7 +49,7 @@ You can disable the log subscriber by calling `SoftValidator::LogSubscriber.deta
 
 ### Enforcing with feature flags
 
-You can turn a soft validation into a hard validation by setting the `:enforce` option to `true`. This will cause the validation to generate errors as normal. You can use this option to enable validation with a feature flag.
+You can turn a soft validation into a hard validation by setting the `:enforced` option to `true`. This will cause the validation to generate errors as normal. You can also set the option to a `Proc` that will be evaluated each time the validation is run, which lets you enable the validation with a feature flag.
 
 ```ruby
 class Thing < ApplicationRecord
@@ -58,16 +57,16 @@ class Thing < ApplicationRecord
             presence: true,
             soft: {
               inclusion: {in: ["feet", "meters"]},
-              enforce: ENV.fetch("ENFORCE_UNITS", !Rails.env.production?.to_s) == "true"
+              enforced: -> { ENV["ENFORCE_UNITS"] == "true" }
             }
 end
 ```
 
-The global default for enforcing soft validations can be changed by setting `SoftValidator.enforce`. If it is set to `true`, soft validations will be enforced by default. In Rails applications this is set automatically in the development and test environments since you would typically want to see the errors in those environments so that you can fix them.
+The global default for enforcing soft validations can be changed by setting `SoftValidator.enforced = true`. If it is set to `true`, soft validations will be enforced by default. In Rails applications this is set automatically in the development and test environments since you would typically want to see the errors in those environments so that you can fix them. You can opt a validation out of the global default by explicitly setting `enforced: false` on that validation.
 
 ### Conditional options
 
-If you want to add any of the standard conditional options for the validator (i.e. `:if`, `:unless`, `:on`, `:prepend`), you need to add it to the soft validator and not the wrapped validator.
+If you want to add any of the standard conditional options for the validator (i.e. `:if`, `:unless`, `:on`, `:allow_nil`, `:allow_blank`, `:prepend`), you need to add it to the soft validator and not the wrapped validator.
 
 ```ruby
 class Thing < ApplicationRecord
@@ -95,7 +94,7 @@ $ bundle
 
 Or install it yourself as:
 ```bash
-$ gem install gem "soft_validator"
+$ gem install soft_validator
 ```
 
 ## Contributing

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.0.1

data/lib/soft_validator.rb

@@ -9,7 +9,7 @@ class SoftValidator < ActiveModel::EachValidator
 
   class << self
     def enforced?
-      @enforced ||= false
+      !!@enforced
     end
 
     attr_writer :enforced
@@ -27,28 +27,37 @@ class SoftValidator < ActiveModel::EachValidator
   end
 
   def validate_each(record, attribute, value)
-    existing_errors = record.errors.errors.dup
+    enforced = enforced?
     @validators.each do |validator|
+      existing_errors = record.errors.errors.dup
       validator.validate_each(record, attribute, value)
-      next if enforced?
+      next if enforced
 
-      (record.errors.errors - existing_errors).each do |error|
-        record.errors.delete(error.attribute, error.type, **error.options)
+      new_errors = record.errors.errors.reject { |error| existing_errors.any? { |existing| existing.equal?(error) } }
+      new_errors.each do |error|
+        record.errors.errors.delete_if { |e| e.equal?(error) }
         ActiveSupport::Notifications.instrument(ERROR_EVENT, error: error)
       end
     end
   end
 
   def enforced?
-    enforced = options[:enforced]
-    enforced = enforced.call if enforced.is_a?(Proc)
-    enforced || self.class.enforced?
+    if options.key?(:enforced)
+      enforced = options[:enforced]
+      enforced = enforced.call if enforced.is_a?(Proc)
+      !!enforced
+    else
+      self.class.enforced?
+    end
   end
 
   private
 
   def wrapped_validators(klass)
-    options.except(:enforced, :if, :unless, :on).map do |validator_name, validator_options|
+    validator_options_list = options.except(:enforced, :if, :unless, :on, :allow_nil, :allow_blank, :strict, :prepend)
+    validator_options_list.filter_map do |validator_name, validator_options|
+      next unless validator_options
+
       class_name = "#{validator_name.to_s.camelize}Validator"
 
       begin

data/soft_validator.gemspec

@@ -8,6 +8,12 @@ Gem::Specification.new do |spec|
   spec.homepage = "https://github.com/bdurand/soft_validator"
   spec.license = "MIT"
 
+  spec.metadata = {
+    "homepage_uri" => spec.homepage,
+    "source_code_uri" => spec.homepage,
+    "changelog_uri" => "#{spec.homepage}/blob/main/CHANGELOG.md"
+  }
+
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   ignore_files = %w[

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: soft_validator
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Brian Durand
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-29 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -38,7 +37,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
 email:
 - bbdurand@gmail.com
 executables: []
@@ -56,8 +54,10 @@ files:
 homepage: https://github.com/bdurand/soft_validator
 licenses:
 - MIT
-metadata: {}
-post_install_message:
+metadata:
+  homepage_uri: https://github.com/bdurand/soft_validator
+  source_code_uri: https://github.com/bdurand/soft_validator
+  changelog_uri: https://github.com/bdurand/soft_validator/blob/main/CHANGELOG.md
 rdoc_options: []
 require_paths:
 - lib
@@ -72,8 +72,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key:
+rubygems_version: 4.0.3
 specification_version: 4
 summary: ActiveModel/ActiveRecord validator that can wrap other validators to notify
   of errors so that new validations can be safely added to an existing model.