super 0.0.11 → 0.0.12

data/lib/super/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Super
-  VERSION = "0.0.11"
+  VERSION = "0.0.12"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: super
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.0.12
 platform: ruby
 authors:
 - Zach Ahn
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-03 00:00:00.000000000 Z
+date: 2021-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -224,7 +224,6 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- STABILITY.md
 - app/assets/config/super_manifest.js
 - app/assets/javascripts/super/application.js
 - app/assets/stylesheets/super/application.css
@@ -232,12 +231,16 @@ files:
 - app/helpers/super/form_builder_helper.rb
 - app/views/layouts/super/application.html.erb
 - app/views/super/application/_collection_header.html.erb
+- app/views/super/application/_display_actions.html.erb
+- app/views/super/application/_display_index.html.erb
 - app/views/super/application/_display_rich_text.html.erb
+- app/views/super/application/_display_show.html.erb
 - app/views/super/application/_filter.html.erb
 - app/views/super/application/_filter_type_select.html.erb
 - app/views/super/application/_filter_type_text.html.erb
 - app/views/super/application/_filter_type_timestamp.html.erb
 - app/views/super/application/_flash.html.erb
+- app/views/super/application/_form.html.erb
 - app/views/super/application/_form_field__destroy.html.erb
 - app/views/super/application/_form_field_checkbox.html.erb
 - app/views/super/application/_form_field_rich_text_area.html.erb
@@ -246,17 +249,13 @@ files:
 - app/views/super/application/_form_fieldset.html.erb
 - app/views/super/application/_form_has_many.html.erb
 - app/views/super/application/_form_has_one.html.erb
+- app/views/super/application/_layout.html.erb
 - app/views/super/application/_member_header.html.erb
+- app/views/super/application/_pagination.html.erb
+- app/views/super/application/_panel.html.erb
 - app/views/super/application/_query.html.erb
 - app/views/super/application/_sort.html.erb
 - app/views/super/application/_sort_expression.html.erb
-- app/views/super/application/_super_layout.html.erb
-- app/views/super/application/_super_pagination.html.erb
-- app/views/super/application/_super_panel.html.erb
-- app/views/super/application/_super_schema_display_actions.html.erb
-- app/views/super/application/_super_schema_display_index.html.erb
-- app/views/super/application/_super_schema_display_show.html.erb
-- app/views/super/application/_super_schema_form.html.erb
 - app/views/super/application/edit.html.erb
 - app/views/super/application/index.html.erb
 - app/views/super/application/new.html.erb
@@ -267,14 +266,7 @@ files:
 - app/views/super/feather/_x.html
 - config/locales/en.yml
 - config/routes.rb
-- docs/README.md
-- docs/action_text.md
 - docs/cheat.md
-- docs/faq.md
-- docs/installation.md
-- docs/quick_start.md
-- docs/webpacker.md
-- docs/yard_customizations.rb
 - frontend/super-frontend/dist/application.css
 - frontend/super-frontend/dist/application.js
 - lib/generators/super/action_text/USAGE
@@ -299,7 +291,6 @@ files:
 - lib/super/configuration.rb
 - lib/super/controls.rb
 - lib/super/controls/optional.rb
-- lib/super/controls/required.rb
 - lib/super/controls/steps.rb
 - lib/super/controls/view.rb
 - lib/super/display.rb
@@ -331,12 +322,19 @@ files:
 - lib/super/schema/common.rb
 - lib/super/schema/guesser.rb
 - lib/super/sort.rb
+- lib/super/useful/builder.rb
+- lib/super/useful/enum.rb
 - lib/super/version.rb
 - lib/super/view_helper.rb
 homepage:
 licenses:
 - LGPL-3.0-only
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/zachahn/super/issues
+  changelog_uri: https://github.com/zachahn/super/blob/main/CHANGELOG.md
+  documentation_uri: https://superadministration.github.io/
+  homepage_uri: https://github.com/zachahn/super
+  source_code_uri: https://github.com/zachahn/super
 post_install_message:
 rdoc_options: []
 require_paths:

data/STABILITY.md

@@ -1,50 +0,0 @@
-# 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/views/super/application/_super_schema_display_show.html.erb

@@ -1,8 +0,0 @@
-<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/docs/README.md

@@ -1,8 +0,0 @@
-# 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

@@ -1,48 +0,0 @@
-<!--
-# @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 do |fields, type|
-      fields[:title] = type.text
-      fields[:content] = type.rich_text
-    end
-  end
-end
-```

data/docs/faq.md

@@ -1,44 +0,0 @@
-<!--
-# @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

@@ -1,21 +0,0 @@
-<!--
-# @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

@@ -1,30 +0,0 @@
-<!--
-# @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

@@ -1,25 +0,0 @@
-<!--
-# @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
-```

data/docs/yard_customizations.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-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/lib/super/controls/required.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module Super
-  class Controls
-    # Methods for `Controls` that must be defined for Super to work properly
-    module Required
-      # Specifies the model. This is a required method
-      #
-      # @return [ActiveRecord::Base]
-      def model
-        raise NotImplementedError
-      end
-    end
-  end
-end