super 0.0.5 → 0.0.6

data/lib/generators/super/install/install_generator.rb

@@ -29,6 +29,22 @@ module Super
       create_file("app/controllers/#{controller_namespace}/.keep", "")
     end
 
+    def copy_cheatsheet
+      super_path = Pathname.new(Gem.loaded_specs["super"].full_gem_path).expand_path
+      super_cheat_path = super_path.join("docs", "cheat.md")
+
+      path =
+        if options["controller_namespace"].present?
+          "app/controllers/#{controller_namespace}/README.md"
+        else
+          "app/controllers/README.md"
+        end
+
+      create_file(path) do
+        super_cheat_path.read.sub(%r{<!--.*?-->}m, "").strip + "\n"
+      end
+    end
+
     def setup_sprockets4_manifest
       append_to_file "app/assets/config/manifest.js", "//= link super_manifest.js\n"
     end

data/lib/super.rb

@@ -2,13 +2,14 @@ require "active_support/concern"
 
 require "super/action_inquirer"
 require "super/assets"
+require "super/client_error"
 require "super/compatibility"
 require "super/configuration"
 require "super/controls"
-require "super/display"
 require "super/display/schema_types"
 require "super/engine"
 require "super/error"
+require "super/form"
 require "super/form/schema_types"
 require "super/layout"
 require "super/link"
@@ -18,6 +19,5 @@ require "super/panel"
 require "super/partial"
 require "super/plugin"
 require "super/schema"
-require "super/step"
 require "super/version"
 require "super/view_helper"

data/lib/super/action_inquirer.rb

@@ -1,7 +1,7 @@
 module Super
   # ```ruby
   # action = Super::ActionInquirer.new(
-  #   Super::ActionInquirer.default_resources,
+  #   Super::ActionInquirer.default_for_resources,
   #   :index
   # )
   #
@@ -15,7 +15,7 @@ module Super
 
     # @return [Hash<Symbol, Array<Symbol>>] default settings for initialization
     #
-    def self.default_resources
+    def self.default_for_resources
       {
         read: %i[index show new edit],
         write: %i[create update destroy],

data/lib/super/client_error.rb

@@ -0,0 +1,43 @@
+module Super
+  # A container class for all user-facing (4xx) errors thrown by this library.
+  #
+  # See also `Super::Error`
+  class ClientError < StandardError
+    class BadRequest < ClientError; end
+    class Unauthorized < ClientError; end
+    class Forbidden < ClientError; end
+    class NotFound < ClientError; end
+    class UnprocessableEntity < ClientError; end
+
+    module Handling
+      extend ActiveSupport::Concern
+
+      included do
+        rescue_from ::Super::ClientError do |exception|
+          code, default_message =
+            case exception
+            when ClientError::UnprocessableEntity
+              [422, "Unprocessable entity"]
+            when ClientError::NotFound
+              [404, "Not found"]
+            when ClientError::Forbidden
+              [403, "Forbidden"]
+            when ClientError::Unauthorized
+              [401, "Unauthorized"]
+            when ClientError::BadRequest, ClientError
+              [400, "Bad request"]
+            end
+
+          flash.now.alert =
+            if exception.message == exception.class.name.to_s
+              default_message
+            else
+              exception.message
+            end
+
+          render "nothing", status: code
+        end
+      end
+    end
+  end
+end

data/lib/super/configuration.rb

@@ -87,7 +87,7 @@ module Super
     # @!attribute [rw]
     configure :title
     # @!attribute [rw]
-    configure :index_resources_per_page, default: 20
+    configure :index_records_per_page, default: 20
     # @!attribute [rw]
     configure :controller_namespace, default: "admin"
     # @!attribute [rw]

data/lib/super/controls.rb

@@ -1,120 +1,36 @@
+require "super/controls/optional"
+require "super/controls/required"
+require "super/controls/steps"
+
 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.
   class Controls
+    include Required
+    include Optional
+    include Steps
+
     def initialize(actual)
       @actual = actual
     end
 
     attr_reader :actual
 
-    # This is an optional method
-    #
-    # @return [String]
-    def 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
+    private
 
-    # 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)
+    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
-          [:new]
+          return @actual.public_send(method_name, *args)
         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:)
-      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)
+      yield
     end
   end
 end

data/lib/super/controls/optional.rb

@@ -0,0 +1,65 @@
+module Super
+  class Controls
+    # Methods for `Controls` that have a sane default implementation
+    module Optional
+      # This is an optional method
+      #
+      # @return [String]
+      def title
+        default_for(:title) do
+          model.name.pluralize
+        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:)
+        default_for(:scope, action: action) do
+          model.all
+        end
+      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
+      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:)
+        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
+        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
+        end
+      end
+    end
+  end
+end

data/lib/super/controls/required.rb

@@ -0,0 +1,41 @@
+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
+        @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)
+      end
+    end
+  end
+end

data/lib/super/controls/steps.rb

@@ -0,0 +1,115 @@
+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:)
+        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
+      end
+
+      # Loads a record using `#scope`
+      #
+      # @param action [ActionInquirer]
+      # @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
+      end
+
+      # Builds a record using `#scope`
+      #
+      # @param action [ActionInquirer]
+      # @return [ActiveRecord::Base]
+      def build_record(action:)
+        default_for(:build_record) do
+          scope(action: action).build
+        end
+      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:)
+        default_for(:build_record_with_params, action: action, params: params) do
+          scope(action: action).build(permitted_params(params, action: action))
+        end
+      end
+
+      # Saves a record
+      #
+      # @param action [ActionInquirer]
+      # @param params [ActionController::Parameters]
+      # @return [ActiveRecord::Base]
+      def save_record(action:, record:, params:)
+        default_for(:save_record, action: action, record: record, params: params) do
+          record.save
+        end
+      end
+
+      # Saves a record
+      #
+      # @param action [ActionInquirer]
+      # @param params [ActionController::Parameters]
+      # @return [ActiveRecord::Base]
+      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
+      end
+
+      # Destroys a record
+      #
+      # @param action [ActionInquirer]
+      # @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
+        end
+      end
+    end
+  end
+end