super 0.0.6 → 0.0.11

data/lib/super/controls.rb

@@ -1,36 +1,17 @@
+# frozen_string_literal: true
+
 require "super/controls/optional"
 require "super/controls/required"
 require "super/controls/steps"
+require "super/controls/view"
 
 module Super
-  # A wrapper around the per-controller Controls classes. This class often
-  # directly delegates to the per-controller classes, but it can also provide
-  # some default implementation.
+  # The base Controls class. Most parts of Super can be configured by
+  # customizing its methods.
   class Controls
     include Required
     include Optional
     include Steps
-
-    def initialize(actual)
-      @actual = actual
-    end
-
-    attr_reader :actual
-
-    private
-
-    def default_for(method_name, *args, **kwargs)
-      if @actual.respond_to?(method_name)
-        if args.empty? && kwargs.empty?
-          return @actual.public_send(method_name)
-        elsif args.empty?
-          return @actual.public_send(method_name, **kwargs)
-        else
-          return @actual.public_send(method_name, *args)
-        end
-      end
-
-      yield
-    end
+    include View
   end
 end

data/lib/super/controls/optional.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Super
   class Controls
     # Methods for `Controls` that have a sane default implementation
@@ -6,9 +8,7 @@ module Super
       #
       # @return [String]
       def title
-        default_for(:title) do
-          model.name.pluralize
-        end
+        model.name.pluralize
       end
 
       # Configures what database records are visible on load. This is an optional
@@ -17,20 +17,49 @@ module Super
       # @param action [ActionInquirer]
       # @return [ActiveRecord::Relation]
       def scope(action:)
-        default_for(:scope, action: action) do
-          model.all
+        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:)
-        default_for(:collection_actions, action: action) do
-          Super::Link.find_all(:new)
-        end
+        Super::Link.find_all(:new)
       end
 
       # Configures the actions linked to on the show page as well as each row of
@@ -39,27 +68,45 @@ module Super
       # @param action [ActionInquirer]
       # @return [Array<Link>]
       def member_actions(action:)
-        default_for(:member_actions, action: action) do
-          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
+        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
 
-      # Specifies how many records to show per page
-      #
-      # @param action [ActionInquirer]
-      # @param query_params [Hash]
-      # @return [ActiveRecord::Relation]
-      def records_per_page(action:, query_params:)
-        default_for(:records_per_page, action: action, query_params: query_params) do
-          Super.configuration.index_records_per_page
+      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,3 +1,5 @@
+# frozen_string_literal: true
+
 module Super
   class Controls
     # Methods for `Controls` that must be defined for Super to work properly
@@ -6,35 +8,7 @@ module Super
       #
       # @return [ActiveRecord::Base]
       def model
-        @actual.model
-      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:)
-        @actual.permitted_params(params, action: action)
-      end
-
-      # Configures the fields that are displayed on the index and show actions.
-      # This is a required method
-      #
-      # @param action [ActionInquirer]
-      # @return [Schema]
-      def display_schema(action:)
-        @actual.display_schema(action: action)
-      end
-
-      # Configures the editable fields on the new and edit actions. This is a
-      # required method
-      #
-      # @param action [ActionInquirer]
-      # @return [Schema]
-      def form_schema(action:)
-        @actual.form_schema(action: action)
+        raise NotImplementedError
       end
     end
   end

data/lib/super/controls/steps.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Super
   class Controls
     # Methods that are called by controller actions. All of these methods have
@@ -10,40 +12,7 @@ module Super
       # @param params [ActionController::Parameters]
       # @return [ActiveRecord::Relation]
       def load_records(action:, params:)
-        default_for(:load_records, action: action, params: params) do
-          scope(action: action)
-        end
-      end
-
-      # Sets up pagination
-      #
-      # @param action [ActionInquirer]
-      # @param records [ActiveRecord::Relation]
-      # @param query_params [Hash]
-      # @return [Pagination]
-      def initialize_pagination(action:, records:, query_params:)
-        default_for(:initialize_pagination, action: action, records: records, query_params: query_params) do
-          Pagination.new(
-            total_count: records.size,
-            limit: records_per_page(action: action, query_params: query_params),
-            query_params: query_params,
-            page_query_param: :page
-          )
-        end
-      end
-
-      # Paginates
-      #
-      # @param action [ActionInquirer]
-      # @param records [ActiveRecord::Relation]
-      # @param pagination [Pagination]
-      # @return [ActiveRecord::Relation]
-      def paginate_records(action:, records:, pagination:)
-        default_for(:paginate_records, action: action, records: records, pagination: pagination) do
-          records
-            .limit(pagination.limit)
-            .offset(pagination.offset)
-        end
+        scope(action: action)
       end
 
       # Loads a record using `#scope`
@@ -52,9 +21,7 @@ module Super
       # @param params [ActionController::Parameters]
       # @return [ActiveRecord::Base]
       def load_record(action:, params:)
-        default_for(:load_record, action: action, params: params) do
-          scope(action: action).find(params[:id])
-        end
+        scope(action: action).find(params[:id])
       end
 
       # Builds a record using `#scope`
@@ -62,9 +29,7 @@ module Super
       # @param action [ActionInquirer]
       # @return [ActiveRecord::Base]
       def build_record(action:)
-        default_for(:build_record) do
-          scope(action: action).build
-        end
+        scope(action: action).build
       end
 
       # Builds and populates a record using `#scope`
@@ -73,31 +38,25 @@ module Super
       # @param params [ActionController::Parameters]
       # @return [ActiveRecord::Base]
       def build_record_with_params(action:, params:)
-        default_for(:build_record_with_params, action: action, params: params) do
-          scope(action: action).build(permitted_params(params, action: action))
-        end
+        scope(action: action).build(permitted_params(params, action: action))
       end
 
       # Saves a record
       #
       # @param action [ActionInquirer]
       # @param params [ActionController::Parameters]
-      # @return [ActiveRecord::Base]
+      # @return [true, false]
       def save_record(action:, record:, params:)
-        default_for(:save_record, action: action, record: record, params: params) do
-          record.save
-        end
+        record.save
       end
 
       # Saves a record
       #
       # @param action [ActionInquirer]
       # @param params [ActionController::Parameters]
-      # @return [ActiveRecord::Base]
+      # @return [true, false]
       def update_record(action:, record:, params:)
-        default_for(:update_record, action: action, record: record, params: params) do
-          record.update(permitted_params(params, action: action))
-        end
+        record.update(permitted_params(params, action: action))
       end
 
       # Destroys a record
@@ -106,8 +65,40 @@ module Super
       # @param params [ActionController::Parameters]
       # @return [ActiveRecord::Base, false]
       def destroy_record(action:, record:, params:)
-        default_for(:update_record, action: action, record: record, params: params) do
-          record.destroy
+        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

data/lib/super/controls/view.rb

@@ -0,0 +1,55 @@
+# 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/display.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module Super
+  # This schema type is meant to be used for +#index+ or +#show+ actions to
+  # transform database fields into something that is human friendly.
+  #
+  # ```
+  # class MembersController::Controls
+  #   # ...
+  #
+  #   def show_schema
+  #     Super::Display.new do |fields, type|
+  #       fields[:name] = type.manual { |name| name }
+  #       fields[:rank] = type.manual { |rank| rank }
+  #       fields[:position] = type.manual { |position| position }
+  #       fields[:ship] = type.manual { |ship| "#{ship.name} (Ship ##{ship.id})" }
+  #       fields[:created_at] = type.manual { |created_at| created_at.iso8601 }
+  #       fields[:updated_at] = type.manual { |updated_at| updated_at.iso8601 }
+  #     end
+  #   end
+  #
+  #   # ...
+  # end
+  # ```
+  class Display
+    include Schema::Common
+
+    def initialize
+      @fields = Super::Schema::Fields.new
+      @schema_types = SchemaTypes.new(fields: @fields)
+
+      yield(@fields, @schema_types)
+    end
+
+    def apply(action:)
+      @action_inquirer = action
+      return self if !@action_inquirer.index?
+      return self if @schema_types.actions_called?
+      @fields[:actions] = @schema_types.actions
+      self
+    end
+
+    def to_partial_path
+      if @action_inquirer.nil?
+        raise Super::Error::Initalization,
+          "You must call the `#apply` method after instantiating Super::Display"
+      elsif @action_inquirer.index?
+        "super_schema_display_index"
+      elsif @action_inquirer.show?
+        "super_schema_display_show"
+      else
+        "super_schema_display_#{@action_inquirer.action}"
+      end
+    end
+
+    # @private
+    def render_field(template:, record:, column:)
+      formatter = @fields[column]
+
+      formatted =
+        if formatter.real?
+          value = record.public_send(column)
+          formatter.present(value)
+        else
+          formatter.present
+        end
+
+      if formatted.respond_to?(:to_partial_path)
+        if formatted.respond_to?(:locals)
+          formatted.locals[:record] ||= record
+          template.render(formatted, formatted.locals)
+        else
+          template.render(formatted)
+        end
+      else
+        formatted
+      end
+    end
+  end
+end