super 0.0.3 → 0.0.8

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

@@ -1,4 +1,4 @@
-<fieldset class="border border-gray-300 rounded p-4">
+<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 %>

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

@@ -1,4 +1,4 @@
-<div data-controller="nested-attributes">
+<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 %>
@@ -7,15 +7,15 @@
     form.fields_for(
       form_has_many.reader,
       form.object.public_send(form_has_many.reader).build,
-      child_index: "TEMPLATE"
+      child_index: "TEMPLATEINDEX"
     ) do |ff|
   %>
-    <template data-target="nested-attributes.template">
+    <template data-apply-template-target="template">
       <%= render "form_fieldset", form_fieldset: form_has_many, form: ff %>
     </template>
   <% end %>
 
-  <button data-action="nested-attributes#add" class="bg-blue-700 hover:bg-blue-800 text-white py-2 px-4 rounded 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/_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::Partial.render(partial, template: self) %>
+<% end %>
+
+<% 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.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.resolved_asides.each do |partial| %>
+        <%= Super::Partial.render(partial, template: self) %>
+      <% end %>
+    </div>
+  </div>
+<% end %>
+
+<% 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

@@ -0,0 +1,7 @@
+<% 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.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 leading-loose mt-4">
+  <% super_schema_display_show.each_attribute_name do |attribute_name| %>
+    <tr>
+      <th class="text-right px-4"><%= controls.model.human_attribute_name(attribute_name) %></th>
+      <td><%= super_schema_display_show.render_field(template: self, record: @record, column: attribute_name) %></td>
+    </tr>
+  <% end %>
+</table>

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

@@ -0,0 +1,15 @@
+<%= form_for(Super.configuration.path_parts(@record), builder: Super::Form::Builder) do |f| %>
+  <div class="max-w-3xl">
+    <% super_schema_form.each_attribute do |field, type| %>
+      <%= render(
+        type,
+        form: f,
+        column: field
+      ) %>
+    <% end %>
+
+    <div>
+      <%= f.submit class: "super-button super-button--fill-blue mt-2" %>
+    </div>
+  </div>
+<% end %>

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

@@ -1,6 +1 @@
-<%= render(
-  partial: "form",
-  locals: {
-    resource: @resource,
-  }
-) %>
+<%= render(@view) %>

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

@@ -1 +1 @@
-<%= render("index") %>
+<%= render(@view) %>

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

@@ -1,6 +1 @@
-<%= render(
-  partial: "form",
-  locals: {
-    resource: @resource,
-  }
-) %>
+<%= render(@view) %>

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

@@ -1 +1 @@
-<%= render("show") %>
+<%= 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,6 @@
+# Docs
+
+* [Quick start](./quick_start.md)
+* [Webpacker](./webpacker.md)
+* [Controls](./controls.md)
+* [FAQ](./faq.md)

data/docs/cheat.md

@@ -0,0 +1,41 @@
+<!--
+# @title Cheat sheet
+-->
+
+# Cheat sheet
+
+## Controls
+
+Controls are the primary way to "control" the behavior of your admin pages.
+They only work with Active Record 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
+* **`#permitted_params(params, action:)`**
+  The strong parameters definition
+* **`#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
+
+
+### 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`

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
+    def initialize(current_user)
+      @current_user = current_user
+    end
+
+    def model
+      Post
+    end
+
+    def scope(action:)
+      # Example: admins can read and write; customer support can only read
+      if @current_user.admin?
+        return model.all
+      end
+
+      if action.read?
+        return model.all
+      end
+
+      raise Super::Error::Forbidden
+    end
+
+    # ...
+  end
+end
+```

data/docs/quick_start.md

@@ -0,0 +1,45 @@
+<!--
+# @title Quick start
+-->
+
+# Quick start
+
+## 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!
+```
+
+Super supports using Webpacker instead of Sprockets. For more information,
+see the [Webpacker guide](./webpacker.md).
+
+## 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,17 @@
+<!--
+# @title Webpacker
+-->
+
+# Installation with Webpacker
+
+Super supports using Webpacker instead of Sprockets. Note though that you need
+to set up ERB templates under Webpacker. There are no other requirements or
+dependencies.
+
+After adding `super` to your Gemfile and running the installation generator
+according to the [Quick start guide](./quick_start.md), run the following:
+
+```bash
+bundle exec rails webpacker:install:erb # if you haven't already
+bundle exec rails generate super:webpacker
+```

data/docs/yard_customizations.rb

@@ -0,0 +1,41 @@
+require "yard"
+
+module FixRelativeLinks
+  def resolve_links(html)
+    html = html.gsub(%r{<a href="([^"]+)">([^<]+)</a>}) do
+      resolve_link_to_docs_subdir(full_match: $&, href: $1, content: $2)
+    end
+
+    html = html.gsub(%r{(<pre[^<]+)?<code[^>]*>([^<]+)</code>}) do
+      resolve_link_to_code(full_match: $&, pre: $1, code: $2)
+    end
+
+    super(html)
+  end
+
+  def resolve_link_to_docs_subdir(full_match:, href:, content:)
+    if href =~ /\bdocs\b/
+      %({file:#{href} #{content}})
+    else
+      full_match
+    end
+  end
+
+  def resolve_link_to_code(full_match:, pre:, code:)
+    if pre
+      return full_match
+    end
+
+    if code.include?("\n")
+      return full_match
+    end
+
+    if !code.start_with?("Super::")
+      return full_match
+    end
+
+    "{#{code}}"
+  end
+end
+
+YARD::Templates::Template.extra_includes << FixRelativeLinks

data/frontend/super-frontend/build.js

@@ -1,17 +1,17 @@
-const Bundler = require('parcel-bundler');
-const fs = require('fs');
-const path = require('path');
+const Bundler = require("parcel-bundler");
+const fs = require("fs");
+const path = require("path");
 
 const entryFiles = [
-  'src/stylesheets/super/application.css',
-  'src/javascripts/super/application.ts',
+  "src/stylesheets/super/application.css",
+  "src/javascripts/super/application.ts",
 ];
 
 const options = {
-  outDir: '../../app/assets',
-  watch: process.argv.includes('--watch'),
-  cacheDir: 'tmp/parcel/cache',
-  global: 'Super',
+  outDir: "../../app/assets",
+  watch: process.argv.includes("--watch"),
+  cacheDir: "tmp/parcel/cache",
+  global: "Super",
   contentHash: false,
   minify: false,
   sourceMaps: false,
@@ -20,10 +20,10 @@ const options = {
 
 const bundler = new Bundler(entryFiles, options);
 
-bundler.on('bundled', function (bundle) {
-  bundle.childBundles.forEach(function (childBundle) {
+bundler.on("bundled", function(bundle) {
+  bundle.childBundles.forEach(function(childBundle) {
     var basename = path.basename(childBundle.name);
-    var destDir = path.join(__dirname, 'dist');
+    var destDir = path.join(__dirname, "dist");
     var destPath = path.join(destDir, basename);
 
     console.log(destPath);