database_consistency 0.7.7 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f15517720ae0fd28c696d2dd01ca86902697f4a97186c89c3ba76e6b44d6cbf4
-  data.tar.gz: b3e33ba7fdaf1708439b549d281e98ae64616b2f77c86c7268525425cc8c0ebc
+  metadata.gz: 96d59f04ee02179f11d92477feb260aaa444c9b923ecbc142aa2b69ca12b3808
+  data.tar.gz: 6c79bf6d628c470a45976047ffcc608bddf07ff610f802a04542462b36ae4421
 SHA512:
-  metadata.gz: 77422c0e1f2cf072e3bbf680112720d6d4672a92b58eebd47498e0a9695f127a0720620cbf6d49de1d376fb6dd4e07e03b005430ed86703e5d61e86e360e0e8f
-  data.tar.gz: 5250dbd31fccde527c5520861d8ddfd5ada707d1484fc8bcf06b4954dd8792c903778e30967193db06d5664f20bc3b022107105db016bb17b2be6fcac5bc00cd
+  metadata.gz: 2c563868a70b3dd6cd1fe7d3f62481e6dee156c75a42a22f7e6ee43ce41d5ad08d6742d099c0a145a2b331726282ec2a71234ab1194361af655f18120e9c1b48
+  data.tar.gz: 4ccdf6f7647b4aac78a7378a15d7796f5ed35997f7f59ec77176ebbc55019faf3a0581852e52d529d7c11aa8d8f59a495295445ed39e0a81a2ec0b6a41f638e5

data/bin/database_consistency

@@ -1,9 +1,25 @@
 #!/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"
+if ARGV.include?('install')
+  require_relative '../lib/database_consistency/configuration'
+  config_filename = DatabaseConsistency::Configuration::CONFIGURATION_PATH
+  file_exists = File.exists?(config_filename)
+  rules = Pathname.new(__FILE__).dirname.join('..', 'lib', 'database_consistency', 'templates', 'rails_defaults.yml').read
+  if file_exists && File.foreach(config_filename).grep(Regexp.new(rules.lines.first.chomp)).any?
+    puts "#{config_filename} is already present"
+  else
+    File.open(config_filename, 'a') do |file|
+      file << "\n" * 2 if file_exists
+      file << rules
+    end
+    puts "#{config_filename} #{file_exists ? 'updated' : 'added'}"
+  end
+  exit 0
+else
+  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
 end
 
 # Load Rails project

data/lib/database_consistency.rb

@@ -11,14 +11,19 @@ require 'database_consistency/writers/base_writer'
 require 'database_consistency/writers/simple_writer'
 
 require 'database_consistency/checkers/base_checker'
+
 require 'database_consistency/checkers/association_checkers/association_checker'
 require 'database_consistency/checkers/association_checkers/missing_index_checker'
+
 require 'database_consistency/checkers/column_checkers/column_checker'
 require 'database_consistency/checkers/column_checkers/null_constraint_checker'
 require 'database_consistency/checkers/column_checkers/length_constraint_checker'
+require 'database_consistency/checkers/column_checkers/primary_key_type_checker'
+
 require 'database_consistency/checkers/validator_checkers/validator_checker'
 require 'database_consistency/checkers/validator_checkers/belongs_to_presence_checker'
 require 'database_consistency/checkers/validator_checkers/missing_unique_index_checker'
+
 require 'database_consistency/checkers/validators_fraction_checkers/validators_fraction_checker'
 require 'database_consistency/checkers/validators_fraction_checkers/column_presence_checker'
 

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

@@ -25,7 +25,8 @@ module DatabaseConsistency
       # | provided   | ok     |
       # | missing    | fail   |
       #
-      # We consider PresenceValidation, InclusionValidation or BelongsTo association using this column
+      # We consider PresenceValidation, InclusionValidation, ExclusionValidation, NumericalityValidator with nil,
+      # or BelongsTo association using this column
       def check
         if valid?
           report_template(:ok)
@@ -37,6 +38,8 @@ module DatabaseConsistency
       def valid?
         validator?(ActiveModel::Validations::PresenceValidator) ||
           validator?(ActiveModel::Validations::InclusionValidator) ||
+          numericality_validator_without_allow_nil? ||
+          nil_exclusion_validator? ||
           belongs_to_association?
       end
 
@@ -48,6 +51,20 @@ module DatabaseConsistency
         model.record_timestamps? && %w[created_at updated_at].include?(column.name)
       end
 
+      def nil_exclusion_validator?
+        model.validators.grep(ActiveModel::Validations::ExclusionValidator).any? do |validator|
+          Helper.check_inclusion?(validator.attributes, column.name) &&
+            validator.options[:in].include?(nil)
+        end
+      end
+
+      def numericality_validator_without_allow_nil?
+        model.validators.grep(ActiveModel::Validations::NumericalityValidator).any? do |validator|
+          Helper.check_inclusion?(validator.attributes, column.name) &&
+            !validator.options[:allow_nil]
+        end
+      end
+
       def validator?(validator_class)
         model.validators.grep(validator_class).any? do |validator|
           Helper.check_inclusion?(validator.attributes, column.name)

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

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module DatabaseConsistency
+  module Checkers
+    # This class checks missing presence validator
+    class PrimaryKeyTypeChecker < ColumnChecker
+      # Message templates
+      VALIDATOR_MISSING = 'column has int/serial type but recommended to have bigint/bigserial/uuid'
+
+      private
+
+      VALID_TYPES = %w[bigserial bigint uuid].freeze
+      SQLITE_ADAPTER_NAME = 'SQLite'
+
+      # We skip check when:
+      #  - column is not a primary key
+      #  - database is SQLite3
+      def preconditions
+        primary_field? && !sqlite?
+      end
+
+      # Table of possible statuses
+      # | bigint/bigserial/uuid | status |
+      # | --------------------- | ------ |
+      # | yes                   | ok     |
+      # | no                    | fail   |
+      def check
+        if valid?
+          report_template(:ok)
+        else
+          report_template(:fail, VALIDATOR_MISSING)
+        end
+      end
+
+      # @return [Boolean]
+      def valid?
+        VALID_TYPES.any? do |type|
+          column.sql_type.to_s.match?(type)
+        end
+      end
+
+      # @return [Boolean]
+      def primary_field?
+        column.name.to_s == model.primary_key.to_s
+      end
+
+      # @return [Boolean]
+      def sqlite?
+        model.connection.adapter_name == SQLITE_ADAPTER_NAME
+      end
+    end
+  end
+end

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

@@ -13,7 +13,7 @@ module DatabaseConsistency
       #  - there is no belongs_to association with given name
       #  - belongs_to association is polymorphic
       def preconditions
-        validator.kind == :presence && association && !association.polymorphic?
+        validator.kind == :presence && association && association.belongs_to? && !association.polymorphic?
       end
 
       # Table of possible statuses

data/lib/database_consistency/processors/columns_processor.rb

@@ -6,7 +6,8 @@ module DatabaseConsistency
     class ColumnsProcessor < BaseProcessor
       CHECKERS = [
         Checkers::NullConstraintChecker,
-        Checkers::LengthConstraintChecker
+        Checkers::LengthConstraintChecker,
+        Checkers::PrimaryKeyTypeChecker
       ].freeze
 
       private

data/lib/database_consistency/templates/rails_defaults.yml

@@ -0,0 +1,7 @@
+# Ignore false positive from Rails' ActionText and ActiveStorage
+ActionText::RichText:
+  enabled: false
+ActiveStorage::Attachment:
+  enabled: false
+ActiveStorage::Blob:
+  enabled: false

data/lib/database_consistency/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: database_consistency
 version: !ruby/object:Gem::Version
-  version: 0.7.7
+  version: 0.8.2
 platform: ruby
 authors:
 - Evgeniy Demin
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-29 00:00:00.000000000 Z
+date: 2020-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -70,16 +70,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -122,7 +122,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
-description: 
+description:
 email:
 - lawliet.djez@gmail.com
 executables:
@@ -138,6 +138,7 @@ files:
 - lib/database_consistency/checkers/column_checkers/column_checker.rb
 - lib/database_consistency/checkers/column_checkers/length_constraint_checker.rb
 - lib/database_consistency/checkers/column_checkers/null_constraint_checker.rb
+- lib/database_consistency/checkers/column_checkers/primary_key_type_checker.rb
 - lib/database_consistency/checkers/validator_checkers/belongs_to_presence_checker.rb
 - lib/database_consistency/checkers/validator_checkers/missing_unique_index_checker.rb
 - lib/database_consistency/checkers/validator_checkers/validator_checker.rb
@@ -151,6 +152,7 @@ files:
 - lib/database_consistency/processors/validators_fractions_processor.rb
 - lib/database_consistency/processors/validators_processor.rb
 - lib/database_consistency/rescue_error.rb
+- lib/database_consistency/templates/rails_defaults.yml
 - lib/database_consistency/version.rb
 - lib/database_consistency/writers/base_writer.rb
 - lib/database_consistency/writers/simple_writer.rb
@@ -158,7 +160,7 @@ homepage: https://github.com/djezzzl/database_consistency
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -173,9 +175,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.9
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Provide an easy way to check the consistency of the database constraints
   with the application validations.