database_consistency 1.3.4 → 1.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f1aad5cf1e4812b31d9bc7df0402f64dd32bb7ebdb9ab4ec7bf41bb195622dc
-  data.tar.gz: 1fc95e58bd89e9faf0004d7faf5cc2635d5432785d2e1a57d9965e413abf4c41
+  metadata.gz: 8f935ca51faca06dad689d217e897a035253f4ce9884f1826befdf1bcbbee3b5
+  data.tar.gz: 38bde32ffee8b05b04bc8a1af261764f967b64f322352ef8d79729f1de485e13
 SHA512:
-  metadata.gz: 6d5d98750608c54e20a5f6990b54c37df89717d7009d46b099b62695b90c2a29ab44f35dab299c1e3e0f83ff4d77f5709e6a42aa7130190fcbb1807b5a6628b9
-  data.tar.gz: ff7a4d0fa92518ed33393c8e1614852ef9ec168ee5a4ac857a653881a268511ad877b982633553e7341ce8a740dbf7ae402002e991210784614e397dbe07ed36
+  metadata.gz: 2352fa358c91e6dbec9a22c9abac34fb27b45e662c1402e88cfe94864b7bfa4966628f246a6f6f5d6c6af323e1320a3fe03c74df644f86ec6d14e4bde7c81962
+  data.tar.gz: ad812a3ce4c8d4d0a7d24d9031815a26ae2c32bfca6d0721430f3c31f01d8c5910f4af091fb7d088e4860d65d887ba0a27531bdd0d8aefc50b589a944ef29290

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

@@ -4,17 +4,21 @@ module DatabaseConsistency
   module Checkers
     # This class checks if association's foreign key type covers associated model's primary key (same or bigger)
     class ForeignKeyTypeChecker < AssociationChecker
-      class Report < DatabaseConsistency::Report # :nodoc:
-        attr_reader :pk_name, :pk_type, :fk_name, :fk_type
-
-        def initialize(fk_name: nil, fk_type: nil, pk_name: nil, pk_type: nil, **args)
-          super(**args)
-          @fk_name = fk_name
-          @fk_type = fk_type
-          @pk_name = pk_name
-          @pk_type = pk_type
+      ALLOWED_TYPES =
+
+        class Report < DatabaseConsistency::Report # :nodoc:
+          attr_reader :pk_name, :pk_type, :fk_name, :fk_type, :table_to_change, :type_to_set
+
+          def initialize(fk_name: nil, fk_type: nil, pk_name: nil, pk_type: nil, table_to_change: nil, type_to_set: nil, **args) # rubocop:disable Metrics/ParameterLists, Layout/LineLength
+            super(**args)
+            @table_to_change = table_to_change
+            @type_to_set = type_to_set
+            @fk_name = fk_name
+            @fk_type = fk_type
+            @pk_name = pk_name
+            @pk_type = pk_type
+          end
         end
-      end
 
       private
 
@@ -37,9 +41,11 @@ module DatabaseConsistency
       # | ------------- | ------ |
       # | covers        | ok     |
       # | doesn't cover | fail   |
-      def check # rubocop:disable Metrics/MethodLength
+      def check # rubocop:disable Metrics/MethodLength,  Metrics/AbcSize
         if converted_type(associated_column).cover?(converted_type(primary_column))
           report_template(:ok)
+        elsif !(converted_type(associated_column).numeric? && converted_type(primary_column).numeric?)
+          report_template(:ok)
         else
           report_template(:fail, error_slug: :inconsistent_types)
         end
@@ -52,11 +58,13 @@ module DatabaseConsistency
         )
       end
 
-      def report_template(status, error_slug: nil)
+      def report_template(status, error_slug: nil) # rubocop:disable Metrics/MethodLength
         Report.new(
           status: status,
           error_slug: error_slug,
           error_message: nil,
+          table_to_change: table_to_change,
+          type_to_set: converted_type(primary_column).convert,
           fk_type: converted_type(associated_column).type,
           fk_name: associated_key,
           pk_type: converted_type(primary_column).type,
@@ -65,6 +73,14 @@ module DatabaseConsistency
         )
       end
 
+      def table_to_change
+        @table_to_change ||= if belongs_to_association?
+                               association.active_record.table_name
+                             else
+                               association.klass.table_name
+                             end
+      end
+
       # @return [String]
       def primary_key
         @primary_key ||= if belongs_to_association?

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

@@ -4,6 +4,16 @@ module DatabaseConsistency
   module Checkers
     # This class checks if association's foreign key has index in the database
     class MissingIndexChecker < AssociationChecker
+      class Report < DatabaseConsistency::Report # :nodoc:
+        attr_reader :table_name, :columns
+
+        def initialize(table_name:, columns:, **args)
+          super(**args)
+          @table_name = table_name
+          @columns = columns
+        end
+      end
+
       private
 
       # We skip check when:
@@ -48,6 +58,17 @@ module DatabaseConsistency
         end
       end
 
+      def report_template(status, error_slug: nil)
+        Report.new(
+          status: status,
+          error_slug: error_slug,
+          error_message: nil,
+          table_name: association.klass.table_name,
+          columns: association_keys,
+          **report_attributes
+        )
+      end
+
       def unique_has_one_association?
         association.scope.nil? && association.macro == :has_one && !association.options[:as].present?
       end

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

@@ -4,9 +4,24 @@ module DatabaseConsistency
   module Checkers
     # This class checks missing presence validator
     class PrimaryKeyTypeChecker < ColumnChecker
+      class Report < DatabaseConsistency::Report # :nodoc:
+        attr_reader :fk_name, :table_to_change, :type_to_set
+
+        def initialize(fk_name: nil, table_to_change: nil, type_to_set: nil, **args)
+          super(**args)
+          @table_to_change = table_to_change
+          @type_to_set = type_to_set
+          @fk_name = fk_name
+        end
+      end
+
       private
 
       VALID_TYPES = %w[bigserial bigint uuid].freeze
+      VALID_TYPES_MAP = {
+        'serial' => 'bigserial',
+        'integer' => 'bigint'
+      }.freeze
       SQLITE_ADAPTER_NAME = 'SQLite'
 
       # We skip check when:
@@ -21,14 +36,26 @@ module DatabaseConsistency
       # | --------------------- | ------ |
       # | yes                   | ok     |
       # | no                    | fail   |
-      def check
+      def check # rubocop:disable Metrics/MethodLength
         if valid?
           report_template(:ok)
         else
-          report_template(:fail, error_slug: :small_primary_key)
+          Report.new(
+            status: :fail,
+            error_slug: :small_primary_key,
+            error_message: nil,
+            table_to_change: model.table_name,
+            fk_name: column.name,
+            type_to_set: type_to_set,
+            **report_attributes
+          )
         end
       end
 
+      def type_to_set
+        VALID_TYPES_MAP[column.sql_type.to_s] || 'bigserial'
+      end
+
       # @return [Boolean]
       def valid?
         VALID_TYPES.any? do |type|

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

@@ -4,6 +4,16 @@ module DatabaseConsistency
   module Checkers
     # This class checks if uniqueness validator has unique index in the database
     class MissingUniqueIndexChecker < ValidatorChecker
+      class Report < DatabaseConsistency::Report # :nodoc:
+        attr_reader :table_name, :columns
+
+        def initialize(table_name:, columns:, **args)
+          super(**args)
+          @table_name = table_name
+          @columns = columns
+        end
+      end
+
       def column_or_attribute_name
         @column_or_attribute_name ||= Helper.uniqueness_validator_columns(attribute, validator, model).join('+')
       end
@@ -21,11 +31,18 @@ module DatabaseConsistency
       # | ------------ | ------ |
       # | persisted    | ok     |
       # | missing      | fail   |
-      def check
+      def check # rubocop:disable Metrics/MethodLength
         if unique_index
           report_template(:ok)
         else
-          report_template(:fail, error_slug: :missing_unique_index)
+          Report.new(
+            status: :fail,
+            error_slug: :missing_unique_index,
+            error_message: nil,
+            table_name: model.table_name,
+            columns: sorted_uniqueness_validator_columns,
+            **report_attributes
+          )
         end
       end
 

data/lib/database_consistency/databases/types/base.rb

@@ -7,6 +7,8 @@ module DatabaseConsistency
       class Base
         attr_reader :type
 
+        NUMERIC_TYPES = %w[bigserial serial bigint integer smallint].freeze
+
         COVERED_TYPES = {
           'bigint' => %w[integer bigint],
           'integer' => %w[integer smallint]
@@ -22,6 +24,10 @@ module DatabaseConsistency
           type
         end
 
+        def numeric?
+          NUMERIC_TYPES.include?(convert)
+        end
+
         # @param [DatabaseConsistency::Databases::Types::Base]
         #
         # @return [Boolean]

data/lib/database_consistency/version.rb

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

data/lib/database_consistency/writers/autofix/association_missing_index.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Writers
+    module Autofix
+      class AssociationMissingIndex < MigrationBase # :nodoc:
+        def attributes
+          {
+            table_name: report.table_name,
+            columns: columns,
+            index_name: index_name
+          }
+        end
+
+        private
+
+        def migration_name
+          "add_#{report.table_name}_#{columns_key}_index"
+        end
+
+        def template_path
+          File.join(__dir__, 'templates', 'association_missing_index.tt')
+        end
+
+        def columns
+          "%w[#{report.columns.join(' ')}]"
+        end
+
+        def columns_key
+          report.columns.join('_').gsub('(', '_').gsub(')', '_')
+        end
+
+        def index_name
+          "index_#{report.table_name}_#{columns_key}".first(63)
+        end
+      end
+    end
+  end
+end

data/lib/database_consistency/writers/autofix/has_one_missing_unique_index.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Writers
+    module Autofix
+      class HasOneMissingUniqueIndex < AssociationMissingIndex # :nodoc:
+        def attributes
+          super.merge(unique: true)
+        end
+
+        private
+
+        def template_path
+          File.join(__dir__, 'templates', 'has_one_missing_unique_index.tt')
+        end
+      end
+    end
+  end
+end

data/lib/database_consistency/writers/autofix/inconsistent_types.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Writers
+    module Autofix
+      class InconsistentTypes < MigrationBase # :nodoc:
+        def attributes
+          {
+            table_to_change: report.table_to_change,
+            type_to_set: report.type_to_set,
+            fk_name: report.fk_name
+          }
+        end
+
+        private
+
+        def migration_name
+          "change_#{report.table_to_change}_#{report.fk_name}_to_#{report.type_to_set}"
+        end
+
+        def template_path
+          File.join(__dir__, 'templates', 'inconsistent_types.tt')
+        end
+      end
+    end
+  end
+end

data/lib/database_consistency/writers/autofix/templates/association_missing_index.tt

@@ -0,0 +1,5 @@
+class %<migration_name>s < ActiveRecord::Migration[%<migration_version>s]
+  def change
+    add_index :%<table_name>s, %<columns>s, name: :%<index_name>s
+  end
+end

data/lib/database_consistency/writers/autofix/templates/has_one_missing_unique_index.tt

@@ -0,0 +1,5 @@
+class %<migration_name>s < ActiveRecord::Migration[%<migration_version>s]
+  def change
+    add_index :%<table_name>s, %<columns>s, name: :%<index_name>s, unique: true
+  end
+end

data/lib/database_consistency/writers/autofix/templates/inconsistent_types.tt

@@ -0,0 +1,5 @@
+class %<migration_name>s < ActiveRecord::Migration[%<migration_version>s]
+  def change
+    change_column :%<table_to_change>s, :%<fk_name>s, :%<type_to_set>s
+  end
+end

data/lib/database_consistency/writers/autofix/templates/null_constraint_missing.tt

@@ -1,5 +1,5 @@
 class %<migration_name>s < ActiveRecord::Migration[%<migration_version>s]
   def change
-    change_column_null(:%<table_name>s, :%<column_name>s, false)
+    change_column_null :%<table_name>s, :%<column_name>s, false
   end
 end

data/lib/database_consistency/writers/autofix_writer.rb

@@ -6,11 +6,16 @@ module DatabaseConsistency
     # The simplest formatter
     class AutofixWriter < BaseWriter
       SLUG_TO_GENERATOR = {
+        association_missing_index: Autofix::AssociationMissingIndex,
+        association_missing_null_constraint: Autofix::NullConstraintMissing,
+        has_one_missing_unique_index: Autofix::HasOneMissingUniqueIndex,
+        inconsistent_types: Autofix::InconsistentTypes,
         missing_foreign_key: Autofix::MissingForeignKey,
+        missing_unique_index: Autofix::HasOneMissingUniqueIndex,
         null_constraint_missing: Autofix::NullConstraintMissing,
-        association_missing_null_constraint: Autofix::NullConstraintMissing,
         redundant_index: Autofix::RedundantIndex,
-        redundant_unique_index: Autofix::RedundantIndex
+        redundant_unique_index: Autofix::RedundantIndex,
+        small_primary_key: Autofix::InconsistentTypes
       }.freeze
 
       def write

data/lib/database_consistency/writers/simple_writer.rb

@@ -6,23 +6,23 @@ module DatabaseConsistency
     # The simplest formatter
     class SimpleWriter < BaseWriter
       SLUG_TO_WRITER = {
-        missing_foreign_key: Simple::Base.with('should have foreign key in the database'),
-        inconsistent_types: Simple::InconsistentTypes,
-        has_one_missing_unique_index: Simple::Base.with('associated model should have proper unique index in the database'), # rubocop:disable Layout/LineLength
         association_missing_index: Simple::Base.with('associated model should have proper index in the database'),
-        length_validator_missing: Simple::Base.with('column has limit in the database but do not have length validator'), # rubocop:disable Layout/LineLength
+        association_missing_null_constraint: Simple::Base.with('association foreign key column should be required in the database'), # rubocop:disable Layout/LineLength
+        has_one_missing_unique_index: Simple::Base.with('associated model should have proper unique index in the database'), # rubocop:disable Layout/LineLength
+        inconsistent_types: Simple::InconsistentTypes,
         length_validator_greater_limit: Simple::Base.with('column has greater limit in the database than in length validator'), # rubocop:disable Layout/LineLength
         length_validator_lower_limit: Simple::Base.with('column has lower limit in the database than in length validator'), # rubocop:disable Layout/LineLength
-        null_constraint_misses_validator: Simple::Base.with('column is required in the database but do not have presence validator'), # rubocop:disable Layout/LineLength
-        small_primary_key: Simple::Base.with('column has int/serial type but recommended to have bigint/bigserial/uuid'), # rubocop:disable Layout/LineLength
-        missing_uniqueness_validation: Simple::Base.with('index is unique in the database but do not have uniqueness validator'), # rubocop:disable Layout/LineLength
+        length_validator_missing: Simple::Base.with('column has limit in the database but do not have length validator'), # rubocop:disable Layout/LineLength
+        missing_foreign_key: Simple::Base.with('should have foreign key in the database'),
         missing_unique_index: Simple::Base.with('model should have proper unique index in the database'),
-        possible_null: Simple::Base.with('column is required but there is possible null value insert'),
-        null_constraint_missing: Simple::Base.with('column should be required in the database'),
-        association_missing_null_constraint: Simple::Base.with('association foreign key column should be required in the database'), # rubocop:disable Layout/LineLength
+        missing_uniqueness_validation: Simple::Base.with('index is unique in the database but do not have uniqueness validator'), # rubocop:disable Layout/LineLength
         null_constraint_association_misses_validator: Simple::NullConstraintAssociationMissesValidator,
+        null_constraint_misses_validator: Simple::Base.with('column is required in the database but do not have presence validator'), # rubocop:disable Layout/LineLength
+        null_constraint_missing: Simple::Base.with('column should be required in the database'),
+        possible_null: Simple::Base.with('column is required but there is possible null value insert'),
         redundant_index: Simple::RedundantIndex,
-        redundant_unique_index: Simple::RedundantUniqueIndex
+        redundant_unique_index: Simple::RedundantUniqueIndex,
+        small_primary_key: Simple::Base.with('column has int/serial type but recommended to have bigint/bigserial/uuid')
       }.freeze
 
       def write

data/lib/database_consistency.rb

@@ -24,6 +24,9 @@ require 'database_consistency/writers/autofix/helpers/migration'
 require 'database_consistency/writers/autofix/base'
 require 'database_consistency/writers/autofix/migration_base'
 require 'database_consistency/writers/autofix/missing_foreign_key'
+require 'database_consistency/writers/autofix/inconsistent_types'
+require 'database_consistency/writers/autofix/association_missing_index'
+require 'database_consistency/writers/autofix/has_one_missing_unique_index'
 require 'database_consistency/writers/autofix/redundant_index'
 require 'database_consistency/writers/autofix/null_constraint_missing'
 require 'database_consistency/writers/autofix_writer'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: database_consistency
 version: !ruby/object:Gem::Version
-  version: 1.3.4
+  version: 1.3.5
 platform: ruby
 authors:
 - Evgeniy Demin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-12 00:00:00.000000000 Z
+date: 2022-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -179,12 +179,18 @@ files:
 - lib/database_consistency/rescue_error.rb
 - lib/database_consistency/templates/rails_defaults.yml
 - lib/database_consistency/version.rb
+- lib/database_consistency/writers/autofix/association_missing_index.rb
 - lib/database_consistency/writers/autofix/base.rb
+- lib/database_consistency/writers/autofix/has_one_missing_unique_index.rb
 - lib/database_consistency/writers/autofix/helpers/migration.rb
+- lib/database_consistency/writers/autofix/inconsistent_types.rb
 - lib/database_consistency/writers/autofix/migration_base.rb
 - lib/database_consistency/writers/autofix/missing_foreign_key.rb
 - lib/database_consistency/writers/autofix/null_constraint_missing.rb
 - lib/database_consistency/writers/autofix/redundant_index.rb
+- lib/database_consistency/writers/autofix/templates/association_missing_index.tt
+- lib/database_consistency/writers/autofix/templates/has_one_missing_unique_index.tt
+- lib/database_consistency/writers/autofix/templates/inconsistent_types.tt
 - lib/database_consistency/writers/autofix/templates/missing_foreign_key.tt
 - lib/database_consistency/writers/autofix/templates/null_constraint_missing.tt
 - lib/database_consistency/writers/autofix/templates/redundant_index.tt