data_checks 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76f3628c85ded9452a6825695726c6814153051c3345812f6e411f447b9114fb
-  data.tar.gz: 04bca1e6301d41a901e73432ad98b062e508a40e0156fa8a803e0c3fdb765f2d
+  metadata.gz: 990db04b3558c8b10439aa6af136f5415cffcfdf368ddd886db4c0c18b707896
+  data.tar.gz: 7acf51bdf1f5dc5b537577359257e33b110f0b2c3eb554ad8959eb25052c75c4
 SHA512:
-  metadata.gz: 2133d07d50f683647d055aaf877169dadbd62bde6cde8bab24ed785e660c99f844ff80c2be0cd2f3bfec30ec8fba9d902d3ca85ef8dd877f89b54bfd1580d59c
-  data.tar.gz: 8c14320fbeaf09ca1a789f7c4232e5908849ede96b645b13a8f12a1922e07902f700a8c6ae36221d47f485d15a72be1f499789a58f4c0a62e4219ee94a65347c
+  metadata.gz: 337bc667143363ae190de87729e3fbf17b940ebdaa1cd7ee701ed8f83e80b8dda30eb7db0ebdccd81231587c297df9ac662bf1bac23b0fa3c37f2bf828e382a1
+  data.tar.gz: 0b00bc6ee4b76e30023a4da4d20e9c9afb5b5f0d91936cfb21f024be8773e06e78db513df6e3776540a53cce7e0188d5ae3a6e1d714442ee01772afa3282b9c4

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 ## master (unreleased)
 
+## 0.2.0 (2023-11-09)
+
+- Add `ensure_equal` check method
+
+    ```ruby
+    ensure_equal :featured_projects, to: 100 do
+      FeaturedProject.count
+    end
+    ```
+
+## 0.1.1 (2022-11-26)
+
+- Do not prematurely load `ActiveRecord::Base`
+
+    See https://github.com/rails/rails/issues/46567 for details.
+
 ## 0.1.0 (2022-04-21)
 
 - First release

data/README.md

@@ -2,6 +2,8 @@
 
 This gem provides a small DSL to check your data for inconsistencies and anomalies.
 
+[![Build Status](https://github.com/fatkodima/data_checks/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/fatkodima/data_checks/actions/workflows/test.yml)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -23,7 +25,15 @@ You could also assume that your data will never get corrupted, and validations d
 
 This gem doesn't aim to replace those tools, but provides something else that could serve a close purpose: *ensure that you work with the data you expect*.
 
-This gem help you to schedule some verifications on your data and get alerts when something is unexpected.
+This gem helps you to schedule some verifications on your data and get alerts when something is unexpected.
+
+`data_checks` can help to catch:
+
+* 🐛 **Bugs due to race conditions** (e.g. user accidentally double clicks a button to delete an email and ends up without emails due to a race condition bug in the app)
+* 🐛 **Invalid persisted data**
+* 🐛 **Unexpected changes in behavior and data** (e.g. too many (too less) of something is created/deleted/imported/enqueued/..., etc)
+
+This idea is nicely presented at RailsConf: [RailsConf 2018: The Doctor Is In: Using checkups to find bugs in production by Ryan Laughlin](https://www.youtube.com/watch?v=gEAlhKaK2I4)
 
 ## Usage
 
@@ -37,8 +47,15 @@ For example, we expect every image attachment to have previews in 3 sizes. It is
 
 ```ruby
 DataChecks.configure do
+  ensure_no :users_without_emails, tag: "minutely" do
+    User.where.missing(:email_addresses)
+  end
+
   ensure_no :images_without_previews, tag: "hourly" do
-    Attachment.images.joins(:previews).having("COUNT(*) < 3").group(:attachment_id)
+    Attachment.images
+      .left_joins(:previews)
+      .group(:attachment_id)
+      .having("COUNT(previews.id) < 3")
   end
 
   notifier :email,
@@ -116,6 +133,7 @@ end
 * `ensure_any` will check that the result of a given block is `> 0`
 * `ensure_more` will check that the result of a given block is `>` than a given number or that it contains more than a given number of items
 * `ensure_less` will check that the result of a given block is `<` than a given number or that it contains less than a given number of items
+* `ensure_equal` will check that the result of a given block is `==` to the given number or that it contains a given number of items
 
 ```ruby
 ensure_no :images_without_previews do

data/lib/data_checks/config.rb

@@ -26,6 +26,10 @@ module DataChecks
       add_check(EnsureLess, name, options, block)
     end
 
+    def ensure_equal(name, **options, &block)
+      add_check(EnsureEqual, name, options, block)
+    end
+
     def notifier(name, **options)
       name = name.to_s
 

data/lib/data_checks/ensure_equal.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module DataChecks
+  class EnsureEqual < Check
+    private
+      def handle_result(result)
+        expected = options.fetch(:to)
+        passing = true
+        count = 0
+
+        case result
+        when Numeric
+          if result != expected
+            passing = false
+            count = result
+          end
+        # In ActiveRecord <= 4.2 ActiveRecord::Relation is not an Enumerable!
+        when Enumerable, ActiveRecord::Relation
+          count = result.size
+          if count != expected
+            passing = false
+            entries = result
+          end
+        else
+          raise ArgumentError, "Unsupported result: '#{result.class.name}' for 'ensure_equal'"
+        end
+
+        CheckResult.new(check: self, passing: passing, count: count, entries: entries)
+      end
+  end
+end

data/lib/data_checks/ensure_less.rb

@@ -5,23 +5,17 @@ module DataChecks
     private
       def handle_result(result)
         expected = options.fetch(:than)
-        passing = true
 
         case result
         when Numeric
           count = result
-          if result >= expected
-            passing = false
-          end
         when Enumerable, ActiveRecord::Relation
-          count = result.count
-          if count >= expected
-            passing = false
-          end
+          count = result.size
         else
           raise ArgumentError, "Unsupported result: '#{result.class.name}' for 'ensure_less'"
         end
 
+        passing = count < expected
         CheckResult.new(check: self, passing: passing, count: count)
       end
   end

data/lib/data_checks/ensure_more.rb

@@ -5,23 +5,17 @@ module DataChecks
     private
       def handle_result(result)
         expected = options.fetch(:than)
-        passing = true
 
         case result
         when Numeric
           count = result
-          if result <= expected
-            passing = false
-          end
         when Enumerable, ActiveRecord::Relation
-          count = result.count
-          if count <= expected
-            passing = false
-          end
+          count = result.size
         else
           raise ArgumentError, "Unsupported result: '#{result.class.name}' for 'ensure_more'"
         end
 
+        passing = count > expected
         CheckResult.new(check: self, passing: passing, count: count)
       end
   end

data/lib/data_checks/ensure_no.rb

@@ -15,7 +15,7 @@ module DataChecks
           end
         # In ActiveRecord <= 4.2 ActiveRecord::Relation is not an Enumerable!
         when Enumerable, ActiveRecord::Relation
-          unless result.empty?
+          unless result.to_a.empty? # loads records for ActiveRecord::Relation
             passing = false
             count = result.size
             entries = result

data/lib/data_checks/status_printer.rb

@@ -31,8 +31,8 @@ module DataChecks
     private
       def print_summary(counts)
         statuses = DataChecks::CheckRun.statuses
-        summary = "Error: #{counts[statuses[:error]]}, "\
-                  "Failing: #{counts[statuses[:failing]]}, "\
+        summary = "Error: #{counts[statuses[:error]]}, " \
+                  "Failing: #{counts[statuses[:failing]]}, " \
                   "Passing: #{counts[statuses[:passing]]}"
         summary += ", Not Ran: #{counts['not_ran']}" if counts["not_ran"] > 0
         @io.puts(summary)

data/lib/data_checks/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DataChecks
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/data_checks.rb

@@ -1,20 +1,25 @@
 # frozen_string_literal: true
 
-require "data_checks/check_run"
-require "data_checks/check_result"
-require "data_checks/check"
-require "data_checks/ensure_less"
-require "data_checks/ensure_more"
-require "data_checks/ensure_no"
-require "data_checks/notifiers"
-require "data_checks/config"
-require "data_checks/runner"
-require "data_checks/status_printer"
-require "data_checks/version"
+require "active_record"
 
+require "data_checks/version"
 require "data_checks/railtie" if defined?(Rails)
 
 module DataChecks
+  extend ActiveSupport::Autoload
+
+  autoload :Check
+  autoload :CheckResult
+  autoload :CheckRun
+  autoload :Config
+  autoload :EnsureEqual
+  autoload :EnsureLess
+  autoload :EnsureMore
+  autoload :EnsureNo
+  autoload :Notifiers
+  autoload :Runner
+  autoload :StatusPrinter
+
   class << self
     def config
       @config ||= Config.new

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: data_checks
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - fatkodima
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-21 00:00:00.000000000 Z
-dependencies: []
+date: 2023-11-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
 description:
 email:
 - fatkodima123@gmail.com
@@ -25,6 +39,7 @@ files:
 - lib/data_checks/check_result.rb
 - lib/data_checks/check_run.rb
 - lib/data_checks/config.rb
+- lib/data_checks/ensure_equal.rb
 - lib/data_checks/ensure_less.rb
 - lib/data_checks/ensure_more.rb
 - lib/data_checks/ensure_no.rb
@@ -66,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Regression testing for data