database_consistency 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f18ab981e7a995312fcefac4aad1673991c0ca74f83e892ed443b55399f73621
-  data.tar.gz: '0284902da44ea88322df42739eb9471212970ff4a2bde3ea91c491a0b3b6a8c6'
+  metadata.gz: 5774c6b4064a081e7a285013456b39fef68f39ec7dd536063c236d54abec3e84
+  data.tar.gz: 18ed6073af882e007ec6ea70a9a55fad8daa8fef755049a3070d9f68ce1377dd
 SHA512:
-  metadata.gz: 3765a63635638981d1a7389ed4d5f4a611d188c08281a13fc2ae5c435e4da8ad09a9a0f49511be596126d75caca322a3a7bd16309d27914adcfcb386a135223a
-  data.tar.gz: 6473f6990528f09bbb90e6e044b0e1c506b9c9586c65f2b76f8efaed68f1cb91d914703e11ba3747ce0663f9999e33065d7d5b0f5dbce44672a3ca33bd3be94f
+  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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DatabaseConsistency
-  VERSION = '1.2.0'
+  VERSION = '1.2.1'
 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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: database_consistency
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Evgeniy Demin
@@ -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