database_consistency 1.1.12 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 908211c725197dadbe72f2f7c8f2f47d48a55ed546c57d2f512b9b2978fb325a
-  data.tar.gz: 4b18e433573c598b25906dce98554516f3c54bacbd897b59c8f72c6d9577a53d
+  metadata.gz: f18ab981e7a995312fcefac4aad1673991c0ca74f83e892ed443b55399f73621
+  data.tar.gz: '0284902da44ea88322df42739eb9471212970ff4a2bde3ea91c491a0b3b6a8c6'
 SHA512:
-  metadata.gz: 43ea449cc58c970f99deb81936461d2f267a107934ad93cfb1f73ef0e0a8e46c97d9ba5085a54538828d162ca06638ad35afb907fa51de661df30bad9527cefc
-  data.tar.gz: 799f1975507dababf597ca140655377e90a1480af4422080349027b03ef7ef9dbade4125e95f317ef3d873706e82f1c24991c9c9600a08cb3dca3e6ff2bbc8e0
+  metadata.gz: 3765a63635638981d1a7389ed4d5f4a611d188c08281a13fc2ae5c435e4da8ad09a9a0f49511be596126d75caca322a3a7bd16309d27914adcfcb386a135223a
+  data.tar.gz: 6473f6990528f09bbb90e6e044b0e1c506b9c9586c65f2b76f8efaed68f1cb91d914703e11ba3747ce0663f9999e33065d7d5b0f5dbce44672a3ca33bd3be94f

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

@@ -7,6 +7,7 @@ module DatabaseConsistency
       attr_reader :model, :association
 
       def initialize(model, association)
+        super()
         @model = model
         @association = association
       end

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

@@ -6,6 +6,7 @@ module DatabaseConsistency
     class MissingIndexChecker < AssociationChecker
       # Message templates
       MISSING_INDEX = 'associated model should have proper index in the database'
+      MISSING_UNIQUE_INDEX = 'associated model should have proper unique index in the database'
 
       private
 
@@ -28,6 +29,22 @@ module DatabaseConsistency
       # | persisted    | ok     |
       # | missing      | fail   |
       def check
+        if unique_has_one_association?
+          check_unique_has_one
+        else
+          check_remaining
+        end
+      end
+
+      def check_unique_has_one
+        if unique_index
+          report_template(:ok)
+        else
+          report_template(:fail, MISSING_UNIQUE_INDEX)
+        end
+      end
+
+      def check_remaining
         if index
           report_template(:ok)
         else
@@ -35,9 +52,19 @@ module DatabaseConsistency
         end
       end
 
+      def unique_has_one_association?
+        association.scope.nil? && association.macro == :has_one && !association.options[:as].present?
+      end
+
+      def unique_index
+        @unique_index ||= association.klass.connection.indexes(association.klass.table_name).find do |index|
+          index_keys(index) == association_keys && index.unique
+        end
+      end
+
       def index
         @index ||= association.klass.connection.indexes(association.klass.table_name).find do |index|
-          index_keys(index) == association_keys
+          index_keys(index, limit: association_keys.size) == association_keys
         end
       end
 
@@ -45,10 +72,16 @@ module DatabaseConsistency
         @association_keys ||= [association.foreign_key, association.type].compact.map(&:to_s).sort
       end
 
-      def index_keys(index)
+      def index_keys(index, limit: nil)
         return unless index.columns.is_a?(Array)
 
-        index.columns[0...association_keys.size].sort
+        columns = index.columns
+
+        if limit
+          columns.first(limit).sort
+        else
+          columns
+        end
       end
     end
   end

data/lib/database_consistency/checkers/base_checker.rb

@@ -19,7 +19,7 @@ module DatabaseConsistency
       # @param [Boolean] catch_errors
       #
       # @return [Hash, File, nil]
-      def report(catch_errors = true)
+      def report(catch_errors: true)
         return unless preconditions
 
         @report ||= check

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

@@ -7,6 +7,7 @@ module DatabaseConsistency
       attr_reader :model, :column
 
       def initialize(model, column)
+        super()
         @model = model
         @column = column
       end

data/lib/database_consistency/checkers/index_checkers/index_checker.rb

@@ -7,6 +7,7 @@ module DatabaseConsistency
       attr_reader :model, :index
 
       def initialize(model, index)
+        super()
         @model = model
         @index = index
       end

data/lib/database_consistency/checkers/validator_checkers/validator_checker.rb

@@ -7,6 +7,7 @@ module DatabaseConsistency
       attr_reader :model, :attribute, :validator
 
       def initialize(model, attribute, validator)
+        super()
         @model = model
         @attribute = attribute
         @validator = validator

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

@@ -7,6 +7,7 @@ module DatabaseConsistency
       attr_reader :model, :attribute, :validators
 
       def initialize(model, attribute, validators)
+        super()
         @model = model
         @attribute = attribute
         @validators = validators.select(&method(:filter))

data/lib/database_consistency/configuration.rb

@@ -37,22 +37,30 @@ module DatabaseConsistency
     def enabled?(*path)
       current = configuration
 
+      value = global_enabling
+
       path.each do |key|
         current = current[key.to_s]
-        return true unless current.is_a?(Hash)
+        return value unless current.is_a?(Hash)
 
         next if current['enabled'].nil?
 
-        return false unless current['enabled']
+        value = current['enabled']
       end
 
-      true
+      value
     end
 
     private
 
     attr_reader :configuration
 
+    def global_enabling
+      value = configuration.dig('DatabaseConsistencyCheckers', 'All', 'enabled')
+
+      value.nil? ? true : value
+    end
+
     def load_yaml_config_file(filepath)
       if YAML.respond_to?(:safe_load_file)
         YAML.safe_load_file(filepath, aliases: true)

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

@@ -14,7 +14,7 @@ module DatabaseConsistency
 
         # @param [String] type
         def initialize(type)
-          @type = type
+          @type = type.downcase
         end
 
         # @return [String]

data/lib/database_consistency/helper.rb

@@ -23,8 +23,10 @@ module DatabaseConsistency
 
     # Returns list of models to check
     def models
-      ActiveRecord::Base.descendants.delete_if(&:abstract_class?).delete_if do |klass|
-        !klass.connection.table_exists?(klass.table_name) || klass.name.include?('HABTM_')
+      ActiveRecord::Base.descendants.delete_if(&:abstract_class?).select do |klass|
+        klass.connection.table_exists?(klass.table_name) &&
+          !klass.name.include?('HABTM_') &&
+          project_klass?(klass)
       end
     end
 
@@ -35,6 +37,15 @@ module DatabaseConsistency
       end
     end
 
+    # @param klass [ActiveRecord::Base]
+    #
+    # @return [Boolean]
+    def project_klass?(klass)
+      return true unless Module.respond_to?(:const_source_location) && defined?(Bundler)
+
+      !Module.const_source_location(klass.to_s).first.to_s.include?(Bundler.bundle_path.to_s)
+    end
+
     # @return [Boolean]
     def check_inclusion?(array, element)
       array.include?(element.to_s) || array.include?(element.to_sym)

data/lib/database_consistency/version.rb

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

data/lib/database_consistency/writers/simple_writer.rb

@@ -12,6 +12,12 @@ module DatabaseConsistency
         red: "\e[31m"
       }.freeze
 
+      COLOR_BY_STATUS = {
+        ok: :green,
+        warning: :yellow,
+        fail: :red
+      }.freeze
+
       def write
         results.each do |result|
           next unless write?(result.status)
@@ -31,11 +37,7 @@ module DatabaseConsistency
       end
 
       def status_text(result)
-        color = case result.status
-                when :ok then :green
-                when :warning then :yellow
-                when :fail then :red
-                end
+        color = COLOR_BY_STATUS[result.status]
 
         colorize(result.status, color)
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: database_consistency
 version: !ruby/object:Gem::Version
-  version: 1.1.12
+  version: 1.2.0
 platform: ruby
 authors:
 - Evgeniy Demin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-23 00:00:00.000000000 Z
+date: 2022-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -199,7 +199,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.21
 signing_key: 
 specification_version: 4
 summary: Provide an easy way to check the consistency of the database constraints