invalid_record_finder 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5ef7639bb7c4e24b75291c9ddaf3561283b190c490379a51e8a3e35d1f927a74
+  data.tar.gz: e1a2c6a9b544fb3de431f5b9e7f003a416f466f21e17a3a80bff225aefa40177
+SHA512:
+  metadata.gz: d6faecd6d67a3cd6a11cb6a008621857ecda7eaf76aa881180c294be6ee578e621e19114a79def11052214e4d4360d14a33a1530177648228d339ab6c2844df4
+  data.tar.gz: 326e337b4b2ce97d3534a3c7e0071a97f17cd2cd474d32d8ad5f8a6f3f3e4852bb99793fc1632613f0c07993fba6618a1aaac3ce8ec7fa463166c556389936b0

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [1.0.0] - 2021-11-24
+
+- Initial release

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in invalid_record_finder.gemspec
+gemspec
+
+gem 'rails', '>= 5.0'
+gem 'rake', '~> 13.0'
+gem 'rspec', '~> 3.10'
+gem 'sqlite3'

data/Gemfile.lock

@@ -0,0 +1,174 @@
+PATH
+  remote: .
+  specs:
+    invalid_record_finder (1.0.0)
+      activerecord (>= 5.0)
+      fortschritt (~> 0.3)
+      tabulo (~> 2.7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activejob (= 6.1.4.1)
+      activerecord (= 6.1.4.1)
+      activestorage (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      mail (>= 2.7.1)
+    actionmailer (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      actionview (= 6.1.4.1)
+      activejob (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.1.4.1)
+      actionview (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      rack (~> 2.0, >= 2.0.9)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activerecord (= 6.1.4.1)
+      activestorage (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      nokogiri (>= 1.8.5)
+    actionview (6.1.4.1)
+      activesupport (= 6.1.4.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.1.4.1)
+      activesupport (= 6.1.4.1)
+      globalid (>= 0.3.6)
+    activemodel (6.1.4.1)
+      activesupport (= 6.1.4.1)
+    activerecord (6.1.4.1)
+      activemodel (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+    activestorage (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activejob (= 6.1.4.1)
+      activerecord (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      marcel (~> 1.0.0)
+      mini_mime (>= 1.1.0)
+    activesupport (6.1.4.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    builder (3.2.4)
+    concurrent-ruby (1.1.9)
+    crass (1.0.6)
+    diff-lcs (1.4.4)
+    erubi (1.10.0)
+    fortschritt (0.3.6)
+    globalid (1.0.0)
+      activesupport (>= 5.0)
+    i18n (1.8.11)
+      concurrent-ruby (~> 1.0)
+    loofah (2.12.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (1.0.2)
+    method_source (1.0.0)
+    mini_mime (1.1.2)
+    mini_portile2 (2.6.1)
+    minitest (5.14.4)
+    nio4r (2.5.8)
+    nokogiri (1.12.5)
+      mini_portile2 (~> 2.6.1)
+      racc (~> 1.4)
+    nokogiri (1.12.5-x86_64-darwin)
+      racc (~> 1.4)
+    racc (1.6.0)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.1.4.1)
+      actioncable (= 6.1.4.1)
+      actionmailbox (= 6.1.4.1)
+      actionmailer (= 6.1.4.1)
+      actionpack (= 6.1.4.1)
+      actiontext (= 6.1.4.1)
+      actionview (= 6.1.4.1)
+      activejob (= 6.1.4.1)
+      activemodel (= 6.1.4.1)
+      activerecord (= 6.1.4.1)
+      activestorage (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      bundler (>= 1.15.0)
+      railties (= 6.1.4.1)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.2)
+      loofah (~> 2.3)
+    railties (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      method_source
+      rake (>= 0.13)
+      thor (~> 1.0)
+    rake (13.0.6)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    sprockets (4.0.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.4.1)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.4.2)
+    tabulo (2.7.1)
+      tty-screen (= 0.8.1)
+      unicode-display_width (= 2.1.0)
+    thor (1.1.0)
+    tty-screen (0.8.1)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
+    websocket-driver (0.7.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.5.1)
+
+PLATFORMS
+  ruby
+  x86_64-darwin-19
+
+DEPENDENCIES
+  invalid_record_finder!
+  rails (>= 5.0)
+  rake (~> 13.0)
+  rspec (~> 3.10)
+  sqlite3
+
+BUNDLED WITH
+   2.2.32

data/LICENSE.txt

@@ -0,0 +1,190 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2021 gut.org gAG
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,76 @@
+# InvalidRecordFinder
+
+Find entries in your database that no longer pass your validations.
+
+These poor little records need your help because they can't be updated anymore 😢
+
+## Installation
+
+Bundle or gem install `invalid_record_finder`.
+
+## Usage
+
+### Basic example
+
+A common use case is to periodically check all records and send mails if invalid records are found.
+
+Models must inherit from `ApplicationRecord` and `ActionMailer` must be configured for the mail sending to work.
+
+```ruby
+# my_regular_task.rake
+
+result = InvalidRecordFinder.call
+result.mail(from: 'noreply@myapp.com', to: 'devs@myapp.com')
+```
+
+### Targetting specific models
+
+To check only specific models or scopes:
+
+```ruby
+result = InvalidRecordFinder.call(models: [ImportantModel])
+```
+
+To check all models except some:
+
+```ruby
+result = InvalidRecordFinder.call(
+  ignored_models:     [HugeTableThing, IrrelevantThing],
+  ignored_namespaces: 'Legacy::',
+)
+```
+
+### Other options
+
+Findings can also be put into CSV files.
+
+The files will be in `Rails.root.join('tmp', 'invalid_records')` by default.
+
+```ruby
+InvalidRecordFinder.call.save_csvs
+```
+
+Per default, there is one mail or CSV for each model with invalid records.
+
+To send just a single mail or write a single CSV:
+
+```ruby
+result = InvalidRecordFinder.call.flatten
+result.mail(from: 'noreply@myapp.com', to: 'devs@myapp.com')
+result.save_csvs(to: my_custom_dir)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/betterplace/invalid_record_finder.
+
+## License
+
+`InvalidRecordFinder` is released under the [Apache License 2.0](LICENSE.txt) and Copyright 2021 [gut.org gAG](https://gut.org).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: %i[spec]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'invalid_record_finder'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/invalid_record_finder.gemspec

@@ -0,0 +1,32 @@
+
+require_relative 'lib/invalid_record_finder/version'
+
+Gem::Specification.new do |spec|
+  spec.name     = 'invalid_record_finder'
+  spec.version  = InvalidRecordFinder::VERSION
+  spec.authors  = ['betterplace development team']
+  spec.email    = ['developers@betterplace.org']
+
+  spec.summary  = 'Finds invalid ActiveRecord entries and reports them'
+  spec.homepage = 'https://github.com/betterplace/invalid_record_finder'
+  spec.license  = 'Apache-2.0'
+
+  spec.required_ruby_version = '>= 2.6.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = "#{spec.homepage}/blob/master/CHANGELOG.md"
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activerecord', '>= 5.0'
+  spec.add_dependency 'fortschritt', '~> 0.3'
+  spec.add_dependency 'tabulo', '~> 2.7'
+end

data/lib/invalid_record_finder/finding.rb

@@ -0,0 +1,26 @@
+# lightweight representation of a single validation error on one record
+module InvalidRecordFinder
+  class Finding
+    attr_reader :model, :field, :field_value, :message, :id
+
+    def initialize(record, field, message)
+      @model       = record.class.name
+      @field       = field
+      @field_value = record[field]
+      @message     = message
+      @id          = record.id
+    end
+
+    def to_a
+      [model, field, field_value, message, id]
+    end
+
+    def to_h
+      { model: model, field: field, field_value: field_value, message: message, id: id }
+    end
+
+    def ==(other)
+      other.is_a?(self.class) && other.to_h == to_h
+    end
+  end
+end

data/lib/invalid_record_finder/findings_list.rb

@@ -0,0 +1,53 @@
+# Collects Findings
+module InvalidRecordFinder
+  class FindingsList
+    require 'forwardable'
+    extend Forwardable
+
+    def_delegators :@findings, :[], :empty?, :size, :to_a
+
+    def initialize(data = [])
+      @findings = data
+    end
+
+    def add_if_invalid(record)
+      return if record.valid? # Just make sure that the validation has run
+
+      record.errors.each do |err|
+        findings << InvalidRecordFinder::Finding.new(
+          record, err.attribute.to_s, err.message
+        )
+      end
+    rescue => e
+      # handle and report exceptions that occur during validation
+      findings << InvalidRecordFinder::Finding.new(record, 'EXCEPTION', e.message)
+    end
+
+    require 'tabulo'
+
+    def to_table
+      Tabulo::Table.new(findings.first(100), *headers, align_header: :left).pack
+    end
+
+    require 'csv'
+
+    def to_csv
+      CSV.generate do |csv|
+        csv << headers
+        findings.map(&:to_a).each { |line| csv << line }
+      end
+    end
+
+    def ==(other)
+      other.is_a?(self.class) && other.to_a == to_a
+    end
+
+    private
+
+    attr_reader :findings
+
+    def headers
+      %i[model field field_value message id]
+    end
+  end
+end

data/lib/invalid_record_finder/mailer.rb

@@ -0,0 +1,40 @@
+begin
+  require 'action_mailer'
+rescue LoadError
+  # leave this class undefined if ActionMailer is not present
+  return
+end
+
+module InvalidRecordFinder
+
+  # sends mails
+  class Mailer < ActionMailer::Base
+    def mail(model_name:, findings_list:, from:, to:, subject_prefix: nil)
+      attachments["#{model_name}.csv"] = findings_list.to_csv
+      super(
+        from:    from,
+        to:      to,
+        body:    build_body(model_name, findings_list),
+        subject: build_subject(model_name, findings_list, subject_prefix),
+      )
+    end
+
+    private
+
+    def build_body(model_name, findings_list)
+      <<~END
+        # Errors on #{model_name}
+        ```
+        #{findings_list.to_table}
+        ```
+      END
+    end
+
+    def build_subject(model_name, findings_list, prefix)
+      [
+        prefix,
+        "InvalidRecordFinder found #{findings_list.size} invalid #{model_name} records",
+      ].compact.join(' ')
+    end
+  end
+end

data/lib/invalid_record_finder/model_picker.rb

@@ -0,0 +1,39 @@
+module InvalidRecordFinder
+  module ModelPicker
+    def self.call(given_models: [], ignored_models: [], ignored_namespaces: [])
+      given_models = parse_given_models(given_models)
+      return given_models if given_models.any?
+
+      ignored_models     = to_string_array(ignored_models)
+      ignored_namespaces = to_string_array(ignored_namespaces)
+
+      Rails.configuration.cache_classes || Rails.application.eager_load!
+
+      models = defined?(ApplicationRecord) && ApplicationRecord
+        .descendants
+        .reject(&:abstract_class?)
+        .map(&:name)
+      models.blank? && raise(Error, 'No models inherit from ApplicationRecord.')
+
+      if ignored_namespaces.any?
+        models = models.grep_v(/\A(?:#{Regexp.union(ignored_namespaces)})/)
+      end
+      models.empty? && raise(Error, 'All models are ignored through namespaces.')
+
+      if ignored_models.any?
+        models -= ignored_models.map(&:to_s)
+      end
+      models.empty? && raise(Error, 'All models are ignored.')
+
+      models.map(&:constantize)
+    end
+
+    def self.parse_given_models(arg)
+      Array(arg).map { |el| el.respond_to?(:constantize) ? el.constantize : el }.compact
+    end
+
+    def self.to_string_array(arg)
+      Array(arg).map { |obj| obj.respond_to?(:name) ? obj.name : obj&.to_s }.compact
+    end
+  end
+end

data/lib/invalid_record_finder/result.rb

@@ -0,0 +1,59 @@
+# A map of model names to FindingsLists.
+module InvalidRecordFinder
+  class Result
+    require 'forwardable'
+    extend Forwardable
+
+    def_delegators :@hash, :[], :[]=, :each, :empty?, :to_h
+
+    def initialize(data = {})
+      @hash = data
+    end
+
+    # Flattens all the FindingsLists (for multiple models) into one,
+    # e.g. to send as a single mail or write into a single CSV.
+    #
+    # @return [InvalidRecordFinder::Result]
+    def flatten
+      flat_list = FindingsList.new(@hash.values.flat_map(&:to_a))
+      self.class.new('ApplicationRecord' => flat_list)
+    end
+
+    def mail(from:, to:, subject_prefix: nil, delivery_method: :deliver_now)
+      each do |model_name, findings_list|
+        findings_list.empty? || Mailer.mail(
+          model_name:     model_name,
+          findings_list:  findings_list,
+          from:           from,
+          to:             to,
+          subject_prefix: subject_prefix,
+        ).send(delivery_method)
+      end
+    end
+
+    require 'fileutils'
+
+    def save_csvs(to: default_csv_dir)
+      FileUtils.mkdir_p(to)
+
+      each.with_object([]) do |(model_name, findings_list), acc|
+        next if findings_list.empty?
+
+        acc << (path = File.join(to, "#{model_name}.csv"))
+        File.write(path, findings_list.to_csv)
+      end
+    end
+
+    def default_csv_dir
+      Rails.root.join('tmp', 'invalid_records')
+    end
+
+    def ==(other)
+      other.is_a?(self.class) && other.to_h == to_h
+    end
+
+    def inspect
+      "#<#{self.class}:0x%x>" % (object_id << 1)
+    end
+  end
+end

data/lib/invalid_record_finder/scanner.rb

@@ -0,0 +1,29 @@
+# Goes through all records of the given models, collects all invalid ones.
+module InvalidRecordFinder
+  module Scanner
+    class << self
+      # @return [InvalidRecordFinder::Result]
+      def call(models:, verbose: false)
+        models.each_with_object(Result.new) do |model, acc|
+          puts "Checking #{model}..." if verbose
+          list = FindingsList.new
+          each_record(model, verbose: verbose) { |r| list.add_if_invalid(r) }
+          puts "Found #{list.size} invalid #{model}\n\n" if verbose
+          acc[model.name] = list
+        end
+      end
+
+      private
+
+      require 'fortschritt'
+
+      def each_record(model, verbose: false)
+        scope = model.all
+        if verbose
+          scope = scope.with_fortschritt
+        end
+        scope.find_each { |record| yield(record.fortschritt) }
+      end
+    end
+  end
+end

data/lib/invalid_record_finder/version.rb

@@ -0,0 +1,3 @@
+module InvalidRecordFinder
+  VERSION = '1.0.0'
+end

data/lib/invalid_record_finder.rb

@@ -0,0 +1,26 @@
+require_relative 'invalid_record_finder/finding'
+require_relative 'invalid_record_finder/findings_list'
+require_relative 'invalid_record_finder/mailer'
+require_relative 'invalid_record_finder/model_picker'
+require_relative 'invalid_record_finder/result'
+require_relative 'invalid_record_finder/scanner'
+require_relative 'invalid_record_finder/version'
+
+module InvalidRecordFinder
+  class Error < StandardError; end
+
+  # @return [InvalidRecordFinder::Result]
+  def self.call(
+    models: [],
+    ignored_namespaces: [],
+    ignored_models: [],
+    verbose: false
+  )
+    models = ModelPicker.call(
+      given_models: models,
+      ignored_models: ignored_models,
+      ignored_namespaces: ignored_namespaces,
+    )
+    Scanner.call(models: models, verbose: verbose)
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: invalid_record_finder
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- betterplace development team
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-11-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: fortschritt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: tabulo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+description:
+email:
+- developers@betterplace.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- invalid_record_finder.gemspec
+- lib/invalid_record_finder.rb
+- lib/invalid_record_finder/finding.rb
+- lib/invalid_record_finder/findings_list.rb
+- lib/invalid_record_finder/mailer.rb
+- lib/invalid_record_finder/model_picker.rb
+- lib/invalid_record_finder/result.rb
+- lib/invalid_record_finder/scanner.rb
+- lib/invalid_record_finder/version.rb
+homepage: https://github.com/betterplace/invalid_record_finder
+licenses:
+- Apache-2.0
+metadata:
+  homepage_uri: https://github.com/betterplace/invalid_record_finder
+  source_code_uri: https://github.com/betterplace/invalid_record_finder
+  changelog_uri: https://github.com/betterplace/invalid_record_finder/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Finds invalid ActiveRecord entries and reports them
+test_files: []