database_consistency 1.1.14 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86037a5780e8f5f906a5232a9925b5e250177b6ebe653a81509167814dc87a2e
-  data.tar.gz: 91cafa728a48dd765a2b66fc41c9a2a4f2952d72737472c6f1f88af28d9053b8
+  metadata.gz: 5774c6b4064a081e7a285013456b39fef68f39ec7dd536063c236d54abec3e84
+  data.tar.gz: 18ed6073af882e007ec6ea70a9a55fad8daa8fef755049a3070d9f68ce1377dd
 SHA512:
-  metadata.gz: d6ac7dbf5de3cc1cbfaa7aef08e86aad7c88b2e5734283ef130ab60582945312faf87828b949d6f2f2e551b2770faca8498ad70e6438bcc6416977df20441aa3
-  data.tar.gz: f31f3a0ad600d45e7fcfe6f9d9aad07a267dfc96de990e03f7e725e9644f09d95ce8b6f0c69de920676e7023a5cf2dc7058dce2506f0ead2f23ee543b2596e8f
+  metadata.gz: 575b90af564642b397b5a93d2c5a94a3b3b2fb8f6de12e40225361ebb96128df61a8d3e19fb4982986985c6bd1ae110539cc93f00688bab3b44205f7aa5f3716
+  data.tar.gz: 051360a87facb2062451b17c59ff596156b0211dfbf73d6e3345c1b45d470f45177c280d6dd6fb59602faa719a959534252dc4f9615378724d2a321d39c64394

data/bin/database_consistency

@@ -24,17 +24,22 @@ end
 require 'optparse'
 
 config = [default_config]
+options = {}
 opt_parser = OptionParser.new do |opts|
   opts.banner = <<-DESC
   Usage: database_consistency install - run installation
          database_consistency [options]
   DESC
 
-  opts.on('-cFILE', '--config=FILE', 'Use additional configuration file') do |f|
+  opts.on('-cFILE', '--config=FILE', 'Use additional configuration file.') do |f|
     config << f
   end
 
-  opts.on('-h', '--help', 'Prints this help') do
+  opts.on('-g', '--generate-todo', 'Generate TODO file with every failing check disabled. You can pass existing configurations so the generated file will have only new failures.') do |f|
+    options[:todo] = true
+  end
+
+  opts.on('-h', '--help', 'Prints this help.') do
     puts opts
     exit
   end
@@ -66,5 +71,5 @@ $LOAD_PATH.unshift(File.expand_path('lib', __dir__))
 require 'database_consistency'
 
 # Process checks
-code = DatabaseConsistency.run(config)
+code = DatabaseConsistency.run(config, **options)
 exit code

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

@@ -7,6 +7,7 @@ module DatabaseConsistency
       attr_reader :model, :association
 
       def initialize(model, association)
+        super()
         @model = model
         @association = association
       end

data/lib/database_consistency/checkers/base_checker.rb

@@ -19,7 +19,7 @@ module DatabaseConsistency
       # @param [Boolean] catch_errors
       #
       # @return [Hash, File, nil]
-      def report(catch_errors = true)
+      def report(catch_errors: true)
         return unless preconditions
 
         @report ||= check

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

@@ -7,6 +7,7 @@ module DatabaseConsistency
       attr_reader :model, :column
 
       def initialize(model, column)
+        super()
         @model = model
         @column = column
       end

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

@@ -7,6 +7,7 @@ module DatabaseConsistency
       attr_reader :model, :index
 
       def initialize(model, index)
+        super()
         @model = model
         @index = index
       end

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

@@ -7,6 +7,7 @@ module DatabaseConsistency
       attr_reader :model, :attribute, :validator
 
       def initialize(model, attribute, validator)
+        super()
         @model = model
         @attribute = attribute
         @validator = validator

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

@@ -7,6 +7,7 @@ module DatabaseConsistency
       attr_reader :model, :attribute, :validators
 
       def initialize(model, attribute, validators)
+        super()
         @model = model
         @attribute = attribute
         @validators = validators.select(&method(:filter))

data/lib/database_consistency/configuration.rb

@@ -37,22 +37,30 @@ module DatabaseConsistency
     def enabled?(*path)
       current = configuration
 
+      value = global_enabling
+
       path.each do |key|
         current = current[key.to_s]
-        return true unless current.is_a?(Hash)
+        return value unless current.is_a?(Hash)
 
         next if current['enabled'].nil?
 
-        return false unless current['enabled']
+        value = current['enabled']
       end
 
-      true
+      value
     end
 
     private
 
     attr_reader :configuration
 
+    def global_enabling
+      value = configuration.dig('DatabaseConsistencyCheckers', 'All', 'enabled')
+
+      value.nil? ? true : value
+    end
+
     def load_yaml_config_file(filepath)
       if YAML.respond_to?(:safe_load_file)
         YAML.safe_load_file(filepath, aliases: true)

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

@@ -14,7 +14,7 @@ module DatabaseConsistency
 
         # @param [String] type
         def initialize(type)
-          @type = type
+          @type = type.downcase
         end
 
         # @return [String]

data/lib/database_consistency/helper.rb

@@ -23,8 +23,10 @@ module DatabaseConsistency
 
     # Returns list of models to check
     def models
-      ActiveRecord::Base.descendants.delete_if(&:abstract_class?).delete_if do |klass|
-        !klass.connection.table_exists?(klass.table_name) || klass.name.include?('HABTM_')
+      ActiveRecord::Base.descendants.delete_if(&:abstract_class?).select do |klass|
+        klass.connection.table_exists?(klass.table_name) &&
+          !klass.name.include?('HABTM_') &&
+          project_klass?(klass)
       end
     end
 
@@ -35,6 +37,15 @@ module DatabaseConsistency
       end
     end
 
+    # @param klass [ActiveRecord::Base]
+    #
+    # @return [Boolean]
+    def project_klass?(klass)
+      return true unless Module.respond_to?(:const_source_location) && defined?(Bundler)
+
+      !Module.const_source_location(klass.to_s).first.to_s.include?(Bundler.bundle_path.to_s)
+    end
+
     # @return [Boolean]
     def check_inclusion?(array, element)
       array.include?(element.to_s) || array.include?(element.to_sym)

data/lib/database_consistency/version.rb

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

data/lib/database_consistency/writers/simple_writer.rb

@@ -12,6 +12,12 @@ module DatabaseConsistency
         red: "\e[31m"
       }.freeze
 
+      COLOR_BY_STATUS = {
+        ok: :green,
+        warning: :yellow,
+        fail: :red
+      }.freeze
+
       def write
         results.each do |result|
           next unless write?(result.status)
@@ -31,11 +37,7 @@ module DatabaseConsistency
       end
 
       def status_text(result)
-        color = case result.status
-                when :ok then :green
-                when :warning then :yellow
-                when :fail then :red
-                end
+        color = COLOR_BY_STATUS[result.status]
 
         colorize(result.status, color)
       end

data/lib/database_consistency/writers/todo_writer.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  # The module contains formatters
+  module Writers
+    # The writer that generates to-do file
+    class TodoWriter < BaseWriter
+      def write
+        hash = results.each_with_object({}) do |result, hash|
+          next unless write?(result.status)
+
+          assign_result(hash, result)
+        end
+
+        File.write(file_name, hash.to_yaml)
+      end
+
+      def write?(status)
+        status == :fail
+      end
+
+      private
+
+      def assign_result(hash, result)
+        hash[result.table_or_model_name] ||= {}
+        hash[result.table_or_model_name][result.column_or_attribute_name] ||= {}
+        hash[result.table_or_model_name][result.column_or_attribute_name][result.checker_name] = {'enabled' => false}
+      end
+
+      def file_name
+        [nil, *(1..100)].each do |number|
+          name = generate_file_name(number)
+
+          return name unless File.exists?(name)
+        end
+      end
+
+      def generate_file_name(number = nil)
+        ".database_consistency.todo#{number}.yml"
+      end
+    end
+  end
+end

data/lib/database_consistency.rb

@@ -10,6 +10,7 @@ require 'database_consistency/errors'
 
 require 'database_consistency/writers/base_writer'
 require 'database_consistency/writers/simple_writer'
+require 'database_consistency/writers/todo_writer'
 
 require 'database_consistency/databases/factory'
 require 'database_consistency/databases/types/base'
@@ -48,16 +49,19 @@ require 'database_consistency/processors/indexes_processor'
 # The root module
 module DatabaseConsistency
   class << self
-    def run(*args)
+    def run(*args, **opts)
       configuration = Configuration.new(*args)
       reports = Processors.reports(configuration)
 
-      Writers::SimpleWriter.write(
-        reports,
-        config: configuration
-      )
+      if opts[:todo]
+        Writers::TodoWriter.write(reports, config: configuration)
 
-      reports.any? { |report| report.status == :fail } || !RescueError.empty? ? 1 : 0
+        0
+      else
+        Writers::SimpleWriter.write(reports, config: configuration)
+
+        reports.any? { |report| report.status == :fail } || !RescueError.empty? ? 1 : 0
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: database_consistency
 version: !ruby/object:Gem::Version
-  version: 1.1.14
+  version: 1.2.1
 platform: ruby
 authors:
 - Evgeniy Demin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-28 00:00:00.000000000 Z
+date: 2022-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -180,6 +180,7 @@ files:
 - lib/database_consistency/version.rb
 - lib/database_consistency/writers/base_writer.rb
 - lib/database_consistency/writers/simple_writer.rb
+- lib/database_consistency/writers/todo_writer.rb
 homepage: https://github.com/djezzzl/database_consistency
 licenses:
 - MIT
@@ -199,7 +200,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
+rubygems_version: 3.3.21
 signing_key: 
 specification_version: 4
 summary: Provide an easy way to check the consistency of the database constraints