Merge pull request opf#18894 from opf/code-maintenance/64006-rename-admin_settings_primer_form_with-to-settings_primer_form_with

[64006] Rename `admin_settings_primer_form_with` to `settings_primer_form_with`

Author: cbliard

app/components/custom_fields/details_component.html.erb

@@ -15,7 +15,7 @@
       end
 
       content.with_row do
-        admin_settings_primer_form_with(
+        settings_primer_form_with(
           model:,
           scope: :custom_field,
           id: "custom_field_form",

app/components/op_primer/form_helpers.rb

@@ -113,16 +113,17 @@ def render_inline_settings_form(form_builder, &blk)
     end
 
     # An extension of primers default `primer_form_with`
-    # Renders a primer form with a special wrapper around to limit the width.
+    # Renders a primer form with a special wrapper around to limit the width for
+    # legibility.
     #
     # This method dynamically creates a container around the actual form.
     # All arguments and the content are simply passed through to the `primer_form_with` call
     #
-    # It is meant for settings pages within the administration to
-    # have a unified look and feel for our users.
+    # It is meant for any settings pages like in administration or project
+    # settings to have a unified look and feel for our users.
     #
     # @example
-    #   admin_settings_primer_form_with(scope: :settings, action: :update, method: :patch) do |form|
+    #   settings_primer_form_with(scope: :settings, action: :update, method: :patch) do |form|
     #     render_inline_settings_form(form) do |f|
     #       f.check_box(name: :allow_tracking_start_and_end_times)
     #       f.check_box(name: :enforce_tracking_start_and_end_times)
@@ -133,7 +134,7 @@ def render_inline_settings_form(form_builder, &blk)
     #
     # @param kwargs [Hash] The arguments for the form
     # @param block [Proc] A block that defines the form structure.
-    def admin_settings_primer_form_with(**, &)
+    def settings_primer_form_with(**, &)
       render(Primer::BaseComponent.new(tag: :div, classes: "op-admin-settings-form-wrapper")) do
         primer_form_with(**, &)
       end

app/components/projects/life_cycle_step_definitions/form_component.html.erb

@@ -27,7 +27,7 @@ See COPYRIGHT and LICENSE files for more details.
 
 ++#%>
 
-<%= admin_settings_primer_form_with(
+<%= settings_primer_form_with(
       model: [:admin, :settings, model],
       data: { controller: "show-when-checked" }
     ) do |f|

app/components/projects/settings/general/show_component.html.erb

@@ -30,7 +30,7 @@ See COPYRIGHT and LICENSE files for more details.
 <%=
   flex_layout do |container|
     container.with_row(mb: 3) do
-      admin_settings_primer_form_with(model: project, url: project_settings_general_path(project)) do |f|
+      settings_primer_form_with(model: project, url: project_settings_general_path(project)) do |f|
         concat(
           render(Primer::Beta::Subhead.new) do |component|
             component.with_heading(tag: :h2, size: :medium) { I18n.t("projects.settings.header_details") }
@@ -49,7 +49,7 @@ See COPYRIGHT and LICENSE files for more details.
     end
 
     container.with_row(mb: 3) do
-      admin_settings_primer_form_with(model: project, url: project_settings_general_path(project)) do |f|
+      settings_primer_form_with(model: project, url: project_settings_general_path(project)) do |f|
         concat(
           render(Primer::Beta::Subhead.new) do |component|
             component.with_heading(tag: :h2, size: :medium) { I18n.t("projects.settings.header_status") }
@@ -68,7 +68,7 @@ See COPYRIGHT and LICENSE files for more details.
     end
 
     container.with_row(mb: 3) do
-      admin_settings_primer_form_with(model: project, url: project_settings_general_path(project)) do |f|
+      settings_primer_form_with(model: project, url: project_settings_general_path(project)) do |f|
         concat(
           render(Primer::Beta::Subhead.new) do |component|
             component.with_heading(tag: :h2, size: :medium) { I18n.t("projects.settings.header_relations") }

app/components/work_packages/types/settings_component.html.erb

@@ -28,7 +28,7 @@ See COPYRIGHT and LICENSE files for more details.
 ++#%>
 
 <%=
-  admin_settings_primer_form_with(**form_options) do |f|
+  settings_primer_form_with(**form_options) do |f|
     render(WorkPackages::Types::SettingsForm.new(f))
   end
 %>

app/components/work_packages/types/subject_configuration_component.html.erb

@@ -32,7 +32,7 @@ See COPYRIGHT and LICENSE files for more details.
 %>
 
 <%=
-  admin_settings_primer_form_with(**form_options) do |f|
+  settings_primer_form_with(**form_options) do |f|
     render(WorkPackages::Types::SubjectConfigurationForm.new(f))
   end
 %>

app/views/admin/settings/authentication_settings/_login.html.erb

@@ -28,7 +28,7 @@ See COPYRIGHT and LICENSE files for more details.
 ++#%>
 
 <%=
-  admin_settings_primer_form_with(scope: :settings,
+  settings_primer_form_with(scope: :settings,
                                   url: admin_settings_authentication_path(tab: params[:tab]),
                                   method: :patch) do |f|
     render_inline_settings_form(f) do |form|

app/views/admin/settings/authentication_settings/_passwords.html.erb

@@ -28,7 +28,7 @@ See COPYRIGHT and LICENSE files for more details.
 ++#%>
 
 <%=
-  admin_settings_primer_form_with(scope: :settings,
+  settings_primer_form_with(scope: :settings,
                                   url: admin_settings_authentication_path(tab: params[:tab]),
                                   data: { turbo_method: :patch },
                                   method: :patch) do |f|

app/views/admin/settings/authentication_settings/_registration.html.erb

@@ -28,7 +28,7 @@ See COPYRIGHT and LICENSE files for more details.
 ++#%>
 
 <%=
-  admin_settings_primer_form_with(scope: :settings,
+  settings_primer_form_with(scope: :settings,
                                   url: admin_settings_authentication_path(tab: params[:tab]),
                                   data: { turbo_method: :patch },
                                   method: :patch) do |f|

app/views/admin/settings/progress_tracking/show.html.erb

@@ -38,7 +38,7 @@ See COPYRIGHT and LICENSE files for more details.
   end
 %>
 <%=
-  admin_settings_primer_form_with(
+  settings_primer_form_with(
     scope: :settings, action: :update, method: :patch,
     data: {
       application_target: "dynamic",

app/views/admin/settings/work_package_priorities/edit.html.erb

@@ -43,6 +43,6 @@ See COPYRIGHT and LICENSE files for more details.
   end
 %>
 
-<%= admin_settings_primer_form_with(model: @enumeration, scope: :enumeration, url: url_for(action: :update, id: @enumeration)) do |f| %>
+<%= settings_primer_form_with(model: @enumeration, scope: :enumeration, url: url_for(action: :update, id: @enumeration)) do |f| %>
   <%= render(Admin::Enumerations::ItemForm.new(f)) %>
 <% end %>

app/views/admin/settings/work_package_priorities/new.html.erb

@@ -41,6 +41,6 @@ See COPYRIGHT and LICENSE files for more details.
   end
 %>
 
-<%= admin_settings_primer_form_with(model: @enumeration, scope: :enumeration, url: url_for(action: :create)) do |f| %>
+<%= settings_primer_form_with(model: @enumeration, scope: :enumeration, url: url_for(action: :create)) do |f| %>
   <%= render(Admin::Enumerations::ItemForm.new(f)) %>
 <% end %>

app/views/statuses/edit.html.erb

@@ -44,7 +44,7 @@ See COPYRIGHT and LICENSE files for more details.
 <%= error_messages_for :status %>
 
 <%=
-  admin_settings_primer_form_with(
+  settings_primer_form_with(
     model: @status,
     data: {
       application_target: "dynamic",

lookbook/docs/patterns/17-settings-pages.md.erb

@@ -4,12 +4,12 @@ Settings pages usually stretch to the full width of the viewport as they tend no
 
 As specified in the documentation for [forms](./forms), we prefer limiting the width of a form for legibility. Because the default behaviour of form elements to fill the full width of the container, we wrap forms in a container that limits its available width.
 
-Any view component rendering a form should use the the `admin_settings_primer_form_with` form helper instead of the standard `primer_form_with`. The form itself stays unchanged. This
+Any view component rendering a form should use the the `settings_primer_form_with` form helper instead of the standard `primer_form_with`. The form itself stays unchanged. This
 way, the rendered form is wrapped into a container with `680px` max-width.
 
 ```erb
 <%%=
-  admin_settings_primer_form_with(**form_options) do |f|
+  settings_primer_form_with(**form_options) do |f|
     render(WorkPackages::Types::SettingsForm.new(f))
   end %>
 ```

modules/costs/app/views/admin/costs_settings/show.html.erb

@@ -53,7 +53,7 @@ See COPYRIGHT and LICENSE files for more details.
                                                         dismissable: false))
       %>
       <%=
-        admin_settings_primer_form_with(scope: :settings, action: :update, method: :patch) do |time_form|
+        settings_primer_form_with(scope: :settings, action: :update, method: :patch) do |time_form|
           render_inline_settings_form(time_form) do |form|
             form.html_content do
               render(Primer::Beta::Subhead.new(hide_border: true)) do |subhead|
@@ -76,7 +76,7 @@ See COPYRIGHT and LICENSE files for more details.
   component.with_tab(id: "tab-costs") do |tab|
     tab.with_text { I18n.t(:label_costs) }
     tab.with_panel do
-      admin_settings_primer_form_with(scope: :settings, action: :update, method: :patch) do |time_form|
+      settings_primer_form_with(scope: :settings, action: :update, method: :patch) do |time_form|
         render_inline_settings_form(time_form) do |form|
           form.html_content do
             render(Primer::Beta::Subhead.new(hide_border: true)) do |subhead|

modules/costs/app/views/admin/settings/time_entry_activities/edit.html.erb

@@ -43,6 +43,6 @@ See COPYRIGHT and LICENSE files for more details.
   end
 %>
 
-<%= admin_settings_primer_form_with(model: @enumeration, scope: :enumeration, url: url_for(action: :update, id: @enumeration)) do |f| %>
+<%= settings_primer_form_with(model: @enumeration, scope: :enumeration, url: url_for(action: :update, id: @enumeration)) do |f| %>
   <%= render(Admin::Enumerations::ItemForm.new(f)) %>
 <% end %>

modules/documents/app/views/admin/settings/document_categories/edit.html.erb

@@ -42,6 +42,6 @@ See COPYRIGHT and LICENSE files for more details.
   end
 %>
 
-<%= admin_settings_primer_form_with(model: @enumeration, scope: :enumeration, url: url_for(action: :update, id: @enumeration)) do |f| %>
+<%= settings_primer_form_with(model: @enumeration, scope: :enumeration, url: url_for(action: :update, id: @enumeration)) do |f| %>
   <%= render(Admin::Enumerations::ItemForm.new(f)) %>
 <% end %>