super 0.17.0 → 0.20.0

data/app/controllers/super/application_controller.rb

@@ -5,12 +5,22 @@ module Super
   class ApplicationController < SubstructureController
     include ClientError::Handling
 
-    helper_method :current_action
+    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
+      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)
+      @display = display_schema.apply(action: current_action, format: request.format)
       @view = index_view
       @query_form = initialize_query_form
       initialize_filter_form
@@ -21,7 +31,7 @@ module Super
     # Displays a specific record to the user
     def show
       @record = load_record
-      @display = display_schema.apply(action: current_action)
+      @display = display_schema.apply(action: current_action, format: request.format)
       @view = show_view
     end
 
@@ -86,7 +96,7 @@ module Super
 
     private
 
-    def current_action
+    helper_method def current_action
       @current_action ||=
         ActionInquirer.new(
           ActionInquirer.default_for_resources,
@@ -104,5 +114,25 @@ module Super
     ensure
       @current_action = original
     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/substructure_controller.rb

@@ -4,10 +4,28 @@ 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 NotImplementedError
+      raise Error::NotImplementedError
     end
 
     # This is an optional method
@@ -17,6 +35,16 @@ module Super
       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
     #
@@ -65,12 +93,28 @@ module Super
       params.require(strong_params.require(model)).permit(strong_params.permit)
     end
 
+    helper_method def form_record(record)
+      record
+    end
+
+    helper_method def form_action(record)
+      Super::Link.polymorphic_parts(record)
+    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)
+      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
@@ -91,6 +135,14 @@ module Super
       end
     end
 
+    helper_method def resolve_collection_action(action)
+      action.resolve(params: params)
+    end
+
+    helper_method def resolve_member_action(action, record)
+      action.resolve(params: params, record: record)
+    end
+
     helper_method def filters_enabled?
       true
     end
@@ -130,6 +182,15 @@ module Super
       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
@@ -188,6 +249,14 @@ module Super
       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]
@@ -204,55 +273,65 @@ module Super
     #
     # @return [ActiveRecord::Relation]
     def paginate_records
+      return @records if !pagination_enabled?
+
       @records
         .limit(@pagination.limit)
         .offset(@pagination.offset)
     end
 
+    helper_method def paginated_link(page_query_params)
+      polymorphic_path(
+        Super::Link.polymorphic_parts(model),
+        page_query_params
+      )
+    end
+
+    helper_method def csv_enabled?
+      true
+    end
+
     def index_view
       Super::Layout.new(
-        mains: [
-          Super::Panel.new(
-            Super::Partial.new("collection_header"),
-            :@display
-          ),
-        ],
-        asides: [
-          :@query_form,
-        ]
+        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(
-        mains: [
-          Super::Panel.new(
-            Super::Partial.new("member_header"),
-            :@display
-          ),
-        ]
+        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(
-        mains: [
-          Super::Panel.new(
-            Super::Partial.new("collection_header"),
-            :@form
-          ),
-        ]
+        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(
-        mains: [
-          Super::Panel.new(
-            Super::Partial.new("member_header"),
-            :@form
-          ),
-        ]
+        main: Super::ViewChain.new(
+          main_panel: Super::Panel.new,
+          main_header: Super::Partial.new("member_header"),
+          main: :@form
+        )
       )
     end
 
@@ -260,6 +339,7 @@ module Super
       included do
         helper_method :site_title
         helper_method :site_navigation
+        helper_method :document_title
       end
 
       private
@@ -271,6 +351,22 @@ module Super
       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

@@ -10,9 +10,9 @@ module Super
     # 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
+      ActionView::Base.field_error_proc = FormBuilder::FIELD_ERROR_PROC
 
-      options[:builder] ||= Form::Builder
+      options[:builder] ||= FormBuilder
       return form_for(record, options, &block)
     ensure
       ActionView::Base.field_error_proc = original
@@ -21,9 +21,9 @@ module Super
     # 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
+      ActionView::Base.field_error_proc = FormBuilder::FIELD_ERROR_PROC
 
-      options[:builder] ||= Form::Builder
+      options[:builder] ||= FormBuilder
       return form_with(**options, &block)
     ensure
       ActionView::Base.field_error_proc = original

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

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,9 @@
+<% 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 %>">
+<label for="<%= html_id %>"><%= value %></label>
+</div>
+<% else %>
+<%= value %>
+<% end %>

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

@@ -2,14 +2,15 @@
   <h1 class="text-xl">
     <%= title %>
   </h1>
-  <div>
-    <% collection_actions.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>
-  <% member_actions(record).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/_form.html.erb

@@ -1,4 +1,4 @@
-<%= super_form_for(Super::Link.polymorphic_parts(@record), builder: Super::Form::Builder) do |f| %>
+<%= super_form_for(form_record(@record), url: form_action(@record)) do |f| %>
   <div class="max-w-3xl">
     <% form.each_attribute do |field, type| %>
       <%= render(

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

@@ -1,29 +1,28 @@
-<% layout.resolve(self) %>
+<%# <% layout.resolve(self) %1> %>
 
-<% layout.resolved_headers.each do |partial| %>
-  <%= Super::Partial.render(partial, template: self) %>
+<% if layout.header %>
+  <%= render layout.header %>
 <% end %>
 
-<% if layout.resolved_asides.empty? %>
-  <% layout.resolved_mains.each do |partial| %>
-    <%= Super::Partial.render(partial, template: self) %>
-  <% end %>
-<% else %>
+<% if layout.aside %>
   <div class="flow-root -mx-2">
     <div class="md:float-left md:w-9/12 px-2">
-      <% layout.resolved_mains.each do |partial| %>
-        <%= Super::Partial.render(partial, template: self) %>
+      <% if layout.main %>
+        <%= render layout.main %>
       <% end %>
     </div>
 
     <div class="md:float-right md:w-3/12 px-2">
-      <% layout.resolved_asides.each do |partial| %>
-        <%= Super::Partial.render(partial, template: self) %>
-      <% end %>
+      <%= render layout.aside %>
     </div>
   </div>
+<% else %>
+  <% if layout.main %>
+    <%= render layout.main %>
+  <% end %>
 <% end %>
 
-<% layout.resolved_footers.each do |partial| %>
+<% if layout.footer %>
+  <%= render layout.footer %>
   <%= Super::Partial.render(partial, template: self) %>
 <% end %>

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

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

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

@@ -2,15 +2,15 @@
   <h1 class="text-xl">
     <%= title %>
   </h1>
-  <div>
-    <% member_actions(@record).each do |link| %>
-      <%= link.to_s(
+  <div class="flex gap-2">
+    <% resolved_member_actions(@record).each do |link| %>
+      <%= render(
+        link,
         default_options: {
-          class: "super-button super-button--border-blue super-button-sm inline-block ml-2"
-        },
-        record: @record,
-        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/_pagination.html.erb

@@ -1,13 +1,11 @@
+<%= yield %>
 <% if @pagination.necessary? %>
   <div class="flex justify-end mr-2">
     <div class="mt-4">
       <% @pagination.each do |page_query_params, is_current_page, display| %>
         <%= link_to(
           display,
-          polymorphic_path(
-            Super::Link.polymorphic_parts(model),
-            page_query_params
-          ),
+          paginated_link(page_query_params),
           class: "inline-block ml-2 text-lg #{is_current_page ? " text-gray-900" : ""}"
         ) %>
       <% end %>

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

@@ -1,3 +1,3 @@
 <div class="pt-8 text-sm text-gray-800">
-  <%= t("super.layout.powered_by", env: Rails.env.capitalize, version: Super::VERSION) %>
+  <%= t("super.layout.powered_by_html", env: Rails.env.capitalize, version: Super::VERSION) %>
 </div>

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) %>
-      <%= link_or_menu.to_s(default_options: { class: "inline-block mr-6" }) %>
+      <%= render(link_or_menu, 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">
+      <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">
+        <ul class="absolute bg-white shadow-md px-4 py-3 z-20">
           <% link_or_menu.links.each do |link| %>
-            <li><%= link.to_s(default_options: { class: "" }) %></li>
+            <li><%= render(link, default_options: { class: "" }) %></li>
           <% end %>
         </ul>
       </details>

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

@@ -0,0 +1,5 @@
+<% current = view_chain.chain.shift %>
+<% current = instance_variable_get(current) if current.kind_of?(Symbol) %>
+<%= render(current) do %>
+  <%= render(view_chain) %>
+<% end %>

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

@@ -0,0 +1,14 @@
+<%=
+  attribute_names = @display.each_attribute_name.to_a
+
+  CSV
+    .generate(write_headers: true, headers: attribute_names) do |csv|
+      @records.each do |record|
+        row = attribute_names.map do |attribute_name|
+          @display.render_attribute(template: self, record: record, column: attribute_name)
+        end
+        csv << row
+      end
+    end
+    .html_safe
+-%>

data/config/locales/en.yml

@@ -1,5 +1,19 @@
 ---
 en:
   super:
+    actions:
+      new: New
+      index: Index
+      show: View
+      edit: Edit
+      destroy: Delete
+    batch:
+      none_error: This batch action received no items to act upon
+    csv:
+      initial_cta: Export CSV
+      modal_header: Export CSV
+      download_current_cta: Download current view
+      download_all_cta: Download all matching query
     layout:
-      powered_by: "%{env} environment. Powered by Super %{version}."
+      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."