database_consistency 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0980b34790693d62df725d9e527a8694480d343c44c5061250abe3900802b32
-  data.tar.gz: 514a6e6590244f3c31b43d7c997fc90d4f3eae5e4748930e4d28eefb6945c01a
+  metadata.gz: 5feffbf59ee35344cc1f96e796cd63adea0ca6aa6b01eb81cacbb5c166bd082b
+  data.tar.gz: ac0bb8dbb583b572b785591f59bce8bebb307b267e07960707e72861e7d6b6ff
 SHA512:
-  metadata.gz: f79aa59df5649f0313cb78023781c9ce59e73e2add191268606353530a957a299bed6b6834352b2fbb694cdef90c072ae1c5281cdf15e3187f65da04a758e874
-  data.tar.gz: d1b45c15a664d2832bc3cde9a511a779fa1bd9ca39b2c7c990cdfdedeced6a6f9fcf8a50b526f07eb79b8664ea2183fab4445465d1507e9aea8770394933560b
+  metadata.gz: 189c7967c87ebac15dfe0e68a98041423148a37596508360f87cbba295790754575aabef0cd4740e4d3c5b0bb6766eb62675920fcb01972f723d7ccfa166ce4f
+  data.tar.gz: beddfa2491ec4ec8d22bac9b4b081933d2751dd9931f849f4713e9a3e2f41aaae8850a88ee3041adb154b1ed960a65949e25e3754d5706b079d1b612182ed77b

data/lib/database_consistency/checkers/base_checker.rb

@@ -13,7 +13,7 @@ module DatabaseConsistency
 
       # @param [DatabaseConsistency::Configuration] configuration
       def enabled?(configuration)
-        configuration.enabled?(checker_name, table_or_model_name, column_or_attribute_name)
+        configuration.enabled?(table_or_model_name, column_or_attribute_name, checker_name)
       end
 
       private

data/lib/database_consistency/checkers/belongs_to_presence_checker.rb

@@ -20,7 +20,7 @@ module DatabaseConsistency
       # | foreign key | status |
       # | ----------- | ------ |
       # | persisted   | ok     |
-      # | missed      | fail   |
+      # | missing     | fail   |
       def check
         if model.connection.foreign_keys(model.table_name).find { |fk| fk.column == reflection.foreign_key.to_s }
           report_template(:ok)

data/lib/database_consistency/checkers/column_presence_checker.rb

@@ -2,7 +2,7 @@
 
 module DatabaseConsistency
   module Checkers
-    # This class checks PresenceValidator
+    # This class checks if presence validator has non-null constraint in the database
     class ColumnPresenceChecker < ValidatorChecker
       WEAK_OPTIONS = %i[allow_nil allow_blank if unless].freeze
       # Message templates
@@ -23,8 +23,8 @@ module DatabaseConsistency
       # | ------------------------------- | -------- | ------ |
       # | at least one provided           | required | fail   |
       # | at least one provided           | optional | ok     |
-      # | all missed                      | required | ok     |
-      # | all missed                      | optional | fail   |
+      # | all missing                     | required | ok     |
+      # | all missing                     | optional | fail   |
       def check
         can_be_null = column.null
         has_weak_option = validator.options.slice(*WEAK_OPTIONS).any?

data/lib/database_consistency/checkers/missing_unique_index_checker.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Checkers
+    # This class checks if uniqueness validator has unique index in the database
+    class MissingUniqueIndexChecker < ValidatorChecker
+      MISSING_INDEX = 'should have unique index in the database'
+
+      def column_or_attribute_name
+        @column_or_attribute_name ||= index_columns.join('+')
+      end
+
+      private
+
+      # We skip check when:
+      #  - validator is not a uniqueness validator
+      def preconditions
+        validator.kind == :uniqueness
+      end
+
+      # Table of possible statuses
+      # | unique index | status |
+      # | ------------ | ------ |
+      # | persisted    | ok     |
+      # | missing      | fail   |
+      def check
+        if unique_index
+          report_template(:ok)
+        else
+          report_template(:fail, MISSING_INDEX)
+        end
+      end
+
+      def unique_index
+        @unique_index ||= model.connection.indexes(model.table_name).find do |index|
+          index.unique && index.columns.sort == sorted_index_columns
+        end
+      end
+
+      def index_columns
+        @index_columns ||= ([attribute] + Array.wrap(validator.options[:scope])).map(&:to_s)
+      end
+
+      def sorted_index_columns
+        @sorted_index_columns ||= index_columns.sort
+      end
+    end
+  end
+end

data/lib/database_consistency/checkers/null_constraint_checker.rb

@@ -22,7 +22,7 @@ module DatabaseConsistency
       # | validation | status |
       # | ---------- | ------ |
       # | provided   | ok     |
-      # | missed     | fail   |
+      # | missing    | fail   |
       #
       # We consider PresenceValidation, InclusionValidation or BelongsTo reflection using this column
       def check

data/lib/database_consistency/processors/models_processor.rb

@@ -6,7 +6,8 @@ module DatabaseConsistency
     class ModelsProcessor < BaseProcessor
       CHECKERS = [
         Checkers::ColumnPresenceChecker,
-        Checkers::BelongsToPresenceChecker
+        Checkers::BelongsToPresenceChecker,
+        Checkers::MissingUniqueIndexChecker
       ].freeze
 
       private

data/lib/database_consistency/version.rb

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

data/lib/database_consistency/writers/simple_writer.rb

@@ -18,9 +18,9 @@ module DatabaseConsistency
       end
 
       def line(result)
-        "#{result.status} #{result.table_or_model_name} #{result.column_or_attribute_name} #{result.message}".tap do |s|
-          s.concat " (checker: #{result.checker_name})" if debug?
-        end
+        s = "#{result.status} #{result.table_or_model_name} #{result.column_or_attribute_name} #{result.message}"
+        s += " (checker: #{result.checker_name})" if debug?
+        s
       end
     end
   end

data/lib/database_consistency.rb

@@ -15,6 +15,7 @@ require 'database_consistency/checkers/validator_checker'
 require 'database_consistency/checkers/column_presence_checker'
 require 'database_consistency/checkers/null_constraint_checker'
 require 'database_consistency/checkers/belongs_to_presence_checker'
+require 'database_consistency/checkers/missing_unique_index_checker'
 
 require 'database_consistency/processors/base_processor'
 require 'database_consistency/processors/models_processor'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: database_consistency
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Evgeniy Demin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-10 00:00:00.000000000 Z
+date: 2019-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -113,6 +113,7 @@ files:
 - lib/database_consistency/checkers/base_checker.rb
 - lib/database_consistency/checkers/belongs_to_presence_checker.rb
 - lib/database_consistency/checkers/column_presence_checker.rb
+- lib/database_consistency/checkers/missing_unique_index_checker.rb
 - lib/database_consistency/checkers/null_constraint_checker.rb
 - lib/database_consistency/checkers/table_checker.rb
 - lib/database_consistency/checkers/validator_checker.rb