database_consistency 1.1.3 → 1.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e4c24aeb235c8283ce761d7b4d1e3511246eae28c761a55b4f8ef180a090b22
-  data.tar.gz: d8e3b783eae3e68e88126c7f9d77de062748201652ec46492522eda6af0722bf
+  metadata.gz: 2a742a08f374228e004b155fef15ec5ddaa23404c5aacf42b462eb2cb82ba09a
+  data.tar.gz: 8359e199cdbb89fc9d4b8700728bbef938d2d90a1474e4c2400c2aaa6d31f28f
 SHA512:
-  metadata.gz: 005c1fa13f5aab3d833c9fd0690907f5df81a0d34ee2dcb5ea19ace51ed41f1438c803d56b95d3573eaa0938b8d9295a04dd5e2dafb6a6ab6ca48c6fcba3af4e
-  data.tar.gz: fab16372c3782df28f84aac35b997c31ccbb68d3be8ee0b8442e09061c8a85797da584153fc3de151ff1761227348b17041302260daede249b3b10753a1d610b
+  metadata.gz: 962c814731ed2c85427e4b3e765df897c8cd8574f6075e3566e65b72af5effa370a14593019748ff9833a9658a0e55841219acdf3fe9caf212aa9db4bc426df3
+  data.tar.gz: df3aab9a1b6b5d5b2a815ad237b76ff3ffe127cd7921050c09a57e5f53e08087344ad5777224a603c52978382f6568c0c8a19c16038863cb759cac147bb7f9be

data/bin/database_consistency

@@ -1,27 +1,52 @@
 #!/usr/bin/env ruby
 
+require_relative '../lib/database_consistency/configuration'
+
+default_config = DatabaseConsistency::Configuration::DEFAULT_PATH
+
 if ARGV.include?('install')
-  require_relative '../lib/database_consistency/configuration'
-  config_filename = DatabaseConsistency::Configuration::CONFIGURATION_PATH
-  file_exists = File.exists?(config_filename)
+  require 'pathname'
+
+  file_exists = File.exists?(default_config)
   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"
+  if file_exists && File.foreach(default_config).grep(Regexp.new(rules.lines.first.chomp)).any?
+    puts "#{default_config} is already present"
   else
-    File.open(config_filename, 'a') do |file|
+    File.open(default_config, 'a') do |file|
       file << "\n" * 2 if file_exists
       file << rules
     end
-    puts "#{config_filename} #{file_exists ? 'updated' : 'added'}"
+    puts "#{default_config} #{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
+
+require 'optparse'
+
+config = [default_config]
+opt_parser = OptionParser.new do |opts|
+  opts.banner = <<-DESC
+  Usage: database_consistency install - run installation
+         database_consistency [options]
+  DESC
+
+  opts.on('-cFILE', '--config=FILE', 'Use additional configuration file') do |f|
+    config << f
+  end
+
+  opts.on('-h', '--help', 'Prints this help') do
+    puts opts
+    exit
   end
 end
 
+opt_parser.parse!
+
+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
+
 # Load Rails project
 begin
   require File.join(base_dir, 'config', 'boot')
@@ -41,5 +66,5 @@ $LOAD_PATH.unshift(File.expand_path('lib', __dir__))
 require 'database_consistency'
 
 # Process checks
-code = DatabaseConsistency.run
+code = DatabaseConsistency.run(config)
 exit code

data/lib/database_consistency/checkers/{validator_checkers/belongs_to_presence_checker.rb → association_checkers/foreign_key_checker.rb}

@@ -2,18 +2,23 @@
 
 module DatabaseConsistency
   module Checkers
-    # This class checks if required +belongs_to+ has foreign key constraint
-    class BelongsToPresenceChecker < ValidatorChecker
-      MISSING_FOREIGN_KEY = 'model should have proper foreign key in the database'
+    # This class checks if non polymorphic +belongs_to+ association has foreign key constraint
+    class ForeignKeyChecker < AssociationChecker
+      MISSING_FOREIGN_KEY = 'should have foreign key in the database'
 
       private
 
       # We skip check when:
-      #  - validator is a not a presence validator
-      #  - there is no belongs_to association with given name
-      #  - belongs_to association is polymorphic
+      #  - association isn't belongs_to association
+      #  - association is polymorphic
       def preconditions
-        validator.kind == :presence && association && association.belongs_to? && !association.polymorphic?
+        supported? && association.belongs_to? && !association.polymorphic?
+      end
+
+      def supported?
+        return false if ActiveRecord::VERSION::MAJOR < 5 && ActiveRecord::Base.connection_config[:adapter] == 'sqlite3'
+
+        true
       end
 
       # Table of possible statuses
@@ -28,10 +33,6 @@ module DatabaseConsistency
           report_template(:fail, MISSING_FOREIGN_KEY)
         end
       end
-
-      def association
-        @association ||= model.reflect_on_association(attribute)
-      end
     end
   end
 end

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

@@ -42,6 +42,8 @@ module DatabaseConsistency
         else
           report_template(:fail, render_text)
         end
+      rescue Errors::MissingField => e
+        report_template(:fail, e.message)
       end
 
       # @return [String]
@@ -101,8 +103,8 @@ module DatabaseConsistency
 
       # @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."
+        "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

data/lib/database_consistency/checkers/column_checkers/null_constraint_checker.rb

@@ -6,6 +6,8 @@ module DatabaseConsistency
     class NullConstraintChecker < ColumnChecker
       # Message templates
       VALIDATOR_MISSING = 'column is required in the database but do not have presence validator'
+      ASSOCIATION_VALIDATOR_MISSING = 'column is required in the database but do '\
+                                      'not have presence validator for association (%a_n)'
 
       private
 
@@ -26,21 +28,23 @@ module DatabaseConsistency
       # | missing    | fail   |
       #
       # We consider PresenceValidation, InclusionValidation, ExclusionValidation, NumericalityValidator with nil,
-      # or BelongsTo association using this column
+      # or required BelongsTo association using this column
       def check
         if valid?
           report_template(:ok)
+        elsif belongs_to_association
+          report_template(:fail, ASSOCIATION_VALIDATOR_MISSING.gsub('%a_n', belongs_to_association.name.to_s))
         else
           report_template(:fail, VALIDATOR_MISSING)
         end
       end
 
       def valid?
-        validator?(ActiveModel::Validations::PresenceValidator) ||
-          validator?(ActiveModel::Validations::InclusionValidator) ||
+        validator?(:presence, column.name) ||
+          validator?(:inclusion, column.name) ||
           numericality_validator_without_allow_nil? ||
           nil_exclusion_validator? ||
-          belongs_to_association?
+          (belongs_to_association && validator?(:presence, belongs_to_association.name))
       end
 
       def primary_field?
@@ -52,28 +56,30 @@ module DatabaseConsistency
       end
 
       def nil_exclusion_validator?
-        model.validators.grep(ActiveModel::Validations::ExclusionValidator).any? do |validator|
-          Helper.check_inclusion?(validator.attributes, column.name) &&
+        model.validators.any? do |validator|
+          validator.kind == :exclusion &&
+            Helper.check_inclusion?(validator.attributes, column.name) &&
             validator.options[:in].include?(nil)
         end
       end
 
       def numericality_validator_without_allow_nil?
-        model.validators.grep(ActiveModel::Validations::NumericalityValidator).any? do |validator|
-          Helper.check_inclusion?(validator.attributes, column.name) &&
+        model.validators.any? do |validator|
+          validator.kind == :numericality &&
+            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)
+      def validator?(kind, attribute)
+        model.validators.any? do |validator|
+          validator.kind == kind && Helper.check_inclusion?(validator.attributes, attribute)
         end
       end
 
-      def belongs_to_association?
-        model.reflect_on_all_associations.grep(ActiveRecord::Reflection::BelongsToReflection).any? do |r|
-          Helper.check_inclusion?([r.foreign_key, r.foreign_type], column.name)
+      def belongs_to_association
+        @belongs_to_association ||= model.reflect_on_all_associations.find do |r|
+          r.belongs_to? && Helper.check_inclusion?([r.foreign_key, r.foreign_type], column.name)
         end
       end
     end

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

@@ -29,8 +29,18 @@ module DatabaseConsistency
       # | all missing                     | required | ok     |
       # | all missing                     | optional | fail   |
       def check
+        report_message
+      rescue Errors::MissingField => e
+        report_template(:fail, e.message)
+      end
+
+      def has_weak_option?
+        validators.all? { |validator| validator.options.slice(*WEAK_OPTIONS).any? }
+      end
+
+      def report_message
         can_be_null = column.null
-        has_weak_option = validators.all? { |validator| validator.options.slice(*WEAK_OPTIONS).any? }
+        has_weak_option = has_weak_option?
 
         return report_template(:ok) if can_be_null == has_weak_option
         return report_template(:fail, POSSIBLE_NULL) unless can_be_null
@@ -44,7 +54,7 @@ module DatabaseConsistency
 
       def column
         @column ||= regular_column || association_reference_column ||
-                    (raise Errors::MissingField, "Missing column in #{model.table_name} for #{attribute}")
+                    (raise Errors::MissingField, "column (#{attribute}) is missing in table (#{model.table_name}) but used for presence validation")
       end
 
       def regular_column

data/lib/database_consistency/configuration.rb

@@ -5,15 +5,20 @@ require 'yaml'
 module DatabaseConsistency
   # The class to access configuration options
   class Configuration
-    CONFIGURATION_PATH = '.database_consistency.yml'
-
-    def initialize(filepath = CONFIGURATION_PATH)
-      @configuration = if filepath && File.exist?(filepath)
-                         data = YAML.load_file(filepath)
-                         data.is_a?(Hash) ? data : {}
-                       else
-                         {}
-                       end
+    DEFAULT_PATH = '.database_consistency.yml'
+
+    def initialize(filepaths = DEFAULT_PATH)
+      @configuration = Array(filepaths).each_with_object({}) do |filepath, result|
+        content =
+          if filepath && File.exist?(filepath)
+            data = YAML.load_file(filepath)
+            data.is_a?(Hash) ? data : {}
+          else
+            {}
+          end
+
+        combine_configs!(result, content)
+      end
     end
 
     def debug?
@@ -48,6 +53,16 @@ module DatabaseConsistency
 
     attr_reader :configuration
 
+    def combine_configs!(config, new_config)
+      config.merge!(new_config) do |_key, val, new_val|
+        if val.is_a?(Hash) && new_val.is_a?(Hash)
+          combine_configs!(val, new_val)
+        else
+          new_val
+        end
+      end
+    end
+
     def settings
       @settings ||= configuration['DatabaseConsistencySettings']
     end

data/lib/database_consistency/processors/associations_processor.rb

@@ -6,6 +6,7 @@ module DatabaseConsistency
     class AssociationsProcessor < BaseProcessor
       CHECKERS = [
         Checkers::MissingIndexChecker,
+        Checkers::ForeignKeyChecker,
         Checkers::ForeignKeyTypeChecker
       ].freeze
 

data/lib/database_consistency/processors/validators_processor.rb

@@ -5,7 +5,6 @@ module DatabaseConsistency
     # The class to process validators
     class ValidatorsProcessor < BaseProcessor
       CHECKERS = [
-        Checkers::BelongsToPresenceChecker,
         Checkers::MissingUniqueIndexChecker
       ].freeze
 

data/lib/database_consistency/version.rb

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

data/lib/database_consistency.rb

@@ -19,6 +19,7 @@ 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_checker'
 require 'database_consistency/checkers/association_checkers/foreign_key_type_checker'
 
 require 'database_consistency/checkers/column_checkers/column_checker'
@@ -27,7 +28,6 @@ require 'database_consistency/checkers/column_checkers/length_constraint_checker
 require 'database_consistency/checkers/column_checkers/primary_key_type_checker'
 
 require 'database_consistency/checkers/validator_checkers/validator_checker'
-require 'database_consistency/checkers/validator_checkers/belongs_to_presence_checker'
 require 'database_consistency/checkers/validator_checkers/missing_unique_index_checker'
 
 require 'database_consistency/checkers/validators_fraction_checkers/validators_fraction_checker'
@@ -48,8 +48,8 @@ require 'database_consistency/processors/indexes_processor'
 # The root module
 module DatabaseConsistency
   class << self
-    def run
-      configuration = Configuration.new
+    def run(*args)
+      configuration = Configuration.new(*args)
       reports = Processors.reports(configuration)
 
       Writers::SimpleWriter.write(

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: database_consistency
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.1.7
 platform: ruby
 authors:
 - Evgeniy Demin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-25 00:00:00.000000000 Z
+date: 2021-12-08 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_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
@@ -144,7 +145,6 @@ files:
 - lib/database_consistency/checkers/index_checkers/redundant_index_checker.rb
 - lib/database_consistency/checkers/index_checkers/redundant_unique_index_checker.rb
 - lib/database_consistency/checkers/index_checkers/unique_index_checker.rb
-- lib/database_consistency/checkers/validator_checkers/belongs_to_presence_checker.rb
 - lib/database_consistency/checkers/validator_checkers/missing_unique_index_checker.rb
 - lib/database_consistency/checkers/validator_checkers/validator_checker.rb
 - lib/database_consistency/checkers/validators_fraction_checkers/column_presence_checker.rb