partial_form 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 35c22d1a3abf0d4b2827af73c6a28a1128d5a3ea37719aadfe6b033966bd3f90
+  data.tar.gz: 3f63f0465f0d6547ae2740e312cc6f814644acd59c91923ef02166e21bf8b8ca
+SHA512:
+  metadata.gz: 5b225a18088404fb2746c000c262780207b97d2db81992cb83a95e9591cc186e9ae63dd7dc276057413fc9e7b8ac0157d79ec729f6a0abd61854b0f26e6f7e1b
+  data.tar.gz: 77b4cf2729f0e77a2656203c5e630957931562adb04327a9d488bac9a24977f904a7a6d0664f22288f10206f05bb0b2ecd294f08198c2d37a14415d2f8e48963

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## [0.1.0] - 2024-11-01
+
+- Initial release
+
+## [Unreleased]
+
+- ...

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Tom Rothe
+
+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,154 @@
+# PartialForm
+
+Customizable forms for Rails using partials!
+
+The PartialForm gem simplifies the rendering of form fields by providing a `FormBuilder` that leverages partials. This approach streamlines the management and maintenance of the field helper markup.
+
+Potential uses are:
+
+- Show error messages right next to the input field
+- Render labels along with the inputs
+- Indicate if a field is required or optional
+- Keep the field markup & CSS classes consistent throughout the app
+- Add more complex input fields (such as a barcode input or a custom date range picker)
+
+## Installation & Usage
+
+You can install the gem using `bundler add partial_form`.
+
+The gem provides a form builder named `PartialForm::Builder`, here an example:
+
+```erb
+<%# app/views/article/_form.html.erb %>
+<%= form_with model: @article, builder: PartialForm::Builder do |f|  %>
+  <%= f._text_field :title # mind the prefix, renders app/views/form/_text_field.html.erb %>
+  <%= f._date_field :published_on, hint: "The release date" # pass arbitrary options to the partial %>
+  <%= f.text_field :slug # the default form helper is available without prefix %>
+<% end %>
+```
+
+The `PartialForm::Builder` mimics the API of the [default FormBuilder](https://api.rubyonrails.org/classes/ActionView/Helpers/FormBuilder.html) but adds a `_` prefix.
+The partial builder comes with default templates for each helper. These render something like this (for an invalid field):
+
+```html
+<!-- example for the rendered output of an included template -->
+<div class="form-group">
+  <label for="article_title">Published On</label>
+  <input type="date" name="article[published_on]" id="article_published_on" class="invalid">
+  <p class="form-errors">can't be blank</p>
+  <p class="form-hint">The release date</p>
+</div>
+```
+
+If you want to set the builder as default builder for all your forms, you can:
+
+```ruby
+class ApplicationController < ActionController::Base
+  default_form_builder PartialForm::Builder
+end
+```
+
+## Documentation
+
+Find the [latest documentation](https://motine.github.io/partial_form/).
+
+Here an extensive list of all helpers: `_label`, `_text_field`, `_color_field`, `_date_field`, `_datetime_field`, `_datetime_local_field`, `_email_field`, `_file_field`, `_hidden_field`, `_month_field`, `_number_field`, `_password_field`, `_phone_field`, `_range_field`, `_search_field`, `_telephone_field`, `_text_area`, `_time_field`, `_url_field`, `_week_field`, `_check_box`, `_radio_button`, `_select`, `_collection_select`, `_grouped_collection_select`, `_time_zone_select`, `_weekday_select`, `_collection_check_boxes`, `_collection_radio_buttons`, `_button`, `_submit`
+
+## Customize the builder
+
+You can copy the standard partials to your application using:
+
+```bash
+rails g partial_form:partials
+# Which partials do you want to copy? [default, all] default
+#   create  app/views/layouts/form/_wrapper.html.erb
+#   create  app/views/layouts/form/_text_field.html.erb
+#   create  app/views/layouts/form/_label.html.erb
+#   create  app/views/layouts/form/_submit.html.erb
+```
+
+Here an example how to **customize an existing helper** (`_text_field`) partial:
+
+```erb
+<%# available locals: f, method, options, errors; all keyword arguments passed to the `_text_field` are accessible via `options` %>
+<%= f.label method, class: "mb-3" # call the default form builder helper %>
+<%= f.text_field method, options.merge!(class: class_names(options[:class], "mb-3 border", invalid: errors.any?)) # make sure to retain passed `class` %>
+<% if errors.any? -%>
+  <p class="mt-4 text-red-200"><%= errors.to_sentence %></p>
+<% end %>
+```
+
+Please mind that some helpers use `options` and others `html_options` and check the [documentation](https://motine.github.io/partial_form/).
+
+To **add a new helper method**, you can derive from the `PartialForm::Builder` and a new method as well as a partial:
+
+```ruby
+class MyBuilder < PartialForm::Builder
+  def _fancy_field(method, options = {})
+    render_simple_field(:_fancy_field, method, options) # renders the partial `views/layouts/form/_fancy_field` and passes the default arguments such as `f`, `method`, `errors`, etc.
+  end
+
+  def _super_fancy_field(bells)
+    whistles = Whistle.all
+    render_partial("super", {f: self, bells:, whistles:}) # renders `views/layouts/form/_super` and passes `f`, `bells`, `whistles`
+  end
+end
+```
+
+## Develop & Contribute
+
+Bug reports and pull requests are welcome on [GitHub](https://github.com/motine/partial_form).
+
+The easiest way to get a development environment is to build and use a Docker image:
+
+```bash
+# build and enter the dev container
+docker build -t partial_form .
+docker run -it --rm -v $(pwd):/app -p 3000:3000 partial_form
+
+# use the demo app for testing
+_demo_app/bin/rails s -b 0.0.0.0 # visit http://localhost:3000 (the gem is reloaded in a very sloppy manner)
+
+# useful commands
+rake test
+rake standard:fix
+rake # run both
+rake rdoc
+```
+
+## Release
+
+This section is intended for the maintainer.
+
+```shell
+# make changes
+rake # preflight
+# review and edit CHANGELOG.md
+# edit lib/partial_form/version.rb
+export VERSION=0.1.0
+git commit -am "version bump"
+git tag $VERSION
+gem build partial_form.gemspec
+gem push partial_form-$VERSION.gem
+git push && git push --tags
+```
+
+# Alternatives
+
+Currently, there are multiple ways to solve the problem of adapting the markup for form fields. There is a [dedicated section](https://guides.rubyonrails.org/form_helpers.html#customizing-form-builders) in the [Action View Form Helpers Guide](https://guides.rubyonrails.org/form_helpers.html) on how to customize form elements. Some cases can even be solved with dedicated configuration options such as [field_error_proc](https://guides.rubyonrails.org/configuring.html#config-action-view-field-error-proc).
+
+In my opinion, these approaches are either verbose or too limited to solve the use cases above.
+
+- **Copy the required logic & markup into templates** Repeating the markup in some views may keep the cross-dependencies low. However, copying the same (faulty) markup/logic to all forms, decreases maintainability.
+- **Introduce helper methods** Helpers are a very convenient way to refactor repeating code. However, specifying markup in helpers can easily become unreadable if the logic becomes more involved. Also, helpers do not have access to the form object unless passed explicitly.
+- **Add a form builder** Form builders are made for adapting and extending form field rendering. They are a great tool. However, similar to introducing helper methods, specifying the markup can become cumbersome ([example gist](https://gist.github.com/motine/dc47f6ceeaaea96e855a2dd7f4ef83ae)) and hard to read.
+- **Refactor to partials** Partials are geared towards defining markup structures. They keep code readable even if logic becomes more complicated. However, partials do not have access to the form object per se. Also, using the `render` syntax does not communicate the type of input as well as a form builder method (`render "forms/text_field", method: :title, builder: f` vs. `f.text_field :title`).
+- **Pull in a form builder gem** There are [many gems](https://awesome-ruby.com/#-form-builder), that allow customizing form rendering. Each of them, has its own way to adapt the behavior. This requires the developer to learn these ([sometimes complicated](https://github.com/heartcombo/simple_form?tab=readme-ov-file#the-wrappers-api)) concepts. Also, some gems provide additional functionality which may not be needed (e.g. automatic collection population).
+
+If you are interested in more details, please check the discussion on [discuss.rubyonrails.org](https://discuss.rubyonrails.org/t/introduce-a-standard-formbuilder-that-leverages-partials/86790).
+
+The [view_partial_form_builder gem](https://github.com/seanpdoyle/view_partial_form_builder) is similar to this gem, however there are subtle differences.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/views/layouts/form/_button.html.erb

@@ -0,0 +1,2 @@
+<%# available locals: f, value, options, block %>
+<%= f.button value, options, &block %>

data/app/views/layouts/form/_check_box.html.erb

@@ -0,0 +1,4 @@
+<%# available locals: f, method, options, checked_value, unchecked_value, errors %>
+<%= render("layouts/form/wrapper", **local_assigns) do -%>
+  <%= f.check_box method, options, checked_value, unchecked_value %>
+<% end %>

data/app/views/layouts/form/_collection_check_boxes.html.erb

@@ -0,0 +1,5 @@
+<%# available locals: f, method, collection, value_method, text_method, options, html_options, block, errors %>
+<%= render("layouts/form/wrapper", **local_assigns) do -%>
+  <%= f.collection_check_boxes method, collection, value_method, text_method, options, html_options, &block %>
+<% end %>
+

data/app/views/layouts/form/_collection_radio_buttons.html.erb

@@ -0,0 +1,4 @@
+<%# available locals: f, method, collection, value_method, text_method, options, html_options, block, errors %>
+<%= render("layouts/form/wrapper", **local_assigns) do -%>
+  <%= f.collection_radio_buttons method, collection, value_method, text_method, options, html_options, &block %>
+<% end %>

data/app/views/layouts/form/_collection_select.html.erb

@@ -0,0 +1,4 @@
+<%# available locals: method, collection, value_method, text_method, options, html_options, errors %>
+<%= render("layouts/form/wrapper", **local_assigns) do -%>
+  <%= f.collection_select method, collection, value_method, text_method, options, html_options %>
+<% end %>

data/app/views/layouts/form/_color_field.html.erb

@@ -0,0 +1,4 @@
+<%# please see _text_field partial for available locals %>
+<%= render("layouts/form/wrapper", **local_assigns) do -%>
+  <%= f.color_field method, options %>
+<% end %>

data/app/views/layouts/form/_date_field.html.erb

@@ -0,0 +1,4 @@
+<%# please see _text_field partial for available locals %>
+<%= render("layouts/form/wrapper", **local_assigns) do -%>
+  <%= f.date_field method, options %>
+<% end %>

data/app/views/layouts/form/_datetime_field.html.erb

@@ -0,0 +1,4 @@
+<%# please see _text_field partial for available locals %>
+<%= render("layouts/form/wrapper", **local_assigns) do -%>
+  <%= f.datetime_field method, options %>
+<% end %>

data/app/views/layouts/form/_datetime_local_field.html.erb

@@ -0,0 +1,4 @@
+<%# please see _text_field partial for available locals %>
+<%= render("layouts/form/wrapper", **local_assigns) do -%>
+  <%= f.datetime_local_field method, options %>
+<% end %>

data/app/views/layouts/form/_email_field.html.erb

@@ -0,0 +1,4 @@
+<%# please see _text_field partial for available locals %>
+<%= render("layouts/form/wrapper", **local_assigns) do -%>
+  <%= f.email_field method, options %>
+<% end %>

data/app/views/layouts/form/_file_field.html.erb

@@ -0,0 +1,4 @@
+<%# please see _text_field partial for available locals %>
+<%= render("layouts/form/wrapper", **local_assigns) do -%>
+  <%= f.file_field method, options %>
+<% end %>

data/app/views/layouts/form/_grouped_collection_select.html.erb

@@ -0,0 +1,4 @@
+<%# available locals: f, method, collection, group_method, group_label_method, option_key_method, option_value_method, options, html_options, errors %>
+<%= render("layouts/form/wrapper", **local_assigns) do -%>
+  <%= f.grouped_collection_select method, collection, group_method, group_label_method, option_key_method, option_value_method, options, html_options %>
+<% end %>

data/app/views/layouts/form/_hidden_field.html.erb

@@ -0,0 +1,4 @@
+<%# please see _text_field partial for available locals %>
+<%= render("layouts/form/wrapper", **local_assigns) do -%>
+  <%= f.hidden_field method, options %>
+<% end %>

data/app/views/layouts/form/_label.html.erb

@@ -0,0 +1,4 @@
+<%# available locals: f, method, options, block, errors and text (can be `nil` to infer via I18n or `false` to skip this label) %>
+<% unless text == false # we always render the label unless the `false` is given -%>
+  <%= f.label method, text, options, &block %>
+<% end %>

data/app/views/layouts/form/_month_field.html.erb

@@ -0,0 +1,4 @@
+<%# please see _text_field partial for available locals %>
+<%= render("layouts/form/wrapper", **local_assigns) do -%>
+  <%= f.month_field method, options %>
+<% end %>

data/app/views/layouts/form/_number_field.html.erb

@@ -0,0 +1,4 @@
+<%# please see _text_field partial for available locals %>
+<%= render("layouts/form/wrapper", **local_assigns) do -%>
+  <%= f.number_field method, options %>
+<% end %>

data/app/views/layouts/form/_password_field.html.erb

@@ -0,0 +1,4 @@
+<%# please see _text_field partial for available locals %>
+<%= render("layouts/form/wrapper", **local_assigns) do -%>
+  <%= f.password_field method, options %>
+<% end %>

data/app/views/layouts/form/_phone_field.html.erb

@@ -0,0 +1,4 @@
+<%# please see _text_field partial for available locals %>
+<%= render("layouts/form/wrapper", **local_assigns) do -%>
+  <%= f.phone_field method, options %>
+<% end %>

data/app/views/layouts/form/_radio_button.html.erb

@@ -0,0 +1,4 @@
+<%# available locals: f, method, tag_value, options, errors %>
+<%= render("layouts/form/wrapper", **local_assigns) do -%>
+  <%= f.radio_button method, tag_value, options %>
+<% end %>

data/app/views/layouts/form/_range_field.html.erb

@@ -0,0 +1,4 @@
+<%# please see _text_field partial for available locals %>
+<%= render("layouts/form/wrapper", **local_assigns) do -%>
+  <%= f.range_field method, options %>
+<% end %>

data/app/views/layouts/form/_search_field.html.erb

@@ -0,0 +1,4 @@
+<%# please see _text_field partial for available locals %>
+<%= render("layouts/form/wrapper", **local_assigns) do -%>
+  <%= f.search_field method, options %>
+<% end %>

data/app/views/layouts/form/_select.html.erb

@@ -0,0 +1,4 @@
+<%# available locals: f, method, choices, options, html_options, block, errors %>
+<%= render("layouts/form/wrapper", **local_assigns) do -%>
+  <%= f.select method, choices, options, html_options, &block %>
+<% end %>

data/app/views/layouts/form/_submit.html.erb

@@ -0,0 +1,2 @@
+<%# available locals: f, value, options %>
+<%= f.submit value, options %>

data/app/views/layouts/form/_telephone_field.html.erb

@@ -0,0 +1,4 @@
+<%# please see _text_field partial for available locals %>
+<%= render("layouts/form/wrapper", **local_assigns) do -%>
+  <%= f.telephone_field method, options %>
+<% end %>

data/app/views/layouts/form/_text_area.html.erb

@@ -0,0 +1,4 @@
+<%# please see _text_field partial for available locals %>
+<%= render("layouts/form/wrapper", **local_assigns) do -%>
+  <%= f.text_area method, options %>
+<% end %>

data/app/views/layouts/form/_text_field.html.erb

@@ -0,0 +1,4 @@
+<%# available locals: f, method, options, errors %>
+<%= render("layouts/form/wrapper", **local_assigns) do -%>
+  <%= f.text_field method, options -%>
+<% end %>

data/app/views/layouts/form/_time_field.html.erb

@@ -0,0 +1,4 @@
+<%# please see _text_field partial for available locals %>
+<%= render("layouts/form/wrapper", **local_assigns) do -%>
+  <%= f.time_field method, options %>
+<% end %>

data/app/views/layouts/form/_time_zone_select.html.erb

@@ -0,0 +1,4 @@
+<%# available locals: f, method, priority_zones, options, html_options, errors %>
+<%= render("layouts/form/wrapper", **local_assigns) do -%>
+  <%= f.time_zone_select method, priority_zones, options, html_options %>
+<% end %>

data/app/views/layouts/form/_url_field.html.erb

@@ -0,0 +1,4 @@
+<%# please see _text_field partial for available locals %>
+<%= render("layouts/form/wrapper", **local_assigns) do -%>
+  <%= f.url_field method, options %>
+<% end %>

data/app/views/layouts/form/_week_field.html.erb

@@ -0,0 +1,4 @@
+<%# please see _text_field partial for available locals %>
+<%= render("layouts/form/wrapper", **local_assigns) do -%>
+  <%= f.week_field method, options %>
+<% end %>

data/app/views/layouts/form/_weekday_select.html.erb

@@ -0,0 +1,4 @@
+<%# available locals: f, method, options, html_options, errors %>
+<%= render("layouts/form/wrapper", **local_assigns) do -%>
+  <%= f.weekday_select method, options, html_options %>
+<% end %>

data/app/views/layouts/form/_wrapper.html.erb

@@ -0,0 +1,15 @@
+<%# please see _text_field partial for available locals %>
+<%
+  options_target = defined?(html_options) ? html_options : options # in some helper methods the class must be added to `options`, in others to `html_options`
+  options_target.merge!(class: class_names(options_target[:class], invalid: errors.any?))
+%>
+<div class="form-group">
+  <%= f._label method, options.delete(:label) -%>
+  <%= yield -%>
+  <% if errors.any? -%>
+    <p class="form-errors"><%= errors.to_sentence %></p>
+  <% end %>
+  <% if options[:hint].present? %>
+    <p class="form-hint"><%= options[:hint] %></p>
+  <% end %>
+</div>

data/lib/generators/partial_form/partials_generator.rb

@@ -0,0 +1,42 @@
+module PartialForm
+  module Generators
+    class PartialsGenerator < Rails::Generators::Base
+      SELECTION_GLOBS = {
+        default: "_{wrapper,text_field,label,submit}*.erb",
+        all: "*.erb"
+      }
+      FORM_PARTIALS_PATH = Pathname(__dir__).join("../../../app/views/layouts/form")
+      source_root FORM_PARTIALS_PATH
+      argument :given_selection, type: :string, optional: true, banner: "SELECTION" # optional because we ask for it if the user does not specify it
+
+      def self.banner # :nodoc:
+        <<~BANNER
+          rails g partial_form:partials SELECTION [options]
+
+          Copies partial templates to your application.
+          You can choose if all partials or only a subset is copied.
+          Pick on of: #{SELECTION_GLOBS.keys.join(", ")}
+        BANNER
+      end
+
+      def validate_selection
+        @selection = given_selection
+        valid_selections = SELECTION_GLOBS.keys.map(&:to_s)
+        if @selection.blank?
+          @selection = ask("Which partials do you want to copy?", limited_to: valid_selections)
+        end
+        unless valid_selections.include?(@selection)
+          raise Thor::Error, "Please choose a valid selection (first parameter): #{valid_selections.join(", ")}"
+        end
+      end
+
+      def copy_partials
+        pattern = SELECTION_GLOBS[@selection.to_sym]
+        filenames = FORM_PARTIALS_PATH.glob(pattern).map { _1.basename }
+        filenames.each do |filename|
+          copy_file filename, "app/views/layouts/form/#{filename}"
+        end
+      end
+    end
+  end
+end

data/lib/partial_form/builder.rb

@@ -0,0 +1,309 @@
+require "action_view"
+
+module PartialForm
+  ##
+  # The builder allows the rendering of form fields similar to rails default `FormBuilder`.
+  # This Builder uses partials to manage and maintain the form field markup code.
+  # The Builder mimics the API of the default [Rails FormBuilder](https://api.rubyonrails.org/classes/ActionView/Helpers/FormBuilder.html) with the prefix `_`.
+  #
+  # The general idea is that each helper renders a dedicated partial and passes the arguments: `f`, `method`, `options`, `errors`.
+  #
+  # Please see README.md for more details.
+  class Builder < ActionView::Helpers::FormBuilder
+    def initialize(*) # :nodoc:
+      super
+      # CAUTION
+      # we want to make sure that fields are not wrapped by a "field_with_errors" proc
+      # this change affects all builders working on the current template
+      @template.field_error_proc = proc { |html_tag, instance| html_tag }
+    end
+
+    SIMPLE_FIELD_HELPER = [ # :nodoc:
+      :color_field, :date_field, :datetime_field, :datetime_local_field, :email_field, :file_field,
+      :hidden_field, :month_field, :number_field, :password_field, :phone_field, :range_field,
+      :search_field, :telephone_field, :text_field, :text_area, :time_field, :url_field, :week_field
+    ]
+
+    ##
+    # :method: _text_field
+    # :call-seq: _text_field(method, options = {})
+    #
+    # Renders the partial `views/layouts/form/_text_field`.
+    # All options are forwarded to the partial. Typically, options such as `label` and `hint` are taken into account with the template.
+    # Please checkout the examples in the README.md
+    #
+    # The partial template usually wraps the original field helper which can be found here: [ActionView::Helpers::FormBuilder#text_field](https://api.rubyonrails.org/classes/ActionView/Helpers/FormBuilder.html#method-i-text_field).
+
+    ##
+    # :method: _color_field
+    # :call-seq: _color_field(method, options = {})
+    #
+    # Renders the partial `views/layouts/form/_color_field`.
+    #
+    # Please see #_text_field for more details. The partial template usually wraps [ActionView::Helpers::FormBuilder#color_field](https://api.rubyonrails.org/classes/ActionView/Helpers/FormBuilder.html#method-i-color_field).
+
+    ##
+    # :method: _date_field
+    # :call-seq: _date_field(method, options = {})
+    #
+    # Renders the partial `views/layouts/form/_date_field`.
+    #
+    # Please see #_text_field for more details. The partial template usually wraps [ActionView::Helpers::FormBuilder#date_field](https://api.rubyonrails.org/classes/ActionView/Helpers/FormBuilder.html#method-i-date_field).
+
+    ##
+    # :method: _datetime_field
+    # :call-seq: _datetime_field(method, options = {})
+    #
+    # Renders the partial `views/layouts/form/_datetime_field`.
+    #
+    # Please see #_text_field for more details. The partial template usually wraps [ActionView::Helpers::FormBuilder#datetime_field](https://api.rubyonrails.org/classes/ActionView/Helpers/FormBuilder.html#method-i-datetime_field).
+
+    ##
+    # :method: _datetime_local_field
+    # :call-seq: _datetime_local_field(method, options = {})
+    #
+    # Renders the partial `views/layouts/form/_datetime_local_field`.
+    #
+    # Please see #_text_field for more details. The partial template usually wraps [ActionView::Helpers::FormBuilder#text_fielddatetime_local_fieldhttps://api.rubyonrails.org/classes/ActionView/Helpers/FormBuilder.html#method-i-datetime_local_field).
+
+    ##
+    # :method: _email_field
+    # :call-seq: _email_field(method, options = {})
+    #
+    # Renders the partial `views/layouts/form/_email_field`.
+    #
+    # Please see #_text_field for more details. The partial template usually wraps [ActionView::Helpers::FormBuilder#email_field](https://api.rubyonrails.org/classes/ActionView/Helpers/FormBuilder.html#method-i-email_field).
+
+    ##
+    # :method: _file_field
+    # :call-seq: _file_field(method, options = {})
+    #
+    # Renders the partial `views/layouts/form/_file_field`.
+    #
+    # Please see #_text_field for more details. The partial template usually wraps [ActionView::Helpers::FormBuilder#file_field](https://api.rubyonrails.org/classes/ActionView/Helpers/FormBuilder.html#method-i-file_field).
+
+    ##
+    # :method: _hidden_field
+    # :call-seq: _hidden_field(method, options = {})
+    #
+    # Renders the partial `views/layouts/form/_hidden_field`.
+    #
+    # Please see #_text_field for more details. The partial template usually wraps [ActionView::Helpers::FormBuilder#hidden_field](https://api.rubyonrails.org/classes/ActionView/Helpers/FormBuilder.html#method-i-hidden_field).
+
+    ##
+    # :method: _month_field
+    # :call-seq: _month_field(method, options = {})
+    #
+    # Renders the partial `views/layouts/form/_month_field`.
+    #
+    # Please see #_text_field for more details. The partial template usually wraps [ActionView::Helpers::FormBuilder#month_field](https://api.rubyonrails.org/classes/ActionView/Helpers/FormBuilder.html#method-i-month_field).
+
+    ##
+    # :method: _number_field
+    # :call-seq: _number_field(method, options = {})
+    #
+    # Renders the partial `views/layouts/form/_number_field`.
+    #
+    # Please see #_text_field for more details. The partial template usually wraps [ActionView::Helpers::FormBuilder#number_field](https://api.rubyonrails.org/classes/ActionView/Helpers/FormBuilder.html#method-i-number_field).
+
+    ##
+    # :method: _password_field
+    # :call-seq: _password_field(method, options = {})
+    #
+    # Renders the partial `views/layouts/form/_password_field`.
+    #
+    # Please see #_text_field for more details. The partial template usually wraps [ActionView::Helpers::FormBuilder#password_field](https://api.rubyonrails.org/classes/ActionView/Helpers/FormBuilder.html#method-i-password_field).
+
+    ##
+    # :method: _phone_field
+    # :call-seq: _phone_field(method, options = {})
+    #
+    # Renders the partial `views/layouts/form/_phone_field`.
+    #
+    # Please see #_text_field for more details. The partial template usually wraps [ActionView::Helpers::FormBuilder#phone_field](https://api.rubyonrails.org/classes/ActionView/Helpers/FormBuilder.html#method-i-phone_field).
+
+    ##
+    # :method: _range_field
+    # :call-seq: _range_field(method, options = {})
+    #
+    # Renders the partial `views/layouts/form/_range_field`.
+    #
+    # Please see #_text_field for more details. The partial template usually wraps [ActionView::Helpers::FormBuilder#range_field](https://api.rubyonrails.org/classes/ActionView/Helpers/FormBuilder.html#method-i-range_field).
+
+    ##
+    # :method: _search_field
+    # :call-seq: _search_field(method, options = {})
+    #
+    # Renders the partial `views/layouts/form/_search_field`.
+    #
+    # Please see #_text_field for more details. The partial template usually wraps [ActionView::Helpers::FormBuilder#search_field](https://api.rubyonrails.org/classes/ActionView/Helpers/FormBuilder.html#method-i-search_field).
+
+    ##
+    # :method: _telephone_field
+    # :call-seq: _telephone_field(method, options = {})
+    #
+    # Renders the partial `views/layouts/form/_telephone_field`.
+    #
+    # Please see #_text_field for more details. The partial template usually wraps [ActionView::Helpers::FormBuilder#telephone_field](https://api.rubyonrails.org/classes/ActionView/Helpers/FormBuilder.html#method-i-telephone_field).
+
+    ##
+    # :method: _text_area
+    # :call-seq: _text_area(method, options = {})
+    #
+    # Renders the partial `views/layouts/form/_text_area`.
+    #
+    # Please see #_text_field for more details. The partial template usually wraps [ActionView::Helpers::FormBuilder#text_area](https://api.rubyonrails.org/classes/ActionView/Helpers/FormBuilder.html#method-i-text_area).
+
+    ##
+    # :method: _time_field
+    # :call-seq: _time_field(method, options = {})
+    #
+    # Renders the partial `views/layouts/form/_time_field`.
+    #
+    # Please see #_text_field for more details. The partial template usually wraps [ActionView::Helpers::FormBuilder#time_field](https://api.rubyonrails.org/classes/ActionView/Helpers/FormBuilder.html#method-i-time_field).
+
+    ##
+    # :method: _url_field
+    # :call-seq: _url_field(method, options = {})
+    #
+    # Renders the partial `views/layouts/form/_url_field`.
+    #
+    # Please see #_text_field for more details. The partial template usually wraps [ActionView::Helpers::FormBuilder#url_field](https://api.rubyonrails.org/classes/ActionView/Helpers/FormBuilder.html#method-i-url_field).
+
+    ##
+    # :method: _week_field
+    # :call-seq: _week_field(method, options = {})
+    #
+    # Renders the partial `views/layouts/form/_week_field`.
+    #
+    # Please see #_text_field for more details. The partial template usually wraps [ActionView::Helpers::FormBuilder#week_field](https://api.rubyonrails.org/classes/ActionView/Helpers/FormBuilder.html#method-i-week_field).
+
+    SIMPLE_FIELD_HELPER.each do |method_name|
+      define_method :"_#{method_name}" do |method, options = {}|
+        render_simple_field(__method__, method, options)
+      end
+    end
+
+    ##
+    # Renders the partial `views/layouts/form/_label`.
+    #
+    # The partial template usually wraps [ActionView::Helpers::FormBuilder#label](https://api.rubyonrails.org/classes/ActionView/Helpers/FormBuilder.html#method-i-label).
+    def _label(method, text = nil, options = {}, &block)
+      errors = object.errors.messages_for(method)
+      render_partial("label", {f: self, method:, text:, errors:, options:, block:})
+    end
+
+    ##
+    # Renders the partial `views/layouts/form/_button`.
+    #
+    # The partial template usually wraps [ActionView::Helpers::FormBuilder#button](https://api.rubyonrails.org/classes/ActionView/Helpers/FormBuilder.html#method-i-button).
+    def _button(value = nil, options = {}, &block)
+      render_partial("button", {f: self, value:, options:, block:})
+    end
+
+    ##
+    # Renders the partial `views/layouts/form/_submit`.
+    #
+    # The partial template usually wraps [ActionView::Helpers::FormBuilder#submit](https://api.rubyonrails.org/classes/ActionView/Helpers/FormBuilder.html#method-i-submit).
+    def _submit(value = nil, options = {})
+      render_partial("submit", {f: self, value:, options:})
+    end
+
+    ##
+    # Renders the partial `views/layouts/form/_check_box`.
+    #
+    # The partial template usually wraps [ActionView::Helpers::FormBuilder#check_box](https://api.rubyonrails.org/classes/ActionView/Helpers/FormBuilder.html#method-i-check_box).
+    def _check_box(method, options = {}, checked_value = "1", unchecked_value = "0")
+      errors = object.errors.messages_for(method)
+      render_partial("check_box", {f: self, method:, options:, checked_value:, unchecked_value:, errors:})
+    end
+
+    ##
+    # Renders the partial `views/layouts/form/_radio_button`.
+    #
+    # The partial template usually wraps [ActionView::Helpers::FormBuilder#radio_button](https://api.rubyonrails.org/classes/ActionView/Helpers/FormBuilder.html#method-i-radio_button).
+    def _radio_button(method, tag_value, options = {})
+      errors = object.errors.messages_for(method)
+      render_partial("radio_button", {f: self, method:, tag_value:, options:, errors:})
+    end
+
+    ##
+    # Renders the partial `views/layouts/form/_select`.
+    #
+    # The partial template usually wraps [ActionView::Helpers::FormBuilder#select](https://api.rubyonrails.org/classes/ActionView/Helpers/FormBuilder.html#method-i-select).
+    def _select(method, choices = nil, options = {}, html_options = {}, &block)
+      errors = object.errors.messages_for(method)
+      render_partial("select", {f: self, method:, choices:, options:, html_options:, block:, errors:})
+    end
+
+    ##
+    # Renders the partial `views/layouts/form/_collection_select`.
+    #
+    # The partial template usually wraps [ActionView::Helpers::FormBuilder#collection_select](https://api.rubyonrails.org/classes/ActionView/Helpers/FormBuilder.html#method-i-collection_select).
+    def _collection_select(method, collection, value_method, text_method, options = {}, html_options = {})
+      errors = object.errors.messages_for(method)
+      render_partial("collection_select", {f: self, method:, collection:, value_method:, text_method:, options:, html_options:, errors:})
+    end
+
+    ##
+    # Renders the partial `views/layouts/form/_grouped_collection_select`.
+    #
+    # The partial template usually wraps [ActionView::Helpers::FormBuilder#grouped_collection_select](https://api.rubyonrails.org/classes/ActionView/Helpers/FormBuilder.html#method-i-grouped_collection_select).
+    def _grouped_collection_select(method, collection, group_method, group_label_method, option_key_method, option_value_method, options = {}, html_options = {})
+      errors = object.errors.messages_for(method)
+      render_partial("grouped_collection_select", {f: self, method:, collection:, group_method:, group_label_method:, option_key_method:, option_value_method:, options:, html_options:, errors:})
+    end
+
+    ##
+    # Renders the partial `views/layouts/form/_time_zone_select`.
+    #
+    # The partial template usually wraps [ActionView::Helpers::FormBuilder#time_zone_select](https://api.rubyonrails.org/classes/ActionView/Helpers/FormBuilder.html#method-i-time_zone_select).
+    def _time_zone_select(method, priority_zones = nil, options = {}, html_options = {})
+      errors = object.errors.messages_for(method)
+      render_partial("time_zone_select", {f: self, method:, priority_zones:, options:, html_options:, errors:})
+    end
+
+    ##
+    # Renders the partial `views/layouts/form/_weekday_select`.
+    #
+    # The partial template usually wraps [ActionView::Helpers::FormBuilder#weekday_select](https://api.rubyonrails.org/classes/ActionView/Helpers/FormBuilder.html#method-i-weekday_select).
+    def _weekday_select(method, options = {}, html_options = {})
+      errors = object.errors.messages_for(method)
+      render_partial("weekday_select", {f: self, method:, options:, html_options:, errors:})
+    end
+
+    ##
+    # Renders the partial `views/layouts/form/_collection_check_boxes`.
+    #
+    # The partial template usually wraps [ActionView::Helpers::FormBuilder#collection_check_boxes](https://api.rubyonrails.org/classes/ActionView/Helpers/FormBuilder.html#method-i-collection_check_boxes).
+    def _collection_check_boxes(method, collection, value_method, text_method, options = {}, html_options = {}, &block)
+      errors = object.errors.messages_for(method)
+      render_partial("collection_check_boxes", {f: self, method:, collection:, value_method:, text_method:, options:, html_options:, block:, errors:})
+    end
+
+    ##
+    # Renders the partial `views/layouts/form/_collection_radio_buttons`.
+    #
+    # The partial template usually wraps [ActionView::Helpers::FormBuilder#collection_radio_buttons](https://api.rubyonrails.org/classes/ActionView/Helpers/FormBuilder.html#method-i-collection_radio_buttons).
+    def _collection_radio_buttons(method, collection, value_method, text_method, options = {}, html_options = {}, &block)
+      errors = object.errors.messages_for(method)
+      render_partial("collection_radio_buttons", {f: self, method:, collection:, value_method:, text_method:, options:, html_options:, block:, errors:})
+    end
+
+    protected
+
+    def render_simple_field(type_with_prefix, method, options) # :nodoc:
+      type = type_with_prefix.to_s.delete_prefix("_")
+      errors = object.errors.messages_for(method)
+      render_partial(type, {f: self, method:, errors:, options:})
+    end
+
+    # Renders the partial with the given name, forwarding the locals to it.
+    def render_partial(partial_name, locals = {})
+      # layout name: controller.send :_layout, self.lookup_context, []
+      partial_path = "layouts/form/#{partial_name}"
+      raise "Please provide #{partial_path} partial" unless @template.lookup_context.exists?(partial_path, [], true) # true stands for partial
+      @template.render(partial: partial_path, locals:)
+    end
+  end
+end

data/lib/partial_form/engine.rb

@@ -0,0 +1,5 @@
+require "rails"
+module PartialForm # :nodoc:
+  class Engine < ::Rails::Engine # :nodoc:
+  end
+end

data/lib/partial_form/version.rb

@@ -0,0 +1,3 @@
+module PartialForm
+  VERSION = "0.1.0"
+end

data/lib/partial_form.rb

@@ -0,0 +1,6 @@
+require_relative "partial_form/version"
+require_relative "partial_form/engine"
+require_relative "partial_form/builder"
+
+module PartialForm
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: partial_form
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tom Rothe
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-11-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+description: The gem simplifies the rendering of form fields by providing a `FormBuilder`
+  that leverages partials. This approach streamlines the management and maintenance
+  of the field helper markup.
+email:
+- info@tomrothe.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- app/views/layouts/form/_button.html.erb
+- app/views/layouts/form/_check_box.html.erb
+- app/views/layouts/form/_collection_check_boxes.html.erb
+- app/views/layouts/form/_collection_radio_buttons.html.erb
+- app/views/layouts/form/_collection_select.html.erb
+- app/views/layouts/form/_color_field.html.erb
+- app/views/layouts/form/_date_field.html.erb
+- app/views/layouts/form/_datetime_field.html.erb
+- app/views/layouts/form/_datetime_local_field.html.erb
+- app/views/layouts/form/_email_field.html.erb
+- app/views/layouts/form/_file_field.html.erb
+- app/views/layouts/form/_grouped_collection_select.html.erb
+- app/views/layouts/form/_hidden_field.html.erb
+- app/views/layouts/form/_label.html.erb
+- app/views/layouts/form/_month_field.html.erb
+- app/views/layouts/form/_number_field.html.erb
+- app/views/layouts/form/_password_field.html.erb
+- app/views/layouts/form/_phone_field.html.erb
+- app/views/layouts/form/_radio_button.html.erb
+- app/views/layouts/form/_range_field.html.erb
+- app/views/layouts/form/_search_field.html.erb
+- app/views/layouts/form/_select.html.erb
+- app/views/layouts/form/_submit.html.erb
+- app/views/layouts/form/_telephone_field.html.erb
+- app/views/layouts/form/_text_area.html.erb
+- app/views/layouts/form/_text_field.html.erb
+- app/views/layouts/form/_time_field.html.erb
+- app/views/layouts/form/_time_zone_select.html.erb
+- app/views/layouts/form/_url_field.html.erb
+- app/views/layouts/form/_week_field.html.erb
+- app/views/layouts/form/_weekday_select.html.erb
+- app/views/layouts/form/_wrapper.html.erb
+- lib/generators/partial_form/partials_generator.rb
+- lib/partial_form.rb
+- lib/partial_form/builder.rb
+- lib/partial_form/engine.rb
+- lib/partial_form/version.rb
+homepage: https://github.com/motine/partial_form
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/motine/partial_form
+  source_code_uri: https://github.com/motine/partial_form/
+  changelog_uri: https://github.com/motine/partial_form/blob/master/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.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: Customizable forms for Rails using partials!
+test_files: []