validation_errors 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4fed7190ae44232b3441ccaa634450ceefa80ac74dd5615c6b0b58147fc3990d
-  data.tar.gz: 3fc056004f5e810c75489c009df26d2bd42f3804d163b3c2bcd2ab85665a50e4
+  metadata.gz: 83e3819827bf1a4c43f5cc7f460ebaf26c51e0661c438d896e0d434cf705d038
+  data.tar.gz: 83fda6815b49bd7bb28b70b717379ce6e421d26b558a05df1ddfcf1efd06b260
 SHA512:
-  metadata.gz: f2fd1b962e6f1dca4fa2cdb6dc672bc45823d1e79e20a1ccbe44f5dc562207e7871c1f5637acfb8698af7c54caad3be70de5b80f44d5bdab501d76825522d11c
-  data.tar.gz: 15191622d27d105d9872cd266b9610e6c8e6db98c650aefb0efcd0ef9d833ec1f6ebe00fc7ef101443abac6c959bd099dcc6cc426a0434505bb3653ce6f53d02
+  metadata.gz: ef287bf9b54ad6d38725df355b54cfa8671f6d4416064eaaca13837f31b95aef9066ebb1b0aa21496f9f6c5eec28ef7a7a742d2d4bf1022db1e89798ff3620c9
+  data.tar.gz: '08680fc49f5d4c2b56b7d37a4ee188022208e5032f8d785517dfdd8711b0debb35d1b7be6277da31c9d52b0508ecf89ef5a52087648407cc99055a7ae86e0f93'

data/CHANGELOG.md

@@ -1,11 +1,16 @@
-## Unreleased
+## [0.3.1] - 2025-08-12
 
-- ...
+- Documentation changes and some more tests to specify how to track errors on nested associations.
+
+## [0.3.0] - 2024-11-05
+
+- Fix persistance in case of rolled back transactions.
+- Filter `Rails.application.config.filter_parameters` by default. Does not support procs. 
 
 ## [0.2.0] - 2022-12-29
 
-- Allow to use a custom action name when tracking errors
+- Allow to use a custom action name when tracking errors.
 
 ## [0.1.0] - 2022-09-19
 
-- Initial release
+- Initial release.

data/Gemfile.lock

@@ -1,68 +1,106 @@
 PATH
   remote: .
   specs:
-    validation_errors (0.2.0)
+    validation_errors (0.3.1)
       activerecord (>= 4.1.0)
       zeitwerk (>= 2.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (7.0.4)
-      activesupport (= 7.0.4)
-    activerecord (7.0.4)
-      activemodel (= 7.0.4)
-      activesupport (= 7.0.4)
-    activesupport (7.0.4)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
+    activemodel (7.2.2.1)
+      activesupport (= 7.2.2.1)
+    activerecord (7.2.2.1)
+      activemodel (= 7.2.2.1)
+      activesupport (= 7.2.2.1)
+      timeout (>= 0.4.0)
+    activesupport (7.2.2.1)
+      base64
+      benchmark (>= 0.3)
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
       minitest (>= 5.1)
-      tzinfo (~> 2.0)
-    ast (2.4.2)
-    concurrent-ruby (1.1.10)
-    i18n (1.12.0)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+    ast (2.4.3)
+    base64 (0.1.2)
+    benchmark (0.4.1)
+    bigdecimal (3.2.2)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.3)
+    drb (2.2.3)
+    i18n (1.14.7)
       concurrent-ruby (~> 1.0)
-    minitest (5.16.3)
-    parallel (1.22.1)
-    parser (3.1.2.1)
+    json (2.13.2)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    logger (1.7.0)
+    minitest (5.25.5)
+    parallel (1.27.0)
+    parser (3.3.9.0)
       ast (~> 2.4.1)
+      racc
+    prism (1.4.0)
+    racc (1.8.1)
     rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.5.0)
-    rexml (3.2.5)
-    rubocop (1.10.0)
+    rake (13.3.0)
+    regexp_parser (2.11.1)
+    rexml (3.4.1)
+    rubocop (1.56.4)
+      base64 (~> 0.1.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.2.2.3)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.21.0)
-      parser (>= 3.1.1.0)
-    rubocop-performance (1.9.2)
-      rubocop (>= 0.90.0, < 2.0)
-      rubocop-ast (>= 0.4.0)
-    ruby-progressbar (1.11.0)
-    sqlite3 (1.5.0-arm64-darwin)
-    standard (0.13.0)
-      rubocop (= 1.10.0)
-      rubocop-performance (= 1.9.2)
-    tzinfo (2.0.5)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.46.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    rubocop-performance (1.23.1)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    ruby-progressbar (1.13.0)
+    securerandom (0.4.1)
+    sqlite3 (1.5.4-arm64-darwin)
+    sqlite3 (1.5.4-x86_64-linux)
+    standard (1.31.2)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.56.4)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.2)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.6.0)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.23.0)
+    timeout (0.4.3)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.3.0)
-    zeitwerk (2.6.6)
+    unicode-display_width (2.6.0)
+    zeitwerk (2.6.18)
 
 PLATFORMS
   arm64-darwin-21
+  arm64-darwin-24
+  x86_64-linux
 
 DEPENDENCIES
   minitest (~> 5.0)
   rake (~> 13.0)
   sqlite3 (~> 1.5.0)
-  standard (~> 0.13.0)
+  standard (~> 1.31.0)
   validation_errors!
 
 BUNDLED WITH
-   2.3.21
+   2.5.18

data/README.md

@@ -4,7 +4,8 @@ _Because shit happens_
 
 This gem helps you keep track of the ActiveRecord validation errors that have been triggered on a model.
 
-It persists them on a `validation_errors` database table the following information:
+It persists them on a `validation_errors` database table with:
+
 * time of the error
 * model name
 * model id (if available)
@@ -18,17 +19,17 @@ This gem has been extracted from various Ruby On Rails apps where I had this nee
 
 If you have a validation error, you want to keep track of it...but how?
 * You can use a logger, but then you have to parse the logs to get the information you need. i.e. is not structured.
-* You can use an error tracker, like Sentry, but this isn't really an error, is it? If you have many, it might pollute your errors tracker.
-* You can use a database table, and that's what this gem does.
+* You can use an error tracker, like Sentry, but this isn't really an error, is it? If you have many, it might pollute your error tracker.
+* You can use a database table! And that's exactly what this gem does.
 
 This gem will keep track of the errors, and give you all the freedom to query it and extract statistics and make analysis.
-By analysing from time to time these data, you might found out the following:
+By analysing these data from time to time, you might found out the following:
 * Your UI sucks
 * Your validations are too strict
 * Your validations are too loose
 * Your client-side validations are not working
 * Your client-side validations are too loose
-* This bullet point list has been generated by copilot
+* This bullet point list has been generated by AI
 
 ## Installation
 
@@ -100,6 +101,10 @@ class ApplicationRecord < ActiveRecord::Base
 end
 ```
 
+### Validate nested attributes
+
+If you don't specify `accepts_nested_attributes_for` for nested attributes, only a generic `invalid` error will be tracked for associations.
+
 We currently don't support (PR welcome):
 * enable globally and disable on a specific model `skip_track_validation_errors`
 * enable only for specific actions `track_validation_errors only: [:create]`
@@ -184,6 +189,34 @@ group by 1, 2
 FlatValidationError.group(:invalid_model_name, :error_column).count
 ```
 
+## RailsAdmin integration
+
+We provide here some code samples to integrate the models in [RailsAdmin](https://github.com/sferik/rails_admin).
+
+This configuration will give you a basic configuration to work with the validation errors efficiently.
+```ruby
+config.model "ValidationError" do
+  list do
+    include_fields :invalid_model_name, :invalid_model_id, :action, :created_at
+
+    field :details, :string do
+      visible false
+      searchable true
+      filterable true
+    end
+  end
+
+  show do
+    include_fields :invalid_model_name, :invalid_model_id, :action
+
+    field(:created_at)
+    field(:details) do
+      formatted_value { "<pre>#{JSON.pretty_generate(bindings[:object].details)}</pre>".html_safe }
+    end
+  end
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. 
@@ -199,10 +232,8 @@ which will create a git tag for the version, push git commits and the created ta
 Bug reports and pull requests are welcome on GitHub at https://github.com/coorasse/validation_errors. 
 This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/coorasse/validation_errors/blob/master/CODE_OF_CONDUCT.md).
 
+Try to be a decent human being while interacting with other people.
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the ValidationErrors project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/coorasse/validation_errors/blob/master/CODE_OF_CONDUCT.md).

data/lib/validation_error.rb

@@ -2,9 +2,37 @@
 
 class ValidationError < ActiveRecord::Base
   def self.track(invalid_model, action: invalid_model.persisted? ? "update" : "create")
+    details = filter_sensible_information(invalid_model.errors.details)
     create!(invalid_model_name: invalid_model.class.name,
-            invalid_model_id: invalid_model.id,
-            details: invalid_model.errors.details,
-            action: action)
+      invalid_model_id: invalid_model.id,
+      details: details,
+      action: action)
+  end
+
+  def self.filter_sensible_information(details)
+    filter_parameters = if defined?(Rails) && Rails.respond_to?(:application)
+      Rails.application.config.filter_parameters
+    else
+      []
+    end
+    filtered_details = details.dup
+    filtered_details.each do |column_name, errors|
+      filter_parameters.each do |filter|
+        must_filter = case filter
+        when Regexp
+          filter.match?(column_name)
+        when String, Symbol
+          filter.to_s == column_name.to_s
+        end
+        if must_filter
+          errors.each do |error|
+            if error[:value].present?
+              error[:value] = "***"
+            end
+          end
+        end
+      end
+    end
+    filtered_details
   end
 end

data/lib/validation_errors.rb

@@ -22,18 +22,31 @@ module ValidationErrors
     end
 
     module InstanceMethods
-      def save(**options)
+      def update(attributes)
         super.tap do |result|
           ValidationError.track(self) unless result
         end
       end
 
+      def update!(attributes)
+        super
+      rescue ActiveRecord::RecordInvalid
+        ValidationError.track(self)
+        raise
+      end
+
+      def save(**options)
+        super.tap do |result|
+          ValidationError.track(self) unless result || persisted?
+        end
+      end
+
       # Attempts to save the record just like {ActiveRecord::Base#save}[rdoc-ref:Base#save] but
       # will raise an ActiveRecord::RecordInvalid exception instead of returning +false+ if the record is not valid.
       def save!(**options)
         super
       rescue ActiveRecord::RecordInvalid
-        ValidationError.track(self)
+        ValidationError.track(self) unless persisted?
         raise
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: validation_errors
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Alessandro Rodi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-29 00:00:00.000000000 Z
+date: 2025-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: 1.31.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: 1.31.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -106,10 +106,8 @@ files:
 - ".semaphore/semaphore.yml"
 - ".standard.yml"
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
-- LICENSE.txt
 - README.md
 - Rakefile
 - lib/flat_validation_error.rb
@@ -144,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.10
+rubygems_version: 3.3.27
 signing_key:
 specification_version: 4
 summary: Track ActiveRecord validation errors on database

data/CODE_OF_CONDUCT.md

@@ -1,84 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the overall community
-
-Examples of unacceptable behavior include:
-
-* The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
-  address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
-
-Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at coorasse@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series of actions.
-
-**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within the community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
-available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
-
-Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2022 Alessandro Rodi
-
-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.