database_consistency 0.8.8 → 0.8.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 406fd80b86af26702bba071b8dabe3d8f238923bd7ef6d04776b014d2c5c5575
-  data.tar.gz: b30e6bee8c79233090fb8a94557217a6e2fc72e618b577b858083bf0cd3ba71e
+  metadata.gz: 3d3bf88ec6fae8aac99d835defc6f02c0d16a8bf307c1ff8096c53fa252ef691
+  data.tar.gz: dd877669bd9a0de57fcf74969f16ba5d434997b36bcb4e73473e5242546ff6e6
 SHA512:
-  metadata.gz: 72147fa9f0eccd7ac75216fe673757541048b143ea31fbab435a83e7cb10f62d3e45ae19a5e0c8e609515d3033fa7d868deba863fd8d7ba152f50d254fb3f534
-  data.tar.gz: 6c172f7b74de5face1e235103a2821d41be08f282a840b756caf73f24285e8cf6f7e1f5ecf5e40f26160a8036c947c335edc5338ef3ca274a989d9353220f04d
+  metadata.gz: c3325319154f7e8420f10d39f1e3a1c325e776f4fda2ddee6e004655ee7526bc535bf8e9c958b79d5e41bb3a44a625b6c31eead26437b12b1649fa9fef3b136d
+  data.tar.gz: cee59e3274dc9a841915eb3baf9860cb749a84e1a1baa72e90bde23ba589f2a3d5d8473eda60dc544fa1cbe5fa1ab5496dc64d26ad5052b704ee04b1dbc91c9d

data/lib/database_consistency.rb

@@ -33,11 +33,15 @@ 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/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/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,41 +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') }
-      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,29 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Processors
+    # The class to process indexes
+    class IndexesProcessor < BaseProcessor
+      CHECKERS = [
+        Checkers::UniqueIndexChecker
+      ].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.8'
+  VERSION = '0.8.13'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: database_consistency
 version: !ruby/object:Gem::Version
-  version: 0.8.8
+  version: 0.8.13
 platform: ruby
 authors:
 - Evgeniy Demin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-24 00:00:00.000000000 Z
+date: 2021-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -140,6 +140,8 @@ 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/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 +156,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