database_consistency 1.1.5 → 1.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c43909523b8cb7b8369f55dc151bf84e32752276907a249ada7606edffbbdca
-  data.tar.gz: b2a27e403ab36224ab3f432f4bd4d8021e75306c000b8fd20c01ea2cd868d795
+  metadata.gz: 1b191ca6be5af749e9c3e7bd634696e5ecc648972f5b882954990bcc9e13dde2
+  data.tar.gz: 460e7edbac351faf21032e9d71c768d0e98b12ddafad792516bc5f4158122525
 SHA512:
-  metadata.gz: a7dac1b50e3e621c62f5bb00c96ef130bee3a862d70c3078dc29dd2538ca5f6a66f6772aa449ffed3771354a0514ab21e2b58df4b125dd62415f163b936667ee
-  data.tar.gz: f71af9349ed08f62b295c47cb32dc11a591a59cd44784e8f5ba00390c8011ccbc8597dc6cd63a5db4eee965f1ae0b758c8fa7487503c0f5469c27e492f7bfcd1
+  metadata.gz: 4b1da4a7207245abc904aa28fcbbf2d8fe7c15683f86ad55557ba10b6d7699103404c42ed33a6fda82a413e4a6ed73681579dfd9512c7480d60a5f3da7d9d335
+  data.tar.gz: a4a13d8527677783f144448bfbe892d282086fffbe6dd04121aa50052d435c2d370eee32ee7c378047a2cf47817fcee4b74b9e7d0f9ed4b652d80431948196cc

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/association_checkers/foreign_key_checker.rb

@@ -16,7 +16,7 @@ module DatabaseConsistency
       end
 
       def supported?
-        return false if ActiveRecord::VERSION::MAJOR < 5 && ActiveRecord::Base.connection_config[:adapter] == 'sqlite3'
+        return false if ActiveRecord::VERSION::MAJOR < 5 && Helper.adapter == 'sqlite3'
 
         true
       end

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

@@ -2,18 +2,9 @@
 
 module DatabaseConsistency
   module Checkers
-    # This class checks if association's foreign key type is the same as associated model's primary key
+    # This class checks if association's foreign key type covers associated model's primary key (same or bigger)
     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
+      INCONSISTENT_TYPE = "foreign key (%a_f) with type (%a_t) doesn't cover primary key (%b_f) with type (%b_t)"
 
       private
 
@@ -32,16 +23,18 @@ module DatabaseConsistency
       end
 
       # Table of possible statuses
-      # | type         | status |
-      # | ------------ | ------ |
-      # | consistent   | ok     |
-      # | inconsistent | fail   |
+      # | type          | status |
+      # | ------------- | ------ |
+      # | covers        | ok     |
+      # | doesn't cover | fail   |
       def check
-        if converted_type(base_column) == converted_type(associated_column)
+        if converted_type(associated_column).cover?(converted_type(primary_column))
           report_template(:ok)
         else
           report_template(:fail, render_text)
         end
+      rescue Errors::MissingField => e
+        report_template(:fail, e.message)
       end
 
       # @return [String]
@@ -49,40 +42,40 @@ module DatabaseConsistency
         INCONSISTENT_TYPE
           .gsub('%a_t', type(associated_column))
           .gsub('%a_f', associated_key)
-          .gsub('%b_t', type(base_column))
-          .gsub('%b_f', base_key)
+          .gsub('%b_t', type(primary_column))
+          .gsub('%b_f', primary_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
+      def primary_key
+        @primary_key ||= if belongs_to_association?
+                           association.association_primary_key
+                         else
+                           association.active_record_primary_key
+                         end.to_s
       end
 
       # @return [String]
       def associated_key
-        @associated_key ||= (
-          if belongs_to_association?
-            association.association_primary_key
-          else
-            association.foreign_key
-          end
-        ).to_s
+        @associated_key ||= association.foreign_key.to_s
       end
 
       # @return [ActiveRecord::ConnectionAdapters::Column]
-      def base_column
-        @base_column ||= column(association.active_record, base_key)
+      def primary_column
+        @primary_column ||= if belongs_to_association?
+                              column(association.klass, primary_key)
+                            else
+                              column(association.active_record, primary_key)
+                            end
       end
 
       # @return [ActiveRecord::ConnectionAdapters::Column]
       def associated_column
-        @associated_column ||= column(association.klass, associated_key)
+        @associated_column ||= if belongs_to_association?
+                                 column(association.active_record, associated_key)
+                               else
+                                 column(association.klass, associated_key)
+                               end
       end
 
       # @return [DatabaseConsistency::Databases::Factory]
@@ -101,8 +94,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
@@ -114,9 +107,9 @@ module DatabaseConsistency
 
       # @param [ActiveRecord::ConnectionAdapters::Column]
       #
-      # @return [String]
+      # @return [DatabaseConsistency::Databases::Types::Base]
       def converted_type(column)
-        database_factory.type(type(column)).convert
+        database_factory.type(type(column))
       end
 
       # @return [Boolean]

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 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 = weak_option?
 
         return report_template(:ok) if can_be_null == has_weak_option
         return report_template(:fail, POSSIBLE_NULL) unless can_be_null
@@ -43,8 +53,9 @@ module DatabaseConsistency
       end
 
       def column
-        @column ||= regular_column || association_reference_column ||
-                    (raise Errors::MissingField, "Missing column in #{model.table_name} for #{attribute}")
+        @column ||= regular_column ||
+                    association_reference_column ||
+                    (raise Errors::MissingField, "column (#{attribute}) is missing in table (#{model.table_name}) but used for presence validation") # rubocop:disable Layout/LineLength
       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 = load_yaml_config_file(filepath)
+            data.is_a?(Hash) ? data : {}
+          else
+            {}
+          end
+
+        combine_configs!(result, content)
+      end
     end
 
     def debug?
@@ -48,6 +53,24 @@ module DatabaseConsistency
 
     attr_reader :configuration
 
+    def load_yaml_config_file(filepath)
+      if YAML.respond_to?(:safe_load_file)
+        YAML.safe_load_file(filepath, aliases: true)
+      else
+        YAML.load_file(filepath)
+      end
+    end
+
+    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/databases/types/base.rb

@@ -7,6 +7,11 @@ module DatabaseConsistency
       class Base
         attr_reader :type
 
+        COVERED_TYPES = {
+          'bigint' => %w[integer bigint],
+          'integer' => %w[integer smallint]
+        }.freeze
+
         # @param [String] type
         def initialize(type)
           @type = type
@@ -16,6 +21,13 @@ module DatabaseConsistency
         def convert
           type
         end
+
+        # @param [DatabaseConsistency::Databases::Types::Base]
+        #
+        # @return [Boolean]
+        def cover?(other_type)
+          (COVERED_TYPES[convert] || [convert]).include?(other_type.convert)
+        end
       end
     end
   end

data/lib/database_consistency/databases/types/sqlite.rb

@@ -7,9 +7,10 @@ module DatabaseConsistency
       class Sqlite < Base
         TYPES = {
           'bigserial' => 'bigint',
-          'bigint' => 'bigint',
           'serial' => 'integer',
-          'integer' => 'integer'
+          'integer(8)' => 'bigint',
+          'integer(4)' => 'integer',
+          'integer(2)' => 'smallint'
         }.freeze
 
         # @return [String]

data/lib/database_consistency/helper.rb

@@ -5,6 +5,14 @@ module DatabaseConsistency
   module Helper
     module_function
 
+    def adapter
+      if ActiveRecord::Base.respond_to?(:connection_config)
+        ActiveRecord::Base.connection_config[:adapter]
+      else
+        ActiveRecord::Base.connection_db_config.configuration_hash[:adapter]
+      end
+    end
+
     # Returns list of models to check
     def models
       ActiveRecord::Base.descendants.delete_if(&:abstract_class?).delete_if do |klass|

data/lib/database_consistency/version.rb

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

data/lib/database_consistency.rb

@@ -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.5
+  version: 1.1.10
 platform: ruby
 authors:
 - Evgeniy Demin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-31 00:00:00.000000000 Z
+date: 2022-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -56,14 +56,14 @@ dependencies:
   name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.2'
 - !ruby/object:Gem::Dependency
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -185,7 +199,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: Provide an easy way to check the consistency of the database constraints