database_consistency 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9bc1994c7c24ab9a38d97c764fb0d9ce55e4fa71934df313f2cc693c466cecb7
-  data.tar.gz: 04110bdba61254592c2b22323555948ad06a78b8a63ce78a40175005096acb54
+  metadata.gz: 24c245f8df70e4e98c102b52a56ead68364ba0613a67d1d60d499c36ddfae5b2
+  data.tar.gz: c1d8ce538657703f75a56f3fa462922ddbc5176d328e94665c83f71fd92bb3ed
 SHA512:
-  metadata.gz: 581c8660605072f0cd877310813d71781b50de0af57aa5d85b216b57dd3ed040dc90944e165e51ff9b4728d180474157281ce1e028d9295b7137657367a4fa80
-  data.tar.gz: 0c9d42d9902485c01d208ac38110aa4c7742b4ceca00c369c4fc4c014e84df038b708f17b084f9cee7da8eef28a1f31b52d4a29fa2f597f7cf454af1cefc828c
+  metadata.gz: 00614cf53933e47d9599698d6b412294446b50c6757ea042374247b2b400b4fec12743d00a02401040630e9912aee54fa65e472a4d683e5a2116e93e5f7f48a6
+  data.tar.gz: 5b87a53b2566b6892920ff883909f0a3ae871f137c8ed482b85fdc1a4ece3bd83eb1f68218a391a75dbdfa977a66cd2a34e9eb33810083a024039ccd636ff833

data/lib/database_consistency/checkers/association_checkers/foreign_key_cascade_checker.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Checkers
+    # This class checks if non polymorphic +belongs_to+ association has foreign key constraint
+    class ForeignKeyCascadeChecker < AssociationChecker
+      Report = ReportBuilder.define(
+        DatabaseConsistency::Report,
+        :cascade_option,
+        :primary_table,
+        :foreign_table,
+        :primary_key,
+        :foreign_key
+      )
+
+      OPTION_TO_CASCADE = {
+        delete: :cascade,
+        delete_all: :cascade,
+        nullify: :nullify,
+        restrict_with_exception: :restrict,
+        restrict_with_error: :restrict
+      }.freeze
+
+      DEPENDENT_OPTIONS = OPTION_TO_CASCADE.keys.freeze
+
+      private
+
+      def preconditions
+        !association.polymorphic? &&
+          !association.belongs_to? &&
+          foreign_key &&
+          DEPENDENT_OPTIONS.include?(dependent_option)
+      rescue StandardError
+        false
+      end
+
+      # Table of possible statuses
+      # | foreign key | status |
+      # | ----------- | ------ |
+      # | persisted   | ok     |
+      # | missing     | fail   |
+      def check
+        if correlated_cascade_constraint?
+          report_template(:ok)
+        else
+          report_template(:fail, error_slug: :missing_foreign_key_cascade)
+        end
+      end
+
+      def required_foreign_key_cascade
+        OPTION_TO_CASCADE[dependent_option]
+      end
+
+      def correlated_cascade_constraint?
+        required_foreign_key_cascade == foreign_key_on_delete_option
+      end
+
+      def dependent_option
+        association.options[:dependent]
+      end
+
+      def foreign_key_on_delete_option
+        foreign_key.options[:on_delete]
+      end
+
+      def foreign_key
+        @foreign_key ||=
+          association.klass
+                     .connection
+                     .foreign_keys(association.klass.table_name)
+                     .find { |fk| fk.column == association.foreign_key.to_s }
+      end
+
+      def report_template(status, error_slug: nil)
+        Report.new(
+          status: status,
+          error_message: nil,
+          error_slug: error_slug,
+          primary_table: association.table_name.to_s,
+          primary_key: association.association_primary_key.to_s,
+          foreign_table: association.active_record.table_name.to_s,
+          foreign_key: association.foreign_key.to_s,
+          cascade_option: required_foreign_key_cascade,
+          **report_attributes
+        )
+      end
+    end
+  end
+end

data/lib/database_consistency/checkers/enum_checkers/enum_type_checker.rb

@@ -4,8 +4,6 @@ module DatabaseConsistency
   module Checkers
     # This class checks enum types consistency
     class EnumTypeChecker < EnumChecker
-      MissingColumn = Class.new(StandardError)
-
       Report = DatabaseConsistency::ReportBuilder.define(
         DatabaseConsistency::Report,
         :column_type,
@@ -15,7 +13,7 @@ module DatabaseConsistency
       private
 
       def preconditions
-        true
+        column.present?
       end
 
       def check
@@ -53,10 +51,11 @@ module DatabaseConsistency
         model.defined_enums[enum].values.map(&:class).uniq
       end
 
-      def column_type
-        column = model.columns.find { |c| c.name.to_s == enum.to_s }
-        raise MissingColumn unless column
+      def column
+        @column ||= model.columns.find { |c| c.name.to_s == enum.to_s }
+      end
 
+      def column_type
         column.type.to_s
       end
 

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

@@ -20,26 +20,13 @@ module DatabaseConsistency
 
       # We skip the check when there are no presence validators
       def preconditions
-        validators.any? && !association?
+        column && validators.any? && !association?
       end
 
       def association?
         model._reflect_on_association(attribute)&.macro == :has_one
       end
 
-      # Table of possible statuses
-      # | allow_nil/allow_blank/if/unless | database | status |
-      # | ------------------------------- | -------- | ------ |
-      # | at least one provided           | required | fail   |
-      # | at least one provided           | optional | ok     |
-      # | all missing                     | required | ok     |
-      # | all missing                     | optional | fail   |
-      def check
-        report_message
-      rescue Errors::MissingField => e
-        report_template(:fail, error_message: e.message)
-      end
-
       def report_template(status, error_message: nil, error_slug: nil)
         Report.new(
           status: status,
@@ -55,7 +42,7 @@ module DatabaseConsistency
         validators.all? { |validator| validator.options.slice(*WEAK_OPTIONS).any? }
       end
 
-      def report_message # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+      def check # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
         can_be_null = column.null
         has_weak_option = weak_option?
 
@@ -84,9 +71,7 @@ module DatabaseConsistency
       end
 
       def column
-        @column ||= regular_column ||
-                    association_reference_column ||
-                    (raise Errors::MissingField, "column (#{attribute}) is missing in table (#{model.table_name}) but used for presence validation") # rubocop:disable Layout/LineLength
+        @column ||= (regular_column || association_reference_column)
       end
 
       def regular_column

data/lib/database_consistency/processors/associations_processor.rb

@@ -7,7 +7,8 @@ module DatabaseConsistency
       CHECKERS = [
         Checkers::MissingIndexChecker,
         Checkers::ForeignKeyChecker,
-        Checkers::ForeignKeyTypeChecker
+        Checkers::ForeignKeyTypeChecker,
+        Checkers::ForeignKeyCascadeChecker
       ].freeze
 
       private

data/lib/database_consistency/version.rb

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

data/lib/database_consistency/writers/autofix/migration_base.rb

@@ -17,7 +17,9 @@ module DatabaseConsistency
         private
 
         def migration
-          File.read(template_path) % attributes.merge(migration_configuration(migration_name))
+          attributes.merge(migration_configuration(migration_name)).reduce(File.read(template_path)) do |str, (k, v)|
+            str.gsub("%<#{k}>s", v.to_s)
+          end
         end
       end
     end

data/lib/database_consistency/writers/simple/base.rb

@@ -47,7 +47,9 @@ module DatabaseConsistency
         end
 
         def message_text
-          template % attributes
+          attributes.reduce(template) do |str, (k, v)|
+            str.gsub("%<#{k}>s", v.to_s)
+          end
         end
 
         def attributes

data/lib/database_consistency/writers/simple/missing_foreign_key_cascade.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Writers
+    module Simple
+      class MissingForeignKeyCascade < Base # :nodoc:
+        private
+
+        def template
+          'should have foreign key with on_delete: :%<cascade_option>s in the database'
+        end
+
+        def attributes
+          {
+            cascade_option: report.cascade_option
+          }
+        end
+
+        def unique_attributes
+          {
+            foreign_table: report.foreign_table,
+            foreign_key: report.foreign_key,
+            primary_table: report.primary_table,
+            primary_key: report.primary_key,
+            cascade_option: report.cascade_option
+          }
+        end
+      end
+    end
+  end
+end

data/lib/database_consistency/writers/simple_writer.rb

@@ -23,7 +23,8 @@ module DatabaseConsistency
         redundant_index: Simple::RedundantIndex,
         redundant_unique_index: Simple::RedundantUniqueIndex,
         small_primary_key: Simple::SmallPrimaryKey,
-        inconsistent_enum_type: Simple::InconsistentEnumType
+        inconsistent_enum_type: Simple::InconsistentEnumType,
+        missing_foreign_key_cascade: Simple::MissingForeignKeyCascade
       }.freeze
 
       def write

data/lib/database_consistency.rb

@@ -18,6 +18,7 @@ require 'database_consistency/writers/simple/default_message'
 require 'database_consistency/writers/simple/inconsistent_types'
 require 'database_consistency/writers/simple/null_constraint_association_misses_validator'
 require 'database_consistency/writers/simple/redundant_index'
+require 'database_consistency/writers/simple/missing_foreign_key_cascade'
 require 'database_consistency/writers/simple/redundant_unique_index'
 require 'database_consistency/writers/simple/association_missing_index'
 require 'database_consistency/writers/simple/association_missing_null_constraint'
@@ -59,6 +60,7 @@ 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/association_checkers/foreign_key_cascade_checker'
 
 require 'database_consistency/checkers/column_checkers/column_checker'
 require 'database_consistency/checkers/column_checkers/null_constraint_checker'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: database_consistency
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Evgeniy Demin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-27 00:00:00.000000000 Z
+date: 2022-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -147,6 +147,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_cascade_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
@@ -211,6 +212,7 @@ files:
 - lib/database_consistency/writers/simple/length_validator_lower_limit.rb
 - lib/database_consistency/writers/simple/length_validator_missing.rb
 - lib/database_consistency/writers/simple/missing_foreign_key.rb
+- lib/database_consistency/writers/simple/missing_foreign_key_cascade.rb
 - lib/database_consistency/writers/simple/missing_unique_index.rb
 - lib/database_consistency/writers/simple/missing_uniqueness_validation.rb
 - lib/database_consistency/writers/simple/null_constraint_association_misses_validator.rb