super 0.0.4 → 0.0.9

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

@@ -1,5 +1,13 @@
-<div class="super-field-group">
-  <%= form.label(column, class: "block") %>
-  <%= form.text_field(column, class: "super-input w-full mt-1") %>
-  <%= render "form_inline_errors", form: form, column: column %>
-</div>
+<% 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_has_many.html.erb

@@ -10,12 +10,12 @@
       child_index: "TEMPLATEINDEX"
     ) do |ff|
   %>
-    <template data-target="apply-template.template">
+    <template data-apply-template-target="template">
       <%= render "form_fieldset", form_fieldset: form_has_many, form: ff %>
     </template>
   <% end %>
 
-  <button data-action="apply-template#call" class="super-button super-button--fill-blue mt-2">
+  <a href="#" data-action="apply-template#call" class="super-button super-button--fill-blue mt-2 inline-block">
     Add <%= form_has_many.label %>
-  </button>
+  </a>
 </div>

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

@@ -1,5 +1,5 @@
 <% if form.object %>
-  <% form.object.errors.full_messages_for(column).each do |error_message| %>
+  <% 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 %>

data/app/views/super/application/{_resource_header.html.erb → _member_header.html.erb}

@@ -3,13 +3,13 @@
     <%= controls.title %>
   </h1>
   <div>
-    <% controls.resource_actions(@resource, params: params, action: action_inquirer).each do |link| %>
-      <%= link_to(
-        link.text,
-        link.href,
-        link.options.reverse_merge(
+    <% 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>

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

@@ -1,34 +1,29 @@
-<%
-  super_layout_headers = super_resolve_list_for_rendering(super_layout.headers)
-  super_layout_asides = super_resolve_list_for_rendering(super_layout.asides)
-  super_layout_mains = super_resolve_list_for_rendering(super_layout.mains)
-  super_layout_footers = super_resolve_list_for_rendering(super_layout.footers)
-%>
+<% super_layout.resolve(self) %>
 
-<% super_layout_headers.each do |partial| %>
-  <%= super_render_partialish(partial) %>
+<% super_layout.resolved_headers.each do |partial| %>
+  <%= Super::Partial.render(partial, template: self) %>
 <% end %>
 
-<% if super_layout_asides.empty? %>
-  <% super_layout_mains.each do |partial| %>
-    <%= super_render_partialish(partial) %>
+<% if super_layout.resolved_asides.empty? %>
+  <% super_layout.resolved_mains.each do |partial| %>
+    <%= Super::Partial.render(partial, template: self) %>
   <% end %>
 <% else %>
   <div class="clearfix -mx-2">
     <div class="md:float-left md:w-9/12 px-2">
-      <% super_layout_mains.each do |partial| %>
-        <%= super_render_partialish(partial) %>
+      <% super_layout.resolved_mains.each do |partial| %>
+        <%= Super::Partial.render(partial, template: self) %>
       <% end %>
     </div>
 
     <div class="md:float-right md:w-3/12 px-2">
-      <% super_layout_asides.each do |partial| %>
-        <%= super_render_partialish(partial) %>
+      <% super_layout.resolved_asides.each do |partial| %>
+        <%= Super::Partial.render(partial, template: self) %>
       <% end %>
     </div>
   </div>
 <% end %>
 
-<% super_layout_footers.each do |partial| %>
-  <%= super_render_partialish(partial) %>
+<% super_layout.resolved_footers.each do |partial| %>
+  <%= Super::Partial.render(partial, template: self) %>
 <% end %>

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

@@ -0,0 +1,16 @@
+<% 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 %>

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

@@ -1,11 +1,7 @@
-<%
-  super_panel_parts = super_resolve_list_for_rendering(super_panel.parts, Proc.new)
-%>
-
-<% if super_panel_parts.any? %>
+<% if super_panel.resolve(self, block_given? ? Proc.new { yield } : nil).resolved_parts.any? %>
   <div class="border rounded shadow border-gray-400 bg-white px-5 pt-4 pb-8 mt-6">
-    <% super_panel_parts.each do |partial| %>
-      <%= super_render_partialish(partial) %>
+    <% super_panel.resolved_parts.each do |partial| %>
+      <%= Super::Partial.render(partial, template: self) %>
     <% 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,24 @@
+<div class="mt-4 overflow-x-auto lg:overflow-x-visible">
+  <table class="w-full border-separate relative" cellspacing="0" cellpadding="0">
+    <thead class="">
+      <tr class="">
+        <% super_schema_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 sticky top-0 z-10">
+            <%= controls.model.human_attribute_name(attribute_name) %>
+          </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.each_attribute_name do |attribute_name| %>
+            <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 bg-white <%= Super::ViewHelper.classes(["bg-gray-100", row_index.odd?]) %>">
+              <%= super_schema_display_index.render_field(template: self, record: record, column: attribute_name) %>
+            </td>
+          <% end %>
+        </tr>
+      <% end %>
+    </tbody>
+  </table>
+</div>

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

@@ -0,0 +1,8 @@
+<table class="max-w-full mt-4">
+  <% super_schema_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>
+      <td class="py-1 align-baseline"><%= super_schema_display_show.render_field(template: self, record: @record, column: attribute_name) %></td>
+    </tr>
+  <% end %>
+</table>

data/app/views/super/application/{_form.html.erb → _super_schema_form.html.erb}

@@ -1,8 +1,6 @@
-<% schema = controls.form_schema(action: action_inquirer) %>
-
-<%= form_for(Super.configuration.path_parts(@resource)) do |f| %>
+<%= form_for(Super.configuration.path_parts(@record), builder: Super::Form::Builder) do |f| %>
   <div class="max-w-3xl">
-    <% schema.fields.each do |field, type| %>
+    <% super_schema_form.each_attribute do |field, type| %>
       <%= render(
         type,
         form: f,

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

@@ -1 +1 @@
-<%= render(@super_action.page) %>
+<%= render(@view) %>

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

@@ -1 +1 @@
-<%= render(@super_action.page) %>
+<%= render(@view) %>

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

@@ -1 +1 @@
-<%= render(@super_action.page) %>
+<%= render(@view) %>

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

@@ -1 +1 @@
-<%= render(@super_action.page) %>
+<%= render(@view) %>

data/config/locales/en.yml

@@ -0,0 +1,5 @@
+---
+en:
+  super:
+    layout:
+      powered_by: "%{env} environment. Powered by Super %{version}."

data/docs/README.md

@@ -0,0 +1,8 @@
+# Docs
+
+* [Quick Start](./quick_start.md)
+* [Installation](./installation.md)
+* [Webpacker](./webpacker.md)
+* [ActionText](./action_text.md)
+* [Cheat sheet](./cheat.md)
+* [FAQ](./faq.md)

data/docs/action_text.md

@@ -0,0 +1,48 @@
+<!--
+# @title ActionText
+-->
+
+# Using ActionText with Super
+
+Super has some basic support for editing and viewing ActionText. Since
+ActionText only works with Webpacker, you'll have to set up Webpacker for your
+application. You can optionally set up [Super to use Webpacker](./webpacker.md).
+
+Once you've set that up, ActionText should be relatively simple. The following
+command will copy over the necessary JS and CSS into your application:
+
+```bash
+bundle exec rails generate super:action_text
+```
+
+As an example, let's say we're making admin pages for a blog. We'll keep this
+example simple and work with a `Post` model with just a `#title` column and
+a rich text `#content` field.
+
+```ruby
+class Post < ApplicationRecord
+  has_rich_text :content
+end
+```
+
+We'll need to configure the `#form_schema` and `#display_schema` methods.
+
+```ruby
+class Controls < Super::Controls
+  # ...
+
+  def form_schema(action:)
+    Super::Form.new do |fields, type|
+      fields[:title] = type.text
+      fields[:content] = type.rich_text_area
+    end
+  end
+
+  def display_schema(action:)
+    Super::Display.new(action: action) do |fields, type|
+      fields[:title] = type.text
+      fields[:content] = type.rich_text
+    end
+  end
+end
+```

data/docs/cheat.md

@@ -0,0 +1,41 @@
+<!--
+# @title Cheat sheet
+-->
+
+# Cheat sheet
+
+## Controls
+
+You can configure most of your admin page's behavior by editing Controls.
+They only work with ActiveRecord models
+
+Controls have several required and optional methods. Note that all arguments
+must be defined, even if they are ignored.
+
+
+### Required methods
+
+The following are the methods that must be defined in the `Controls` class.
+
+* **`#model()`**
+  The model that your controller is working with
+
+
+### Optional methods
+
+The following are the methods that can be defined in the `Controls` class.
+
+* **`#title()`**
+  The title to show on the main panel
+* **`#collection_actions(action:)`**
+  The list of collection-level links
+* **`#member_actions(action:)`**
+  The list of member-level links and `#show` pages
+* **`#scope(action:)`**
+  The starting point of the query/relation. Defaults to `#all`
+* **`#display_schema(action:)`**
+  The display schema definition for the `#index` and `#show` pages
+* **`#form_schema(action:)`**
+  The form schema definition for the `#new` and `#edit` pages
+* **`#permitted_params(params, action:)`**
+  The strong parameters definition

data/docs/faq.md

@@ -0,0 +1,44 @@
+<!--
+# @title FAQ
+-->
+
+# FAQ
+
+## How do I handle authorization?
+
+Assuming you already have authentication set up, it should only require defining
+a `Controls#initialize` that accepts an authenticated user. From there, you can
+customize `Controls#scope` to have the required behavior.
+
+```ruby
+class PostsController < AdminController
+  def new_controls
+    Controls.new(current_user)
+  end
+
+  class Controls < Super::Controls
+    def initialize(current_user)
+      @current_user = current_user
+    end
+
+    def model
+      Post
+    end
+
+    def scope(action:)
+      # Example: admins can read and write; others can only read
+      if @current_user.admin?
+        return model.all
+      end
+
+      if action.read?
+        return model.all
+      end
+
+      raise Super::ClientError::Forbidden
+    end
+
+    # ...
+  end
+end
+```

data/docs/installation.md

@@ -0,0 +1,21 @@
+<!--
+# @title Installation
+-->
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "super"
+```
+
+And then execute:
+
+```bash
+bundle install
+bundle exec rails generate super:install # check out the `--help` option!
+```
+
+If you prefer, you can configure Super to use Webpacker instead of Sprockets.
+Check out the [Webpacker guide](./webpacker.md).

data/docs/quick_start.md

@@ -0,0 +1,30 @@
+<!--
+# @title Quick start
+-->
+
+# Quick start
+
+See [Installation](./installation.md) for the installation guide.
+
+
+## Usage
+
+### Creating new admin pages
+
+```bash
+bundle exec rails generate super:resource Thing # check out the `--help` option!
+```
+
+The example above will create a controller called `Admin::ThingsController`. It
+generates a `Controls` class inside the controller as well; it's where most
+configuration lives. See the documentation on [Controls](./controls.md) for more
+info.
+
+You'll have to manually update your routes file. It'll probably look something
+like the following:
+
+```ruby
+namespace :admin do
+  resources :things
+end
+```

data/docs/webpacker.md

@@ -0,0 +1,25 @@
+<!--
+# @title Webpacker
+-->
+
+# Installation with Webpacker
+
+Super supports using Webpacker instead of Sprockets. You'll first need to set up
+Webpacker to handle ERB templates.
+
+After installing Super (see the [Installation guide](./installation.md)), run
+one the following:
+
+## Webpacker 4 and 5
+
+```bash
+bundle exec rails webpacker:install:erb # if you haven't already
+bundle exec rails generate super:webpacker
+```
+
+## Webpacker 6
+
+```bash
+yarn add rails-erb-loader # if you haven't already
+bundle exec rails generate super:webpacker
+```