database_consistency 1.1.7 → 1.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a742a08f374228e004b155fef15ec5ddaa23404c5aacf42b462eb2cb82ba09a
-  data.tar.gz: 8359e199cdbb89fc9d4b8700728bbef938d2d90a1474e4c2400c2aaa6d31f28f
+  metadata.gz: 908211c725197dadbe72f2f7c8f2f47d48a55ed546c57d2f512b9b2978fb325a
+  data.tar.gz: 4b18e433573c598b25906dce98554516f3c54bacbd897b59c8f72c6d9577a53d
 SHA512:
-  metadata.gz: 962c814731ed2c85427e4b3e765df897c8cd8574f6075e3566e65b72af5effa370a14593019748ff9833a9658a0e55841219acdf3fe9caf212aa9db4bc426df3
-  data.tar.gz: df3aab9a1b6b5d5b2a815ad237b76ff3ffe127cd7921050c09a57e5f53e08087344ad5777224a603c52978382f6568c0c8a19c16038863cb759cac147bb7f9be
+  metadata.gz: 43ea449cc58c970f99deb81936461d2f267a107934ad93cfb1f73ef0e0a8e46c97d9ba5085a54538828d162ca06638ad35afb907fa51de661df30bad9527cefc
+  data.tar.gz: 799f1975507dababf597ca140655377e90a1480af4422080349027b03ef7ef9dbade4125e95f317ef3d873706e82f1c24991c9c9600a08cb3dca3e6ff2bbc8e0

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

@@ -9,14 +9,21 @@ module DatabaseConsistency
       private
 
       # We skip check when:
+      #  - underlying models belong to different databases
       #  - association isn't belongs_to association
       #  - association is polymorphic
       def preconditions
-        supported? && association.belongs_to? && !association.polymorphic?
+        supported? &&
+          association.belongs_to? && !association.polymorphic? &&
+          same_database?
+      end
+
+      def same_database?
+        Helper.connection_config(model) == Helper.connection_config(association.klass)
       end
 
       def supported?
-        return false if ActiveRecord::VERSION::MAJOR < 5 && ActiveRecord::Base.connection_config[:adapter] == 'sqlite3'
+        return false if ActiveRecord::VERSION::MAJOR < 5 && Helper.adapter == 'sqlite3'
 
         true
       end

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

@@ -2,18 +2,9 @@
 
 module DatabaseConsistency
   module Checkers
-    # This class checks if association's foreign key type is the same as associated model's primary key
+    # This class checks if association's foreign key type covers associated model's primary key (same or bigger)
     class ForeignKeyTypeChecker < AssociationChecker
-      INCONSISTENT_TYPE = 'associated model key (%a_f) with type (%a_t) mismatches key (%b_f) with type (%b_t)'
-
-      TYPES = {
-        'serial' => 'integer',
-        'integer' => 'integer',
-        'int' => 'integer',
-        'bigserial' => 'bigint',
-        'bigint' => 'bigint',
-        'bigint unsigned' => 'bigint unsigned'
-      }.freeze
+      INCONSISTENT_TYPE = "foreign key (%a_f) with type (%a_t) doesn't cover primary key (%b_f) with type (%b_t)"
 
       private
 
@@ -32,12 +23,12 @@ module DatabaseConsistency
       end
 
       # Table of possible statuses
-      # | type         | status |
-      # | ------------ | ------ |
-      # | consistent   | ok     |
-      # | inconsistent | fail   |
+      # | type          | status |
+      # | ------------- | ------ |
+      # | covers        | ok     |
+      # | doesn't cover | fail   |
       def check
-        if converted_type(base_column) == converted_type(associated_column)
+        if converted_type(associated_column).cover?(converted_type(primary_column))
           report_template(:ok)
         else
           report_template(:fail, render_text)
@@ -51,40 +42,40 @@ module DatabaseConsistency
         INCONSISTENT_TYPE
           .gsub('%a_t', type(associated_column))
           .gsub('%a_f', associated_key)
-          .gsub('%b_t', type(base_column))
-          .gsub('%b_f', base_key)
+          .gsub('%b_t', type(primary_column))
+          .gsub('%b_f', primary_key)
       end
 
       # @return [String]
-      def base_key
-        @base_key ||= (
-          if belongs_to_association?
-            association.foreign_key
-          else
-            association.active_record_primary_key
-          end
-        ).to_s
+      def primary_key
+        @primary_key ||= if belongs_to_association?
+                           association.association_primary_key
+                         else
+                           association.active_record_primary_key
+                         end.to_s
       end
 
       # @return [String]
       def associated_key
-        @associated_key ||= (
-          if belongs_to_association?
-            association.association_primary_key
-          else
-            association.foreign_key
-          end
-        ).to_s
+        @associated_key ||= association.foreign_key.to_s
       end
 
       # @return [ActiveRecord::ConnectionAdapters::Column]
-      def base_column
-        @base_column ||= column(association.active_record, base_key)
+      def primary_column
+        @primary_column ||= if belongs_to_association?
+                              column(association.klass, primary_key)
+                            else
+                              column(association.active_record, primary_key)
+                            end
       end
 
       # @return [ActiveRecord::ConnectionAdapters::Column]
       def associated_column
-        @associated_column ||= column(association.klass, associated_key)
+        @associated_column ||= if belongs_to_association?
+                                 column(association.active_record, associated_key)
+                               else
+                                 column(association.klass, associated_key)
+                               end
       end
 
       # @return [DatabaseConsistency::Databases::Factory]
@@ -116,9 +107,9 @@ module DatabaseConsistency
 
       # @param [ActiveRecord::ConnectionAdapters::Column]
       #
-      # @return [String]
+      # @return [DatabaseConsistency::Databases::Types::Base]
       def converted_type(column)
-        database_factory.type(type(column)).convert
+        database_factory.type(type(column))
       end
 
       # @return [Boolean]

data/lib/database_consistency/checkers/validators_fraction_checkers/column_presence_checker.rb

@@ -18,7 +18,11 @@ module DatabaseConsistency
 
       # We skip the check when there are no presence validators
       def preconditions
-        validators.any?
+        validators.any? && !association?
+      end
+
+      def association?
+        model._reflect_on_association(attribute)&.macro == :has_one
       end
 
       # Table of possible statuses
@@ -34,13 +38,13 @@ module DatabaseConsistency
         report_template(:fail, e.message)
       end
 
-      def has_weak_option?
+      def weak_option?
         validators.all? { |validator| validator.options.slice(*WEAK_OPTIONS).any? }
       end
 
       def report_message
         can_be_null = column.null
-        has_weak_option = has_weak_option?
+        has_weak_option = weak_option?
 
         return report_template(:ok) if can_be_null == has_weak_option
         return report_template(:fail, POSSIBLE_NULL) unless can_be_null
@@ -53,8 +57,9 @@ module DatabaseConsistency
       end
 
       def column
-        @column ||= regular_column || association_reference_column ||
-                    (raise Errors::MissingField, "column (#{attribute}) is missing in table (#{model.table_name}) but used for presence validation")
+        @column ||= regular_column ||
+                    association_reference_column ||
+                    (raise Errors::MissingField, "column (#{attribute}) is missing in table (#{model.table_name}) but used for presence validation") # rubocop:disable Layout/LineLength
       end
 
       def regular_column

data/lib/database_consistency/configuration.rb

@@ -11,7 +11,7 @@ module DatabaseConsistency
       @configuration = Array(filepaths).each_with_object({}) do |filepath, result|
         content =
           if filepath && File.exist?(filepath)
-            data = YAML.load_file(filepath)
+            data = load_yaml_config_file(filepath)
             data.is_a?(Hash) ? data : {}
           else
             {}
@@ -53,6 +53,14 @@ module DatabaseConsistency
 
     attr_reader :configuration
 
+    def load_yaml_config_file(filepath)
+      if YAML.respond_to?(:safe_load_file)
+        YAML.safe_load_file(filepath, aliases: true)
+      else
+        YAML.load_file(filepath)
+      end
+    end
+
     def combine_configs!(config, new_config)
       config.merge!(new_config) do |_key, val, new_val|
         if val.is_a?(Hash) && new_val.is_a?(Hash)

data/lib/database_consistency/databases/types/base.rb

@@ -7,6 +7,11 @@ module DatabaseConsistency
       class Base
         attr_reader :type
 
+        COVERED_TYPES = {
+          'bigint' => %w[integer bigint],
+          'integer' => %w[integer smallint]
+        }.freeze
+
         # @param [String] type
         def initialize(type)
           @type = type
@@ -16,6 +21,13 @@ module DatabaseConsistency
         def convert
           type
         end
+
+        # @param [DatabaseConsistency::Databases::Types::Base]
+        #
+        # @return [Boolean]
+        def cover?(other_type)
+          (COVERED_TYPES[convert] || [convert]).include?(other_type.convert)
+        end
       end
     end
   end

data/lib/database_consistency/databases/types/sqlite.rb

@@ -7,9 +7,10 @@ module DatabaseConsistency
       class Sqlite < Base
         TYPES = {
           'bigserial' => 'bigint',
-          'bigint' => 'bigint',
           'serial' => 'integer',
-          'integer' => 'integer'
+          'integer(8)' => 'bigint',
+          'integer(4)' => 'integer',
+          'integer(2)' => 'smallint'
         }.freeze
 
         # @return [String]

data/lib/database_consistency/helper.rb

@@ -5,6 +5,22 @@ module DatabaseConsistency
   module Helper
     module_function
 
+    def adapter
+      if ActiveRecord::Base.respond_to?(:connection_config)
+        ActiveRecord::Base.connection_config[:adapter]
+      else
+        ActiveRecord::Base.connection_db_config.configuration_hash[:adapter]
+      end
+    end
+
+    def connection_config(klass)
+      if klass.respond_to?(:connection_config)
+        klass.connection_config
+      else
+        klass.connection_db_config.configuration_hash
+      end
+    end
+
     # Returns list of models to check
     def models
       ActiveRecord::Base.descendants.delete_if(&:abstract_class?).delete_if do |klass|

data/lib/database_consistency/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: database_consistency
 version: !ruby/object:Gem::Version
-  version: 1.1.7
+  version: 1.1.12
 platform: ruby
 authors:
 - Evgeniy Demin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-08 00:00:00.000000000 Z
+date: 2022-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -56,14 +56,14 @@ dependencies:
   name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.2'
 - !ruby/object:Gem::Dependency
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -185,7 +199,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: Provide an easy way to check the consistency of the database constraints