super 0.20.0 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e47e4344e0e7e7cf55cc943672017a92e7e30d566aa84b28b2351b4f190b22ed
-  data.tar.gz: 62b74ffa083bbabe27890359f987e78363e6fc86a8b164d8529155f9eeaff655
+  metadata.gz: 8074c717fdd2f747e7d880cdbb02ec13515ec85b3504e7f55f1db526ace24838
+  data.tar.gz: 5d446f1574a35e4ba542281b2edfe5ef36dd588a5c2420b81288702bb96f4607
 SHA512:
-  metadata.gz: ec637b18bb09e636e988507036d41dde995a8f33aeacd69a5b94924eadfcbae4acba73a58c32a0d4188f4f3a8ae852c5b9a9566af647bf4e0583484369d4566c
-  data.tar.gz: 7a9e37ed3dc2232e902e2d8b770c02e737413eec66cc4df80c1cefdb974e38d523568a1f66962a2943b667c6cb28439c0fb501c98b102747ad511d9d5204cc3c
+  metadata.gz: adca04cac0470dfe22929b710d331ff651eb53ee0fdf5f88657f9b18094963f09bda9c6b13808bc112a565937851eda14622e8a0d853b992fa5f1551e6daadb0
+  data.tar.gz: b694a20146e50d743fcc7ca5bbf6e67cdd63df3e256352b70a99a5a677ad0f5014f38ca29efe48263d840809d9c4e3f63d1972a28277510c882c0a6023cf55d0

data/README.md

@@ -38,7 +38,7 @@ changes before 1.0.
 * Builds on top of standard Rails controllers and ERB views
 * Plenty of escape hatches for those very customized pages
 * No DSL. Configure your admin pages by setting methods and returning objects
-* Supports Rails 5.0+, 6.0+
+* Supports Rails 5.0+, 6.0+, 7.0+
 * Supports Ruby 2.3+, 3.0+
 
 

data/app/controllers/super/application_controller.rb

@@ -22,7 +22,6 @@ 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
@@ -48,12 +47,9 @@ module Super
       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
 
@@ -70,12 +66,9 @@ module Super
       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
 
@@ -84,14 +77,12 @@ module Super
       @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

data/app/controllers/super/sitewide_controller.rb

@@ -0,0 +1,33 @@
+# 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
+    private
+
+    helper_method def site_title
+      Super.configuration.title
+    end
+
+    helper_method def site_navigation
+      Super::Navigation.new(&:all)
+    end
+
+    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
+
+    def document_title_separator
+      @document_title_separator ||= " - "
+    end
+  end
+end

data/app/controllers/super/substructure_controller.rb

@@ -3,7 +3,7 @@
 module Super
   # Various methods that determine the behavior of your controllers. These
   # methods can and should be overridden.
-  class SubstructureController < ActionController::Base
+  class SubstructureController < ViewController
     def self.batch(action_name)
       mod = Module.new do
         define_method(action_name) do
@@ -215,22 +215,55 @@ module Super
       @record.destroy
     end
 
-    def initialize_query_form
-      Super::Query::FormObject.new(
+    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
+
+    helper_method def query
+      @query ||= Super::Query.new(
         model: model,
-        params: params,
-        namespace: :q,
+        params: request.GET,
         current_path: request.path,
       )
     end
 
     def apply_queries
-      @query_form.apply_changes(@records)
+      query.apply_changes(@records)
     end
 
     def initialize_filter_form
       if filters_enabled?
-        @query_form.add(
+        @filter_form = query.build(
           Super::Filter::FormObject,
           namespace: :f,
           schema: filter_schema
@@ -240,7 +273,7 @@ module Super
 
     def initialize_sort_form
       if sort_enabled?
-        @query_form.add(
+        @sort_form = query.build(
           Super::Sort::FormObject,
           namespace: :s,
           default: default_sort,
@@ -290,83 +323,5 @@ module Super
     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
-        end
-
-        document_title_segments.map(&:presence).compact.join(document_title_separator)
-      end
-
-      def document_title_segments
-        @document_title_segments ||= [page_title, site_title]
-      end
-
-      def document_title_separator
-        @document_title_separator ||= " - "
-      end
-    end
   end
 end

data/app/controllers/super/view_controller.rb

@@ -0,0 +1,55 @@
+# 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
+
+    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
+
+    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
+  end
+end

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_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 %>

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

@@ -1,66 +1,70 @@
-<h1 class="text-lg">Filter</h1>
-<% filter.each_attribute do |attribute_form_object| %>
-  <div class="mt-4">
-    <%= form.fields_for(attribute_form_object.field_name, attribute_form_object) do |attribute_form| %>
-      <% selected_index = 0 %>
-      <div data-controller="tab-container" data-tab-container-tab-identifier-getter-value="tabIdentifierValue" data-tab-container-tab-controller-name-value="tab">
-        <div>
-          <span class="inline-block"><%= attribute_form_object.humanized_attribute_name %></span>
-          <select data-tab-container-target="control" data-action="tab-container#change" class="super-input super-input-select inline-block">
-            <% selected = false %>
+<h1 class="text-lg mt-4">Filter</h1>
+<%= super_fields_for(query.namespace_for(filter), filter) do |form| %>
+  <% filter.each_attribute do |attribute_form_object| %>
+    <div class="mt-4">
+      <%= form.fields_for(attribute_form_object.field_name, attribute_form_object) do |attribute_form| %>
+        <% selected_index = 0 %>
+        <div data-controller="tab-container" data-tab-container-tab-identifier-getter-value="tabIdentifierValue" data-tab-container-tab-controller-name-value="tab">
+          <div>
+            <span class="inline-block"><%= attribute_form_object.humanized_attribute_name %></span>
+            <select data-tab-container-target="control" data-action="tab-container#change" class="super-input super-input-select inline-block">
+              <% selected = false %>
+              <% attribute_form_object.each_operator.with_index do |operator_form_object, index| %>
+                <%
+                  selected_attribute =
+                    if !selected && operator_form_object.specified?
+                      selected = true
+                      selected_index = index
+                      %(selected=selected)
+                    else
+                      ""
+                    end
+                %>
+                <option value="<%= operator_form_object.identifier %>" <%= selected_attribute %>><%= operator_form_object.operator.humanized_operator_name %></option>
+              <% end %>
+            </select>
+          </div>
+          <div>
             <% attribute_form_object.each_operator.with_index do |operator_form_object, index| %>
-              <%
-                selected_attribute =
-                  if !selected && operator_form_object.specified?
-                    selected = true
-                    selected_index = index
-                    %(selected=selected)
-                  else
-                    ""
-                  end
-              %>
-              <option value="<%= operator_form_object.identifier %>" <%= selected_attribute %>><%= operator_form_object.operator.humanized_operator_name %></option>
-            <% end %>
-          </select>
-        </div>
-        <div>
-          <% attribute_form_object.each_operator.with_index do |operator_form_object, index| %>
-            <div data-controller="tab" data-tab-tab-container-getter-value="tabContainer" data-tab-container-target="tab" data-tab-identifier-value="<%= operator_form_object.identifier %>">
-              <% form_html = capture do %>
-                <div data-tab-target="content">
-                  <%= attribute_form.fields_for(operator_form_object.identifier, operator_form_object) do |operator_form| %>
-                    <div class="flex gap-x-2 mt-2">
-                      <% operator_form_object.each_field.with_index do |operator_field_name, index| %>
-                        <div class="flex-1">
-                          <% if operator_field_name == Super::Filter::FormObject::OperatorForm::NULLARY %>
-                            <%= operator_form.super.check_box(operator_field_name, {}, "1", "") %>
-                            <%= operator_form.super.label(operator_field_name, nil, super: { class: "select-none ml-1" }) %>
-                          <% elsif operator_form_object.operator.respond_to?(:field_transcript) && operator_form_object.operator.field_transcript %>
-                            <% field_transcript = operator_form_object.operator.field_transcript %>
-                            <% if field_transcript.super? %>
-                              <%= operator_form.super.public_send(field_transcript.method_name, operator_field_name, *field_transcript.args, **field_transcript.kwargs) %>
+              <div data-controller="tab" data-tab-tab-container-getter-value="tabContainer" data-tab-container-target="tab" data-tab-identifier-value="<%= operator_form_object.identifier %>">
+                <% form_html = capture do %>
+                  <div data-tab-target="content">
+                    <%= attribute_form.fields_for(operator_form_object.identifier, operator_form_object) do |operator_form| %>
+                      <div class="flex gap-x-2 mt-2">
+                        <% operator_form_object.each_field.with_index do |operator_field_name, index| %>
+                          <div class="flex-1">
+                            <% if operator_field_name == Super::Filter::FormObject::OperatorForm::NULLARY %>
+                              <%= operator_form.super.check_box(operator_field_name, {}, "1", "") %>
+                              <%= operator_form.super.label(operator_field_name, nil, super: { class: "select-none ml-1" }) %>
+                            <% elsif operator_form_object.operator.respond_to?(:field_transcript) && operator_form_object.operator.field_transcript %>
+                              <% field_transcript = operator_form_object.operator.field_transcript %>
+                              <% if field_transcript.super? %>
+                                <%= operator_form.super.public_send(field_transcript.method_name, operator_field_name, *field_transcript.args, **field_transcript.kwargs) %>
+                              <% else %>
+                                <%= operator_form.public_send(field_transcript.method_name, operator_field_name, *field_transcript.args, **field_transcript.kwargs) %>
+                              <% end %>
                             <% else %>
-                              <%= operator_form.public_send(field_transcript.method_name, operator_field_name, *field_transcript.args, **field_transcript.kwargs) %>
+                              <%= operator_form.super.text_field(operator_field_name) %>
                             <% end %>
-                          <% else %>
-                            <%= operator_form.super.text_field(operator_field_name) %>
-                          <% end %>
-                        </div>
-                      <% end %>
-                    </div>
-                  <% end %>
-                </div>
-              <% end %>
+                          </div>
+                        <% end %>
+                      </div>
+                    <% end %>
+                  </div>
+                <% end %>
 
-              <%= form_html if index == selected_index %>
+                <%= form_html if index == selected_index %>
 
-              <template data-tab-target="pocket">
-                <%= form_html %>
-              </template>
-            </div>
-          <% end %>
+                <template data-tab-target="pocket">
+                  <%= form_html %>
+                </template>
+              </div>
+            <% end %>
+          </div>
         </div>
-      </div>
-    <% end %>
-  </div>
+      <% end %>
+    </div>
+  <% end %>
 <% end %>
+
+<%= yield if block_given? %>

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

@@ -1,5 +1,3 @@
-<%# <% layout.resolve(self) %1> %>
-
 <% if layout.header %>
   <%= render layout.header %>
 <% end %>

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

@@ -1,18 +1,19 @@
-<%= render(Super::Panel.new) do %>
+<% if filters_enabled? || sort_enabled? %>
   <h1 class="text-xl">Query</h1>
-  <%= super_form_for(
-    query,
-    url: query.path,
-    method: :get,
-    as: query.namespace,
-    html: { class: "mt-4" },
-    data: { controller: "clean-filter-params", action: "submit->clean-filter-params#call" }) do |form| %>
-    <% query.addons.each do |namespace, addon| %>
-      <%= form.fields_for namespace do |addon_form| %>
-        <%= render(addon, form: addon_form) %>
+
+  <%= form_tag(query.path, method: :get, data: { controller: "clean-filter-params", action: "submit->clean-filter-params#call" }) do %>
+    <% if filters_enabled? %>
+      <%= render @filter_form %>
+    <% end %>
+    <% if sort_enabled? %>
+      <% if filters_enabled? %>
+        <div class="mt-6"></div>
       <% end %>
+      <%= render @sort_form %>
     <% end %>
 
-    <%= form.super.submit "Apply", class: "super-button--border-gray mt-6" %>
+    <%= submit_tag("Apply", class: "super-button super-button--border-gray mt-6") %>
   <% end %>
 <% end %>
+
+<%= yield if block_given? %>

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

@@ -1,18 +1,22 @@
 <h1 class="text-lg mt-6">Sort</h1>
-<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_fields_for(query.namespace_for(sort), sort) do |form| %>
+  <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 %>
+      <% end %>
     <% 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 %>
-    </template>
-  <% 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 %>
+      </template>
+    <% end %>
+
+    <a href="#" data-action="apply-template#call" class="block mt-2 text-sm">
+      Add
+    </a>
+  </div>
+<% end %>
 
-  <a href="#" data-action="apply-template#call" class="block mt-2 text-sm">
-    Add
-  </a>
-</div>
+<%= yield if block_given? %>

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

@@ -1,5 +1,24 @@
-<% current = view_chain.chain.shift %>
-<% current = instance_variable_get(current) if current.kind_of?(Symbol) %>
-<%= render(current) do %>
-  <%= render(view_chain) %>
+<%
+  name, current = view_chain.shift
+  current =
+    if current.kind_of?(Symbol)
+      instance_variable_get(current)
+    else
+      current
+    end
+
+  if !current
+    Rails.logger.warn do
+      "Super::ViewChain encountered a nil view: #{name.inspect}."
+    end
+  end
+%>
+<% if current %>
+  <% if view_chain.empty? %>
+    <%= render(current) %>
+  <% else %>
+    <%= render(current) do %>
+      <%= render(view_chain) %>
+    <% end %>
+  <% end %>
 <% end %>

data/config/locales/en.yml

@@ -17,3 +17,6 @@ en:
     layout:
       powered_by_html: "%{env} environment. Powered by Super %{version}. <a href='https://superadministration.github.io/v%{version}/'>Developer docs.</a>"
     mismatching_package_json_gemfile_versions: "The version of Super specified in your package.json file does not match the version specified in your Gemfile.lock."
+    destroy_error:
+      invalid_foreign_key: Couldn't delete record because other records still refer to this one
+      generic: Couldn't delete record

data/lib/super/badge.rb

@@ -12,9 +12,18 @@ module Super
       purple: "bg-purple-800 text-white",
     }
 
-    def initialize(text, styles: nil)
+    def initialize(text, style: nil, styles: nil)
       @text = text
-      @requested_styles = Array(styles.presence).flatten
+      if styles.present?
+        Super::Useful::Deprecation["0.22"].deprecation_warning("styles:", "use `style:` with a single style")
+      end
+      @requested_styles = Array(styles.presence).flatten + Array(style.presence).flatten
+      if @requested_styles.any? { |s| s.is_a?(String) }
+        Super::Useful::Deprecation["0.22"].warn("Super::Badge.new(text, style:) accepts exactly one Symbol style from this list #{STYLES.keys.inspect}")
+      end
+      if @requested_styles.size != 1
+        Super::Useful::Deprecation["0.22"].warn("Super::Badge.new(text, style:) accepts exactly one style, but it received #{@requested_styles.size}")
+      end
     end
 
     def styles

data/lib/super/cheat.rb

@@ -3,7 +3,12 @@
 module Super
   class Cheat
     def controller
-      paths = %w[../../app/controllers/super/substructure_controller.rb]
+      paths = %w[
+        ../../app/controllers/super/application_controller.rb
+        ../../app/controllers/super/substructure_controller.rb
+        ../../app/controllers/super/view_controller.rb
+        ../../app/controllers/super/sitewide_controller.rb
+      ]
       methods =
         paths
         .map { |f| File.read(File.expand_path(f, __dir__)) }