database_consistency 0.8.7 → 0.8.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1dff50eb6317680dc36fc0260a90c4071bfada212d1124169437123b93d1f65
-  data.tar.gz: 1fcd504bfaed4674386b3af7d53d9d2d2bd2b1f28d2fb65cd3ae1c1c0f1f1eae
+  metadata.gz: ba8c6b25dd4a98dcc7de0dfad22a1c33e4c3a325ab999aedd037fe743c108bdd
+  data.tar.gz: 9c563d73dec087a460e10b9acedc365bbc45059028df5571d59ec6dbfa11f1b1
 SHA512:
-  metadata.gz: 22aaae1a55a6c7bc6dd3027852cf8e8b0e94e970c06ac445455e1c5abe787be2a273ed9d7f2b7e9c13b5455f827b1bec82d02eb117eed2599c8e90ebd12719ab
-  data.tar.gz: e9203782f9364aa086c1ee20e03d6497c92ce17d5e5ece293390549ce4e4f3dbeb0ff07980a9be5548558d59527c4e2a5d0c3928b67991ca27d99fa5f9908dfb
+  metadata.gz: f51d16f3806889640ad04fca4cddda635c708063d0c6554a6f0589678ca8cfe290db7a9709df5232fe0bbfb14fd8532b8498bb6204e2a341473dd27ae3c40400
+  data.tar.gz: '09097fa4bfec79f64a87df086601253594ce409b4d11b736df0127b3b9af10145f721d761ab90c8a0865cd12c48ecb9429211299d1244e02ddf2a88e11c971a9'

data/lib/database_consistency.rb

@@ -6,6 +6,7 @@ require 'database_consistency/version'
 require 'database_consistency/helper'
 require 'database_consistency/configuration'
 require 'database_consistency/rescue_error'
+require 'database_consistency/errors'
 
 require 'database_consistency/writers/base_writer'
 require 'database_consistency/writers/simple_writer'
@@ -32,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

@@ -19,10 +19,14 @@ module DatabaseConsistency
 
       # We skip check when:
       #  - association is polymorphic association
+      #  - association is has_and_belongs_to_many
       #  - association has `through` option
       #  - associated class doesn't exist
       def preconditions
-        !association.polymorphic? && association.through_reflection.nil? && association.klass.present?
+        !association.polymorphic? &&
+          association.through_reflection.nil? &&
+          association.klass.present? &&
+          association.macro != :has_and_belongs_to_many
       rescue NameError
         false
       end
@@ -64,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
@@ -91,7 +95,14 @@ module DatabaseConsistency
       #
       # @return [ActiveRecord::ConnectionAdapters::Column]
       def column(model, column_name)
-        model.connection.columns(model.table_name).find { |column| column.name == column_name }
+        model.connection.columns(model.table_name).find { |column| column.name == column_name } ||
+          (raise Errors::MissingField, missing_field_error(model.table_name, column_name))
+      end
+
+      # @return [String]
+      def missing_field_error(table_name, column_name)
+        "Association (#{association.name}) of class (#{association.active_record}) relies on "\
+          "field (#{column_name}) of table (#{table_name}) but it is missing."
       end
 
       # @param [ActiveRecord::ConnectionAdapters::Column] column

data/lib/database_consistency/checkers/base_checker.rb

@@ -16,16 +16,20 @@ module DatabaseConsistency
         @checker_name ||= name.split('::').last
       end
 
-      # @return [Hash, nil]
-      def report
+      # @param [Boolean] catch_errors
+      #
+      # @return [Hash, File, nil]
+      def report(catch_errors = true)
         return unless preconditions
 
         @report ||= check
       rescue StandardError => e
+        raise e unless catch_errors
+
         RescueError.call(e)
       end
 
-      # @return [Hash, nil]
+      # @return [Hash, File, nil]
       def report_if_enabled?(configuration)
         report if enabled?(configuration)
       end
@@ -62,7 +66,7 @@ module DatabaseConsistency
         raise NotImplementedError
       end
 
-      # @return [Hash]
+      # @return [OpenStruct]
       def report_template(status, message = nil)
         OpenStruct.new(
           checker_name: checker_name,

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/errors.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Errors
+    # The base error class
+    class Base < StandardError; end
+
+    # The error class for missing field
+    class MissingField < Base; end
+  end
+end

data/lib/database_consistency/helper.rb

@@ -8,7 +8,7 @@ module DatabaseConsistency
     # Returns list of models to check
     def models
       ActiveRecord::Base.descendants.delete_if(&:abstract_class?).delete_if do |klass|
-        !klass.connection.table_exists?(klass.table_name)
+        !klass.connection.table_exists?(klass.table_name) || klass.name.include?('HABTM_')
       end
     end
 
@@ -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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: database_consistency
 version: !ruby/object:Gem::Version
-  version: 0.8.7
+  version: 0.8.12
 platform: ruby
 authors:
 - Evgeniy Demin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-23 00:00:00.000000000 Z
+date: 2020-12-08 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
@@ -149,10 +151,12 @@ files:
 - lib/database_consistency/databases/factory.rb
 - lib/database_consistency/databases/types/base.rb
 - lib/database_consistency/databases/types/sqlite.rb
+- lib/database_consistency/errors.rb
 - lib/database_consistency/helper.rb
 - 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