database_consistency 1.3.5 → 1.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f935ca51faca06dad689d217e897a035253f4ce9884f1826befdf1bcbbee3b5
-  data.tar.gz: 38bde32ffee8b05b04bc8a1af261764f967b64f322352ef8d79729f1de485e13
+  metadata.gz: ad00c3759184fa0098812d4cb79169f109205bff2861c37965d56c42c4da568f
+  data.tar.gz: 579087c2a52d57bac85af5fc7f9e86fa31b6c78bbaab1583128e319f9156dafb
 SHA512:
-  metadata.gz: 2352fa358c91e6dbec9a22c9abac34fb27b45e662c1402e88cfe94864b7bfa4966628f246a6f6f5d6c6af323e1320a3fe03c74df644f86ec6d14e4bde7c81962
-  data.tar.gz: ad812a3ce4c8d4d0a7d24d9031815a26ae2c32bfca6d0721430f3c31f01d8c5910f4af091fb7d088e4860d65d887ba0a27531bdd0d8aefc50b589a944ef29290
+  metadata.gz: 206324a83d7f850bde79bb8a4399362ba7ff4f94cf848139d55781cf7e6f54d8b03d5e4641928193689c0c818c803badbcbb4f72685031f72dab26eea1f4a80a
+  data.tar.gz: 2cbaed407b168b1100de5cb6962d2fedac6ce2e8f955a5ed4811ef9d80227a2f3f396de98c9ed0a9de8c5ca751c092f389b482852663a510860cbaad85866643

data/lib/database_consistency/version.rb

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

data/lib/database_consistency/writers/autofix_writer.rb

@@ -41,8 +41,8 @@ module DatabaseConsistency
         klass&.new(report)
       end
 
-      def unique_key(report)
-        [report.class, report.attributes]
+      def unique_key(generator)
+        [generator.class, generator.attributes]
       end
     end
   end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Writers
+    module Simple
+      class AssociationMissingIndex < Base # :nodoc:
+        private
+
+        def template
+          'associated model should have proper index in the database'
+        end
+
+        def unique_attributes
+          {
+            table_name: report.table_name,
+            columns: report.columns
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Writers
+    module Simple
+      class AssociationMissingNullConstraint < Base # :nodoc:
+        private
+
+        def template
+          'association foreign key 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/base.rb

@@ -36,8 +36,16 @@ module DatabaseConsistency
           "#{report.checker_name} #{status_text} #{key_text} #{message_text}"
         end
 
+        def unique_key
+          { class: self.class }.merge(unique_attributes)
+        end
+
         private
 
+        def unique_attributes
+          raise StandardError, 'Missing the implementation'
+        end
+
         def message_text
           template % attributes
         end

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

@@ -9,6 +9,13 @@ module DatabaseConsistency
         def template
           report.error_message || ''
         end
+
+        def unique_attributes
+          {
+            template: template,
+            checker_name: report.checker_name
+          }
+        end
       end
     end
   end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Writers
+    module Simple
+      class HasOneMissingUniqueIndex < Base # :nodoc:
+        private
+
+        def template
+          'associated model should have proper unique index in the database'
+        end
+
+        def unique_attributes
+          {
+            table_name: report.table_name,
+            columns: report.columns,
+            unique: true
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -18,6 +18,14 @@ module DatabaseConsistency
             pk_type: report.pk_type
           }
         end
+
+        def unique_attributes
+          {
+            table_to_change: report.table_to_change,
+            type_to_set: report.type_to_set,
+            fk_name: report.fk_name
+          }
+        end
       end
     end
   end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Writers
+    module Simple
+      class LengthValidatorGreaterLimit < Base # :nodoc:
+        private
+
+        def template
+          'column has greater limit in the database than in length validator'
+        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/length_validator_lower_limit.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Writers
+    module Simple
+      class LengthValidatorLowerLimit < Base # :nodoc:
+        private
+
+        def template
+          'column has lower limit in the database than in length validator'
+        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/length_validator_missing.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Writers
+    module Simple
+      class LengthValidatorMissing < Base # :nodoc:
+        private
+
+        def template
+          'column has limit in the database but do not have length validator'
+        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/missing_foreign_key.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Writers
+    module Simple
+      class MissingForeignKey < Base # :nodoc:
+        private
+
+        def template
+          'should have foreign key in the database'
+        end
+
+        def unique_attributes
+          {
+            foreign_table: report.foreign_table,
+            foreign_key: report.foreign_key,
+            primary_table: report.primary_table,
+            primary_key: report.primary_key
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Writers
+    module Simple
+      class MissingUniqueIndex < Base # :nodoc:
+        private
+
+        def template
+          'model should have proper unique index in the database'
+        end
+
+        def unique_attributes
+          {
+            table_name: report.table_name,
+            columns: report.columns,
+            unique: true
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Writers
+    module Simple
+      class MissingUniquenessValidation < Base # :nodoc:
+        private
+
+        def template
+          'index is unique in the database but do not have uniqueness validator'
+        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/null_constraint_association_misses_validator.rb

@@ -15,6 +15,13 @@ module DatabaseConsistency
             association_name: report.association_name
           }
         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

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Writers
+    module Simple
+      class NullConstraintMissesValidator < Base # :nodoc:
+        private
+
+        def template
+          'column is required in the database but do not have presence validator'
+        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/null_constraint_missing.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Writers
+    module Simple
+      class NullConstraintMissing < Base # :nodoc:
+        private
+
+        def template
+          '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/possible_null.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Writers
+    module Simple
+      class PossibleNull < Base # :nodoc:
+        private
+
+        def template
+          'column is required but there is possible null value insert'
+        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/redundant_index.rb

@@ -15,6 +15,12 @@ module DatabaseConsistency
             covered_index_name: report.covered_index_name
           }
         end
+
+        def unique_attributes
+          {
+            index_name: report.index_name
+          }
+        end
       end
     end
   end

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

@@ -15,6 +15,12 @@ module DatabaseConsistency
             covered_index_name: report.covered_index_name
           }
         end
+
+        def unique_attributes
+          {
+            index_name: report.index_name
+          }
+        end
       end
     end
   end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Writers
+    module Simple
+      class SmallPrimaryKey < Base # :nodoc:
+        private
+
+        def template
+          'column has int/serial type but recommended to have bigint/bigserial/uuid'
+        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

@@ -6,39 +6,38 @@ module DatabaseConsistency
     # The simplest formatter
     class SimpleWriter < BaseWriter
       SLUG_TO_WRITER = {
-        association_missing_index: Simple::Base.with('associated model should have proper index in the database'),
-        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
+        association_missing_index: Simple::AssociationMissingIndex,
+        association_missing_null_constraint: Simple::AssociationMissingNullConstraint,
+        has_one_missing_unique_index: Simple::HasOneMissingUniqueIndex,
         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
-        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'),
-        missing_uniqueness_validation: Simple::Base.with('index is unique in the database but do not have uniqueness validator'), # rubocop:disable Layout/LineLength
+        length_validator_greater_limit: Simple::LengthValidatorGreaterLimit,
+        length_validator_lower_limit: Simple::LengthValidatorLowerLimit,
+        length_validator_missing: Simple::LengthValidatorMissing,
+        missing_foreign_key: Simple::MissingForeignKey,
+        missing_unique_index: Simple::MissingUniqueIndex,
+        missing_uniqueness_validation: Simple::MissingUniquenessValidation,
         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'),
+        null_constraint_misses_validator: Simple::NullConstraintMissesValidator,
+        null_constraint_missing: Simple::NullConstraintMissing,
+        possible_null: Simple::PossibleNull,
         redundant_index: Simple::RedundantIndex,
         redundant_unique_index: Simple::RedundantUniqueIndex,
-        small_primary_key: Simple::Base.with('column has int/serial type but recommended to have bigint/bigserial/uuid')
+        small_primary_key: Simple::SmallPrimaryKey
       }.freeze
 
       def write
-        results.each do |result|
-          next unless write?(result.status)
-
-          writer = writer(result)
-
+        results.select(&method(:write?))
+               .map(&method(:writer))
+               .uniq(&:unique_key)
+               .each do |writer|
           puts writer.msg
         end
       end
 
       private
 
-      def write?(status)
-        status == :fail || config.debug?
+      def write?(report)
+        report.status == :fail || config.debug?
       end
 
       def writer(report)

data/lib/database_consistency.rb

@@ -18,6 +18,19 @@ require 'database_consistency/writers/simple/inconsistent_types'
 require 'database_consistency/writers/simple/null_constraint_association_misses_validator'
 require 'database_consistency/writers/simple/redundant_index'
 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/has_one_missing_unique_index'
+require 'database_consistency/writers/simple/length_validator_lower_limit'
+require 'database_consistency/writers/simple/length_validator_greater_limit'
+require 'database_consistency/writers/simple/length_validator_missing'
+require 'database_consistency/writers/simple/missing_foreign_key'
+require 'database_consistency/writers/simple/missing_unique_index'
+require 'database_consistency/writers/simple/missing_uniqueness_validation'
+require 'database_consistency/writers/simple/null_constraint_misses_validator'
+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_writer'
 
 require 'database_consistency/writers/autofix/helpers/migration'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: database_consistency
 version: !ruby/object:Gem::Version
-  version: 1.3.5
+  version: 1.3.6
 platform: ruby
 authors:
 - Evgeniy Demin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-13 00:00:00.000000000 Z
+date: 2022-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -196,12 +196,25 @@ 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_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/error_message.rb
+- lib/database_consistency/writers/simple/has_one_missing_unique_index.rb
 - lib/database_consistency/writers/simple/inconsistent_types.rb
+- lib/database_consistency/writers/simple/length_validator_greater_limit.rb
+- lib/database_consistency/writers/simple/length_validator_lower_limit.rb
+- lib/database_consistency/writers/simple/length_validator_missing.rb
+- lib/database_consistency/writers/simple/missing_foreign_key.rb
+- lib/database_consistency/writers/simple/missing_unique_index.rb
+- lib/database_consistency/writers/simple/missing_uniqueness_validation.rb
 - lib/database_consistency/writers/simple/null_constraint_association_misses_validator.rb
+- 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_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_writer.rb
 - lib/database_consistency/writers/todo_writer.rb
 homepage: https://github.com/djezzzl/database_consistency