database_consistency 0.8.3 → 0.8.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5015849cbfceb5d46a68ab0c3f9ba0e620fffbf013c16af563d3aa8fd16b140f
-  data.tar.gz: dd379822c590457db98fd9f23fe99f19868063cf994e804eec11fe61b7311105
+  metadata.gz: 406fd80b86af26702bba071b8dabe3d8f238923bd7ef6d04776b014d2c5c5575
+  data.tar.gz: b30e6bee8c79233090fb8a94557217a6e2fc72e618b577b858083bf0cd3ba71e
 SHA512:
-  metadata.gz: 3ec317d549f0852e6396db14f7263904448a3dda2c2515f83a174946a9d8138163f909b078a235a41c5d36daa01bbc38cd61c03f23921d3ad8704c7742e7fcec
-  data.tar.gz: 8c41bdf53040283417a3d616e9cf9b13a34138ba17edf65b84df1506e630e758d88995a618ea2b111a8d45884c49bf8b4e5f9b2c38e16fbfdd379328260aa0f1
+  metadata.gz: 72147fa9f0eccd7ac75216fe673757541048b143ea31fbab435a83e7cb10f62d3e45ae19a5e0c8e609515d3033fa7d868deba863fd8d7ba152f50d254fb3f534
+  data.tar.gz: 6c172f7b74de5face1e235103a2821d41be08f282a840b756caf73f24285e8cf6f7e1f5ecf5e40f26160a8036c947c335edc5338ef3ca274a989d9353220f04d

data/lib/database_consistency.rb

@@ -6,14 +6,20 @@ 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'
 
+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,128 @@
+# 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
+
+      # 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.macro != :has_and_belongs_to_many
+      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 ||= (
+          if belongs_to_association?
+            association.foreign_key
+          else
+            association.active_record_primary_key
+          end
+        ).to_s
+      end
+
+      # @return [String]
+      def associated_key
+        @associated_key ||= (
+          if belongs_to_association?
+            association.active_record_primary_key
+          else
+            association.foreign_key
+          end
+        ).to_s
+      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 } ||
+          (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
+      #
+      # @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 belongs_to_association?
+        association.macro == :belongs_to
+      end
+    end
+  end
+end

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/column_checkers/length_constraint_checker.rb

@@ -21,8 +21,14 @@ module DatabaseConsistency
       # We skip check when:
       #  - column hasn't limit constraint
       #  - column insn't string nor text
+      #  - column is array (PostgreSQL only)
       def preconditions
-        !column.limit.nil? && %i[string text].include?(column.type)
+        !column.limit.nil? && %i[string text].include?(column.type) && !postgresql_array?
+      end
+
+      # @return [Boolean] true if it is an array (PostgreSQL only)
+      def postgresql_array?
+        column.respond_to?(:array) && column.array
       end
 
       # Table of possible statuses

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] || type
+        end
+      end
+    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
 

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.3'
+  VERSION = '0.8.8'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: database_consistency
 version: !ruby/object:Gem::Version
-  version: 0.8.3
+  version: 0.8.8
 platform: ruby
 authors:
 - Evgeniy Demin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-24 00:00:00.000000000 Z
+date: 2020-09-24 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,10 @@ 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/errors.rb
 - lib/database_consistency/helper.rb
 - lib/database_consistency/processors/associations_processor.rb
 - lib/database_consistency/processors/base_processor.rb
@@ -175,7 +180,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