database_consistency 1.1.15 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7986728aea3224bf5a8f04ef65847f88bfe517b4c7b0b3b4361c7a0dbdd2a2d
-  data.tar.gz: d7225b7dadd93850c02c0282974dc01d4c8ae6c2ded3638e996d6aa3fe29fdbe
+  metadata.gz: 7f2d13b99e730f1045b98f63239a77820a81908d2ec05232461bf12275489d5d
+  data.tar.gz: 7f92339d4b0241a15f422f64fdd80eab8db3f64c7cd8c405f91d787851fa3400
 SHA512:
-  metadata.gz: ed7beed1d43e74309e173bfba69ebb82dc4948b73b31413c43d7454a4f3c165ef68328d902278bf8e1bf527897da9848213f477779f3a48d198a580a17b8f9ef
-  data.tar.gz: 0f00c0005e59a6f374c58d25b3554405edf78eb592908603b46224ca7aff86c0e9d39e2a1bb642d6ea0a69100d8df0bf8564c184e8d3ee4b88f93cfdafa75fb1
+  metadata.gz: 4970958fca4670dda454bdaf699e96c013fc443d9bfeea4e11638ed2ad38f567f1f07ddec0785310bfac9e7afc58dd014df94872519c6ed4b7bfb3a405cc5a75
+  data.tar.gz: b3656fa0f395f2e87914b4d217eeea445b9fca195d5db0a4ca9ac596bdf5a81a5662c18dc714a1191a9f61fe714814706428cff6c0816e295ffa15650ffd7917

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/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/processors/base_processor.rb

@@ -25,8 +25,13 @@ module DatabaseConsistency
       end
 
       # @return [Array<Hash>]
-      def reports
+      def reports(catch_errors: true)
         @reports ||= check
+      rescue StandardError => e
+        raise e unless catch_errors
+
+        RescueError.call(e)
+        []
       end
 
       # @return [Array<Class>]

data/lib/database_consistency/processors/indexes_processor.rb

@@ -16,7 +16,7 @@ module DatabaseConsistency
         Helper.parent_models.flat_map do |model|
           next unless configuration.enabled?(model.name.to_s)
 
-          indexes = ActiveRecord::Base.connection.indexes(model.table_name)
+          indexes = model.connection.indexes(model.table_name)
 
           indexes.flat_map do |index|
             enabled_checkers.map do |checker_class|

data/lib/database_consistency/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DatabaseConsistency
-  VERSION = '1.1.15'
+  VERSION = '1.2.2'
 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.15
+  version: 1.2.2
 platform: ruby
 authors:
 - Evgeniy Demin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-04 00:00:00.000000000 Z
+date: 2022-09-10 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.1.6
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Provide an easy way to check the consistency of the database constraints