database_consistency 0.8.9 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88909c88e70df8df3cedb11f197475d9c6dbe3f812de7fdee9bc3e07663f153a
-  data.tar.gz: 17f08f988d4c92f750836ccce9ce5f5c7c12fbee74fc03dffcbec0215f3942fa
+  metadata.gz: b074df0ae4a1316afdb9874c811a02189fd664e00b85220730dd0ae985a36c76
+  data.tar.gz: f870f9f74117a6ea1b5592e7610becc5f854c375ee4a82f9720b287ae9288462
 SHA512:
-  metadata.gz: 812d9b13a6efa7c7db96d16d77f2770f213c7fb2adf50d407395e8fb9dc61dbc6bd59bbaebe9982e71662441fc6af98d803246d453ab9a8d5051535984279869
-  data.tar.gz: a69096397d7d422431425dd18ec9f7763bda7f426fb1d5ba8e9eb3a9ebdc94a5f276d06557e979a03d879280e51d3ac6acd0ba3e1cabd28a033917a404aae3ea
+  metadata.gz: 99e298ec2e58c3bfcc5c10a9e294891b14eee23b1a4c9ccbf3e78f5e500480baf1c3ec397d0a19f5af6e83f05dbe9a297e062358eab9699d324b6b06a1255889
+  data.tar.gz: 7d742b1d5985792e2fa3b3a6d5195ccb91c4b49cdbcbce800de6db29a16ef1045f4bf786b3d88e981d23b573282d4ddb821ede90951890ab45682c16b37ede7b

data/lib/database_consistency.rb

@@ -33,11 +33,16 @@ require 'database_consistency/checkers/validator_checkers/missing_unique_index_c
 require 'database_consistency/checkers/validators_fraction_checkers/validators_fraction_checker'
 require 'database_consistency/checkers/validators_fraction_checkers/column_presence_checker'
 
+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/processors/base_processor'
 require 'database_consistency/processors/associations_processor'
 require 'database_consistency/processors/validators_processor'
 require 'database_consistency/processors/columns_processor'
 require 'database_consistency/processors/validators_fractions_processor'
+require 'database_consistency/processors/indexes_processor'
 
 # The root module
 module DatabaseConsistency

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

@@ -68,7 +68,7 @@ module DatabaseConsistency
       def associated_key
         @associated_key ||= (
           if belongs_to_association?
-            association.active_record_primary_key
+            association.association_primary_key
           else
             association.foreign_key
           end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Checkers
+    # The base class for table checkers
+    class IndexChecker < BaseChecker
+      attr_reader :model, :index
+
+      def initialize(model, index)
+        @model = model
+        @index = index
+      end
+
+      def column_or_attribute_name
+        @column_or_attribute_name ||= index.name.to_s
+      end
+
+      def table_or_model_name
+        @table_or_model_name ||= model.name.to_s
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+# 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
+
+            include_index_as_prefix?(another_index)
+          end
+      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/unique_index_checker.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Checkers
+    # This class checks missing uniqueness validator
+    class UniqueIndexChecker < IndexChecker
+      # Message templates
+      VALIDATOR_MISSING = 'index is unique in the database but do not have uniqueness validator'
+
+      private
+
+      # We skip check when:
+      #  - index is not unique
+      def preconditions
+        index.unique
+      end
+
+      # Table of possible statuses
+      # | validation | status |
+      # | ---------- | ------ |
+      # | provided   | ok     |
+      # | missing    | fail   |
+      #
+      def check
+        if valid?
+          report_template(:ok)
+        else
+          report_template(:fail, VALIDATOR_MISSING)
+        end
+      end
+
+      def valid?
+        uniqueness_validators = model.validators.select { |validator| validator.kind == :uniqueness }
+
+        uniqueness_validators.any? do |validator|
+          validator.attributes.any? do |attribute|
+            sorted_index_columns == Helper.sorted_uniqueness_validator_columns(attribute, validator, model)
+          end
+        end
+      end
+
+      def sorted_index_columns
+        @sorted_index_columns ||= Helper.extract_index_columns(index.columns).sort
+      end
+    end
+  end
+end

data/lib/database_consistency/checkers/validator_checkers/missing_unique_index_checker.rb

@@ -7,7 +7,7 @@ module DatabaseConsistency
       MISSING_INDEX = 'model should have proper unique index in the database'
 
       def column_or_attribute_name
-        @column_or_attribute_name ||= index_columns.join('+')
+        @column_or_attribute_name ||= Helper.uniqueness_validator_columns(attribute, validator, model).join('+')
       end
 
       private
@@ -33,42 +33,12 @@ module DatabaseConsistency
 
       def unique_index
         @unique_index ||= model.connection.indexes(model.table_name).find do |index|
-          index.unique && extract_index_columns(index.columns).sort == sorted_index_columns
+          index.unique && Helper.extract_index_columns(index.columns).sort == sorted_uniqueness_validator_columns
         end
       end
 
-      # @return [Array<String>]
-      def extract_index_columns(index_columns)
-        return index_columns unless index_columns.is_a?(String)
-
-        index_columns.split(',')
-                     .map(&:strip)
-                     .map { |str| str.gsub(/lower\(/i, 'lower(') }
-                     .map { |str| str.gsub(/\(([^)]+)\)::\w+/, '\1') }
-                     .map { |str| str.gsub(/'([^)]+)'::\w+/, '\1') }
-      end
-
-      def index_columns
-        @index_columns ||= ([wrapped_attribute_name] + scope_columns).map(&:to_s)
-      end
-
-      def scope_columns
-        @scope_columns ||= Array.wrap(validator.options[:scope]).map do |scope_item|
-          model._reflect_on_association(scope_item)&.foreign_key || scope_item
-        end
-      end
-
-      def sorted_index_columns
-        @sorted_index_columns ||= index_columns.sort
-      end
-
-      # @return [String]
-      def wrapped_attribute_name
-        if validator.options[:case_sensitive].nil? || validator.options[:case_sensitive]
-          attribute
-        else
-          "lower(#{attribute})"
-        end
+      def sorted_uniqueness_validator_columns
+        @sorted_uniqueness_validator_columns ||= Helper.sorted_uniqueness_validator_columns(attribute, validator, model)
       end
     end
   end

data/lib/database_consistency/helper.rb

@@ -34,5 +34,39 @@ module DatabaseConsistency
 
       associations
     end
+
+    # @return [Array<String>]
+    def extract_index_columns(index_columns)
+      return index_columns unless index_columns.is_a?(String)
+
+      index_columns.split(',')
+                   .map(&:strip)
+                   .map { |str| str.gsub(/lower\(/i, 'lower(') }
+                   .map { |str| str.gsub(/\(([^)]+)\)::\w+/, '\1') }
+                   .map { |str| str.gsub(/'([^)]+)'::\w+/, '\1') }
+    end
+
+    def sorted_uniqueness_validator_columns(attribute, validator, model)
+      uniqueness_validator_columns(attribute, validator, model).sort
+    end
+
+    def uniqueness_validator_columns(attribute, validator, model)
+      ([wrapped_attribute_name(attribute, validator)] + 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
+      end
+    end
+
+    # @return [String]
+    def wrapped_attribute_name(attribute, validator)
+      if validator.options[:case_sensitive].nil? || validator.options[:case_sensitive]
+        attribute
+      else
+        "lower(#{attribute})"
+      end
+    end
   end
 end

data/lib/database_consistency/processors/base_processor.rb

@@ -8,7 +8,8 @@ module DatabaseConsistency
         ColumnsProcessor,
         ValidatorsProcessor,
         AssociationsProcessor,
-        ValidatorsFractionsProcessor
+        ValidatorsFractionsProcessor,
+        IndexesProcessor
       ].flat_map do |processor|
         processor.new(configuration).reports
       end

data/lib/database_consistency/processors/indexes_processor.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Processors
+    # The class to process indexes
+    class IndexesProcessor < BaseProcessor
+      CHECKERS = [
+        Checkers::UniqueIndexChecker,
+        Checkers::RedundantIndexChecker
+      ].freeze
+
+      private
+
+      def check # rubocop:disable Metrics/AbcSize
+        Helper.parent_models.flat_map do |model|
+          next unless configuration.enabled?(model.name.to_s)
+
+          indexes = ActiveRecord::Base.connection.indexes(model.table_name)
+
+          indexes.flat_map do |index|
+            enabled_checkers.map do |checker_class|
+              checker = checker_class.new(model, index)
+              checker.report_if_enabled?(configuration)
+            end
+          end
+        end.compact
+      end
+    end
+  end
+end

data/lib/database_consistency/templates/rails_defaults.yml

@@ -5,3 +5,5 @@ ActiveStorage::Attachment:
   enabled: false
 ActiveStorage::Blob:
   enabled: false
+ActiveStorage::VariantRecord:
+  enabled: false

data/lib/database_consistency/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: database_consistency
 version: !ruby/object:Gem::Version
-  version: 0.8.9
+  version: 1.0.0
 platform: ruby
 authors:
 - Evgeniy Demin
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-16 00:00:00.000000000 Z
+date: 2021-04-24 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:
@@ -140,6 +140,9 @@ files:
 - lib/database_consistency/checkers/column_checkers/length_constraint_checker.rb
 - 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/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
@@ -154,6 +157,7 @@ files:
 - lib/database_consistency/processors/associations_processor.rb
 - lib/database_consistency/processors/base_processor.rb
 - lib/database_consistency/processors/columns_processor.rb
+- lib/database_consistency/processors/indexes_processor.rb
 - lib/database_consistency/processors/validators_fractions_processor.rb
 - lib/database_consistency/processors/validators_processor.rb
 - lib/database_consistency/rescue_error.rb
@@ -165,7 +169,7 @@ homepage: https://github.com/djezzzl/database_consistency
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -181,7 +185,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.