database_consistency 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5feffbf59ee35344cc1f96e796cd63adea0ca6aa6b01eb81cacbb5c166bd082b
-  data.tar.gz: ac0bb8dbb583b572b785591f59bce8bebb307b267e07960707e72861e7d6b6ff
+  metadata.gz: 1528eadd95e4bdb9511b145d5d8584e4ebde5f9bf30b63de852e5d24fa5a79c5
+  data.tar.gz: 4b36f7adca734d72d611c12a846f800a507e5b56c4a32c524713b27a646f79e2
 SHA512:
-  metadata.gz: 189c7967c87ebac15dfe0e68a98041423148a37596508360f87cbba295790754575aabef0cd4740e4d3c5b0bb6766eb62675920fcb01972f723d7ccfa166ce4f
-  data.tar.gz: beddfa2491ec4ec8d22bac9b4b081933d2751dd9931f849f4713e9a3e2f41aaae8850a88ee3041adb154b1ed960a65949e25e3754d5706b079d1b612182ed77b
+  metadata.gz: 7a88219644a5da2c07797b6a9b7e2378c4285498576dcd2b23dd877a8404bbb7be81f08c3aa4acd88d259e9d268748a8026ec5047b4f80ac26b0e240e0c62144
+  data.tar.gz: 15a9f2a8851db00e35b065f5143acb85321839f4a1965800b95d01dc44b741737764bcd261c58f637ad17b65707c298c8f6a4b6abe6874539f726a4ce13ebee3

data/lib/database_consistency/checkers/association_checker.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Checkers
+    # The base class for association checkers
+    class AssociationChecker < BaseChecker
+      attr_reader :model, :association
+
+      def initialize(model, association)
+        @model = model
+        @association = association
+      end
+
+      def column_or_attribute_name
+        @column_or_attribute_name ||= association.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/belongs_to_presence_checker.rb

@@ -4,16 +4,16 @@ module DatabaseConsistency
   module Checkers
     # This class checks if required +belongs_to+ has foreign key constraint
     class BelongsToPresenceChecker < ValidatorChecker
-      MISSING_FOREIGN_KEY = 'should have foreign key in the database'
+      MISSING_FOREIGN_KEY = 'model should have proper foreign key in the database'
 
       private
 
       # We skip check when:
       #  - validator is a not a presence validator
-      #  - there is no belongs_to reflection with given name
-      #  - belongs_to reflection is polymorphic
+      #  - there is no belongs_to association with given name
+      #  - belongs_to association is polymorphic
       def preconditions
-        validator.kind == :presence && reflection && !reflection.polymorphic?
+        validator.kind == :presence && association && !association.polymorphic?
       end
 
       # Table of possible statuses
@@ -22,15 +22,15 @@ module DatabaseConsistency
       # | persisted   | ok     |
       # | missing     | fail   |
       def check
-        if model.connection.foreign_keys(model.table_name).find { |fk| fk.column == reflection.foreign_key.to_s }
+        if model.connection.foreign_keys(model.table_name).find { |fk| fk.column == association.foreign_key.to_s }
           report_template(:ok)
         else
           report_template(:fail, MISSING_FOREIGN_KEY)
         end
       end
 
-      def reflection
-        @reflection ||= model.reflect_on_association(attribute)
+      def association
+        @association ||= model.reflect_on_association(attribute)
       end
     end
   end

data/lib/database_consistency/checkers/{table_checker.rb → column_checker.rb}

@@ -3,7 +3,7 @@
 module DatabaseConsistency
   module Checkers
     # The base class for table checkers
-    class TableChecker < BaseChecker
+    class ColumnChecker < BaseChecker
       attr_reader :model, :column
 
       def initialize(model, column)

data/lib/database_consistency/checkers/column_presence_checker.rb

@@ -6,8 +6,8 @@ module DatabaseConsistency
     class ColumnPresenceChecker < ValidatorChecker
       WEAK_OPTIONS = %i[allow_nil allow_blank if unless].freeze
       # Message templates
-      CONSTRAINT_MISSING = 'should be required in the database'
-      POSSIBLE_NULL = 'is required but possible null value insert'
+      CONSTRAINT_MISSING = 'column should be required in the database'
+      POSSIBLE_NULL = 'column is required but there is possible null value insert'
 
       private
 

data/lib/database_consistency/checkers/missing_index_checker.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Checkers
+    # This class checks if association's foreign key has index in the database
+    class MissingIndexChecker < AssociationChecker
+      # Message templates
+      MISSING_INDEX = 'associated model should have proper index in the database'
+
+      private
+
+      # We skip check when:
+      #  - association isn't a `HasOne` or `HasMany`
+      def preconditions
+        [
+          ActiveRecord::Associations::HasOneAssociation,
+          ActiveRecord::Associations::HasOneThroughAssociation,
+          ActiveRecord::Associations::HasManyAssociation,
+          ActiveRecord::Associations::HasManyThroughAssociation
+        ].include?(association.association_class)
+      end
+
+      # Table of possible statuses
+      # | index        | status |
+      # | ------------ | ------ |
+      # | persisted    | ok     |
+      # | missing      | fail   |
+      def check
+        if index
+          report_template(:ok)
+        else
+          report_template(:fail, MISSING_INDEX)
+        end
+      end
+
+      def index
+        @index ||= association.klass.connection.indexes(association.klass.table_name).find do |index|
+          index.columns[0] == association.foreign_key.to_s
+        end
+      end
+    end
+  end
+end

data/lib/database_consistency/checkers/missing_unique_index_checker.rb

@@ -4,7 +4,7 @@ module DatabaseConsistency
   module Checkers
     # This class checks if uniqueness validator has unique index in the database
     class MissingUniqueIndexChecker < ValidatorChecker
-      MISSING_INDEX = 'should have unique index in the database'
+      MISSING_INDEX = 'model should have proper unique index in the database'
 
       def column_or_attribute_name
         @column_or_attribute_name ||= index_columns.join('+')

data/lib/database_consistency/checkers/null_constraint_checker.rb

@@ -3,9 +3,9 @@
 module DatabaseConsistency
   module Checkers
     # This class checks missing presence validator
-    class NullConstraintChecker < TableChecker
+    class NullConstraintChecker < ColumnChecker
       # Message templates
-      VALIDATOR_MISSING = 'is required but do not have presence validator'
+      VALIDATOR_MISSING = 'column is required in the database but do not have presence validator'
 
       private
 
@@ -24,7 +24,7 @@ module DatabaseConsistency
       # | provided   | ok     |
       # | missing    | fail   |
       #
-      # We consider PresenceValidation, InclusionValidation or BelongsTo reflection using this column
+      # We consider PresenceValidation, InclusionValidation or BelongsTo association using this column
       def check
         if valid?
           report_template(:ok)
@@ -36,7 +36,7 @@ module DatabaseConsistency
       def valid?
         validator?(ActiveModel::Validations::PresenceValidator) ||
           validator?(ActiveModel::Validations::InclusionValidator) ||
-          belongs_to_reflection?
+          belongs_to_association?
       end
 
       def primary_field?
@@ -53,7 +53,7 @@ module DatabaseConsistency
         end
       end
 
-      def belongs_to_reflection?
+      def belongs_to_association?
         model.reflect_on_all_associations.grep(ActiveRecord::Reflection::BelongsToReflection).any? do |r|
           Helper.check_inclusion?([r.foreign_key, r.foreign_type], column.name)
         end

data/lib/database_consistency/processors/associations_processor.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Processors
+    # The class to process associations
+    class AssociationsProcessor < BaseProcessor
+      CHECKERS = [
+        Checkers::MissingIndexChecker
+      ].freeze
+
+      private
+
+      def check
+        Helper.models.flat_map do |model|
+          model.reflect_on_all_associations.flat_map do |association|
+            CHECKERS.map do |checker_class|
+              checker = checker_class.new(model, association)
+              checker.report if checker.enabled?(configuration)
+            end
+          end
+        end.compact
+      end
+    end
+  end
+end

data/lib/database_consistency/processors/base_processor.rb

@@ -4,7 +4,11 @@ module DatabaseConsistency
   # The module for processors
   module Processors
     def self.reports(configuration)
-      [ModelsProcessor, TablesProcessor].flat_map do |processor|
+      [
+        ColumnsProcessor,
+        ValidatorsProcessor,
+        AssociationsProcessor
+      ].flat_map do |processor|
         processor.new(configuration).reports
       end
     end

data/lib/database_consistency/processors/{tables_processor.rb → columns_processor.rb}

@@ -2,8 +2,8 @@
 
 module DatabaseConsistency
   module Processors
-    # The class to process missing validators
-    class TablesProcessor < BaseProcessor
+    # The class to process columns
+    class ColumnsProcessor < BaseProcessor
       CHECKERS = [
         Checkers::NullConstraintChecker
       ].freeze

data/lib/database_consistency/processors/{models_processor.rb → validators_processor.rb}

@@ -2,8 +2,8 @@
 
 module DatabaseConsistency
   module Processors
-    # The class to process all comparators
-    class ModelsProcessor < BaseProcessor
+    # The class to process validators
+    class ValidatorsProcessor < BaseProcessor
       CHECKERS = [
         Checkers::ColumnPresenceChecker,
         Checkers::BelongsToPresenceChecker,

data/lib/database_consistency/version.rb

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

data/lib/database_consistency.rb

@@ -10,16 +10,20 @@ require 'database_consistency/writers/base_writer'
 require 'database_consistency/writers/simple_writer'
 
 require 'database_consistency/checkers/base_checker'
-require 'database_consistency/checkers/table_checker'
+require 'database_consistency/checkers/association_checker'
+require 'database_consistency/checkers/column_checker'
 require 'database_consistency/checkers/validator_checker'
+
 require 'database_consistency/checkers/column_presence_checker'
 require 'database_consistency/checkers/null_constraint_checker'
 require 'database_consistency/checkers/belongs_to_presence_checker'
 require 'database_consistency/checkers/missing_unique_index_checker'
+require 'database_consistency/checkers/missing_index_checker'
 
 require 'database_consistency/processors/base_processor'
-require 'database_consistency/processors/models_processor'
-require 'database_consistency/processors/tables_processor'
+require 'database_consistency/processors/associations_processor'
+require 'database_consistency/processors/validators_processor'
+require 'database_consistency/processors/columns_processor'
 
 # The root module
 module DatabaseConsistency

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: database_consistency
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Evgeniy Demin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-11 00:00:00.000000000 Z
+date: 2019-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -110,18 +110,21 @@ extra_rdoc_files: []
 files:
 - bin/database_consistency
 - lib/database_consistency.rb
+- lib/database_consistency/checkers/association_checker.rb
 - lib/database_consistency/checkers/base_checker.rb
 - lib/database_consistency/checkers/belongs_to_presence_checker.rb
+- lib/database_consistency/checkers/column_checker.rb
 - lib/database_consistency/checkers/column_presence_checker.rb
+- lib/database_consistency/checkers/missing_index_checker.rb
 - lib/database_consistency/checkers/missing_unique_index_checker.rb
 - lib/database_consistency/checkers/null_constraint_checker.rb
-- lib/database_consistency/checkers/table_checker.rb
 - lib/database_consistency/checkers/validator_checker.rb
 - lib/database_consistency/configuration.rb
 - lib/database_consistency/helper.rb
+- lib/database_consistency/processors/associations_processor.rb
 - lib/database_consistency/processors/base_processor.rb
-- lib/database_consistency/processors/models_processor.rb
-- lib/database_consistency/processors/tables_processor.rb
+- lib/database_consistency/processors/columns_processor.rb
+- lib/database_consistency/processors/validators_processor.rb
 - lib/database_consistency/version.rb
 - lib/database_consistency/writers/base_writer.rb
 - lib/database_consistency/writers/simple_writer.rb