database_consistency 1.7.5 → 1.7.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2d7b47374ed7eb17980a23c56cda142a19c6d3e796f70d9c0fbc737da3e7b6d
-  data.tar.gz: 369df7a14b6f5550b598162177c8915a1615e0df63eed590d74be43eb3145f7d
+  metadata.gz: f17a39d98d4045434101b952706e15a54da6c1bc8a46860e7daa56932b9569a8
+  data.tar.gz: 73a0950925d6158c7e9be1dfa7e9d2c706bed88590884c7ab9784e3434e044e0
 SHA512:
-  metadata.gz: a7b0139cf11940e9ce879fe06d788e15e5c6a7c8f3bcd8a9483267a656e3f14977f7cf1e1f8586ca8ce70482d5a2f325214c457b2c055e5d8a590c0e9ea66031
-  data.tar.gz: 103e78babcc811497dcfa70cac0f3285e430e79611efa44dec94070c9b5601c9dbf461e560002f723bde1c7e26ae2d7e2641840f1ecca23dc6c8e7e70f153e75
+  metadata.gz: cd3677888dabe3342854f3ad10e2591cfb79027fd6f210099c4be014f21e02b3317dec9070a35b41876088fbae5bcd5d4faacdb452bbd6e98cfaf7808f3f3294
+  data.tar.gz: a1bdfe2c29b6a873bec6f9866eb11b9a2ac90fe4117df6586f9e3ab3687cb20f29f387b23a34b011f5f2c6a52e52ee881b8b3682ee2e527c1673e2249a4f74fa

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

@@ -2,7 +2,7 @@
 
 module DatabaseConsistency
   module Checkers
-    # This class checks if non polymorphic +belongs_to+ association has foreign key constraint
+    # This class checks that foreign key has a cascade option matching dependent option
     class ForeignKeyCascadeChecker < AssociationChecker
       Report = ReportBuilder.define(
         DatabaseConsistency::Report,
@@ -14,11 +14,11 @@ module DatabaseConsistency
       )
 
       OPTION_TO_CASCADE = {
-        delete: :cascade,
-        delete_all: :cascade,
-        nullify: :nullify,
-        restrict_with_exception: :restrict,
-        restrict_with_error: :restrict
+        delete: [:cascade],
+        delete_all: [:cascade],
+        nullify: [:nullify],
+        restrict_with_exception: [nil, :restrict],
+        restrict_with_error: [nil, :restrict]
       }.freeze
 
       DEPENDENT_OPTIONS = OPTION_TO_CASCADE.keys.freeze
@@ -52,7 +52,7 @@ module DatabaseConsistency
       end
 
       def correlated_cascade_constraint?
-        required_foreign_key_cascade == foreign_key_on_delete_option
+        required_foreign_key_cascade.include?(foreign_key_on_delete_option)
       end
 
       def dependent_option

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

@@ -2,7 +2,7 @@
 
 module DatabaseConsistency
   module Checkers
-    # The base class for table checkers
+    # The base class for column checkers
     class ColumnChecker < BaseChecker
       attr_reader :model, :column
 

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

@@ -2,7 +2,7 @@
 
 module DatabaseConsistency
   module Checkers
-    # This class checks missing presence validator
+    # This class checks the database enum values and ActiveRecord's enum values/inclusion validations are aligned
     class EnumValueChecker < ColumnChecker
       Report = ReportBuilder.define(
         DatabaseConsistency::Report,

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

@@ -2,7 +2,7 @@
 
 module DatabaseConsistency
   module Checkers
-    # This class checks missing presence validator
+    # This checker checks that column has a length constraint if there is a length validation
     class LengthConstraintChecker < ColumnChecker
       VALIDATOR_CLASS =
         if defined?(ActiveRecord::Validations::LengthValidator)

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

@@ -2,7 +2,7 @@
 
 module DatabaseConsistency
   module Checkers
-    # This class checks missing presence validator
+    # This class checks that primary key is bigserial, bigint, or uuid
     class PrimaryKeyTypeChecker < ColumnChecker
       Report = ReportBuilder.define(
         DatabaseConsistency::Report,

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Checkers
+    # This class checks missing NOT NULL constraint for boolean columns
+    class ThreeStateBooleanChecker < ColumnChecker
+      Report = ReportBuilder.define(
+        DatabaseConsistency::Report,
+        :table_name,
+        :column_name
+      )
+
+      private
+
+      def preconditions
+        column.type == :boolean
+      end
+
+      def check
+        if valid?
+          report_template(:ok)
+        else
+          report_template(:fail, error_slug: :three_state_boolean)
+        end
+      end
+
+      def report_template(status, error_slug: nil)
+        Report.new(
+          status: status,
+          error_slug: error_slug,
+          error_message: nil,
+          table_name: model.table_name,
+          column_name: column.name,
+          **report_attributes
+        )
+      end
+
+      # @return [Boolean]
+      def valid?
+        !column.null
+      end
+    end
+  end
+end

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

@@ -2,7 +2,7 @@
 
 module DatabaseConsistency
   module Checkers
-    # The base class for table checkers
+    # The base class for index checkers
     class IndexChecker < BaseChecker
       attr_reader :model, :index
 

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

@@ -2,7 +2,7 @@
 
 module DatabaseConsistency
   module Checkers
-    # This class checks redundant database indexes
+    # This class checks redundant database unique indexes
     class RedundantUniqueIndexChecker < IndexChecker
       Report = ReportBuilder.define(
         DatabaseConsistency::Report,

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

@@ -2,7 +2,7 @@
 
 module DatabaseConsistency
   module Checkers
-    # This class checks if uniqueness validator has unique index in the database
+    # This class checks redundant case_sensitive option for uniqueness validation
     class CaseSensitiveUniqueValidationChecker < ValidatorChecker
       private
 

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

@@ -38,18 +38,25 @@ module DatabaseConsistency
       end
 
       def check
-        return analyse(attribute.to_s, type: :null_constraint_missing) if regular_column
+        if regular_column
+          analyse(attribute.to_s, type: :null_constraint_missing)
+        else
+          analyse_association
+        end
+      end
 
+      def analyse_association
         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
-
-        reports
+        reports.compact.presence
       end
 
       def analyse(column_name, type:)
         field = column(column_name)
+        # If the column is missing there is nothing we can do.
+        return if field.nil?
 
         can_be_null = field.null
         has_weak_option = weak_option?

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

@@ -2,7 +2,7 @@
 
 module DatabaseConsistency
   module Checkers
-    # The base class for validator checker
+    # The base class for validator fraction checkers
     class ValidatorsFractionChecker < BaseChecker
       attr_reader :model, :attribute, :validators
 

data/lib/database_consistency/processors/columns_processor.rb

@@ -8,7 +8,8 @@ module DatabaseConsistency
         Checkers::NullConstraintChecker,
         Checkers::LengthConstraintChecker,
         Checkers::PrimaryKeyTypeChecker,
-        Checkers::EnumValueChecker
+        Checkers::EnumValueChecker,
+        Checkers::ThreeStateBooleanChecker
       ].freeze
 
       private

data/lib/database_consistency/version.rb

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

data/lib/database_consistency/writers/autofix_writer.rb

@@ -16,7 +16,8 @@ module DatabaseConsistency
         null_constraint_missing: Autofix::NullConstraintMissing,
         redundant_index: Autofix::RedundantIndex,
         redundant_unique_index: Autofix::RedundantIndex,
-        small_primary_key: Autofix::InconsistentTypes
+        small_primary_key: Autofix::InconsistentTypes,
+        three_state_boolean: Autofix::NullConstraintMissing
       }.freeze
 
       def write

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Writers
+    module Simple
+      class ThreeStateBoolean < Base # :nodoc:
+        private
+
+        def template
+          'boolean column should have NOT NULL constraint'
+        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_writer.rb

@@ -28,7 +28,8 @@ module DatabaseConsistency
         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
+        redundant_case_insensitive_option: Simple::RedundantCaseInsensitiveOption,
+        three_state_boolean: Simple::ThreeStateBoolean
       }.freeze
 
       def write

data/lib/database_consistency.rb

@@ -38,6 +38,7 @@ 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/three_state_boolean'
 require 'database_consistency/writers/simple_writer'
 
 require 'database_consistency/writers/autofix/helpers/migration'
@@ -71,6 +72,7 @@ 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/column_checkers/three_state_boolean_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.7.5
+  version: 1.7.7
 platform: ruby
 authors:
 - Evgeniy Demin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-05 00:00:00.000000000 Z
+date: 2023-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -157,6 +157,7 @@ files:
 - 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
+- lib/database_consistency/checkers/column_checkers/three_state_boolean_checker.rb
 - lib/database_consistency/checkers/enum_checkers/enum_checker.rb
 - lib/database_consistency/checkers/enum_checkers/enum_type_checker.rb
 - lib/database_consistency/checkers/index_checkers/index_checker.rb
@@ -228,6 +229,7 @@ files:
 - 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
+- lib/database_consistency/writers/simple/three_state_boolean.rb
 - lib/database_consistency/writers/simple_writer.rb
 - lib/database_consistency/writers/todo_writer.rb
 homepage: https://github.com/djezzzl/database_consistency