hyperactiveform 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9bf33b760b731a44e34fd302e0d0d4049f9dd04cfeaeff043a32992f6a8c01d7
+  data.tar.gz: 556cb734a8ee3eabf099240c26a709b19214b30e65d0c731e233e58b2984565f
+SHA512:
+  metadata.gz: 129e1e5a36f424767e7135339ade191302fd7b03cee66695abb9eaa4e274fb521a811d3bbd6b8c3e1fb8934e8a66c94ce75a7e99712ca3fe6bd40ee15949d670
+  data.tar.gz: 381d63d878a72e386c4b0156be4836d54095b503e6640ebacbd2a4b441d924422b11bc583affc291a493c0514b0fcd57f46f9fdea917a7b9403fd36c1847f5fb

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-11-30
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Adrien Siami
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,213 @@
+# ✨ HyperActiveForm ✨
+
+HyperActiveForm is a simple form object implementation for Rails.
+
+Form objects are objects that encapsulate form logic and validations, they allow to extract the business logic out of the controller and models into specialized objects.
+
+HyperActiveForm's form objects mimic the ActiveModel API, so they work out of the box with Rails' form helpers, and allow you to use the ActiveModel validations you already know.
+
+This allows you to only keep strictly necessary validations in the model, and have business logic validations in the form object. This is especially useful when you want different validations to be applied depending on the context.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hyperactiveform'
+```
+
+And then execute:
+
+    $ bundle install
+
+Run the install generator:
+
+    $ rails generate hyperactiveform:install
+
+this will create an `ApplicationForm` class in your app/forms directory. You can use it as a base class for your form objects.
+
+## Usage
+
+Here is an example of an `HyperActiveForm` form object:
+
+```ruby
+class ProfileForm < ApplicationForm
+  # proxy_for is used to delegate the model name to the class, and some methods to the object
+  # this helps use `form_with` in views without having to specify the url
+  proxy_for User, :@user
+
+  # Define the form fields, using ActiveModel::Attributes
+  attribute :first_name
+  attribute :last_name
+  attribute :birth_date, :date
+
+  # Define the validations, using ActiveModel::Validations
+  validates :first_name, presence: true
+  validates :last_name, presence: true
+  validates :birth_date, presence: true
+
+  # Pre-fill the form if needed
+  def setup(user)
+    @user = user
+    self.first_name = user.first_name
+    self.last_name = user.last_name
+    self.birth_date = user.birth_date
+  end
+
+  # Perform the form logic
+  def perform
+    @user.update!(
+      first_name: first_name,
+      last_name: last_name,
+      birth_date: birth_date
+    )
+  end
+end
+```
+
+The controller would look like this:
+
+```ruby
+class UsersController < ApplicationController
+
+  def edit
+    @form = ProfileForm.new(user: current_user)
+  end
+
+  def update
+    @form = ProfileForm.new(user: current_user)
+    if @form.submit(params[:user])
+      redirect_to root_path, notice: "Profile updated"
+    else
+      render :edit, status: :unprocessable_entity
+    end
+  end
+```
+
+And the view would look like this:
+
+```erb
+<%= form_with(model: @form) do |f| %>
+  <%= f.text_field :first_name %>
+  <%= f.text_field :last_name %>
+  <%= f.date_field :birth_date %>
+
+  <%= f.submit %>
+<% end %>
+```
+
+### Understanding `proxy_for`
+
+`HyperActiveForm` mimics a model object, you can use `proxy_for` to tell it which class and object to delegate to.
+
+When using `form_for` or `form_with`, Rails will choose the URL and method based on the object, according to the persisted state of the object and its model name.
+
+The first argument of `proxy_for` is the class of the object, and the second argument is the name of the instance variable that holds the object.
+
+```ruby
+class ProfileForm < ApplicationForm
+  proxy_for User, :@user # Will delegate to @user
+end
+```
+
+If you pass an url and method yourself, you don't need to use `proxy_for`.
+
+### Understanding `setup`
+
+`setup` is called just after the form is initialized, and is used to pre-fill the form with data from the object.
+
+`setup` will receive the same arguments as the initializer, so you can use it to pass any data you need to the form.
+
+```ruby
+class ProfileForm < ApplicationForm
+  def setup(user)
+    @user = user
+    self.first_name = user.first_name
+    self.last_name = user.last_name
+    self.birth_date = user.birth_date
+  end
+end
+```
+
+### Understanding `perform`
+
+When using `submit` or `submit!`, `HyperActiveForm` will first assign the form attributes to the object, then perform the validations, then call `perform` on the object if the form is valid.
+
+The `perform` method is where you should do the actual form logic, like updating the object or creating a new one.
+
+If the return value of `perform` is not truthy, `HyperActiveForm` will consider the form encountered an error and `submit` will return `false`, or `submit!` will raise a `HyperActiveForm::FormDidNotSubmitError`.
+
+At any point during the form processing, you can raise `HyperActiveForm::CancelForm` to cancel the form submission, this is the same as returning `false`.
+
+## Understanding add_errors_from
+
+`HyperActiveForm` provides a method to add errors from a model and apply them fo the form.
+
+This is useful when the underlying model has validations that are not set up in the form object, and you want them to be applied to the form.
+
+```ruby
+class User < ApplicationRecord
+  validates :first_name, presence: true
+end
+
+class ProfileForm < ApplicationForm
+  proxy_for User, :@user
+  attribute :first_name
+
+  def setup(user)
+    @user = user
+    self.first_name = user.first_name
+  end
+
+  def perform
+    @user.update!(first_name: first_name) || add_errors_from(@user)
+  end
+end
+```
+
+### Not all forms map to a single model
+
+The power of `HyperActiveForm` is that you can use it to create forms that don't map to a single model.
+
+Some forms can be used to create several models at once. Doing so without form objects can be tedious especially with nested attributes.
+
+Some forms dont map to any model at all, like a simple contact form that only sends an email and saves nothing in the database, or a sign in form that would only validate the credentials and return the instance of the connected user.
+
+One great example of such forms are search forms. You can use a form object to encapsulate the search logic :
+
+```ruby
+class UserSearchForm < ApplicationForm
+  attribute :name
+  attribute :email
+  attribute :min_age, :integer
+
+  attr_reader :results # So the controller can access the results
+
+  def perform
+    @results = User.all
+
+    if name.present?
+      @results = @results.where(name: name)
+    end
+    if email.present?
+      @results = @results.where(email: email)
+    end
+    if age.present?
+      @results = @results.where("age >= ?", age)
+    end
+
+    true
+  end
+end
+```
+
+And in the controller:
+
+```ruby
+class UsersController < ApplicationController
+  def index
+    @form = UserSearchForm.new
+    @form.submit!(params[:user])
+    @users = @form.results
+  end
+end

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/gemfiles/Gemfile.rails-7.1.x

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec :path => '..'
+
+gem 'rails', '~> 7.1'

data/gemfiles/Gemfile.rails-7.2.x

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec :path => '..'
+
+gem 'rails', '~> 7.2'

data/gemfiles/Gemfile.rails-8.x

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec :path => '..'
+
+gem 'rails', '~> 8.0'

data/lib/hyper_active_form/base.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "active_model"
+require "action_controller"
+
+module HyperActiveForm
+  class Base
+    include ActiveModel::Model
+    include ActiveModel::Attributes
+    include ActiveModel::Validations
+
+    def self.proxy_for(klass, object)
+      delegate :new_record?, :persisted?, :id, to: object
+      singleton_class.delegate :model_name, to: klass
+    end
+
+    def initialize(*, **)
+      super()
+      setup(*, **)
+    end
+
+    def setup; end
+
+    def perform
+      raise NotImplementedError
+    end
+
+    def assign_form_attributes(params)
+      params = ActionController::Parameters.new(params) unless params.is_a?(ActionController::Parameters)
+      attribute_names.each do |attribute|
+        public_send(:"#{attribute}=", params&.dig(attribute)) if params&.key?(attribute)
+      end
+    end
+
+    def submit(params)
+      assign_form_attributes(params)
+      !!(valid? && perform)
+    rescue HyperActiveForm::CancelFormSubmit
+      false
+    end
+
+    def submit!(params)
+      submit(params) || raise(HyperActiveForm::FormDidNotSubmitError)
+    end
+
+    def add_errors_from(model)
+      model.errors.each do |error|
+        Array.wrap(error.message).each { |e| errors.add(error.attribute, e) }
+      end
+
+      false
+    end
+  end
+end

data/lib/hyper_active_form/generators.rb

@@ -0,0 +1,14 @@
+require "rails/generators"
+
+module HyperActiveForm
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      def create_application_form
+        create_file "app/forms/application_form.rb", <<~RUBY
+          class ApplicationForm < HyperActiveForm::Base
+          end
+        RUBY
+      end
+    end
+  end
+end

data/lib/hyper_active_form/version.rb

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

data/lib/hyper_active_form.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module HyperActiveForm
+  class CancelFormSubmit < StandardError; end
+  class FormDidNotSubmitError < StandardError; end
+end
+
+require_relative "hyper_active_form/version"
+require_relative "hyper_active_form/base"
+require_relative "hyper_active_form/generators"

data/lib/hyperactiveform.rb

@@ -0,0 +1 @@
+require_relative "hyper_active_form"

data/sig/hyperactiveform.rbs

@@ -0,0 +1,4 @@
+module Hyperactiveform
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: hyperactiveform
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adrien Siami
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-11-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+description: Encapsulate form logic and validations in a simple object
+email:
+- adrien@siami.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- gemfiles/Gemfile.rails-7.1.x
+- gemfiles/Gemfile.rails-7.2.x
+- gemfiles/Gemfile.rails-8.x
+- lib/hyper_active_form.rb
+- lib/hyper_active_form/base.rb
+- lib/hyper_active_form/generators.rb
+- lib/hyper_active_form/version.rb
+- lib/hyperactiveform.rb
+- sig/hyperactiveform.rbs
+homepage: https://github.com/Intrepidd/hyperactiveform
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Intrepidd/hyperactiveform
+  source_code_uri: https://github.com/Intrepidd/hyperactiveform
+  changelog_uri: https://github.com/Intrepidd/hyperactiveform/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.10
+signing_key:
+specification_version: 4
+summary: Simple form objects for Rails
+test_files: []