database_consistency 0.7.8 → 0.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3b93b80d81b10da730dbaf8cc523325150103fcae0f18ea4092baa03d8fb8ba
-  data.tar.gz: 67a8a38c922d359f11699b703a340489a866e573b8714f1848bfee7900ecb280
+  metadata.gz: 5015849cbfceb5d46a68ab0c3f9ba0e620fffbf013c16af563d3aa8fd16b140f
+  data.tar.gz: dd379822c590457db98fd9f23fe99f19868063cf994e804eec11fe61b7311105
 SHA512:
-  metadata.gz: 187968d380947ce829f765bac635720b959346c53b3ef81a99eadb1555395767d457fcbb5fd325010656b418867d1b916170cf0bc5cf265e69c9228e61d1a01e
-  data.tar.gz: 724d34742874b0b1f6e864dabe98624702409a26d39467292d64490d0757e4e4f7bfe428d0b6e9bf629ccac99abaaf1ba623cf674e1fd00215df5f39c200a512
+  metadata.gz: 3ec317d549f0852e6396db14f7263904448a3dda2c2515f83a174946a9d8138163f909b078a235a41c5d36daa01bbc38cd61c03f23921d3ad8704c7742e7fcec
+  data.tar.gz: 8c41bdf53040283417a3d616e9cf9b13a34138ba17edf65b84df1506e630e758d88995a618ea2b111a8d45884c49bf8b4e5f9b2c38e16fbfdd379328260aa0f1

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/missing_unique_index_checker.rb

@@ -48,7 +48,13 @@ module DatabaseConsistency
       end
 
       def index_columns
-        @index_columns ||= ([wrapped_attribute_name] + Array.wrap(validator.options[:scope])).map(&:to_s)
+        @index_columns ||= ([wrapped_attribute_name] + scope_columns).map(&:to_s)
+      end
+
+      def scope_columns
+        @scope_columns ||= Array.wrap(validator.options[:scope]).map do |scope_item|
+          model._reflect_on_association(scope_item)&.foreign_key || scope_item
+        end
       end
 
       def sorted_index_columns

data/lib/database_consistency/checkers/validators_fraction_checkers/column_presence_checker.rb

@@ -4,7 +4,7 @@ module DatabaseConsistency
   module Checkers
     # This class checks if presence validator has non-null constraint in the database
     class ColumnPresenceChecker < ValidatorsFractionChecker
-      WEAK_OPTIONS = %i[allow_nil allow_blank if unless].freeze
+      WEAK_OPTIONS = %i[allow_nil allow_blank if unless on].freeze
       # Message templates
       CONSTRAINT_MISSING = 'column should be required in the database'
       POSSIBLE_NULL = 'column is required but there is possible null value insert'

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.8'
+  VERSION = '0.8.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: database_consistency
 version: !ruby/object:Gem::Version
-  version: 0.7.8
+  version: 0.8.3
 platform: ruby
 authors:
 - Evgeniy Demin
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-02-02 00:00:00.000000000 Z
+date: 2020-06-24 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.