database_consistency 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 814513a9fa9c4a886a0181cbb09e71fb35ed3ec722404746f827fe754067df01
+  data.tar.gz: 1638aee8d2c92c761905e6a0b433581d6f996bb3f7c871dc2a75c84956cbb12c
+SHA512:
+  metadata.gz: 47ef92e9038f22b807588f560e3c66f95a776e8c07b47633b8f6352935ffdb2bf8e22e6f21178b9ca1a946d84ab345fb4fdf600f2d69bed5935bdf7c5e328eea
+  data.tar.gz: feb38ceb958dc96139b4cca1a3dd70d884c4955203227a0f4d7402ee7d3c0128983c3205f414590829eae508a9d412cd2fd67a80c955b318a327b50cb2b6189f

data/bin/database_consistency

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+base_dir = File.join(Dir.pwd, ARGV.first.to_s)
+
+unless File.realpath(base_dir).start_with?(Dir.pwd)
+  puts "\nWarning! You are going out of current directory, ruby version may be wrong and some gems may be missing.\n"
+end
+
+begin
+  require File.join(base_dir, 'config', 'boot')
+  require File.join(base_dir, 'config', 'environment')
+rescue LoadError
+  puts "\nUh-oh! You must be in the root directory of a Rails project.\n"
+  raise
+end
+
+$LOAD_PATH.unshift(File.expand_path('lib', __dir__))
+require 'database_consistency'
+
+DatabaseConsistency.run

data/lib/database_consistency/comparators/base_comparator.rb

@@ -0,0 +1,25 @@
+module DatabaseConsistency
+  module Comparators
+    # The base class for comparators
+    class BaseComparator
+      attr_reader :validator, :column
+
+      delegate :result, to: :comparison
+
+      private_class_method :new
+
+      def initialize(validator, column)
+        @validator = validator
+        @column = column
+      end
+
+      def comparison
+        Comparison.for(validator, column)
+      end
+
+      def self.compare(validator, column)
+        new(validator, column).compare
+      end
+    end
+  end
+end

data/lib/database_consistency/comparators/presence_comparator.rb

@@ -0,0 +1,30 @@
+module DatabaseConsistency
+  module Comparators
+    # 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
+
+      # Table of possible statuses
+      # | allow_nil/allow_blank/if/unless | database | status |
+      # | ------------------------------- | -------- | ------ |
+      # | at least one provided           | required | fail   |
+      # | at least one provided           | optional | ok     |
+      # | all missed                      | required | ok     |
+      # | all missed                      | optional | fail   |
+      def compare
+        can_be_null = column.null
+        has_weak_option = validator.options.slice(*WEAK_OPTIONS).any?
+
+        if can_be_null == has_weak_option
+          result(:ok)
+        elsif can_be_null
+          result(:fail, CONSTRAINT_MISSING)
+        else
+          result(:fail, POSSIBLE_NULL)
+        end
+      end
+    end
+  end
+end

data/lib/database_consistency/comparison.rb

@@ -0,0 +1,25 @@
+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

data/lib/database_consistency/helper.rb

@@ -0,0 +1,21 @@
+module DatabaseConsistency
+  # The module contains helper methods
+  module Helper
+    module_function
+
+    # Returns list of models to check
+    def models
+      ActiveRecord::Base.descendants.select { |model| model.validators.any? }
+    end
+
+    # Loads all models
+    def load_environment!
+      Rails.application.eager_load! if defined?(Rails)
+    end
+
+    # Find a database field with name equals to attribute
+    def find_field(model, attribute)
+      model.columns.select.find { |field| field.name == attribute }
+    end
+  end
+end

data/lib/database_consistency/processor.rb

@@ -0,0 +1,22 @@
+module DatabaseConsistency
+  # The class to begin
+  class Processor
+    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|
+          next unless (comparator = COMPARATORS[validator.kind])
+
+          validator.attributes.map do |attribute|
+            next unless (column = Helper.find_field(model, attribute.to_s))
+
+            comparator.compare(validator, column)
+          end
+        end.compact
+      end
+    end
+  end
+end

data/lib/database_consistency/version.rb

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

data/lib/database_consistency/writers/base_writer.rb

@@ -0,0 +1,21 @@
+module DatabaseConsistency
+  module Writers
+    # The base class for writers
+    class BaseWriter
+      attr_reader :results, :log_level
+
+      def initialize(results, log_level)
+        @results = results
+        @log_level = log_level
+      end
+
+      def write?(status)
+        status == :fail || log_level == 'DEBUG'
+      end
+
+      def self.write(results, log_level)
+        new(results, log_level).write
+      end
+    end
+  end
+end

data/lib/database_consistency/writers/simple_writer.rb

@@ -0,0 +1,26 @@
+module DatabaseConsistency
+  # The module contains formatters
+  module Writers
+    # The simplest formatter
+    class SimpleWriter < BaseWriter
+      def write
+        puts format
+      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")
+      end
+
+      def line(model_name, comparison)
+        <<-TEXT
+          #{comparison[:status]} #{comparison[:message]} #{model_name} #{comparison[:validator].inspect} #{comparison[:column].inspect}
+        TEXT
+      end
+    end
+  end
+end

data/lib/database_consistency.rb

@@ -0,0 +1,22 @@
+require 'active_record'
+
+require 'database_consistency/version'
+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'
+
+# The root module
+module DatabaseConsistency
+  def self.run
+    Helper.load_environment!
+
+    Writers::SimpleWriter.write(
+      Processor.new.comparisons,
+      ENV['LOG_LEVEL'] || 'INFO'
+    )
+  end
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: database_consistency
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Evgeniy Demin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.55'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.55'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: 
+email:
+- lawliet.djez@gmail.com
+executables:
+- database_consistency
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/database_consistency
+- lib/database_consistency.rb
+- lib/database_consistency/comparators/base_comparator.rb
+- lib/database_consistency/comparators/presence_comparator.rb
+- lib/database_consistency/comparison.rb
+- lib/database_consistency/helper.rb
+- lib/database_consistency/processor.rb
+- lib/database_consistency/version.rb
+- lib/database_consistency/writers/base_writer.rb
+- lib/database_consistency/writers/simple_writer.rb
+homepage: https://github.com/djezzzl/database_consistency
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Provide an easy way to check the consistency of the database constraints
+  with the application validations.
+test_files: []