database_consistency 1.3.8 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad78f367e1642231f8f17aa787385cd154dec73b9fd68ee0f506311335128d0e
-  data.tar.gz: cd0d30bf84e70dffb926a9cae47542853ea59d68ec4e268318af1bee0e6094e4
+  metadata.gz: 9bc1994c7c24ab9a38d97c764fb0d9ce55e4fa71934df313f2cc693c466cecb7
+  data.tar.gz: 04110bdba61254592c2b22323555948ad06a78b8a63ce78a40175005096acb54
 SHA512:
-  metadata.gz: 221df64634adcf4c025ed9937b38f4fed127639b39bb944c9b31b616917916e1cbf01165c934c35c8e5b2f338d6512ab5a371d9d0bcf43ffe25fa3258f73aa47
-  data.tar.gz: bee363244d2240f94225429684e66a8d1dbdd545a22a03f8fdd70f3b40baea91d94be51aadc4822f0a19921541e472c668aaaea22504e7a1c5ff5de10014d005
+  metadata.gz: 581c8660605072f0cd877310813d71781b50de0af57aa5d85b216b57dd3ed040dc90944e165e51ff9b4728d180474157281ce1e028d9295b7137657367a4fa80
+  data.tar.gz: 0c9d42d9902485c01d208ac38110aa4c7742b4ceca00c369c4fc4c014e84df038b708f17b084f9cee7da8eef28a1f31b52d4a29fa2f597f7cf454af1cefc828c

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,69 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Checkers
+    # This class checks enum types consistency
+    class EnumTypeChecker < EnumChecker
+      MissingColumn = Class.new(StandardError)
+
+      Report = DatabaseConsistency::ReportBuilder.define(
+        DatabaseConsistency::Report,
+        :column_type,
+        :values_types
+      )
+
+      private
+
+      def preconditions
+        true
+      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_type
+        column = model.columns.find { |c| c.name.to_s == enum.to_s }
+        raise MissingColumn unless column
+
+        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/configuration.rb

@@ -7,17 +7,10 @@ module DatabaseConsistency
   class Configuration
     DEFAULT_PATH = '.database_consistency.yml'
 
-    def initialize(filepaths = DEFAULT_PATH)
-      @configuration = Array(filepaths).each_with_object({}) do |filepath, result|
-        content =
-          if filepath && File.exist?(filepath)
-            data = load_yaml_config_file(filepath)
-            data.is_a?(Hash) ? data : {}
-          else
-            {}
-          end
-
-        combine_configs!(result, content)
+    def initialize(file_paths = DEFAULT_PATH)
+      @configuration = existing_configurations(file_paths).then do |existing_paths|
+        puts "Loaded configurations: #{existing_paths.join(', ')}"
+        extract_configurations(existing_paths)
       end
     end
 
@@ -55,6 +48,21 @@ module DatabaseConsistency
 
     attr_reader :configuration
 
+    def existing_configurations(paths)
+      Array(paths).select do |filepath|
+        filepath && File.exist?(filepath)
+      end
+    end
+
+    def extract_configurations(paths)
+      Array(paths).each_with_object({}) do |filepath, result|
+        data = load_yaml_config_file(filepath)
+        content = data.is_a?(Hash) ? data : {}
+
+        combine_configs!(result, content)
+      end
+    end
+
     def global_enabling
       value = configuration.dig('DatabaseConsistencyCheckers', 'All', 'enabled')
 

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.8'
+  VERSION = '1.4.0'
 end

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.8
+  version: 1.4.0
 platform: ruby
 authors:
 - Evgeniy Demin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-23 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