database_consistency 1.3.9 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c589e055624919d847ef24864b767c55ebb9bb37d18da70b0558e73c2336815c
-  data.tar.gz: 53bd691bf67c2a014d8c96cfd1e93f59699ace4c6a1ba41befeca8557c05fda6
+  metadata.gz: 5c6d7fe7d9a50ab2233cca7b018d096f9d47b850e2fb92b2724fecba15eb78e6
+  data.tar.gz: 5c98abb3adb05dfddb3c586e3eae4a87d35069d07332c516154791514cc9c70f
 SHA512:
-  metadata.gz: f15b6e520813a6cc98105f250bdfa4397f12c1fff90357680681bafdba028a748bb74de0e43ac22fd377fcdf9569e619d0bd09e14095301c7ea353c45dc71146
-  data.tar.gz: 27e3773b5458c410b80c6640e5e1fc0e863faf568a7b26cf0bddbf8441411971e79ffe8ede2d77fae11c1cf590e7fe13439f0c32ee423305ad0d3d77c77b98f1
+  metadata.gz: 32ee0e823c4c893f5e062f847f33dca5fe6094bfc98d12786f879cbe6a2d2182a44f5d9756271550b524093c56030d38f72ce4ff58de6175b2936852e3e7d3d0
+  data.tar.gz: 210a2a55056fee4992ad8e7b719aa42604b03944891e2061976b27972ad8fd5c7b8ac920fb5b888f193a0dd2fbb27e2a205ffba1252a83c736a5926a471641db

data/lib/database_consistency/checkers/enum_checkers/enum_checker.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Checkers
+    # The base class for enum checkers
+    class EnumChecker < BaseChecker
+      attr_reader :model, :enum
+
+      def initialize(model, enum)
+        super()
+        @model = model
+        @enum = enum
+      end
+
+      def column_or_attribute_name
+        @column_or_attribute_name ||= enum.to_s
+      end
+
+      def table_or_model_name
+        @table_or_model_name ||= model.name.to_s
+      end
+    end
+  end
+end

data/lib/database_consistency/checkers/enum_checkers/enum_type_checker.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Checkers
+    # This class checks enum types consistency
+    class EnumTypeChecker < EnumChecker
+      Report = DatabaseConsistency::ReportBuilder.define(
+        DatabaseConsistency::Report,
+        :column_type,
+        :values_types
+      )
+
+      private
+
+      def preconditions
+        column.present?
+      end
+
+      def check
+        if valid?
+          report_template(:ok)
+        else
+          report_template(:fail, error_slug: :inconsistent_enum_type)
+        end
+      end
+
+      def report_template(status, error_slug: nil)
+        Report.new(
+          status: status,
+          error_slug: error_slug,
+          error_message: nil,
+          column_type: column_type,
+          values_types: values_types,
+          **report_attributes
+        )
+      end
+
+      def column_type_converter(type)
+        case type
+        when 'string' then String
+        when 'integer' then Integer
+        when 'decimal' then BigDecimal
+        when 'date' then Date
+        when 'datetime' then DateTime
+        when 'float' then Float
+        else type
+        end
+      end
+
+      def values_types
+        model.defined_enums[enum].values.map(&:class).uniq
+      end
+
+      def column
+        @column ||= model.columns.find { |c| c.name.to_s == enum.to_s }
+      end
+
+      def column_type
+        column.type.to_s
+      end
+
+      # @return [Boolean]
+      def valid?
+        values_types.all? { |type| type == column_type_converter(column_type) }
+      end
+    end
+  end
+end

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

@@ -20,26 +20,13 @@ module DatabaseConsistency
 
       # We skip the check when there are no presence validators
       def preconditions
-        validators.any? && !association?
+        column && validators.any? && !association?
       end
 
       def association?
         model._reflect_on_association(attribute)&.macro == :has_one
       end
 
-      # Table of possible statuses
-      # | allow_nil/allow_blank/if/unless | database | status |
-      # | ------------------------------- | -------- | ------ |
-      # | at least one provided           | required | fail   |
-      # | at least one provided           | optional | ok     |
-      # | all missing                     | required | ok     |
-      # | all missing                     | optional | fail   |
-      def check
-        report_message
-      rescue Errors::MissingField => e
-        report_template(:fail, error_message: e.message)
-      end
-
       def report_template(status, error_message: nil, error_slug: nil)
         Report.new(
           status: status,
@@ -55,7 +42,7 @@ module DatabaseConsistency
         validators.all? { |validator| validator.options.slice(*WEAK_OPTIONS).any? }
       end
 
-      def report_message # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+      def check # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
         can_be_null = column.null
         has_weak_option = weak_option?
 
@@ -84,9 +71,7 @@ module DatabaseConsistency
       end
 
       def column
-        @column ||= regular_column ||
-                    association_reference_column ||
-                    (raise Errors::MissingField, "column (#{attribute}) is missing in table (#{model.table_name}) but used for presence validation") # rubocop:disable Layout/LineLength
+        @column ||= (regular_column || association_reference_column)
       end
 
       def regular_column

data/lib/database_consistency/processors/base_processor.rb

@@ -9,7 +9,8 @@ module DatabaseConsistency
         ValidatorsProcessor,
         AssociationsProcessor,
         ValidatorsFractionsProcessor,
-        IndexesProcessor
+        IndexesProcessor,
+        EnumsProcessor
       ].flat_map do |processor|
         processor.new(configuration).reports
       end

data/lib/database_consistency/processors/enums_processor.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Processors
+    # The class to process enums
+    class EnumsProcessor < BaseProcessor
+      CHECKERS = [
+        Checkers::EnumTypeChecker
+      ].freeze
+
+      private
+
+      def check
+        Helper.models.flat_map do |model|
+          next unless configuration.enabled?(model.name.to_s)
+
+          model.defined_enums.keys.flat_map do |enum|
+            enabled_checkers.map do |checker_class|
+              checker = checker_class.new(model, enum)
+              checker.report_if_enabled?(configuration)
+            end
+          end
+        end.compact
+      end
+    end
+  end
+end

data/lib/database_consistency/version.rb

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

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

@@ -17,7 +17,9 @@ module DatabaseConsistency
         private
 
         def migration
-          File.read(template_path) % attributes.merge(migration_configuration(migration_name))
+          attributes.merge(migration_configuration(migration_name)).reduce(File.read(template_path)) do |str, (k, v)|
+            str.gsub("%<#{k}>s", v.to_s)
+          end
         end
       end
     end

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

@@ -47,7 +47,9 @@ module DatabaseConsistency
         end
 
         def message_text
-          template % attributes
+          attributes.reduce(template) do |str, (k, v)|
+            str.gsub("%<#{k}>s", v.to_s)
+          end
         end
 
         def attributes

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Writers
+    module Simple
+      class InconsistentEnumType < Base # :nodoc:
+        private
+
+        def template
+          'enum has %<values_types>s types but column has %<column_type>s type'
+        end
+
+        def attributes
+          {
+            values_types: report.values_types.join(', '),
+            column_type: report.column_type
+          }
+        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

@@ -22,7 +22,8 @@ module DatabaseConsistency
         possible_null: Simple::PossibleNull,
         redundant_index: Simple::RedundantIndex,
         redundant_unique_index: Simple::RedundantUniqueIndex,
-        small_primary_key: Simple::SmallPrimaryKey
+        small_primary_key: Simple::SmallPrimaryKey,
+        inconsistent_enum_type: Simple::InconsistentEnumType
       }.freeze
 
       def write

data/lib/database_consistency.rb

@@ -32,6 +32,7 @@ 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/inconsistent_enum_type'
 require 'database_consistency/writers/simple_writer'
 
 require 'database_consistency/writers/autofix/helpers/migration'
@@ -51,6 +52,9 @@ require 'database_consistency/databases/types/sqlite'
 
 require 'database_consistency/checkers/base_checker'
 
+require 'database_consistency/checkers/enum_checkers/enum_checker'
+require 'database_consistency/checkers/enum_checkers/enum_type_checker'
+
 require 'database_consistency/checkers/association_checkers/association_checker'
 require 'database_consistency/checkers/association_checkers/missing_index_checker'
 require 'database_consistency/checkers/association_checkers/foreign_key_checker'
@@ -73,6 +77,7 @@ require 'database_consistency/checkers/index_checkers/redundant_index_checker'
 require 'database_consistency/checkers/index_checkers/redundant_unique_index_checker'
 
 require 'database_consistency/processors/base_processor'
+require 'database_consistency/processors/enums_processor'
 require 'database_consistency/processors/associations_processor'
 require 'database_consistency/processors/validators_processor'
 require 'database_consistency/processors/columns_processor'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: database_consistency
 version: !ruby/object:Gem::Version
-  version: 1.3.9
+  version: 1.4.1
 platform: ruby
 authors:
 - Evgeniy Demin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-26 00:00:00.000000000 Z
+date: 2022-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -155,6 +155,8 @@ 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/enum_checkers/enum_checker.rb
+- lib/database_consistency/checkers/enum_checkers/enum_type_checker.rb
 - lib/database_consistency/checkers/index_checkers/index_checker.rb
 - lib/database_consistency/checkers/index_checkers/redundant_index_checker.rb
 - lib/database_consistency/checkers/index_checkers/redundant_unique_index_checker.rb
@@ -172,6 +174,7 @@ files:
 - lib/database_consistency/processors/associations_processor.rb
 - lib/database_consistency/processors/base_processor.rb
 - lib/database_consistency/processors/columns_processor.rb
+- lib/database_consistency/processors/enums_processor.rb
 - lib/database_consistency/processors/indexes_processor.rb
 - lib/database_consistency/processors/validators_fractions_processor.rb
 - lib/database_consistency/processors/validators_processor.rb
@@ -202,6 +205,7 @@ files:
 - lib/database_consistency/writers/simple/base.rb
 - lib/database_consistency/writers/simple/default_message.rb
 - lib/database_consistency/writers/simple/has_one_missing_unique_index.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
 - lib/database_consistency/writers/simple/length_validator_lower_limit.rb