superform 0.4.5 → 0.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f08aba5c447c430ce4e06c86dacf7a6bc97cf95fd7ce379e913498fe3e809ab7
-  data.tar.gz: ce49b9e40f9f7ff9cc4bd2260918af3c16fa8689c3718281077170b9532613e1
+  metadata.gz: 3cc4c3770a5f974a8d12b494dc0c62674f61d17e566585a145e4d02abcc02047
+  data.tar.gz: 04b1a10d9d7a2349d31117362cfcc1a12b854dfe9e8e666e5fd67534fea1cc3d
 SHA512:
-  metadata.gz: a392d567cba45cf0215131d00ef2557c4989cf020ded8d88f43c6d98c410ae743a629f322fab86addaa0980667a1af335a0effe318bd3d01adbeafcd1c543d5b
-  data.tar.gz: e7d2b01c137cefa7e0e6cefda057005af5f4e297e1e26b36be96f1c1276b0854ccd0352217d30efce471a7c08f1dda2ed5e024e9193321ebae922a9d32f04829
+  metadata.gz: dbb5d91b7e49b8357e33fd4f3178ea658b51fa44e46496c4e03fffc1c4801155f8953c80a223cc1d8c4dc2d3d48ea59f51b711f17d64ea2fba31e4344c8949e4
+  data.tar.gz: 70ee4cbbd71fb9e995d9d03a7c5c556ee6e62ddc1beb2d06826a071511d2052a711b0dc453c3e4f25f984092783c3c56b749b68a34ff55104609a7393ec4444e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    superform (0.4.5)
+    superform (0.4.6)
       phlex-rails (~> 1.0)
       zeitwerk (~> 2.6)
 

data/README.md

@@ -54,19 +54,16 @@ Superforms are built out of [Phlex components](https://www.phlex.fun/html/compon
 
 ```ruby
 # ./app/views/forms/application_form.rb
-class ApplicationForm < ApplicationForm
-  class MyInputComponent < ApplicationComponent
+class ApplicationForm < Superform::Rails::Form
+  class MyInputComponent < Superform::Rails::Components::InputComponent
     def template(&)
       div class: "form-field" do
         input(**attributes)
-        if field.errors?
-          p(class: "form-field-error") { field.errors.to_sentence }
-        end
       end
     end
   end
 
-  class Field < Field
+  class Field < Superform::Rails::Form::Field
     def input(**attributes)
       MyInputComponent.new(self, attributes: attributes)
     end
@@ -107,6 +104,44 @@ Then render it from Erb.
 
 Much better!
 
+### Namespacing forms
+
+By default Superform will namespace 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)
+# This will render inputs with the name `user[email]`
+
+render LoginForm.new(Admin::User.new)
+# This will render inputs with the name `admin_user[email]`
+```
+
+If you want to customize the form namespace, you can override the `key` method in your form.
+
+```ruby
+class UserForm < Superform::Rails::Form
+  def template
+    render field(:email).input
+  end
+  
+  def key
+    "user"
+  end
+end
+
+render UserForm.new(User.new)
+# This will render inputs 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.
@@ -165,6 +200,7 @@ class SignupForm < ApplicationForm
 end
 ```
 
+
 ## 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:
@@ -247,7 +283,7 @@ Rails ships with a lot of great options to make forms. Many of these inspired Su
 
 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 Simpleform, 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.
+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
 

data/lib/generators/superform/install/install_generator.rb

@@ -1,9 +1,13 @@
+require "bundler"
+
 class Superform::InstallGenerator < Rails::Generators::Base
   source_root File.expand_path("templates", __dir__)
 
   APPLICATION_CONFIGURATION_PATH = Rails.root.join("config/application.rb")
 
   def install_phlex_rails
+    return if gem_in_bundle? "phlex-rails"
+
     gem "phlex-rails"
     generate "phlex:install"
   end
@@ -21,4 +25,9 @@ class Superform::InstallGenerator < Rails::Generators::Base
   def create_application_form
     template "application_form.rb", Rails.root.join("app/views/forms/application_form.rb")
   end
+
+  private
+    def gem_in_bundle?(gem_name)
+      Bundler.load.specs.any? { |spec| spec.name == gem_name }
+    end
 end

data/lib/superform/rails.rb

@@ -20,7 +20,6 @@ module Superform
           :field,
           :collection,
           :namespace,
-          :key,
           :assign,
           :serialize,
         to: :@namespace
@@ -29,8 +28,8 @@ module Superform
       # in your subclass you may have something like this:
       #
       # ```ruby
-      # class MyForm
-      #   class MyLabel < LabelComponent
+      # class MyForm < Superform::Rails::Form
+      #   class MyLabel < Superform::Rails::Components::LabelComponent
       #     def template(&content)
       #       label(form: @field.dom.name, class: "text-bold", &content)
       #     end
@@ -38,7 +37,7 @@ module Superform
       #
       #   class Field < Field
       #     def label(**attributes)
-      #       MyLabel.new(self, attributes: **attributes)
+      #       MyLabel.new(self, **attributes)
       #     end
       #   end
       # end
@@ -80,7 +79,7 @@ module Superform
         @action = action
         @method = method
         @attributes = attributes
-        @namespace = Namespace.root(model.model_name.param_key, object: model, field_class: self.class::Field)
+        @namespace = Namespace.root(key, object: model, field_class: self.class::Field)
       end
 
       def around_template(&)
@@ -107,6 +106,10 @@ module Superform
         )
       end
 
+      def key
+        @model.model_name.param_key
+      end
+
       protected
         def authenticity_token_field
           input(
@@ -334,4 +337,4 @@ module Superform
       end
     end
   end
-end
+end

data/lib/superform/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: superform
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.4.6
 platform: ruby
 authors:
 - Brad Gessler
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-10 00:00:00.000000000 Z
+date: 2024-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: phlex-rails