super 0.0.14 → 0.18.0

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

data/lib/super/controls/view.rb

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-module Super
-  class Controls
-    # Methods for `Controls` that have a sane default implementation
-    module View
-      def index_view
-        Super::Layout.new(
-          mains: [
-            Super::Panel.new(
-              Super::Partial.new("collection_header"),
-              :@display
-            ),
-          ],
-          asides: [
-            :@query_form,
-          ]
-        )
-      end
-
-      def show_view
-        Super::Layout.new(
-          mains: [
-            Super::Panel.new(
-              Super::Partial.new("member_header"),
-              :@display
-            ),
-          ]
-        )
-      end
-
-      def new_view
-        Super::Layout.new(
-          mains: [
-            Super::Panel.new(
-              Super::Partial.new("collection_header"),
-              :@form
-            ),
-          ]
-        )
-      end
-
-      def edit_view
-        Super::Layout.new(
-          mains: [
-            Super::Panel.new(
-              Super::Partial.new("member_header"),
-              :@form
-            ),
-          ]
-        )
-      end
-    end
-  end
-end

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