database_consistency 0.8.1 → 0.8.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20658faa1cdd6ae16c25dd7a9b2b85b608f81e2da8ffeb74f8f692ad5c8eb6cb
-  data.tar.gz: 7a6c555f10de5253af9744eea4ada2c95525dd127d081e939ffa6ad6c4923bab
+  metadata.gz: e4c8440238a874ddd2ae11563b8b034c64f94e467426ef85afcd8befdf9a55c2
+  data.tar.gz: 7e7275bf7029cf03a0a9d3e35975d1a927a7317d323c2c7db00eb22306f67aca
 SHA512:
-  metadata.gz: 95ff5510806f67c8e612c488c608f2685e1abebbb3ecba455e706db34a104ab9c1135cac0193692884a7cb9f61301c91e0a27ea07d61eb08a3b89ca3dd5d952d
-  data.tar.gz: 75a78627604fec92c8fd3703c70fa35e125139e188adf1d8592a480fcef44a50a6b4f670f2eaae139dd07c03ca397745b437d44fcdc35f96ea44b41aaaab6b7d
+  metadata.gz: dcd5d6ee89a07990da47ad72231aa5884ee8209f071f21a4ab9ae3521f5ae2bd85167b2b31d32052bff081cd240f5965b4eef3f814ab8ce1ee83ab480d9ccaff
+  data.tar.gz: 2ff692d1618d7ef53500ccf3f88bb361c856d62ea7f577ce66a1c18122af0f05c1c55d5023b3313c4a17f55dbd20d14a0193d6116575e1b551651ad5549829ff

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,105 @@
+# 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 ||= 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.to_s }
+      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/column_checkers/null_constraint_checker.rb

@@ -25,7 +25,7 @@ module DatabaseConsistency
       # | provided   | ok     |
       # | missing    | fail   |
       #
-      # We consider PresenceValidation, InclusionValidation, ExclusionValidation with nil,
+      # We consider PresenceValidation, InclusionValidation, ExclusionValidation, NumericalityValidator with nil,
       # or BelongsTo association using this column
       def check
         if valid?
@@ -38,6 +38,7 @@ module DatabaseConsistency
       def valid?
         validator?(ActiveModel::Validations::PresenceValidator) ||
           validator?(ActiveModel::Validations::InclusionValidator) ||
+          numericality_validator_without_allow_nil? ||
           nil_exclusion_validator? ||
           belongs_to_association?
       end
@@ -57,6 +58,13 @@ module DatabaseConsistency
         end
       end
 
+      def numericality_validator_without_allow_nil?
+        model.validators.grep(ActiveModel::Validations::NumericalityValidator).any? do |validator|
+          Helper.check_inclusion?(validator.attributes, column.name) &&
+            !validator.options[:allow_nil]
+        end
+      end
+
       def validator?(validator_class)
         model.validators.grep(validator_class).any? do |validator|
           Helper.check_inclusion?(validator.attributes, column.name)

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.1'
+  VERSION = '0.8.6'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: database_consistency
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.8.6
 platform: ruby
 authors:
 - Evgeniy Demin
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-03 00:00:00.000000000 Z
+date: 2020-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -122,7 +122,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
-description: 
+description:
 email:
 - lawliet.djez@gmail.com
 executables:
@@ -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
@@ -160,7 +164,7 @@ homepage: https://github.com/djezzzl/database_consistency
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -175,9 +179,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.9
-signing_key: 
+rubygems_version: 3.0.8
+signing_key:
 specification_version: 4
 summary: Provide an easy way to check the consistency of the database constraints
   with the application validations.