superform 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e755c08731146b7a40c49b9eeaee5b267b56476764ce97fdb68ae8392e5cad0a
-  data.tar.gz: b369765812de40bf81c672ee7f131e4bc8c0a4c234baf210096a41c175f02505
+  metadata.gz: b87df41698b91049bed9e30f976d56b92c5c694762a63803453d29fa47c025a9
+  data.tar.gz: bd9ec4dd8499de8303411c3ee88f7a2888ce285b5592eb32829db6043782a4f9
 SHA512:
-  metadata.gz: 014cdef2d3639b063ab13f6d757f68c2eb4b14d3f5c89b51301deae77302c3e6ad11a38c21cd974a2fc4ae22d5f4db57d6b698ff1042ac495aaa13c6bccdaff1
-  data.tar.gz: ad6fd81bc9e597d14b63e2915b0c9ba820da4fa71b7db2f129db25ebee8ded0bc836e2353f1799d8565db689f77a0e2dccc73c9a875336a0dedcf5548b8bf169
+  metadata.gz: 5f945ca1d2a57d3b4ac69d064c72f701cd7d3d524a64dd241c80a23b3fd53cecd572800f2ebbe760321348d0f770b60d60be5acb4a4482e007d9040d21b3898f
+  data.tar.gz: a47df25dcc990f3162b874f85999df79e0acf170643395071aaa2b2c29fde23ff302a055a9ed132927945cc53c30376f645846370f5e323eb89115dc740136ce

data/README.md

@@ -10,10 +10,9 @@ Superform aims to be the best way to build forms in Rails applications. Here's w
 
 It's a complete rewrite of Rails form's internals that's inspired by Reactive component design patterns.
 
-## Installation
+[![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)
 
-> **Note**
-> This doesn't actually work yet. There is working source code at https://github.com/rubymonolith/demo/tree/main/app/views/superform that's being extracted into a gem. This repo and README exist to validate some ideas before the gem is finalized and published.
+## Installation
 
 Add to the Rails application's Gemfile by executing:
 
@@ -45,7 +44,7 @@ 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 model: @post %>
+<%= render Posts::Form.new @post %>
 ```
 
 ## Customization
@@ -102,12 +101,12 @@ end
 Then render it from Erb.
 
 ```erb
-<%= render Users::Form.new model: @user %>
+<%= render Users::Form.new @user %>
 ```
 
 Much better!
 
-### Extending Superforms
+## 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:
 
@@ -143,58 +142,47 @@ 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 everythign 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
-
-> **Note**
-> THese docs are a work in progress. Strong params do work, but not as documented below. Stay tuned for updates.
+## Automatic strong parameters
 
-Guess what? Superform also permits form fields for you in your controller, like this:
+Guess what? Superform eliminates then need for Strong Parameters in Rails by assigning the values of the `params` hash _through_ your form. Here's what it looks like.
 
 ```ruby
-class UserController < ApplicationController
-  # Your actions
+class PostsController < ApplicationController
+  include Superform::Rails::StrongParameters
 
-  private
+  def create
+    @post = assign params.require(:post), to: Post.new
 
-  def permitted_params
-    @form.permit params
+    if @post.save
+      # Success path
+    else
+      # Error path
+    end
   end
-end
-```
 
-To do that though you need to move the form as an inline class into your controller or `app/views` folder, which is pretty easy:
+  def update
+    @post = Post.find(params[:id])
 
-```ruby
-class UsersController < ApplicationController
-  # You could also put this in `./app/views/users/form.rb`
-  class Form < ApplicationForm
-    render field(:email).input(type: :email)
-    render field(:name).input
+    assign params.require(:post), to: @post
 
-    button(type: :submit) { "Sign up" }
+    if @post.save
+      # Success path
+    else
+      # Error path
+    end
   end
 
-  before_action :assign_form
-
-  # Your actions
-
   private
-
-  def assign_form
-    @form = Form.new(model: @user)
-  end
-
-  def permitted_params
-    @form.permit params
-  end
+    # Defaults to `Posts::Form`, but you can override it here if
+    # you uncomment and add your own class. You could also pass the
+    # `form: FormClass` into the `assign` method.
+    #
+    # def form_class
+    # end
 end
 ```
 
-Then render it from your Erb in less lines, like this:
-
-```
-<%= render @form %>
-```
+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
 

data/lib/superform/rails.rb

@@ -100,6 +100,24 @@ module Superform
       end
     end
 
+    module StrongParameters
+      protected
+        # Assigns params to the form model.
+        def assign(params, to:, form: form_class)
+          to.tap do |model|
+            form.new(model).tap do |form|
+              # TODO: Figure out how to render this in a way that doesn't concat a string; just throw everything away.
+              render_to_string form
+              form.assign params
+            end
+          end
+        end
+
+        # Defaults to the form defined in `./app/views/*/form.rb`.
+        def form_class
+          self.controller_name.camelize.constantize::Form
+        end
+    end
 
     module Components
       class FieldComponent < ApplicationComponent

data/lib/superform/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Superform
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: superform
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Brad Gessler