database_consistency 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0cb421a3fbd1c94df1816ecaf52487578c2a68c2aa13f384d1f80a9c68b35613
-  data.tar.gz: 5a38ad0d44e448e08e7474e74ecd0f934f0b9bf86e2fe43a80c2bb4540b154e8
+  metadata.gz: f0980b34790693d62df725d9e527a8694480d343c44c5061250abe3900802b32
+  data.tar.gz: 514a6e6590244f3c31b43d7c997fc90d4f3eae5e4748930e4d28eefb6945c01a
 SHA512:
-  metadata.gz: a6195f162dac4165dd70ce10fddc1dde43527f2d3dd845f9a4f2f4b9f0def589ed125fbe5cce3a5e61eb80c91ccefb609de4bc42ea0dcbe4ff26edd556522884
-  data.tar.gz: 47ebc91829df9bc38a2f518b0b5d4b938a51d79d441984c257c9fa7429d12cc22d3d6184029396d29c0e422ac890c9311391ae9cbc6e2d052fae33e22694f11c
+  metadata.gz: f79aa59df5649f0313cb78023781c9ce59e73e2add191268606353530a957a299bed6b6834352b2fbb694cdef90c072ae1c5281cdf15e3187f65da04a758e874
+  data.tar.gz: d1b45c15a664d2832bc3cde9a511a779fa1bd9ca39b2c7c990cdfdedeced6a6f9fcf8a50b526f07eb79b8664ea2183fab4445465d1507e9aea8770394933560b

data/lib/database_consistency/checkers/base_checker.rb

@@ -4,14 +4,10 @@ module DatabaseConsistency
   module Checkers
     # The base class for checkers
     class BaseChecker
-      def initialize(table_or_model, column_or_attribute, opts = {})
-        @table_or_model = table_or_model
-        @column_or_attribute = column_or_attribute
-        @opts = opts
-      end
-
-      # @return [Hash]
+      # @return [Hash, nil]
       def report
+        return unless preconditions
+
         @report ||= check
       end
 
@@ -22,6 +18,14 @@ module DatabaseConsistency
 
       private
 
+      def check
+        raise NotImplementedError
+      end
+
+      def preconditions
+        raise NotImplementedError
+      end
+
       attr_reader :table_or_model, :column_or_attribute, :opts
 
       # @return [String]

data/lib/database_consistency/checkers/belongs_to_presence_checker.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Checkers
+    # This class checks if required +belongs_to+ has foreign key constraint
+    class BelongsToPresenceChecker < ValidatorChecker
+      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 reflection with given name
+      #  - belongs_to reflection is polymorphic
+      def preconditions
+        validator.kind == :presence && reflection && !reflection.polymorphic?
+      end
+
+      # Table of possible statuses
+      # | foreign key | status |
+      # | ----------- | ------ |
+      # | persisted   | ok     |
+      # | missed      | fail   |
+      def check
+        if model.connection.foreign_keys(model.table_name).find { |fk| fk.column == reflection.foreign_key.to_s }
+          report_template(:ok)
+        else
+          report_template(:fail, MISSING_FOREIGN_KEY)
+        end
+      end
+
+      def reflection
+        @reflection ||= model.reflect_on_association(attribute)
+      end
+    end
+  end
+end

data/lib/database_consistency/checkers/{presence_validation_checker.rb → column_presence_checker.rb}

@@ -3,7 +3,7 @@
 module DatabaseConsistency
   module Checkers
     # This class checks PresenceValidator
-    class PresenceValidationChecker < BaseChecker
+    class ColumnPresenceChecker < ValidatorChecker
       WEAK_OPTIONS = %i[allow_nil allow_blank if unless].freeze
       # Message templates
       CONSTRAINT_MISSING = 'should be required in the database'
@@ -11,6 +11,13 @@ module DatabaseConsistency
 
       private
 
+      # We skip check when:
+      #  - validator is not a presence validator
+      #  - there is no column in the database with given name
+      def preconditions
+        validator.kind == :presence && column
+      end
+
       # Table of possible statuses
       # | allow_nil/allow_blank/if/unless | database | status |
       # | ------------------------------- | -------- | ------ |
@@ -18,12 +25,7 @@ module DatabaseConsistency
       # | at least one provided           | optional | ok     |
       # | all missed                      | required | ok     |
       # | all missed                      | optional | fail   |
-      #
-      # We skip check when:
-      #  - there is no column in the database with given name
       def check
-        return unless column
-
         can_be_null = column.null
         has_weak_option = validator.options.slice(*WEAK_OPTIONS).any?
 
@@ -37,19 +39,7 @@ module DatabaseConsistency
       end
 
       def column
-        @column ||= Helper.find_field(table_or_model, column_or_attribute.to_s)
-      end
-
-      def column_or_attribute_name
-        column_or_attribute.to_s
-      end
-
-      def table_or_model_name
-        table_or_model.name.to_s
-      end
-
-      def validator
-        opts[:validator]
+        @column ||= model.columns.select.find { |field| field.name == attribute.to_s }
       end
     end
   end

data/lib/database_consistency/checkers/null_constraint_checker.rb

@@ -3,62 +3,59 @@
 module DatabaseConsistency
   module Checkers
     # This class checks missing presence validator
-    class NullConstraintChecker < BaseChecker
+    class NullConstraintChecker < TableChecker
       # Message templates
       VALIDATOR_MISSING = 'is required but do not have presence validator'
 
       private
 
-      # Table of possible statuses
-      # | validation | database | status |
-      # | ---------- | -------- | ------ |
-      # | missed     | required | fail   |
-      #
       # We skip check when:
       #  - column hasn't null constraint
       #  - column has default value
       #  - column is a primary key
       #  - column is a timestamp
-      #  - presence validation exists
-      #  - inclusion validation exists
-      #  - belongs_to reflection exists with given column as foreign key or foreign type
-      def check
-        return if skip? ||
-                  validator?(ActiveModel::Validations::PresenceValidator) ||
-                  validator?(ActiveModel::Validations::InclusionValidator) ||
-                  belongs_to_reflection?
-
-        report_template(:fail, VALIDATOR_MISSING)
+      def preconditions
+        !column.null && column.default.nil? && !primary_field? && !timestamp_field?
       end
 
-      def column_or_attribute_name
-        column_or_attribute.name.to_s
+      # Table of possible statuses
+      # | validation | status |
+      # | ---------- | ------ |
+      # | provided   | ok     |
+      # | missed     | fail   |
+      #
+      # We consider PresenceValidation, InclusionValidation or BelongsTo reflection using this column
+      def check
+        if valid?
+          report_template(:ok)
+        else
+          report_template(:fail, VALIDATOR_MISSING)
+        end
       end
 
-      def table_or_model_name
-        table_or_model.name.to_s
+      def valid?
+        validator?(ActiveModel::Validations::PresenceValidator) ||
+          validator?(ActiveModel::Validations::InclusionValidator) ||
+          belongs_to_reflection?
       end
 
-      def skip?
-        column_or_attribute.null ||
-          !column_or_attribute.default.nil? ||
-          column_or_attribute.name == table_or_model.primary_key ||
-          timestamp_field?
+      def primary_field?
+        column.name.to_s == model.primary_key.to_s
       end
 
       def timestamp_field?
-        table_or_model.record_timestamps? && %w[created_at updated_at].include?(column_or_attribute.name)
+        model.record_timestamps? && %w[created_at updated_at].include?(column.name)
       end
 
       def validator?(validator_class)
-        table_or_model.validators.grep(validator_class).any? do |validator|
-          Helper.check_inclusion?(validator.attributes, column_or_attribute.name)
+        model.validators.grep(validator_class).any? do |validator|
+          Helper.check_inclusion?(validator.attributes, column.name)
         end
       end
 
       def belongs_to_reflection?
-        table_or_model.reflect_on_all_associations.grep(ActiveRecord::Reflection::BelongsToReflection).any? do |r|
-          Helper.check_inclusion?([r.foreign_key, r.foreign_type], column_or_attribute.name)
+        model.reflect_on_all_associations.grep(ActiveRecord::Reflection::BelongsToReflection).any? do |r|
+          Helper.check_inclusion?([r.foreign_key, r.foreign_type], column.name)
         end
       end
     end

data/lib/database_consistency/checkers/table_checker.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Checkers
+    # The base class for table checkers
+    class TableChecker < BaseChecker
+      attr_reader :model, :column
+
+      def initialize(model, column)
+        @model = model
+        @column = column
+      end
+
+      def column_or_attribute_name
+        @column_or_attribute_name ||= column.name.to_s
+      end
+
+      def table_or_model_name
+        @table_or_model_name ||= model.name.to_s
+      end
+    end
+  end
+end

data/lib/database_consistency/checkers/validator_checker.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Checkers
+    # The base class for validator checker
+    class ValidatorChecker < BaseChecker
+      attr_reader :model, :attribute, :validator
+
+      def initialize(model, attribute, validator)
+        @model = model
+        @attribute = attribute
+        @validator = validator
+      end
+
+      def column_or_attribute_name
+        @column_or_attribute_name ||= attribute.to_s
+      end
+
+      def table_or_model_name
+        @table_or_model_name ||= model.name.to_s
+      end
+    end
+  end
+end

data/lib/database_consistency/helper.rb

@@ -22,11 +22,6 @@ module DatabaseConsistency
       Rails.application.eager_load! if defined?(Rails)
     end
 
-    # Find a database field with name equals to attribute
-    def find_field(model, attribute)
-      model.columns.select.find { |field| field.name == attribute }
-    end
-
     # @return [Boolean]
     def check_inclusion?(array, element)
       array.include?(element.to_s) || array.include?(element.to_sym)

data/lib/database_consistency/processors/models_processor.rb

@@ -4,9 +4,10 @@ module DatabaseConsistency
   module Processors
     # The class to process all comparators
     class ModelsProcessor < BaseProcessor
-      CHECKERS = {
-        presence: Checkers::PresenceValidationChecker
-      }.freeze
+      CHECKERS = [
+        Checkers::ColumnPresenceChecker,
+        Checkers::BelongsToPresenceChecker
+      ].freeze
 
       private
 
@@ -14,11 +15,11 @@ module DatabaseConsistency
       def check
         Helper.parent_models.flat_map do |model|
           model.validators.flat_map do |validator|
-            next unless (checker_class = CHECKERS[validator.kind])
-
-            validator.attributes.map do |attribute|
-              checker = checker_class.new(model, attribute, validator: validator)
-              checker.report if checker.enabled?(configuration)
+            validator.attributes.flat_map do |attribute|
+              CHECKERS.map do |checker_class|
+                checker = checker_class.new(model, attribute, validator)
+                checker.report if checker.enabled?(configuration)
+              end
             end
           end
         end.compact

data/lib/database_consistency/version.rb

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

data/lib/database_consistency.rb

@@ -10,8 +10,11 @@ require 'database_consistency/writers/base_writer'
 require 'database_consistency/writers/simple_writer'
 
 require 'database_consistency/checkers/base_checker'
-require 'database_consistency/checkers/presence_validation_checker'
+require 'database_consistency/checkers/table_checker'
+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/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.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Evgeniy Demin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-04 00:00:00.000000000 Z
+date: 2019-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -111,8 +111,11 @@ files:
 - bin/database_consistency
 - lib/database_consistency.rb
 - 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/null_constraint_checker.rb
-- lib/database_consistency/checkers/presence_validation_checker.rb
+- lib/database_consistency/checkers/table_checker.rb
+- lib/database_consistency/checkers/validator_checker.rb
 - lib/database_consistency/configuration.rb
 - lib/database_consistency/helper.rb
 - lib/database_consistency/processors/base_processor.rb