database_consistency 0.7.6 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 149d7592b96f1f028881570c9fc3d4c25205361758eaa81de99ee583efad3cab
-  data.tar.gz: 1337cc3b1c115f660906663ee975afedc57308c48cc6b53d02cb6cc52494e8d1
+  metadata.gz: 20658faa1cdd6ae16c25dd7a9b2b85b608f81e2da8ffeb74f8f692ad5c8eb6cb
+  data.tar.gz: 7a6c555f10de5253af9744eea4ada2c95525dd127d081e939ffa6ad6c4923bab
 SHA512:
-  metadata.gz: b1f1c9f3d7b598ea7a2d9c0656aed100e8dc3d685316914f769f77f462c49b39541d6aea53552ef123cc05a0b5b6c01750e2951f7b7bd4495a9ddf42b0b76ba2
-  data.tar.gz: 9c781f382b1cbb7180daf21788648d0afd68f581132e69456a3c34a9580d3bc1d0bf85ed4dce8007cb8922fe9a7222efac4b624f56ea87d48c5315931d476603
+  metadata.gz: 95ff5510806f67c8e612c488c608f2685e1abebbb3ecba455e706db34a104ab9c1135cac0193692884a7cb9f61301c91e0a27ea07d61eb08a3b89ca3dd5d952d
+  data.tar.gz: 75a78627604fec92c8fd3703c70fa35e125139e188adf1d8592a480fcef44a50a6b4f670f2eaae139dd07c03ca397745b437d44fcdc35f96ea44b41aaaab6b7d

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 with nil,
+      # or BelongsTo association using this column
       def check
         if valid?
           report_template(:ok)
@@ -37,6 +38,7 @@ module DatabaseConsistency
       def valid?
         validator?(ActiveModel::Validations::PresenceValidator) ||
           validator?(ActiveModel::Validations::InclusionValidator) ||
+          nil_exclusion_validator? ||
           belongs_to_association?
       end
 
@@ -48,6 +50,13 @@ 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 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/associations_processor.rb

@@ -12,7 +12,7 @@ module DatabaseConsistency
 
       def check
         Helper.models.flat_map do |model|
-          next unless configuration.enabled?(model)
+          next unless configuration.enabled?(model.name.to_s)
 
           Helper.first_level_associations(model).flat_map do |association|
             enabled_checkers.map do |checker_class|

data/lib/database_consistency/processors/columns_processor.rb

@@ -6,14 +6,15 @@ module DatabaseConsistency
     class ColumnsProcessor < BaseProcessor
       CHECKERS = [
         Checkers::NullConstraintChecker,
-        Checkers::LengthConstraintChecker
+        Checkers::LengthConstraintChecker,
+        Checkers::PrimaryKeyTypeChecker
       ].freeze
 
       private
 
       def check
         Helper.parent_models.flat_map do |model|
-          next unless configuration.enabled?(model)
+          next unless configuration.enabled?(model.name.to_s)
 
           model.columns.flat_map do |column|
             enabled_checkers.map do |checker_class|

data/lib/database_consistency/processors/validators_fractions_processor.rb

@@ -13,7 +13,7 @@ module DatabaseConsistency
       # @return [Array<Hash>]
       def check
         Helper.parent_models.flat_map do |model|
-          next unless configuration.enabled?(model)
+          next unless configuration.enabled?(model.name.to_s)
 
           model._validators.flat_map do |attribute, validators|
             next unless attribute

data/lib/database_consistency/processors/validators_processor.rb

@@ -14,7 +14,7 @@ module DatabaseConsistency
       # @return [Array<Hash>]
       def check # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
         Helper.parent_models.flat_map do |model|
-          next unless configuration.enabled?(model)
+          next unless configuration.enabled?(model.name.to_s)
 
           model.validators.flat_map do |validator|
             next unless validator.respond_to?(:attributes)

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.6'
+  VERSION = '0.8.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: database_consistency
 version: !ruby/object:Gem::Version
-  version: 0.7.6
+  version: 0.8.1
 platform: ruby
 authors:
 - Evgeniy Demin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-16 00:00:00.000000000 Z
+date: 2020-06-03 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
@@ -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