super 0.0.12 → 0.17.0

data/app/controllers/super/application_controller.rb

@@ -2,75 +2,78 @@
 
 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 :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
+      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
-        @form = controls.form_schema(action: action_inquirer_for("new"))
-        @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
-        @form = controls.form_schema(action: action_inquirer_for("edit"))
-        @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"
@@ -83,19 +86,23 @@ module Super
 
     private
 
-    def controls
-      @controls ||= new_controls
+    def current_action
+      @current_action ||=
+        ActionInquirer.new(
+          ActionInquirer.default_for_resources,
+          params[:action]
+        )
     end
 
-    def action_inquirer
-      @action_inquirer ||= action_inquirer_for(params[:action])
-    end
-
-    def action_inquirer_for(action)
-      ActionInquirer.new(
+    def with_current_action(action)
+      original = @current_action
+      @current_action = ActionInquirer.new(
         ActionInquirer.default_for_resources,
         action
       )
+      yield
+    ensure
+      @current_action = original
     end
   end
 end

data/app/controllers/super/substructure_controller.rb

@@ -0,0 +1,276 @@
+# 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 =
+        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
+
+    # 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

@@ -13,11 +13,7 @@
       <% if stylesheet.handler.sprockets? %>
         <%= stylesheet_link_tag(stylesheet.path, **stylesheet.arguments) %>
       <% elsif stylesheet.handler.webpacker? %>
-        <% if Gem::Dependency.new("webpacker", "> 5.99", "< 7").matching_specs.any? %>
-          <%= stylesheet_packs_with_chunks_tag(stylesheet.path) %>
-        <% else %>
-          <%= stylesheet_pack_tag(stylesheet.path, **stylesheet.arguments) %>
-        <% end %>
+        <%= stylesheet_pack_tag(stylesheet.path, **stylesheet.arguments) %>
       <% end %>
     <% end %>
 
@@ -25,23 +21,14 @@
       <% if javascript.handler.sprockets? %>
         <%= javascript_include_tag(javascript.path) %>
       <% elsif javascript.handler.webpacker? %>
-        <% if Gem::Dependency.new("webpacker", "> 5.99", "< 7").matching_specs.any? %>
-          <%= javascript_packs_with_chunks_tag(javascript.path) %>
-        <% else %>
-          <%= javascript_pack_tag(javascript.path) %>
-        <% end %>
+        <%= javascript_pack_tag(javascript.path) %>
       <% end %>
     <% end %>
   </head>
 
   <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>
-        <% Super::Navigation::Automatic.new.each do |text, href| %>
-          <%= link_to(text, href, class: "inline-block mr-6") %>
-        <% end %>
-      </header>
+      <%= render "site_header" %>
 
       <%= render "flash" %>
 
@@ -49,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>