validation_errors 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4fed7190ae44232b3441ccaa634450ceefa80ac74dd5615c6b0b58147fc3990d
-  data.tar.gz: 3fc056004f5e810c75489c009df26d2bd42f3804d163b3c2bcd2ab85665a50e4
+  metadata.gz: a477abd871a7de8b45962e84d301fa87507f75f91c63e722668c3151fa808358
+  data.tar.gz: 9546453a776ce4579cf4c32cf23fefe42cea5282331c30dc3460961a266401a6
 SHA512:
-  metadata.gz: f2fd1b962e6f1dca4fa2cdb6dc672bc45823d1e79e20a1ccbe44f5dc562207e7871c1f5637acfb8698af7c54caad3be70de5b80f44d5bdab501d76825522d11c
-  data.tar.gz: 15191622d27d105d9872cd266b9610e6c8e6db98c650aefb0efcd0ef9d833ec1f6ebe00fc7ef101443abac6c959bd099dcc6cc426a0434505bb3653ce6f53d02
+  metadata.gz: 5b248a94703c3bd0145794e06776baee1723664201b255fb47251fb8e41528c8c938f315bd48b07e23cb1d298929c3229b6dc8b1257dfc9782764fd1e2e22162
+  data.tar.gz: 64ae712dbac662fcb2458e5096e7c03ba668126cacd9a8257eb6acbd2c2afa1b90b9d9a5683b2744be6dfe2a3451cb836d9718e077f10168415502a0137cd216

data/CHANGELOG.md

@@ -1,11 +1,12 @@
-## Unreleased
+## [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,7 +1,7 @@
 PATH
   remote: .
   specs:
-    validation_errors (0.2.0)
+    validation_errors (0.3.0)
       activerecord (>= 4.1.0)
       zeitwerk (>= 2.0.0)
 
@@ -46,6 +46,7 @@ GEM
       rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.11.0)
     sqlite3 (1.5.0-arm64-darwin)
+    sqlite3 (1.5.0-x86_64-linux)
     standard (0.13.0)
       rubocop (= 1.10.0)
       rubocop-performance (= 1.9.2)
@@ -56,6 +57,7 @@ GEM
 
 PLATFORMS
   arm64-darwin-21
+  x86_64-linux
 
 DEPENDENCIES
   minitest (~> 5.0)
@@ -65,4 +67,4 @@ DEPENDENCIES
   validation_errors!
 
 BUNDLED WITH
-   2.3.21
+   2.5.18

data/README.md

@@ -184,6 +184,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. 

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,
+            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.0
 platform: ruby
 authors:
 - Alessandro Rodi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-29 00:00:00.000000000 Z
+date: 2024-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -144,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.10
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Track ActiveRecord validation errors on database