database_consistency 0.8.2 → 0.8.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96d59f04ee02179f11d92477feb260aaa444c9b923ecbc142aa2b69ca12b3808
-  data.tar.gz: 6c79bf6d628c470a45976047ffcc608bddf07ff610f802a04542462b36ae4421
+  metadata.gz: b1dff50eb6317680dc36fc0260a90c4071bfada212d1124169437123b93d1f65
+  data.tar.gz: 1fcd504bfaed4674386b3af7d53d9d2d2bd2b1f28d2fb65cd3ae1c1c0f1f1eae
 SHA512:
-  metadata.gz: 2c563868a70b3dd6cd1fe7d3f62481e6dee156c75a42a22f7e6ee43ce41d5ad08d6742d099c0a145a2b331726282ec2a71234ab1194361af655f18120e9c1b48
-  data.tar.gz: 4ccdf6f7647b4aac78a7378a15d7796f5ed35997f7f59ec77176ebbc55019faf3a0581852e52d529d7c11aa8d8f59a495295445ed39e0a81a2ec0b6a41f638e5
+  metadata.gz: 22aaae1a55a6c7bc6dd3027852cf8e8b0e94e970c06ac445455e1c5abe787be2a273ed9d7f2b7e9c13b5455f827b1bec82d02eb117eed2599c8e90ebd12719ab
+  data.tar.gz: e9203782f9364aa086c1ee20e03d6497c92ce17d5e5ece293390549ce4e4f3dbeb0ff07980a9be5548558d59527c4e2a5d0c3928b67991ca27d99fa5f9908dfb

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,117 @@
+# 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 has `through` option
+      #  - associated class doesn't exist
+      def preconditions
+        !association.polymorphic? && association.through_reflection.nil? && 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 ||= (
+          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 }
+      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/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/checkers/validator_checkers/missing_unique_index_checker.rb

@@ -48,7 +48,13 @@ module DatabaseConsistency
       end
 
       def index_columns
-        @index_columns ||= ([wrapped_attribute_name] + Array.wrap(validator.options[:scope])).map(&:to_s)
+        @index_columns ||= ([wrapped_attribute_name] + scope_columns).map(&:to_s)
+      end
+
+      def scope_columns
+        @scope_columns ||= Array.wrap(validator.options[:scope]).map do |scope_item|
+          model._reflect_on_association(scope_item)&.foreign_key || scope_item
+        end
       end
 
       def sorted_index_columns

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

@@ -4,7 +4,7 @@ module DatabaseConsistency
   module Checkers
     # This class checks if presence validator has non-null constraint in the database
     class ColumnPresenceChecker < ValidatorsFractionChecker
-      WEAK_OPTIONS = %i[allow_nil allow_blank if unless].freeze
+      WEAK_OPTIONS = %i[allow_nil allow_blank if unless on].freeze
       # Message templates
       CONSTRAINT_MISSING = 'column should be required in the database'
       POSSIBLE_NULL = 'column is required but there is possible null value insert'

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/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.2'
+  VERSION = '0.8.7'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: database_consistency
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.8.7
 platform: ruby
 authors:
 - Evgeniy Demin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-20 00:00:00.000000000 Z
+date: 2020-09-23 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