anony 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '082ffc4d41e600db7ab5d6e7ece9339939ec5ba24990023c1fafdda6e3746d35'
-  data.tar.gz: c87ea816f66fc94d3bda68b5278bee3830469a90308e09ea4abc359a2294d3a5
+  metadata.gz: 10df947501d12fc04d77ba8133487801dae18bc0bba4d13c5f08c8e68b4852c4
+  data.tar.gz: 822685bc6968e72119bbc9ee497e16e5a59d3859763372e8162cef5cd838387d
 SHA512:
-  metadata.gz: 8757b255148d5d8e419ce35222267af2bfa42c7478fc0442f05b609454fac153634b6aa16d600ae7644ab38dcc79b2d30050f6a5d4cf1681510e58ebf265f1bc
-  data.tar.gz: 9d104cf3d9c12b22d0244f7a01f0db82062e7dffd8a516ed896a51b850f149b2c0baefb161d1a63dfe2add09fabc69d93959febf3ad12fd3581fa70e7298ce1c
+  metadata.gz: d69bb5e5e66f43731c4be96eb9dbc5922979fcff55d39e839dd78a294c5d28c75e3e51ca87c9747c5f550a4bba0feaa4697882756c06520740b2efbd5fbe8676
+  data.tar.gz: d93945a2bb1556229ae9c7ca68b613acb198b15e6440342403ea7f6cfaf740f02bb6d5810a03a2c8a10574aeaab021ef93dc54fa037650743449237e1080cf78

data/.github/workflows/test.yml

@@ -2,6 +2,10 @@ name: tests
 
 on:
   push:
+    branches:
+      - master
+  pull_request:
+    types: [opened, reopened, synchronize]
 
 jobs:
   rubocop:
@@ -19,8 +23,8 @@ jobs:
   tests:
     strategy:
       matrix:
-        ruby-version: [3.1, 3.2, 3.3]
-        rails-version: [7.0, 7.1, 7.2, 8.0]
+        ruby-version: ["3.1", "3.2", "3.3", "3.4"]
+        rails-version: ["7.0", "7.1", "7.2", "8.0"]
         exclude:
           - ruby-version: 3.1
             rails-version: 8.0

data/.rubocop.yml

@@ -1,17 +1,15 @@
 inherit_from: .rubocop_todo.yml
+
 inherit_gem:
   gc_ruboconfig: rubocop.yml
 
 AllCops:
-  TargetRubyVersion: 3.0
+  TargetRubyVersion: 3.1
   NewCops: enable
 
 Layout/LineLength:
   Max: 100
 
-Gemspec/DevelopmentDependencies:
-  EnforcedStyle: gemspec
-
 Gemspec/RequiredRubyVersion:
   Enabled: false
 
@@ -20,4 +18,3 @@ RSpec/MultipleExpectations:
 
 RSpec/ExampleLength:
   Max: 15
-

data/.rubocop_todo.yml

@@ -1,24 +1,29 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2019-11-11 12:18:14 +0000 using RuboCop version 0.76.0.
+# on 2025-02-05 14:52:30 UTC using RuboCop version 1.71.2.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-RSpec/LeakyConstantDeclaration:
+# Offense count: 1
+# Configuration parameters: IgnoredMetadata.
+RSpec/DescribeClass:
   Exclude:
-    - 'spec/anony/anonymisable_spec.rb'
-    - 'spec/anony/strategies/overwrite_spec.rb'
+    - '**/spec/features/**/*'
+    - '**/spec/requests/**/*'
+    - '**/spec/routing/**/*'
+    - '**/spec/system/**/*'
+    - '**/spec/views/**/*'
+    - 'spec/anony/rspec_shared_examples_spec.rb'
 
-RSpec/ExampleLength:
+# Offense count: 3
+RSpec/LeakyConstantDeclaration:
   Exclude:
     - 'spec/anony/anonymisable_spec.rb'
+    - 'spec/anony/strategies/overwrite_spec.rb'
 
+# Offense count: 4
+# Configuration parameters: AllowedGroups.
 RSpec/NestedGroups:
-  Exclude:
-    - 'spec/anony/anonymisable_spec.rb'
-
-RSpec/DescribeClass:
-  Exclude:
-    - 'spec/anony/rspec_shared_examples_spec.rb'
+  Max: 4

data/.ruby-version

@@ -1 +1 @@
-3.3.4
+3.4.1

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## v1.7.0
+
+- Add support for Ruby 3.4
+- Add global configuration option to skip validating models before anonymisation
+
 ## v1.6.0
 
 - Add support for Rails 8.0

data/Gemfile

@@ -6,3 +6,13 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in anony.gemspec
 gemspec
+
+group :development, :test do
+  gem "bundler", "~> 2"
+  gem "database_cleaner-active_record", "~> 2.2"
+  gem "gc_ruboconfig", "~> 5.0.0"
+  gem "rspec", "~> 3.9"
+  gem "rspec-github", "~> 3.0.0"
+  gem "sqlite3", "~> 2.6.0"
+  gem "yard", "~> 0.9.20"
+end

data/README.md

@@ -410,6 +410,28 @@ Anony::Config.ignore_fields(:id, :created_at, :updated_at)
 By default, `Config.ignore_fields` is an empty array and all fields are considered
 anonymisable.
 
+### Preventing model validation before anonymisation
+
+There are cases where models may contain data that is not valid according to the validations defined on the model, and
+the default behaviour of Anony is to validate the model before anonymisation.
+
+If it is necessary to be able to anonymise models even if they contain invalid data, Anony can be configured to skip this
+validation, in which case the validations will only be run when using strategies that modify the model data, and will run
+after anonymisation when the model is saved.
+
+To configure this behaviour, you can set the following configuration option in an initializer:
+
+```ruby
+# config/initializers/anony.rb
+
+Anony::Config.validate_before_anonymisation = false
+```
+
+> Note: If you set this configuration option to `false`, be aware that a model that is invalid before anonymisation and continues
+  to be invalid after anonymisation may have new validation failures caused by the anonymisation if a strategy is incorrectly
+  defined for the model. It is recommended that you perform the anonymisation in a database transaction and roll it back if there
+  are validation errors after anonymisation.
+
 ## Testing
 
 This library ships with a set of useful RSpec examples for your specs. Just require them

data/anony.gemspec

@@ -24,16 +24,6 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 3.1"
 
-  spec.add_development_dependency "bundler", "~> 2"
-  spec.add_development_dependency "database_cleaner-active_record", "~> 2.2"
-  spec.add_development_dependency "gc_ruboconfig", "~> 5.0.0"
-  spec.add_development_dependency "rspec", "~> 3.9"
-  spec.add_development_dependency "rspec-github", "~> 2.4.0"
-  spec.add_development_dependency "yard", "~> 0.9.20"
-
-  # For integration testing
-  spec.add_development_dependency "sqlite3", "~> 2.2.0"
-
   if ENV["RAILS_VERSION"]
     spec.add_dependency "activerecord", "~> #{ENV['RAILS_VERSION']}"
     spec.add_dependency "activesupport", "~> #{ENV['RAILS_VERSION']}"

data/lib/anony/anonymisable.rb

@@ -99,7 +99,7 @@ module Anony
         raise ArgumentError, "#{self.class.name} does not have an Anony configuration"
       end
 
-      self.class.anonymise_config.validate!
+      self.class.anonymise_config.validate! if Config.validate_before_anonymisation
       self.class.anonymise_config.apply(self)
     rescue ActiveRecord::RecordNotSaved, ActiveRecord::RecordNotDestroyed => e
       Result.failed(e, self)

data/lib/anony/config.rb

@@ -12,7 +12,7 @@ module Anony
   #
   #   Anony::Config.ignore_fields(:id)
   module Config
-    mattr_accessor :ignores
+    mattr_accessor :ignores, :validate_before_anonymisation
 
     # @!visibility private
     def self.ignore?(field)
@@ -38,5 +38,14 @@ module Anony
     end
 
     self.ignores = []
+
+    # Config option to change behaviour so that validations on models being anonymised
+    # are not run before anonymisation has been performed. This means that if an invalid model
+    # would become valid after anonymisation, it will not raise an error when being anonymised.
+    #
+    # Validations are still run for the overwrite strategy when the changes to the model are saved
+    #
+    # By default this is set to true, to maintain existing behaviour
+    self.validate_before_anonymisation = true
   end
 end

data/lib/anony/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Anony
-  VERSION = "1.6.0"
+  VERSION = "1.7.0"
 end

metadata

@@ -1,113 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: anony
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - GoCardless Engineering
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-11 00:00:00.000000000 Z
+date: 2025-05-13 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2'
-- !ruby/object:Gem::Dependency
-  name: database_cleaner-active_record
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.2'
-- !ruby/object:Gem::Dependency
-  name: gc_ruboconfig
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 5.0.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 5.0.0
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.9'
-- !ruby/object:Gem::Dependency
-  name: rspec-github
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.4.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.4.0
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.20
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.20
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.2.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.2.0
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -148,7 +49,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '9'
-description:
 email:
 - engineering@gocardless.com
 executables: []
@@ -190,7 +90,6 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -205,8 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.20
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: A small library that defines how ActiveRecord models should be anonymised
   for deletion purposes.