database_consistency 1.3.1 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c6abf040aee5da4569c129d448c0b9dcc2344ace31f64ffad808f1f225f7328
-  data.tar.gz: ccc59e66ac21cee7e6f71cf1d994dc65c09c5706343396af90af7a4b157a6ac8
+  metadata.gz: 857156332ffa36d32216953b8bd1f798ae27dcb2037e873c93d08fa55a01bd47
+  data.tar.gz: f1aa19a34377de90e606b1e8272d9444992e44f6487c0ac28d913298d5ef6df9
 SHA512:
-  metadata.gz: 1617cef7111b2d5e3cca1f003176b1477b27529c1b433dc04a6131c1efff1b2ba8c1291637cd9fa4e169736c10807fa21b12f4c48197175596226d73814e64eb
-  data.tar.gz: 87aa6bf2daaf34aec66256af9b999cc20e09587a71441b151e88a0616fba0c8c907e34ea4497b89c432538d8d0c59b78d27c8dda4f5222f3ca5ec6e759276951
+  metadata.gz: 635ac9cfa1426f77ec59647e7282887fcfc81ec2db8217a545f791383bc1e3538f8f2e5bcb55c1aedee194b27287063a0ee330ffafe0068a7c219f2350a421b9
+  data.tar.gz: f72cf3ef8ac71296984002d798b895740fc15ec91e582503fde012d8b58986956e36bd41bfae5453abb374da27a20f92bbcf96fbfe2abdddf3fe8f2569be3f48

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

@@ -5,15 +5,16 @@ module DatabaseConsistency
     # This class checks redundant database indexes
     class RedundantIndexChecker < IndexChecker
       class Report < DatabaseConsistency::Report # :nodoc:
-        attr_reader :index_name
+        attr_reader :covered_index_name, :index_name
 
-        def initialize(index_name:, **args)
+        def initialize(covered_index_name:, index_name:, **args)
           super(**args)
+          @covered_index_name = covered_index_name
           @index_name = index_name
         end
 
         def attributes
-          super.merge(index_name: index_name)
+          super.merge(covered_index_name: covered_index_name, index_name: index_name)
         end
       end
 
@@ -31,13 +32,14 @@ module DatabaseConsistency
       # | provided   | ok     |
       # | redundant  | fail   |
       #
-      def check
+      def check # rubocop:disable Metrics/MethodLength
         if covered_by_index
           Report.new(
             status: :fail,
             error_slug: :redundant_index,
             error_message: nil,
-            index_name: covered_by_index.name,
+            covered_index_name: covered_by_index.name,
+            index_name: index.name,
             **report_attributes
           )
         else

data/lib/database_consistency/helper.rb

@@ -78,17 +78,23 @@ module DatabaseConsistency
     end
 
     def uniqueness_validator_columns(attribute, validator, model)
-      ([wrapped_attribute_name(attribute, validator)] + scope_columns(validator, model)).map(&:to_s)
+      ([wrapped_attribute_name(attribute, validator, model)] + scope_columns(validator, model)).map(&:to_s)
     end
 
     def scope_columns(validator, model)
       Array.wrap(validator.options[:scope]).map do |scope_item|
-        model._reflect_on_association(scope_item)&.foreign_key || scope_item
+        foreign_key_or_attribute(model, scope_item)
       end
     end
 
+    def foreign_key_or_attribute(model, attribute)
+      model._reflect_on_association(attribute)&.foreign_key || attribute
+    end
+
     # @return [String]
-    def wrapped_attribute_name(attribute, validator)
+    def wrapped_attribute_name(attribute, validator, model)
+      attribute = foreign_key_or_attribute(model, attribute)
+
       if validator.options[:case_sensitive].nil? || validator.options[:case_sensitive]
         attribute
       else

data/lib/database_consistency/version.rb

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

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Writers
+    module Autofix
+      class RedundantIndex < MigrationBase # :nodoc:
+        private
+
+        def migration_name
+          "remove_#{report.index_name}_index"
+        end
+
+        def template_path
+          File.join(__dir__, 'templates', 'redundant_index.tt')
+        end
+      end
+    end
+  end
+end

data/lib/database_consistency/writers/autofix/templates/redundant_index.tt

@@ -0,0 +1,5 @@
+class %<migration_name>s < ActiveRecord::Migration[%<migration_version>s]
+  def change
+    remove_index nil, name: '%<index_name>s'
+  end
+end

data/lib/database_consistency/writers/autofix_writer.rb

@@ -8,7 +8,8 @@ module DatabaseConsistency
       SLUG_TO_GENERATOR = {
         missing_foreign_key: Autofix::MissingForeignKey,
         null_constraint_missing: Autofix::NullConstraintMissing,
-        association_missing_null_constraint: Autofix::NullConstraintMissing
+        association_missing_null_constraint: Autofix::NullConstraintMissing,
+        redundant_index: Autofix::RedundantIndex
       }.freeze
 
       def write

data/lib/database_consistency/writers/simple_writer.rb

@@ -29,7 +29,7 @@ module DatabaseConsistency
         null_constraint_association_misses_validator: 'column is required in the database but do not have presence validator for association %<association_name>s', # rubocop:disable Layout/LineLength
         null_constraint_misses_validator: 'column is required in the database but do not have presence validator',
         small_primary_key: 'column has int/serial type but recommended to have bigint/bigserial/uuid',
-        redundant_index: 'index is redundant as %<index_name>s covers it',
+        redundant_index: 'index is redundant as %<covered_index_name>s covers it',
         redundant_unique_index: 'index uniqueness is redundant as %<index_name>s covers it',
         missing_uniqueness_validation: 'index is unique in the database but do not have uniqueness validator',
         missing_unique_index: 'model should have proper unique index in the database',

data/lib/database_consistency.rb

@@ -19,6 +19,7 @@ require 'database_consistency/writers/autofix/helpers/migration'
 require 'database_consistency/writers/autofix/base'
 require 'database_consistency/writers/autofix/migration_base'
 require 'database_consistency/writers/autofix/missing_foreign_key'
+require 'database_consistency/writers/autofix/redundant_index'
 require 'database_consistency/writers/autofix/null_constraint_missing'
 require 'database_consistency/writers/autofix_writer'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: database_consistency
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.3
 platform: ruby
 authors:
 - Evgeniy Demin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-07 00:00:00.000000000 Z
+date: 2022-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -184,8 +184,10 @@ files:
 - lib/database_consistency/writers/autofix/migration_base.rb
 - lib/database_consistency/writers/autofix/missing_foreign_key.rb
 - lib/database_consistency/writers/autofix/null_constraint_missing.rb
+- lib/database_consistency/writers/autofix/redundant_index.rb
 - lib/database_consistency/writers/autofix/templates/missing_foreign_key.tt
 - lib/database_consistency/writers/autofix/templates/null_constraint_missing.tt
+- lib/database_consistency/writers/autofix/templates/redundant_index.tt
 - lib/database_consistency/writers/autofix_writer.rb
 - lib/database_consistency/writers/base_writer.rb
 - lib/database_consistency/writers/helpers/pipes.rb