database_consistency 1.5.2 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 007b8fe2bddf76beb68b7b8f1aad6d2ccfd54619a52d359c243af7b52138c92a
-  data.tar.gz: 7de86e161f98d852944dc499358c774bc5cb66e9c57f75c32a3b6cc7470e445c
+  metadata.gz: de35bff4be332ceca4a982d5cde674db49db44a53d3fce22e177cc561cfe6253
+  data.tar.gz: 9f519c9b7aef026da3033790b47690c513871b725b5271e77afa55f29014480f
 SHA512:
-  metadata.gz: 3a340470481bc101839adaa2b144c4ed1862477739b8432d3610e0249299051997dd2ff066af606ac8dd56b1e53706369a753c38a9c30f719acad2add5483dc4
-  data.tar.gz: 9bb40d5e967f4f5f75863ea3f6b57df96d22152d3453b0c4e394deaacb7e293a4905911fb21974dbdb465352d04b76676531b2318b1ca25226420ffc09d0fc2b
+  metadata.gz: bdbd9750c5a9f8470a0c73fbae78a50193b423367b934f244fe0132e0dc9af29011cf55b8ef67a6dbe22f7fee3b4bbc012069dac2ae329ccad6f43452f83c80d
+  data.tar.gz: 133abb119e8a80c25b6c4fe0936273dd328adbd6df7bc290ea16f97e695b6468f99a0b9c10bea0420dbc1788de88c73948ea429981b30812002a7b103b2f9ddf

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

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Checkers
+    # This class checks missing presence validator
+    class EnumValueChecker < ColumnChecker
+      Report = ReportBuilder.define(
+        DatabaseConsistency::Report,
+        :enum_values,
+        :declared_values
+      )
+
+      private
+
+      def report_template(status, declared_values, error_slug: nil)
+        Report.new(
+          status: status,
+          error_slug: error_slug,
+          error_message: nil,
+          enum_values: enum_column_values,
+          declared_values: declared_values,
+          **report_attributes
+        )
+      end
+
+      def preconditions
+        postgresql? && column.type == :enum && (enum || inclusion_validator)
+      end
+
+      def postgresql?
+        Helper.adapter == 'postgresql'
+      end
+
+      def check
+        [
+          (verify_enum if enum),
+          (verify_inclusion_validator if inclusion_validator)
+        ].compact
+      end
+
+      def enum_column_values
+        @enum_column_values ||= begin
+          _, values = model.connection.enum_types.find { |(enum, _)| enum == column.sql_type }
+          values.split(',').map(&:strip)
+        end
+      end
+
+      def verify_enum
+        values = enum.values.uniq
+
+        if enum_column_values == values
+          report_template(:ok, values)
+        else
+          report_template(:fail, values, error_slug: :enum_values_inconsistent_with_ar_enum)
+        end
+      end
+
+      def verify_inclusion_validator
+        values = validator_values(inclusion_validator).uniq
+
+        if enum_column_values == values
+          report_template(:ok, values)
+        else
+          report_template(:fail, values, error_slug: :enum_values_inconsistent_with_inclusion)
+        end
+      end
+
+      def validator_values(validator)
+        validator.options[:in] || validator.options[:within]
+      end
+
+      def simple_values_validator?(validator)
+        values = validator_values(validator)
+
+        values.is_a?(Array) && values.all? { |val| val.is_a?(String) }
+      end
+
+      def inclusion_validator
+        @inclusion_validator ||= model.validators.find do |validator|
+          validator.kind == :inclusion &&
+            Helper.check_inclusion?(validator.attributes, column.name) &&
+            simple_values_validator?(validator)
+        end
+      end
+
+      def enum
+        @enum ||= model.defined_enums[column.name]
+      end
+    end
+  end
+end

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

@@ -18,22 +18,17 @@ module DatabaseConsistency
         validator.kind == :presence
       end
 
-      # We skip the check when there are no presence validators
       def preconditions
-        column && validators.any? && !association?
+        (regular_column || association) && validators.any?
       end
 
-      def association?
-        model._reflect_on_association(attribute)&.macro == :has_one
-      end
-
-      def report_template(status, error_message: nil, error_slug: nil)
+      def report_template(status, column_name:, error_slug: nil)
         Report.new(
           status: status,
           error_slug: error_slug,
-          error_message: error_message,
+          error_message: nil,
           table_name: model.table_name.to_s,
-          column_name: attribute.to_s,
+          column_name: column_name,
           **report_attributes
         )
       end
@@ -42,56 +37,42 @@ module DatabaseConsistency
         validators.all? { |validator| validator.options.slice(*WEAK_OPTIONS).any? }
       end
 
-      def check # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
-        can_be_null = column.null
-        has_weak_option = weak_option?
+      def check
+        return analyse(attribute.to_s, type: :null_constraint_missing) if regular_column
 
-        return report_template(:ok) if can_be_null == has_weak_option
-        return report_template(:fail, error_slug: :possible_null) unless can_be_null
-
-        if regular_column
-          Report.new(
-            status: :fail,
-            error_slug: :null_constraint_missing,
-            error_message: nil,
-            table_name: model.table_name.to_s,
-            column_name: attribute.to_s,
-            **report_attributes
-          )
-        else
-          Report.new(
-            status: :fail,
-            error_slug: :association_missing_null_constraint,
-            error_message: nil,
-            table_name: model.table_name.to_s,
-            column_name: association_reflection.foreign_key.to_s,
-            **report_attributes
-          )
+        reports = [analyse(association.foreign_key.to_s, type: :association_missing_null_constraint)]
+        if association.polymorphic?
+          reports << analyse(association.foreign_type.to_s, type: :association_foreign_type_missing_null_constraint)
         end
-      end
 
-      def column
-        @column ||= (regular_column || association_reference_column)
+        reports
       end
 
-      def regular_column
-        @regular_column ||= column_for_name(attribute.to_s)
-      end
+      def analyse(column_name, type:)
+        field = column(column_name)
 
-      def column_for_name(name)
-        model.columns.find { |field| field.name == name.to_s }
-      end
+        can_be_null = field.null
+        has_weak_option = weak_option?
+
+        return report_template(:ok, column_name: column_name) if can_be_null == has_weak_option
+        return report_template(:fail, error_slug: :possible_null, column_name: column_name) unless can_be_null
 
-      def association_reference_column
-        return unless association_reflection
+        report_template(:fail, error_slug: type, column_name: column_name)
+      end
 
-        column_for_name(association_reflection.foreign_key)
+      def regular_column
+        @regular_column ||= column(attribute.to_s)
       end
 
-      def association_reflection
-        model
+      def association
+        @association ||=
+          model
           .reflect_on_all_associations
-          .find { |reflection| reflection.belongs_to? && reflection.name == attribute }
+          .find { |reflection| reflection.belongs_to? && reflection.name.to_s == attribute.to_s }
+      end
+
+      def column(name)
+        model.columns.find { |field| field.name == name.to_s }
       end
     end
   end

data/lib/database_consistency/processors/associations_processor.rb

@@ -18,7 +18,7 @@ module DatabaseConsistency
           next unless configuration.enabled?(model.name.to_s)
 
           Helper.first_level_associations(model).flat_map do |association|
-            enabled_checkers.map do |checker_class|
+            enabled_checkers.flat_map do |checker_class|
               checker = checker_class.new(model, association)
               checker.report_if_enabled?(configuration)
             end

data/lib/database_consistency/processors/columns_processor.rb

@@ -7,7 +7,8 @@ module DatabaseConsistency
       CHECKERS = [
         Checkers::NullConstraintChecker,
         Checkers::LengthConstraintChecker,
-        Checkers::PrimaryKeyTypeChecker
+        Checkers::PrimaryKeyTypeChecker,
+        Checkers::EnumValueChecker
       ].freeze
 
       private
@@ -17,7 +18,7 @@ module DatabaseConsistency
           next unless configuration.enabled?(model.name.to_s)
 
           model.columns.flat_map do |column|
-            enabled_checkers.map do |checker_class|
+            enabled_checkers.flat_map do |checker_class|
               checker = checker_class.new(model, column)
               checker.report_if_enabled?(configuration)
             end

data/lib/database_consistency/processors/enums_processor.rb

@@ -15,7 +15,7 @@ module DatabaseConsistency
           next unless configuration.enabled?(model.name.to_s)
 
           model.defined_enums.keys.flat_map do |enum|
-            enabled_checkers.map do |checker_class|
+            enabled_checkers.flat_map do |checker_class|
               checker = checker_class.new(model, enum)
               checker.report_if_enabled?(configuration)
             end

data/lib/database_consistency/processors/indexes_processor.rb

@@ -19,7 +19,7 @@ module DatabaseConsistency
           indexes = model.connection.indexes(model.table_name)
 
           indexes.flat_map do |index|
-            enabled_checkers.map do |checker_class|
+            enabled_checkers.flat_map do |checker_class|
               checker = checker_class.new(model, index)
               checker.report_if_enabled?(configuration)
             end

data/lib/database_consistency/processors/validators_fractions_processor.rb

@@ -18,7 +18,7 @@ module DatabaseConsistency
           model._validators.flat_map do |attribute, validators|
             next unless attribute
 
-            enabled_checkers.map do |checker_class|
+            enabled_checkers.flat_map do |checker_class|
               checker = checker_class.new(model, attribute, validators)
               checker.report_if_enabled?(configuration)
             end

data/lib/database_consistency/processors/validators_processor.rb

@@ -19,7 +19,7 @@ module DatabaseConsistency
             next unless validator.respond_to?(:attributes)
 
             validator.attributes.flat_map do |attribute|
-              enabled_checkers.map do |checker_class|
+              enabled_checkers.flat_map do |checker_class|
                 checker = checker_class.new(model, attribute, validator)
                 checker.report_if_enabled?(configuration)
               end

data/lib/database_consistency/version.rb

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

data/lib/database_consistency/writers/autofix_writer.rb

@@ -8,6 +8,7 @@ module DatabaseConsistency
       SLUG_TO_GENERATOR = {
         association_missing_index: Autofix::AssociationMissingIndex,
         association_missing_null_constraint: Autofix::NullConstraintMissing,
+        association_foreign_type_missing_null_constraint: Autofix::NullConstraintMissing,
         has_one_missing_unique_index: Autofix::HasOneMissingUniqueIndex,
         inconsistent_types: Autofix::InconsistentTypes,
         missing_foreign_key: Autofix::MissingForeignKey,

data/lib/database_consistency/writers/simple/association_foreign_type_missing_null_constraint.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Writers
+    module Simple
+      class AssociationForeignTypeMissingNullConstraint < Base # :nodoc:
+        private
+
+        def template
+          'association foreign type column should be required in the database'
+        end
+
+        def unique_attributes
+          {
+            table_name: report.table_name,
+            column_name: report.column_name
+          }
+        end
+      end
+    end
+  end
+end

data/lib/database_consistency/writers/simple/enum_values_inconsistent_with_ar_enum.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Writers
+    module Simple
+      class EnumValuesInconsistentWithArEnum < Base # :nodoc:
+        private
+
+        def template
+          'enum has [%<enum_values>s] values but ActiveRecord enum has [%<declared_values>s] values'
+        end
+
+        def attributes
+          {
+            enum_values: report.enum_values.join(', '),
+            declared_values: report.declared_values.join(', ')
+          }
+        end
+
+        def unique_attributes
+          {
+            table_or_model_name: report.table_or_model_name,
+            column_or_attribute_name: report.column_or_attribute_name,
+            ar_enum: true
+          }
+        end
+      end
+    end
+  end
+end

data/lib/database_consistency/writers/simple/enum_values_inconsistent_with_inclusion.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Writers
+    module Simple
+      class EnumValuesInconsistentWithInclusion < Base # :nodoc:
+        private
+
+        def template
+          'enum has [%<enum_values>s] values but ActiveRecord inclusion validation has [%<declared_values>s] values'
+        end
+
+        def attributes
+          {
+            enum_values: report.enum_values.join(', '),
+            declared_values: report.declared_values.join(', ')
+          }
+        end
+
+        def unique_attributes
+          {
+            table_or_model_name: report.table_or_model_name,
+            column_or_attribute_name: report.column_or_attribute_name,
+            inclusion: true
+          }
+        end
+      end
+    end
+  end
+end

data/lib/database_consistency/writers/simple_writer.rb

@@ -8,6 +8,7 @@ module DatabaseConsistency
       SLUG_TO_WRITER = {
         association_missing_index: Simple::AssociationMissingIndex,
         association_missing_null_constraint: Simple::AssociationMissingNullConstraint,
+        association_foreign_type_missing_null_constraint: Simple::AssociationForeignTypeMissingNullConstraint,
         has_one_missing_unique_index: Simple::HasOneMissingUniqueIndex,
         inconsistent_types: Simple::InconsistentTypes,
         length_validator_greater_limit: Simple::LengthValidatorGreaterLimit,
@@ -24,7 +25,9 @@ module DatabaseConsistency
         redundant_unique_index: Simple::RedundantUniqueIndex,
         small_primary_key: Simple::SmallPrimaryKey,
         inconsistent_enum_type: Simple::InconsistentEnumType,
-        missing_foreign_key_cascade: Simple::MissingForeignKeyCascade
+        missing_foreign_key_cascade: Simple::MissingForeignKeyCascade,
+        enum_values_inconsistent_with_ar_enum: Simple::EnumValuesInconsistentWithArEnum,
+        enum_values_inconsistent_with_inclusion: Simple::EnumValuesInconsistentWithInclusion
       }.freeze
 
       def write

data/lib/database_consistency.rb

@@ -22,6 +22,7 @@ require 'database_consistency/writers/simple/missing_foreign_key_cascade'
 require 'database_consistency/writers/simple/redundant_unique_index'
 require 'database_consistency/writers/simple/association_missing_index'
 require 'database_consistency/writers/simple/association_missing_null_constraint'
+require 'database_consistency/writers/simple/association_foreign_type_missing_null_constraint'
 require 'database_consistency/writers/simple/has_one_missing_unique_index'
 require 'database_consistency/writers/simple/length_validator_lower_limit'
 require 'database_consistency/writers/simple/length_validator_greater_limit'
@@ -34,6 +35,8 @@ require 'database_consistency/writers/simple/null_constraint_missing'
 require 'database_consistency/writers/simple/possible_null'
 require 'database_consistency/writers/simple/small_primary_key'
 require 'database_consistency/writers/simple/inconsistent_enum_type'
+require 'database_consistency/writers/simple/enum_values_inconsistent_with_ar_enum'
+require 'database_consistency/writers/simple/enum_values_inconsistent_with_inclusion'
 require 'database_consistency/writers/simple_writer'
 
 require 'database_consistency/writers/autofix/helpers/migration'
@@ -66,6 +69,7 @@ require 'database_consistency/checkers/column_checkers/column_checker'
 require 'database_consistency/checkers/column_checkers/null_constraint_checker'
 require 'database_consistency/checkers/column_checkers/length_constraint_checker'
 require 'database_consistency/checkers/column_checkers/primary_key_type_checker'
+require 'database_consistency/checkers/column_checkers/enum_value_checker'
 
 require 'database_consistency/checkers/validator_checkers/validator_checker'
 require 'database_consistency/checkers/validator_checkers/missing_unique_index_checker'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: database_consistency
 version: !ruby/object:Gem::Version
-  version: 1.5.2
+  version: 1.6.0
 platform: ruby
 authors:
 - Evgeniy Demin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-30 00:00:00.000000000 Z
+date: 2022-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -153,6 +153,7 @@ files:
 - lib/database_consistency/checkers/association_checkers/missing_index_checker.rb
 - lib/database_consistency/checkers/base_checker.rb
 - lib/database_consistency/checkers/column_checkers/column_checker.rb
+- lib/database_consistency/checkers/column_checkers/enum_value_checker.rb
 - lib/database_consistency/checkers/column_checkers/length_constraint_checker.rb
 - lib/database_consistency/checkers/column_checkers/null_constraint_checker.rb
 - lib/database_consistency/checkers/column_checkers/primary_key_type_checker.rb
@@ -201,10 +202,13 @@ files:
 - lib/database_consistency/writers/autofix/templates/redundant_index.tt
 - lib/database_consistency/writers/autofix_writer.rb
 - lib/database_consistency/writers/base_writer.rb
+- lib/database_consistency/writers/simple/association_foreign_type_missing_null_constraint.rb
 - lib/database_consistency/writers/simple/association_missing_index.rb
 - lib/database_consistency/writers/simple/association_missing_null_constraint.rb
 - lib/database_consistency/writers/simple/base.rb
 - lib/database_consistency/writers/simple/default_message.rb
+- lib/database_consistency/writers/simple/enum_values_inconsistent_with_ar_enum.rb
+- lib/database_consistency/writers/simple/enum_values_inconsistent_with_inclusion.rb
 - lib/database_consistency/writers/simple/has_one_missing_unique_index.rb
 - lib/database_consistency/writers/simple/inconsistent_enum_type.rb
 - lib/database_consistency/writers/simple/inconsistent_types.rb