phlexi-form 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 677bddc668db5f933dadf3bbe2057dc3463dda9efc7ea47cbbb4d79ec907bc9c
+  data.tar.gz: fe050eaa5f4e946c14fd69285ca93e4f1ed4ac0a4b079a7fb8976cadb4695381
+SHA512:
+  metadata.gz: fffc444e797c5fead7b45308e05cc94bc0b9d3da7c389c1eb199867c18b3c834058b7ad8ae7a34a805e0e05c9d15897051b59efdaf213b16a17a991af571d42c
+  data.tar.gz: df80447cf6f4263e5303f39b219ff8615f303e106abce319a55d4289e382aba32aff65df08e746a75045427f15403e742d8bbb38c4cfef611935df1f1706bd09

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+3.2.2

data/Appraisals

@@ -0,0 +1,13 @@
+appraise "default" do
+  # gem "phlex", "~> 1.10"
+end
+
+# appraise "rails-7" do
+#   gem "rails", "~> 7.1.3", ">= 7.1.3.4"
+#   gem "sqlite3", "~> 1.4"
+#   gem "puma", ">= 5.0"
+#   gem "importmap-rails"
+#   gem "turbo-rails"
+#   gem "stimulus-rails"
+#   gem "tzinfo-data", platforms: %i[windows jruby]
+# end

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.2.0] - 2024-07-31
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at bradgessler@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Stefan Froelich
+
+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,395 @@
+# Superform
+
+Superform aims to be the best way to build forms in Rails applications. Here's what it does differently.
+
+* **Everything is a component.** Superform is built on top of [Phlex](https://phlex.fun), so every bit of HTML in the form can be customized to your precise needs. Use it with your own CSS Framework or go crazy customizing every last bit of TailwindCSS.
+
+* **Automatic strong parameters.** Superform automatically permits form fields so you don't have to facepalm yourself after adding a field, wondering why it doesn't persist, only to realize you forgot to add the parameter to your controller. No more! Superform was architected with safety & security in mind, meaning it can automatically permit your form parameters.
+
+* **Compose complex forms with Plain 'ol Ruby Objects.** Superform is built on top of POROs, so you can easily compose classes, modules, & ruby code together to create complex forms. You can even extend forms to create new forms with a different look and feel.
+
+It's a complete rewrite of Rails form's internals that's inspired by Reactive component design patterns.
+
+[![Maintainability](https://api.codeclimate.com/v1/badges/0e4dfe2a1ece26e3a59e/maintainability)](https://codeclimate.com/github/rubymonolith/superform/maintainability) [![Ruby](https://github.com/rubymonolith/superform/actions/workflows/main.yml/badge.svg)](https://github.com/rubymonolith/superform/actions/workflows/main.yml)
+
+## Installation
+
+Add to the Rails application's Gemfile by executing:
+
+    $ bundle add superform
+
+Then install it.
+
+    $ rails g superform:install
+
+This will install both Phlex Rails and Superform.
+
+## Usage
+
+Superform streamlines the development of forms on Rails applications by making everything a component.
+
+After installing, create a form in `app/views/*/form.rb`. For example, a form for a `Post` resource might look like this.
+
+```ruby
+# ./app/views/posts/form.rb
+class Posts::Form < ApplicationForm
+  def template(&)
+    row field(:title).input
+    row field(:body).textarea
+    row field(:blog).select Blog.select(:id, :title)
+  end
+end
+```
+
+Then render it in your templates. Here's what it looks like from an Erb file.
+
+```erb
+<h1>New post</h1>
+<%= render Posts::Form.new @post %>
+```
+
+## Customization
+
+Superforms are built out of [Phlex components](https://www.phlex.fun/html/components/). The method names correspeond with the HTML tag, its arguments are attributes, and the blocks are the contents of the tag.
+
+```ruby
+# ./app/views/forms/application_form.rb
+class ApplicationForm < Superform::Rails::Form
+  class MyInputComponent < Superform::Rails::Components::InputComponent
+    def template(&)
+      div class: "form-field" do
+        input(**attributes)
+      end
+    end
+  end
+
+  class Field < Superform::Rails::Form::Field
+    def input(**attributes)
+      MyInputComponent.new(self, attributes: attributes)
+    end
+  end
+
+  def labeled(component)
+    div class: "form-row" do
+      render component.field.label
+      render component
+    end
+  end
+
+  def submit(text)
+    button(type: :submit) { text }
+  end
+end
+```
+
+That looks like a LOT of code, and it is, but look at how easy it is to create forms.
+
+```ruby
+# ./app/views/users/form.rb
+class Users::Form < ApplicationForm
+  def template(&)
+    labeled field(:name).input
+    labeled field(:email).input(type: :email)
+
+    submit "Sign up"
+  end
+end
+```
+
+Then render it from Erb.
+
+```erb
+<%= render Users::Form.new @user %>
+```
+
+Much better!
+
+## Namespaces & Collections
+
+Superform uses a different syntax for namespacing and collections than Rails, which can be a bit confusing since the same terminology is used but the application is slightly different.
+
+Consider a form for an account that lets people edit the names and email of the owner and users of an account.
+
+```ruby
+class AccountForm < Superform::Rails::Form
+  def template
+    # Account#owner returns a single object
+    namespace :owner do |owner|
+      # Renders input with the name `account[owner][name]`
+      render owner.field(:name).input
+      # Renders input with the name `account[owner][email]`
+      render owner.field(:email).input(type: :email)
+    end
+
+    # Account#members returns a collection of objects
+    collection(:members).each do |member|
+      # Renders input with the name `account[members][0][name]`,
+      # `account[members][1][name]`, ...
+      render member.field(:name).input
+      # Renders input with the name `account[members][0][email]`,
+      # `account[members][1][email]`, ...
+      render member.field(:email).input(type: :email)
+
+      # Member#permissions returns an array of values like
+      # ["read", "write", "delete"].
+      member.field(:permissions).collection do |permission|
+        # Renders input with the name `account[members][0][permissions][]`,
+        # `account[members][1][permissions][]`, ...
+        render permission.label do
+          plain permisson.value.humanize
+          render permission.checkbox
+        end
+      end
+    end
+  end
+end
+```
+
+One big difference between Superform and Rails is the `collection` methods require the use of the `each` method to enumerate over each item in the collection.
+
+There's three different types of namespaces and collections to consider:
+
+1. **Namespace** - `namespace(:field_name)` is used to map form fields to a single object that's a child of another object. In ActiveRecord, this could be a `has_one` or `belongs_to` relationship.
+
+2. **Collection** - `collection(:field_name).each` is used to map a collection of objects to a form. In this case, the members of the account. In ActiveRecord, this could be a `has_many` relationship.
+
+3. **Field Collection** - `field(:field_name).collection.each` is used when the value of a field is enumerable, like an array of values. In ActiveRecord, this could be an attribute that's an Array type.
+
+### Change a form's root namespace
+
+By default Superform namespaces a form based on the ActiveModel model name param key.
+
+```ruby
+class UserForm < Superform::Rails::Form
+  def template
+    render field(:email).input
+  end
+end
+
+render LoginForm.new(User.new)
+# Renders input with the name `user[email]`
+
+render LoginForm.new(Admin::User.new)
+# Renders input with the name `admin_user[email]`
+```
+
+To customize the form namespace, like an ActiveRecord model nested within a module, the `key` method can be overriden.
+
+```ruby
+class UserForm < Superform::Rails::Form
+  def template
+    render field(:email).input
+  end
+  
+  def key
+    "user"
+  end
+end
+
+render UserForm.new(User.new)
+# Renders input with the name `user[email]`
+
+render UserForm.new(Admin::User.new)
+# This will also render inputs with the name `user[email]`
+```
+
+## Form field guide
+
+Superform tries to strike a balance between "being as close to HTML forms as possible" and not requiring a lot of boilerplate to create forms. This example is contrived, but it shows all the different ways you can render a form.
+
+In practice, many of the calls below you'd put inside of a method. This cuts down on the number of `render` calls in your HTML code and further reduces boilerplate.
+
+```ruby
+# Everything below is intentionally verbose!
+class SignupForm < ApplicationForm
+  def template
+    # The most basic type of input, which will be autofocused.
+    render field(:name).input.focus
+
+    # Input field with a lot more options on it.
+    render field(:email).input(type: :email, placeholder: "We will sell this to third parties", required: true)
+
+    # You can put fields in a block if that's your thing.
+    render field(:reason) do |f|
+      div do
+        f.label { "Why should we care about you?" }
+        f.textarea(row: 3, col: 80)
+      end
+    end
+
+    # Let's get crazy with Selects. They can accept values as simple as 2 element arrays.
+    div do
+      render field(:contact).label { "Would you like us to spam you to death?" }
+      render field(:contact).select(
+        [true, "Yes"],  # <option value="true">Yes</option>
+        [false, "No"],  # <option value="false">No</option>
+        "Hell no",      # <option value="Hell no">Hell no</option>
+        nil             # <option></option>
+      )
+    end
+
+    div do
+      render field(:source).label { "How did you hear about us?" }
+      render field(:source).select do |s|
+        # Pretend WebSources is an ActiveRecord scope with a "Social" category that has "Facebook, X, etc"
+        # and a "Search" category with "AltaVista, Yahoo, etc."
+        WebSources.select(:id, :name).group_by(:category) do |category, sources|
+          s.optgroup(label: category) do
+            s.options(sources)
+          end
+        end
+      end
+    end
+
+    div do
+      render field(:agreement).label { "Check this box if you agree to give us your first born child" }
+      render field(:agreement).checkbox(checked: true)
+    end
+
+    render button { "Submit" }
+  end
+end
+```
+
+### Upload fields
+If you want to add file upload fields to your form you will need to initialize your form with the `enctype` attribute set to `multipart/form-data` as shown in the following example code:
+
+```ruby
+class User::ImageForm < ApplicationForm
+  def template
+    # render label
+    render field(:image).label { "Choose file" }
+    # render file input with accept attribute for png and jpeg images
+    render field(:image).input(type: "file", accept: "image/png, image/jpeg")
+  end
+end
+
+# IMPORTANT
+# When rendering the form remember to init the User::ImageForm like that
+render User::ImageForm.new(@usermodel, enctype: "multipart/form-data")
+```
+
+
+## Extending Superforms
+
+The best part? If you have forms with a completely different look and feel, you can extend the forms just like you would a Ruby class:
+
+```ruby
+class AdminForm < ApplicationForm
+  class AdminInput < ApplicationComponent
+    def template(&)
+      input(**attributes)
+      small { admin_tool_tip_for field.key }
+    end
+  end
+
+  class Field < Field
+    def tooltip_input(**attributes)
+      AdminInput.new(self, attributes: attributes)
+    end
+  end
+end
+```
+
+Then, just like you did in your Erb, you create the form:
+
+```ruby
+class Admin::Users::Form < AdminForm
+  def template(&)
+    labeled field(:name).tooltip_input
+    labeled field(:email).tooltip_input(type: :email)
+
+    submit "Save"
+  end
+end
+```
+
+Since Superforms are just Ruby objects, you can organize them however you want. You can keep your view component classes embedded in your Superform file if you prefer for everything to be in one place, keep the forms in the `app/views/forms/*.rb` folder and the components in `app/views/forms/**/*_component.rb`, use Ruby's `include` and `extend` features to modify different form classes, or put them in a gem and share them with an entire organization or open source community. It's just Ruby code!
+
+## Automatic strong parameters
+
+Guess what? Superform eliminates the need for Strong Parameters in Rails by assigning the values of the `params` hash _through_ your form via the `assign` method. Here's what it looks like.
+
+```ruby
+class PostsController < ApplicationController
+  include Superform::Rails::StrongParameters
+
+  def create
+    @post = assign params.require(:post), to: Posts::Form.new(Post.new)
+
+    if @post.save
+      # Success path
+    else
+      # Error path
+    end
+  end
+
+  def update
+    @post = Post.find(params[:id])
+
+    assign params.require(:post), to: Posts::Form.new(@post)
+
+    if @post.save
+      # Success path
+    else
+      # Error path
+    end
+  end
+end
+```
+
+How does it work? An instance of the form is created, then the hash is assigned to it. If the params include data outside of what a form accepts, it will be ignored.
+
+## Comparisons
+
+Rails ships with a lot of great options to make forms. Many of these inspired Superform. The tl;dr:
+
+1. Rails has a lot of great form helpers. Simple Form and Formtastic both have concise ways of defining HTML forms, but do require frequently opening and closing Erb tags.
+
+2. Superform is uniquely capable of permitting its own controller parameters, leaving you with one less thing to worry about and test. Additionally it can be extended, shared, and modularized since its Plain' 'ol Ruby, which opens up a world of TailwindCSS form libraries and proprietary form libraries developed internally by organizations.
+
+### Rails form helpers
+
+Rails form helpers have lasted for almost 20 years and are super solid, but things get tricky when your application starts to take on different styles of forms. To manage it all you have to cobble together helper methods, partials, and templates. Additionally, the structure of the form then has to be expressed to the controller as strong params, forcing you to repeat yourself.
+
+With Superform, you build the entire form with Ruby code, so you avoid the Erb gymnastics and helper method soup that it takes in Rails to scale up forms in an organization.
+
+### Simple Form
+
+I built some pretty amazing applications with Simple Form and admire its syntax. It requires "Erb soup", which is an opening and closing line of Erb per line. If you follow a specific directory structure or use their component framework, you can get pretty far, but you'll hit a wall when you need to start putting wrappers around forms or inputs.
+
+https://github.com/heartcombo/simple_form#the-wrappers-api
+
+The API is there, but when you change the syntax, you have to reboot the server to see the changes. UI development should be reflected immediately when the page is reloaded, which is what Superforms can do.
+
+Like Rails form helpers, it doesn't self-permit parameters.
+
+https://www.ruby-toolbox.com/projects/simple_form
+
+### Formtastic
+
+Formtastic gives us a nice DSL inside of Erb that we can use to create forms, but like Simple Form, there's a lot of opening and closing Erb tags that make the syntax clunky.
+
+It has generators that give you Ruby objects that represent HTML form inputs that you can customize, but its limited to very specific parts of the HTML components. Superform lets you customize every aspect of the HTML in your form elements.
+
+It also does not permit its own parameters.
+
+https://www.ruby-toolbox.com/projects/formtastic
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rubymonolith/superform. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/rubymonolith/superform/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Superform project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/rubymonolith/superform/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "standard/rake"
+
+task default: %i[test standard]
+
+# https://juincc.medium.com/how-to-setup-minitest-for-your-gems-development-f29c4bee13c2
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end

data/config.ru

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "rubygems"
+require "bundler"
+
+Bundler.require :default, :development
+
+# Combustion.initialize! :all
+# run Combustion::Application

data/gemfiles/default.gemfile

@@ -0,0 +1,5 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gemspec path: "../"