active_record_auto_validations 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0f8bdbdb695e04d78b7e03badf31c5bda8ba83a299c64e05bd674f7ebee5309
-  data.tar.gz: d0db6d6605807a16c0cef57488011e440da7f148c74e499c69473576054df564
+  metadata.gz: d82df8dff2fe3dd3b03523499df936304e262721ea812792749059393602b662
+  data.tar.gz: 2f34c86ef85893c79c215c8227458ab42e0503c46cca848527ddef8f71dc1642
 SHA512:
-  metadata.gz: 3a2888303307eb73773a4136d5d1d4d30f1b25476d6ee5047b8a6399e2d94e36944d8d0c1c3cc9765f16e4879425fc185fcd39c001e15024f567bc94f13f25bb
-  data.tar.gz: ab897c30fa03d44438ae8393bf35583bc1c471b0dfe046a94282f14c54b8be157f03a063b9df5bc4f02c575e6eaf3eed0b00b3651383c43d6dc230afba9d78be
+  metadata.gz: a3cee5f5a370c5c800efc0976eea8a350bb08d75bb9eab11d6fab4446d7ca2eab18096777daeff71f790bf51dd228c2a6c12e1d961c4eeda03541f1055f2be11
+  data.tar.gz: f2eb99db19909b63de9de904a86f0dc9b119117c6391b27d5595e8b0ca0ad5c4013b3bfa164a2314dafe393e315ca148db60206f2a99fb79d593da69c382608f

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

@@ -0,0 +1,11 @@
+module ActiveRecordAutoValidations::ModelConcern
+  extend ActiveSupport::Concern
+
+  included do |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

@@ -0,0 +1,103 @@
+class ActiveRecordAutoValidations::AutoValidateModelClass
+  attr_reader :model_class
+
+  def self.execute!(model_class:)
+    ActiveRecordAutoValidations::AutoValidateModelClass.new(model_class: model_class).perform
+  end
+
+  def initialize(model_class:)
+    @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
+    end
+
+    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 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"
+
+      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 unless index.unique
+
+      # Dont add uniqueness validation to ActsAsList position columns
+      if index.columns.include?("position") && model_class.respond_to?(:acts_as_list_top)
+        Rails.logger.info { "AutoValidate: Skipping unique validation on #{model_class.table_name}##{index.columns.join(",")} because it looks like ActsAsList" }
+        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? && !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}" }
+    model_class.validates column.name.to_sym, presence: true
+  end
+
+  def auto_validate_max_length_on_column?(column)
+    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}" }
+    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.1"
+  VERSION = "0.0.3".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.1
+  version: 0.0.3
 platform: ruby
 authors:
 - kaspernj
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-19 00:00:00.000000000 Z
+date: 2022-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,6 +24,104 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 7.0.3
+- !ruby/object:Gem::Dependency
+  name: dotenv-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Scans ActiveRecord models and adds automatic validations based on null,
   max length etc.
 email:
@@ -35,21 +133,15 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- app/assets/config/auto_validations_manifest.js
-- app/assets/stylesheets/auto_validations/application.css
-- app/controllers/auto_validations/application_controller.rb
-- app/helpers/auto_validations/application_helper.rb
-- app/jobs/auto_validations/application_job.rb
-- app/mailers/auto_validations/application_mailer.rb
-- app/models/auto_validations/application_record.rb
-- app/models/concerns/auto_validations/model_concern.rb
-- app/services/auto_validations/auto_validate_model_class.rb
-- app/views/layouts/auto_validations/application.html.erb
+- 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/services/active_record_auto_validations/on_load.rb
 - config/routes.rb
 - lib/active_record_auto_validations.rb
 - lib/active_record_auto_validations/engine.rb
 - lib/active_record_auto_validations/version.rb
-- lib/tasks/auto_validations_tasks.rake
+- lib/tasks/active_record_auto_validations_tasks.rake
 homepage: https://github.com/kaspernj/active_record_auto_validations
 licenses:
 - MIT
@@ -57,6 +149,7 @@ 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
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:

data/app/assets/config/auto_validations_manifest.js

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

data/app/assets/stylesheets/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/auto_validations/application_controller.rb

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

data/app/helpers/auto_validations/application_helper.rb

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

data/app/jobs/auto_validations/application_job.rb

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

data/app/mailers/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/auto_validations/application_record.rb

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

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

@@ -1,7 +0,0 @@
-module ActiveRecordAutoValidations::ModelConcern
-  extend ActiveSupport::Concern
-
-  included do |base|
-    ActiveRecordAutoValidations::AutoValidateModelClass.execute!(model_class: base)
-  end
-end

data/app/services/auto_validations/auto_validate_model_class.rb

@@ -1,51 +0,0 @@
-class ActiveRecordAutoValidations::AutoValidateModelClass < ApplicationService
-  attr_reader :model_class
-
-  def initialize(model_class:)
-    @model_class = model_class
-  end
-
-  def perform
-    begin
-      columns
-    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!
-    end
-
-    insert_active_record_auto_validations!
-    succeed!
-  end
-
-  def columns
-    @columns ||= model_class.columns
-  end
-
-  def insert_active_record_auto_validations!
-    columns.each do |column|
-      next if column.name == "id" || column.name == "created_at" || column.name == "updated_at"
-
-      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 auto_validate_presence_on_column?(column)
-    !column.null && !column.name.end_with?("_id") && column.default.nil?
-  end
-
-  def auto_validate_pesence_on_column!(column)
-    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
-  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}"
-    model_class.validates column.name.to_sym, allow_blank: true, length: {maximum: column.limit}
-  end
-end

data/app/views/layouts/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>