database_consistency 1.1.0 → 1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f37408420931f459ea476d095f441e40256ea2279e07c21ad9d477c0781d5944
-  data.tar.gz: b054877a7819333fab57dbe22786456d4a0328b462f9808561e470290b3ae6e7
+  metadata.gz: 33bfe05b79b4c641cfa784c2e60894004910bfcbf594d3045ce51b586eec5812
+  data.tar.gz: 20355a79ba3aa941f85764203474e8a16b5c91397ce008940f4ecb9a2e45d71a
 SHA512:
-  metadata.gz: c2e7a18dabde150f3f1f2ee144b6076e2c0fb944c9c128851379e86007f0aed056f1fb550cc19319b777767ffc165534939a680e248213473032054dfa8e2924
-  data.tar.gz: f047ff2a3e5e41137a93f5c64e4a0288e74b0d687670e7eabe5b3656a675abf87df75586fd5a0988f25f26f993d20542addfd2d84b430dac7dd30025f2016415
+  metadata.gz: 57e588223f73d55f10d00e47c7492de68849f3487a272293beb8eba3547bea679f4c2322a93fc2ac625177426252ba1d97650197515493a17218face6149b493
+  data.tar.gz: d21a4eab903327f8fd7ea775828c45c72674f6edf58b1f8fb0889cd986a79adaf514a160bb30497b9b46003b180888b97ddfe94c25b68a106ed4e15a97d8d25b

data/lib/database_consistency/checkers/{validator_checkers/belongs_to_presence_checker.rb → association_checkers/foreign_key_checker.rb}

@@ -2,18 +2,23 @@
 
 module DatabaseConsistency
   module Checkers
-    # This class checks if required +belongs_to+ has foreign key constraint
-    class BelongsToPresenceChecker < ValidatorChecker
-      MISSING_FOREIGN_KEY = 'model should have proper foreign key in the database'
+    # This class checks if non polymorphic +belongs_to+ association has foreign key constraint
+    class ForeignKeyChecker < AssociationChecker
+      MISSING_FOREIGN_KEY = 'should have foreign key in the database'
 
       private
 
       # We skip check when:
-      #  - validator is a not a presence validator
-      #  - there is no belongs_to association with given name
-      #  - belongs_to association is polymorphic
+      #  - association isn't belongs_to association
+      #  - association is polymorphic
       def preconditions
-        validator.kind == :presence && association && association.belongs_to? && !association.polymorphic?
+        supported? && association.belongs_to? && !association.polymorphic?
+      end
+
+      def supported?
+        return false if ActiveRecord::VERSION::MAJOR < 5 && ActiveRecord::Base.connection_config[:adapter] == 'sqlite3'
+
+        true
       end
 
       # Table of possible statuses
@@ -28,10 +33,6 @@ module DatabaseConsistency
           report_template(:fail, MISSING_FOREIGN_KEY)
         end
       end
-
-      def association
-        @association ||= model.reflect_on_association(attribute)
-      end
     end
   end
 end

data/lib/database_consistency/checkers/index_checkers/redundant_index_checker.rb

@@ -38,10 +38,14 @@ module DatabaseConsistency
           model.connection.indexes(model.table_name).find do |another_index|
             next if index.name == another_index.name
 
-            include_index_as_prefix?(another_index)
+            clause_equals?(another_index) && include_index_as_prefix?(another_index)
           end
       end
 
+      def clause_equals?(another_index)
+        another_index.where == index.where
+      end
+
       def include_index_as_prefix?(another_index)
         another_index_columns = Helper.extract_index_columns(another_index.columns)
         index_columns == another_index_columns.first(index_columns.size)

data/lib/database_consistency/checkers/index_checkers/redundant_unique_index_checker.rb

@@ -38,10 +38,14 @@ module DatabaseConsistency
           model.connection.indexes(model.table_name).find do |another_index|
             next if index.name == another_index.name
 
-            another_index.unique && contain_index?(another_index)
+            another_index.unique && clause_equals?(another_index) && contain_index?(another_index)
           end
       end
 
+      def clause_equals?(another_index)
+        another_index.where == index.where
+      end
+
       def contain_index?(another_index)
         another_index_columns = Helper.extract_index_columns(another_index.columns)
         index_columns & another_index_columns == another_index_columns

data/lib/database_consistency/checkers/validators_fraction_checkers/column_presence_checker.rb

@@ -7,6 +7,7 @@ module DatabaseConsistency
       WEAK_OPTIONS = %i[allow_nil allow_blank if unless on].freeze
       # Message templates
       CONSTRAINT_MISSING = 'column should be required in the database'
+      ASSOCIATION_FOREIGN_KEY_CONSTRAINT_MISSING = 'association foreign key column should be required in the database'
       POSSIBLE_NULL = 'column is required but there is possible null value insert'
 
       private
@@ -15,11 +16,9 @@ module DatabaseConsistency
         validator.kind == :presence
       end
 
-      # We skip check when:
-      #  - there is no presence validators
-      #  - there is no column in the database with given name
+      # We skip the check when there are no presence validators
       def preconditions
-        validators.any? && column
+        validators.any?
       end
 
       # Table of possible statuses
@@ -33,17 +32,39 @@ module DatabaseConsistency
         can_be_null = column.null
         has_weak_option = validators.all? { |validator| validator.options.slice(*WEAK_OPTIONS).any? }
 
-        if can_be_null == has_weak_option
-          report_template(:ok)
-        elsif can_be_null
+        return report_template(:ok) if can_be_null == has_weak_option
+        return report_template(:fail, POSSIBLE_NULL) unless can_be_null
+
+        if regular_column
           report_template(:fail, CONSTRAINT_MISSING)
         else
-          report_template(:fail, POSSIBLE_NULL)
+          report_template(:fail, ASSOCIATION_FOREIGN_KEY_CONSTRAINT_MISSING)
         end
       end
 
       def column
-        @column ||= model.columns.select.find { |field| field.name == attribute.to_s }
+        @column ||= regular_column || association_reference_column ||
+                    (raise Errors::MissingField, "Missing column in #{model.table_name} for #{attribute}")
+      end
+
+      def regular_column
+        @regular_column ||= column_for_name(attribute.to_s)
+      end
+
+      def column_for_name(name)
+        model.columns.find { |field| field.name == name.to_s }
+      end
+
+      def association_reference_column
+        return unless association_reflection
+
+        column_for_name(association_reflection.foreign_key)
+      end
+
+      def association_reflection
+        model
+          .reflect_on_all_associations
+          .find { |reflection| reflection.belongs_to? && reflection.name == attribute }
       end
     end
   end

data/lib/database_consistency/processors/associations_processor.rb

@@ -6,6 +6,7 @@ module DatabaseConsistency
     class AssociationsProcessor < BaseProcessor
       CHECKERS = [
         Checkers::MissingIndexChecker,
+        Checkers::ForeignKeyChecker,
         Checkers::ForeignKeyTypeChecker
       ].freeze
 

data/lib/database_consistency/processors/validators_processor.rb

@@ -5,7 +5,6 @@ module DatabaseConsistency
     # The class to process validators
     class ValidatorsProcessor < BaseProcessor
       CHECKERS = [
-        Checkers::BelongsToPresenceChecker,
         Checkers::MissingUniqueIndexChecker
       ].freeze
 

data/lib/database_consistency/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DatabaseConsistency
-  VERSION = '1.1.0'
+  VERSION = '1.1.4'
 end

data/lib/database_consistency/writers/simple_writer.rb

@@ -21,9 +21,7 @@ module DatabaseConsistency
       end
 
       def msg(result)
-        msg = "#{status_text(result)} #{key_text(result)} #{result.message}"
-        msg += " (checker: #{result.checker_name})" if config.debug?
-        msg
+        "#{result.checker_name} #{status_text(result)} #{key_text(result)} #{result.message}"
       end
 
       private

data/lib/database_consistency.rb

@@ -19,6 +19,7 @@ require 'database_consistency/checkers/base_checker'
 
 require 'database_consistency/checkers/association_checkers/association_checker'
 require 'database_consistency/checkers/association_checkers/missing_index_checker'
+require 'database_consistency/checkers/association_checkers/foreign_key_checker'
 require 'database_consistency/checkers/association_checkers/foreign_key_type_checker'
 
 require 'database_consistency/checkers/column_checkers/column_checker'
@@ -27,7 +28,6 @@ require 'database_consistency/checkers/column_checkers/length_constraint_checker
 require 'database_consistency/checkers/column_checkers/primary_key_type_checker'
 
 require 'database_consistency/checkers/validator_checkers/validator_checker'
-require 'database_consistency/checkers/validator_checkers/belongs_to_presence_checker'
 require 'database_consistency/checkers/validator_checkers/missing_unique_index_checker'
 
 require 'database_consistency/checkers/validators_fraction_checkers/validators_fraction_checker'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: database_consistency
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.4
 platform: ruby
 authors:
 - Evgeniy Demin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-24 00:00:00.000000000 Z
+date: 2021-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -133,6 +133,7 @@ files:
 - bin/database_consistency
 - lib/database_consistency.rb
 - lib/database_consistency/checkers/association_checkers/association_checker.rb
+- lib/database_consistency/checkers/association_checkers/foreign_key_checker.rb
 - lib/database_consistency/checkers/association_checkers/foreign_key_type_checker.rb
 - lib/database_consistency/checkers/association_checkers/missing_index_checker.rb
 - lib/database_consistency/checkers/base_checker.rb
@@ -144,7 +145,6 @@ files:
 - lib/database_consistency/checkers/index_checkers/redundant_index_checker.rb
 - lib/database_consistency/checkers/index_checkers/redundant_unique_index_checker.rb
 - lib/database_consistency/checkers/index_checkers/unique_index_checker.rb
-- lib/database_consistency/checkers/validator_checkers/belongs_to_presence_checker.rb
 - lib/database_consistency/checkers/validator_checkers/missing_unique_index_checker.rb
 - lib/database_consistency/checkers/validator_checkers/validator_checker.rb
 - lib/database_consistency/checkers/validators_fraction_checkers/column_presence_checker.rb