Add some yard doc

Author: Intrepidd

Gemfile.lock

@@ -189,6 +189,7 @@ GEM
     websocket-driver (0.7.6)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
+    yard (0.9.37)
     zeitwerk (2.7.1)
 
 PLATFORMS
@@ -198,6 +199,7 @@ DEPENDENCIES
   hyperactiveform!
   rake (~> 13.0)
   rspec (~> 3.13)
+  yard
 
 BUNDLED WITH
    2.5.18

hyperactiveform.gemspec

@@ -33,4 +33,5 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "rails", ">= 7.0"
   spec.add_development_dependency "rspec", "~> 3.13"
+  spec.add_development_dependency "yard"
 end

lib/hyper_active_form/base.rb

@@ -4,6 +4,13 @@
 require "action_controller"
 
 module HyperActiveForm
+  ##
+  # Base class for HyperActiveForm objects
+  #
+  # HyperActiveForm objects are simple ActiveModel objects that encapsulate
+  # form logic and validations. They are designed to be subclassed and
+  # customized to fit the needs of your application.
+  #
   class Base
     include ActiveModel::Model
     include ActiveModel::Attributes
@@ -12,6 +19,11 @@ class Base
 
     define_model_callbacks :assign_form_attributes, :submit
 
+    # Defines to which object the form should delegate the active model methods
+    # This is useful so `form_for`/`form_with` can automatically deduce the url and method to use
+    #
+    # @param klass [Class] the class of the object to proxy
+    # @param object [Object] where to delegate the object to, for example: `:@user`
     def self.proxy_for(klass, object)
       delegate :new_record?, :persisted?, :id, to: object
       singleton_class.delegate :model_name, to: klass
@@ -28,6 +40,12 @@ def perform
       raise NotImplementedError
     end
 
+    # Assigns the attributes of the form from the params
+    # This method is called by the `submit` method, but can also be called
+    # directly if you need to assign the attributes without submitting the form
+    # for example if you want to refresh the form with new data
+    #
+    # @param params [Hash] the params to assign the attributes from
     def assign_form_attributes(params)
       run_callbacks :assign_form_attributes do
         params = ActionController::Parameters.new(params) unless params.is_a?(ActionController::Parameters)
@@ -38,6 +56,11 @@ def assign_form_attributes(params)
       end
     end
 
+    # Submits the form, assigning the attributes from the params,
+    # running validations and calling the `perform` method if the form is valid
+    #
+    # @param params [Hash] the params to assign the attributes from
+    # @return [Boolean] true if the form is valid and the `perform` method returned something truthy
     def submit(params)
       run_callbacks :submit do
         assign_form_attributes(params)
@@ -47,10 +70,17 @@ def submit(params)
       false
     end
 
+    # Same as `submit` but raises a `FormDidNotSubmitError` if the form is not valid
+    #
+    # @param params [Hash] the params to assign the attributes from
+    # @return [Boolean] true if the form is valid and the `perform` method returned something truthy
     def submit!(params)
       submit(params) || raise(HyperActiveForm::FormDidNotSubmitError)
     end
 
+    # Adds the errors from a model to the form
+    #
+    # @param model [ActiveModel::Model] the model to add the errors from
     def add_errors_from(model)
       model.errors.each do |error|
         Array.wrap(error.message).each { |e| errors.add(error.attribute, e) }