super 0.0.11 → 0.0.16

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 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,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.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require "super/controls/optional"
-require "super/controls/required"
-require "super/controls/steps"
-require "super/controls/view"
-
-module Super
-  # The base Controls class. Most parts of Super can be configured by
-  # customizing its methods.
-  class Controls
-    include Required
-    include Optional
-    include Steps
-    include View
-  end
-end

data/lib/super/controls/optional.rb

@@ -1,112 +0,0 @@
-# frozen_string_literal: true
-
-module Super
-  class Controls
-    # Methods for `Controls` that have a sane default implementation
-    module Optional
-      # This is an optional method
-      #
-      # @return [String]
-      def title
-        model.name.pluralize
-      end
-
-      # Configures what database records are visible on load. This is an optional
-      # method, it defaults to "`all`" methods
-      #
-      # @param action [ActionInquirer]
-      # @return [ActiveRecord::Relation]
-      def scope(action:)
-        model.all
-      end
-
-      # Configures the fields that are displayed on the index and show actions.
-      # This is a required method
-      #
-      # @param action [ActionInquirer]
-      # @return [Display]
-      def display_schema(action:)
-        Display.new do |fields, type|
-          Display::Guesser.new(model: model, action: action, fields: fields, type: type).call
-        end
-      end
-
-      # Configures the editable fields on the new and edit actions. This is a
-      # required method
-      #
-      # @param action [ActionInquirer]
-      # @return [Form]
-      def form_schema(action:)
-        Form.new do |fields, type|
-          Form::Guesser.new(model: model, fields: fields, type: type).call
-        end
-      end
-
-      # Configures which parameters could be written to the database. This is a
-      # required method
-      #
-      # @param params [ActionController::Parameters]
-      # @param action [ActionInquirer]
-      # @return [ActionController::Parameters]
-      def permitted_params(params, action:)
-        strong_params = Super::Form::StrongParams.new(form_schema(action: action))
-        params.require(strong_params.require(model)).permit(strong_params.permit)
-      end
-
-      # Configures the actions linked to on the index page. This is an optional
-      # method
-      #
-      # @param action [ActionInquirer]
-      # @return [Array<Link>]
-      def collection_actions(action:)
-        Super::Link.find_all(:new)
-      end
-
-      # Configures the actions linked to on the show page as well as each row of
-      # the table on the index page. This is an optional method
-      #
-      # @param action [ActionInquirer]
-      # @return [Array<Link>]
-      def member_actions(action:)
-        if action.show?
-          Super::Link.find_all(:edit, :destroy)
-        elsif action.edit?
-          Super::Link.find_all(:show, :destroy)
-        else
-          Super::Link.find_all(:show, :edit, :destroy)
-        end
-      end
-
-      def filters_enabled?
-        true
-      end
-
-      def filter_schema
-        Super::Filter.new do |fields, type|
-          Super::Filter::Guesser.new(model: model, fields: fields, type: type).call
-        end
-      end
-
-      def sort_enabled?
-        true
-      end
-
-      def sortable_columns
-        action = ActionInquirer.new(
-          ActionInquirer.default_for_resources,
-          "index"
-        )
-        attribute_names =
-          display_schema(action: action).each_attribute.map do |key, val|
-            key if val.real?
-          end
-
-        attribute_names.compact
-      end
-
-      def default_sort
-        { id: :desc }
-      end
-    end
-  end
-end

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