database_consistency 1.7.17 → 1.7.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8218744cf4be81d5348c01ffbb18c545b0c98db3a864575de8046b0c15d43002
-  data.tar.gz: 6a311b65d72845d0bb746d6d93c5f8850e2056202b042a015c4ea900f30c70f4
+  metadata.gz: 83e68ed4220ec40c55d0e018d8b99da78f98354b9e550279dba9fda64859e011
+  data.tar.gz: d729674e108e0051fc41dec2aa92dbe05d645b9b7c0f6fc6f87fb3a61ab2c94e
 SHA512:
-  metadata.gz: 85832321274f953b83db7ca119b07bd812c983adeabf3ce9be69291bd8cbb29afef6630a9e90599be82f40f68538e878f599cdfbdd19e705dd38bba0ee5fd54d
-  data.tar.gz: a5738e4667fabca642f76d0be5dff2618bede457681d6b26cbf16f2b0fdb63fa526c068baf87026d0773c476bcd442a3de70fd119fce9f68e9c60ff2e7bb0fad
+  metadata.gz: a87472873c4cfbfd797742a24229ef01693d610f78db20f15e012779e182bcaf5626743ee85b117bcda95289cf8155cf30a5c13f285b4a68373443a22b2bcc85
+  data.tar.gz: 8c52b06123f13a5932c3069e6a5cfb609a5008b8622eab6755d04661fd99b3e31482a91b575c760ab6f8f10013364e91eb9d9504df8c2e9b088194de235890d9

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Checkers
+    # This class checks that primary column type is "uuid" and the model class defines `self.implicit_order_column`
+    class ImplicitOrderingChecker < ColumnChecker
+      Report = ReportBuilder.define(DatabaseConsistency::Report)
+
+      private
+
+      TARGET_COLUMN_TYPE = 'uuid'
+
+      # We skip check when:
+      # - adapter is not PostgreSQL
+      # - column is not a primary key
+      # - column type is not "uuid"
+      def preconditions
+        ActiveRecord::VERSION::MAJOR >= 6 &&
+          Helper.postgresql? &&
+          primary_field? &&
+          column.sql_type.to_s.match(TARGET_COLUMN_TYPE)
+      end
+
+      # Table of possible statuses
+      # | defined `self.implicit_order_column` | status |
+      # | ----------------------------------- | ------ |
+      # | yes                                 | ok     |
+      # | no                                  | fail   |
+      def check
+        if implicit_order_column_defined?
+          report_template(:ok)
+        else
+          report_template(:fail, error_slug: :implicit_order_column_missing)
+        end
+      end
+
+      # @return [Boolean]
+      def primary_field?
+        column.name.to_s == model.primary_key.to_s
+      end
+
+      # @return [Boolean]
+      def implicit_order_column_defined?
+        model.implicit_order_column.present?
+      end
+    end
+  end
+end

data/lib/database_consistency/processors/columns_processor.rb

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

data/lib/database_consistency/report_builder.rb

@@ -7,7 +7,7 @@ module DatabaseConsistency
         attr_reader(*attrs)
 
         class_eval(<<~DEF, __FILE__, __LINE__ + 1)
-          def initialize(#{attrs.map { |attr| "#{attr}:" }.join(', ')}, **opts)
+          def initialize(#{attrs.map { |attr| "#{attr}:" }.join(', ')}#{"," if attrs.any?} **opts)
             super(**opts) if opts.any?
             #{attrs.map { |attr| "@#{attr} = #{attr}" }.join("\n")}
           end

data/lib/database_consistency/version.rb

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

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Writers
+    module Simple
+      class ImplicitOrderColumnMissing < Base # :nodoc:
+        private
+
+        def template
+          'implicit_order_column is recommended when using uuid column type for primary key'
+        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

@@ -12,6 +12,7 @@ module DatabaseConsistency
         enum_values_inconsistent_with_ar_enum: Simple::EnumValuesInconsistentWithArEnum,
         enum_values_inconsistent_with_inclusion: Simple::EnumValuesInconsistentWithInclusion,
         has_one_missing_unique_index: Simple::HasOneMissingUniqueIndex,
+        implicit_order_column_missing: Simple::ImplicitOrderColumnMissing,
         inconsistent_enum_type: Simple::InconsistentEnumType,
         inconsistent_types: Simple::InconsistentTypes,
         length_validator_greater_limit: Simple::LengthValidatorGreaterLimit,

data/lib/database_consistency.rb

@@ -42,6 +42,7 @@ require 'database_consistency/writers/simple/redundant_case_insensitive_option'
 require 'database_consistency/writers/simple/three_state_boolean'
 require 'database_consistency/writers/simple/missing_association_class'
 require 'database_consistency/writers/simple/missing_table'
+require 'database_consistency/writers/simple/implicit_order_column_missing'
 require 'database_consistency/writers/simple_writer'
 
 require 'database_consistency/writers/autofix/helpers/migration'
@@ -80,6 +81,7 @@ 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/column_checkers/implicit_ordering_checker.rb'
 
 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.17
+  version: 1.7.18
 platform: ruby
 authors:
 - Evgeniy Demin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-16 00:00:00.000000000 Z
+date: 2023-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -155,6 +155,7 @@ files:
 - 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/implicit_ordering_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
@@ -217,6 +218,7 @@ files:
 - 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/implicit_order_column_missing.rb
 - lib/database_consistency/writers/simple/inconsistent_enum_type.rb
 - lib/database_consistency/writers/simple/inconsistent_types.rb
 - lib/database_consistency/writers/simple/length_validator_greater_limit.rb