recheck 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f6d708bcbdaeb426979687daffc616bf45829d7d3cc82f36bbf5331664ac737
-  data.tar.gz: dc56ce8289e425936891ecb106f1b4a7a7c82b58035bd4b4f4c90d0353312bbd
+  metadata.gz: 486a238104811d7c0c89f9139bce5a9d484f4394e3c23645e1329635a2d462c2
+  data.tar.gz: af3d9af6493d3b684c1047635ad2481f638ad89166d01f1f11fd99c3e57e615b
 SHA512:
-  metadata.gz: 4a368e70331a30b93eeeafc5f75cc92fe94fa06ceba27d66a334367f17b84c666e4cbeb32106826fd779b0c3ffd40e5b04656b63c08b3fd214f71fc6cde83898
-  data.tar.gz: e6b8607c5338ac141da261503da2c8e820b2397adef3a2e6926577bca5e97162a2024c3eec34bfba36e705b7d2d09b99ee377f681c1f9f99582a83bd337f5433
+  metadata.gz: '059a3fd50bc81f4788297e9c767094ea6fda175c4328ca6922778929c41612da1cec31e419a751e8705daf1b6a8409dd16185156947d5321a0f6976f109d113c'
+  data.tar.gz: c0237b5b87bcee83242f5c8a753eb89a61936519b9a2eedb1e39b071a832726b2c5a50e4bd036a1f126d892d399aecccd3e7c158f9c66793b913aca996774957

data/changelog.md

@@ -0,0 +1,26 @@
+## [Unreleased]
+
+## 0.8.0 - 2025-09-05
+
+* Fixed generated check for ActiveRecord length validation
+
+## 0.7.0 - 2025-09-05
+
+* Fixed including rake tasks.
+
+## 0.6.0 - 2025-09-05
+
+* Folded recheck-rails gem into primary gem with conditional loading
+
+## 0.5.0 - 2025-07-30
+
+* setup: Generate some docs for reporters and checkers.
+* Runner, reporter: add `around_query`
+
+## 0.4.0 - 2025-07-16
+
+* Public beta.
+
+## 0.1.0 - 2024-03-16
+
+* Placeholder.

data/comm-license.md

@@ -0,0 +1,185 @@
+# END-USER LICENSE AGREEMENT
+
+------------------------------------------------------------------------------
+
+IMPORTANT: THIS SOFTWARE END-USER LICENSE AGREEMENT ("EULA") IS A LEGAL AGREEMENT (“Agreement”) BETWEEN YOU (THE CUSTOMER, EITHER AS AN INDIVIDUAL OR, IF PURCHASED OR OTHERWISE ACQUIRED BY OR FOR AN ENTITY, AS AN ENTITY) AND RECHECK LIMITED WORKER COOPERATIVE ASSOCIATION ("Recheck LWCA").
+READ IT CAREFULLY BEFORE COMPLETING THE INSTALLATION PROCESS AND USING RECHECK PRO AND RELATED SOFTWARE COMPONENTS (“SOFTWARE”).
+IT PROVIDES A LICENSE TO USE THE SOFTWARE AND CONTAINS WARRANTY INFORMATION AND LIABILITY DISCLAIMERS.
+BY INSTALLING AND USING THE SOFTWARE, YOU ARE CONFIRMING YOUR ACCEPTANCE OF THE SOFTWARE AND AGREEING TO BECOME BOUND BY THE TERMS OF THIS AGREEMENT.
+
+------------------------------------------------------------------------------
+
+The Open Source version of the Software (“LGPL Version”) is licensed under the terms of the GNU Lesser General Public License version 3.0 (“LGPL”) and not under this EULA.
+In order to use the Software under this Agreement, you must receive a “Source URL” at the time of purchase, in accordance with the scope of use and other terms specified for each type of Software and as set forth in this Section 1 of this Agreement.
+
+## 1. License Grant
+
+### 1.1 General Use
+This Agreement grants you a non-exclusive, non-transferable, limited license to the use rights for the Software, without the right to grant sublicenses, subject to the terms and conditions in this Agreement. The Software is licensed, not sold.
+
+### 1.2 Unlimited Organization License
+If you purchased an Organization License (included with the Recheck Pro Software), you may install the Software on an unlimited number of Hosts.
+“Host” means any physical or virtual machine which is controlled by you.
+You may also run an unlimited number of Workers.
+“Worker” means a thread within a Recheck server process which executes jobs.
+You may concurrently run the software on an unlimited number of Hosts, with each host running an unlimited number of Workers.
+
+### 1.3 Limited Enterprise License
+If you purchased a Limited License for the Recheck Enterprise Software, you may install the Software on an unlimited number of Hosts.
+“Host” means any physical or virtual machine which is controlled by you.
+The aggregate number of Workers run by the hosts must not exceed the maximum number of Workers authorized at the time of purchase.
+“Worker” means a thread within a Recheck server process which executes jobs. In order to run additional Workers, you must purchase an additional allowance from Recheck LWCA.
+
+### 1.4 Enterprise Site License
+If you purchased a Site License for the Recheck Enterprise Software, you may install the Software on an unlimited number of Hosts.
+“Host” means any physical or virtual machine which is controlled by you.
+You may also run an unlimited number of Workers.
+“Worker” means a thread within a Recheck server process which executes jobs.
+You may concurrently run the software on an unlimited number of Hosts, with each host running an unlimited number of Workers.
+
+### 1.5 Appliance License
+If you purchased an Appliance License, you may distribute the Software in any applications, frameworks, or elements (collectively referred to as an “Application” or “Applications”) that you develop using the Software in accordance with this EULA, provided that such distribution does not violate the restrictions set forth in section 3 of this EULA.
+You must not remove, obscure or interfere with any copyright, acknowledgment, attribution, trademark, warning or disclaimer statement affixed to, incorporated in or otherwise applied in connection with the Software.
+You are required to ensure that the Software is not reused by or with any applications other than those with which you distribute it as permitted herein.
+For example, if You install the Software on a customer's server, that customer is not permitted to use the Software independently of your Application.
+You must inform Recheck LWCA of your knowledge of any infringing use of the Software by any of your customers.
+You are liable for compliance by those third parties with the terms and conditions of this EULA.
+You will not owe Recheck LWCA any royalties for your distribution of the Software in accordance with this EULA.
+
+### 1.6 Archive Copies
+You are entitled to make a reasonable amount of copies of the Software for archival purposes.
+Each copy must reproduce all copyright and other proprietary rights notices on or in the Software Product.
+
+### 1.7 Electronic Delivery
+All Software and license documentation shall be delivered by electronic means unless otherwise specified on the applicable invoice or at the time of purchase.
+Software shall be deemed delivered when it is made available for download by you (“Delivery”).
+
+### 2 Modifications
+Recheck LWCA shall provide you with source code so that you can create Modifications of the original software.
+“Modification” means: (a) any addition to or deletion from the contents of a file included in the original Software or previous Modifications created by You, or (b) any new file that contains any part of the original Software or previous Modifications.
+While you retain all rights to any original work authored by you as part of the Modifications, We continue to own all copyright and other intellectual property rights in the Software.
+
+## 3. Restricted Uses
+
+### 3.1 Reversing
+You shall not (and shall not allow any third party to):
+(a) decompile, disassemble, or otherwise reverse engineer the Software or attempt to reconstruct or discover any source code, underlying ideas, algorithms, file formats or programming interfaces of the Software by any means whatsoever (except and only to the extent that applicable law prohibits or restricts reverse engineering restrictions);
+(b) distribute, sell, sublicense, rent, lease or use the Software for time sharing, hosting, service provider or like purposes, except as expressly permitted under this Agreement;
+(c) redistribute the Software or Modifications other than by including the Software or a portion thereof within your own product, which must have substantially different functionality than the Software or Modifications and must not allow any third party to use the Software or Modifications, or any portions thereof, for software development or application development purposes;
+(d) redistribute the Software as part of a product, "appliance" or "virtual server";
+(e) redistribute the Software on any server which is not directly under your control;
+(f) remove any product identification, proprietary, copyright or other notices contained in the Software;
+(g) modify any part of the Software, create a derivative work of any part of the Software (except as permitted in Section 4), or incorporate the Software, except to the extent expressly authorized in writing by Recheck LWCA;
+(h) publicly disseminate performance information or analysis (including, without limitation, benchmarks) from any source relating to the Software;
+(i) utilize any equipment, device, software, or other means designed to circumvent or remove any form of Source URL or copy protection used by Recheck LWCA in connection with the Software, or use the Software together with any authorization code, Source URL, serial number, or other copy protection device not supplied by Recheck LWCA;
+(j) use the Software to develop a product which is competitive with any Recheck LWCA product offerings;
+or (k) use unauthorized Source URLS or keycode(s) or distribute or publish Source URLs or keycode(s), except as may be expressly permitted by Recheck LWCA in writing.
+
+If your unique Source URL is ever published, Recheck LWCA reserves the right to terminate your access without notice.
+
+### 3.2 Reimplementing
+Under no circumstances may you use the software as part of a product or service that provides similar functionality to the software itself.
+
+### 4 Ownership
+Notwithstanding anything to the contrary contained herein, except for the limited license rights expressly provided herein, Recheck LWCA and its suppliers have and will retain all rights, title and interest (including, without limitation, all patent, copyright, trademark, trade secret and other intellectual property rights) in and to the Software and all copies, modifications and derivative works thereof (including any changes which incorporate any of your ideas, feedback or suggestions).
+You acknowledge that you are obtaining only a limited license right to the Software, and that irrespective of any use of the words “purchase”, “sale” or like terms hereunder no ownership rights are being conveyed to you under this Agreement or otherwise.
+
+### 5 Fees and Payment
+The Software license fees will be due and payable in full as set forth in the applicable invoice or at the time of purchase.
+If the Software does not function properly within two weeks of purchase, please contact us within those two weeks for a refund.
+You shall be responsible for all taxes, withholdings, duties and levies arising from the order (excluding taxes based on the net income of Recheck LWCA).
+
+### 6 Support, Maintenance and Services.
+Subject to the terms and conditions of this Agreement, as set forth in your invoice, and as set forth on the latest version of the Recheck Pro support page (https://github.com/recheckdev/recheck-ruby/wiki/Commercial-Support), support and maintenance services may be included with the purchase of your license subscription.
+
+## 7. Term of Agreement
+
+### 7.1 Term
+This Agreement is effective as of the Delivery of the Software and expires at such time as all license and service subscriptions hereunder have expired in accordance with their own terms (the “Term”).
+For clarification, the term of your license under this Agreement may be perpetual, limited for Evaluation Version, or designated as a fixed-term license in the Invoice, and shall be specified at your time of purchase.
+Either party may terminate this Agreement (including all related Invoices) if the other party: (a) fails to cure any material breach of this Agreement within thirty (30) days after written notice of such breach, provided that Recheck LWCA may terminate this Agreement immediately upon any breach of Section 3 or if you exceed any other restrictions contained in Section 1, unless otherwise specified in this agreement; (b) ceases operation without a successor; or (c) seeks protection under any bankruptcy, receivership, trust deed, creditors arrangement, composition or comparable proceeding, or if any such proceeding is instituted against such party (and not dismissed within sixty (60) days)).
+Termination is not an exclusive remedy and the exercise by either party of any remedy under this Agreement will be without prejudice to any other remedies it may have under this Agreement, by law, or otherwise.
+
+### 7.2 Termination
+Upon any termination of this Agreement, you shall cease any and all use of any Software and destroy all copies thereof.
+
+### 7.3 Expiration of License
+Upon the expiration of any term under this Agreement, (a) all Software updates and services pursuant to the license shall cease, (b) you may only continue to run existing installations of the Software, (c) you may not install the Software on any additional Hosts, and (d) any new installation of the Software shall require the purchase of a new license subscription from Recheck LWCA.
+
+### 8 Disclaimer of Warranties
+The Software is provided "as is," with all faults, defects and errors, and without warranty of any kind.
+Recheck LWCA does not warrant that the Software will be free of bugs, errors, viruses or other defects, and Recheck LWCA shall have no liability of any kind for the use of or inability to use the Software, the Software content or any associated service, and you acknowledge that it is not technically practicable for Recheck LWCA to do so.
+To the maximum extent permitted by applicable law, Recheck LWCA disclaims all warranties, express, implied, arising by law or otherwise, regarding the Software, the Software content and their respective performance or suitability for your intended use, including without limitation any implied warranty of merchantability, fitness for a particular purpose.
+
+## 9. Limitation of Liability
+In no event will Recheck LWCA be liable for any direct, indirect, consequential, incidental, special, exemplary, or punitive damages or liabilities whatsoever arising from or relating to the Software, the Software content or this Agreement, whether based on contract, tort (including negligence), strict liability or other theory, even if Recheck LWCA has been advised of the possibility of such damages.
+
+In no event will Recheck LWCA' liability exceed the Software license price as indicated in the invoice. The existence of more than one claim will not enlarge or extend this limit.
+
+## 10 Remedies
+Your exclusive remedy and Recheck LWCA' entire liability for breach of this Agreement shall be limited, at Recheck LWCA' sole and exclusive discretion, to (a) replacement of any defective software or documentation; or (b) refund of the license fee paid to Recheck LWCA, payable in accordance with Recheck LWCA' refund policy.
+
+## 11. Acknowledgements
+
+### 11.1 Consent to the Use of Data
+You agree that Recheck LWCA and its affiliates may collect and use technical information gathered as part of the product support services.
+Recheck LWCA may use this information solely to improve products and services and will not disclose this information in a form that personally identifies you.
+
+### 11.2 Verification
+We or a certified auditor acting on our behalf, may, upon its reasonable request and at its expense, audit you with respect to the use of the Software.
+Such audit may be conducted by mail, electronic means or through an in-person visit to your place of business.
+Any such in-person audit shall be conducted during regular business hours at your facilities and shall not unreasonably interfere with your business activities.
+We shall not remove, copy, or redistribute any electronic material during the course of an audit.
+If an audit reveals that you are using the Software in a way that is in material violation of the terms of the EULA, then you shall pay our reasonable costs of conducting the audit.
+In the case of a material violation, you agree to pay Us any amounts owing that are attributable to the unauthorized use.
+In the alternative, We reserve the right, at our sole option, to terminate the licenses for the Software.
+
+### 11.3 Government End Users
+If the Software and related documentation are supplied to or purchased by or on behalf of the United States Government, then the Software is deemed to be "commercial software" as that term is used in the Federal Acquisition Regulation system.
+Rights of the United States shall not exceed the minimum rights set forth in FAR 52.227-19 for "restricted computer software".
+All other terms and conditions of this Agreement apply.
+
+### 12 Third Party Software
+Examples included in Software may provide links to third party libraries or code (collectively “Third Party Software”) to implement various functions.
+Third Party Software does not comprise part of the Software.
+In some cases, access to Third Party Software may be included along with the Software delivery as a convenience for demonstration purposes.
+Such source code and libraries may be included in the “…/examples” source tree delivered with the Software and do not comprise the Software.
+Licensee acknowledges (1) that some part of Third Party Software may require additional licensing of copyright and patents from the owners of such, and (2) that distribution of any of the Software referencing or including any portion of a Third Party Software may require appropriate licensing from such third parties.
+
+
+## 13. Miscellaneous
+
+### 13.1 Entire Agreement
+This Agreement sets forth our entire agreement with respect to the Software and the subject matter hereof and supersedes all prior and contemporaneous understandings and agreements whether written or oral.
+
+### 13.2 Amendment
+Recheck LWCA reserves the right, in its sole discretion, to amend this Agreement from time.
+Amendments to this Agreement can be located at: https://github.com/recheckdev/recheck-ruby/blob/main/COMM-LICENSE.
+
+### 13.3 Assignment
+You may not assign this Agreement or any of its rights under this Agreement without the prior written consent of Recheck LWCA and any attempted assignment without such consent shall be void.
+
+### 13.4 Export Compliance
+You agree to comply with all applicable laws and regulations, including laws, regulations, orders or other restrictions on export, re-export or redistribution of software.
+
+### 13.5 Indemnification
+You agree to defend, indemnify, and hold harmless Recheck LWCA from and against any lawsuits, claims, losses, damages, fines and expenses (including attorneys' fees and costs) arising out of your use of the Software or breach of this Agreement.
+
+### 13.6 Governing Law
+This Agreement is governed by the laws of the State of Illinois and the United States without regard to conflicts of laws provisions thereof, and without regard to the United Nations Convention on the International Sale of Goods or the Uniform Computer Information Transactions Act, as currently enacted by any jurisdiction or as may be codified or amended from time to time by any jurisdiction.
+The jurisdiction and venue for actions related to the subject matter hereof shall be the state of Illinois and United States federal courts located in Chicago, Illinois, and both parties hereby submit to the personal jurisdiction of such courts.
+
+### 13.7 Attorneys' Fees and Costs
+The prevailing party in any action to enforce this Agreement will be entitled to recover its attorneys' fees and costs in connection with such action.
+
+### 13.8 Severability
+If any provision of this Agreement is held by a court of competent jurisdiction to be invalid, illegal, or unenforceable, the remainder of this Agreement will remain in full force and effect.
+
+### 13.9 Waiver
+Failure or neglect by either party to enforce at any time any of the provisions of this licence Agreement shall not be construed or deemed to be a waiver of that party's rights under this Agreement.
+
+### 13.10 Headings
+The headings of sections and paragraphs of this Agreement are for convenience of reference only and are not intended to restrict, affect or be of any weight in the interpretation or construction of the provisions of such sections or paragraphs.
+
+### 14 Contact Information
+If you have any questions about this EULA, or if you want to contact Recheck LWCA for any reason, please direct correspondence to info@recheck.coop.

data/lib/recheck/rails/setup.rb

@@ -94,25 +94,26 @@ module Recheck
               FunctionPlaceholder.new inspect:, name:, comment: "Coming soon to Recheck beta"
             when ActiveRecord::Validations::LengthValidator
               or_clauses = []
-              if type == :stirng || type == :integer
+              if type == :string || type == :text || type == :integer
                 if validator.options[:is]
                   or_clauses << %{"LENGTH(`#{column.name}`) = '')"}
                 end
                 if validator.options[:minimum] && validator.options[:maximum]
-                  or_clauses << %{"LENGTH(`#{column.name}`) >= #{validator.options[:minimum]} and "LENGTH(`#{column.name}`) <= #{validator.options[:maximum]}}
+                  or_clauses << %{"LENGTH(`#{column.name}`) <= #{validator.options[:minimum]} and LENGTH(`#{column.name}`) >= #{validator.options[:maximum]}"}
                 elsif validator.options[:minimum]
-                  or_clauses << %{"LENGTH(`#{column.name}`) >= #{validator.options[:minimum]}}
+                  or_clauses << %{"LENGTH(`#{column.name}`) <= #{validator.options[:minimum]}"}
                 elsif validator.options[:maximum]
-                  or_clauses << %{"LENGTH(`#{column.name}`) <= #{validator.options[:maximum]}}
+                  or_clauses << %{"LENGTH(`#{column.name}`) >= #{validator.options[:maximum]}"}
                 end
               elsif type == :boolean
-                comment = "Validating length of a boolean is backend-dependednt and a strange idea."
+                comment = "Validating length of a boolean is backend-dependent and a strange idea."
               else
-                comment = "Recheck doesn't know how to handle presence on a #{type}, please report."
+                comment = "Recheck doesn't know how to handle length on a #{type}, please report."
               end
               if !validator.options[:allow_nil] && !validator.options[:allow_blank]
                 or_clauses << "#{column.name}: nil"
               end
+              Query.new inspect:, name:, warning:, comment:, or_clauses:
             when ActiveRecord::Validations::NumericalityValidator
               FunctionPlaceholder.new inspect:, name:, comment: "Coming soon to Recheck beta"
             when ActiveRecord::Validations::PresenceValidator

data/lib/recheck/rails/version.rb

@@ -0,0 +1 @@
+../../../recheck/lib/recheck/version.rb

data/lib/recheck/tasks/recheck_tasks.rake

@@ -0,0 +1,19 @@
+namespace :recheck do
+  desc "Set up a recheck suite"
+  task setup: :environment do
+    # Eager load all models for introspection
+    Rails.application.eager_load!
+
+    require "recheck/commands"
+    require "recheck/rails/setup"
+
+    Recheck::Command::Setup.new(argv: []).run
+  end
+
+  desc "Run recheck checks"
+  task :run, [:args] => :environment do |_t, args|
+    require "recheck/commands"
+
+    Recheck::Command::Run.new(argv: args[:args]&.split || []).run
+  end
+end

data/lib/recheck/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Recheck
-  VERSION = '0.6.0'
+  VERSION = '0.8.0'
 end

data/license.md

@@ -0,0 +1,9 @@
+Copyright (c) Recheck Limited Worker Cooperative Association
+
+Recheck is an Open Source project licensed under the terms of the LGPLv3 license.
+See <http://www.gnu.org/licenses/lgpl-3.0.html> for license text.
+
+Recheck Pro and Recheck Enterprise have a commercial-friendly license.
+You can find the commercial license in COMM-LICENSE.md.
+
+Visit https://recheck.dev for purchasing options.

data/readme.md

@@ -0,0 +1,400 @@
+Beta note:
+Recheck is in __early beta__.
+You should expect and report crashes, bugs, or missing features.
+It is safe to try out because, by design, it does not write to your database.
+
+Please don't submit Recheck to Lobsters/Reddit/Hacker News/etc. yet,
+I'd really like it to exercise it and reach 1.0 first.
+
+# Recheck
+
+Recheck is a tool for checking the correctness of production data, inspired by an internal tool at Stripe.
+
+Have you ever pulled a record out of your database and been surprised to find it's not valid?
+
+    Order.find(123).valid?
+    => false
+
+Huh!?
+
+You've probably seen this sort of problem, where production data is inconsistent or "impossible".
+Not every row, but one in a few hundred thousand or a few million.
+When you have a background job, hit a third-party API, or have a state machine that measures transition in days,
+you sometimes get these bad records where there's a few `NULL`s where there shouldn't be,
+a couple fields on a record contradict each other, or associated records are missing.
+
+**It's not your codebase. This happens in every database at scale.**
+
+In theory no background job would crash at 3 AM halfway through its run and every business rule would have perfectly reliable SQL constraints.
+But the cost of perfection is very high, perhaps infinitely high.
+
+**Recheck is the missing tool for pragmatically addressing data integrity.**
+
+When you see a user report or an exception, you have to query to see if there's more bad data.
+With Recheck you wrap up that query in a "check", a small bit of code like a unit test for your production data.
+Out of the box it can detect and use your model validations, but the real value is in writing your own checks as you implement code or investigate bugs.
+You can manually run your checks, or stand up a Recheck service to run them continuously in the background.
+
+It's worth writing a check any time you have:
+
+- A background job that edits or adds records
+- A null is replaced by a third-party API call
+- A painful bug you don't want to see again
+- A slow state machine
+- Any technical or business rule logic that is difficult to write a db constraint for
+
+(Not using Ruby? Sign up to [get notified](https://recheck.dev) when Recheck is available in more languages.)
+
+
+## Install and Configure
+
+Add Recheck to your `Gemfile`:
+
+    gem "recheck"
+
+Recheck runs against production data, so don't put it only in a `development` or `test` group like a testing tool.
+
+Generate basic checks:
+
+    # if you're using Rails, run:
+
+    $ bundle exec rails recheck:setup
+    creating recheck/
+    generating recheck/recheck_helper.rb
+    creating recheck/site/domain_checker.rb
+    creating recheck/site/tls_checker.rb
+    detected ActiveRecord models, creating recheck/model/
+      app/models/comment.rb -> recheck/model/comment_checker.rb
+      app/models/story.rb -> recheck/model/story_checker.rb
+      app/models/user.rb -> recheck/model/user_checker.rb
+    detected ActiveJob jobs, creating recheck/job/
+      app/jobs/user_cleanup_job.rb -> recheck/job/user_cleanup_checker.rb
+    detected Sidekiq workers, creating recheck/worker/
+      app/workers/refresh.rb -> recheck/worker/refresh_checker.rb
+
+
+    # if you're not using Rails, run:
+
+    $ bundle exec recheck setup
+    [you'll get shorter but pretty similar output]
+
+Run `git add --all` and `git commit` to record a baseline because you'll probably edit them in a minute.
+
+**You should immediately run these default checks to start finding bad data.**
+
+
+## Run Your Checks
+
+Keep in mind: This runs against _production_ and will usually run full table scans.
+If you have a huge amount of data this could be a lot of I/O.
+If you're large enough to have an OLAP/data warehouse, consult with your data team about running against that instead of your OLTP.
+
+Run your checks:
+
+    $ bundle exec recheck
+    CommentChecker ... 2,442 pass 0 fail
+    StoryChecker .. 1,196 pass 0 fail
+    UserChecker ..x. 3,501 pass 3 fail
+    Completed in 28 seconds
+
+Each `.` is a set of 1,000 records passing, each `x` is a set with at least one failure.
+The exit code is `0` when all checks pass,
+`1` when any checks fail, or
+`2` when any checks error out (takes precedence).
+
+A failure looks like:
+
+    $ bundle exec recheck recheck/model/user_checker.rb
+    UserChecker ...x. 3,501 pass, 3 fail
+
+    Failures:
+    UserLoginChecker#check_users_are_synced_to_ldap recheck/model/user_checker.rb:46
+      2342
+    UserLoginChecker#Bug1422 recheck/model/user_checker.rb:105
+      1755
+      2342
+
+By default `recheck` only prints to the command line, but you can write `Reporter`s to notify teams by email/slack/issue tracker in regular use.
+
+You can run subsets of checks by filename or line number:
+
+    $ recheck recheck/job
+    $ recheck recheck/job/user* recheck/doc_store/integration_checker.rb
+    $ recheck recheck/model/user_checker.rb
+    $ recheck recheck/model/user_checker.rb:46
+
+When you have a lot of data and checks take more than a few minutes to run, Recheck will recommend changing strategies,
+for example to check all recent records but sample randomly from older data that's less likely to have new errors.
+The schedulers and strategies appropriate for millions of records and gigabytes of data are available in [Recheck Pro](https://recheck.dev/pro), along with a nice web interface.
+
+
+## Write Checks
+
+A `Checker` is a class that groups queries and related checks, a `check` is an individual method that checks a single record.
+Group your checks by query, team, or purpose.
+The runner only looks for methods named `query` and `check_`, so you can use delegation, modules, and inheritance (as long as inheritance eventually reaches `Recheck::Checker::Base`) as you like to organize your checks.
+
+
+Here's a short example:
+
+```ruby
+class UserContactChecker < Recheck::Checker::Base
+  # Query for records to check:
+  def query
+    # Watching for Bug #556, which left some users without shipping/contact info
+    # if the user edited their profile while the daily sync job was running.
+    User.where(email: nil)
+      .left_outer_joins(:mailing_addresses, :phone_numbers)
+      .where(mailing_addresses: { id: nil })
+      .where(phone_numbers: { id: nil })
+      .distinct
+  end
+
+  # The simplest possible check would be to consider every queried record bad.
+  # This is standard when you're checking for a particular, well-defined bug.
+  def check_bad_data_exists(_)= false
+end
+```
+
+Here's a longer example, showing the 4 hooks available:
+
+```ruby
+# recheck/models/user_logins_checker.rb
+# Checkers must inherit from Recheck::Checker::Base to be registered to run.
+class UserLoginsChecker < Recheck::Checker::Base
+
+  # Hook 1: initialize (optional)
+  # Runs once to prepare a shared resource for the checks to use:
+  def intitialize
+    @ldap = Net::LDAP.new({ host: "example.com", port: 389, auth: LDAP_CREDENTIALS })
+  end
+
+  # Hook 2: query* (required)
+  # Your query might be very simple, like checking all records.
+  # You can have multiple query methods; all records are run against all checks.
+  # You can return any Enumerable.
+  def query_all
+    User.all.include(:avatar).find_each
+  end
+
+  # Hook 3: check* (optional)
+  # Each check inspects a single record, the name must start with "check".
+  #
+  # While it would be nice to always be able to query out bad data,
+  # sometimes it's easier to express "bad" in code, or you have to
+  # integrate with other data sources.
+  #
+  # A check is a function that receives a single record and returns
+  # false or nil for a failing record; anything else is a pass.
+  def check_users_are_synced_to_ldap(user)
+    # ldap syncs every minute so pass very recently changed users:
+    return true if user.updated_at >= 1.minute.ago
+
+    count = @ldap.search({
+      base: "dc=example, dc=com",
+      filter: Net::LDAP::Filter.eq("mail", User.email),
+      return_result: false
+    }).size
+
+    # user appears in ldap exactly once, right?
+    return count == 1
+  end
+
+  # You can define many checks for your records:
+  def check_user_has_avatar_on_s3(user)
+    # ...
+  end
+
+  # That's all you need to implement a checker, but you can have any other
+  # methods or attributes you want. This is mostly useful for metadata for
+  # Reporters, so remember this method for the next section.
+  def team= :security
+end
+
+Some tips for writing checks:
+
+  * Checkers are cheap. Don't be shy about splitting up your checkers by team or function.
+    Recheck looks for any file `recheck/**/*_checker.rb` or you can give any path on the command line.
+  * Generally you want checks to avoid side effects because you can't control their scheduling,
+    but if you can automatically fix up your data, go for it.
+    Recheck is a pragmatic tool for keeping your data healthy.
+  * It's great to include detailed comments with links in your checkers so that when they alert
+    to give a running start on context for the people dealing with the alert.
+    Maybe a [runbook](https://www.pagerduty.com/resources/learn/what-is-a-runbook/)?
+
+
+## Reporters
+
+Reporters are how you turn failing checks into emails, bug tracker tickets, or any other useful notification or report.
+You can notify different teams however they most "enjoy" hearing about bad data.
+
+When you run your check suite you can name reporters to use:
+
+    recheck run --reporter Json recheck/validation/user.rb | jq -R -r "fromjson?"
+    {
+      "UserValidationChecker": {
+        "check_no_invalid_records_found": {
+          "counts": {
+            "counts": {
+              "pass": 0,
+              "fail": 0,
+              "exception": 0,
+              "blanket": 0,
+              "no_query_methods": 0,
+              "no_queries": 0,
+              "no_check_methods": 0,
+              "no_checks": 0
+            },
+            "queries": 0
+          },
+          "fail": [],
+          "exception": []
+        }
+      }
+    }
+
+Notice this doesn't show the usual terminal output?
+That's printed by `Recheck::Reporter::Default`, which recheck only includes if you don't name any reporters in your command.
+
+When you `recheck run`, you can give the full namespace to a class like `--reporter Recheck::Reporter::Json` but it searches in `Recheck::Reporter` for the convenience of saying `--reporter Json`.
+
+Reporters are even easier to write than checker classes:
+
+```ruby
+# recheck/reporter/email_team_reporter.rb
+# Checkers must inherit from Recheck::Reporter::Base to be registered as available.
+class EmailTeamReporter < Recheck::Reporter::Base
+  # Optional: appears in `recheck reporters`.
+  def self.help
+  end
+
+  # Required: receives the arg from the command line.
+  # raise ArgumentError for any problem with arg
+  def initialize(arg:)
+    @team_lookup = TeamLookupService.new(api_key: arg)
+  rescue InvalidApiKey
+    raise ArgumentError, "API key not accepted for team lookup"
+  end
+
+  # There are four hooks, all optional:
+  # around_run: fires around the entire run
+  # around_query: fires around each query
+  # around_checker: fires around each checker
+  # around_check: fires for each call to a check_ of each record
+
+  # Important warning: all your hooks _must_ yield to run the next part of the suite.
+
+  def around_run(checkers:)
+    total_counts = yield
+
+    Email.new({
+      to: @team_lookup.find(:ops),
+      subject: "check run completed",
+      body: "results: #{total_counts.inspect}"
+    }).send_now!
+  end
+
+  # This Reporter doesn't need a around_checker or around_query,
+  # so it doesn't define them.
+
+  def around_check(checker:, query:, check:)
+    result = yield
+
+    if result.is_a? Recheck::Error
+      Email.new({
+        # Remember defining .team in the checker example above?
+        to: @team_lookup.find(checker.team),
+        subject: "failing check",
+        body: result.inspect
+      }).send_now!
+    end
+  end
+end
+```
+
+To pass the API key as the reporter's arg:
+
+    bundle exec recheck --reporter EmailTeamReporter:api_key_123abc
+
+A reporter takes a single string `arg` after a `:`, which is deliberately simple to avoid the creeping horror of shell parsing.
+
+If you need to pass complex options or run from a job, you can script it:
+
+```ruby
+require "recheck"
+
+# load reporters and checkers from this project and elsewhere
+Dir.glob([
+  "recheck/check/**/*.rb",
+  "/path/to/shared/checks/**/*.rb",
+  "recheck/reporter/**/*.rb"
+]).each do |file|
+  require_relative file
+end
+
+# you can instantiate your checkers and reporters with additional config
+Recheck::Runner.new(
+  checkers: [
+    UserChecker.new(role: :admin),
+    UserChecker.new(role: :customer_suport),
+    SecurityChecker.new
+  ],
+  reporters: [
+    SlackReporter.new(channels: [:security, :ops].merge(ARGV.map(&:to_sym))
+  ]
+)
+```
+
+Run `recheck reporters` to list your loaded reporters.
+
+Read [the reporters that ship with Recheck](lib/recheck/reporters.rb) for more ideas.
+
+
+## Production
+
+When you have your check suite and reporters, it's time to run them in production.
+
+You could run `bundle exec recheck recheck/job/* recheck/model/user_checker.rb --reporter ... --reporter ...` and so on manually,
+but Recheck's real value comes when you schedule it to run automatically.
+Start with running all your checks daily and then specialize into running subsets more or less frequently as you gain confidence and build out a big suite.
+
+
+Recheck is free for personal and commercial use,
+but pretty much all non-trivial commercial systems would benefit by upgrading to [Recheck Pro](https://recheck.dev/pro).
+It comes with an admin panel to track issues over time, silence flaky or low-priority checks, and more:
+
+[admin screenshot TK]
+
+The admin panel also handles running your checks continuously in the background.
+
+Recheck Pro also includes sophisticated strategies to catch issues ASAP while minimizing database load.
+For example, if you add the line `schedule Recheck::Pro::RecentlyUpdated`, it will:
+
+- every minute, run checks against records edited in the last hour
+- every hour, run checks against records edited in the last day
+- every day, run checks against records edited in the last 30 days
+- every day, run checks against 1% of records edited more than 30 days ago,
+  but back off and warn if the database is responding slowly
+
+See the [full docs](https://recheck.dev/doc) for more.
+
+
+## Contributing
+
+Bug reports, feature requests, and pull requests are welcome on GitHub at: https://github.com/recheckdev/recheck
+
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `rake test` 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`.
+Please don't bump the version number in PRs; I'll handle releases.
+
+
+## License
+
+Recheck is an open core product.
+See [license.md](https://github.com/recheckdev/recheck/blob/main/ruby/recheck/license.md) for terms of the freely available license.
+
+The license for Recheck Pro can be found in [comm-license.md](https://github.com/recheckdev/recheck/blob/main/ruby/recheck/comm-license.md).
+Purchase at [Recheck.dev](https://recheck.dev).

data/recheck.gemspec

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative "lib/recheck/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "recheck"
+  spec.version = Recheck::VERSION
+  spec.authors = ["Peter Bhat Harkins"]
+  spec.email = ["peter@recheck.coop"]
+
+  spec.summary = "Recheck your production data integrity"
+  spec.description = "Check on validations, background jobs, third-party integrations, state machines, and business rules"
+  spec.homepage = "https://recheck.dev"
+  spec.license = "LGPL-3.0"
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/recheckdev/recheck/ruby/recheck"
+  spec.metadata["changelog_uri"] = "https://github.com/recheckdev/recheck/ruby/recheck/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `jj file list .`.split.reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[
+          .
+          bin/
+          build/
+          Gemfile
+          Rakefile
+          test/
+        ])
+    end
+  end
+
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # runtime dependencies here
+  spec.add_dependency "resolv"
+  spec.add_dependency "whois", "~> 5.1"
+  spec.add_dependency "whois-parser"
+end

data/template/active_record_model_check.rb.erb

@@ -0,0 +1,16 @@
+require_relative '../recheck_helper'
+
+class <%= class_name %>Checker < Recheck::Checker::Base
+  def query_all
+    <%= class_name %><%= pk_info.query_method %>
+  end
+
+  def check_valid(record)
+    record.valid?
+  end
+
+  # Write more-specific checks for your model here.
+  #
+  # Best practice: If you can query() narrowly for bad data (like for a bug you
+  # are investigating or worry might recur), add a new Checker for it.
+end

data/template/application_record_check.rb.erb

@@ -0,0 +1,11 @@
+require_relative '<%= "../" * depth %>recheck_helper'
+
+class <%= class_name %>Checker < Recheck::Checker::Base
+  def query_all
+    <%= model.name %>.all.find_each
+  end
+
+  def check_valid record
+    record.valid?
+  end
+end

data/template/validation_checker.rb.erb

@@ -0,0 +1,33 @@
+require_relative '<%= "../" * depth %>recheck_helper'
+
+# Generated <%= Date.today.iso8601 %> for <%= model_root_filename %>
+
+class <%= class_name %>ValidationChecker < Recheck::Checker::Base
+  <% queries.each do |query| %>
+    # <%= query.inspect -%>
+    <%
+    case query
+    when Placeholder %>
+      # <%= query.comment -%>
+      <%
+    when FunctionPlaceholder
+      %>
+      def <%= query.name %>
+        # <%= query.comment %>
+      end
+      <%
+    when Query
+      %><%= query.warning ? "# #{query.warning}" : "" %>
+      def <%= query.name %>
+        <%= query.comment ? "# #{query.comment}" : "" %>
+        <%= class_name %>.where(<%= query.or_clauses.first %>)<%= (query.or_clauses.drop(1).map {".or(#{class_name}.where(#{it}))"}).join("") %>.find_each
+      end
+      <%
+    end
+  end %>
+
+  # these queries only find records that don't pass validation so the check always fails
+  def check_no_invalid_records_found(_)
+    false
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: recheck
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Peter Bhat Harkins
@@ -60,6 +60,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- changelog.md
+- comm-license.md
 - exe/recheck
 - lib/recheck.rb
 - lib/recheck/checkers.rb
@@ -69,17 +71,25 @@ files:
 - lib/recheck/rails/railtie.rb
 - lib/recheck/rails/setup.rb
 - lib/recheck/rails/validation.rb
+- lib/recheck/rails/version.rb
 - lib/recheck/reporters.rb
 - lib/recheck/results.rb
 - lib/recheck/runner.rb
+- lib/recheck/tasks/recheck_tasks.rake
 - lib/recheck/vendor/optimist.rb
 - lib/recheck/version.rb
+- license.md
+- readme.md
+- recheck.gemspec
+- template/active_record_model_check.rb.erb
+- template/application_record_check.rb.erb
 - template/recheck_helper.rb
 - template/regression_checker_sample.rb
 - template/reporter_sample.rb
 - template/site/dns_checker.rb
 - template/site/tls_checker.rb
 - template/site/whois_checker.rb
+- template/validation_checker.rb.erb
 homepage: https://recheck.dev
 licenses:
 - LGPL-3.0
@@ -101,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Recheck your production data integrity
 test_files: []