soft_validator 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 64db8fb56e161e44e7a584528a2c8dd5831ce1c6e10f77d0a02305ff51ae2aea
+  data.tar.gz: 403ef75272880d067ab2657ae678bee52b7f9ff3d1297230e1ed8ae5b7025227
+SHA512:
+  metadata.gz: 7e62f0f978d8850a29119294f1a56cc6b52d0114c093644f7d61cb893feb5998e1ff9916d90c58be37bd6e9b5105e58943adee8b8ae8836fda06c8350864d68b
+  data.tar.gz: 9bcbfe1be63d91adad556557b50cb6dfa2babe13b851df51f3cd0fd1869cd14652dbc36d3945a1c004d6df14388a14412ddfe7e39e1bc189db7603f10292495a

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+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.0
+
+### Added
+
+- Initial release

data/MIT_LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2023 Brian Durand
+
+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 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/README.md

@@ -0,0 +1,109 @@
+# 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)
+
+This gem adds a soft validator for use with ActiveModel/ActiveRecord. It is intended to solve issues that can arise when adding new validations to an existing model. Once your model is running in production and taking real world inputs, it can be risky to add a new validation since it might break some of those inputs. This gem allows you to soft launch a new validation by running it in a non-enforcing mode. This will allow you to see what would have failed without actually failing the validation. You can then fix the issues and turn on the validation.
+
+## Usage
+
+The easiest way to use the gem is simply to wrap your existing validations with a `:soft` validation.
+
+```ruby
+class Thing < ApplicationRecord
+  validates :units, presence: true, soft: {inclusion: {in: ["feet", "meters"]}}
+end
+```
+
+Each of the validations in the `:soft` validation will still be run when the record is validated. However, if there are any errors, they will not be added to the record `errors` object and the record will still be considered valid.
+
+### 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:
+
+```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}"
+  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:
+
+```ruby
+SoftValidator.subscribe do |error|
+  message = "Soft validation error on {error.base.class.name}(#{error.base.id}): #{error.full_message}"
+  Rails.logger.warn(message)
+end
+```
+
+If you just want to log the errors, you can use the built in log subscriber instead (it does the same thing as the above subscription). You **do not** need to do this in a Rails application; it will be done for you automatically.
+
+```ruby
+SoftValidator::LogSubscriber.attach
+```
+
+You can disable the log subscriber by calling `SoftValidator::LogSubscriber.detach`.
+
+### 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.
+
+```ruby
+class Thing < ApplicationRecord
+  validates :units,
+            presence: true,
+            soft: {
+              inclusion: {in: ["feet", "meters"]},
+              enforce: ENV.fetch("ENFORCE_UNITS", !Rails.env.production?.to_s) == "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.
+
+### 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.
+
+```ruby
+class Thing < ApplicationRecord
+  validates :units,
+            soft: {inclusion: {in: ["feet", "meters"]}, if: :units_changed?}
+
+  # This won't work; the `if` option cannot be on the wrapped validator:
+  # validates :units,
+  #           soft: {inclusion: {in: ["feet", "meters"], if: :units_changed?}}
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "soft_validator"
+```
+
+Then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install gem "soft_validator"
+```
+
+## Contributing
+
+Open a pull request on GitHub.
+
+Please use the [standardrb](https://github.com/testdouble/standard) syntax and lint your code with `standardrb --fix` before submitting.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/soft_validator/log_subscriber.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+# Log subscriber for soft validation errors.
+class SoftValidator::LogSubscriber < ActiveSupport::LogSubscriber
+  class << self
+    # Helper method to attach the log subscriber.
+    def attach
+      attach_to :soft_validator
+    end
+
+    # Helper method to detach the log subscriber.
+    def detach
+      detach_from :soft_validator
+    end
+  end
+
+  def validation_error(event)
+    return unless logger&.warn?
+
+    error = event.payload[:error]
+    record = error.base
+    ref = record.class.name
+    ref = "#{ref}(#{record.id})" if record.respond_to?(:id)
+    message = "Soft validation error on #{ref}: #{error.full_message}"
+
+    logger.warn(message)
+  end
+
+  def logger
+    self.class.logger
+  end
+end

data/lib/soft_validator/railtie.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class SoftValidator::Railtie < Rails::Railtie
+  initializer("soft_validator.initialize") do
+    SoftValidator::LogSubscriber.attach
+    SoftValidator.enforced = (Rails.env.development? || Rails.env.test?)
+  end
+end

data/lib/soft_validator.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require "active_model"
+
+class SoftValidator < ActiveModel::EachValidator
+  VERSION = File.read(File.join(__dir__, "..", "VERSION")).strip.freeze
+
+  ERROR_EVENT = "validation_error.soft_validator"
+
+  class << self
+    def enforced?
+      @enforced ||= false
+    end
+
+    attr_writer :enforced
+
+    def subscribe(&block)
+      ActiveSupport::Notifications.subscribe(ERROR_EVENT) do |event|
+        yield(event.payload[:error])
+      end
+    end
+  end
+
+  def initialize(options)
+    super
+    @validators = wrapped_validators(options[:class])
+  end
+
+  def validate_each(record, attribute, value)
+    existing_errors = record.errors.errors.dup
+    @validators.each do |validator|
+      validator.validate_each(record, attribute, value)
+      next if enforced?
+
+      (record.errors.errors - existing_errors).each do |error|
+        record.errors.delete(error.attribute, error.type, **error.options)
+        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?
+  end
+
+  private
+
+  def wrapped_validators(klass)
+    options.except(:enforced, :if, :unless, :on).map do |validator_name, validator_options|
+      class_name = "#{validator_name.to_s.camelize}Validator"
+
+      begin
+        validator = klass.const_get(class_name)
+      rescue NameError
+        raise ArgumentError, "Unknown validator: '#{class_name}'"
+      end
+
+      validator_options = {} unless validator_options.is_a?(Hash)
+      validator.new(validator_options.merge(class: klass, attributes: attributes))
+    end
+  end
+end
+
+require_relative "soft_validator/log_subscriber"
+
+if defined?(Rails::Railtie)
+  require_relative "soft_validator/railtie"
+end

data/soft_validator.gemspec

@@ -0,0 +1,36 @@
+Gem::Specification.new do |spec|
+  spec.name = "soft_validator"
+  spec.version = File.read(File.join(__dir__, "VERSION")).strip
+  spec.authors = ["Brian Durand"]
+  spec.email = ["bbdurand@gmail.com"]
+
+  spec.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."
+  spec.homepage = "https://github.com/bdurand/soft_validator"
+  spec.license = "MIT"
+
+  # 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[
+    .
+    Appraisals
+    Gemfile
+    Gemfile.lock
+    Rakefile
+    config.ru
+    assets/
+    bin/
+    gemfiles/
+    spec/
+  ]
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject { |f| ignore_files.any? { |path| f.start_with?(path) } }
+  end
+
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activemodel", ">= 7.0"
+
+  spec.add_development_dependency "bundler"
+
+  spec.required_ruby_version = ">= 2.7"
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: soft_validator
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Brian Durand
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-03-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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:
+email:
+- bbdurand@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- MIT_LICENSE.txt
+- README.md
+- VERSION
+- lib/soft_validator.rb
+- lib/soft_validator/log_subscriber.rb
+- lib/soft_validator/railtie.rb
+- soft_validator.gemspec
+homepage: https://github.com/bdurand/soft_validator
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+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.
+test_files: []