base_controller.rb in administrate-base_controller-0.4.0

- old
+ new
@@ -1,119 +1,139 @@
 require 'administrate/base_controller/version'
-require 'administrate/engine'
 
 module Administrate
-  class Engine < Rails::Engine
-    config.after_initialize do
-      ::Administrate::ApplicationController.class_eval do
-        def index
-          resources = index_resources
-          resources = apply_resource_includes(resources)
-          resources = order.apply(resources)
-          resources = resources.page(params[:page]).per(records_per_page)
+  module BaseController
+    def index
+      resources = index_resources
+      resources = apply_resource_includes(resources)
+      resources = order.apply(resources)
+      resources = resources.page(params[:page]).per(records_per_page)
 
-          respond_to do |format|
-            format.json { render_index_json(resources) }
-            format.any { render_index_any(resources, format: format) }
-          end
-        end
+      respond_to do |format|
+        format.json { render_index_json(resources) }
+        format.any { render_index_any(resources, format: format) }
+      end
+    end
 
-        def new
-          resource = new_resource
-          authorize_resource(resource)
-          render locals: { page: new_page(resource) }
-        end
+    def new
+      resource = new_resource
+      authorize_resource(resource)
+      render locals: { page: new_page(resource) }
+    end
 
-        def edit
-          render locals: { page: edit_page(requested_resource) }
-        end
+    def edit
+      render locals: { page: edit_page(requested_resource) }
+    end
 
-        def show
-          respond_to do |format|
-            format.json { render_show_json(requested_resource) }
-            format.any { render_show_any(requested_resource, format: format) }
-          end
-        end
+    def show
+      respond_to do |format|
+        format.json { render_show_json(requested_resource) }
+        format.any { render_show_any(requested_resource, format: format) }
+      end
+    end
 
-        protected
+    protected
 
-        def search_term
-          @search_term ||= params[:search].to_s.strip
-        end
+    def search_term
+      @search_term ||= params[:search].to_s.strip
+    end
 
-        def index_scoped_resource
-          scoped_resource
-        end
+    ##
+    # The resource scope only used for +index+.
+    #
+    # By default this calls +scoped_resource+ but it's common to overwrite this in controllers that would like a scoped
+    # view on the index page only. This way a subset of resources is shown, based on some state such as the path or a
+    # cookie or the current user, but +find_resource+ still works as intended when accessing the show path.
+    #
+    def index_scoped_resource
+      scoped_resource
+    end
 
-        def index_resources
-          Administrate::Search.new(index_scoped_resource, dashboard_class, search_term).run
-        end
+    ##
+    # Wraps the +index_scoped_resource+.
+    #
+    # By default this constructs the +Administrate::Search+ decorator, wraps the resources and runs it with the
+    # +dashboard_class+ and +search_term+. Overwrite this to turn off search.
+    #
+    def index_resources
+      Administrate::Search.new(index_scoped_resource, dashboard_class, search_term).run
+    end
 
-        def index_page
-          Administrate::Page::Collection.new(dashboard, order: order)
-        end
+    ##
+    # The page used for +index+.
+    #
+    def index_page
+      Administrate::Page::Collection.new(dashboard, order: order)
+    end
 
-        def show_page(resource = requested_resource)
-          Administrate::Page::Show.new(dashboard, resource)
-        end
+    ##
+    # The page used for +show+
+    #
+    def show_page(resource = requested_resource)
+      Administrate::Page::Show.new(dashboard, resource)
+    end
 
-        def new_page(resource)
-          Administrate::Page::Form.new(dashboard, resource)
-        end
+    ##
+    # The page used for +new+
+    #
+    def new_page(resource)
+      Administrate::Page::Form.new(dashboard, resource)
+    end
 
-        def edit_page(resource)
-          new_page(resource)
-        end
+    ##
+    # The page used for +edit+
+    #
+    def edit_page(resource)
+      new_page(resource)
+    end
 
-        def authorize_resource(resource)
-          return if show_action?(action_name.to_sym, resource)
-          raise "That's not a valid action."
-        end
+    def authorize_resource(resource)
+      return if show_action?(action_name.to_sym, resource)
+      raise "That's not a valid action."
+    end
 
-        def resource_params
-          permitted = params.require(resource_class.model_name.param_key)
-                          .permit(dashboard.permitted_attributes)
-                          .to_h
+    def resource_params
+      permitted = params.require(resource_class.model_name.param_key)
+                      .permit(dashboard.permitted_attributes)
+                      .to_h
 
-          permitted.each_with_object(permitted) do |(k, v), result|
-            result[k] = read_param(k, v)
-          end
-        end
+      permitted.each_with_object(permitted) do |(k, v), result|
+        result[k] = read_param(k, v)
+      end
+    end
 
-        def read_param(_, data)
-          if data.is_a?(ActionController::Parameters) && data[:type]
-            return read_param_value(data)
-          end
+    def read_param(_, data)
+      if data.is_a?(ActionController::Parameters) && data[:type]
+        return read_param_value(data)
+      end
 
-          data
-        end
+      data
+    end
 
-        def render_index_json(resources)
-          render json: resources
-        end
+    def render_index_json(resources)
+      render json: resources
+    end
 
-        def render_index_any(resources, format:)
-          page = index_page
+    def render_index_any(resources, format:)
+      page = index_page
 
-          render locals: {
-            resources: resources,
-            search_term: search_term,
-            page: page,
-            show_search_bar: show_search_bar?,
-          }
-        end
+      render locals: {
+        resources: resources,
+        search_term: search_term,
+        page: page,
+        show_search_bar: show_search_bar?,
+      }
+    end
 
-        def render_show_json(resource = requested_resource)
-          render json: resource
-        end
+    def render_show_json(resource = requested_resource)
+      render json: resource
+    end
 
-        def render_show_any(resource = requested_resource, format:)
-          render locals: { page: show_page(resource) }
-        end
+    def render_show_any(resource = requested_resource, format:)
+      render locals: { page: show_page(resource) }
+    end
 
-        private
+    private
 
-        attr_writer :search_term
-      end
-    end
+    attr_writer :search_term
   end
 end