data_checks 0.1.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75110dd7aeb5c0972a2f4a2bc018133627b3322b6491bbb491b0f395306cc8ec
-  data.tar.gz: 2e882c3d2373d7accc19c7b1efc9cc74f690d76bec9693145f358ae436706d31
+  metadata.gz: 6b83ce0d2930d4e168a3622d8e233cc2a77893062508a0babad2faf9ec5e3f58
+  data.tar.gz: 23cf5db0c7fcb99baa1c65f815c36c554c06e0e5523ee29ce5c2ce6b0a9a3743
 SHA512:
-  metadata.gz: 1f4ba9afdf6edb3afca680e9f3df7e9e0a16d650c5dcd2419c7784683d89fe10425b681d12228b504ad6652354bcf776cf4bd53d111ccbd3978c061d2f1ea34d
-  data.tar.gz: 3d079a8442eb89134f27c26e65cd86825e850392fa98d85b130992910fe56126b42dbce30be4adeb5b6d3bca4ad7765321c8122ebcc4ceb3a294d6f2007a01e1
+  metadata.gz: e53875e40ada24436d58f31c6aa8e2e2eba0030283efb3cec5fd9ba1fae466f2297094c40d35c36594fea5a702b3c1846d164458f837f63476894c2f993a4eb5
+  data.tar.gz: 27ab0bb74134ed8f1d23d49a2e47ab3e6b24c0a25f09f73f7be1fa1a8e320de36bad91a7c93f94cd8eb098a72af83e0c078117140d3696b6ab21ef0b1dfed42c

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 ## master (unreleased)
 
+## 0.3.0 (2024-08-10)
+
+- Drop support for older activerecord and ruby versions
+
+## 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`

data/README.md

@@ -4,6 +4,11 @@ This gem provides a small DSL to check your data for inconsistencies and anomali
 
 [![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)
 
+## Requirements
+
+- ruby 3.0+
+- activerecord 7.0+
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -133,6 +138,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/check_run.rb

@@ -5,7 +5,7 @@ module DataChecks
     self.table_name = :data_checks_runs
 
     STATUSES = [:passing, :failing, :error]
-    enum status: STATUSES.map { |status| [status, status.to_s] }.to_h
+    enum :status, STATUSES.index_with(&:to_s)
 
     serialize :backtrace
 

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,30 @@
+# 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
+        when Enumerable
+          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
+        when Enumerable
+          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
+        when Enumerable
+          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

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

data/lib/data_checks/version.rb

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

data/lib/data_checks.rb

@@ -12,6 +12,7 @@ module DataChecks
   autoload :CheckResult
   autoload :CheckRun
   autoload :Config
+  autoload :EnsureEqual
   autoload :EnsureLess
   autoload :EnsureMore
   autoload :EnsureNo

data/lib/generators/data_checks/install_generator.rb

@@ -10,7 +10,7 @@ module DataChecks
     source_root File.expand_path("templates", __dir__)
 
     def create_migration_file
-      migration_template("migration.rb", File.join(migrations_dir, "install_data_checks.rb"))
+      migration_template("migration.rb", File.join(db_migrate_path, "install_data_checks.rb"))
     end
 
     def copy_initializer_file
@@ -19,11 +19,7 @@ module DataChecks
 
     private
       def start_after
-        self.class.next_migration_number(migrations_dir)
-      end
-
-      def migrations_dir
-        ar_version >= 5.1 ? db_migrate_path : "db/migrate"
+        self.class.next_migration_number(db_migrate_path)
       end
 
       def ar_version

data/lib/generators/data_checks/templates/initializer.rb.tt

@@ -12,7 +12,8 @@ DataChecks.configure do
 
   # ==> Configure checks
   #
-  # Available checks are :ensure_no, :ensure_any, :ensure_more, and :ensure_less.
+  # Available checks are :ensure_no, :ensure_any, :ensure_more, :ensure_less,
+  # and :ensure_equal.
   #
   # ensure_no :users_without_emails do
   #   User.where(email: nil).count

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: data_checks
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.3.0
 platform: ruby
 authors:
 - fatkodima
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-26 00:00:00.000000000 Z
+date: 2024-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '7.0'
 description:
 email:
 - fatkodima123@gmail.com
@@ -39,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
@@ -73,14 +74,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: Regression testing for data