super 0.20.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
@@ -22,13 +24,14 @@ module Super
       @records = load_records
       @display = display_schema.apply(action: current_action, format: request.format)
       @view = index_view
-      @query_form = initialize_query_form
       initialize_filter_form
       initialize_sort_form
       @records = apply_queries
     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)
@@ -36,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
@@ -43,21 +48,22 @@ module Super
     end
 
     # Creates a record, or shows the validation errors
+    #
+    # @return [void]
     def create
       @record = build_record
       set_record_attributes
 
       if save_record
-        redirect_to polymorphic_path(Super::Link.polymorphic_parts(@record))
+        redirect_to_record
       else
-        @current_action = ActionInquirer.new!
-        @form = form_schema
-        @view = new_view
-        render :new, status: :bad_request
+        render_new_as_bad_request
       end
     end
 
     # Displays a form to allow the user to update an existing record
+    #
+    # @return [void]
     def edit
       @record = load_record
       @form = form_schema
@@ -65,74 +71,73 @@ module Super
     end
 
     # Updates a record, or shows validation errors
+    #
+    # @return [void]
     def update
       @record = load_record
       set_record_attributes
 
       if save_record
-        redirect_to polymorphic_path(Super::Link.polymorphic_parts(@record))
+        redirect_to_record
       else
-        @current_action = ActionInquirer.edit!
-        @form = form_schema
-        @view = edit_view
-        render :edit, status: :bad_request
+        render_edit_as_bad_request
       end
     end
 
     # Deletes a record, or shows validation errors
+    #
+    # @return [void]
     def destroy
       @record = load_record
 
       if destroy_record
-        redirect_to polymorphic_path(Super::Link.polymorphic_parts(@record))
+        redirect_to_records
       else
-        flash.alert = "Couldn't delete record"
-        redirect_to polymorphic_path(Super::Link.polymorphic_parts(@record))
+        redirect_to_record_with_destroy_failure_message
       end
-    rescue ActiveRecord::InvalidForeignKey => e
-      flash.alert = "Couldn't delete record: #{e.class}"
-      redirect_to polymorphic_path(Super::Link.polymorphic_parts(@record))
+    rescue ActiveRecord::ActiveRecordError => e
+      redirect_to_record_with_destroy_failure_message(e)
     end
 
     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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Super
+  # 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
+      end
+
+      document_title_segments.map(&:presence).compact.join(document_title_separator)
+    end
+
+    def document_title_segments
+      @document_title_segments ||= [page_title, site_title]
+    end
+
+    # @return [String]
+    def document_title_separator
+      @document_title_separator ||= " - "
+    end
+  end
+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 < ActionController::Base
+  # 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,22 +215,24 @@ module Super
       @record.destroy
     end
 
-    def initialize_query_form
-      Super::Query::FormObject.new(
+    # @return [Super::Query]
+    helper_method def query
+      @query ||= Super::Query.new(
         model: model,
-        params: params,
-        namespace: :q,
-        current_path: request.path,
+        params: request.GET,
+        current_path: request.path
       )
     end
 
+    # @return [ActiveRecord::Relation]
     def apply_queries
-      @query_form.apply_changes(@records)
+      query.apply_changes(@records)
     end
 
+    # @return [Super::Filter::FormObject, nil]
     def initialize_filter_form
       if filters_enabled?
-        @query_form.add(
+        @filter_form = query.build(
           Super::Filter::FormObject,
           namespace: :f,
           schema: filter_schema
@@ -238,9 +240,10 @@ module Super
       end
     end
 
+    # @return [Super::Sort::FormObject, nil]
     def initialize_sort_form
       if sort_enabled?
-        @query_form.add(
+        @sort_form = query.build(
           Super::Sort::FormObject,
           namespace: :s,
           default: default_sort,
@@ -249,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
@@ -287,85 +292,28 @@ module Super
       )
     end
 
+    # @return [Boolean]
     helper_method def csv_enabled?
       true
     end
 
-    def index_view
-      Super::Layout.new(
-        main: Super::ViewChain.new(
-          main_panel: Super::Panel.new,
-          batch_form: Super::Partial.new("batch_form"),
-          main_header: Super::Partial.new("collection_header"),
-          main: :@display
-        ),
-        aside: Super::ViewChain.new(
-          main: :@query_form
-        )
-      )
-    end
-
-    def show_view
-      Super::Layout.new(
-        main: Super::ViewChain.new(
-          main_panel: Super::Panel.new,
-          main_header: Super::Partial.new("member_header"),
-          main: :@display
-        )
-      )
-    end
-
-    def new_view
-      Super::Layout.new(
-        main: Super::ViewChain.new(
-          main_panel: Super::Panel.new,
-          main_header: Super::Partial.new("collection_header"),
-          main: :@form
-        )
-      )
-    end
-
-    def edit_view
-      Super::Layout.new(
-        main: Super::ViewChain.new(
-          main_panel: Super::Panel.new,
-          main_header: Super::Partial.new("member_header"),
-          main: :@form
-        )
-      )
-    end
-
-    concerning :Sitewide do
-      included do
-        helper_method :site_title
-        helper_method :site_navigation
-        helper_method :document_title
-      end
-
-      private
-
-      def site_title
-        Super.configuration.title
-      end
-
-      def site_navigation
-        Super::Navigation.new(&:all)
-      end
-
-      def document_title
-        if instance_variable_defined?(:@document_title)
-          return @document_title
+    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
-
-        document_title_segments.map(&:presence).compact.join(document_title_separator)
-      end
-
-      def document_title_segments
-        @document_title_segments ||= [page_title, site_title]
       end
+    end
 
-      def document_title_separator
-        @document_title_separator ||= " - "
+    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

data/app/controllers/super/view_controller.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Super
+  # These methods define what each resourceful Super admin page looks like.
+  # Generally, the return value of each of these methods should be set to
+  # `@view`.
+  class ViewController < SitewideController
+    private
+
+    # @return [#to_partial_path]
+    def index_view
+      Super::Layout.new(
+        main: Super::ViewChain.new(
+          main_panel: Super::Panel.new,
+          batch_form: Super::Partial.new("batch_form"),
+          main_header: Super::Partial.new("collection_header"),
+          main: :@display
+        ),
+        aside: Super::ViewChain.new(
+          query_panel: Super::Panel.new,
+          query: query
+        )
+      )
+    end
+
+    # @return [#to_partial_path]
+    def show_view
+      Super::Layout.new(
+        main: Super::ViewChain.new(
+          main_panel: Super::Panel.new,
+          main_header: Super::Partial.new("member_header"),
+          main: :@display
+        )
+      )
+    end
+
+    # @return [#to_partial_path]
+    def new_view
+      Super::Layout.new(
+        main: Super::ViewChain.new(
+          main_panel: Super::Panel.new,
+          main_header: Super::Partial.new("collection_header"),
+          main: :@form
+        )
+      )
+    end
+
+    # @return [#to_partial_path]
+    def edit_view
+      Super::Layout.new(
+        main: Super::ViewChain.new(
+          main_panel: Super::Panel.new,
+          main_header: Super::Partial.new("member_header"),
+          main: :@form
+        )
+      )
+    end
+  end
+end

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_index.html.erb

@@ -2,9 +2,15 @@
   <table class="w-full border-separate" cellspacing="0" cellpadding="0">
     <thead class="">
       <tr class="">
-        <% display_index.each_attribute_name do |attribute_name| %>
+        <% display_index.each_attribute do |attribute_name, attribute_definition| %>
           <th class="p-2 first:pl-6 border-b border-b-2 border-gray-400 text-gray-600 text-left text-sm font-normal bg-white top-0 z-10">
-            <%= model.human_attribute_name(attribute_name) %>
+            <%=
+              if attribute_definition.respond_to?(:attribute_name) && attribute_definition.attribute_name
+                attribute_definition.attribute_name
+              else
+                model.human_attribute_name(attribute_name)
+              end
+            %>
           </th>
         <% end %>
       </tr>

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/_display_show.html.erb

@@ -1,7 +1,15 @@
 <table class="max-w-full mt-4">
-  <% display_show.each_attribute_name do |attribute_name| %>
+  <% display_show.each_attribute do |attribute_name, attribute_definition| %>
     <tr>
-      <th class="py-1 align-baseline text-right px-4"><%= model.human_attribute_name(attribute_name) %></th>
+      <th class="py-1 align-baseline text-right px-4">
+        <%=
+          if attribute_definition.respond_to?(:attribute_name) && attribute_definition.attribute_name
+            attribute_definition.attribute_name
+          else
+            model.human_attribute_name(attribute_name)
+          end
+        %>
+      </th>
       <td class="py-1 align-baseline"><%= display_show.render_attribute(template: self, record: @record, column: attribute_name) %></td>
     </tr>
   <% end %>