super 0.0.12 → 0.17.0

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,36 +0,0 @@
-# frozen_string_literal: true
-
-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/app/views/super/application/_filter_type_select.html.erb

@@ -1,21 +0,0 @@
-<div class="super-field-group" data-controller="clean-filter-param">
-  <%= form.fields_for(filter_type_select.field_name, filter_type_select) do |form_field| %>
-    <%= form_field.label(:q, filter_type_select.humanized_field_name) %>
-    <div class="relative inline-block">
-      <%= form_field.super.select(
-        :op,
-        filter_type_select.operators,
-        { include_blank: false },
-        data: { clean_filter_param_target: "candidate" }
-      ) %>
-    </div>
-    <div class="mt-3">
-      <%= form_field.super.select(
-        :q,
-        filter_type_select.field_type.collection,
-        {},
-        data: { clean_filter_param_target: "control candidate" }
-      ) %>
-    </div>
-  <% end %>
-</div>

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

@@ -1,18 +0,0 @@
-<div class="super-field-group" data-controller="clean-filter-param">
-  <%= form.fields_for(filter_type_text.field_name, filter_type_text) do |form_field| %>
-    <%= form_field.label(:q, filter_type_text.humanized_field_name) %>
-    <div class="relative inline-block">
-      <%= form_field.super.select(
-        :op,
-        filter_type_text.operators,
-        { include_blank: false },
-        data: { clean_filter_param_target: "candidate" }
-      ) %>
-    </div>
-    <%= form_field.super.text_field(
-      :q,
-      class: "mt-3",
-      data: { clean_filter_param_target: "control candidate" }
-    ) %>
-  <% end %>
-</div>

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

@@ -1,24 +0,0 @@
-<div class="super-field-group" data-controller="clean-filter-param">
-  <%= form.fields_for(filter_type_timestamp.field_name, filter_type_timestamp) do |form_field| %>
-    <%= form_field.label(:q0, filter_type_timestamp.humanized_field_name) %>
-    <div class="relative inline-block mt-2">
-      <%= form_field.super.select(
-        :op,
-        filter_type_timestamp.operators,
-        { include_blank: false },
-        data: { clean_filter_param_target: "candidate" }
-      ) %>
-    </div>
-    <div class="flex items-center mt-3">
-      <div class="flex-initial">
-        <%= form_field.super.text_field(:q0, data: { clean_filter_param_target: "control candidate" }) %>
-      </div>
-      <div class="flex-initial px-2">
-        &ndash;
-      </div>
-      <div class="flex-initial">
-        <%= form_field.super.text_field(:q1, data: { clean_filter_param_target: "control candidate" }) %>
-      </div>
-    </div>
-  <% end %>
-</div>

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_select.html.erb

@@ -1 +0,0 @@
-<%= form.super.select!(column, form_field_select[:collection]) %>

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

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

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/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/lib/super/controls.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-require "super/controls/optional"
-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 Optional
-    include Steps
-    include View
-
-    # Specifies the model. This is a required method
-    #
-    # @return [ActiveRecord::Base]
-    def model
-      raise NotImplementedError
-    end
-  end
-end

data/lib/super/controls/optional.rb

@@ -1,113 +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|
-            val = val.build if val.respond_to?(:build)
-            key if val.real?
-          end
-
-        attribute_names.compact
-      end
-
-      def default_sort
-        { id: :desc }
-      end
-    end
-  end
-end

data/lib/super/controls/steps.rb

@@ -1,106 +0,0 @@
-# frozen_string_literal: true
-
-module Super
-  class Controls
-    # Methods that are called by controller actions. All of these methods have
-    # a default implementation, but feel free to override as needed.
-    module Steps
-      # Tells the controller how to load records in the index action using
-      # `#scope`
-      #
-      # @param action [ActionInquirer]
-      # @param params [ActionController::Parameters]
-      # @return [ActiveRecord::Relation]
-      def load_records(action:, params:)
-        scope(action: action)
-      end
-
-      # Loads a record using `#scope`
-      #
-      # @param action [ActionInquirer]
-      # @param params [ActionController::Parameters]
-      # @return [ActiveRecord::Base]
-      def load_record(action:, params:)
-        scope(action: action).find(params[:id])
-      end
-
-      # Builds a record using `#scope`
-      #
-      # @param action [ActionInquirer]
-      # @return [ActiveRecord::Base]
-      def build_record(action:)
-        scope(action: action).build
-      end
-
-      # Builds and populates a record using `#scope`
-      #
-      # @param action [ActionInquirer]
-      # @param params [ActionController::Parameters]
-      # @return [ActiveRecord::Base]
-      def build_record_with_params(action:, params:)
-        scope(action: action).build(permitted_params(params, action: action))
-      end
-
-      # Saves a record
-      #
-      # @param action [ActionInquirer]
-      # @param params [ActionController::Parameters]
-      # @return [true, false]
-      def save_record(action:, record:, params:)
-        record.save
-      end
-
-      # Saves a record
-      #
-      # @param action [ActionInquirer]
-      # @param params [ActionController::Parameters]
-      # @return [true, false]
-      def update_record(action:, record:, params:)
-        record.update(permitted_params(params, action: action))
-      end
-
-      # Destroys a record
-      #
-      # @param action [ActionInquirer]
-      # @param params [ActionController::Parameters]
-      # @return [ActiveRecord::Base, false]
-      def destroy_record(action:, record:, params:)
-        record.destroy
-      end
-
-      def initialize_query_form(params:, current_path:)
-        Super::Query::FormObject.new(
-          model: model,
-          params: params,
-          namespace: :q,
-          current_path: current_path,
-        )
-      end
-
-      def apply_queries(query_form:, records:)
-        query_form.apply_changes(records)
-      end
-
-      def initialize_filter_form(query_form:)
-        if filters_enabled?
-          query_form.add(
-            Super::Filter::FormObject,
-            namespace: :f,
-            schema: filter_schema
-          )
-        end
-      end
-
-      def initialize_sort_form(query_form:)
-        if sort_enabled?
-          query_form.add(
-            Super::Sort::FormObject,
-            namespace: :s,
-            default: default_sort,
-            sortable_columns: sortable_columns
-          )
-        end
-      end
-    end
-  end
-end