database_consistency 0.8.4 → 0.8.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f88361846480fa9257f1a17799b54f60e9e44630b81f3e0612ce9a8bd2ee8ca
-  data.tar.gz: bbe851973d91592ab4156cb12da0dd0a3fc33d429c9c5521e3d4be9fc1c3f380
+  metadata.gz: ed9a2103f6e588628f52a00ddd933b0dc899fac0d6e8752a3bf1111a3894fb17
+  data.tar.gz: d8bf6a551c55fc3e4a33d837354f1b3d777c6171b48aa84d2cce5bbba478e0d5
 SHA512:
-  metadata.gz: 13b9a733d87f4f840afc7e87d284ddea367cf6bbd7bacf10a496dea82d2cc782427eb3bcad4b1926f633dad79f36ccc7afbdc9463c2a68ccde5e07ce76a85019
-  data.tar.gz: fbc37a0a3764eea67df7733d4bebd40a5f1f3ddb1019998de08f6e71610350e4b4bf44f9896ea939de013b3ac5bc0630bbbaae8176189e095fbefde0420aee18
+  metadata.gz: a1c59e4de257fdaa7aae63725abcc82f7da1f4ea98f51fc804162b8c5488021c3c665f7e7298b135eaddd50560415b563f0cd608fdaaee81519e44af74966bb2
+  data.tar.gz: 516f5102afb3234eb88d8a8039b584c9210b33d78401290423032cbd017df5218aa6a455ae5faeffb54dd9bad7ea82a17a40f1729255c7ea2ed988924bad3ea9

data/lib/database_consistency.rb

@@ -10,10 +10,15 @@ require 'database_consistency/rescue_error'
 require 'database_consistency/writers/base_writer'
 require 'database_consistency/writers/simple_writer'
 
+require 'database_consistency/databases/factory'
+require 'database_consistency/databases/types/base'
+require 'database_consistency/databases/types/sqlite'
+
 require 'database_consistency/checkers/base_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_type_checker'
 
 require 'database_consistency/checkers/column_checkers/column_checker'
 require 'database_consistency/checkers/column_checkers/null_constraint_checker'

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

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Checkers
+    # This class checks if association's foreign key type is the same as associated model's primary key
+    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
+
+      private
+
+      def preconditions
+        !association.polymorphic? && association.klass.present?
+      rescue NameError
+        false
+      end
+
+      # Table of possible statuses
+      # | type         | status |
+      # | ------------ | ------ |
+      # | consistent   | ok     |
+      # | inconsistent | fail   |
+      def check
+        if converted_type(base_column) == converted_type(associated_column)
+          report_template(:ok)
+        else
+          report_template(:fail, render_text)
+        end
+      end
+
+      # @return [String]
+      def render_text
+        INCONSISTENT_TYPE
+          .gsub('%a_t', type(associated_column))
+          .gsub('%a_f', associated_key)
+          .gsub('%b_t', type(base_column))
+          .gsub('%b_f', base_key)
+      end
+
+      # @return [String]
+      def base_key
+        @base_key ||= belongs_to_association? ? association.foreign_key : association.active_record_primary_key
+      end
+
+      # @return [String]
+      def associated_key
+        @associated_key ||= belongs_to_association? ? association.active_record_primary_key : association.foreign_key
+      end
+
+      # @return [ActiveRecord::ConnectionAdapters::Column]
+      def base_column
+        @base_column ||= column(association.active_record, base_key)
+      end
+
+      # @return [ActiveRecord::ConnectionAdapters::Column]
+      def associated_column
+        @associated_column ||= column(association.klass, associated_key)
+      end
+
+      # @return [DatabaseConsistency::Databases::Factory]
+      def database_factory
+        @database_factory ||= Databases::Factory.new(association.active_record.connection.adapter_name)
+      end
+
+      # @param [ActiveRecord::Base] model
+      # @param [String] column_name
+      #
+      # @return [ActiveRecord::ConnectionAdapters::Column]
+      def column(model, column_name)
+        model.connection.columns(model.table_name).find { |column| column.name == column_name }
+      end
+
+      # @param [ActiveRecord::ConnectionAdapters::Column] column
+      #
+      # @return [String]
+      def type(column)
+        column.sql_type
+      end
+
+      # @param [ActiveRecord::ConnectionAdapters::Column]
+      #
+      # @return [String]
+      def converted_type(column)
+        database_factory.type(type(column)).convert
+      end
+
+      # @return [Boolean]
+      def supported_type?(column)
+        database_factory.type(type(column)).supported?
+      end
+
+      # @return [Boolean]
+      def belongs_to_association?
+        association.macro == :belongs_to
+      end
+    end
+  end
+end

data/lib/database_consistency/databases/factory.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Databases
+    # Factory for database adapters
+    class Factory
+      attr_reader :adapter
+
+      # @param [String] adapter
+      def initialize(adapter)
+        @adapter = adapter
+      end
+
+      # @return [DatabaseConsistency::Databases::Types::Base]
+      def type(type)
+        sqlite? ? Types::Sqlite.new(type) : Types::Base.new(type)
+      end
+
+      private
+
+      # @return [Boolean]
+      def sqlite?
+        adapter == 'SQLite'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Databases
+    module Types
+      # Base wrapper for database types
+      class Base
+        attr_reader :type
+
+        # @param [String] type
+        def initialize(type)
+          @type = type
+        end
+
+        # @return [String]
+        def convert
+          type
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Databases
+    module Types
+      # Wraps types for SQLite database
+      class Sqlite < Base
+        TYPES = {
+          'bigserial' => 'bigint',
+          'bigint' => 'bigint',
+          'serial' => 'integer',
+          'integer' => 'integer'
+        }.freeze
+
+        # @return [String]
+        def convert
+          TYPES[type]
+        end
+      end
+    end
+  end
+end

data/lib/database_consistency/processors/associations_processor.rb

@@ -5,7 +5,8 @@ module DatabaseConsistency
     # The class to process associations
     class AssociationsProcessor < BaseProcessor
       CHECKERS = [
-        Checkers::MissingIndexChecker
+        Checkers::MissingIndexChecker,
+        Checkers::ForeignKeyTypeChecker
       ].freeze
 
       private

data/lib/database_consistency/rescue_error.rb

@@ -33,7 +33,7 @@ module DatabaseConsistency
     private
 
     def filename
-      "database_consistency_#{Time.now.strftime('%Y_%m_%d_%H_%M_%S')}"
+      @filename ||= "database_consistency_#{Time.now.strftime('%Y_%m_%d_%H_%M_%S')}"
     end
   end
 end

data/lib/database_consistency/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: database_consistency
 version: !ruby/object:Gem::Version
-  version: 0.8.4
+  version: 0.8.5
 platform: ruby
 authors:
 - Evgeniy Demin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-04 00:00:00.000000000 Z
+date: 2020-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -133,6 +133,7 @@ files:
 - bin/database_consistency
 - lib/database_consistency.rb
 - lib/database_consistency/checkers/association_checkers/association_checker.rb
+- lib/database_consistency/checkers/association_checkers/foreign_key_type_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
@@ -145,6 +146,9 @@ files:
 - lib/database_consistency/checkers/validators_fraction_checkers/column_presence_checker.rb
 - lib/database_consistency/checkers/validators_fraction_checkers/validators_fraction_checker.rb
 - lib/database_consistency/configuration.rb
+- lib/database_consistency/databases/factory.rb
+- lib/database_consistency/databases/types/base.rb
+- lib/database_consistency/databases/types/sqlite.rb
 - lib/database_consistency/helper.rb
 - lib/database_consistency/processors/associations_processor.rb
 - lib/database_consistency/processors/base_processor.rb
@@ -175,7 +179,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.8
 signing_key:
 specification_version: 4
 summary: Provide an easy way to check the consistency of the database constraints