super 0.0.14 → 0.18.0

data/app/controllers/super/substructure_controller.rb

@@ -0,0 +1,313 @@
+# 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
+    private
+
+    helper_method def model
+      raise Error::NotImplementedError
+    end
+
+    # This is an optional method
+    #
+    # @return [String]
+    helper_method def title
+      model.name.pluralize
+    end
+
+    # This defines what to set in the <title> tag. It works in conjunction with
+    # the `#site_title` method
+    #
+    # @return [String, void]
+    helper_method def page_title
+      model.name.pluralize
+    rescue Error::NotImplementedError, NameError
+      return nil
+    end
+
+    # Configures what database records are visible on load. This is an optional
+    # method, it defaults to "`all`" methods
+    #
+    # @return [ActiveRecord::Relation]
+    helper_method def base_scope
+      model.all
+    end
+
+    # Configures the fields that are displayed on the index and show actions.
+    # This is a required method
+    #
+    # @return [Display]
+    helper_method def display_schema
+      Display.new do |fields, type|
+        Display::Guesser.new(model: model, action: current_action, fields: fields, type: type).call
+      end
+    end
+
+    # Configures the editable fields on the new and edit actions. This is a
+    # required method
+    #
+    # @return [Form]
+    helper_method def form_schema
+      Form.new do |fields, type|
+        Form::Guesser.new(model: model, fields: fields, type: type).call
+      end
+    end
+
+    # Configures which parameters could be written to the database. This is a
+    # required method
+    #
+    # @return [ActionController::Parameters]
+    helper_method def permitted_params
+      strong_params =
+        if current_action.create?
+          with_current_action("new") do
+            Super::Form::StrongParams.new(form_schema)
+          end
+        elsif current_action.update?
+          with_current_action("edit") do
+            Super::Form::StrongParams.new(form_schema)
+          end
+        else
+          Super::Form::StrongParams.new(form_schema)
+        end
+      params.require(strong_params.require(model)).permit(strong_params.permit)
+    end
+
+    # Configures the actions linked to on the index page. This is an optional
+    # method
+    #
+    # @return [Array<Link>]
+    helper_method def collection_actions
+      Super::Link.find_all(:new)
+    end
+
+    # Configures the actions linked to on the show page as well as each row of
+    # the table on the index page. This is an optional method
+    #
+    # Favor the `record` argument over the `@record` instance variable;
+    # `@record` won't always be set, notably on the index page where it's
+    # called on every row
+    #
+    # @return [Array<Link>]
+    helper_method def member_actions(record)
+      if current_action.show?
+        Super::Link.find_all(:edit, :destroy)
+      elsif current_action.edit?
+        Super::Link.find_all(:show, :destroy)
+      else
+        Super::Link.find_all(:show, :edit, :destroy)
+      end
+    end
+
+    helper_method def filters_enabled?
+      true
+    end
+
+    helper_method def filter_schema
+      Super::Filter.new do |fields, type|
+        Super::Filter::Guesser.new(model: model, fields: fields, type: type).call
+      end
+    end
+
+    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)
+          key if val.real?
+        end
+
+      attribute_names.compact
+    end
+
+    helper_method def default_sort
+      { id: :desc }
+    end
+
+    # Specifies how many records to show per page
+    #
+    # @return [ActiveRecord::Relation]
+    helper_method def records_per_page
+      Super.configuration.index_records_per_page
+    end
+
+    def load_records
+      base_scope
+    end
+
+    def load_record
+      base_scope.find(params[:id])
+    end
+
+    def build_record
+      base_scope.build
+    end
+
+    def set_record_attributes
+      @record.attributes = permitted_params
+    end
+
+    def save_record
+      @record.save
+    end
+
+    def destroy_record
+      @record.destroy
+    end
+
+    def initialize_query_form
+      Super::Query::FormObject.new(
+        model: model,
+        params: params,
+        namespace: :q,
+        current_path: request.path,
+      )
+    end
+
+    def apply_queries
+      @query_form.apply_changes(@records)
+    end
+
+    def initialize_filter_form
+      if filters_enabled?
+        @query_form.add(
+          Super::Filter::FormObject,
+          namespace: :f,
+          schema: filter_schema
+        )
+      end
+    end
+
+    def initialize_sort_form
+      if sort_enabled?
+        @query_form.add(
+          Super::Sort::FormObject,
+          namespace: :s,
+          default: default_sort,
+          sortable_columns: sortable_columns
+        )
+      end
+    end
+
+    def pagination_disabled_param
+      :_all_pages
+    end
+
+    def pagination_enabled?
+      !params.key?(pagination_disabled_param)
+    end
+
+    # Sets up pagination
+    #
+    # @return [Pagination]
+    def initialize_pagination
+      Pagination.new(
+        total_count: @records.size,
+        limit: records_per_page,
+        query_params: request.GET,
+        page_query_param: :page
+      )
+    end
+
+    # Paginates
+    #
+    # @return [ActiveRecord::Relation]
+    def paginate_records
+      return @records if !pagination_enabled?
+
+      @records
+        .limit(@pagination.limit)
+        .offset(@pagination.offset)
+    end
+
+    def index_view
+      Super::Layout.new(
+        mains: [
+          Super::Panel.new(
+            Super::Partial.new("collection_header"),
+            :@display
+          ),
+        ],
+        asides: [
+          :@query_form,
+        ]
+      )
+    end
+
+    def show_view
+      Super::Layout.new(
+        mains: [
+          Super::Panel.new(
+            Super::Partial.new("member_header"),
+            :@display
+          ),
+        ]
+      )
+    end
+
+    def new_view
+      Super::Layout.new(
+        mains: [
+          Super::Panel.new(
+            Super::Partial.new("collection_header"),
+            :@form
+          ),
+        ]
+      )
+    end
+
+    def edit_view
+      Super::Layout.new(
+        mains: [
+          Super::Panel.new(
+            Super::Partial.new("member_header"),
+            :@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/helpers/super/form_builder_helper.rb

@@ -1,7 +1,13 @@
 # frozen_string_literal: true
 
 module Super
+  # These are form builder view helpers. They are similar to what Rails ships
+  # out of the box but adds some styling and functionality.
+  #
+  # These helpers are available both in Super views and in your application's
+  # views.
   module FormBuilderHelper
+    # Super's version of `#form_for`
     def super_form_for(record, options = {}, &block)
       original = ActionView::Base.field_error_proc
       ActionView::Base.field_error_proc = Form::Builder::FIELD_ERROR_PROC
@@ -12,6 +18,7 @@ module Super
       ActionView::Base.field_error_proc = original
     end
 
+    # Super's version of `#form_with`
     def super_form_with(**options, &block)
       original = ActionView::Base.field_error_proc
       ActionView::Base.field_error_proc = Form::Builder::FIELD_ERROR_PROC

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

@@ -1,7 +1,7 @@
 <!DOCTYPE html>
 <html class="bg-gray-100">
   <head>
-    <title><%= Super.configuration.title %></title>
+    <title><%= document_title %></title>
     <%= csrf_meta_tags %>
     <% if respond_to?(:csp_meta_tag) -%>
       <%= csp_meta_tag %>
@@ -28,23 +28,7 @@
 
   <body class="font-sans pb-4">
     <div class="px-4">
-      <header class="pt-4">
-        <h1 class="text-lg font-bold mr-6 mb-1"><%= Super.configuration.title %></h1>
-        <% navigation.definition.each do |link_or_menu| %>
-          <% if link_or_menu.is_a?(Super::Link) %>
-            <%= link_or_menu.to_s(default_options: { class: "inline-block mr-6" }) %>
-          <% else %>
-            <details class="details-reset select-none inline-block mr-6" data-controller="click-outside-to-close" data-action="click@window->click-outside-to-close#close">
-              <summary class="text-blue-700"><%= link_or_menu.title %></summary>
-              <ul class="absolute bg-white shadow-md px-4 py-3">
-                <% link_or_menu.links.each do |link| %>
-                  <li><%= link.to_s(default_options: { class: "" }) %></li>
-                <% end %>
-              </ul>
-            </details>
-          <% end %>
-        <% end %>
-      </header>
+      <%= render "site_header" %>
 
       <%= render "flash" %>
 
@@ -52,9 +36,7 @@
 
       <%= yield %>
 
-      <div class="pt-8 text-sm text-gray-800">
-        <%= t("super.layout.powered_by", env: Rails.env.capitalize, version: Super::VERSION) %>
-      </div>
+      <%= render "site_footer" %>
     </div>
   </body>
 </html>

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

@@ -1,9 +1,9 @@
 <header class="flex justify-between content-end">
   <h1 class="text-xl">
-    <%= controls.title %>
+    <%= title %>
   </h1>
   <div>
-    <% controls.collection_actions(action: action_inquirer).each do |link| %>
+    <% collection_actions.each do |link| %>
       <%= link.to_s(
         default_options: {
           class: "super-button super-button--border-blue super-button-sm inline-block ml-2"

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

@@ -1,5 +1,5 @@
 <div>
-  <% controls.member_actions(action: action_inquirer).each do |link| %>
+  <% member_actions(record).each do |link| %>
     <span class="pr-2 last:pr-0"><%= link.to_s(record: record, params: params) %></span>
   <% end %>
 </div>

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

@@ -1,10 +1,10 @@
 <div class="mt-4 overflow-x-auto">
-  <table class="w-full border-separate relative" cellspacing="0" cellpadding="0">
+  <table class="w-full border-separate" cellspacing="0" cellpadding="0">
     <thead class="">
       <tr class="">
         <% display_index.each_attribute_name do |attribute_name| %>
           <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">
-            <%= controls.model.human_attribute_name(attribute_name) %>
+            <%= model.human_attribute_name(attribute_name) %>
           </th>
         <% end %>
       </tr>

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

@@ -1,7 +1,7 @@
 <table class="max-w-full mt-4">
   <% display_show.each_attribute_name do |attribute_name| %>
     <tr>
-      <th class="py-1 align-baseline text-right px-4"><%= controls.model.human_attribute_name(attribute_name) %></th>
+      <th class="py-1 align-baseline text-right px-4"><%= model.human_attribute_name(attribute_name) %></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,6 +1,66 @@
 <h1 class="text-lg">Filter</h1>
-<% filter.each_field do |filter_field| %>
+<% filter.each_attribute do |attribute_form_object| %>
   <div class="mt-4">
-    <%= render(filter_field, form: form) %>
+    <%= 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| %>
+            <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.super.text_field(operator_field_name) %>
+                          <% end %>
+                        </div>
+                      <% end %>
+                    </div>
+                  <% end %>
+                </div>
+              <% end %>
+
+              <%= form_html if index == selected_index %>
+
+              <template data-tab-target="pocket">
+                <%= form_html %>
+              </template>
+            </div>
+          <% end %>
+        </div>
+      </div>
+    <% end %>
   </div>
 <% end %>