super 0.0.3 → 0.0.4

data/lib/super.rb

@@ -1,6 +1,8 @@
 require "tsort"
 require "active_support/concern"
 
+require "super/action"
+require "super/action/step"
 require "super/action_inquirer"
 require "super/assets"
 require "super/configuration"
@@ -10,10 +12,12 @@ require "super/error"
 require "super/display"
 require "super/display/schema_types"
 require "super/form/schema_types"
-require "super/inline_callback"
+require "super/layout"
+require "super/link"
 require "super/navigation/automatic"
 require "super/pagination"
+require "super/panel"
+require "super/partial"
 require "super/plugin"
 require "super/schema"
 require "super/version"
-require "super/view"

data/lib/super/action.rb

@@ -0,0 +1,22 @@
+module Super
+  class Action
+    def initialize(steps:, page:)
+      @steps = steps
+      @page = page
+    end
+
+    attr_reader :page
+
+    def steps
+      resolved_steps = @steps.map do |step|
+        if step.respond_to?(:call)
+          step
+        elsif self.class.steps.key?(step)
+          self.class.steps[step]
+        end
+      end
+
+      resolved_steps.compact
+    end
+  end
+end

data/lib/super/action/step.rb

@@ -0,0 +1,36 @@
+module Super
+  class Action
+    def self.steps
+      @steps ||= {}
+    end
+
+    steps[:new_resource] = proc do
+      @resource = controls.scope(action: action_inquirer).build
+    end
+
+    steps[:create_resource] = proc do
+      @resource = controls.scope(action: action_inquirer).build(create_permitted_params)
+    end
+
+    steps[:load_resource] = proc do
+      @resource = controls.scope(action: action_inquirer).find(params[:id])
+    end
+
+    steps[:load_resources] = proc do
+      @resources = controls.scope(action: action_inquirer)
+    end
+
+    steps[:paginate] = proc do
+      @pagination = Pagination.new(
+        total_count: @resources.size,
+        limit: Super.configuration.index_resources_per_page,
+        query_params: request.GET,
+        page_query_param: :page
+      )
+
+      @resources = @resources
+        .limit(@pagination.limit)
+        .offset(@pagination.offset)
+    end
+  end
+end

data/lib/super/controls.rb

@@ -9,33 +9,253 @@ module Super
 
     attr_reader :actual
 
+    # This is an optional method
+    #
+    # @return [String]
     def title
-      @actual.title
+      if @actual.respond_to?(:title)
+        return @actual.title
+      end
+
+      model.name.pluralize
     end
 
+    # Specifies the model. This is a required method
+    #
+    # @return [ActiveRecord::Base]
     def model
       @actual.model
     end
 
+    # Configures the actions linked to on the index page. This is an optional
+    # method
+    #
+    # @param params [ActionController::Parameters]
+    # @param action [ActionInquirer]
+    # @return [Array<Link>]
+    def resources_actions(params:, action:)
+      actions =
+        if @actual.respond_to?(:resources_actions)
+          @actual.resources_actions(params: params, action: action)
+        else
+          [:new]
+        end
+
+      actions.map do |link|
+        link = Link.resolve(link)
+
+        link.call(params: params)
+      end
+    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 resource [ActiveRecord::Base]
+    # @param params [ActionController::Parameters]
+    # @param action [ActionInquirer]
+    # @return [Array<Link>]
+    def resource_actions(resource, params:, action:)
+      actions =
+        if @actual.respond_to?(:resource_actions)
+          @actual.resource_actions(resource, params: params, action: action)
+        else
+          if action.show?
+            [:edit, :destroy]
+          elsif action.edit?
+            [:show, :destroy]
+          else
+            [:show, :edit, :destroy]
+          end
+        end
+
+      actions.map do |link|
+        link = Link.resolve(link)
+
+        link.call(resource, params: params)
+      end
+    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:)
-      @actual.scope(action: action)
+      if @actual.respond_to?(:scope)
+        return @actual.scope(action: action)
+      end
+
+      model.all
     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)
     end
+
+    # @return [Action]
+    def index
+      if @actual.respond_to?(:index)
+        return @actual.index
+      end
+
+      Super::Action.new(
+        steps: [
+          :load_resources,
+          :paginate,
+        ],
+        page: Super::Layout.new(
+          mains: [
+            Super::Panel.new(
+              Super::Partial.new("resources_header"),
+              Super::Partial.new("index")
+            )
+          ]
+        )
+      )
+    end
+
+    # @return [Action]
+    def show
+      if @actual.respond_to?(:show)
+        return @actual.show
+      end
+
+      Super::Action.new(
+        steps: [
+          :load_resource,
+        ],
+        page: Super::Layout.new(
+          mains: [
+            Super::Panel.new(
+              Super::Partial.new("resource_header"),
+              Super::Partial.new("show")
+            )
+          ]
+        )
+      )
+    end
+
+    # @return [Action]
+    def new
+      if @actual.respond_to?(:new)
+        return @actual.new
+      end
+
+      Super::Action.new(
+        steps: [
+          :new_resource,
+        ],
+        page: Super::Layout.new(
+          mains: [
+            Super::Panel.new(
+              Super::Partial.new("resources_header"),
+              Super::Partial.new("form")
+            )
+          ]
+        )
+      )
+    end
+
+    # @return [Action]
+    def create
+      if @actual.respond_to?(:create)
+        return @actual.create
+      end
+
+      Super::Action.new(
+        steps: [
+          :create_resource,
+        ],
+        page: Super::Layout.new(
+          mains: [
+            Super::Panel.new(
+              Super::Partial.new("resources_header"),
+              Super::Partial.new("form")
+            )
+          ]
+        )
+      )
+    end
+
+    # @return [Action]
+    def edit
+      if @actual.respond_to?(:edit)
+        return @actual.edit
+      end
+
+      Super::Action.new(
+        steps: [
+          :load_resource,
+        ],
+        page: Super::Layout.new(
+          mains: [
+            Super::Panel.new(
+              Super::Partial.new("resource_header"),
+              Super::Partial.new("form")
+            )
+          ]
+        )
+      )
+    end
+
+    # @return [Action]
+    def update
+      if @actual.respond_to?(:update)
+        return @actual.update
+      end
+
+      Super::Action.new(
+        steps: [
+          :load_resource,
+        ],
+        page: Super::Layout.new(
+          mains: [
+            Super::Panel.new(
+              Super::Partial.new("resource_header"),
+              Super::Partial.new("form")
+            )
+          ]
+        )
+      )
+    end
+
+    # @return [Action]
+    def destroy
+      if @actual.respond_to?(:destroy)
+        return @actual.destroy
+      end
+
+      Super::Action.new(
+        steps: [
+          :load_resource,
+        ],
+        page: Super::Layout.new
+      )
+    end
   end
 end

data/lib/super/error.rb

@@ -6,6 +6,7 @@ module Super
     class InvalidStyle < Error; end
     class InvalidPluginArgument < Error; end
     class ActionInquirerError < Error; end
+    class LinkNotRegistered < Error; end
 
     class ClientError < Error; end
     class BadRequest < ClientError; end

data/lib/super/form/schema_types.rb

@@ -63,7 +63,7 @@ module Super
           return false if other.class != self.class
           return false if other.instance_variable_get(:@partial_path) != @partial_path
           return false if other.instance_variable_get(:@extras) != @extras
-          return false if other.instance_variable_get(:@nested) != @nested
+          return false if other.instance_variable_get(:@nested_fields) != @nested_fields
 
           true
         end

data/lib/super/layout.rb

@@ -0,0 +1,19 @@
+module Super
+  class Layout
+    def initialize(headers: nil, asides: nil, mains: nil, footers: nil)
+      @headers = Array(headers).compact
+      @asides = Array(asides).compact
+      @mains = Array(mains).compact
+      @footers = Array(footers).compact
+    end
+
+    attr_reader :headers
+    attr_reader :asides
+    attr_reader :mains
+    attr_reader :footers
+
+    def to_partial_path
+      "super_layout"
+    end
+  end
+end

data/lib/super/link.rb

@@ -0,0 +1,87 @@
+module Super
+  # Links have three required attributes that are passed directly into Rails'
+  # `link_to` helper
+  class Link
+    def self.resolve(link)
+      if link.kind_of?(self)
+        return link
+      end
+
+      if registry.key?(link)
+        return registry[link]
+      end
+
+      raise Error::LinkNotRegistered, "Unknown link `#{link}`"
+    end
+
+    def self.registry
+      @registry ||= {
+        new: -> (params:) {
+          new(
+            "New",
+            Rails.application.routes.url_for(
+              controller: params[:controller],
+              action: :new,
+              only_path: true
+            )
+          )
+        },
+        index: -> (params:) {
+          new(
+            "Index",
+            Rails.application.routes.url_for(
+              controller: params[:controller],
+              action: :index,
+              only_path: true
+            )
+          )
+        },
+        show: -> (resource, params:) {
+          new(
+            "View",
+            Rails.application.routes.url_for(
+              controller: params[:controller],
+              action: :show,
+              id: resource,
+              only_path: true
+            )
+          )
+        },
+        edit: -> (resource, params:) {
+          new(
+            "Edit",
+            Rails.application.routes.url_for(
+              controller: params[:controller],
+              action: :edit,
+              id: resource,
+              only_path: true
+            )
+          )
+        },
+        destroy: -> (resource, params:) {
+          new(
+            "Delete",
+            Rails.application.routes.url_for(
+              controller: params[:controller],
+              action: :destroy,
+              id: resource,
+              only_path: true
+            ),
+            method: :delete,
+            data: { confirm: "Really delete?" }
+          )
+        },
+      }
+    end
+
+    def initialize(text, href, **options)
+      @text = text
+      @href = href
+      @options = options
+    end
+
+    attr_reader :text
+    attr_reader :href
+    attr_reader :options
+  end
+end