database_consistency 0.8.13 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d3bf88ec6fae8aac99d835defc6f02c0d16a8bf307c1ff8096c53fa252ef691
-  data.tar.gz: dd877669bd9a0de57fcf74969f16ba5d434997b36bcb4e73473e5242546ff6e6
+  metadata.gz: dc9590f6144cef94d2046971c259258a8428cddd9b7083f7225a04d3c5c19933
+  data.tar.gz: 6a272364d20b0fdfb9be5155dc0e56c3becc4fc98ef0dc777537ae5a5f1c5f0f
 SHA512:
-  metadata.gz: c3325319154f7e8420f10d39f1e3a1c325e776f4fda2ddee6e004655ee7526bc535bf8e9c958b79d5e41bb3a44a625b6c31eead26437b12b1649fa9fef3b136d
-  data.tar.gz: cee59e3274dc9a841915eb3baf9860cb749a84e1a1baa72e90bde23ba589f2a3d5d8473eda60dc544fa1cbe5fa1ab5496dc64d26ad5052b704ee04b1dbc91c9d
+  metadata.gz: dcb1f1eae53a0d783c6e83a6f3ca77ae4f5ab4c3086291b268e0e3745abce10d760214c313687db98086ccee9322fe88cbcaade5def8290dea17939447534868
+  data.tar.gz: 90fcc238b355768e1f2e7b11909b7eb5f2d679b724be2ef3264a158fcdeb916aa751b97e6e14ecfae39f5de985e83887f862565e86c716bb3e43391a463b3a8a

data/lib/database_consistency.rb

@@ -35,6 +35,8 @@ 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'

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

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Checkers
+    # This class checks redundant database indexes
+    class RedundantIndexChecker < IndexChecker
+      # Message templates
+      REDUNDANT_INDEX = 'index is redundant as (%index) covers it'
+
+      private
+
+      # We skip check when:
+      #  - index is 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_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
+
+            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)
+      end
+
+      def index_columns
+        @index_columns ||= Helper.extract_index_columns(index.columns)
+      end
+    end
+  end
+end

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/processors/indexes_processor.rb

@@ -5,7 +5,9 @@ module DatabaseConsistency
     # The class to process indexes
     class IndexesProcessor < BaseProcessor
       CHECKERS = [
-        Checkers::UniqueIndexChecker
+        Checkers::UniqueIndexChecker,
+        Checkers::RedundantIndexChecker,
+        Checkers::RedundantUniqueIndexChecker
       ].freeze
 
       private

data/lib/database_consistency/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: database_consistency
 version: !ruby/object:Gem::Version
-  version: 0.8.13
+  version: 1.1.2
 platform: ruby
 authors:
 - Evgeniy Demin
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-04 00:00:00.000000000 Z
+date: 2021-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -122,7 +122,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
-description:
+description: 
 email:
 - lawliet.djez@gmail.com
 executables:
@@ -141,6 +141,8 @@ files:
 - lib/database_consistency/checkers/column_checkers/null_constraint_checker.rb
 - 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
@@ -168,7 +170,7 @@ homepage: https://github.com/djezzzl/database_consistency
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -184,7 +186,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.8
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Provide an easy way to check the consistency of the database constraints
   with the application validations.