action_validator 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 532de573ba9a7413bdfc6ffa8740a6ee28226d95ade42b47855fc5ab269fb01c
-  data.tar.gz: db4a16bf7690207e95bcb04503ca38f13512cc04d0a7acca5252a135bc32de3a
+  metadata.gz: 4aaba049d97346476208fb2f0f732a068c6ab921e369424507f45360fffe45e6
+  data.tar.gz: 370ca30364a45c315341897690e5e7abb5789f49e4b4325d3fe2db717c024a8b
 SHA512:
-  metadata.gz: b107cc5fdfef31a1b03cf762f4e18b3cf576de2c1bb060a5dbce9b3c577b8b1412e1c2329990b5e63ffd2d5e19bb658d146a249212213ef80c7617e646b4b183
-  data.tar.gz: 500aa58f0c13bde306b4bfe682cb285819e53ba3cfea8ea71e58210d527b8cab134c01e2fbecdcfde122c8b8778e821e90357ea2759ade1f89287f57176ce2e6
+  metadata.gz: d875711628f3f58dc72fd06d4269a8a639a86022e40035dd799b75f4f548c7c0c5311fc83afc415bac190d0c895f3cbe71b52a7589362bc268004c253640c0d8
+  data.tar.gz: fc7e2dffa723cfd2b685cb7898b1d2b2cd2eb155dc8140264764cc9057ea43dc00b54fc89d2831aaf00a62d8aad582545861795852703baaab323c284e6e3e8e

data/app/channels/action_validator/form_channel.rb

@@ -14,16 +14,19 @@ module ActionValidator
     end
 
     def validate(data)
-      model_class, params = parse_params(data["formData"])
-      if model_class.nil?
-        Rails.logger.warn("No valid model class found, cannot perform remote validation.")
-        ActionCable.server.broadcast("action_validator_form_channel", { errors: {} })
-        return
-      end
+      Rails.logger.tagged("ActionValidator") do
+        model_class, params = parse_params(data["formData"])
+
+        if model_class.nil?
+          Rails.logger.warn("No valid model class found, cannot perform remote validation.")
+          ActionCable.server.broadcast("action_validator_form_channel", { errors: {} })
+          return
+        end
 
-      instance = validated_instance(model_class, params)
+        instance = validated_instance(model_class, params)
 
-      ActionCable.server.broadcast("action_validator_form_channel", { errors: parse_model_errors(instance) })
+        ActionCable.server.broadcast("action_validator_form_channel", { errors: parse_model_errors(instance) })
+      end
     end
 
     private
@@ -35,10 +38,6 @@ module ActionValidator
     end
 
     def parse_model_errors(instance)
-      # TODO: What about errors on :base? Or any other random shit people might add?
-      #       I think we can just tell people to add a div with the proper attribute?
-      #       Or just don't allow it?
-      #
       instance.errors.each_with_object({}) { |error, hash| hash[error.attribute] = error.full_message }
     end
 

data/app/helpers/action_validator/form_helper.rb

@@ -7,7 +7,8 @@ module ActionValidator
   module FormHelper
     # A wrapper around the Rails form_for helper. This method can be used exactly the same as the standard Rails helper.
     #
-    def validator_form_for(record, options = {}, &block) merge_form_options(options)
+    def validator_form_for(record, options = {}, &block)
+      merge_form_options(options)
 
       form_for(record, options, &block)
     end
@@ -15,7 +16,7 @@ module ActionValidator
     # A wrapper around the Rails form_with helper. This method can be used exactly the same as the standard Rails
     # helper.
     #
-    def validator_form_with(model: nil, scope: nil, url: nil, format: nil, **options, &block)
+    def validator_form_with(model: false, scope: nil, url: nil, format: nil, **options, &block)
       merge_form_options(options)
 
       form_with(model: model, scope: scope, url: url, format: format, **options, &block)
@@ -28,13 +29,13 @@ module ActionValidator
       options[:data][ActionValidator::STIMULUS_SELECTORS[:target]] = :error
       options[:data][:attribute] = attribute
 
-      tag.div({ **options, id: attribute }) { '' }
+      tag.div(id: attribute, **options)
     end
 
     private
 
     def merge_form_options(options)
-      default_builder = ActionView::Base.default_form_builder
+      default_builder = self.class.default_form_builder
       options[:builder] ||= default_builder || ActionValidator::FormBuilder
       options[:data] ||= {}
       options[:data].merge!(

data/app/javascript/action_validator/controllers/form_controller.js

@@ -1,26 +1,24 @@
-import { Controller } from "@hotwired/stimulus"
+import { Controller } from "@hotwired/stimulus";
 import consumer from "channels/consumer";
 
 export default class extends Controller {
-  static targets = ['submit', 'input', 'error'];
+  static targets = ["submit", "input", "error"];
   static values = { modelName: String };
 
   connect() {
-    // TODO: This might not JUST be inputs. It could be any DOM element. Maybe a better name is needed here.
-    //       `remoteValidatableElements` or something. The current set up doesn't really work well for this though
-    //       because the `remoteValidatableInputs` is directly tied to an actual input. Maybe the cableReceived method
-    //       should check for another `target` that matches the `errors` key in the return value if the error element
-    //       doesn't exist for that attribute...
-    //
-    this.remoteValidatableInputs = []
-    this.channel = consumer.subscriptions.create('ActionValidator::FormChannel', {
-      connected: this.#cableConnected.bind(this),
-      disconnected: this.#cableDisconnected.bind(this),
-      received: this.#cableReceived.bind(this),
-    });
-
-    this.inputTargets.forEach(input => {
-      if (input.dataset.remoteValidate === 'true') this.remoteValidatableInputs.push(input);
+    this.remoteValidatableInputs = [];
+    this.channel = consumer.subscriptions.create(
+      "ActionValidator::FormChannel",
+      {
+        connected: this.#cableConnected.bind(this),
+        disconnected: this.#cableDisconnected.bind(this),
+        received: this.#cableReceived.bind(this),
+      },
+    );
+
+    this.inputTargets.forEach((input) => {
+      if (input.dataset.remoteValidate === "true")
+        this.remoteValidatableInputs.push(input);
     });
 
     this.#disableSubmit();
@@ -36,31 +34,35 @@ export default class extends Controller {
 
   validate(ev) {
     const inputElement = ev.target;
-    const { dataset: { remoteValidate } } = inputElement;
+    const {
+      dataset: { remoteValidate },
+    } = inputElement;
     this.#checkAndSetDirty(inputElement);
-    if (inputElement.dataset.isDirty === 'false') return;
+    if (inputElement.dataset.isDirty === "false") return;
 
     const htmlValid = this.validateInput(ev.target);
 
-    if (remoteValidate === 'true' && htmlValid) {
-     this.channel.perform('validate', { formData: this.#serializeForm() });
+    if (remoteValidate === "true" && htmlValid) {
+      this.channel.perform("validate", { formData: this.#serializeForm() });
     } else {
       this.validateForm();
     }
   }
 
   validateInput(input) {
-    input.setCustomValidity('');
+    input.setCustomValidity("");
     const isValid = input.checkValidity();
-    const errorElement = this.errorTargets.find(target => input.dataset.attribute === target.dataset.attribute);
+    const errorElement = this.errorTargets.find(
+      (target) => input.dataset.attribute === target.dataset.attribute,
+    );
 
     if (isValid) {
-      errorElement.innerHTML = '';
+      if (errorElement) errorElement.innerHTML = "";
       input.dataset.valid = true;
 
       return true;
     } else {
-      errorElement.innerHTML = input.validationMessage;
+      if (errorElement) errorElement.innerHTML = input.validationMessage;
       input.dataset.valid = false;
 
       return false;
@@ -77,18 +79,20 @@ export default class extends Controller {
     const currentlyDirty = element.dataset.isDirty;
     const value = element.value;
 
-    if (currentlyDirty === 'false' && value) element.dataset.isDirty = true;
+    if (currentlyDirty === "false" && value) element.dataset.isDirty = true;
   }
 
   #serializeForm() {
     const formData = new FormData(this.element);
-    const queryString = new URLSearchParams(formData).toString()
+    const queryString = new URLSearchParams(formData).toString();
 
     return queryString;
   }
 
   #formValid() {
-    return this.inputTargets.every(element => element.dataset.valid === 'true');
+    return this.inputTargets.every(
+      (element) => element.dataset.valid === "true",
+    );
   }
 
   // TODO: Add an option to just show errors globally somewhere and not next to each input. We should support arbitrary
@@ -97,16 +101,18 @@ export default class extends Controller {
   #cableReceived(data) {
     const { errors } = data;
 
-    this.remoteValidatableInputs.forEach(inputElement => {
-      if (inputElement.dataset.isDirty === 'false') return;
+    this.remoteValidatableInputs.forEach((inputElement) => {
+      if (inputElement.dataset.isDirty === "false") return;
 
       const attributeName = inputElement.dataset.attribute;
       const error = errors[attributeName];
-      const errorElement = this.errorTargets.find(target => attributeName === target.dataset.attribute);
+      const errorElement = this.errorTargets.find(
+        (target) => attributeName === target.dataset.attribute,
+      );
       if (!errorElement) {
         Stimulus.logDebugActivity(
           `No error element found for input with attribute '${attributeName}'. Cannot add error.`,
-          'cableReceived'
+          "cableReceived",
         );
         return;
       }
@@ -116,36 +122,48 @@ export default class extends Controller {
         inputElement.setCustomValidity(errors[attributeName]);
         inputElement.dataset.valid = false;
       } else {
-        errorElement.innerHTML = '';
-        inputElement.setCustomValidity('');
+        errorElement.innerHTML = "";
+        inputElement.setCustomValidity("");
         inputElement.dataset.valid = true;
       }
-    })
+    });
 
     this.validateForm();
   }
 
   #disableSubmit() {
     if (this.hasSubmitTarget) {
-      this.submitTarget.setAttribute('disabled', true);
+      this.submitTarget.setAttribute("disabled", true);
     } else {
-      Stimulus.logDebugActivity('No submit target found for form', 'disableSubmit');
+      Stimulus.logDebugActivity(
+        "No submit target found for form",
+        "disableSubmit",
+      );
     }
   }
 
   #enableSubmit() {
     if (this.hasSubmitTarget) {
-      this.submitTarget.removeAttribute('disabled');
+      this.submitTarget.removeAttribute("disabled");
     } else {
-      Stimulus.logDebugActivity('No submit target found for form', 'enableSubmit');
+      Stimulus.logDebugActivity(
+        "No submit target found for form",
+        "enableSubmit",
+      );
     }
   }
 
   #cableConnected() {
-    Stimulus.logDebugActivity('ActionValidator connected to cable', 'cableConnected');
+    Stimulus.logDebugActivity(
+      "ActionValidator connected to cable",
+      "cableConnected",
+    );
   }
 
   #cableDisconnected() {
-    Stimulus.logDebugActivity('ActionValidator disconnected from cable', 'cableDisconnected');
+    Stimulus.logDebugActivity(
+      "ActionValidator disconnected from cable",
+      "cableDisconnected",
+    );
   }
 }

data/config/importmap.rb

@@ -1,4 +1,3 @@
-pin "application-action-validator", to: "action_validator/application.js", preload: true
 pin "@hotwired/stimulus", to: "stimulus.min.js", preload: true
 pin_all_from(
   ActionValidator::Engine.root.join("app/javascript/action_validator/controllers"),

data/lib/action_validator/engine.rb

@@ -14,7 +14,6 @@ module ActionValidator
 
     initializer "action_validator.assets" do |app|
       app.config.assets.paths << root.join("app/javascript")
-      app.config.assets.precompile += %w[action_validator_manifest]
     end
 
     initializer "action_validator.importmap", before: "importmap" do |app|

data/lib/action_validator/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActionValidator
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: action_validator
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Darin Haener
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-24 00:00:00.000000000 Z
+date: 2025-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -137,7 +136,6 @@ metadata:
   homepage_uri: https://www.github.com/dphaener/action_validator
   source_code_uri: https://www.github.com/dphaener/action_validator
   changelog_uri: https://www.github.com/dphaener/action_validator/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -152,8 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Simple client and server side form validation.
 test_files: []