super 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c7f47bcff0941f86aa7bdb0fa79fec029120128728fdcff3c4b8944dae7bf91
-  data.tar.gz: 58e5532e0d911cbbe859be53912f86967b29e1d77b9d9b221744114b84d1a5be
+  metadata.gz: 7b01ea90f28d8e14b5a5f4bd454e2a15676b9c95623200a17d1a2ed2fb71d87f
+  data.tar.gz: 753365f90dcc880f4249ab60d9eea04034189fd221ecb03d500a8fc78f02a7a9
 SHA512:
-  metadata.gz: 2dc95583d9a8926a105a48515c695b9546d61eb9a8043c22741759b40620c85038affecaee527fce0356e635a2a9ef4327ff33dc5772469dcbd75cc4cf90eddc
-  data.tar.gz: b9539c0e2b57adc6ea1c78398ea5240291de73b7922dd42d8f8049f822c08be24dab24652c475273990c9392f7a3a58e1f277ea41e9db322358dcf653141c221
+  metadata.gz: ec08f45761eefc5645daa6f4976b9b3844fba97c04b81ddbee3217dfd6392666c30eabb7e7a2eca0516f2dad861b4f8a5f85ac8ac36ed583baa6dcb38d7fb4f2
+  data.tar.gz: ed215af314d49cc4454ba98cb8fd84d351ca32808de1eceaa4c079b2199f18bfbd6ebfc1aa8d388738012868b764482741d933e1e232ac1cf30bf02f3effe26f

data/.yardopts

@@ -6,6 +6,8 @@ CONTRIBUTING.md
 STABILITY.md
 LICENSE
 docs/quick_start.md
+docs/installation.md
 docs/webpacker.md
+docs/action_text.md
 docs/cheat.md
 docs/faq.md

data/README.md

@@ -2,7 +2,7 @@
 
 ![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]
+[![Try the demo](https://img.shields.io/badge/try-demo-blue)][demo]
 
 
 Super is an admin framework for Ruby on Rails applications. Super helps you make
@@ -11,91 +11,82 @@ app that make it great.
 
 Super strives to let engineers build great admin pages quickly and easily by:
 
-* Providing a useful CRUD interface
-* Relying on Rails' built in features whenever possible
-* Preferring plain Ruby objects rather than requiring DSLs
-* Supporting a wide range of Ruby and Rails versions
-* Having zero dependencies
+* Providing a configurable CRUD interface with usable defaults
+* Building on top of standard Rails controllers and ERB views
+* Preferring plain Ruby objects and initializers instead of DSLs
 
 
-Super has no dependencies. That means when you install Super, only Super gets
-added to your `Gemfile.lock`. This leads to many benefits:
+Super's distinguishing feature is that it's easy to maintain in your
+application. It does this by:
 
-* Super doesn't require common Rails libraries like [Kaminari][Kaminari],
-  [Devise][Devise], or [Sass][Sass], so it'll never conflict with the libraries
-  you have installed. If you want to upgrade Super, you won't have to upgrade
-  any of your other gems. And if you want to upgrade your other gems, you won't
-  have to upgrade Super! This will greatly reduce your maintenance burden since
-  your admin framework won't dictate which libraries and which versions your
-  application uses.
-* All code has the possibility of bugs and security issues, whether they're
-  written by you or by others. Having fewer dependencies can reduce the risk of
-  introducing problems into your application.
+* Supporting a wide range of Ruby (2.3–3.0+) and Rails (5.0–6.1+) versions,
+  which makes it easy to upgrade your Ruby and Rails versions without breaking
+  your admin pages
+* Having zero dependencies, so that you can upgrade your app's dependencies
+  without affecting your admin pages (or upgrade your admin pages without
+  worrying it might break your app)
+
+
+Note: There may be lots of breaking changes since Super is still fairly young.
+See the [stability doc](./STABILITY.md) for an idea of what might be changed.
 
 
 ## Features
 
-* Sprockets and Webpacker compatibility
-    * Note: Webpacker support depends on one additional NPM package for parsing
-      ERB
-* Configurable forms (new and edit forms)
-    * Nested associations are supported out of the box
+* Responsive and mobile-friendly
+* Compatible with Sprockets and Webpacker
+* Configurable forms
+    * Supports nested attributes `accepts_nested_attributes_for`
 * Configurable display (index and show tables)
+* Advanced filtering for ActiveRecord
 * Pre-built frontend assets (doesn't require Sass, PostCSS, Babel, etc)
     * Vendored assets include
         * Stimulus JS
-        * Rails UJS
         * Tailwind CSS
+        * Rails UJS
 * Supports Rails 5.0+, Ruby 2.3+
 
 
-## Super doesn't fit my needs. What should I look at?
+See the [demo][demo] and its [source][demo_source] for an example of some of its
+features.
+
+
+## Installation and Usage
 
-There are lots of Rails admin frameworks. I've personally used
-[ActiveAdmin][ActiveAdmin] and [Administrate][Administrate], and I had some
-brief exposure to [RailsAdmin][RailsAdmin].
+See [Installation](./docs/quick_start.md) and
+[Quick start](./docs/quick_start.md)
 
-If you need a ton of features, I'd probably suggest looking at ActiveAdmin. It
-relies pretty heavily on DSLs but is pretty flexible and popular.
 
-I like Administrate as well. I found that it doesn't have quite as many features
-as ActiveAdmin, but it's nice and feels like developing a normal Rails app.
-There's no DSL.
+## Editions
 
+There are several editions to consider.
 
-## Paid editions
+**Super FOSS** provides:
 
-If you have additional requirements, there are some paid editions to consider:
+* A great admin framework that's free and easy to maintain
+* Community support, see the [discussion forum][discussions]
 
-**Super Premium** provides:
+**Super Premium** (not available yet) provides:
 
-* Priority email support
+* Private email support
 * Ensuring long term development of Super
 
-**Super Professional** provides everything in Premium and:
+**Super Professional** (not available yet) provides everything in Premium and:
 
 * Productivity improvements and quality of life features for admins
 * An LGPL exemption
 
-They aren't available yet. Contact me if you're interested, or subscribe to the
-[newsletter][newsletter] to be notified of its availability and for brief,
-occasional updates to Super.
-
-
-## Demos
-
-* [Super Demo][super_demo]
-    * [Super Demo source][super_demo_source]
-
-
-## Installation and Usage
+Subscribe to the [newsletter][newsletter] to be notified of their availabilities
+and for brief, quarterly-at-most updates to Super.
 
-See [Quick start](./docs/quick_start.md)
 
+## Super doesn't fit my needs. What are some alternatives?
 
-## Path to 1.0
+[ActiveAdmin](https://github.com/activeadmin/activeadmin) is great if you need
+lots of features. It relies heavily on DSLs but is flexible and popular.
 
-See [STABILITY](./STABILITY.md)
+[Administrate](https://github.com/thoughtbot/administrate) doesn't have as many
+features as ActiveAdmin, but it feels like developing a normal Rails app.
 
 
 ## Contributing
@@ -109,12 +100,7 @@ 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
-[Kaminari]: https://github.com/kaminari/kaminari
-[Devise]: https://github.com/heartcombo/devise
-[Sass]: https://github.com/sass/sassc-ruby
+[discussions]: https://github.com/zachahn/super/discussions
 [newsletter]: https://tinyletter.com/zachahn
-[super_demo]: https://demo-super.herokuapp.com/admin/members
-[super_demo_source]: https://github.com/zachahn/super_demo
+[demo]: https://demo-super.herokuapp.com/admin/members
+[demo_source]: https://github.com/zachahn/super_demo

data/STABILITY.md

@@ -19,10 +19,10 @@ stability.
 <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::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::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>

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

@@ -4271,154 +4271,158 @@ Object.keys(_core).forEach(function (key) {
     }
   });
 });
-},{"@stimulus/core":"../node_modules/@stimulus/core/dist/index.js"}],"javascripts/super/apply_template_controller.ts":[function(require,module,exports) {
+},{"@stimulus/core":"../node_modules/@stimulus/core/dist/index.js"}],"javascripts/super/apply_template_controller.js":[function(require,module,exports) {
 "use strict";
 
-var __extends = this && this.__extends || function () {
-  var _extendStatics = function extendStatics(d, b) {
-    _extendStatics = Object.setPrototypeOf || {
-      __proto__: []
-    } instanceof Array && function (d, b) {
-      d.__proto__ = b;
-    } || function (d, b) {
-      for (var p in b) {
-        if (b.hasOwnProperty(p)) d[p] = b[p];
-      }
-    };
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
 
-    return _extendStatics(d, b);
-  };
+var _stimulus = require("stimulus");
 
-  return function (d, b) {
-    _extendStatics(d, b);
+function _typeof(obj) { "@babel/helpers - typeof"; if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }
 
-    function __() {
-      this.constructor = d;
-    }
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
 
-    d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-  };
-}();
+function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
 
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
+function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }
 
-var stimulus_1 = require("stimulus");
+function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); if (superClass) _setPrototypeOf(subClass, superClass); }
 
-var default_1 =
-/** @class */
-function (_super) {
-  __extends(default_1, _super);
+function _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf || function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); }
 
-  function default_1() {
-    return _super !== null && _super.apply(this, arguments) || this;
-  }
+function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(this, result); }; }
 
-  default_1.prototype.call = function (event) {
-    event.preventDefault();
-    var unixtime = new Date().getTime();
-    var content = this.templateTarget.innerHTML.replace(/TEMPLATEINDEX/g, unixtime.toString());
-    this.templateTarget.insertAdjacentHTML("beforebegin", content);
-  };
+function _possibleConstructorReturn(self, call) { if (call && (_typeof(call) === "object" || typeof call === "function")) { return call; } return _assertThisInitialized(self); }
 
-  default_1.targets = ["template"];
-  return default_1;
-}(stimulus_1.Controller);
+function _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); } return self; }
 
-exports.default = default_1;
-},{"stimulus":"../node_modules/stimulus/index.js"}],"javascripts/super/toggle_pending_destruction_controller.ts":[function(require,module,exports) {
-"use strict";
+function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Date.prototype.toString.call(Reflect.construct(Date, [], function () {})); return true; } catch (e) { return false; } }
 
-var __extends = this && this.__extends || function () {
-  var _extendStatics = function extendStatics(d, b) {
-    _extendStatics = Object.setPrototypeOf || {
-      __proto__: []
-    } instanceof Array && function (d, b) {
-      d.__proto__ = b;
-    } || function (d, b) {
-      for (var p in b) {
-        if (b.hasOwnProperty(p)) d[p] = b[p];
-      }
-    };
+function _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); }
 
-    return _extendStatics(d, b);
-  };
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 
-  return function (d, b) {
-    _extendStatics(d, b);
+var _default = /*#__PURE__*/function (_Controller) {
+  _inherits(_default, _Controller);
 
-    function __() {
-      this.constructor = d;
+  var _super = _createSuper(_default);
+
+  function _default() {
+    _classCallCheck(this, _default);
+
+    return _super.apply(this, arguments);
+  }
+
+  _createClass(_default, [{
+    key: "call",
+    value: function call(event) {
+      event.preventDefault();
+      var unixtime = new Date().getTime();
+      var content = this.templateTarget.innerHTML.replace(/TEMPLATEINDEX/g, unixtime.toString());
+      this.templateTarget.insertAdjacentHTML("beforebegin", content);
     }
+  }]);
 
-    d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-  };
-}();
+  return _default;
+}(_stimulus.Controller);
+
+exports.default = _default;
+
+_defineProperty(_default, "targets", ["template"]);
+},{"stimulus":"../node_modules/stimulus/index.js"}],"javascripts/super/toggle_pending_destruction_controller.js":[function(require,module,exports) {
+"use strict";
 
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.default = void 0;
 
-var stimulus_1 = require("stimulus");
+var _stimulus = require("stimulus");
 
-var default_1 =
-/** @class */
-function (_super) {
-  __extends(default_1, _super);
+function _typeof(obj) { "@babel/helpers - typeof"; if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }
+
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+
+function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
+
+function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }
+
+function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); if (superClass) _setPrototypeOf(subClass, superClass); }
+
+function _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf || function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); }
+
+function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(this, result); }; }
+
+function _possibleConstructorReturn(self, call) { if (call && (_typeof(call) === "object" || typeof call === "function")) { return call; } return _assertThisInitialized(self); }
+
+function _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); } return self; }
+
+function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Date.prototype.toString.call(Reflect.construct(Date, [], function () {})); return true; } catch (e) { return false; } }
+
+function _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); }
+
+var _default = /*#__PURE__*/function (_Controller) {
+  _inherits(_default, _Controller);
 
-  function default_1() {
-    return _super !== null && _super.apply(this, arguments) || this;
+  var _super = _createSuper(_default);
+
+  function _default() {
+    _classCallCheck(this, _default);
+
+    return _super.apply(this, arguments);
   }
 
-  default_1.prototype.call = function (event) {
-    var target = event.target;
+  _createClass(_default, [{
+    key: "call",
+    value: function call(event) {
+      var target = event.target;
 
-    if (target) {
-      if (target.checked) {
-        this.element.classList.add("opacity-75", "bg-gray-100");
-      } else {
-        this.element.classList.remove("opacity-75", "bg-gray-100");
+      if (target) {
+        if (target.checked) {
+          this.element.classList.add("opacity-75", "bg-gray-100");
+        } else {
+          this.element.classList.remove("opacity-75", "bg-gray-100");
+        }
       }
     }
-  };
+  }]);
 
-  return default_1;
-}(stimulus_1.Controller);
+  return _default;
+}(_stimulus.Controller);
 
-exports.default = default_1;
-},{"stimulus":"../node_modules/stimulus/index.js"}],"javascripts/super/application.ts":[function(require,module,exports) {
+exports.default = _default;
+},{"stimulus":"../node_modules/stimulus/index.js"}],"javascripts/super/application.js":[function(require,module,exports) {
 "use strict";
 
-var __importDefault = this && this.__importDefault || function (mod) {
-  return mod && mod.__esModule ? mod : {
-    "default": 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;
+  get: function () {
+    return _stimulus.Controller;
   }
 });
+exports.StimulusApplication = void 0;
+
+var _ujs = _interopRequireDefault(require("@rails/ujs"));
+
+var _stimulus = require("stimulus");
+
+var _apply_template_controller = _interopRequireDefault(require("./apply_template_controller"));
+
+var _toggle_pending_destruction_controller = _interopRequireDefault(require("./toggle_pending_destruction_controller"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-var apply_template_controller_1 = __importDefault(require("./apply_template_controller"));
+_ujs.default.start();
 
-var toggle_pending_destruction_controller_1 = __importDefault(require("./toggle_pending_destruction_controller"));
+var StimulusApplication = _stimulus.Application.start();
 
-ujs_1.default.start();
-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")
+StimulusApplication.register("apply-template", _apply_template_controller.default);
+StimulusApplication.register("toggle-pending-destruction", _toggle_pending_destruction_controller.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.js","./toggle_pending_destruction_controller":"javascripts/super/toggle_pending_destruction_controller.js"}]},{},["javascripts/super/application.js"], "Super")