database_consistency 1.7.12 → 1.7.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8560e4cc5588b8182f8d5258703894839190a758abf57e35e2abe81a630848fc
-  data.tar.gz: 26b96205cd47d48f9a557d6986ef2d2f0eef940f1407ed430760f6201c91cca5
+  metadata.gz: 3621ad7d1790987ba3867541950d611af17e26be2da7bbc1a33914db25292872
+  data.tar.gz: 8d26e698a1c2ca1f8ba37e2ca899b3486730a025e7b4377645603eda312c0d59
 SHA512:
-  metadata.gz: bfb1870b761338b23481926ec64cea7a814b7a174937d5035ca6a71ef63f7cfd332db6ab243f15ff5e9990a6445522b5565d2103b0c45eeb147f22eddbc48d7f
-  data.tar.gz: feec3a2004be04efe8ab1329a79b4b4395ffa3feec5c7798ad04b8218b7365b917a89a80681409d9a1827a5620105a7295ff6b67863828dd85b555c1dc8e7e7f
+  metadata.gz: aedb071d671ca0a4b92a060c58aced55e4e49039d80fbb8d0fc6aa2062070763d5ae4d08333c32cdc3c65fcdb4bf7798875076b47d342c541d1e73ce7c3e57d3
+  data.tar.gz: 82c070e44a36db48e84f17f701168d2fc02f019bd61dcdc9fa43d2cd79039eb865f8466215a75940a66b0cc782417a5adfe47394e4ed1b046164a6e43ce89092

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

@@ -22,6 +22,8 @@ module DatabaseConsistency
         supported? &&
           association.belongs_to? && !association.polymorphic? &&
           same_database?
+      rescue NameError
+        false
       end
 
       def same_database?

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

@@ -25,7 +25,8 @@ module DatabaseConsistency
         !association.polymorphic? &&
           association.through_reflection.nil? &&
           association.klass.present? &&
-          association.macro != :has_and_belongs_to_many
+          association.macro != :has_and_belongs_to_many &&
+          association.klass.table_exists?
       rescue NameError
         false
       end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Checkers
+    # This class checks if an association has existing class defined
+    class MissingAssociationClassChecker < AssociationChecker
+      Report = ReportBuilder.define(
+        DatabaseConsistency::Report,
+        :class_name
+      )
+
+      private
+
+      def preconditions
+        !association.polymorphic?
+      end
+
+      def check
+        association.klass
+        report_template(:ok)
+      rescue NameError
+        report_template(:fail, error_slug: :missing_association_class)
+      end
+
+      def report_template(status, error_slug: nil)
+        Report.new(
+          status: status,
+          error_message: nil,
+          error_slug: error_slug,
+          class_name: association.class_name,
+          **report_attributes
+        )
+      end
+    end
+  end
+end

data/lib/database_consistency/checkers/model_checkers/missing_table_checker.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Checkers
+    # This class checks that a model has a corresponding table
+    class MissingTableChecker < ModelChecker
+      private
+
+      def preconditions
+        !model.abstract_class?
+      end
+
+      def check
+        if model.table_exists?
+          report_template(:ok)
+        else
+          report_template(:fail, error_slug: :missing_table)
+        end
+      end
+    end
+  end
+end

data/lib/database_consistency/checkers/model_checkers/model_checker.rb

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

data/lib/database_consistency/helper.rb

@@ -29,13 +29,18 @@ module DatabaseConsistency
       end
     end
 
+    def project_models
+      ActiveRecord::Base.descendants.select do |klass|
+        project_klass?(klass)
+      end
+    end
+
     # Returns list of models to check
     def models
-      ActiveRecord::Base.descendants.select do |klass|
+      project_models.select do |klass|
         !klass.abstract_class? &&
           klass.connection.table_exists?(klass.table_name) &&
-          !klass.name.include?('HABTM_') &&
-          project_klass?(klass)
+          !klass.name.include?('HABTM_')
       end
     end
 

data/lib/database_consistency/processors/associations_processor.rb

@@ -8,7 +8,8 @@ module DatabaseConsistency
         Checkers::MissingIndexChecker,
         Checkers::ForeignKeyChecker,
         Checkers::ForeignKeyTypeChecker,
-        Checkers::ForeignKeyCascadeChecker
+        Checkers::ForeignKeyCascadeChecker,
+        Checkers::MissingAssociationClassChecker
       ].freeze
 
       private

data/lib/database_consistency/processors/base_processor.rb

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

data/lib/database_consistency/processors/models_processor.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Processors
+    # The class to process models
+    class ModelsProcessor < BaseProcessor
+      CHECKERS = [
+        Checkers::MissingTableChecker
+      ].freeze
+
+      private
+
+      def check
+        Helper.project_models.flat_map do |model|
+          next unless configuration.enabled?('DatabaseConsistencyDatabases', Helper.database_name(model)) &&
+                      configuration.enabled?(model.name.to_s)
+
+          enabled_checkers.flat_map do |checker_class|
+            checker = checker_class.new(model)
+            checker.report_if_enabled?(configuration)
+          end
+        end.compact
+      end
+    end
+  end
+end

data/lib/database_consistency/version.rb

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

data/lib/database_consistency/writers/simple/base.rb

@@ -33,7 +33,7 @@ module DatabaseConsistency
         end
 
         def msg
-          "#{report.checker_name} #{status_text} #{key_text} #{message_text}".strip
+          [report.checker_name, status_text, key_text, message_text].compact.join(' ').strip
         end
 
         def unique_key
@@ -57,11 +57,14 @@ module DatabaseConsistency
         end
 
         def key_text
-          "#{colorize(report.table_or_model_name, :blue)} #{colorize(report.column_or_attribute_name, :yellow)}"
+          [
+            colorize(report.table_or_model_name, :blue),
+            colorize(report.column_or_attribute_name, :yellow)
+          ].compact.join(' ')
         end
 
         def colorize(text, color)
-          return text unless config.colored? && color
+          return text unless text && config.colored? && color
 
           "#{COLORS[color]}#{text}\e[0m"
         end

data/lib/database_consistency/writers/simple/missing_association_class.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Writers
+    module Simple
+      class MissingAssociationClass < Base # :nodoc:
+        private
+
+        def template
+          'refers to undefined model "%<class_name>s"'
+        end
+
+        def unique_attributes
+          {
+            class_name: report.class_name
+          }
+        end
+
+        def attributes
+          {
+            class_name: report.class_name
+          }
+        end
+      end
+    end
+  end
+end

data/lib/database_consistency/writers/simple/missing_table.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Writers
+    module Simple
+      class MissingTable < Base # :nodoc:
+        private
+
+        def template
+          'should have a table in the database'
+        end
+
+        def unique_attributes
+          {
+            table_or_model_name: report.table_or_model_name
+          }
+        end
+      end
+    end
+  end
+end

data/lib/database_consistency/writers/simple_writer.rb

@@ -6,29 +6,31 @@ module DatabaseConsistency
     # The simplest formatter
     class SimpleWriter < BaseWriter
       SLUG_TO_WRITER = {
+        association_foreign_type_missing_null_constraint: Simple::AssociationForeignTypeMissingNullConstraint,
         association_missing_index: Simple::AssociationMissingIndex,
         association_missing_null_constraint: Simple::AssociationMissingNullConstraint,
-        association_foreign_type_missing_null_constraint: Simple::AssociationForeignTypeMissingNullConstraint,
+        enum_values_inconsistent_with_ar_enum: Simple::EnumValuesInconsistentWithArEnum,
+        enum_values_inconsistent_with_inclusion: Simple::EnumValuesInconsistentWithInclusion,
         has_one_missing_unique_index: Simple::HasOneMissingUniqueIndex,
+        inconsistent_enum_type: Simple::InconsistentEnumType,
         inconsistent_types: Simple::InconsistentTypes,
         length_validator_greater_limit: Simple::LengthValidatorGreaterLimit,
         length_validator_lower_limit: Simple::LengthValidatorLowerLimit,
         length_validator_missing: Simple::LengthValidatorMissing,
+        missing_association_class: Simple::MissingAssociationClass,
         missing_foreign_key: Simple::MissingForeignKey,
+        missing_foreign_key_cascade: Simple::MissingForeignKeyCascade,
+        missing_table: Simple::MissingTable,
         missing_unique_index: Simple::MissingUniqueIndex,
         missing_uniqueness_validation: Simple::MissingUniquenessValidation,
         null_constraint_association_misses_validator: Simple::NullConstraintAssociationMissesValidator,
         null_constraint_misses_validator: Simple::NullConstraintMissesValidator,
         null_constraint_missing: Simple::NullConstraintMissing,
         possible_null: Simple::PossibleNull,
+        redundant_case_insensitive_option: Simple::RedundantCaseInsensitiveOption,
         redundant_index: Simple::RedundantIndex,
         redundant_unique_index: Simple::RedundantUniqueIndex,
         small_primary_key: Simple::SmallPrimaryKey,
-        inconsistent_enum_type: Simple::InconsistentEnumType,
-        missing_foreign_key_cascade: Simple::MissingForeignKeyCascade,
-        enum_values_inconsistent_with_ar_enum: Simple::EnumValuesInconsistentWithArEnum,
-        enum_values_inconsistent_with_inclusion: Simple::EnumValuesInconsistentWithInclusion,
-        redundant_case_insensitive_option: Simple::RedundantCaseInsensitiveOption,
         three_state_boolean: Simple::ThreeStateBoolean
       }.freeze
 

data/lib/database_consistency.rb

@@ -39,6 +39,8 @@ require 'database_consistency/writers/simple/enum_values_inconsistent_with_ar_en
 require 'database_consistency/writers/simple/enum_values_inconsistent_with_inclusion'
 require 'database_consistency/writers/simple/redundant_case_insensitive_option'
 require 'database_consistency/writers/simple/three_state_boolean'
+require 'database_consistency/writers/simple/missing_association_class'
+require 'database_consistency/writers/simple/missing_table'
 require 'database_consistency/writers/simple_writer'
 
 require 'database_consistency/writers/autofix/helpers/migration'
@@ -61,11 +63,15 @@ require 'database_consistency/checkers/base_checker'
 require 'database_consistency/checkers/enum_checkers/enum_checker'
 require 'database_consistency/checkers/enum_checkers/enum_type_checker'
 
+require 'database_consistency/checkers/model_checkers/model_checker'
+require 'database_consistency/checkers/model_checkers/missing_table_checker'
+
 require 'database_consistency/checkers/association_checkers/association_checker'
 require 'database_consistency/checkers/association_checkers/missing_index_checker'
 require 'database_consistency/checkers/association_checkers/foreign_key_checker'
 require 'database_consistency/checkers/association_checkers/foreign_key_type_checker'
 require 'database_consistency/checkers/association_checkers/foreign_key_cascade_checker'
+require 'database_consistency/checkers/association_checkers/missing_association_class_checker'
 
 require 'database_consistency/checkers/column_checkers/column_checker'
 require 'database_consistency/checkers/column_checkers/null_constraint_checker'
@@ -93,6 +99,7 @@ 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'
+require 'database_consistency/processors/models_processor'
 
 # The root module
 module DatabaseConsistency

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: database_consistency
 version: !ruby/object:Gem::Version
-  version: 1.7.12
+  version: 1.7.15
 platform: ruby
 authors:
 - Evgeniy Demin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-05 00:00:00.000000000 Z
+date: 2023-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -150,6 +150,7 @@ files:
 - lib/database_consistency/checkers/association_checkers/foreign_key_cascade_checker.rb
 - lib/database_consistency/checkers/association_checkers/foreign_key_checker.rb
 - lib/database_consistency/checkers/association_checkers/foreign_key_type_checker.rb
+- lib/database_consistency/checkers/association_checkers/missing_association_class_checker.rb
 - lib/database_consistency/checkers/association_checkers/missing_index_checker.rb
 - lib/database_consistency/checkers/base_checker.rb
 - lib/database_consistency/checkers/column_checkers/column_checker.rb
@@ -164,6 +165,8 @@ files:
 - lib/database_consistency/checkers/index_checkers/redundant_index_checker.rb
 - lib/database_consistency/checkers/index_checkers/redundant_unique_index_checker.rb
 - lib/database_consistency/checkers/index_checkers/unique_index_checker.rb
+- lib/database_consistency/checkers/model_checkers/missing_table_checker.rb
+- lib/database_consistency/checkers/model_checkers/model_checker.rb
 - lib/database_consistency/checkers/validator_checkers/case_sensitive_unique_validation_checker.rb
 - lib/database_consistency/checkers/validator_checkers/missing_unique_index_checker.rb
 - lib/database_consistency/checkers/validator_checkers/validator_checker.rb
@@ -180,6 +183,7 @@ files:
 - lib/database_consistency/processors/columns_processor.rb
 - lib/database_consistency/processors/enums_processor.rb
 - lib/database_consistency/processors/indexes_processor.rb
+- lib/database_consistency/processors/models_processor.rb
 - lib/database_consistency/processors/validators_fractions_processor.rb
 - lib/database_consistency/processors/validators_processor.rb
 - lib/database_consistency/report.rb
@@ -217,8 +221,10 @@ files:
 - lib/database_consistency/writers/simple/length_validator_greater_limit.rb
 - lib/database_consistency/writers/simple/length_validator_lower_limit.rb
 - lib/database_consistency/writers/simple/length_validator_missing.rb
+- lib/database_consistency/writers/simple/missing_association_class.rb
 - lib/database_consistency/writers/simple/missing_foreign_key.rb
 - lib/database_consistency/writers/simple/missing_foreign_key_cascade.rb
+- lib/database_consistency/writers/simple/missing_table.rb
 - lib/database_consistency/writers/simple/missing_unique_index.rb
 - lib/database_consistency/writers/simple/missing_uniqueness_validation.rb
 - lib/database_consistency/writers/simple/null_constraint_association_misses_validator.rb
@@ -264,7 +270,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.1
 signing_key: 
 specification_version: 4
 summary: Provide an easy way to check the consistency of the database constraints