database_consistency 1.1.2 → 1.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc9590f6144cef94d2046971c259258a8428cddd9b7083f7225a04d3c5c19933
-  data.tar.gz: 6a272364d20b0fdfb9be5155dc0e56c3becc4fc98ef0dc777537ae5a5f1c5f0f
+  metadata.gz: 482d9a79d349bbe6d49233cf8ffb05accbf61c9d30db72b8e2d9c5d5517602a6
+  data.tar.gz: 14309f3ef7aab0e6aa0d20e4f9a0c0148a2be89e30d09235fb558cc55085d38d
 SHA512:
-  metadata.gz: dcb1f1eae53a0d783c6e83a6f3ca77ae4f5ab4c3086291b268e0e3745abce10d760214c313687db98086ccee9322fe88cbcaade5def8290dea17939447534868
-  data.tar.gz: 90fcc238b355768e1f2e7b11909b7eb5f2d679b724be2ef3264a158fcdeb916aa751b97e6e14ecfae39f5de985e83887f862565e86c716bb3e43391a463b3a8a
+  metadata.gz: 7abe1d2b81e1f557b20da7c61a33c9fab8ebe709dd459e78ec16c4b088b3a457b094985428d72f882c6e946d028a444bfaf6aa1058764f03aef6bb54c2ecd89c
+  data.tar.gz: d2b930d6d7a0f639c9f7f139f207d90df85af5409d918d77cf7f3c781602844220996eb3fef6639f0c490f33235efa74f92817a254eb5ee4930ec429c4a4c02d

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/association_checkers/foreign_key_type_checker.rb

@@ -42,6 +42,8 @@ module DatabaseConsistency
         else
           report_template(:fail, render_text)
         end
+      rescue Errors::MissingField => e
+        report_template(:fail, e.message)
       end
 
       # @return [String]
@@ -101,8 +103,8 @@ module DatabaseConsistency
 
       # @return [String]
       def missing_field_error(table_name, column_name)
-        "Association (#{association.name}) of class (#{association.active_record}) relies on "\
-          "field (#{column_name}) of table (#{table_name}) but it is missing."
+        "association (#{association.name}) of class (#{association.active_record}) relies on "\
+          "field (#{column_name}) of table (#{table_name}) but it is missing"
       end
 
       # @param [ActiveRecord::ConnectionAdapters::Column] column

data/lib/database_consistency/checkers/column_checkers/null_constraint_checker.rb

@@ -6,6 +6,8 @@ module DatabaseConsistency
     class NullConstraintChecker < ColumnChecker
       # Message templates
       VALIDATOR_MISSING = 'column is required in the database but do not have presence validator'
+      ASSOCIATION_VALIDATOR_MISSING = 'column is required in the database but do '\
+                                      'not have presence validator for association (%a_n)'
 
       private
 
@@ -26,21 +28,23 @@ module DatabaseConsistency
       # | missing    | fail   |
       #
       # We consider PresenceValidation, InclusionValidation, ExclusionValidation, NumericalityValidator with nil,
-      # or BelongsTo association using this column
+      # or required BelongsTo association using this column
       def check
         if valid?
           report_template(:ok)
+        elsif belongs_to_association
+          report_template(:fail, ASSOCIATION_VALIDATOR_MISSING.gsub('%a_n', belongs_to_association.name.to_s))
         else
           report_template(:fail, VALIDATOR_MISSING)
         end
       end
 
       def valid?
-        validator?(ActiveModel::Validations::PresenceValidator) ||
-          validator?(ActiveModel::Validations::InclusionValidator) ||
+        validator?(:presence, column.name) ||
+          validator?(:inclusion, column.name) ||
           numericality_validator_without_allow_nil? ||
           nil_exclusion_validator? ||
-          belongs_to_association?
+          (belongs_to_association && validator?(:presence, belongs_to_association.name))
       end
 
       def primary_field?
@@ -52,28 +56,30 @@ module DatabaseConsistency
       end
 
       def nil_exclusion_validator?
-        model.validators.grep(ActiveModel::Validations::ExclusionValidator).any? do |validator|
-          Helper.check_inclusion?(validator.attributes, column.name) &&
+        model.validators.any? do |validator|
+          validator.kind == :exclusion &&
+            Helper.check_inclusion?(validator.attributes, column.name) &&
             validator.options[:in].include?(nil)
         end
       end
 
       def numericality_validator_without_allow_nil?
-        model.validators.grep(ActiveModel::Validations::NumericalityValidator).any? do |validator|
-          Helper.check_inclusion?(validator.attributes, column.name) &&
+        model.validators.any? do |validator|
+          validator.kind == :numericality &&
+            Helper.check_inclusion?(validator.attributes, column.name) &&
             !validator.options[:allow_nil]
         end
       end
 
-      def validator?(validator_class)
-        model.validators.grep(validator_class).any? do |validator|
-          Helper.check_inclusion?(validator.attributes, column.name)
+      def validator?(kind, attribute)
+        model.validators.any? do |validator|
+          validator.kind == kind && Helper.check_inclusion?(validator.attributes, attribute)
         end
       end
 
-      def belongs_to_association?
-        model.reflect_on_all_associations.grep(ActiveRecord::Reflection::BelongsToReflection).any? do |r|
-          Helper.check_inclusion?([r.foreign_key, r.foreign_type], column.name)
+      def belongs_to_association
+        @belongs_to_association ||= model.reflect_on_all_associations.find do |r|
+          r.belongs_to? && Helper.check_inclusion?([r.foreign_key, r.foreign_type], column.name)
         end
       end
     end

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
@@ -30,20 +29,52 @@ module DatabaseConsistency
       # | all missing                     | required | ok     |
       # | all missing                     | optional | fail   |
       def check
+        report_message
+      rescue Errors::MissingField => e
+        report_template(:fail, e.message)
+      end
+
+      def has_weak_option?
+        validators.all? { |validator| validator.options.slice(*WEAK_OPTIONS).any? }
+      end
+
+      def report_message
         can_be_null = column.null
-        has_weak_option = validators.all? { |validator| validator.options.slice(*WEAK_OPTIONS).any? }
+        has_weak_option = has_weak_option?
 
-        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, "column (#{attribute}) is missing in table (#{model.table_name}) but used for presence validation")
+      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.2'
+  VERSION = '1.1.6'
 end

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.2
+  version: 1.1.6
 platform: ruby
 authors:
 - Evgeniy Demin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-03 00:00:00.000000000 Z
+date: 2021-11-10 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