super 0.0.10 → 0.0.15

data/CONTRIBUTING.md

@@ -1,56 +0,0 @@
-# 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/Rakefile

@@ -1,34 +0,0 @@
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
-
-require 'rdoc/task'
-
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Super'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.md')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-require_relative "dummy_path"
-
-APP_RAKEFILE = File.expand_path("#{SUPER_DUMMY_PATH}/Rakefile", __dir__)
-load 'rails/tasks/engine.rake'
-
-load 'rails/tasks/statistics.rake'
-
-require 'bundler/gem_tasks'
-
-require 'rake/testtask'
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
-end
-
-task default: :test

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/_form_field_checkbox.html.erb

@@ -1 +0,0 @@
-<%= form.super.check_box!(column) %>

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

@@ -1 +0,0 @@
-<%= form.super.rich_text_area!(column) %>

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

@@ -1 +0,0 @@
-<%= form.super.text_field!(column) %>

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/app/views/super/feather/_chevron_down.html

@@ -1 +0,0 @@
-<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-chevron-down"><polyline points="6 9 12 15 18 9"></polyline></svg>

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(action: action) do |fields, type|
-      fields[:title] = type.text
-      fields[:content] = type.rich_text
-    end
-  end
-end
-```

data/docs/cheat.md

@@ -1,41 +0,0 @@
-<!--
-# @title Cheat sheet
--->
-
-# Cheat sheet
-
-## Controls
-
-You can configure most of your admin page's behavior by editing Controls.
-They only work with ActiveRecord 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
-
-
-### 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`
-* **`#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
-* **`#permitted_params(params, action:)`**
-  The strong parameters definition

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,41 +0,0 @@
-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,13 +0,0 @@
-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