RubyGems - super - Versions diffs - 0.0.0 → 0.0.5 - Mend

super 0.0.0 → 0.0.5

Files changed (86) hide show

checksums.yaml +4 -4
data/.yardopts +10 -0
data/LICENSE +165 -0
data/README.md +66 -18
data/Rakefile +3 -1
data/app/assets/config/super_manifest.js +2 -0
data/app/assets/javascripts/super/application.js +3618 -0
data/app/assets/stylesheets/super/application.css +98584 -0
data/app/controllers/super/application_controller.rb +103 -0
data/app/helpers/super/application_helper.rb +32 -0
data/app/views/layouts/super/application.html.erb +39 -0
data/app/views/super/application/_flash.html.erb +17 -0
data/app/views/super/application/_form.html.erb +17 -0
data/app/views/super/application/_form_field__destroy.html.erb +9 -0
data/app/views/super/application/_form_field_select.html.erb +23 -0
data/app/views/super/application/_form_field_text.html.erb +13 -0
data/app/views/super/application/_form_fieldset.html.erb +8 -0
data/app/views/super/application/_form_has_many.html.erb +21 -0
data/app/views/super/application/_form_has_one.html.erb +11 -0
data/app/views/super/application/_form_inline_errors.html.erb +10 -0
data/app/views/super/application/_index.html.erb +45 -0
data/app/views/super/application/_resource_header.html.erb +16 -0
data/app/views/super/application/_resources_header.html.erb +16 -0
data/app/views/super/application/_show.html.erb +10 -0
data/app/views/super/application/_super_layout.html.erb +34 -0
data/app/views/super/application/_super_panel.html.erb +11 -0
data/app/views/super/application/edit.html.erb +6 -0
data/app/views/super/application/index.html.erb +6 -0
data/app/views/super/application/new.html.erb +6 -0
data/app/views/super/application/nothing.html.erb +0 -0
data/app/views/super/application/show.html.erb +6 -0
data/app/views/super/feather/README.md +32 -0
data/app/views/super/feather/_chevron_down.svg +1 -0
data/docs/README.md +6 -0
data/docs/controls.md +39 -0
data/docs/faq.md +44 -0
data/docs/quick_start.md +45 -0
data/docs/webpacker.md +17 -0
data/docs/yard_customizations.rb +41 -0
data/frontend/super-frontend/build.js +36 -0
data/frontend/super-frontend/dist/application.css +98584 -0
data/frontend/super-frontend/dist/application.js +3618 -0
data/frontend/super-frontend/package.json +21 -0
data/frontend/super-frontend/postcss.config.js +6 -0
data/frontend/super-frontend/src/javascripts/super/application.ts +18 -0
data/frontend/super-frontend/src/javascripts/super/apply_template_controller.ts +21 -0
data/frontend/super-frontend/src/javascripts/super/rails__ujs.d.ts +1 -0
data/frontend/super-frontend/src/javascripts/super/toggle_pending_destruction_controller.ts +15 -0
data/frontend/super-frontend/src/stylesheets/super/application.css +77 -0
data/frontend/super-frontend/tailwind.config.js +9 -0
data/frontend/super-frontend/tsconfig.json +13 -0
data/frontend/super-frontend/yarn.lock +5540 -0
data/lib/generators/super/install/USAGE +34 -0
data/lib/generators/super/install/install_generator.rb +46 -0
data/lib/generators/super/install/templates/base_controller.rb.tt +2 -0
data/lib/generators/super/install/templates/initializer.rb.tt +5 -0
data/lib/generators/super/resource/USAGE +8 -0
data/lib/generators/super/resource/resource_generator.rb +52 -0
data/lib/generators/super/resource/templates/resources_controller.rb.tt +45 -0
data/lib/generators/super/webpacker/USAGE +14 -0
data/lib/generators/super/webpacker/templates/pack_super_application.js.erb.tt +2 -0
data/lib/generators/super/webpacker/webpacker_generator.rb +25 -0
data/lib/super.rb +22 -4
data/lib/super/action_inquirer.rb +101 -0
data/lib/super/assets.rb +63 -0
data/lib/super/compatibility.rb +13 -0
data/lib/super/configuration.rb +103 -0
data/lib/super/controls.rb +120 -0
data/lib/super/display.rb +9 -0
data/lib/super/display/schema_types.rb +40 -0
data/lib/super/engine.rb +6 -0
data/lib/super/error.rb +18 -0
data/lib/super/form/schema_types.rb +115 -0
data/lib/super/layout.rb +19 -0
data/lib/super/link.rb +87 -0
data/lib/super/navigation/automatic.rb +71 -0
data/lib/super/pagination.rb +70 -0
data/lib/super/panel.rb +17 -0
data/lib/super/partial.rb +11 -0
data/lib/super/plugin.rb +89 -0
data/lib/super/schema.rb +73 -0
data/lib/super/step.rb +36 -0
data/lib/super/version.rb +1 -1
data/lib/super/view_helper.rb +43 -0
metadata +215 -14
data/LICENSE.txt +0 -40

data/app/controllers/super/application_controller.rb ADDED

@@ -0,0 +1,103 @@
+module Super
+  # Provides a default implementation for each of the resourceful actions
+  class ApplicationController < ActionController::Base
+    include Pluggable.new(:super_application_controller)
+    helper_method :action_inquirer
+    helper_method :controls
+    rescue_from Error::ClientError do |exception|
+      code, default_message =
+        case exception
+        when Error::UnprocessableEntity
+          [422, "Unprocessable entity"]
+        when Error::NotFound
+          [404, "Not found"]
+        when Error::Forbidden
+          [403, "Forbidden"]
+        when Error::Unauthorized
+          [401, "Unauthorized"]
+        when Error::BadRequest, Error::ClientError
+          [400, "Bad request"]
+        end
+      flash.now.alert =
+        if exception.message == exception.class.name.to_s
+          default_message
+        else
+          exception.message
+        end
+      render "nothing", status: code
+    end
+    def index
+      @resources = Step.load_resources(controls, params, action_inquirer)
+      @pagination = Step.initialize_pagination(@resources, request.GET)
+      @resources = Step.paginate_resources(@resources, @pagination)
+    end
+    def show
+      @resource = Step.load_resource(controls, params, action_inquirer)
+    end
+    def new
+      @resource = Step.build_resource(controls, action_inquirer)
+    end
+    def create
+      @resource = Step.build_resource_with_params(controls, action_inquirer, create_permitted_params)
+      if @resource.save
+        redirect_to polymorphic_path(Super.configuration.path_parts(@resource))
+      else
+        render :new, status: :bad_request
+      end
+    end
+    def edit
+      @resource = Step.load_resource(controls, params, action_inquirer)
+    end
+    def update
+      @resource = Step.load_resource(controls, params, action_inquirer)
+      if @resource.update(update_permitted_params)
+        redirect_to polymorphic_path(Super.configuration.path_parts(@resource))
+      else
+        render :edit, status: :bad_request
+      end
+    end
+    def destroy
+      @resource = Step.load_resource(controls, params, action_inquirer)
+      if @resource.destroy
+        redirect_to polymorphic_path(Super.configuration.path_parts(controls.model))
+      else
+        redirect_to polymorphic_path(Super.configuration.path_parts(@resource))
+      end
+    end
+    private
+    def controls
+      Super::Controls.new(new_controls)
+    end
+    def create_permitted_params
+      controls.permitted_params(params, action: action_inquirer)
+    end
+    def update_permitted_params
+      controls.permitted_params(params, action: action_inquirer)
+    end
+    def action_inquirer
+      @action_inquirer ||= ActionInquirer.new(
+        ActionInquirer.default_resources,
+        params[:action]
+      )
+    end
+  end
+end

data/app/helpers/super/application_helper.rb ADDED

@@ -0,0 +1,32 @@
+module Super
+  module ApplicationHelper
+    def super_resolve_list_for_rendering(partials, block = -> {})
+      block_result = block.call
+      if block_result.present?
+        partials = [block_result, *partials]
+      end
+      partials = partials.map do |partial|
+        if partial.is_a?(Symbol)
+          instance_variable_get(partial)
+        else
+          partial
+        end
+      end
+      partials.compact
+    end
+    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
+  end
+end

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

@@ -0,0 +1,39 @@
+<!DOCTYPE html>
+<html class="bg-gray-100">
+  <head>
+    <title><%= Super.configuration.title %></title>
+    <%= csrf_meta_tags %>
+    <% if respond_to?(:csp_meta_tag) -%>
+      <%= 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" %>
+    <% elsif Super.configuration.asset_handler.webpacker? %>
+      <%= stylesheet_pack_tag "super/application", media: "all" %>
+      <%= javascript_pack_tag "super/application" %>
+    <% 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>
+        <%
+        route_namespace = Super.configuration.route_namespace.map(&:to_s).join("/")
+        Super::Navigation::Automatic.new(route_namespace: route_namespace).each do |text, href| %>
+          <%= link_to(text, href, class: "inline-block mr-6") %>
+        <% end %>
+      </header>
+      <%= render "flash" %>
+      <div class="pt-4"></div>
+      <%= yield %>
+    </div>
+  </body>
+</html>

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

@@ -0,0 +1,17 @@
+<%
+  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 data-flash="anchor">
+  <% 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>

data/app/views/super/application/_form.html.erb ADDED

@@ -0,0 +1,17 @@
+<% schema = controls.form_schema(action: action_inquirer) %>
+<%= form_for(Super.configuration.path_parts(@resource)) do |f| %>
+  <div class="max-w-3xl">
+    <% schema.fields.each 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/_form_field__destroy.html.erb ADDED

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

@@ -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.svg" %>
+      </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 ADDED

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

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

@@ -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-target="apply-template.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 ADDED

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

@@ -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/_index.html.erb ADDED

@@ -0,0 +1,45 @@
+<% schema = controls.display_schema(action: action_inquirer) %>
+<div class="mt-4 -mx-5 overflow-x-auto">
+  <table class="w-full">
+    <thead>
+      <tr class="text-left text-sm uppercase font-bold tracking-wide">
+        <% schema.field_keys.each do |column| %>
+          <th class="p-2 first:pl-5"><%= column.to_s.humanize %></th>
+        <% end %>
+        <th class="p-2 pr-5">Actions</th>
+      </tr>
+    </thead>
+    <tbody class="border-gray-400 border-solid border-t-2">
+      <% @resources.each do |resource| %>
+        <tr id="resource-pk-<%= resource.id %>" class="border-b border-gray-400">
+          <% schema.field_keys.each do |column| %>
+            <td class="p-2 first:pl-5"><%= Super::Display.format(schema, resource, column) %></td>
+          <% end %>
+          <td class="p-2 pr-5" style="word-spacing: 0.25rem">
+            <% controls.resource_actions(resource, params: params, action: action_inquirer).each do |link| %>
+              <%= link_to(link.text, link.href, link.options) %>
+            <% end %>
+          </td>
+        </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 %>

data/app/views/super/application/_resource_header.html.erb ADDED

@@ -0,0 +1,16 @@
+<header class="flex justify-between content-end">
+  <h1 class="text-xl">
+    <%= 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(
+          class: "super-button super-button--border-blue super-button-sm inline-block ml-2"
+        )
+      ) %>
+    <% end %>
+  </div>
+</header>

data/app/views/super/application/_resources_header.html.erb ADDED

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

data/app/views/super/application/_show.html.erb ADDED

@@ -0,0 +1,10 @@
+<% schema = controls.display_schema(action: action_inquirer) %>
+<table class="max-w-full leading-loose mt-4">
+  <% schema.field_keys.each do |column| %>
+    <tr>
+      <th class="text-right px-4"><%= column.to_s.humanize %></th>
+      <td><%= Super::Display.format(schema, @resource, column) %></td>
+    </tr>
+  <% end %>
+</table>

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

@@ -0,0 +1,34 @@
+<%
+  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_headers.each do |partial| %>
+  <%= super_render_partialish(partial) %>
+<% end %>
+<% if super_layout_asides.empty? %>
+  <% super_layout_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_mains.each do |partial| %>
+        <%= super_render_partialish(partial) %>
+      <% end %>
+    </div>
+    <div class="md:float-right md:w-3/12 px-2">
+      <% super_layout_asides.each do |partial| %>
+        <%= super_render_partialish(partial) %>
+      <% end %>
+    </div>
+  </div>
+<% end %>
+<% super_layout_footers.each do |partial| %>
+  <%= super_render_partialish(partial) %>
+<% end %>