anony 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30ab02373cbc28f7d884d0fdfa88da77ec4a1628056332363d9899f7627e629d
-  data.tar.gz: bfbad23ad3325b0641ef5cfb2cfb21859f0db5b2a388982342bc43e74df722ac
+  metadata.gz: ebdd2184f519951dc6fef205b2e55c0b1eaadc50849f91e17087521e6ec3d887
+  data.tar.gz: 8be91d24763bf780ba745cd0c4a4d9f9283637b79a2a3b32c4e0476366a675ce
 SHA512:
-  metadata.gz: f10ce2f8c110fae434df6c37c6946b99715f25b2790ab0da3f8784a991e88cf5f7927800099d23e1b6b5a38f55439bd97d2078382b88139213b943e38515015b
-  data.tar.gz: 716e44ce317a2712c81e038e0757cca8e99db144a7c8612830fe0af413153859593ca7a45d5c0ce7b55c3f2117ee6fc8bbcc9ee84ffa8e69a4bcbbc61990ffaa
+  metadata.gz: 57a6da624bb0c53df166d32b530cbae6fb17966091a72105424513044e6fcabdf67179a56d494e7d242b836559edd5a0384f13a20544e43f564e27fa9a437fd8
+  data.tar.gz: 51533727cb125403cc1ee87fb95ea23b8fcaff4cf73a1f5fa67a071805e299ff6924f9093e0458037805fd8fc219221091ac7657b4b85e81dd7d95ba079a9d72

data/.github/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 10

data/.github/workflows/test.yml

@@ -0,0 +1,37 @@
+name: tests
+
+on:
+  push:
+
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+      - name: Run rubocop
+        run: bundle exec rubocop --parallel --extra-details --display-style-guide
+
+  tests:
+    strategy:
+      matrix:
+        ruby-version: [2.6, 2.7, 3.0, 3.1]
+        rails-version: [6.0, 6.1, 7.0]
+        exclude:
+          - ruby-version: 2.6
+            rails-version: 7.0
+    runs-on: ubuntu-latest
+    env:
+      RAILS_VERSION: ${{ matrix.rails-version }}
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: "${{ matrix.ruby-version }}"
+      - name: Run tests
+        run: bundle exec rspec --format RSpec::Github::Formatter

data/.rubocop.yml

@@ -4,9 +4,16 @@ inherit_gem:
 
 AllCops:
   TargetRubyVersion: 3.0
+  NewCops: enable
 
 Layout/LineLength:
   Max: 100
 
+Gemspec/DevelopmentDependencies:
+  EnforcedStyle: gemspec
+
 Gemspec/RequiredRubyVersion:
   Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# v1.2.0
+
+- Add support for configuring multiple superclasses for the `DefineDeletionStrategy` cop [#98](https://github.com/gocardless/anony/pull/98)
+- Introduce helpers (selectors) for anonymising all a subject's records [#97](https://github.com/gocardless/anony/pull/97)
+
 # v1.1.0
 
 - Drop ruby 2.4 and 2.5 support

data/README.md

@@ -243,6 +243,42 @@ irb(main):003:0> manager
  => #<Manager first_name="e9ab2800-d4b9-4227-94a7-7f81118d8a8a" last_name="previous-name-of-42">
 ```
 
+### Anonymising many records, or anonymising by subject
+
+**Note**: This is an experimental feature and has not been tested widely
+in production environments.
+
+You can use selectors to anonymise multiple records. You first define a block for
+a specific subject that returns a list of anonymisable records.
+
+```ruby
+anonymise do
+  selectors do
+    for_subject(:user_id) { |user_id| find_all_users(user_id) }
+  end
+end
+```
+
+You can also use `scopes`, `where`, etc when defining your selectors:
+
+```ruby
+anonymise do
+  selectors do
+    for_subject(:user_id) { |user_id| where(user_id: user_id) }
+  end
+end
+```
+
+This can then be used to anonymise all those subject using this API:
+
+```ruby
+ModelName.anonymise_for!(:user_id, "user_1234")
+```
+
+If you attempt to anonymise records with a selector that has not been defined it
+will throw an error.
+
+
 ### Identifying anonymised records
 
 If your model has an `anonymised_at` column, Anony will automatically set that value
@@ -281,6 +317,12 @@ class Employees < ApplicationRecord
 end
 ```
 
+There is also a helper defined when `Anony::Anonymisable" is included:
+
+```ruby
+Employees.anonymised?
+```
+
 ### Preventing anonymisation
 
 You might have a need to preserve model data in some (or all) circumstances. Anony exposes
@@ -365,6 +407,7 @@ Anony::Config.ignore_fields(:id, :created_at, :updated_at)
 By default, `Config.ignore_fields` is an empty array and all fields are considered
 anonymisable.
 
+
 ## Testing
 
 This library ships with a set of useful RSpec examples for your specs. Just require them
@@ -446,6 +489,15 @@ Lint/DefineDeletionStrategy:
   ModelSuperclass: Acme::Record
 ```
 
+If your models use multiple superclasses, you can specify a list of superclasses in your `.rubocop.yml`. Note that you will have to specify `ApplicationRecord` explicitly in this list should you want to lint all models which inherit from `ApplicationRecord`.
+```yml
+Lint/DefineDeletionStrategy:
+  ModelSuperclass: 
+  - Acme::Record
+  - UmbrellaCorp::Record
+
+```
+
 ## License & Contributing
 
 * Anony is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/anony.gemspec

@@ -24,15 +24,16 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 2.6"
 
-  spec.add_development_dependency "bundler", "~> 2.2.0"
-  spec.add_development_dependency "gc_ruboconfig", "~> 2.24.0"
+  spec.add_development_dependency "bundler", "~> 2"
+  spec.add_development_dependency "gc_ruboconfig", "~> 3.6.0"
   spec.add_development_dependency "rspec", "~> 3.9"
-  spec.add_development_dependency "rspec_junit_formatter", "~> 0.4"
+  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", "~> 1.4.1"
+  spec.add_development_dependency "sqlite3", "~> 1.6.1"
 
   spec.add_dependency "activerecord", ">= 5.2", "< 8"
   spec.add_dependency "activesupport", ">= 5.2", "< 8"
+  spec.metadata["rubygems_mfa_required"] = "true"
 end

data/lib/anony/anonymisable.rb

@@ -2,7 +2,8 @@
 
 require "active_support/core_ext/module/delegation"
 
-require_relative "./strategies/overwrite"
+require_relative "not_anonymisable_exception"
+require_relative "strategies/overwrite"
 require_relative "model_config"
 
 module Anony
@@ -54,6 +55,30 @@ module Anony
         @anonymise_config.valid?
       end
 
+      # Finds the records that relate to a particular subject and runs anonymise on
+      # each of them. If a selector is not defined it will raise an exception.
+      def anonymise_for!(subject, subject_id)
+        records = anonymise_config.
+          select(subject, subject_id)
+        records.map do |record|
+          if !record.respond_to?(:anonymise!)
+            raise NotAnonymisableException, record
+          end
+
+          record.anonymise!
+        end
+      end
+
+      # Checks if a selector has been defined for a given subject.
+      # This is useful for when writing tests to check all models have a valid selector
+      # for a given subject.
+      # @return [Boolean]
+      # @example
+      #   Manager.selector_for?(:user_id)
+      def selector_for?(subject)
+        anonymise_config.selector_for?(subject)
+      end
+
       attr_reader :anonymise_config
     end
 
@@ -74,6 +99,10 @@ module Anony
       Result.failed(e)
     end
 
+    def anonymised?
+      anonymised_at.present?
+    end
+
     # @!visibility private
     def self.included(base)
       base.extend(ClassMethods)

data/lib/anony/cops/define_deletion_strategy.rb

@@ -36,9 +36,8 @@ module RuboCop
         end
 
         def model?(node)
-          return unless (superclass = node.children[1])
-
-          superclass.const_name == model_superclass_name
+          superclass = node.children[1]
+          model_superclass_name.include? superclass&.const_name
         end
 
         def class_name(node)
@@ -46,7 +45,15 @@ module RuboCop
         end
 
         def model_superclass_name
-          cop_config["ModelSuperclass"] || "ApplicationRecord"
+          unless cop_config["ModelSuperclass"]
+            return ["ApplicationRecord"]
+          end
+
+          if cop_config["ModelSuperclass"].is_a?(Array)
+            return cop_config["ModelSuperclass"]
+          end
+
+          [cop_config["ModelSuperclass"]]
         end
       end
     end

data/lib/anony/field_level_strategies.rb

@@ -147,7 +147,7 @@ module Anony
     #   end
     OverwriteHex = Struct.new(:max_length) do
       def call(_existing_value)
-        hex_length = max_length / 2 + 1
+        hex_length = (max_length / 2) + 1
         SecureRandom.hex(hex_length)[0, max_length]
       end
     end

data/lib/anony/model_config.rb

@@ -2,8 +2,9 @@
 
 require "active_support/core_ext/module/delegation"
 
-require_relative "./strategies/destroy"
-require_relative "./strategies/overwrite"
+require_relative "strategies/destroy"
+require_relative "strategies/overwrite"
+require_relative "selectors"
 
 module Anony
   class ModelConfig
@@ -29,6 +30,7 @@ module Anony
     def initialize(model_class, &block)
       @model_class = model_class
       @strategy = UndefinedStrategy.new
+      @selectors_config = nil
       @skip_filter = nil
       instance_exec(&block) if block
     end
@@ -45,6 +47,7 @@ module Anony
     end
 
     delegate :valid?, :validate!, to: :@strategy
+    delegate :select, to: :@selectors_config
 
     # Use the deletion strategy instead of anonymising individual fields. This method is
     # incompatible with the fields strategy.
@@ -86,6 +89,30 @@ module Anony
       @strategy = Strategies::Overwrite.new(@model_class, &block)
     end
 
+    # Define selectors to select records that apply to a particular subject.
+    # This method taks a configuration block that then builds Selectors
+    #
+    # @see Anony::Selectors
+    #
+    # @example
+    #
+    #   anonymise do
+    #     selectors do
+    #       for_subject(:user_id) { |user_id| self.select_for_user(user_id) }
+    #     end
+    #   end
+    #
+    #   ModelName.anonymise_for!(:user_id, "user_1234")
+    def selectors(&block)
+      @selectors_config = Selectors.new(@model_class, &block)
+    end
+
+    def selector_for?(subject)
+      return false if @selectors_config.nil?
+
+      @selectors_config.selectors[subject].present?
+    end
+
     # Prevent any anonymisation strategy being applied when the provided block evaluates
     # to true. The block is executed in the model context.
     #

data/lib/anony/not_anonymisable_exception.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Anony
+  class NotAnonymisableException < StandardError
+    def initialize(record)
+      @record = record
+      super("Record does not implement anonymise!.
+            Have you included Anony::Anonymisable and a config?")
+    end
+  end
+end

data/lib/anony/selector_not_found_exception.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Anony
+  class SelectorNotFoundException < StandardError
+    def initialize(selector, model_name)
+      super("Selector for #{selector} not found. Make sure you have one defined in #{model_name}")
+    end
+  end
+end

data/lib/anony/selectors.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative "selector_not_found_exception"
+
+module Anony
+  class Selectors
+    def initialize(model_class, &block)
+      @model_class = model_class
+      @selectors = {}
+      instance_exec(&block) if block
+    end
+
+    attr_reader :selectors
+
+    def for_subject(subject, &block)
+      selectors[subject] = block
+    end
+
+    def select(subject, subject_id)
+      selector = selectors[subject]
+      raise SelectorNotFoundException.new(subject.to_s, @model_class.name) if selector.nil?
+
+      @model_class.instance_exec(subject_id, &selector)
+    end
+  end
+end

data/lib/anony/strategies/overwrite.rb

@@ -126,7 +126,7 @@ module Anony
 
         if already_ignored.any?
           raise ArgumentError, "Cannot ignore #{already_ignored.inspect} " \
-                              "(fields already ignored in Anony::Config)"
+                               "(fields already ignored in Anony::Config)"
         end
 
         no_op(*fields)

data/lib/anony/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: anony
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - GoCardless Engineering
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-16 00:00:00.000000000 Z
+date: 2024-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: gc_ruboconfig
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.24.0
+        version: 3.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.24.0
+        version: 3.6.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -53,19 +53,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.9'
 - !ruby/object:Gem::Dependency
-  name: rspec_junit_formatter
+  name: rspec-github
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: 2.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: 2.4.0
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.1
+        version: 1.6.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.1
+        version: 1.6.1
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -141,7 +141,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
+- ".github/dependabot.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
@@ -161,8 +162,11 @@ files:
 - lib/anony/field_exception.rb
 - lib/anony/field_level_strategies.rb
 - lib/anony/model_config.rb
+- lib/anony/not_anonymisable_exception.rb
 - lib/anony/result.rb
 - lib/anony/rspec_shared_examples.rb
+- lib/anony/selector_not_found_exception.rb
+- lib/anony/selectors.rb
 - lib/anony/skipped_exception.rb
 - lib/anony/strategies/destroy.rb
 - lib/anony/strategies/overwrite.rb
@@ -170,7 +174,8 @@ files:
 homepage: https://github.com/gocardless/anony
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:

data/.circleci/config.yml

@@ -1,54 +0,0 @@
-version: 2.1
-
-jobs:
-  test:
-    parameters:
-      ruby-version:
-        type: string
-      rails-version:
-        type: string
-
-    docker:
-      - image: cimg/ruby:<<parameters.ruby-version>>
-        environment:
-          - RAILS_VERSION=<<parameters.rails-version>>
-    steps:
-      - checkout
-
-      - restore_cache:
-          key: anony-bundler-{{ checksum "anony.gemspec" }}
-
-      - run: gem install bundler -v 2.2.33
-      - run: bundle config set path 'vendor/bundle'
-      - run: bundle install
-
-      - save_cache:
-          key: anony-bundler-{{ checksum "anony.gemspec" }}
-          paths:
-            - vendor/bundle
-
-      - run:
-          command: |
-            bundle exec rspec --profile 10 \
-                              --format RspecJunitFormatter \
-                              --out /tmp/test-results/rspec.xml \
-                              --format progress \
-                              spec
-
-      - store_test_results:
-          path: /tmp/test-results
-
-      - run: bundle exec rubocop --parallel --extra-details --display-style-guide
-
-workflows:
-  version: 2
-  tests:
-    jobs:
-      - test:
-          matrix:
-            parameters:
-              ruby-version: ["2.6", "2.7", "3.0"]
-              rails-version: ["6.0", "6.1", "7.0"]
-            exclude:
-              - ruby-version: "2.6"
-                rails-version: "7.0"