Refactor ActiveAdmin Controller hierarchy.

Author: pcreux

features/registering_pages.feature

@@ -10,12 +10,12 @@ Feature: Registering Pages
     """ 
     ActiveAdmin.page "Status" do
       content do
-        h1 "Current Status"
+        para "I love chocolate."
       end
     end
     """
     When I go to the dashboard
-    Then I should see "Status"
-    When I follow "Status"
-    Then I should see "Current Status"
+    And I follow "Status"
+    Then I should see the page title "Status"
+    Then I should see "I love chocolate."
 

lib/active_admin.rb

@@ -16,6 +16,7 @@ module ActiveAdmin
   autoload :Breadcrumbs,              'active_admin/breadcrumbs'
   autoload :Callbacks,                'active_admin/callbacks'
   autoload :Component,                'active_admin/component'
+  autoload :BaseController,           'active_admin/base_controller'
   autoload :ControllerAction,         'active_admin/controller_action'
   autoload :CSVBuilder,               'active_admin/csv_builder'
   autoload :Dashboards,               'active_admin/dashboards'

lib/active_admin/base_controller.rb

@@ -0,0 +1,57 @@
+require 'inherited_resources'
+
+module ActiveAdmin
+  class BaseController < ::InheritedResources::Base
+    helper ::ActiveAdmin::ViewHelpers
+
+    layout 'active_admin'
+
+    before_filter :only_render_implemented_actions
+    before_filter :authenticate_active_admin_user
+
+    class << self
+      # Ensure that this method is available for the DSL
+      public :actions
+
+      # Reference to the Resource object which initialized
+      # this controller
+      attr_accessor :active_admin_config
+    end
+
+    # By default Rails will render un-implemented actions when the view exists. Becuase Active
+    # Admin allows you to not render any of the actions by using the #actions method, we need
+    # to check if they are implemented.
+    def only_render_implemented_actions
+      raise AbstractController::ActionNotFound unless action_methods.include?(params[:action])
+    end
+
+
+    private
+
+    # Calls the authentication method as defined in ActiveAdmin.authentication_method
+    def authenticate_active_admin_user
+      send(active_admin_namespace.authentication_method) if active_admin_namespace.authentication_method
+    end
+
+    def current_active_admin_user
+      send(active_admin_namespace.current_user_method) if active_admin_namespace.current_user_method
+    end
+    helper_method :current_active_admin_user
+
+    def current_active_admin_user?
+      !current_active_admin_user.nil?
+    end
+    helper_method :current_active_admin_user?
+
+    def active_admin_config
+      self.class.active_admin_config
+    end
+    helper_method :active_admin_config
+
+    def active_admin_namespace
+      active_admin_config.namespace
+    end
+    helper_method :active_admin_namespace
+
+  end
+end

lib/active_admin/dashboards/dashboard_controller.rb

@@ -9,7 +9,7 @@ def index
         render 'active_admin/dashboard/index.html.arb'
       end
 
-      protected
+      private
 
       def set_current_tab
         @current_tab = I18n.t("active_admin.dashboard")

lib/active_admin/page.rb

@@ -61,5 +61,18 @@ def route_collection_path
     def comments?
       false
     end
+
+    # Overwrite Resource::ActionItems
+    def action_items_for(action)
+      []
+    end
+
+    def skip_sidebar?
+      true
+    end
+
+    def sidebar_sections_for(action)
+      []
+    end
   end
 end

lib/active_admin/page_controller.rb

@@ -1,86 +1,17 @@
 module ActiveAdmin
   # Note: I could try to just inherit from ResourceController
-  class PageController < ::InheritedResources::Base
+  class PageController < BaseController
 
-    helper ::ActiveAdmin::ViewHelpers
+    layout false # Page page is a subclass of Base page.
 
-    layout :determine_active_admin_layout
+    actions :index
 
-    respond_to :html
-
-    before_filter :only_render_implemented_actions
-    before_filter :authenticate_active_admin_user
-
-    ACTIVE_ADMIN_ACTIONS = [:index]
-
-    include ActiveAdmin::Resource::ActionItems
     include ActiveAdmin::ResourceController::PageConfigurations
     include ActiveAdmin::ResourceController::Menu
 
     def index(options={}, &block)
       arbre_block = index_config.block
       render "active_admin/page/index"
     end
-
-    class << self
-      # Ensure that this method is available for the DSL
-      public :actions
-
-      # Reference to the Resource object which initialized
-      # this controller
-      attr_accessor :active_admin_config
-
-      def active_admin_config=(config)
-        @active_admin_config = config
-        #defaults  :resource_class => config.resource,
-        #          :route_prefix => config.route_prefix,
-        #          :instance_name => config.underscored_resource_name
-      end
-
-    end
-
-    protected
-
-    # By default Rails will render un-implemented actions when the view exists. Becuase Active
-    # Admin allows you to not render any of the actions by using the #actions method, we need
-    # to check if they are implemented.
-    def only_render_implemented_actions
-      raise AbstractController::ActionNotFound unless action_methods.include?(params[:action])
-    end
-
-    # Determine which layout to use.
-    #
-    #   1.  If we're rendering a standard Active Admin action, we want layout(false)
-    #       because these actions are subclasses of the Base page (which implementes
-    #       all the required layout code)
-    #   2.  If we're rendering a custom action, we'll use the active_admin layout so
-    #       that users can render any template inside Active Admin.
-    def determine_active_admin_layout
-      ACTIVE_ADMIN_ACTIONS.include?(params[:action].to_sym) ? false : 'active_admin'
-    end
-
-    # Calls the authentication method as defined in ActiveAdmin.authentication_method
-    def authenticate_active_admin_user
-      send(active_admin_application.authentication_method) if active_admin_application.authentication_method
-    end
-
-    def current_active_admin_user
-      send(active_admin_application.current_user_method) if active_admin_application.current_user_method
-    end
-    helper_method :current_active_admin_user
-
-    def current_active_admin_user?
-      !current_active_admin_user.nil?
-    end
-    helper_method :current_active_admin_user?
-
-    def active_admin_config
-      self.class.active_admin_config
-    end
-    helper_method :active_admin_config
-
-    def active_admin_application
-      ActiveAdmin.application
-    end
   end
 end

lib/active_admin/resource_controller.rb

@@ -10,18 +10,12 @@
 require 'active_admin/resource_controller/scoping'
 
 module ActiveAdmin
-  class ResourceController < ::InheritedResources::Base
-
-    helper ::ActiveAdmin::ViewHelpers
-
+  class ResourceController < BaseController
     layout :determine_active_admin_layout
 
     respond_to :html, :xml, :json
     respond_to :csv, :only => :index
 
-    before_filter :only_render_implemented_actions
-    before_filter :authenticate_active_admin_user
-
     ACTIVE_ADMIN_ACTIONS = [:index, :show, :new, :create, :edit, :update, :destroy]
 
     include Actions
@@ -35,13 +29,6 @@ class ResourceController < ::InheritedResources::Base
     include Scoping
 
     class << self
-      # Ensure that this method is available for the DSL
-      public :actions
-
-      # Reference to the Resource object which initialized
-      # this controller
-      attr_accessor :active_admin_config
-
       def active_admin_config=(config)
         @active_admin_config = config
         defaults  :resource_class => config.resource,
@@ -52,14 +39,7 @@ def active_admin_config=(config)
       public :belongs_to
     end
 
-    protected
-
-    # By default Rails will render un-implemented actions when the view exists. Becuase Active
-    # Admin allows you to not render any of the actions by using the #actions method, we need
-    # to check if they are implemented.
-    def only_render_implemented_actions
-      raise AbstractController::ActionNotFound unless action_methods.include?(params[:action])
-    end
+    private
 
     # Determine which layout to use.
     #
@@ -72,39 +52,11 @@ def determine_active_admin_layout
       ACTIVE_ADMIN_ACTIONS.include?(params[:action].to_sym) ? false : 'active_admin'
     end
 
-    # Calls the authentication method as defined in ActiveAdmin.authentication_method
-    def authenticate_active_admin_user
-      send(active_admin_namespace.authentication_method) if active_admin_namespace.authentication_method
-    end
-
-    def current_active_admin_user
-      send(active_admin_namespace.current_user_method) if active_admin_namespace.current_user_method
-    end
-    helper_method :current_active_admin_user
-
-    def current_active_admin_user?
-      !current_active_admin_user.nil?
-    end
-    helper_method :current_active_admin_user?
-
-    def active_admin_config
-      self.class.active_admin_config
-    end
-    helper_method :active_admin_config
-
-    def active_admin_namespace
-      active_admin_config.namespace
-    end
-    helper_method :active_admin_namespace
-
-    def active_admin_namespace
-      active_admin_config.namespace
-    end
-
     # Returns the renderer class to use for the given action.
     def renderer_for(action)
       active_admin_namespace.view_factory["#{action}_page"]
     end
     helper_method :renderer_for
+
   end
 end

lib/active_admin/resource_controller/action_builder.rb

@@ -1,5 +1,5 @@
 module ActiveAdmin
-  class ResourceController < ::InheritedResources::Base
+  class ResourceController < BaseController
 
     module ActionBuilder
       extend ActiveSupport::Concern

lib/active_admin/resource_controller/actions.rb

@@ -1,5 +1,5 @@
 module ActiveAdmin
-  class ResourceController < ::InheritedResources::Base
+  class ResourceController < BaseController
 
     # Override the InheritedResources actions to use the
     # Active Admin templates.

lib/active_admin/resource_controller/callbacks.rb

@@ -1,5 +1,5 @@
 module ActiveAdmin
-  class ResourceController < ::InheritedResources::Base
+  class ResourceController < BaseController
 
     module Callbacks
       extend ActiveSupport::Concern