active_record_auto_validations 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db14026d46494a83057c52f72b6bc2d7c61e9bea8321d3f25830a04ccf4a01a0
-  data.tar.gz: 989f1988c0b10ae172a9735705458025db3c141349b1324e75278e7178681097
+  metadata.gz: fed3fd2ca11387161a5229a84c3a2830e75ecfccccb690f7e3df623d1b7860b0
+  data.tar.gz: cbce1703024f0281fd689a87f135b5ee3c197d4fa282ff8937790748e160823c
 SHA512:
-  metadata.gz: c57baea430f577cecdfb69d9890d2ebcee10662dd0dac05eb3e0baca884f2499bfabfd2867940f6af3ce168373a983f403af5e269f9df6866afa0bd7f07cb091
-  data.tar.gz: f4c749d363d248d89733da4d9260eb2a01df123afd23cf1c74ac6aefe3b366596dbd306f04f2c2a77a3c2b490ee2ae557d159fc79ff92400859ecec1dfbc11bc
+  metadata.gz: 6f3f3022a614e737fd610d50ece642e8d8b5db811cb5e5a4a8c228935e3103b266480a16ad71f0ecce1591ef6614c1d7b258cfdc6af9a22720e7c1c1e238c5e4
+  data.tar.gz: 95f0eaf31a5ae94683bd686c0677ac783f02a6c36ef816a20fdfbe74c7c6a2ce673366d4fbed1df40c13aa7bd48dd2b494977085bc0079a6cf010f7c46d1d362

data/README.md

@@ -21,6 +21,32 @@ Or install it yourself as:
 $ gem install active_record_auto_validations
 ```
 
+Add this initializer:
+```ruby
+Rails.autoloaders.main.on_load do |_klass_name, klass, _defined_by_file|
+  ActiveRecordAutoValidations::OnLoad.execute!(klass: klass)
+end
+```
+
+To run auto-validations on all models you can add something like this to ApplicationRecord:
+```ruby
+class ApplicationRecord < ActiveRecord::Base
+  primary_abstract_class
+
+  def self.inherited(child)
+    super
+    child.include ActiveRecordAutoValidations::ModelConcern
+  end
+end
+```
+
+To run auto-validations on a single model you can do this:
+```ruby
+class Project < ApplicationRecord
+  include ActiveRecordAutoValidations::ModelConcern
+end
+```
+
 ## Contributing
 Contribution directions go here.
 

data/app/models/concerns/active_record_auto_validations/model_concern.rb

@@ -2,6 +2,10 @@ module ActiveRecordAutoValidations::ModelConcern
   extend ActiveSupport::Concern
 
   included do |base|
-    ActiveRecordAutoValidations::AutoValidateModelClass.execute!(model_class: base)
+    # The actual loading needs to be done after the model has been fully loaded,
+    # so this is actually done through a "on_load"-callback in an initializer.
+    #
+    # Kind of a hack but haven't been able to find another way of doing this
+    base.instance_variable_set(:@active_record_auto_validations_marked, true)
   end
 end

data/app/services/active_record_auto_validations/auto_unique_index.rb

@@ -0,0 +1,41 @@
+class ActiveRecordAutoValidations::AutoUniqueIndex
+  def self.execute!(**args)
+    ActiveRecordAutoValidations::AutoUniqueIndex.new(**args).perform
+  end
+
+  attr_reader :columns, :index, :model_class
+
+  def initialize(columns:, index:, model_class:)
+    @columns = columns
+    @index = index
+    @model_class = model_class
+  end
+
+  def perform
+    model_class.validates last_column_name.to_sym, **validates_args
+  end
+
+  def index_columns
+    @index_columns ||= index.columns.map { |column_name| columns.find { |column| column.name == column_name } }
+  end
+
+  def last_column_name
+    @last_column_name ||= index.columns.last
+  end
+
+  def validates_args
+    rest_of_columns = index.columns.clone
+    rest_of_columns.pop
+
+    validates_args = {}
+
+    if rest_of_columns.length.positive?
+      validates_args[:uniqueness] ||= {}
+      validates_args[:uniqueness][:scope] = rest_of_columns
+    end
+
+    validates_args[:allow_blank] = true if index_columns.any?(&:null)
+    validates_args[:uniqueness] ||= true
+    validates_args
+  end
+end

data/app/services/active_record_auto_validations/auto_validate_model_class.rb

@@ -1,51 +1,119 @@
-class ActiveRecordAutoValidations::AutoValidateModelClass < ApplicationService
-  attr_reader :model_class
+class ActiveRecordAutoValidations::AutoValidateModelClass
+  attr_reader :ignore_column_names, :model_class
 
-  def initialize(model_class:)
+  def self.execute!(...)
+    ActiveRecordAutoValidations::AutoValidateModelClass.new(...).perform
+  end
+
+  def initialize(model_class:, ignore_column_names: [])
+    @ignore_column_names = ignore_column_names
     @model_class = model_class
   end
 
   def perform
+    check_if_already_loaded_on_model_class!
+    register_loaded_on_model_class!
+
     begin
       columns
+      indexes
     rescue ActiveRecord::StatementInvalid => e
       # Database is probably not running - we need to ignore this to make stuff like db:migrate, db:schema:load work
-      Rails.logger.error "AutoValidate: Ignoring error while loading columns, because database might not be initialized: #{e.message}"
-      return succeed!
+      Rails.logger.info { "AutoValidate: Ignoring error while loading columns, because database might not be initialized: #{e.message}" }
+      return
     end
 
-    insert_active_record_auto_validations!
-    succeed!
+    insert_active_record_auto_validations_from_columns!
+    insert_active_record_auto_validations_from_indexes!
+  end
+
+  def check_if_already_loaded_on_model_class!
+    auto_validations_loaded = model_class.instance_variable_get(:@_active_record_auto_validations_loaded)
+
+    raise "AutoValidations already loaded for #{model_class.name}" if auto_validations_loaded
+  end
+
+  def register_loaded_on_model_class!
+    model_class.instance_variable_set(:@_active_record_auto_validations_loaded, true)
   end
 
   def columns
     @columns ||= model_class.columns
   end
 
-  def insert_active_record_auto_validations!
+  def ignore_column?(column_name)
+    return true if column_name == "id" || column_name == "created_at" || column_name == "updated_at"
+
+    ignore_column_names.include?(column_name)
+  end
+
+  def ignore_index?(index)
+    return true unless index.unique
+
+    index.columns.any? { |index_column_name| ignore_column?(index_column_name) }
+  end
+
+  def indexes
+    @indexes ||= model_class.connection.indexes(model_class.table_name)
+  end
+
+  def insert_active_record_auto_validations_from_columns!
     columns.each do |column|
-      next if column.name == "id" || column.name == "created_at" || column.name == "updated_at"
+      next if ignore_column?(column.name)
 
       auto_validate_pesence_on_column!(column) if auto_validate_presence_on_column?(column)
       auto_validate_max_length_on_column!(column) if auto_validate_max_length_on_column?(column)
     end
   end
 
+  def insert_active_record_auto_validations_from_indexes!
+    indexes.each do |index|
+      next if ignore_index?(index)
+
+      # Dont add uniqueness validation to ActsAsList position columns
+      if index.columns.include?("position") && model_class.respond_to?(:acts_as_list_top)
+        Rails.logger.info do
+          "AutoValidate: Skipping unique validation on #{model_class.table_name}##{index.columns.join(",")} because it looks like ActsAsList"
+        end
+
+        next
+      end
+
+      ActiveRecordAutoValidations::AutoUniqueIndex.execute!(columns: columns, model_class: model_class, index: index)
+    end
+  end
+
+  def presence_validation_exists_on_column?(column)
+    model_class.validators_on(column.name.to_sym).each do |validator|
+      return true if validator.kind == :presence
+    end
+
+    false
+  end
+
   def auto_validate_presence_on_column?(column)
-    !column.null && !column.name.end_with?("_id") && column.default.nil?
+    !column.null && !column.name.end_with?("_id") && column.default.nil? && column.default_function.nil? && !presence_validation_exists_on_column?(column)
   end
 
   def auto_validate_pesence_on_column!(column)
-    Rails.logger.info "AutoValidate: Adding presence validation to #{model_class.table_name}##{column.name}"
+    Rails.logger.info { "AutoValidate: Adding presence validation to #{model_class.table_name}##{column.name}" }
     model_class.validates column.name.to_sym, presence: true
   end
 
   def auto_validate_max_length_on_column?(column)
-    column.type == :string && column.limit
+    column.type == :string && column.limit && !max_length_validation_exists_on_column?(column)
   end
 
   def auto_validate_max_length_on_column!(column)
-    Rails.logger.info "AutoValidate: Adding maxlength of #{column.limit} validation to #{model_class.table_name}##{column.name}"
+    Rails.logger.info { "AutoValidate: Adding maxlength of #{column.limit} validation to #{model_class.table_name}##{column.name}" }
     model_class.validates column.name.to_sym, allow_blank: true, length: {maximum: column.limit}
   end
+
+  def max_length_validation_exists_on_column?(column)
+    model_class.validators_on(column.name.to_sym).each do |validator|
+      return true if validator.kind == :length
+    end
+
+    false
+  end
 end

data/app/services/active_record_auto_validations/on_load.rb

@@ -0,0 +1,9 @@
+class ActiveRecordAutoValidations::OnLoad
+  def self.execute!(klass:)
+    # This callback is going to be called for all classes. We should only run auto-validations on the ones that have had the module included
+    # which is done through the marked-variable.
+    marked = klass.instance_variable_get(:@active_record_auto_validations_marked)
+
+    ActiveRecordAutoValidations::AutoValidateModelClass.execute!(model_class: klass) if marked
+  end
+end

data/config/routes.rb

@@ -1,2 +1,2 @@
-ActiveRecordAutoValidations::Engine.routes.draw do
+ActiveRecordAutoValidations::Engine.routes.draw do # rubocop:disable Lint/EmptyBlock
 end

data/lib/active_record_auto_validations/engine.rb

@@ -1,5 +1,5 @@
-module ActiveRecordAutoValidations
-  class Engine < ::Rails::Engine
-    isolate_namespace ActiveRecordAutoValidations
-  end
+module ActiveRecordAutoValidations; end
+
+class ActiveRecordAutoValidations::Engine < Rails::Engine
+  isolate_namespace ActiveRecordAutoValidations
 end

data/lib/active_record_auto_validations/version.rb

@@ -1,3 +1,3 @@
 module ActiveRecordAutoValidations
-  VERSION = "0.0.2"
+  VERSION = "0.0.4".freeze
 end

data/lib/active_record_auto_validations.rb

@@ -2,5 +2,4 @@ require "active_record_auto_validations/version"
 require "active_record_auto_validations/engine"
 
 module ActiveRecordAutoValidations
-  # Your code goes here...
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_record_auto_validations
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - kaspernj
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-19 00:00:00.000000000 Z
+date: 2024-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -35,16 +35,10 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- app/assets/config/active_record_auto_validations_manifest.js
-- app/assets/stylesheets/active_record_auto_validations/application.css
-- app/controllers/active_record_auto_validations/application_controller.rb
-- app/helpers/active_record_auto_validations/application_helper.rb
-- app/jobs/active_record_auto_validations/application_job.rb
-- app/mailers/active_record_auto_validations/application_mailer.rb
-- app/models/active_record_auto_validations/application_record.rb
 - app/models/concerns/active_record_auto_validations/model_concern.rb
+- app/services/active_record_auto_validations/auto_unique_index.rb
 - app/services/active_record_auto_validations/auto_validate_model_class.rb
-- app/views/layouts/active_record_auto_validations/application.html.erb
+- app/services/active_record_auto_validations/on_load.rb
 - config/routes.rb
 - lib/active_record_auto_validations.rb
 - lib/active_record_auto_validations/engine.rb
@@ -57,7 +51,8 @@ metadata:
   homepage_uri: https://github.com/kaspernj/active_record_auto_validations
   source_code_uri: https://github.com/kaspernj/active_record_auto_validations
   changelog_uri: https://github.com/kaspernj/active_record_auto_validations
-post_install_message: 
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -72,8 +67,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: Scans ActiveRecord models and adds automatic validations based on null, max
   length etc.

data/app/assets/config/active_record_auto_validations_manifest.js

@@ -1 +0,0 @@
-//= link_directory ../stylesheets/active_record_auto_validations .css

data/app/assets/stylesheets/active_record_auto_validations/application.css

@@ -1,15 +0,0 @@
-/*
- * This is a manifest file that'll be compiled into application.css, which will include all the files
- * listed below.
- *
- * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
- * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
- *
- * You're free to add application-wide styles to this file and they'll appear at the bottom of the
- * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
- * files in this directory. Styles in this file should be added after the last require_* statement.
- * It is generally better to create a new file per style scope.
- *
- *= require_tree .
- *= require_self
- */

data/app/controllers/active_record_auto_validations/application_controller.rb

@@ -1,4 +0,0 @@
-module ActiveRecordAutoValidations
-  class ApplicationController < ActionController::Base
-  end
-end

data/app/helpers/active_record_auto_validations/application_helper.rb

@@ -1,4 +0,0 @@
-module ActiveRecordAutoValidations
-  module ApplicationHelper
-  end
-end

data/app/jobs/active_record_auto_validations/application_job.rb

@@ -1,4 +0,0 @@
-module ActiveRecordAutoValidations
-  class ApplicationJob < ActiveJob::Base
-  end
-end

data/app/mailers/active_record_auto_validations/application_mailer.rb

@@ -1,6 +0,0 @@
-module ActiveRecordAutoValidations
-  class ApplicationMailer < ActionMailer::Base
-    default from: "from@example.com"
-    layout "mailer"
-  end
-end

data/app/models/active_record_auto_validations/application_record.rb

@@ -1,5 +0,0 @@
-module ActiveRecordAutoValidations
-  class ApplicationRecord < ActiveRecord::Base
-    self.abstract_class = true
-  end
-end

data/app/views/layouts/active_record_auto_validations/application.html.erb

@@ -1,15 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <title>Auto validations</title>
-  <%= csrf_meta_tags %>
-  <%= csp_meta_tag %>
-
-  <%= stylesheet_link_tag    "active_record_auto_validations/application", media: "all" %>
-</head>
-<body>
-
-<%= yield %>
-
-</body>
-</html>