database_consistency 1.5.3 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f06f5f350f8f4a0dc3eab32d48b01f61da8fde59ebcbc0fcd35296a5a0a2ecd5
-  data.tar.gz: 13d02eb9836ef51570c33b721909517e1abbbb2d7406e5236a718d040e997f0d
+  metadata.gz: 8049cc73c646f8be58c7f7b3491a0dc02f55f3c75eac32803b850f8c272d11fa
+  data.tar.gz: fdf3df62bb8df2995889a5c717e22fb437260ebfd77d0bd80bdb5d7b9f90494a
 SHA512:
-  metadata.gz: be22b9c36f696268721fdad8fdb8cb5379cb739261d40577754ede248c4cdfd7cf1858f03a6609c762fa500ce87424b3cfc2ed60c93a437bcb2af15dc92f4f8d
-  data.tar.gz: cdfdaa8f8ba2d0e8af3e510407dcfffb36a1568c380a8be115aa87369bf3f97f45d3c2ebb6587f30a0b2048a576193bf90a168e924f3387f6b05e34f1f4d6ced
+  metadata.gz: e05dcd8d5f1dc062e482a7028f2e10c3232377f1fb7c44609ea41fffb9f14fb3a331db407a693fe5ffe1c0f69d0105e3c39b65166210a6ded5365a1e239ebb50
+  data.tar.gz: 4dba6ecf15c4f3b6ae3553c28873e23ef77b930a4275124f14b9dfae8b84cb8bfee53033fc4f84a573064c1ebd9b702bb32dddf0fa66c8838e373bb0a372f8ee

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

@@ -0,0 +1,87 @@
+# 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
+        Helper.postgresql? && column.type == :enum && (enum || inclusion_validator)
+      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/validator_checkers/case_sensitive_unique_validation_checker.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Checkers
+    # This class checks if uniqueness validator has unique index in the database
+    class CaseSensitiveUniqueValidationChecker < ValidatorChecker
+      private
+
+      def preconditions
+        validator.kind == :uniqueness && Helper.postgresql? && citext?
+      end
+
+      def check
+        if validator.options[:case_sensitive].nil? || validator.options[:case_sensitive]
+          report_template(:ok)
+        else
+          report_template(:fail, error_slug: :redundant_case_insensitive_option)
+        end
+      end
+
+      def citext?
+        field_name = Helper.foreign_key_or_attribute(model, attribute)
+
+        field = model.columns.find { |column| column.name.to_s == field_name.to_s }
+
+        field&.type == :citext
+      end
+
+      def sorted_uniqueness_validator_columns
+        @sorted_uniqueness_validator_columns ||= Helper.sorted_uniqueness_validator_columns(attribute, validator, model)
+      end
+    end
+  end
+end

data/lib/database_consistency/helper.rb

@@ -13,6 +13,10 @@ module DatabaseConsistency
       end
     end
 
+    def postgresql?
+      adapter == 'postgresql'
+    end
+
     def connection_config(klass)
       if klass.respond_to?(:connection_config)
         klass.connection_config

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

data/lib/database_consistency/processors/validators_processor.rb

@@ -5,7 +5,8 @@ module DatabaseConsistency
     # The class to process validators
     class ValidatorsProcessor < BaseProcessor
       CHECKERS = [
-        Checkers::MissingUniqueIndexChecker
+        Checkers::MissingUniqueIndexChecker,
+        Checkers::CaseSensitiveUniqueValidationChecker
       ].freeze
 
       private

data/lib/database_consistency/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DatabaseConsistency
-  VERSION = '1.5.3'
+  VERSION = '1.7.0'
 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/redundant_case_insensitive_option.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Writers
+    module Simple
+      class RedundantCaseInsensitiveOption < Base # :nodoc:
+        private
+
+        def template
+          "has case insensitive type and doesn't require case_sensitive: false option"
+        end
+
+        def unique_attributes
+          {
+            table_or_model_name: report.table_or_model_name,
+            column_or_attribute_name: report.column_or_attribute_name
+          }
+        end
+      end
+    end
+  end
+end

data/lib/database_consistency/writers/simple_writer.rb

@@ -25,7 +25,10 @@ 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,
+        redundant_case_insensitive_option: Simple::RedundantCaseInsensitiveOption
       }.freeze
 
       def write

data/lib/database_consistency.rb

@@ -35,6 +35,9 @@ 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/redundant_case_insensitive_option'
 require 'database_consistency/writers/simple_writer'
 
 require 'database_consistency/writers/autofix/helpers/migration'
@@ -67,9 +70,11 @@ 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'
+require 'database_consistency/checkers/validator_checkers/case_sensitive_unique_validation_checker'
 
 require 'database_consistency/checkers/validators_fraction_checkers/validators_fraction_checker'
 require 'database_consistency/checkers/validators_fraction_checkers/column_presence_checker'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: database_consistency
 version: !ruby/object:Gem::Version
-  version: 1.5.3
+  version: 1.7.0
 platform: ruby
 authors:
 - Evgeniy Demin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-01 00:00:00.000000000 Z
+date: 2022-12-05 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
@@ -162,6 +163,7 @@ files:
 - lib/database_consistency/checkers/index_checkers/redundant_index_checker.rb
 - lib/database_consistency/checkers/index_checkers/redundant_unique_index_checker.rb
 - lib/database_consistency/checkers/index_checkers/unique_index_checker.rb
+- lib/database_consistency/checkers/validator_checkers/case_sensitive_unique_validation_checker.rb
 - lib/database_consistency/checkers/validator_checkers/missing_unique_index_checker.rb
 - lib/database_consistency/checkers/validator_checkers/validator_checker.rb
 - lib/database_consistency/checkers/validators_fraction_checkers/column_presence_checker.rb
@@ -206,6 +208,8 @@ files:
 - 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
@@ -220,6 +224,7 @@ files:
 - lib/database_consistency/writers/simple/null_constraint_misses_validator.rb
 - lib/database_consistency/writers/simple/null_constraint_missing.rb
 - lib/database_consistency/writers/simple/possible_null.rb
+- lib/database_consistency/writers/simple/redundant_case_insensitive_option.rb
 - lib/database_consistency/writers/simple/redundant_index.rb
 - lib/database_consistency/writers/simple/redundant_unique_index.rb
 - lib/database_consistency/writers/simple/small_primary_key.rb