database_consistency 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 814513a9fa9c4a886a0181cbb09e71fb35ed3ec722404746f827fe754067df01
-  data.tar.gz: 1638aee8d2c92c761905e6a0b433581d6f996bb3f7c871dc2a75c84956cbb12c
+  metadata.gz: c50d282f04ae0e4003a596551369213ea66ee986a6f2486a3761ec36af6d87b3
+  data.tar.gz: 14141f85bb9ced24c2cf4fe69d2ace3a0aa0218e4f181846d2c0dfcf88569d9d
 SHA512:
-  metadata.gz: 47ef92e9038f22b807588f560e3c66f95a776e8c07b47633b8f6352935ffdb2bf8e22e6f21178b9ca1a946d84ab345fb4fdf600f2d69bed5935bdf7c5e328eea
-  data.tar.gz: feb38ceb958dc96139b4cca1a3dd70d884c4955203227a0f4d7402ee7d3c0128983c3205f414590829eae508a9d412cd2fd67a80c955b318a327b50cb2b6189f
+  metadata.gz: 90577c3faf083a0c694ac8d1146d5980e7ff69df6be7578cb57069bf62a4bc3455c2f8b4a639ccae2b75f8db8473c3c5e1733e407ca0e3292a5610062e48313b
+  data.tar.gz: 1d638396701af3be6591db67d5782cae92d4af14fb38a4a076834836b2b7988772ee053056247d56984f2830185dd9b7703464efabec21d99e8674b112b0abfa

data/lib/database_consistency/column_verifiers/base_verifier.rb

@@ -0,0 +1,23 @@
+module DatabaseConsistency
+  module ColumnVerifiers
+    # The base class for column verifiers
+    class BaseVerifier
+      attr_reader :model, :column
+
+      delegate :result, to: :report
+
+      def initialize(model, column)
+        @model = model
+        @column = column
+      end
+
+      def report
+        Report.new(column: column)
+      end
+
+      def self.verify(model, column)
+        new(model, column).verify
+      end
+    end
+  end
+end

data/lib/database_consistency/column_verifiers/presence_missing_verifier.rb

@@ -0,0 +1,26 @@
+module DatabaseConsistency
+  module ColumnVerifiers
+    # This class verifies that column needs a presence validator
+    class PresenceMissingVerifier < BaseVerifier
+      VALIDATOR_MISSING = 'is required but do not have presence validator'.freeze
+
+      def verify
+        result(:fail, Helper.message(column, VALIDATOR_MISSING)) unless skip? || validator?
+      end
+
+      private
+
+      def skip?
+        column.null ||
+          column.name == model.primary_key ||
+          (model.record_timestamps? && %w[created_at updated_at].include?(column.name))
+      end
+
+      def validator?
+        model.validators.grep(ActiveModel::Validations::PresenceValidator).any? do |validator|
+          validator.attributes.include?(column.name) || validator.attributes.include?(column.name.to_sym)
+        end
+      end
+    end
+  end
+end

data/lib/database_consistency/comparators/base_comparator.rb

@@ -4,17 +4,15 @@ module DatabaseConsistency
     class BaseComparator
       attr_reader :validator, :column
 
-      delegate :result, to: :comparison
-
-      private_class_method :new
+      delegate :result, to: :report
 
       def initialize(validator, column)
         @validator = validator
         @column = column
       end
 
-      def comparison
-        Comparison.for(validator, column)
+      def report
+        Report.new(validator: validator, column: column)
       end
 
       def self.compare(validator, column)

data/lib/database_consistency/comparators/presence_comparator.rb

@@ -3,8 +3,9 @@ module DatabaseConsistency
     # The comparator class for {{ActiveModel::Validations::PresenceValidator}}
     class PresenceComparator < BaseComparator
       WEAK_OPTIONS = %i[allow_nil allow_blank if unless].freeze
-      CONSTRAINT_MISSING = 'database field should have: "null: false"'.freeze
-      POSSIBLE_NULL = 'possible null value insert'.freeze
+      # Message templates
+      CONSTRAINT_MISSING = 'should be required in the database'.freeze
+      POSSIBLE_NULL = 'is required but possible null value insert'.freeze
 
       # Table of possible statuses
       # | allow_nil/allow_blank/if/unless | database | status |
@@ -18,13 +19,19 @@ module DatabaseConsistency
         has_weak_option = validator.options.slice(*WEAK_OPTIONS).any?
 
         if can_be_null == has_weak_option
-          result(:ok)
+          result(:ok, message)
         elsif can_be_null
-          result(:fail, CONSTRAINT_MISSING)
+          result(:fail, message(CONSTRAINT_MISSING))
         else
-          result(:fail, POSSIBLE_NULL)
+          result(:fail, message(POSSIBLE_NULL))
         end
       end
+
+      private
+
+      def message(template = nil)
+        Helper.message(column, template)
+      end
     end
   end
 end

data/lib/database_consistency/database_processor.rb

@@ -0,0 +1,18 @@
+module DatabaseConsistency
+  # The class to process missing validators
+  class DatabaseProcessor
+    VERIFIERS = [
+      ColumnVerifiers::PresenceMissingVerifier
+    ].freeze
+
+    def reports
+      Helper.models.flat_map do |model|
+        model.columns.flat_map do |column|
+          VERIFIERS.map do |verifier|
+            verifier.verify(model, column)
+          end
+        end
+      end.compact
+    end
+  end
+end

data/lib/database_consistency/helper.rb

@@ -17,5 +17,12 @@ module DatabaseConsistency
     def find_field(model, attribute)
       model.columns.select.find { |field| field.name == attribute }
     end
+
+    # @return [String]
+    def message(column, template = nil)
+      str = "column #{column.name} of table #{column.table_name}"
+      str += " #{template}" if template
+      str
+    end
   end
 end

data/lib/database_consistency/report.rb

@@ -0,0 +1,17 @@
+module DatabaseConsistency
+  # This class outputs the report result
+  class Report
+    attr_reader :opts
+
+    def initialize(opts = {})
+      @opts = opts
+    end
+
+    def result(status, message)
+      {
+        status:  status,
+        message: message
+      }.tap { |hash| hash[:opts] = opts unless opts.empty? }
+    end
+  end
+end

data/lib/database_consistency/{processor.rb → validators_processor.rb}

@@ -1,13 +1,13 @@
 module DatabaseConsistency
-  # The class to begin
-  class Processor
+  # The class to process all comparators
+  class ValidatorsProcessor
     COMPARATORS = {
       presence: DatabaseConsistency::Comparators::PresenceComparator
     }.freeze
 
-    def comparisons
-      Helper.models.each_with_object({}) do |model, hash|
-        hash[model.name] = model.validators.flat_map do |validator|
+    def reports
+      Helper.models.flat_map do |model|
+        model.validators.flat_map do |validator|
           next unless (comparator = COMPARATORS[validator.kind])
 
           validator.attributes.map do |attribute|
@@ -15,8 +15,8 @@ module DatabaseConsistency
 
             comparator.compare(validator, column)
           end
-        end.compact
-      end
+        end
+      end.compact
     end
   end
 end

data/lib/database_consistency/version.rb

@@ -1,3 +1,3 @@
 module DatabaseConsistency
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/lib/database_consistency/writers/base_writer.rb

@@ -10,7 +10,11 @@ module DatabaseConsistency
       end
 
       def write?(status)
-        status == :fail || log_level == 'DEBUG'
+        status == :fail
+      end
+
+      def debug?
+        log_level == 'DEBUG'
       end
 
       def self.write(results, log_level)

data/lib/database_consistency/writers/simple_writer.rb

@@ -8,18 +8,20 @@ module DatabaseConsistency
       end
 
       def format
-        results.map do |model_name, comparisons|
-          comparisons.map do |comparison|
-            next unless write?(comparison[:status])
-            line(model_name, comparison)
-          end.tap(&:compact!).map(&:lstrip).join("\n")
-        end.join("\n")
+        results.map do |result|
+          next unless write?(result[:status])
+          line(result)
+        end.tap(&:compact!).map(&:lstrip).delete_if(&:empty?).join(delimiter)
       end
 
-      def line(model_name, comparison)
-        <<-TEXT
-          #{comparison[:status]} #{comparison[:message]} #{model_name} #{comparison[:validator].inspect} #{comparison[:column].inspect}
-        TEXT
+      def delimiter
+        debug? ? "\n\n" : "\n"
+      end
+
+      def line(result)
+        "#{result[:status]} #{result[:message]}".tap do |str|
+          str.concat " #{result[:opts].inspect}" if debug?
+        end
       end
     end
   end

data/lib/database_consistency.rb

@@ -1,21 +1,32 @@
 require 'active_record'
 
 require 'database_consistency/version'
+require 'database_consistency/report'
+require 'database_consistency/helper'
+
 require 'database_consistency/writers/base_writer'
 require 'database_consistency/writers/simple_writer'
-require 'database_consistency/comparison'
-require 'database_consistency/helper'
+
 require 'database_consistency/comparators/base_comparator'
 require 'database_consistency/comparators/presence_comparator'
-require 'database_consistency/processor'
+require 'database_consistency/validators_processor'
+
+require 'database_consistency/column_verifiers/base_verifier'
+require 'database_consistency/column_verifiers/presence_missing_verifier'
+require 'database_consistency/database_processor'
 
 # The root module
 module DatabaseConsistency
   def self.run
     Helper.load_environment!
 
+    reports = [
+      ValidatorsProcessor.new,
+      DatabaseProcessor.new
+    ].flat_map(&:reports)
+
     Writers::SimpleWriter.write(
-      Processor.new.comparisons,
+      reports,
       ENV['LOG_LEVEL'] || 'INFO'
     )
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: database_consistency
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Evgeniy Demin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-30 00:00:00.000000000 Z
+date: 2018-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -110,11 +110,14 @@ extra_rdoc_files: []
 files:
 - bin/database_consistency
 - lib/database_consistency.rb
+- lib/database_consistency/column_verifiers/base_verifier.rb
+- lib/database_consistency/column_verifiers/presence_missing_verifier.rb
 - lib/database_consistency/comparators/base_comparator.rb
 - lib/database_consistency/comparators/presence_comparator.rb
-- lib/database_consistency/comparison.rb
+- lib/database_consistency/database_processor.rb
 - lib/database_consistency/helper.rb
-- lib/database_consistency/processor.rb
+- lib/database_consistency/report.rb
+- lib/database_consistency/validators_processor.rb
 - lib/database_consistency/version.rb
 - lib/database_consistency/writers/base_writer.rb
 - lib/database_consistency/writers/simple_writer.rb

data/lib/database_consistency/comparison.rb

@@ -1,25 +0,0 @@
-module DatabaseConsistency
-  # This class outputs the comparison result
-  class Comparison
-    attr_reader :validator, :column
-
-    private_class_method :new
-
-    def initialize(validator, column)
-      @validator = validator
-      @column = column
-    end
-
-    def result(status, message = nil)
-      {
-        column:    column,
-        validator: validator,
-        status:    status
-      }.tap { |hash| hash[:message] = message if message }
-    end
-
-    def self.for(validator, column)
-      new(validator, column)
-    end
-  end
-end