super 0.0.15 → 0.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b7ba12321fd5d2a62b2aa9d81a832df2741a25adb997fa393c1aaab49d29946
-  data.tar.gz: 2251cbc956d77d0e96b6904706c1ec3af8f3ae7edfcc8e5352268554a2296d27
+  metadata.gz: 14981d8658b6c65e32ead25ed20481ab4f675928239f72454ed0fc8d2dcd8795
+  data.tar.gz: 124dc8f187b220e30d171bf4a2dda7f778b52a70088df3ffce5ea15bdfa93196
 SHA512:
-  metadata.gz: b515c1e2f3b9b382eb8244793e453af79303618612f06536b6167aed55bc713807857fd6a0bbed30e45af84b5338b5edd53d84246bf5cc79737e3674d24074aa
-  data.tar.gz: 55623dc8472f95d6179073399478f452c3854f7c49791e1adf3e8371676bef3f443f3601ad3786fae36105c9988c160a14bf9c0f83d0ed7dc0dee2af3ecd030e
+  metadata.gz: '0780127899eadf34022440f92166258941a8794a72098af5694b4df28da8b3c7a9f7c91ef8f140c0bc5fdd7154d539d197061229402ad9500c4510928ff0be03'
+  data.tar.gz: 9025a0591386f938da8dc65a3d3dca846f76093c1d1c529b9df97a3cd0aa14b543dd2b32854273cbe23fd97358fce5dcef0712b96b5b29c09d0b7b0dda2b2b90

data/README.md

@@ -14,8 +14,8 @@ application. It does this by having zero dependencies—this lets you update you
 app's dependencies without worrying about breaking your admin pages, and vice
 versa, update your admin pages without breaking your app.
 
-Note: There may be lots of breaking changes since Super is still fairly young.
-See the [stability doc](./STABILITY.md) for an idea of what might be changed.
+Note: Super is under active development and will likely have a few more breaking
+changes before 1.0.
 
 
 ## Features

data/app/assets/javascripts/super/application.js

@@ -237,7 +237,7 @@ var Super = (function (exports) {
 
   /*
   Unobtrusive JavaScript
-  https://github.com/rails/rails/blob/master/actionview/app/assets/javascripts
+  https://github.com/rails/rails/blob/main/actionview/app/assets/javascripts
   Released under the MIT license
    */
   createCommonjsModule(function (module) {
@@ -489,9 +489,9 @@ var Super = (function (exports) {
 
             if (!options.crossDomain) {
               xhr.setRequestHeader('X-Requested-With', 'XMLHttpRequest');
+              CSRFProtection(xhr);
             }
 
-            CSRFProtection(xhr);
             xhr.withCredentials = !!options.withCredentials;
 
             xhr.onreadystatechange = function () {

data/app/assets/stylesheets/super/application.css

@@ -1,6 +1,6 @@
-/*! tailwindcss v2.1.1 | MIT License | https://tailwindcss.com */
+/*! tailwindcss v2.1.2 | MIT License | https://tailwindcss.com */
 
-/*! modern-normalize v1.0.0 | MIT License | https://github.com/sindresorhus/modern-normalize */
+/*! modern-normalize v1.1.0 | MIT License | https://github.com/sindresorhus/modern-normalize */
 
 /*
 Document
@@ -12,8 +12,8 @@ Use a better box model (opinionated).
 */
 
 *,
-*::before,
-*::after {
+::before,
+::after {
   box-sizing: border-box;
 }
 
@@ -21,7 +21,7 @@ Use a better box model (opinionated).
 Use a more readable tab size (opinionated).
 */
 
-:root {
+html {
   -moz-tab-size: 4;
   -o-tab-size: 4;
      tab-size: 4;
@@ -1479,6 +1479,12 @@ span.flatpickr-day.selected {
   outline-offset: 2px;
 }
 
+.super-input:disabled {
+  opacity: 0.5;
+  --tw-bg-opacity: 1;
+  background-color: rgba(247, 250, 252, var(--tw-bg-opacity));
+}
+
 .super-input-select {
   padding-right: 2rem;
   width: 100%;

data/app/controllers/super/application_controller.rb

@@ -2,78 +2,76 @@
 
 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
+    helper_method :current_action
 
     # 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)
+      @records = load_records
+      @display = display_schema.apply(action: current_action)
+      @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)
+      @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_with_params
 
-      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
 
-      if controls.update_record(action: action_inquirer, record: @record, params: params)
+      if update_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 +84,12 @@ module Super
 
     private
 
-    def controls
-      @controls ||= new_controls
-    end
-
-    def action_inquirer
-      @action_inquirer ||=
+    def current_action
+      @current_action ||=
         ActionInquirer.new(
           ActionInquirer.default_for_resources,
           params[:action]
         )
     end
-
-    def navigation
-      Navigation.new(&:all)
-    end
   end
 end

data/app/controllers/super/substructure_controller.rb

@@ -0,0 +1,265 @@
+# 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 NotImplementedError
+    end
+
+    # This is an optional method
+    #
+    # @return [String]
+    helper_method def title
+      model.name.pluralize
+    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 = Super::Form::StrongParams.new(form_schema)
+      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
+    #
+    # @return [Array<Link>]
+    helper_method def member_actions
+      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 build_record_with_params
+      base_scope.build(permitted_params)
+    end
+
+    def save_record
+      @record.save
+    end
+
+    def update_record
+      @record.update(permitted_params)
+    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
+
+    # 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
+      @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
+      end
+
+      private
+
+      def site_title
+        Super.configuration.title
+      end
+
+      def site_navigation
+        Super::Navigation.new(&:all)
+      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

@@ -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.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

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

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

@@ -1,9 +1,9 @@
 <header class="flex justify-between content-end">
   <h1 class="text-xl">
-    <%= controls.title %>
+    <%= title %>
   </h1>
   <div>
-    <% controls.member_actions(action: action_inquirer).each do |link| %>
+    <% member_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/_pagination.html.erb

@@ -5,7 +5,7 @@
         <%= link_to(
           display,
           polymorphic_path(
-            Super::Link.polymorphic_parts(controls.model),
+            Super::Link.polymorphic_parts(model),
             page_query_params
           ),
           class: "inline-block ml-2 text-lg #{is_current_page ? " text-gray-900" : ""}"

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

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

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

@@ -0,0 +1,17 @@
+<header class="pt-4">
+  <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" }) %>
+    <% 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>

data/frontend/super-frontend/dist/application.css

@@ -1,6 +1,6 @@
-/*! tailwindcss v2.1.1 | MIT License | https://tailwindcss.com */
+/*! tailwindcss v2.1.2 | MIT License | https://tailwindcss.com */
 
-/*! modern-normalize v1.0.0 | MIT License | https://github.com/sindresorhus/modern-normalize */
+/*! modern-normalize v1.1.0 | MIT License | https://github.com/sindresorhus/modern-normalize */
 
 /*
 Document
@@ -12,8 +12,8 @@ Use a better box model (opinionated).
 */
 
 *,
-*::before,
-*::after {
+::before,
+::after {
   box-sizing: border-box;
 }
 
@@ -21,7 +21,7 @@ Use a better box model (opinionated).
 Use a more readable tab size (opinionated).
 */
 
-:root {
+html {
   -moz-tab-size: 4;
   -o-tab-size: 4;
      tab-size: 4;
@@ -1479,6 +1479,12 @@ span.flatpickr-day.selected {
   outline-offset: 2px;
 }
 
+.super-input:disabled {
+  opacity: 0.5;
+  --tw-bg-opacity: 1;
+  background-color: rgba(247, 250, 252, var(--tw-bg-opacity));
+}
+
 .super-input-select {
   padding-right: 2rem;
   width: 100%;

data/frontend/super-frontend/dist/application.js

@@ -237,7 +237,7 @@ var Super = (function (exports) {
 
   /*
   Unobtrusive JavaScript
-  https://github.com/rails/rails/blob/master/actionview/app/assets/javascripts
+  https://github.com/rails/rails/blob/main/actionview/app/assets/javascripts
   Released under the MIT license
    */
   createCommonjsModule(function (module) {
@@ -489,9 +489,9 @@ var Super = (function (exports) {
 
             if (!options.crossDomain) {
               xhr.setRequestHeader('X-Requested-With', 'XMLHttpRequest');
+              CSRFProtection(xhr);
             }
 
-            CSRFProtection(xhr);
             xhr.withCredentials = !!options.withCredentials;
 
             xhr.onreadystatechange = function () {

data/lib/generators/super/install/templates/base_controller.rb.tt

@@ -1,10 +1,2 @@
 class <%= parent_controller_name.classify %>Controller < Super::ApplicationController
-  class <%= parent_controller_name.classify.demodulize %>Controls < Super::Controls
-  end
-
-  private
-
-  def new_controls
-    self.class::Controls.new
-  end
 end

data/lib/generators/super/resource/templates/resources_controller.rb.tt

@@ -1,9 +1,9 @@
 <% module_namespacing do -%>
 class <%= controller_class_name %>Controller < <%= parent_controller_name.classify %>Controller
-  class Controls < <%= parent_controller_name.classify.demodulize %>Controls
-    def model
-      <%= class_name %>
-    end
+  private
+
+  def model
+    <%= class_name %>
   end
 end
 <% end -%>

data/lib/super.rb

@@ -14,7 +14,6 @@ require "super/badge"
 require "super/client_error"
 require "super/compatibility"
 require "super/configuration"
-require "super/controls"
 require "super/display"
 require "super/display/guesser"
 require "super/display/schema_types"

data/lib/super/action_inquirer.rb

@@ -25,12 +25,19 @@ module Super
       }
     end
 
+    # @return [ActionInquirer]
     def self.index!; new(default_for_resources, "index"); end
+    # @return [ActionInquirer]
     def self.show!; new(default_for_resources, "show"); end
+    # @return [ActionInquirer]
     def self.new!; new(default_for_resources, "new"); end
+    # @return [ActionInquirer]
     def self.edit!; new(default_for_resources, "edit"); end
+    # @return [ActionInquirer]
     def self.create!; new(default_for_resources, "create"); end
+    # @return [ActionInquirer]
     def self.update!; new(default_for_resources, "update"); end
+    # @return [ActionInquirer]
     def self.destroy!; new(default_for_resources, "destroy"); end
 
     def initialize(categories_and_their_actions, action)

data/lib/super/badge.rb

@@ -6,7 +6,6 @@ module Super
       light: "bg-gray-100 text-black",
       dark: "bg-gray-900 text-white",
       red: "bg-red-700 text-white",
-      orange: "bg-orange-400 text-black",
       yellow: "bg-yellow-400 text-black",
       green: "bg-green-700 text-white",
       blue: "bg-blue-700 text-white",

data/lib/super/cheat.rb

@@ -2,15 +2,15 @@
 
 module Super
   class Cheat
-    def controls
-      paths = %w[controls.rb controls/optional.rb controls/steps.rb controls/view.rb]
+    def controller
+      paths = %w[../../app/controllers/super/substructure_controller.rb]
       methods =
         paths
-        .map { |f| File.read(File.join(__dir__, f)) }
-        .flat_map { |content| content.scan(/^\s+def .*$/) }
-        .map { |method| method.strip.sub(/^def /, "#") }
+        .map { |f| File.read(File.expand_path(f, __dir__)) }
+        .flat_map { |content| content.scan(/^\s+(?:helper_method )?def .*$/) }
+        .map { |method| method.strip.sub(/^(?:helper_method )?def /, "#") }
 
-      puts "== Super::Controls"
+      puts "== Super::ApplicationController"
       puts methods.join("\n")
     end
   end

data/lib/super/link.rb

@@ -82,7 +82,7 @@ module Super
 
     def self.polymorphic_parts(*parts_tail)
       parts_head = Super.configuration.path.strip.gsub(%r{\A/+}, "").gsub(%r{/+\z}, "").strip.split("/")
-      parts_head + parts_tail
+      parts_head.map { |part| part.is_a?(String) ? part.to_sym : part } + parts_tail
     end
 
     def initialize(text, href, **options)

data/lib/super/pagination.rb

@@ -76,8 +76,8 @@ module Super
     module ControllerMethods
       def index
         super
-        @pagination = controls.initialize_pagination(action: action_inquirer, records: @records, query_params: request.GET)
-        @records = controls.paginate_records(action: action_inquirer, records: @records, pagination: @pagination)
+        @pagination = initialize_pagination
+        @records = paginate_records
         @view.mains.first.parts.push(:@pagination)
       end
     end

data/lib/super/reset.rb

@@ -12,6 +12,11 @@ module Super
       undef_method :edit
       undef_method :update
       undef_method :destroy
+
+      Super::SubstructureController.private_instance_methods(false).each do |imethod|
+        next if imethod == :navigation
+        undef_method imethod
+      end
     end
   end
 end

data/lib/super/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Super
-  VERSION = "0.0.15"
+  VERSION = "0.0.16"
 end

data/lib/tasks/super/cheat.rake

@@ -4,6 +4,6 @@ namespace :super do
   task :cheat do
     require "super/cheat"
     cheat = Super::Cheat.new
-    cheat.controls
+    cheat.controller
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: super
 version: !ruby/object:Gem::Version
-  version: 0.0.15
+  version: 0.0.16
 platform: ruby
 authors:
 - Zach Ahn
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-01 00:00:00.000000000 Z
+date: 2021-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -226,6 +226,7 @@ files:
 - app/assets/javascripts/super/application.js
 - app/assets/stylesheets/super/application.css
 - app/controllers/super/application_controller.rb
+- app/controllers/super/substructure_controller.rb
 - app/helpers/super/form_builder_helper.rb
 - app/views/layouts/super/application.html.erb
 - app/views/super/application/_collection_header.html.erb
@@ -250,6 +251,8 @@ files:
 - app/views/super/application/_pagination.html.erb
 - app/views/super/application/_panel.html.erb
 - app/views/super/application/_query.html.erb
+- app/views/super/application/_site_footer.html.erb
+- app/views/super/application/_site_header.html.erb
 - app/views/super/application/_sort.html.erb
 - app/views/super/application/_sort_expression.html.erb
 - app/views/super/application/edit.html.erb
@@ -285,10 +288,6 @@ files:
 - lib/super/client_error.rb
 - lib/super/compatibility.rb
 - lib/super/configuration.rb
-- lib/super/controls.rb
-- lib/super/controls/optional.rb
-- lib/super/controls/steps.rb
-- lib/super/controls/view.rb
 - lib/super/display.rb
 - lib/super/display/guesser.rb
 - lib/super/display/schema_types.rb

data/lib/super/controls.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-require "super/controls/optional"
-require "super/controls/steps"
-require "super/controls/view"
-
-module Super
-  # The base Controls class. Most parts of Super can be configured by
-  # customizing its methods.
-  class Controls
-    include Optional
-    include Steps
-    include View
-
-    # Specifies the model. This is a required method
-    #
-    # @return [ActiveRecord::Base]
-    def model
-      raise NotImplementedError
-    end
-  end
-end

data/lib/super/controls/optional.rb

@@ -1,122 +0,0 @@
-# frozen_string_literal: true
-
-module Super
-  class Controls
-    # Methods for `Controls` that have a sane default implementation
-    module Optional
-      # This is an optional method
-      #
-      # @return [String]
-      def title
-        model.name.pluralize
-      end
-
-      # Configures what database records are visible on load. This is an optional
-      # method, it defaults to "`all`" methods
-      #
-      # @param action [ActionInquirer]
-      # @return [ActiveRecord::Relation]
-      def scope(action:)
-        model.all
-      end
-
-      # Configures the fields that are displayed on the index and show actions.
-      # This is a required method
-      #
-      # @param action [ActionInquirer]
-      # @return [Display]
-      def display_schema(action:)
-        Display.new do |fields, type|
-          Display::Guesser.new(model: model, action: action, fields: fields, type: type).call
-        end
-      end
-
-      # Configures the editable fields on the new and edit actions. This is a
-      # required method
-      #
-      # @param action [ActionInquirer]
-      # @return [Form]
-      def form_schema(action:)
-        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
-      #
-      # @param params [ActionController::Parameters]
-      # @param action [ActionInquirer]
-      # @return [ActionController::Parameters]
-      def permitted_params(params, action:)
-        strong_params = Super::Form::StrongParams.new(form_schema(action: action))
-        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
-      #
-      # @param action [ActionInquirer]
-      # @return [Array<Link>]
-      def collection_actions(action:)
-        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
-      #
-      # @param action [ActionInquirer]
-      # @return [Array<Link>]
-      def member_actions(action:)
-        if action.show?
-          Super::Link.find_all(:edit, :destroy)
-        elsif action.edit?
-          Super::Link.find_all(:show, :destroy)
-        else
-          Super::Link.find_all(:show, :edit, :destroy)
-        end
-      end
-
-      def filters_enabled?
-        true
-      end
-
-      def filter_schema
-        Super::Filter.new do |fields, type|
-          Super::Filter::Guesser.new(model: model, fields: fields, type: type).call
-        end
-      end
-
-      def sort_enabled?
-        true
-      end
-
-      def sortable_columns
-        action = ActionInquirer.new(
-          ActionInquirer.default_for_resources,
-          "index"
-        )
-        attribute_names =
-          display_schema(action: action).each_attribute.map do |key, val|
-            val = val.build if val.respond_to?(:build)
-            key if val.real?
-          end
-
-        attribute_names.compact
-      end
-
-      def default_sort
-        { id: :desc }
-      end
-
-      # Specifies how many records to show per page
-      #
-      # @param action [ActionInquirer]
-      # @param query_params [Hash]
-      # @return [ActiveRecord::Relation]
-      def records_per_page(action:, query_params:)
-        Super.configuration.index_records_per_page
-      end
-    end
-  end
-end

data/lib/super/controls/steps.rb

@@ -1,133 +0,0 @@
-# frozen_string_literal: true
-
-module Super
-  class Controls
-    # Methods that are called by controller actions. All of these methods have
-    # a default implementation, but feel free to override as needed.
-    module Steps
-      # Tells the controller how to load records in the index action using
-      # `#scope`
-      #
-      # @param action [ActionInquirer]
-      # @param params [ActionController::Parameters]
-      # @return [ActiveRecord::Relation]
-      def load_records(action:, params:)
-        scope(action: action)
-      end
-
-      # Loads a record using `#scope`
-      #
-      # @param action [ActionInquirer]
-      # @param params [ActionController::Parameters]
-      # @return [ActiveRecord::Base]
-      def load_record(action:, params:)
-        scope(action: action).find(params[:id])
-      end
-
-      # Builds a record using `#scope`
-      #
-      # @param action [ActionInquirer]
-      # @return [ActiveRecord::Base]
-      def build_record(action:)
-        scope(action: action).build
-      end
-
-      # Builds and populates a record using `#scope`
-      #
-      # @param action [ActionInquirer]
-      # @param params [ActionController::Parameters]
-      # @return [ActiveRecord::Base]
-      def build_record_with_params(action:, params:)
-        scope(action: action).build(permitted_params(params, action: action))
-      end
-
-      # Saves a record
-      #
-      # @param action [ActionInquirer]
-      # @param params [ActionController::Parameters]
-      # @return [true, false]
-      def save_record(action:, record:, params:)
-        record.save
-      end
-
-      # Saves a record
-      #
-      # @param action [ActionInquirer]
-      # @param params [ActionController::Parameters]
-      # @return [true, false]
-      def update_record(action:, record:, params:)
-        record.update(permitted_params(params, action: action))
-      end
-
-      # Destroys a record
-      #
-      # @param action [ActionInquirer]
-      # @param params [ActionController::Parameters]
-      # @return [ActiveRecord::Base, false]
-      def destroy_record(action:, record:, params:)
-        record.destroy
-      end
-
-      def initialize_query_form(params:, current_path:)
-        Super::Query::FormObject.new(
-          model: model,
-          params: params,
-          namespace: :q,
-          current_path: current_path,
-        )
-      end
-
-      def apply_queries(query_form:, records:)
-        query_form.apply_changes(records)
-      end
-
-      def initialize_filter_form(query_form:)
-        if filters_enabled?
-          query_form.add(
-            Super::Filter::FormObject,
-            namespace: :f,
-            schema: filter_schema
-          )
-        end
-      end
-
-      def initialize_sort_form(query_form:)
-        if sort_enabled?
-          query_form.add(
-            Super::Sort::FormObject,
-            namespace: :s,
-            default: default_sort,
-            sortable_columns: sortable_columns
-          )
-        end
-      end
-
-      # Sets up pagination
-      #
-      # @param action [ActionInquirer]
-      # @param records [ActiveRecord::Relation]
-      # @param query_params [Hash]
-      # @return [Pagination]
-      def initialize_pagination(action:, records:, query_params:)
-        Pagination.new(
-          total_count: records.size,
-          limit: records_per_page(action: action, query_params: query_params),
-          query_params: query_params,
-          page_query_param: :page
-        )
-      end
-
-      # Paginates
-      #
-      # @param action [ActionInquirer]
-      # @param records [ActiveRecord::Relation]
-      # @param pagination [Pagination]
-      # @return [ActiveRecord::Relation]
-      def paginate_records(action:, records:, pagination:)
-        records
-          .limit(pagination.limit)
-          .offset(pagination.offset)
-      end
-    end
-  end
-end

data/lib/super/controls/view.rb

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-module Super
-  class Controls
-    # Methods for `Controls` that have a sane default implementation
-    module View
-      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
-    end
-  end
-end