phlexi-form 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 677bddc668db5f933dadf3bbe2057dc3463dda9efc7ea47cbbb4d79ec907bc9c
-  data.tar.gz: fe050eaa5f4e946c14fd69285ca93e4f1ed4ac0a4b079a7fb8976cadb4695381
+  metadata.gz: d20cf0d6ccfcdf3cbb3a05a518b25a9b6176ef827e32f9cab47fddb43391f470
+  data.tar.gz: '0788efe146100a6629f679d913a080ff7cc2039881477bc9ffda16dfe0f6dc9f'
 SHA512:
-  metadata.gz: fffc444e797c5fead7b45308e05cc94bc0b9d3da7c389c1eb199867c18b3c834058b7ad8ae7a34a805e0e05c9d15897051b59efdaf213b16a17a991af571d42c
-  data.tar.gz: df80447cf6f4263e5303f39b219ff8615f303e106abce319a55d4289e382aba32aff65df08e746a75045427f15403e742d8bbb38c4cfef611935df1f1706bd09
+  metadata.gz: 3e671e22b8daa6e5e243725f79302e26b9b1d5395d92a54013d0aed981bc9eb2dfd756d8214a69446e0328186b339dc21dd3e1853c5236270f048e974c4ae114
+  data.tar.gz: d7441ae010f74f188baf43b6ac90e5cdd49b88563a22261e223b11d3c20de6135e5f610c0f278eaae28d49bc3627df3ec0b3012fe49d5e41626751d15200fd26

data/Appraisals

@@ -2,12 +2,7 @@ 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
+appraise "rails-7" do
+  gem "rails", "~> 7.1.3", ">= 7.1.3.4"
+  gem "sqlite3", "~> 1.4"
+end

data/README.md

@@ -1,395 +1,196 @@
-# Superform
+# Phlexi::Form 
 
-Superform aims to be the best way to build forms in Rails applications. Here's what it does differently.
+Phlexi::Form is a flexible and powerful form builder for Ruby applications. It provides a more customizable and extensible way to create forms compared to traditional form helpers.
 
-* **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.
+[![Ruby](https://github.com/radioactive-labs/phlexi-form/actions/workflows/main.yml/badge.svg)](https://github.com/radioactive-labs/phlexi-form/actions/workflows/main.yml)
 
-* **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.
+## Features
 
-* **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.
+- Customizable form components (input, select, checkbox, radio button, etc.)
+- Automatic field type and attribute inference based on model attributes
+- Built-in support for validations and error handling
+- Flexible form structure with support for nested attributes
+- Works with Phlex or erb views
+- Extract input from parameters that match your form definition. No need to strong paramters.
+- Rails compatible form inputs
 
-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.
+Add this line to your application's Gemfile:
 
 ```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
+gem 'phlexi-form'
 ```
 
-Then render it in your templates. Here's what it looks like from an Erb file.
+And then execute:
 
-```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
+$ bundle install
 ```
 
-That looks like a LOT of code, and it is, but look at how easy it is to create forms.
+Or install it yourself as:
 
-```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 %>
+$ gem install phlexi-form
 ```
 
-Much better!
-
-## Namespaces & Collections
+## Usage
 
-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.
+There are 2 ways to use Phlexi::Form:
 
-Consider a form for an account that lets people edit the names and email of the owner and users of an account.
+### Direct Usage
 
 ```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
+Phlexi::Form(User.new) do
+  field(:name) do |name|
+    render name.label_tag
+    render name.input_tag
   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
+  field(:email) do |email|
+    render email.label_tag
+    render email.input_tag
   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.
+  nest_one(:address) do |address|
+    address.field(:street) do |street|
+      render street.label_tag
+      render street.input_tag
+    end
 
-```ruby
-class UserForm < Superform::Rails::Form
-  def template
-    render field(:email).input
-  end
-  
-  def key
-    "user"
+    address.field(:city) do |city|
+      render city.label_tag
+      render city.input_tag
+    end
   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]`
+  render submit_button
+end
 ```
 
-## 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.
+> **Important**
+>
+> If you are rendering your form inline e.g. 
+> ```ruby
+> render Phlexi::Form(User.new) {
+>   render field(:name).label_tag
+>   render field(:name).input_tag
+> }
+> ```
+>
+> Make sure you use `{...}` in defining your block instead of `do...end`
+> This might be fixed in a future version.
+
+### Inherit form
 
 ```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
+class UserForm < Phlexi::Form::Base
+  def form_template
+    field(:name) do |name|
+      render name.label_tag
+      render name.input_tag
     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>
-      )
+    field(:email) do |email|
+      render email.label_tag
+      render email.input_tag
     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
+    nest_one(:address) do |address|
+      address.field(:street) do |street|
+        render street.label_tag
+        render street.input_tag
       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)
+      address.field(:city) do |city|
+        render city.label_tag
+        render city.input_tag
+      end
     end
 
-    render button { "Submit" }
+    render submit_button
   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
+# In your view or controller
+form = UserForm.new(User.new)
 
-# IMPORTANT
-# When rendering the form remember to init the User::ImageForm like that
-render User::ImageForm.new(@usermodel, enctype: "multipart/form-data")
+# Render the form
+render form
+
+# Extract params
+form.extract_input({
+  name: "Brad Pitt",
+  email: "brad@pitt.com",
+  address: {
+    street: "Plumbago",
+    city: "Accra",
+  }
+})
 ```
 
+## Advanced Usage
 
-## Extending Superforms
+### Custom Components
 
-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:
+You can create custom form components by inheriting from `Phlexi::Form::Components::Base`:
 
 ```ruby
-class AdminForm < ApplicationForm
-  class AdminInput < ApplicationComponent
-    def template(&)
+class CustomInput < Phlexi::Form::Components::Base
+  def template
+    div(class: "custom-input") do
       input(**attributes)
-      small { admin_tool_tip_for field.key }
-    end
-  end
-
-  class Field < Field
-    def tooltip_input(**attributes)
-      AdminInput.new(self, attributes: attributes)
+      span(class: "custom-icon")
     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
+# Usage in your form
+field(:custom_field) do |field|
+  render CustomInput.new(field)
 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
+### Theming
 
-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.
+Phlexi::Form supports theming through a flexible theming system:
 
 ```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
+class ThemedForm < Phlexi::Form::Base
+  class FieldBuilder < FieldBuilder
+    private
+    
+    def default_theme
+      {
+        input: "border rounded px-2 py-1",
+        label: "font-bold text-gray-700",
+        # Add more theme options here
+      }
     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.
+<!-- ## Configuration
 
-https://github.com/heartcombo/simple_form#the-wrappers-api
+You can configure Phlexi::Form globally by creating an initializer:
 
-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).
+```ruby
+# config/initializers/phlexi_form.rb
+Phlexi::Form.configure do |config|
+  config.default_theme = {
+    # Your default theme options
+  }
+  # Add more configuration options here
+end
+``` -->
 
 ## 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).
+Bug reports and pull requests are welcome on GitHub at https://github.com/radioactive-labs/phlexi-form.
 
 ## 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/TODO

@@ -0,0 +1,4 @@
+- Add tests for primary_key
+- Ensure composite primary keys are supported
+- add tests for formmethod override in submit_button
+- how can we automatically infer the file types accepted by the file_input component

data/config.ru

@@ -4,6 +4,3 @@ require "rubygems"
 require "bundler"
 
 Bundler.require :default, :development
-
-# Combustion.initialize! :all
-# run Combustion::Application

data/gemfiles/default.gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: ..
   specs:
-    phlexi-form (0.1.0)
+    phlexi-form (0.3.0.rc1)
       activesupport
-      phlex (~> 1.10)
+      phlex (~> 1.11)
       zeitwerk
 
 GEM
@@ -35,6 +35,8 @@ GEM
       minitest (>= 5.1)
       mutex_m
       tzinfo (~> 2.0)
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
     ansi (1.5.0)
     appraisal (2.5.0)
       bundler
@@ -49,6 +51,15 @@ GEM
     bundler-audit (0.9.1)
       bundler (>= 1.2.0, < 3)
       thor (~> 1.0)
+    capybara (3.40.0)
+      addressable
+      matrix
+      mini_mime (>= 0.1.3)
+      nokogiri (~> 1.11)
+      rack (>= 1.6.0)
+      rack-test (>= 0.6.3)
+      regexp_parser (>= 1.5, < 3.0)
+      xpath (~> 3.2)
     combustion (1.5.0)
       activesupport (>= 3.0.0)
       railties (>= 3.0.0)
@@ -70,6 +81,8 @@ GEM
     loofah (2.22.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
+    matrix (0.4.2)
+    mini_mime (1.1.5)
     minitest (5.24.1)
     minitest-reporters (1.7.1)
       ansi
@@ -84,8 +97,12 @@ GEM
       ast (~> 2.4.1)
       racc
     phlex (1.11.0)
+    phlex-testing-capybara (0.1.0)
+      capybara (~> 3.38)
+      phlex (>= 0.5)
     psych (5.1.2)
       stringio
+    public_suffix (6.0.1)
     racc (1.8.1)
     rack (3.1.7)
     rack-session (2.0.0)
@@ -155,6 +172,8 @@ GEM
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.5.0)
     webrick (1.8.1)
+    xpath (3.2.0)
+      nokogiri (~> 1.8)
     zeitwerk (2.6.17)
 
 PLATFORMS
@@ -166,6 +185,7 @@ DEPENDENCIES
   combustion
   minitest
   minitest-reporters
+  phlex-testing-capybara
   phlexi-form!
   rake
   standard

data/gemfiles/rails_7.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 7.1.3", ">= 7.1.3.4"
+gem "sqlite3", "~> 1.4"
+
+gemspec path: "../"