database_consistency 1.0.0 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b074df0ae4a1316afdb9874c811a02189fd664e00b85220730dd0ae985a36c76
-  data.tar.gz: f870f9f74117a6ea1b5592e7610becc5f854c375ee4a82f9720b287ae9288462
+  metadata.gz: 9e4c24aeb235c8283ce761d7b4d1e3511246eae28c761a55b4f8ef180a090b22
+  data.tar.gz: d8e3b783eae3e68e88126c7f9d77de062748201652ec46492522eda6af0722bf
 SHA512:
-  metadata.gz: 99e298ec2e58c3bfcc5c10a9e294891b14eee23b1a4c9ccbf3e78f5e500480baf1c3ec397d0a19f5af6e83f05dbe9a297e062358eab9699d324b6b06a1255889
-  data.tar.gz: 7d742b1d5985792e2fa3b3a6d5195ccb91c4b49cdbcbce800de6db29a16ef1045f4bf786b3d88e981d23b573282d4ddb821ede90951890ab45682c16b37ede7b
+  metadata.gz: 005c1fa13f5aab3d833c9fd0690907f5df81a0d34ee2dcb5ea19ace51ed41f1438c803d56b95d3573eaa0938b8d9295a04dd5e2dafb6a6ab6ca48c6fcba3af4e
+  data.tar.gz: fab16372c3782df28f84aac35b997c31ccbb68d3be8ee0b8442e09061c8a85797da584153fc3de151ff1761227348b17041302260daede249b3b10753a1d610b

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

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Checkers
+    # This class checks redundant database indexes
+    class RedundantUniqueIndexChecker < IndexChecker
+      # Message templates
+      REDUNDANT_UNIQUE_INDEX = 'index uniqueness is redundant as (%index) covers it'
+
+      private
+
+      # We skip check when:
+      #  - index is not unique
+      def preconditions
+        index.unique
+      end
+
+      # Table of possible statuses
+      # | validation | status |
+      # | ---------- | ------ |
+      # | provided   | ok     |
+      # | redundant  | fail   |
+      #
+      def check
+        if covered_by_index
+          report_template(:fail, render_message)
+        else
+          report_template(:ok)
+        end
+      end
+
+      def render_message
+        REDUNDANT_UNIQUE_INDEX.sub('%index', covered_by_index.name)
+      end
+
+      def covered_by_index
+        @covered_by_index ||=
+          model.connection.indexes(model.table_name).find do |another_index|
+            next if index.name == another_index.name
+
+            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
+      end
+
+      def index_columns
+        @index_columns ||= Helper.extract_index_columns(index.columns)
+      end
+    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
@@ -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/indexes_processor.rb

@@ -6,7 +6,8 @@ module DatabaseConsistency
     class IndexesProcessor < BaseProcessor
       CHECKERS = [
         Checkers::UniqueIndexChecker,
-        Checkers::RedundantIndexChecker
+        Checkers::RedundantIndexChecker,
+        Checkers::RedundantUniqueIndexChecker
       ].freeze
 
       private

data/lib/database_consistency/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DatabaseConsistency
-  VERSION = '1.0.0'
+  VERSION = '1.1.3'
 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

@@ -36,6 +36,7 @@ require 'database_consistency/checkers/validators_fraction_checkers/column_prese
 require 'database_consistency/checkers/index_checkers/index_checker'
 require 'database_consistency/checkers/index_checkers/unique_index_checker'
 require 'database_consistency/checkers/index_checkers/redundant_index_checker'
+require 'database_consistency/checkers/index_checkers/redundant_unique_index_checker'
 
 require 'database_consistency/processors/base_processor'
 require 'database_consistency/processors/associations_processor'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: database_consistency
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.3
 platform: ruby
 authors:
 - Evgeniy Demin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-24 00:00:00.000000000 Z
+date: 2021-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -142,6 +142,7 @@ files:
 - lib/database_consistency/checkers/column_checkers/primary_key_type_checker.rb
 - lib/database_consistency/checkers/index_checkers/index_checker.rb
 - 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