super 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8e7ba2e6b5845517d94684e487bdfed0779dcade517e3e3e89bff55fee6f258
-  data.tar.gz: 62e2a405ed8d99a95de077babfdc9eb3b654d651b1887e8776d1dba609058f8e
+  metadata.gz: 6c7f47bcff0941f86aa7bdb0fa79fec029120128728fdcff3c4b8944dae7bf91
+  data.tar.gz: 58e5532e0d911cbbe859be53912f86967b29e1d77b9d9b221744114b84d1a5be
 SHA512:
-  metadata.gz: 76bd34e08d34ea8797f0ed197b062a6be056247204a5f6badfea5a82f119c196d37b04a65ad2b1f25535885c013a1ebed7175399090078888cc528b997b57371
-  data.tar.gz: 5933d518932ea142b70aa5ac3c844d497a5bea951ee7bd72ad1a128fabc911212e2c09b63857900b2eec881a97f28aff5682b6e5c9457a25f2d0dba431887900
+  metadata.gz: 2dc95583d9a8926a105a48515c695b9546d61eb9a8043c22741759b40620c85038affecaee527fce0356e635a2a9ef4327ff33dc5772469dcbd75cc4cf90eddc
+  data.tar.gz: b9539c0e2b57adc6ea1c78398ea5240291de73b7922dd42d8f8049f822c08be24dab24652c475273990c9392f7a3a58e1f277ea41e9db322358dcf653141c221

data/CONTRIBUTING.md

@@ -0,0 +1,56 @@
+# Contributing
+
+Thank you for thinking about contributing to Super!
+
+
+## General guidelines
+
+There are a few ground rules that to adhere to:
+
+* be friendly and patient,
+* be welcoming,
+* be considerate,
+* be respectful,
+* be careful in the words that you choose and be kind to others,
+* when we disagree, try to understand why.
+
+This isn't an exhaustive list of things that you can't do. Rather, take it in
+the spirit in which it's intended - a guide to make it easier to communicate and
+participate in the community.
+
+This applies to all spaces managed by the Super project.
+
+If you believe someone is violating the code of conduct, we ask that you report
+it by emailing: super+conduct at zachahn.com
+
+Offenders may be banned, asked to apologize, etc.
+
+(These guidelines are based on the [FreeBSD CoC][FreeBSD CoC], which in turn is
+based on [LLVM Project's draft CoC][LLVM CoC], which in turn is based on the
+[Django Project Code of Conduct][Django CoC], which is in turn based on wording
+from the Speak Up! project.)
+
+
+## Bug reports / issues
+
+1. Please tell us what version of Super, Ruby, and Rails you are using
+1. Please search the issues before posting your problem
+1. Please ask questions in a public place to benefit all Super users
+1. Please email security-related problems to super+security [at] zachahn.com
+
+
+## Feature requests / pull requests
+
+Contributors will need to sign a CLA. This isn't set up yet, so I won't be able
+to accept contributions.
+
+1. Please note that pull requests may be closed/denied for any reason.
+   Your feature may be better as its own repository. If so, I will link to your
+   project from the README!
+1. Please allow Super's contributors to modify your PR before merging.
+   It might make the process a bit smoother, but this isn't a necessity.
+
+
+[FreeBSD CoC]: https://www.freebsd.org/internal/code-of-conduct.html
+[LLVM CoC]: https://llvm.org/docs/CodeOfConduct.html
+[Django CoC]: https://www.djangoproject.com/conduct/

data/README.md

@@ -1,5 +1,10 @@
 # Super
 
+![Unit tests status](https://github.com/zachahn/super/workflows/Unit%20tests/badge.svg?branch=master)
+[![Gem](https://img.shields.io/gem/v/super)][gem]
+[![Try the demo](https://img.shields.io/badge/try-demo-blue)][super_demo]
+
+
 Super is an admin framework for Ruby on Rails applications. Super helps you make
 powerful admin pages quickly so that you can concentrate on the parts of your
 app that make it great.
@@ -103,6 +108,7 @@ See [CONTRIBUTING](./CONTRIBUTING.md)
 The gem is available under the terms of the [GNU LGPLv3](./LICENSE).
 
 
+[gem]: https://rubygems.org/gems/super
 [Administrate]: https://github.com/thoughtbot/administrate
 [ActiveAdmin]: https://github.com/activeadmin/activeadmin
 [RailsAdmin]: https://github.com/sferik/rails_admin

data/STABILITY.md

@@ -0,0 +1,50 @@
+# Stability
+
+The table below shows the current progress towards API stability and the release
+of version 1.0.
+
+Note though that it is neither a comprehensive list nor a guarantee of
+stability.
+
+
+<table>
+<thead>
+<tr><th>Feature</th><th>Status</th></tr>
+</thead>
+<tbody>
+<tr><td>UI</td>                                             <td>❌</td></tr>
+<tr><td>Frontend JS</td>                                    <td>❌</td></tr>
+<tr><td><code>Super::ActionInquirer</code></td>             <td>✅</td></tr>
+<tr><td><code>Super::ApplicationController</code></td>      <td>✅</td></tr>
+<tr><td><code>Super::Assets</code></td>                     <td>🚧</td></tr>
+<tr><td><code>Super::ClientError</code></td>                <td>✅</td></tr>
+<tr><td><code>Super::Compatability</code></td>              <td>🙈</td></tr>
+<tr><td><code>Super::Configuration</code></td>              <td>❌</td></tr>
+<tr><td><code>Super::Controls::Optional</code></td>         <td>✅</td></tr>
+<tr><td><code>Super::Controls::Required</code></td>         <td>✅</td></tr>
+<tr><td><code>Super::Controls::Steps</code></td>            <td>🤔</td></tr>
+<tr><td><code>Super::Controls</code></td>                   <td>✅</td></tr>
+<tr><td><code>Super::Display</code></td>                    <td>🤔</td></tr>
+<tr><td><code>Super::Engine</code></td>                     <td>🙈</td></tr>
+<tr><td><code>Super::Error</code></td>                      <td>✅</td></tr>
+<tr><td><code>Super::Filter</code></td>                     <td>❌</td></tr>
+<tr><td><code>Super::Form</code></td>                       <td>🤔</td></tr>
+<tr><td><code>Super::Layout</code></td>                     <td>🤔</td></tr>
+<tr><td><code>Super::Link</code></td>                       <td>✅</td></tr>
+<tr><td><code>Super::Navigation</code></td>                 <td>🤔</td></tr>
+<tr><td><code>Super::Pagination</code></td>                 <td>🤔</td></tr>
+<tr><td><code>Super::Panel</code></td>                      <td>🤔</td></tr>
+<tr><td><code>Super::Partial</code></td>                    <td>🤔</td></tr>
+<tr><td><code>Super::Plugin</code></td>                     <td>✅</td></tr>
+<tr><td><code>Super::ViewHelper</code></td>                 <td>❌</td></tr>
+</tbody>
+</table>
+
+
+### Legend
+
+* ✅ Tentatively stable. Further changes will probably be additive
+* 🚧 Likely upcoming breaking changes
+* ❌ Planned upcoming breaking changes
+* 🤔 Undecided
+* 🙈 Private API

data/app/assets/javascripts/super/application.js

@@ -4399,21 +4399,26 @@ var __importDefault = this && this.__importDefault || function (mod) {
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.StimulusController = exports.StimulusApplication = void 0;
 
 var ujs_1 = __importDefault(require("@rails/ujs"));
 
 var stimulus_1 = require("stimulus");
 
+Object.defineProperty(exports, "StimulusController", {
+  enumerable: true,
+  get: function get() {
+    return stimulus_1.Controller;
+  }
+});
+
 var apply_template_controller_1 = __importDefault(require("./apply_template_controller"));
 
 var toggle_pending_destruction_controller_1 = __importDefault(require("./toggle_pending_destruction_controller"));
 
 ujs_1.default.start();
-var application = stimulus_1.Application.start();
-application.register("apply-template", apply_template_controller_1.default);
-application.register("toggle-pending-destruction", toggle_pending_destruction_controller_1.default);
-exports.default = {
-  StimulusApplication: application,
-  StimulusController: stimulus_1.Controller
-};
+var StimulusApplication = stimulus_1.Application.start();
+exports.StimulusApplication = StimulusApplication;
+StimulusApplication.register("apply-template", apply_template_controller_1.default);
+StimulusApplication.register("toggle-pending-destruction", toggle_pending_destruction_controller_1.default);
 },{"@rails/ujs":"../node_modules/@rails/ujs/lib/assets/compiled/rails-ujs.js","stimulus":"../node_modules/stimulus/index.js","./apply_template_controller":"javascripts/super/apply_template_controller.ts","./toggle_pending_destruction_controller":"javascripts/super/toggle_pending_destruction_controller.ts"}]},{},["javascripts/super/application.ts"], "Super")

data/app/controllers/super/application_controller.rb

@@ -78,7 +78,7 @@ module Super
     private
 
     def controls
-      Super::Controls.new(new_controls)
+      @controls ||= new_controls
     end
 
     def action_inquirer

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

@@ -9,12 +9,20 @@
 
     <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" %>
+    <% Super.configuration.stylesheets.each do |stylesheet| %>
+      <% if stylesheet.handler.sprockets? %>
+        <%= stylesheet_link_tag(stylesheet.path, **stylesheet.arguments) %>
+      <% elsif stylesheet.handler.webpacker? %>
+        <%= stylesheet_pack_tag(stylesheet.path, **stylesheet.arguments) %>
+      <% end %>
+    <% end %>
+
+    <% Super.configuration.javascripts.each do |javascript| %>
+      <% if javascript.handler.sprockets? %>
+        <%= javascript_include_tag(javascript.path) %>
+      <% elsif javascript.handler.webpacker? %>
+        <%= javascript_pack_tag(javascript.path) %>
+      <% end %>
     <% end %>
   </head>
 

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

@@ -1,4 +1,4 @@
-<% if super_panel.resolve(self, block_given? ? Proc.new : nil).resolved_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.resolved_parts.each do |partial| %>
       <%= Super::Partial.render(partial, template: self) %>

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

@@ -2,9 +2,9 @@
   <table class="w-full border-separate relative" cellspacing="0" cellpadding="0">
     <thead class="">
       <tr class="">
-        <% super_schema_display_index.field_keys.each do |column| %>
+        <% 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(column) %>
+            <%= controls.model.human_attribute_name(attribute_name) %>
           </th>
         <% end %>
       </tr>
@@ -12,9 +12,9 @@
     <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| %>
+          <% 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.schema_type.render_field(template: self, record: record, column: column) %>
+              <%= super_schema_display_index.render_field(template: self, record: record, column: attribute_name) %>
             </td>
           <% end %>
         </tr>

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

@@ -1,8 +1,8 @@
 <table class="max-w-full leading-loose mt-4">
-  <% super_schema_display_show.field_keys.each do |column| %>
+  <% super_schema_display_show.each_attribute_name do |attribute_name| %>
     <tr>
-      <th class="text-right px-4"><%= column.to_s.humanize %></th>
-      <td><%= super_schema_display_show.schema_type.render_field(template: self, record: @record, column: column) %></td>
+      <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

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

data/frontend/super-frontend/dist/application.js

@@ -4399,21 +4399,26 @@ var __importDefault = this && this.__importDefault || function (mod) {
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.StimulusController = exports.StimulusApplication = void 0;
 
 var ujs_1 = __importDefault(require("@rails/ujs"));
 
 var stimulus_1 = require("stimulus");
 
+Object.defineProperty(exports, "StimulusController", {
+  enumerable: true,
+  get: function get() {
+    return stimulus_1.Controller;
+  }
+});
+
 var apply_template_controller_1 = __importDefault(require("./apply_template_controller"));
 
 var toggle_pending_destruction_controller_1 = __importDefault(require("./toggle_pending_destruction_controller"));
 
 ujs_1.default.start();
-var application = stimulus_1.Application.start();
-application.register("apply-template", apply_template_controller_1.default);
-application.register("toggle-pending-destruction", toggle_pending_destruction_controller_1.default);
-exports.default = {
-  StimulusApplication: application,
-  StimulusController: stimulus_1.Controller
-};
+var StimulusApplication = stimulus_1.Application.start();
+exports.StimulusApplication = StimulusApplication;
+StimulusApplication.register("apply-template", apply_template_controller_1.default);
+StimulusApplication.register("toggle-pending-destruction", toggle_pending_destruction_controller_1.default);
 },{"@rails/ujs":"../node_modules/@rails/ujs/lib/assets/compiled/rails-ujs.js","stimulus":"../node_modules/stimulus/index.js","./apply_template_controller":"javascripts/super/apply_template_controller.ts","./toggle_pending_destruction_controller":"javascripts/super/toggle_pending_destruction_controller.ts"}]},{},["javascripts/super/application.ts"], "Super")

data/frontend/super-frontend/src/javascripts/super/application.ts

@@ -1,18 +1,15 @@
 import RailsUjs from "@rails/ujs";
-import { Application, Controller } from "stimulus";
+import { Application, Controller as StimulusController } from "stimulus";
 import ApplyTemplateController from "./apply_template_controller";
 import TogglePendingDestructionController from "./toggle_pending_destruction_controller";
 
 RailsUjs.start();
 
-const application = Application.start();
-application.register("apply-template", ApplyTemplateController);
-application.register(
+let StimulusApplication = Application.start();
+StimulusApplication.register("apply-template", ApplyTemplateController);
+StimulusApplication.register(
   "toggle-pending-destruction",
   TogglePendingDestructionController
 );
 
-export default {
-  StimulusApplication: application,
-  StimulusController: Controller,
-};
+export { StimulusApplication, StimulusController };

data/lib/generators/super/resource/templates/resources_controller.rb.tt

@@ -6,40 +6,10 @@ class <%= class_name.pluralize %>Controller < <%= parent_controller_name %>
     Controls.new
   end
 
-  class Controls
-    def title
-      <%= class_name %>.name.pluralize
-    end
-
+  class Controls < Super::Controls
     def model
       <%= class_name %>
     end
-
-    def scope(action:)
-      if action.read?
-        <%= class_name %>.all
-      else
-        <%= class_name %>.all
-      end
-    end
-
-    def permitted_params(params, action:)
-      if action.create?
-        params.require(:<%= file_name %>).permit()
-      else
-        params.require(:<%= file_name %>).permit()
-      end
-    end
-
-    def display_schema(action:)
-      Super::Schema.new(Super::Display::SchemaTypes.new) do |fields, type|
-      end
-    end
-
-    def form_schema(action:)
-      Super::Schema.new(Super::Form::SchemaTypes.new) do |fields, type|
-      end
-    end
   end
 end
 <% end -%>

data/lib/generators/super/webpacker/webpacker_generator.rb

@@ -12,14 +12,15 @@ module Super
     def set_asset_handler_to_webpacker
       insert_into_file(
         "config/initializers/super.rb",
-        "  c.asset_handler = Super::Assets.webpacker\n",
+        "  c.javascripts = Super::Assets.use_webpacker(c.javascripts)\n" \
+        "  c.stylesheets = Super::Assets.use_webpacker(c.stylesheets)\n",
         before: /\bend\b/
       )
     end
 
     def remind_about_erb
       say "Make sure ERB is set up for Webpacker!", :bold
-      say "Run if needed: rails webpacker:install:erb", :bold
+      say "Run if needed: bundle exec rails webpacker:install:erb"
     end
   end
 end

data/lib/super.rb

@@ -2,19 +2,29 @@ require "tsort"
 
 require "rails/engine"
 
+require "super/schema/common"
+
 require "super/action_inquirer"
 require "super/assets"
 require "super/client_error"
 require "super/compatibility"
 require "super/configuration"
 require "super/controls"
+require "super/display"
+require "super/display/guesser"
 require "super/display/schema_types"
 require "super/error"
 require "super/filter"
+require "super/filter/form_object"
+require "super/filter/guesser"
 require "super/filter/operator"
+require "super/filter/plugin"
 require "super/filter/schema_types"
 require "super/form"
+require "super/form/builder"
+require "super/form/guesser"
 require "super/form/schema_types"
+require "super/form/strong_params"
 require "super/layout"
 require "super/link"
 require "super/navigation/automatic"
@@ -23,6 +33,7 @@ require "super/panel"
 require "super/partial"
 require "super/plugin"
 require "super/schema"
+require "super/schema/guesser"
 require "super/version"
 require "super/view_helper"
 

data/lib/super/assets.rb

@@ -1,8 +1,64 @@
 module Super
   # Utilities for determining whether to use Sprockets or Webpacker
   class Assets
-    def self.sprockets_available?
-      Gem::Dependency.new("sprockets").matching_specs.any?
+    def self.webpacker(path, **arguments)
+      Asset.new(handler: Handler.webpacker, path: path, arguments: arguments)
+    end
+
+    def self.sprockets(path, **arguments)
+      Asset.new(handler: Handler.sprockets, path: path, arguments: arguments)
+    end
+
+    def self.auto(path, **arguments)
+      Asset.new(handler: Handler.auto, path: path, arguments: arguments)
+    end
+
+    def self.use_webpacker(assets, grep: nil)
+      assets = [assets] if !assets.kind_of?(Array)
+
+      assets.map do |asset|
+        grep_matches = grep && asset === grep
+        if grep_matches || !grep
+          asset.instance_variable_set(:@handler, Handler.webpacker)
+        end
+
+        asset
+      end
+    end
+
+    def self.use_sprockets(assets, grep: nil)
+      assets = [assets] if !assets.kind_of?(Array)
+
+      assets.map do |asset|
+        grep_matches = grep && asset === grep
+        if grep_matches || !grep
+          asset.instance_variable_set(:@asset_handler, Handler.sprockets)
+        end
+
+        asset
+      end
+    end
+
+    class Asset
+      def initialize(handler:, path:, arguments:)
+        @handler = handler
+        @path = path
+        @arguments = arguments
+      end
+
+      attr_reader :handler
+      attr_reader :path
+      attr_reader :arguments
+
+      def ===(other)
+        return true if path == other
+        return true if other.is_a?(Regexp) && path.match?(other)
+        return true if handler == other
+        return true if handler.to_sym == other
+        return true if handler.to_s == other
+
+        false
+      end
     end
 
     def self.dist(gem_name, package_name)
@@ -15,49 +71,63 @@ module Super
       gem_path.join("frontend", package_name, "dist")
     end
 
-    def self.auto
-      @auto ||=
-        if Gem::Dependency.new("sprockets", "~> 4.0").matching_specs.any?
-          sprockets
-        elsif Gem::Dependency.new("sprockets", "~> 3.0").matching_specs.any?
-          sprockets
-        elsif Gem::Dependency.new("sprockets", "~> 2.0").matching_specs.any?
-          sprockets
-        elsif Gem::Dependency.new("webpacker", "~> 4.0").matching_specs.any?
-          webpacker
-        elsif Gem::Dependency.new("webpacker", "~> 3.0").matching_specs.any?
-          webpacker
-        else
-          none
-        end
-    end
+    class Handler
+      def self.auto
+        @auto ||=
+          if Gem::Dependency.new("sprockets", "~> 4.0").matching_specs.any?
+            sprockets
+          elsif Gem::Dependency.new("sprockets", "~> 3.0").matching_specs.any?
+            sprockets
+          elsif Gem::Dependency.new("sprockets", "~> 2.0").matching_specs.any?
+            sprockets
+          elsif Gem::Dependency.new("webpacker", "~> 4.0").matching_specs.any?
+            webpacker
+          elsif Gem::Dependency.new("webpacker", "~> 3.0").matching_specs.any?
+            webpacker
+          else
+            none
+          end
+      end
 
-    def self.sprockets
-      new(:sprockets)
-    end
+      def self.sprockets_available?
+        Gem::Dependency.new("sprockets").matching_specs.any? && defined?(Sprockets)
+      end
 
-    def self.webpacker
-      new(:webpacker)
-    end
+      def self.sprockets
+        @sprockets ||= new(:sprockets)
+      end
 
-    def self.none
-      new(:none)
-    end
+      def self.webpacker
+        @webpacker ||= new(:webpacker)
+      end
 
-    def initialize(asset_handler)
-      @asset_handler = asset_handler
-    end
+      def self.none
+        @none ||= new(:none)
+      end
 
-    def sprockets?
-      @asset_handler == :sprockets
-    end
+      def initialize(asset_handler)
+        @asset_handler = asset_handler
+      end
 
-    def webpacker?
-      @asset_handler == :webpacker
-    end
+      def sprockets?
+        @asset_handler == :sprockets
+      end
+
+      def webpacker?
+        @asset_handler == :webpacker
+      end
+
+      def none?
+        @asset_handler == :none
+      end
+
+      def to_sym
+        @asset_handler
+      end
 
-    def none?
-      @asset_handler == :none
+      def to_s
+        @asset_handler.to_s
+      end
     end
   end
 end