super 0.21.0 → 0.22.0

data/app/controllers/super/application_controller.rb

@@ -2,7 +2,7 @@
 
 module Super
   # Provides a default implementation for each of the resourceful actions
-  class ApplicationController < SubstructureController
+  class ApplicationController < ViewController
     include ClientError::Handling
 
     before_action do
@@ -12,6 +12,8 @@ module Super
     end
 
     # Displays a list of records to the user
+    #
+    # @return [void]
     def index
       if request.format.ref == :csv && !csv_enabled?
         params_for_rebuilding_url = params.to_unsafe_hash
@@ -28,6 +30,8 @@ module Super
     end
 
     # Displays a specific record to the user
+    #
+    # @return [void]
     def show
       @record = load_record
       @display = display_schema.apply(action: current_action, format: request.format)
@@ -35,6 +39,8 @@ module Super
     end
 
     # Displays a form to allow the user to create a new record
+    #
+    # @return [void]
     def new
       @record = build_record
       @form = form_schema
@@ -42,6 +48,8 @@ module Super
     end
 
     # Creates a record, or shows the validation errors
+    #
+    # @return [void]
     def create
       @record = build_record
       set_record_attributes
@@ -54,6 +62,8 @@ module Super
     end
 
     # Displays a form to allow the user to update an existing record
+    #
+    # @return [void]
     def edit
       @record = load_record
       @form = form_schema
@@ -61,6 +71,8 @@ module Super
     end
 
     # Updates a record, or shows validation errors
+    #
+    # @return [void]
     def update
       @record = load_record
       set_record_attributes
@@ -73,6 +85,8 @@ module Super
     end
 
     # Deletes a record, or shows validation errors
+    #
+    # @return [void]
     def destroy
       @record = load_record
 
@@ -87,43 +101,43 @@ module Super
 
     private
 
-    helper_method def current_action
-      @current_action ||=
-        ActionInquirer.new(
-          ActionInquirer.default_for_resources,
-          params[:action]
-        )
+    # @return [void]
+    def redirect_to_record
+      redirect_to polymorphic_path(Super::Link.polymorphic_parts(@record))
     end
 
-    def with_current_action(action)
-      original = @current_action
-      @current_action = ActionInquirer.new(
-        ActionInquirer.default_for_resources,
-        action
-      )
-      yield
-    ensure
-      @current_action = original
+    # @return [void]
+    def redirect_to_records
+      redirect_to polymorphic_path(Super::Link.polymorphic_parts(model))
     end
 
-    helper_method def resolved_member_actions(record)
-      member_actions(record).map do |action|
-        if action.respond_to?(:resolve)
-          resolve_member_action(action, record)
+    # @return [void]
+    def redirect_to_record_with_destroy_failure_message(error = nil)
+      flash.alert =
+        case error
+        when ActiveRecord::InvalidForeignKey
+          I18n.t("super.destroy_error.invalid_foreign_key")
         else
-          action
+          I18n.t("super.destroy_error.generic")
         end
-      end
+
+      redirect_to polymorphic_path(Super::Link.polymorphic_parts(@record))
     end
 
-    helper_method def resolved_collection_actions
-      collection_actions.map do |action|
-        if action.respond_to?(:resolve)
-          resolve_collection_action(action)
-        else
-          action
-        end
-      end
+    # @return [void]
+    def render_new_as_bad_request
+      @current_action = ActionInquirer.new!
+      @form = form_schema
+      @view = new_view
+      render :new, status: :bad_request
+    end
+
+    # @return [void]
+    def render_edit_as_bad_request
+      @current_action = ActionInquirer.edit!
+      @form = form_schema
+      @view = edit_view
+      render :edit, status: :bad_request
     end
   end
 end

data/app/controllers/super/foundation_controller.rb

@@ -0,0 +1,30 @@
+# typed: true
+# frozen_string_literal: true
+
+module Super
+  # These methods could be useful for any Super controller, resourceful or not.
+  class FoundationController < ActionController::Base
+    private
+
+    # @return [Super::ActionInquirer]
+    helper_method def current_action
+      @current_action ||=
+        ActionInquirer.new(
+          ActionInquirer.default_for_resources,
+          params[:action]
+        )
+    end
+
+    # @return [void]
+    def with_current_action(action)
+      original = @current_action
+      @current_action = ActionInquirer.new(
+        ActionInquirer.default_for_resources,
+        action
+      )
+      yield
+    ensure
+      @current_action = original
+    end
+  end
+end

data/app/controllers/super/sitewide_controller.rb

@@ -1,19 +1,21 @@
 # frozen_string_literal: true
 
 module Super
-  # Various methods that are useful for all Super admin controllers, regardless
-  # of the controller being a resourceful or non-resourceful.
-  class SitewideController < ActionController::Base
+  # These methods could be useful for any Super controller, resourceful or not.
+  class SitewideController < SubstructureController
     private
 
+    # @return [String]
     helper_method def site_title
       Super.configuration.title
     end
 
+    # @return [Super::Navigation]
     helper_method def site_navigation
       Super::Navigation.new(&:all)
     end
 
+    # @return [String]
     helper_method def document_title
       if instance_variable_defined?(:@document_title)
         return @document_title
@@ -26,6 +28,7 @@ module Super
       @document_title_segments ||= [page_title, site_title]
     end
 
+    # @return [String]
     def document_title_separator
       @document_title_separator ||= " - "
     end

data/app/controllers/super/substructure_controller.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 module Super
-  # Various methods that determine the behavior of your controllers. These
-  # methods can and should be overridden.
-  class SubstructureController < ViewController
+  # These methods determine the behavior of your resourceful Super controllers.
+  # These methods can and should be overridden.
+  class SubstructureController < FoundationController
     def self.batch(action_name)
       mod = Module.new do
         define_method(action_name) do
@@ -42,7 +42,7 @@ module Super
     helper_method def page_title
       model.name.pluralize
     rescue Error::NotImplementedError, NameError
-      return nil
+      nil
     end
 
     # Configures what database records are visible on load. This is an optional
@@ -143,25 +143,24 @@ module Super
       action.resolve(params: params, record: record)
     end
 
+    # @return [Boolean]
     helper_method def filters_enabled?
       true
     end
 
+    # @return [Super::Filter]
     helper_method def filter_schema
       Super::Filter.new do |fields, type|
         Super::Filter::Guesser.new(model: model, fields: fields, type: type).call
       end
     end
 
+    # @return [Boolean]
     helper_method def sort_enabled?
       true
     end
 
     helper_method def sortable_columns
-      action = ActionInquirer.new(
-        ActionInquirer.default_for_resources,
-        "index"
-      )
       attribute_names =
         display_schema.each_attribute.map do |key, val|
           val = val.build if val.respond_to?(:build)
@@ -172,23 +171,23 @@ module Super
     end
 
     helper_method def default_sort
-      { id: :desc }
+      {id: :desc}
     end
 
     # Specifies how many records to show per page
     #
-    # @return [ActiveRecord::Relation]
+    # @return [Integer]
     helper_method def records_per_page
       Super.configuration.index_records_per_page
     end
 
+    # @return [Boolean]
     helper_method def batch_actions_enabled?
       true
     end
 
     helper_method def batch_actions
-      [
-      ]
+      []
     end
 
     def load_records
@@ -203,6 +202,7 @@ module Super
       base_scope.build
     end
 
+    # @return [void]
     def set_record_attributes
       @record.attributes = permitted_params
     end
@@ -215,52 +215,21 @@ module Super
       @record.destroy
     end
 
-    def redirect_to_record
-      redirect_to polymorphic_path(Super::Link.polymorphic_parts(@record))
-    end
-
-    def redirect_to_records
-      redirect_to polymorphic_path(Super::Link.polymorphic_parts(model))
-    end
-
-    def redirect_to_record_with_destroy_failure_message(error = nil)
-      flash.alert =
-        case error
-        when ActiveRecord::InvalidForeignKey
-          I18n.t("super.destroy_error.invalid_foreign_key")
-        else
-          I18n.t("super.destroy_error.generic")
-        end
-
-      redirect_to polymorphic_path(Super::Link.polymorphic_parts(@record))
-    end
-
-    def render_new_as_bad_request
-      @current_action = ActionInquirer.new!
-      @form = form_schema
-      @view = new_view
-      render :new, status: :bad_request
-    end
-
-    def render_edit_as_bad_request
-      @current_action = ActionInquirer.edit!
-      @form = form_schema
-      @view = edit_view
-      render :edit, status: :bad_request
-    end
-
+    # @return [Super::Query]
     helper_method def query
       @query ||= Super::Query.new(
         model: model,
         params: request.GET,
-        current_path: request.path,
+        current_path: request.path
       )
     end
 
+    # @return [ActiveRecord::Relation]
     def apply_queries
       query.apply_changes(@records)
     end
 
+    # @return [Super::Filter::FormObject, nil]
     def initialize_filter_form
       if filters_enabled?
         @filter_form = query.build(
@@ -271,6 +240,7 @@ module Super
       end
     end
 
+    # @return [Super::Sort::FormObject, nil]
     def initialize_sort_form
       if sort_enabled?
         @sort_form = query.build(
@@ -282,10 +252,12 @@ module Super
       end
     end
 
+    # @return [Symbol, String]
     helper_method def pagination_disabled_param
       :_all_pages
     end
 
+    # @return [Boolean]
     def pagination_enabled?
       !params.key?(pagination_disabled_param)
     end
@@ -320,8 +292,29 @@ module Super
       )
     end
 
+    # @return [Boolean]
     helper_method def csv_enabled?
       true
     end
+
+    helper_method def resolved_member_actions(record)
+      member_actions(record).map do |action|
+        if action.respond_to?(:resolve)
+          resolve_member_action(action, record)
+        else
+          action
+        end
+      end
+    end
+
+    helper_method def resolved_collection_actions
+      collection_actions.map do |action|
+        if action.respond_to?(:resolve)
+          resolve_collection_action(action)
+        else
+          action
+        end
+      end
+    end
   end
 end

data/app/controllers/super/view_controller.rb

@@ -7,6 +7,7 @@ module Super
   class ViewController < SitewideController
     private
 
+    # @return [#to_partial_path]
     def index_view
       Super::Layout.new(
         main: Super::ViewChain.new(
@@ -17,11 +18,12 @@ module Super
         ),
         aside: Super::ViewChain.new(
           query_panel: Super::Panel.new,
-          query: query,
+          query: query
         )
       )
     end
 
+    # @return [#to_partial_path]
     def show_view
       Super::Layout.new(
         main: Super::ViewChain.new(
@@ -32,6 +34,7 @@ module Super
       )
     end
 
+    # @return [#to_partial_path]
     def new_view
       Super::Layout.new(
         main: Super::ViewChain.new(
@@ -42,6 +45,7 @@ module Super
       )
     end
 
+    # @return [#to_partial_path]
     def edit_view
       Super::Layout.new(
         main: Super::ViewChain.new(

data/app/views/layouts/super/application.html.erb

@@ -28,15 +28,15 @@
 
   <body class="font-sans pb-4">
     <div class="px-4">
-      <%= render "site_header" %>
+      <%= super_render "site_header" %>
 
-      <%= render "flash" %>
+      <%= super_render "flash" %>
 
       <div class="pt-4"></div>
 
       <%= yield %>
 
-      <%= render "site_footer" %>
+      <%= super_render "site_footer" %>
     </div>
   </body>
 </html>

data/app/views/super/application/_batch_checkbox.csv.erb

@@ -1 +1 @@
-<%= value -%>
+<%= batch_checkbox.locals[:value] -%>

data/app/views/super/application/_batch_checkbox.html.erb

@@ -1,7 +1,7 @@
 <% if current_action.collection? %>
 <div class="whitespace-nowrap gap-1">
 <% html_id = "batch-checkbox-#{value.to_s.gsub(/[^a-z0-9]+/, "-")}" %>
-<input type="checkbox" name="batch[]" value="<%= value %>" id="<%= html_id %>">
+<input type="checkbox" name="batch[]" value="<%= batch_checkbox.locals[:value] %>" id="<%= html_id %>">
 <label for="<%= html_id %>"><%= value %></label>
 </div>
 <% else %>

data/app/views/super/application/_collection_header.html.erb

@@ -4,7 +4,7 @@
   </h1>
   <div class="flex gap-2">
     <% resolved_collection_actions.each do |link| %>
-      <%= render(
+      <%= super_render(
         link,
         default_options: {
           class: "super-button super-button--border-blue super-button-sm inline-block"

data/app/views/super/application/_csv_button.html.erb

@@ -5,7 +5,7 @@
     <details-dialog class="bg-white shadow-md px-4 py-4 rounded-lg">
       <header class="flex items-center">
         <h1 class="font-semibold border-b-1 flex-1"><%= t("super.csv.modal_header") %></h1>
-        <button type="button" data-close-dialog class="flex-initial h-4 w-4"><%= render("super/feather/x") %></button>
+        <button type="button" data-close-dialog class="flex-initial h-4 w-4"><%= super_render("super/feather/x") %></button>
       </header>
       <div class="mt-3">
         <% linkable_params = params.to_unsafe_hash %>

data/app/views/super/application/_display_actions.html.erb

@@ -1,5 +1,5 @@
 <div>
   <% resolved_member_actions(record).each do |link| %>
-    <span class="pr-2 last:pr-0"><%= render link %></span>
+    <span class="pr-2 last:pr-0"><%= super_render link %></span>
   <% end %>
 </div>

data/app/views/super/application/_display_rich_text.html.erb

@@ -1 +1 @@
-<%= rich_text %>
+<%= display_rich_text.locals[:rich_text] %>

data/app/views/super/application/_form.html.erb

@@ -1,7 +1,7 @@
 <%= super_form_for(form_record(@record), url: form_action(@record)) do |f| %>
   <div class="max-w-3xl">
     <% form.each_attribute do |field, type| %>
-      <%= render(
+      <%= super_render(
         type,
         form: f,
         column: field

data/app/views/super/application/_form_fieldset.html.erb

@@ -3,6 +3,6 @@
     <legend class="bg-white p-1 -mx-1"><%= form_fieldset.label %></legend>
   <% end %>
   <% form_fieldset.nested_fields.each do |field, type| %>
-    <%= render(type, form: form, column: field) %>
+    <%= super_render(type, form: form, column: field) %>
   <% end %>
 </fieldset>

data/app/views/super/application/_form_has_many.html.erb

@@ -1,6 +1,6 @@
 <div data-controller="apply-template">
   <%= form.fields_for(form_has_many.reader) do |ff| %>
-    <%= render "form_fieldset", form_fieldset: form_has_many, form: ff %>
+    <%= super_render "form_fieldset", form_fieldset: form_has_many, form: ff %>
   <% end %>
 
   <%=
@@ -11,7 +11,7 @@
     ) do |ff|
   %>
     <template data-apply-template-target="template">
-      <%= render "form_fieldset", form_fieldset: form_has_many, form: ff %>
+      <%= super_render "form_fieldset", form_fieldset: form_has_many, form: ff %>
     </template>
   <% end %>
 

data/app/views/super/application/_form_has_one.html.erb

@@ -6,6 +6,6 @@
   %>
 
   <%= form.fields_for(form_has_one.reader) do |ff| %>
-    <%= render "form_fieldset", form_fieldset: form_has_one, form: ff %>
+    <%= super_render "form_fieldset", form_fieldset: form_has_one, form: ff %>
   <% end %>
 </div>

data/app/views/super/application/_layout.html.erb

@@ -1,26 +1,26 @@
 <% if layout.header %>
-  <%= render layout.header %>
+  <%= super_render layout.header %>
 <% end %>
 
 <% if layout.aside %>
   <div class="flow-root -mx-2">
     <div class="md:float-left md:w-9/12 px-2">
       <% if layout.main %>
-        <%= render layout.main %>
+        <%= super_render layout.main %>
       <% end %>
     </div>
 
     <div class="md:float-right md:w-3/12 px-2">
-      <%= render layout.aside %>
+      <%= super_render layout.aside %>
     </div>
   </div>
 <% else %>
   <% if layout.main %>
-    <%= render layout.main %>
+    <%= super_render layout.main %>
   <% end %>
 <% end %>
 
 <% if layout.footer %>
-  <%= render layout.footer %>
-  <%= Super::Partial.render(partial, template: self) %>
+  <%= super_render layout.footer %>
+  <%= super_render(partial) %>
 <% end %>

data/app/views/super/application/_link.html.erb

@@ -1,8 +1,3 @@
 <%=
-  default_options ||= {}
-  link_to(
-    link.text,
-    link.href,
-    default_options.deep_merge(link.options)
-  )
+  link.to_link(self, local_assigns)
 %>

data/app/views/super/application/_member_header.html.erb

@@ -4,7 +4,7 @@
   </h1>
   <div class="flex gap-2">
     <% resolved_member_actions(@record).each do |link| %>
-      <%= render(
+      <%= super_render(
         link,
         default_options: {
           class: "super-button super-button--border-blue super-button-sm inline-block"

data/app/views/super/application/_panel.html.erb

@@ -1,7 +1,7 @@
 <% if panel.resolve(self, block_given? ? Proc.new { yield } : nil).resolved_parts.any? %>
   <div class="border rounded shadow border-gray-400 bg-white px-5 pt-4 pb-8 mt-6">
     <% panel.resolved_parts.each do |partial| %>
-      <%= Super::Partial.render(partial, template: self) %>
+      <%= super_render(partial) %>
     <% end %>
   </div>
 <% end %>

data/app/views/super/application/_query.html.erb

@@ -3,13 +3,13 @@
 
   <%= form_tag(query.path, method: :get, data: { controller: "clean-filter-params", action: "submit->clean-filter-params#call" }) do %>
     <% if filters_enabled? %>
-      <%= render @filter_form %>
+      <%= super_render @filter_form %>
     <% end %>
     <% if sort_enabled? %>
       <% if filters_enabled? %>
         <div class="mt-6"></div>
       <% end %>
-      <%= render @sort_form %>
+      <%= super_render @sort_form %>
     <% end %>
 
     <%= submit_tag("Apply", class: "super-button super-button--border-gray mt-6") %>

data/app/views/super/application/_site_header.html.erb

@@ -2,13 +2,13 @@
   <h1 class="text-lg font-bold mr-6 mb-1"><%= site_title %></h1>
   <% site_navigation.definition.each do |link_or_menu| %>
     <% if link_or_menu.is_a?(Super::Link) %>
-      <%= render(link_or_menu, default_options: { class: "inline-block mr-6" }) %>
+      <%= super_render(link_or_menu, default_options: { class: "inline-block mr-6" }) %>
     <% else %>
       <details class="details-reset details-backdrop-transparent select-none inline-block mr-6">
         <summary class="text-blue-700"><%= link_or_menu.title %></summary>
         <ul class="absolute bg-white shadow-md px-4 py-3 z-20">
           <% link_or_menu.links.each do |link| %>
-            <li><%= render(link, default_options: { class: "" }) %></li>
+            <li><%= super_render(link, default_options: { class: "" }) %></li>
           <% end %>
         </ul>
       </details>

data/app/views/super/application/_sort.html.erb

@@ -3,13 +3,13 @@
   <div data-controller="apply-template">
     <% sort.exprs.each.with_index do |expr, index| %>
       <%= form.fields_for("exprs[]", expr.with_index(index)) do |expr_fields| %>
-        <%= render "sort_expression", expr_fields: expr_fields, sort: sort %>
+        <%= super_render "sort_expression", expr_fields: expr_fields, sort: sort %>
       <% end %>
     <% end %>
 
     <%= form.fields_for("exprs[]", sort.new_expr.with_index("TEMPLATEINDEX")) do |expr_fields| %>
       <template data-apply-template-target="template">
-        <%= render "sort_expression", expr_fields: expr_fields, sort: sort %>
+        <%= super_render "sort_expression", expr_fields: expr_fields, sort: sort %>
       </template>
     <% end %>
 

data/app/views/super/application/_sort_expression.html.erb

@@ -19,7 +19,7 @@
       ) %>
     </div>
     <div class="flex-none pl-2">
-      <a href="#" data-action="delete#call" class="block text-black hover:text-red-600 h-4 w-4"><%= render("super/feather/x") %></a>
+      <a href="#" data-action="delete#call" class="block text-black hover:text-red-600 h-4 w-4"><%= super_render("super/feather/x") %></a>
     </div>
   </div>
 </div>