database_consistency 1.3.2 → 1.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0c1477361d612a93d643987fff549de519a50d8452b1019c04f32766598078a
-  data.tar.gz: 5132d1568f2573ef5a2bfdeb34321d29f8bc4938f2cc7fa3e75e383dec8a22d6
+  metadata.gz: 1f1aad5cf1e4812b31d9bc7df0402f64dd32bb7ebdb9ab4ec7bf41bb195622dc
+  data.tar.gz: 1fc95e58bd89e9faf0004d7faf5cc2635d5432785d2e1a57d9965e413abf4c41
 SHA512:
-  metadata.gz: f3b9c74967fa7143dca1606de94d9ff18ed48553a1dc916a255f012e22f2509ead5ed943ec1b331fdac9bd11a41a5a0c5549948b9961ace82c374b17dfa9b064
-  data.tar.gz: 59cfde80772740f400642739011136f1292dc9c34540835f534f77cac7c2fe4a25d44dc279553b29ee93137dfb718815a08c07b663fd1e8c5fa949fa3003b0da
+  metadata.gz: 6d5d98750608c54e20a5f6990b54c37df89717d7009d46b099b62695b90c2a29ab44f35dab299c1e3e0f83ff4d77f5709e6a42aa7130190fcbb1807b5a6628b9
+  data.tar.gz: ff7a4d0fa92518ed33393c8e1614852ef9ec168ee5a4ac857a653881a268511ad877b982633553e7341ce8a740dbf7ae402002e991210784614e397dbe07ed36

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

@@ -14,15 +14,6 @@ module DatabaseConsistency
           @foreign_table = foreign_table
           @foreign_key = foreign_key
         end
-
-        def attributes
-          super.merge(
-            primary_table: primary_table,
-            primary_key: primary_key,
-            foreign_table: foreign_table,
-            foreign_key: foreign_key
-          )
-        end
       end
 
       private

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

@@ -14,15 +14,6 @@ module DatabaseConsistency
           @pk_name = pk_name
           @pk_type = pk_type
         end
-
-        def attributes
-          super.merge(
-            fk_name: fk_name,
-            fk_type: fk_type,
-            pk_name: pk_name,
-            pk_type: pk_type
-          )
-        end
       end
 
       private

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

@@ -11,10 +11,6 @@ module DatabaseConsistency
           super(**args)
           @association_name = association_name
         end
-
-        def attributes
-          super.merge(association_name: association_name)
-        end
       end
 
       private

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

@@ -5,16 +5,13 @@ module DatabaseConsistency
     # This class checks redundant database indexes
     class RedundantIndexChecker < IndexChecker
       class Report < DatabaseConsistency::Report # :nodoc:
-        attr_reader :index_name
+        attr_reader :covered_index_name, :index_name
 
-        def initialize(index_name:, **args)
+        def initialize(covered_index_name:, index_name:, **args)
           super(**args)
+          @covered_index_name = covered_index_name
           @index_name = index_name
         end
-
-        def attributes
-          super.merge(index_name: index_name)
-        end
       end
 
       private
@@ -31,13 +28,14 @@ module DatabaseConsistency
       # | provided   | ok     |
       # | redundant  | fail   |
       #
-      def check
+      def check # rubocop:disable Metrics/MethodLength
         if covered_by_index
           Report.new(
             status: :fail,
             error_slug: :redundant_index,
             error_message: nil,
-            index_name: covered_by_index.name,
+            covered_index_name: covered_by_index.name,
+            index_name: index.name,
             **report_attributes
           )
         else

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

@@ -5,15 +5,12 @@ module DatabaseConsistency
     # This class checks redundant database indexes
     class RedundantUniqueIndexChecker < IndexChecker
       class Report < DatabaseConsistency::Report # :nodoc:
-        attr_reader :index_name
+        attr_reader :index_name, :covered_index_name
 
-        def initialize(index_name:, **args)
+        def initialize(covered_index_name:, index_name:, **args)
           super(**args)
           @index_name = index_name
-        end
-
-        def attributes
-          super.merge(index_name: index_name)
+          @covered_index_name = covered_index_name
         end
       end
 
@@ -31,13 +28,14 @@ module DatabaseConsistency
       # | provided   | ok     |
       # | redundant  | fail   |
       #
-      def check
+      def check # rubocop:disable Metrics/MethodLength
         if covered_by_index
           Report.new(
             status: :fail,
             error_slug: :redundant_unique_index,
             error_message: nil,
-            index_name: covered_by_index.name,
+            index_name: index.name,
+            covered_index_name: covered_by_index.name,
             **report_attributes
           )
         else

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

@@ -14,10 +14,6 @@ module DatabaseConsistency
           @table_name = table_name
           @column_name = column_name
         end
-
-        def attributes
-          super.merge(table_name: table_name, column_name: column_name)
-        end
       end
 
       private

data/lib/database_consistency/report.rb

@@ -12,12 +12,5 @@ module DatabaseConsistency
       @error_slug = error_slug
       @error_message = error_message
     end
-
-    def attributes
-      {
-        error_slug: error_slug,
-        error_message: error_message
-      }
-    end
   end
 end

data/lib/database_consistency/version.rb

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

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

@@ -10,10 +10,14 @@ module DatabaseConsistency
           File.write(migration_path(migration_name), migration)
         end
 
+        def attributes
+          {}
+        end
+
         private
 
         def migration
-          File.read(template_path) % report.attributes.merge(migration_configuration(migration_name))
+          File.read(template_path) % attributes.merge(migration_configuration(migration_name))
         end
       end
     end

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

@@ -4,6 +4,15 @@ module DatabaseConsistency
   module Writers
     module Autofix
       class MissingForeignKey < MigrationBase # :nodoc:
+        def attributes
+          {
+            foreign_table: report.foreign_table,
+            foreign_key: report.foreign_key,
+            primary_table: report.primary_table,
+            primary_key: report.primary_key
+          }
+        end
+
         private
 
         def migration_name

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

@@ -4,6 +4,13 @@ module DatabaseConsistency
   module Writers
     module Autofix
       class NullConstraintMissing < MigrationBase # :nodoc:
+        def attributes
+          {
+            table_name: report.table_name,
+            column_name: report.column_name
+          }
+        end
+
         private
 
         def migration_name

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Writers
+    module Autofix
+      class RedundantIndex < MigrationBase # :nodoc:
+        def attributes
+          {
+            index_name: report.index_name
+          }
+        end
+
+        private
+
+        def migration_name
+          "remove_#{report.index_name}_index"
+        end
+
+        def template_path
+          File.join(__dir__, 'templates', 'redundant_index.tt')
+        end
+      end
+    end
+  end
+end

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

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

data/lib/database_consistency/writers/autofix_writer.rb

@@ -8,32 +8,36 @@ module DatabaseConsistency
       SLUG_TO_GENERATOR = {
         missing_foreign_key: Autofix::MissingForeignKey,
         null_constraint_missing: Autofix::NullConstraintMissing,
-        association_missing_null_constraint: Autofix::NullConstraintMissing
+        association_missing_null_constraint: Autofix::NullConstraintMissing,
+        redundant_index: Autofix::RedundantIndex,
+        redundant_unique_index: Autofix::RedundantIndex
       }.freeze
 
       def write
-        reports.each do |report|
-          next unless fix?(report)
-
-          fix(report)
-        end
+        unique_generators.each(&:fix!)
       end
 
       private
 
-      def reports
-        results.then(&Helpers::Pipes.method(:unique))
+      def unique_generators
+        results
+          .select(&method(:fix?))
+          .map(&method(:generator))
+          .compact
+          .uniq(&method(:unique_key))
       end
 
       def fix?(report)
         report.status == :fail
       end
 
-      def fix(report)
+      def generator(report)
         klass = SLUG_TO_GENERATOR[report.error_slug]
-        return unless klass
+        klass&.new(report)
+      end
 
-        klass.new(report).fix!
+      def unique_key(report)
+        [report.class, report.attributes]
       end
     end
   end

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

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Writers
+    module Simple
+      class Base # :nodoc:
+        COLORS = {
+          blue: "\e[34m",
+          yellow: "\e[33m",
+          green: "\e[32m",
+          red: "\e[31m"
+        }.freeze
+
+        COLOR_BY_STATUS = {
+          ok: :green,
+          warning: :yellow,
+          fail: :red
+        }.freeze
+
+        def self.with(text)
+          Class.new(self) do
+            define_method :template do
+              text
+            end
+          end
+        end
+
+        attr_reader :report, :config
+
+        def initialize(report, config:)
+          @report = report
+          @config = config
+        end
+
+        def msg
+          "#{report.checker_name} #{status_text} #{key_text} #{message_text}"
+        end
+
+        private
+
+        def message_text
+          template % attributes
+        end
+
+        def attributes
+          {}
+        end
+
+        def key_text
+          "#{colorize(report.table_or_model_name, :blue)} #{colorize(report.column_or_attribute_name, :yellow)}"
+        end
+
+        def colorize(text, color)
+          return text unless config.colored? && color
+
+          "#{COLORS[color]}#{text}\e[0m"
+        end
+
+        def status_text
+          color = COLOR_BY_STATUS[report.status]
+
+          colorize(report.status, color)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Writers
+    module Simple
+      class ErrorMessage < Base # :nodoc:
+        private
+
+        def template
+          report.error_message || ''
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Writers
+    module Simple
+      class InconsistentTypes < Base # :nodoc:
+        private
+
+        def template
+          "foreign key %<fk_name>s with type %<fk_type>s doesn't cover primary key %<pk_name>s with type %<pk_type>s"
+        end
+
+        def attributes
+          {
+            fk_name: report.fk_name,
+            fk_type: report.fk_type,
+            pk_name: report.pk_name,
+            pk_type: report.pk_type
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Writers
+    module Simple
+      class NullConstraintAssociationMissesValidator < Base # :nodoc:
+        private
+
+        def template
+          'column is required in the database but do not have presence validator for association %<association_name>s'
+        end
+
+        def attributes
+          {
+            association_name: report.association_name
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Writers
+    module Simple
+      class RedundantIndex < Base # :nodoc:
+        private
+
+        def template
+          'index is redundant as %<covered_index_name>s covers it'
+        end
+
+        def attributes
+          {
+            covered_index_name: report.covered_index_name
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Writers
+    module Simple
+      class RedundantUniqueIndex < Base # :nodoc:
+        private
+
+        def template
+          'index uniqueness is redundant as %<covered_index_name>s covers it'
+        end
+
+        def attributes
+          {
+            covered_index_name: report.covered_index_name
+          }
+        end
+      end
+    end
+  end
+end

data/lib/database_consistency/writers/simple_writer.rb

@@ -5,75 +5,45 @@ module DatabaseConsistency
   module Writers
     # The simplest formatter
     class SimpleWriter < BaseWriter
-      COLORS = {
-        blue: "\e[34m",
-        yellow: "\e[33m",
-        green: "\e[32m",
-        red: "\e[31m"
-      }.freeze
-
-      COLOR_BY_STATUS = {
-        ok: :green,
-        warning: :yellow,
-        fail: :red
-      }.freeze
-
-      SLUG_TO_MESSAGE = {
-        missing_foreign_key: 'should have foreign key in the database',
-        inconsistent_types: "foreign key %<fk_name>s with type %<fk_type>s doesn't cover primary key %<pk_name>s with type %<pk_type>s", # rubocop:disable Layout/LineLength
-        has_one_missing_unique_index: 'associated model should have proper unique index in the database',
-        association_missing_index: 'associated model should have proper index in the database',
-        length_validator_missing: 'column has limit in the database but do not have length validator',
-        length_validator_greater_limit: 'column has greater limit in the database than in length validator',
-        length_validator_lower_limit: 'column has lower limit in the database than in length validator',
-        null_constraint_association_misses_validator: 'column is required in the database but do not have presence validator for association %<association_name>s', # rubocop:disable Layout/LineLength
-        null_constraint_misses_validator: 'column is required in the database but do not have presence validator',
-        small_primary_key: 'column has int/serial type but recommended to have bigint/bigserial/uuid',
-        redundant_index: 'index is redundant as %<index_name>s covers it',
-        redundant_unique_index: 'index uniqueness is redundant as %<index_name>s covers it',
-        missing_uniqueness_validation: 'index is unique in the database but do not have uniqueness validator',
-        missing_unique_index: 'model should have proper unique index in the database',
-        possible_null: 'column is required but there is possible null value insert',
-        null_constraint_missing: 'column should be required in the database',
-        association_missing_null_constraint: 'association foreign key column should be required in the database'
+      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
+        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
+        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
+        null_constraint_association_misses_validator: Simple::NullConstraintAssociationMissesValidator,
+        redundant_index: Simple::RedundantIndex,
+        redundant_unique_index: Simple::RedundantUniqueIndex
       }.freeze
 
       def write
         results.each do |result|
           next unless write?(result.status)
 
-          puts msg(result)
+          writer = writer(result)
+
+          puts writer.msg
         end
       end
 
       private
 
-      def msg(result)
-        "#{result.checker_name} #{status_text(result)} #{key_text(result)} #{message_text(result)}"
-      end
-
       def write?(status)
         status == :fail || config.debug?
       end
 
-      def message_text(result)
-        (SLUG_TO_MESSAGE[result.error_slug] || result.error_message || '') % result.attributes
-      end
-
-      def key_text(result)
-        "#{colorize(result.table_or_model_name, :blue)} #{colorize(result.column_or_attribute_name, :yellow)}"
-      end
-
-      def status_text(result)
-        color = COLOR_BY_STATUS[result.status]
-
-        colorize(result.status, color)
-      end
-
-      def colorize(text, color)
-        return text unless config.colored? && color
-
-        "#{COLORS[color]}#{text}\e[0m"
+      def writer(report)
+        klass = SLUG_TO_WRITER[report.error_slug] || Simple::ErrorMessage
+        klass.new(report, config: config)
       end
     end
   end

data/lib/database_consistency.rb

@@ -9,16 +9,22 @@ require 'database_consistency/rescue_error'
 require 'database_consistency/errors'
 require 'database_consistency/report'
 
-require 'database_consistency/writers/helpers/pipes'
-
 require 'database_consistency/writers/base_writer'
-require 'database_consistency/writers/simple_writer'
 require 'database_consistency/writers/todo_writer'
 
+require 'database_consistency/writers/simple/base'
+require 'database_consistency/writers/simple/error_message'
+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_writer'
+
 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/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.2
+  version: 1.3.4
 platform: ruby
 authors:
 - Evgeniy Demin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-11 00:00:00.000000000 Z
+date: 2022-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -184,11 +184,18 @@ files:
 - 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/missing_foreign_key.tt
 - lib/database_consistency/writers/autofix/templates/null_constraint_missing.tt
+- 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/helpers/pipes.rb
+- lib/database_consistency/writers/simple/base.rb
+- lib/database_consistency/writers/simple/error_message.rb
+- lib/database_consistency/writers/simple/inconsistent_types.rb
+- lib/database_consistency/writers/simple/null_constraint_association_misses_validator.rb
+- lib/database_consistency/writers/simple/redundant_index.rb
+- lib/database_consistency/writers/simple/redundant_unique_index.rb
 - lib/database_consistency/writers/simple_writer.rb
 - lib/database_consistency/writers/todo_writer.rb
 homepage: https://github.com/djezzzl/database_consistency

data/lib/database_consistency/writers/helpers/pipes.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module DatabaseConsistency
-  module Writers
-    module Helpers
-      module Pipes # :nodoc:
-        module_function
-
-        def unique(reports)
-          reports.uniq(&:attributes)
-        end
-      end
-    end
-  end
-end