database_consistency 0.8.0 → 0.8.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f029e8151f93b3824ea0ba0b7cb0eff4d2a1d22dc76597da6169957bffb7611
-  data.tar.gz: b05b3a118134910eabdbf26a936185ad2cfc45df3417b7d8fad3b0f03d505466
+  metadata.gz: ed9a2103f6e588628f52a00ddd933b0dc899fac0d6e8752a3bf1111a3894fb17
+  data.tar.gz: d8bf6a551c55fc3e4a33d837354f1b3d777c6171b48aa84d2cce5bbba478e0d5
 SHA512:
-  metadata.gz: '05827f5dbbbb745ff76721881eb78669492a3fbadc3949362076b50736f61f0fa1a6c1750780098a12e6fb61389a8e75deb05603e7a3a4c6d7269f3bad3ba78e'
-  data.tar.gz: 57796525845caf0652456e5141ec464146b3fd88ddb44ad51247b2a497b0afd108585edea38489c21da59055ffd5045f11e713e64a9e2107fdbe5b213d4d783f
+  metadata.gz: a1c59e4de257fdaa7aae63725abcc82f7da1f4ea98f51fc804162b8c5488021c3c665f7e7298b135eaddd50560415b563f0cd608fdaaee81519e44af74966bb2
+  data.tar.gz: 516f5102afb3234eb88d8a8039b584c9210b33d78401290423032cbd017df5218aa6a455ae5faeffb54dd9bad7ea82a17a40f1729255c7ea2ed988924bad3ea9

data/bin/database_consistency

@@ -1,9 +1,25 @@
 #!/usr/bin/env ruby
 
-base_dir = File.join(Dir.pwd, ARGV.first.to_s)
-
-unless File.realpath(base_dir).start_with?(Dir.pwd)
-  puts "\nWarning! You are going out of current directory, ruby version may be wrong and some gems may be missing.\n"
+if ARGV.include?('install')
+  require_relative '../lib/database_consistency/configuration'
+  config_filename = DatabaseConsistency::Configuration::CONFIGURATION_PATH
+  file_exists = File.exists?(config_filename)
+  rules = Pathname.new(__FILE__).dirname.join('..', 'lib', 'database_consistency', 'templates', 'rails_defaults.yml').read
+  if file_exists && File.foreach(config_filename).grep(Regexp.new(rules.lines.first.chomp)).any?
+    puts "#{config_filename} is already present"
+  else
+    File.open(config_filename, 'a') do |file|
+      file << "\n" * 2 if file_exists
+      file << rules
+    end
+    puts "#{config_filename} #{file_exists ? 'updated' : 'added'}"
+  end
+  exit 0
+else
+  base_dir = File.join(Dir.pwd, ARGV.first.to_s)
+  unless File.realpath(base_dir).start_with?(Dir.pwd)
+    puts "\nWarning! You are going out of current directory, ruby version may be wrong and some gems may be missing.\n"
+  end
 end
 
 # Load Rails project

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/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]
+        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/templates/rails_defaults.yml

@@ -0,0 +1,7 @@
+# Ignore false positive from Rails' ActionText and ActiveStorage
+ActionText::RichText:
+  enabled: false
+ActiveStorage::Attachment:
+  enabled: false
+ActiveStorage::Blob:
+  enabled: false

data/lib/database_consistency/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DatabaseConsistency
-  VERSION = '0.8.0'
+  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.0
+  version: 0.8.5
 platform: ruby
 authors:
 - Evgeniy Demin
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-02 00:00:00.000000000 Z
+date: 2020-09-21 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
@@ -152,6 +156,7 @@ files:
 - lib/database_consistency/processors/validators_fractions_processor.rb
 - lib/database_consistency/processors/validators_processor.rb
 - lib/database_consistency/rescue_error.rb
+- lib/database_consistency/templates/rails_defaults.yml
 - lib/database_consistency/version.rb
 - lib/database_consistency/writers/base_writer.rb
 - lib/database_consistency/writers/simple_writer.rb
@@ -159,7 +164,7 @@ homepage: https://github.com/djezzzl/database_consistency
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -174,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.