super 0.0.1 → 0.0.6

data/app/controllers/super/application_controller.rb

@@ -1,84 +1,92 @@
 module Super
+  # Provides a default implementation for each of the resourceful actions
   class ApplicationController < ActionController::Base
-    include Super::InlineCallback
+    include ClientError::Handling
     include Pluggable.new(:super_application_controller)
 
-    register_inline_callback(:index_paginate, on: :index, after: :yield)
-
+    helper_method :action_inquirer
     helper_method :controls
 
+    # Displays a list of records to the user
     def index
-      with_inline_callbacks do
-        @resources = controls.index_scope
-      end
+      @records = controls.load_records(action: action_inquirer, params: params)
+      @pagination = controls.initialize_pagination(action: action_inquirer, records: @records, query_params: request.GET)
+      @records = controls.paginate_records(action: action_inquirer, records: @records, pagination: @pagination)
+      @display = controls.display_schema(action: action_inquirer)
+    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)
     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)
+    end
+
+    # Creates a record, or shows the validation errors
     def create
-      @resource = controls.create_scope.build(create_permitted_params)
+      @record = controls.build_record_with_params(action: action_inquirer, params: params)
 
-      if @resource.save
-        redirect_to polymorphic_path(Super.configuration.path_parts(@resource))
+      if controls.save_record(action: action_inquirer, record: @record, params: params)
+        redirect_to polymorphic_path(Super.configuration.path_parts(@record))
       else
+        @form = controls.form_schema(action: action_inquirer_for("new"))
         render :new, status: :bad_request
       end
     end
 
-    def new
-      @resource = controls.new_scope.build
-    end
-
+    # Displays a form to allow the user to update an existing record
     def edit
-      @resource = controls.edit_scope.find(params[:id])
-    end
-
-    def show
-      @resource = controls.show_scope.find(params[:id])
+      @record = controls.load_record(action: action_inquirer, params: params)
+      @form = controls.form_schema(action: action_inquirer)
     end
 
+    # Updates a record, or shows validation errors
     def update
-      @resource = controls.update_scope.find(params[:id])
+      @record = controls.load_record(action: action_inquirer, params: params)
 
-      if @resource.update(update_permitted_params)
-        redirect_to polymorphic_path(Super.configuration.path_parts(@resource))
+      if controls.update_record(action: action_inquirer, record: @record, params: params)
+        redirect_to polymorphic_path(Super.configuration.path_parts(@record))
       else
+        @form = controls.form_schema(action: action_inquirer_for("edit"))
         render :edit, status: :bad_request
       end
     end
 
+    # Deletes a record, or shows validation errors
     def destroy
-      @resource = controls.destroy_scope.find(params[:id])
-      if @resource.destroy
+      @record = controls.load_record(action: action_inquirer, params: params)
+
+      if controls.destroy_record(action: action_inquirer, record: @record, params: params)
         redirect_to polymorphic_path(Super.configuration.path_parts(controls.model))
       else
-        redirect_to polymorphic_path(Super.configuration.path_parts(@resource))
+        flash.alert = "Couldn't delete record"
+        redirect_to polymorphic_path(Super.configuration.path_parts(@record))
       end
+    rescue ActiveRecord::InvalidForeignKey => e
+      flash.alert = "Couldn't delete record: #{e.class}"
+      redirect_to polymorphic_path(Super.configuration.path_parts(@record))
     end
 
     private
 
-    def index_paginate
-      @pagination = Pagination.new(
-        total_count: @resources.size,
-        limit: Super.configuration.index_resources_per_page,
-        query_params: request.GET,
-        page_query_param: :page
-      )
-
-      @resources = @resources
-        .limit(@pagination.limit)
-        .offset(@pagination.offset)
-    end
-
     def controls
-      Controls.new(dashboard)
+      Super::Controls.new(new_controls)
     end
 
-    def create_permitted_params
-      controls.create_permitted_params(params)
+    def action_inquirer
+      @action_inquirer ||= action_inquirer_for(params[:action])
     end
 
-    def update_permitted_params
-      controls.update_permitted_params(params)
+    def action_inquirer_for(action)
+      ActionInquirer.new(
+        ActionInquirer.default_for_resources,
+        action
+      )
     end
   end
 end

data/app/helpers/super/application_helper.rb

@@ -0,0 +1,39 @@
+module Super
+  # View helpers, available within views
+  module ApplicationHelper
+    def super_render_partialish(partialish)
+      if partialish.respond_to?(:to_partial_path)
+        if partialish.is_a?(Super::Partial)
+          render(partialish, partialish.locals)
+        else
+          render(partialish)
+        end
+      else
+        partialish
+      end
+    end
+
+    def super_format_for_display(schema, record, column)
+      formatter = schema.fields[column]
+
+      formatted =
+        if formatter.real?
+          value = record.public_send(column)
+          formatter.present(value)
+        else
+          formatter.present
+        end
+
+      if formatted.respond_to?(:to_partial_path)
+        if formatted.respond_to?(:locals)
+          formatted.locals[:record] ||= record
+          render(formatted, formatted.locals)
+        else
+          render(formatted)
+        end
+      else
+        formatted
+      end
+    end
+  end
+end

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

@@ -1,5 +1,5 @@
 <!DOCTYPE html>
-<html class="bg-white">
+<html class="bg-gray-100">
   <head>
     <title><%= Super.configuration.title %></title>
     <%= csrf_meta_tags %>
@@ -7,6 +7,8 @@
       <%= csp_meta_tag %>
     <% end -%>
 
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+
     <% if Super.configuration.asset_handler.sprockets? %>
       <%= stylesheet_link_tag "super/application", media: "all" %>
       <%= javascript_include_tag "super/application" %>
@@ -16,10 +18,10 @@
     <% end %>
   </head>
 
-  <body class="font-sans bg-white">
+  <body class="font-sans pb-4">
     <div class="px-4">
       <header class="pt-4">
-        <h1 class="text-base font-bold mr-6"><%= Super.configuration.title %></h1>
+        <h1 class="text-lg font-bold mr-6 mb-1"><%= Super.configuration.title %></h1>
         <%
         route_namespace = Super.configuration.route_namespace.map(&:to_s).join("/")
         Super::Navigation::Automatic.new(route_namespace: route_namespace).each do |text, href| %>
@@ -27,13 +29,15 @@
         <% end %>
       </header>
 
-      <div class="pt-8"></div>
+      <%= render "flash" %>
 
-      <% if content_for?(:header) %>
-        <%= yield :header %>
-      <% end %>
+      <div class="pt-4"></div>
 
       <%= yield %>
+
+      <div class="pt-8 text-sm text-gray-800">
+        <%= t("super.layout.powered_by", env: Rails.env.capitalize, version: Super::VERSION) %>
+      </div>
     </div>
   </body>
 </html>

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

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

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

@@ -0,0 +1,17 @@
+<% if flash.any? %>
+  <% colors = {
+    "notice" => { bg: "bg-blue-100", fg: "text-blue-400", border: "border-blue-600" },
+    "alert" => { bg: "bg-red-100", fg: "text-red-400", border: "border-red-600" },
+  } %>
+
+  <div class="mt-8">
+    <% flash.each do |level, messages| %>
+      <% Array(messages).each do |message| %>
+        <% color = colors[level.to_s] || colors["notice"] %>
+        <div class="<%= "%<bg>s %<fg>s border-l-4 %<border>s p-4 mt-2" % color %>">
+          <%= message %>
+        </div>
+      <% end %>
+    <% end %>
+  </div>
+<% end %>

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

@@ -0,0 +1,9 @@
+<% if !local_assigns[:ungrouped] %>
+  <div class="super-field-group">
+<% end %>
+  <%= form.check_box(column, data: { action: "toggle-pending-destruction#call" }) %>
+  <%= form.label(column) %>
+  <%= render "form_inline_errors", form: form, column: column %>
+<% if !local_assigns[:ungrouped] %>
+  </div>
+<% end %>

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

@@ -0,0 +1,23 @@
+<% if !local_assigns[:ungrouped] %>
+  <div class="super-field-group">
+<% end %>
+  <% if !local_assigns[:hide_label] %>
+    <%= form.label(column, class: "block") %>
+  <% end %>
+  <div class="<%= Super::ViewHelper.classes("super-input-select", ["mt-1", !local_assigns[:hide_label]]) %>">
+    <%= form.select(
+      column,
+      form_field_select[:collection],
+      { include_blank: true }.merge(form_field_select[:options] || {}),
+      { class: "super-input super-input-select-field" }
+    ) %>
+    <div class="super-input-select-icon text-gray-700">
+      <span class="h-4 w-4">
+        <%= render "super/feather/chevron_down" %>
+      </span>
+    </div>
+  </div>
+  <%= render "form_inline_errors", form: form, column: column %>
+<% if !local_assigns[:ungrouped] %>
+  </div>
+<% end %>

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

@@ -0,0 +1,13 @@
+<% if !local_assigns[:ungrouped] %>
+  <div class="super-field-group">
+<% end %>
+  <% if !local_assigns[:hide_label] %>
+    <%= form.label(column, class: "block") %>
+  <% end %>
+  <div class="<%= Super::ViewHelper.classes(["mt-1", !local_assigns[:hide_label]]) %>">
+    <%= form.text_field(column, class: "super-input w-full") %>
+    <%= render "form_inline_errors", form: form, column: column %>
+  </div>
+<% if !local_assigns[:ungrouped] %>
+  </div>
+<% end %>

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

@@ -0,0 +1,8 @@
+<fieldset class="border border-gray-300 rounded pb-4 px-4 mt-4 shadow" data-controller="toggle-pending-destruction">
+  <% if form_fieldset.label.present? %>
+    <legend class="bg-white p-1 -mx-1"><%= form_fieldset.label %></legend>
+  <% end %>
+  <% form_fieldset.nested_fields.each do |field, type| %>
+    <%= render(type, form: form, column: field) %>
+  <% end %>
+</fieldset>

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

@@ -0,0 +1,21 @@
+<div data-controller="apply-template">
+  <%= form.fields_for(form_has_many.reader) do |ff| %>
+    <%= render "form_fieldset", form_fieldset: form_has_many, form: ff %>
+  <% end %>
+
+  <%=
+    form.fields_for(
+      form_has_many.reader,
+      form.object.public_send(form_has_many.reader).build,
+      child_index: "TEMPLATEINDEX"
+    ) do |ff|
+  %>
+    <template data-apply-template-target="template">
+      <%= render "form_fieldset", form_fieldset: form_has_many, form: ff %>
+    </template>
+  <% end %>
+
+  <a href="#" data-action="apply-template#call" class="super-button super-button--fill-blue mt-2 inline-block">
+    Add <%= form_has_many.label %>
+  </a>
+</div>

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

@@ -0,0 +1,11 @@
+<div>
+  <%
+    if form.object.public_send(form_has_one.reader).nil?
+      form.object.public_send("build_" + form_has_one.reader.to_s)
+    end
+  %>
+
+  <%= form.fields_for(form_has_one.reader) do |ff| %>
+    <%= render "form_fieldset", form_fieldset: form_has_one, form: ff %>
+  <% end %>
+</div>

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

@@ -0,0 +1,10 @@
+<% if form.object %>
+  <% Super::ViewHelper.errors_accounting_for_reflections(form.object, column).each do |error_message| %>
+    <p class="text-red-400 text-xs italic pt-1"><%= error_message %></p>
+  <% end %>
+<% else %>
+  <p class="text-red-400 text-xs italic pt-1">
+    This form doesn't have an object, so something is probably wrong.
+    Maybe <code>accepts_nested_attributes_for</code> isn't set up?
+  </p>
+<% end %>

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

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

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

@@ -0,0 +1,29 @@
+<% super_layout.resolve(self) %>
+
+<% super_layout.resolved_headers.each do |partial| %>
+  <%= super_render_partialish(partial) %>
+<% end %>
+
+<% if super_layout.resolved_asides.empty? %>
+  <% super_layout.resolved_mains.each do |partial| %>
+    <%= super_render_partialish(partial) %>
+  <% end %>
+<% else %>
+  <div class="clearfix -mx-2">
+    <div class="md:float-left md:w-9/12 px-2">
+      <% super_layout.resolved_mains.each do |partial| %>
+        <%= super_render_partialish(partial) %>
+      <% end %>
+    </div>
+
+    <div class="md:float-right md:w-3/12 px-2">
+      <% super_layout.resolved_asides.each do |partial| %>
+        <%= super_render_partialish(partial) %>
+      <% end %>
+    </div>
+  </div>
+<% end %>
+
+<% super_layout.resolved_footers.each do |partial| %>
+  <%= super_render_partialish(partial) %>
+<% end %>

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

@@ -0,0 +1,7 @@
+<% if super_panel.resolve(self, block_given? ? Proc.new : nil).resolved_parts.any? %>
+  <div class="border rounded shadow border-gray-400 bg-white px-5 pt-4 pb-8 mt-6">
+    <% super_panel.resolved_parts.each do |partial| %>
+      <%= super_render_partialish(partial) %>
+    <% end %>
+  </div>
+<% end %>

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

@@ -0,0 +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>
+  <% end %>
+</div>

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

@@ -0,0 +1,39 @@
+<div class="mt-4 overflow-x-auto">
+  <table class="w-full border-separate" cellspacing="0" cellpadding="0">
+    <thead>
+      <tr class="">
+        <% super_schema_display_index.field_keys.each do |column| %>
+          <th class="p-2 first:pl-6 border-b border-b-2 border-gray-400 text-gray-600 text-left text-sm font-normal"><%= column.to_s.humanize %></th>
+        <% end %>
+      </tr>
+    </thead>
+    <tbody class="">
+      <% @records.each.with_index do |record, row_index| %>
+        <tr id="record-pk-<%= record.id %>" class="group">
+          <% super_schema_display_index.field_keys.each do |column| %>
+            <td class="py-1 px-2 first:pl-5 border-transparent border-t border-b group-hover:bg-blue-200 first:border-l first:rounded-l-lg last:border-r last:rounded-r-lg <%= Super::ViewHelper.classes(["bg-gray-100", row_index.odd?]) %>">
+              <%= super_format_for_display(super_schema_display_index, record, column) %>
+            </td>
+          <% end %>
+        </tr>
+      <% end %>
+    </tbody>
+  </table>
+</div>
+
+<% 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.configuration.path_parts(controls.model),
+            page_query_params
+          ),
+          class: "inline-block ml-2 text-lg #{is_current_page ? " text-gray-900" : ""}"
+        ) %>
+      <% end %>
+    </div>
+  </div>
+<% end %>