super 0.0.15 → 0.19.0.rc1

data/app/controllers/super/application_controller.rb

@@ -2,78 +2,88 @@
 
 module Super
   # Provides a default implementation for each of the resourceful actions
-  class ApplicationController < ActionController::Base
+  class ApplicationController < SubstructureController
     include ClientError::Handling
 
-    helper_method :action_inquirer
-    helper_method :controls
-    helper_method :navigation
+    before_action do
+      if Super::PackagedAsset.warning_message
+        flash.now[:mismatching_package_json_gemfile_versions] = Super::PackagedAsset.warning_message
+      end
+    end
 
     # Displays a list of records to the user
     def index
-      @records = controls.load_records(action: action_inquirer, params: params)
-      @display = controls.display_schema(action: action_inquirer).apply(action: action_inquirer)
-      @view = controls.index_view
-      @query_form = controls.initialize_query_form(params: params, current_path: request.path)
-      controls.initialize_filter_form(query_form: @query_form)
-      controls.initialize_sort_form(query_form: @query_form)
-      @records = controls.apply_queries(query_form: @query_form, records: @records)
+      if request.format.ref == :csv && !csv_enabled?
+        params_for_rebuilding_url = params.to_unsafe_hash
+        params_for_rebuilding_url.delete("format")
+        return redirect_to params_for_rebuilding_url
+      end
+
+      @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
     def show
-      @record = controls.load_record(action: action_inquirer, params: params)
-      @display = controls.display_schema(action: action_inquirer).apply(action: action_inquirer)
-      @view = controls.show_view
+      @record = load_record
+      @display = display_schema.apply(action: current_action, format: request.format)
+      @view = show_view
     end
 
     # Displays a form to allow the user to create a new record
     def new
-      @record = controls.build_record(action: action_inquirer)
-      @form = controls.form_schema(action: action_inquirer)
-      @view = controls.new_view
+      @record = build_record
+      @form = form_schema
+      @view = new_view
     end
 
     # Creates a record, or shows the validation errors
     def create
-      @record = controls.build_record_with_params(action: action_inquirer, params: params)
+      @record = build_record
+      set_record_attributes
 
-      if controls.save_record(action: action_inquirer, record: @record, params: params)
+      if save_record
         redirect_to polymorphic_path(Super::Link.polymorphic_parts(@record))
       else
-        @action_inquirer = ActionInquirer.new!
-        @form = controls.form_schema(action: action_inquirer)
-        @view = controls.new_view
+        @current_action = ActionInquirer.new!
+        @form = form_schema
+        @view = new_view
         render :new, status: :bad_request
       end
     end
 
     # Displays a form to allow the user to update an existing record
     def edit
-      @record = controls.load_record(action: action_inquirer, params: params)
-      @form = controls.form_schema(action: action_inquirer)
-      @view = controls.edit_view
+      @record = load_record
+      @form = form_schema
+      @view = edit_view
     end
 
     # Updates a record, or shows validation errors
     def update
-      @record = controls.load_record(action: action_inquirer, params: params)
+      @record = load_record
+      set_record_attributes
 
-      if controls.update_record(action: action_inquirer, record: @record, params: params)
+      if save_record
         redirect_to polymorphic_path(Super::Link.polymorphic_parts(@record))
       else
-        @action_inquirer = ActionInquirer.edit!
-        @form = controls.form_schema(action: action_inquirer)
-        @view = controls.edit_view
+        @current_action = ActionInquirer.edit!
+        @form = form_schema
+        @view = edit_view
         render :edit, status: :bad_request
       end
     end
 
     # Deletes a record, or shows validation errors
     def destroy
-      @record = controls.load_record(action: action_inquirer, params: params)
+      @record = load_record
 
-      if controls.destroy_record(action: action_inquirer, record: @record, params: params)
+      if destroy_record
         redirect_to polymorphic_path(Super::Link.polymorphic_parts(@record))
       else
         flash.alert = "Couldn't delete record"
@@ -86,20 +96,43 @@ module Super
 
     private
 
-    def controls
-      @controls ||= new_controls
-    end
-
-    def action_inquirer
-      @action_inquirer ||=
+    helper_method def current_action
+      @current_action ||=
         ActionInquirer.new(
           ActionInquirer.default_for_resources,
           params[:action]
         )
     end
 
-    def navigation
-      Navigation.new(&:all)
+    def with_current_action(action)
+      original = @current_action
+      @current_action = ActionInquirer.new(
+        ActionInquirer.default_for_resources,
+        action
+      )
+      yield
+    ensure
+      @current_action = original
+    end
+
+    helper_method def resolved_member_actions(record)
+      member_actions(record).map do |action|
+        if action.respond_to?(:resolve)
+          action.resolve(record: record, params: params)
+        else
+          action
+        end
+      end
+    end
+
+    helper_method def resolved_collection_actions
+      collection_actions.map do |action|
+        if action.respond_to?(:resolve)
+          action.resolve(params: params)
+        else
+          action
+        end
+      end
     end
   end
 end

data/app/controllers/super/substructure_controller.rb

@@ -0,0 +1,349 @@
+# 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
+    def self.batch(action_name)
+      mod = Module.new do
+        define_method(action_name) do
+          if !params[:batch]
+            flash.alert = I18n.t("super.batch.none_error")
+            return render :nothing, status: :bad_request
+          end
+
+          super()
+        end
+      end
+
+      const_set("Batch__#{action_name}__#{SecureRandom.hex(4)}", mod)
+      prepend(mod)
+
+      action_name
+    end
+
+    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
+      if current_action.index?
+        [
+          Super::Partial.new("csv_button"),
+          Super::Partial.new("batch_button"),
+          Super::Link.find(:new)
+        ]
+      else
+        Super::Link.find_all(:new)
+      end
+    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
+
+    helper_method def batch_actions_enabled?
+      true
+    end
+
+    helper_method def batch_actions
+      [
+      ]
+    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
+
+    helper_method 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
+
+    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("collection_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/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/_batch_button.html.erb

@@ -0,0 +1,12 @@
+<% default_options = {} unless defined?(default_options) %>
+<% if batch_actions_enabled? && batch_actions.any? %>
+  <details class="details-reset details-backdrop-transparent inline-block">
+    <summary class="cursor-pointer <%= default_options[:class] %>" id="batch-actions">Batch actions</summary>
+
+    <ul class="absolute bg-white shadow-md px-4 py-3 z-20">
+      <% batch_actions.each do |batch_action| %>
+        <li><button data-controller="batch" data-batch-method-value="<%= batch_action.options&.dig(:method) || "get" %>" data-batch-action-value="<%= batch_action.href %>" data-action="batch#submit" class="<%= default_options[:class] %>"><%= batch_action.text %></button></li>
+      <% end %>
+    </ul>
+  </details>
+<% end %>

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

@@ -0,0 +1 @@
+<%= value -%>

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

@@ -0,0 +1,5 @@
+<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 %>">
+<label for="<%= html_id %>"><%= value %></label>
+</div>

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

@@ -0,0 +1,3 @@
+<form>
+  <%= yield %>
+</form>

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

@@ -1,15 +1,16 @@
 <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| %>
-      <%= link.to_s(
+  <div class="flex gap-2">
+    <% resolved_collection_actions.each do |link| %>
+      <%= render(
+        link,
         default_options: {
-          class: "super-button super-button--border-blue super-button-sm inline-block ml-2"
-        },
-        params: params
+          class: "super-button super-button--border-blue super-button-sm inline-block"
+        }
       ) %>
     <% end %>
   </div>
 </header>
+<%= yield if block_given? %>

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

@@ -0,0 +1,25 @@
+<% default_options = {} unless defined?(default_options) %>
+<% if csv_enabled? %>
+  <details class="details-reset details-backdrop-dark inline-block">
+    <summary class="cursor-pointer <%= default_options[:class] %>"><%= t("super.csv.initial_cta") %></summary>
+    <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>
+      </header>
+      <div class="mt-3">
+        <% linkable_params = params.to_unsafe_hash %>
+        <%= link_to(
+          t("super.csv.download_current_cta"),
+          linkable_params.merge(format: :csv),
+          class: "super-button"
+        ) %>
+        <%= link_to(
+          t("super.csv.download_all_cta"),
+          linkable_params.merge(format: :csv, pagination_disabled_param => 1),
+          class: "super-button"
+        ) %>
+      </div>
+    </details-dialog>
+  </details>
+<% end %>

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

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

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

@@ -4,7 +4,7 @@
       <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>