Add comments to Page & Resource's Config and Controllers

Author: pcreux

lib/active_admin/base_controller.rb

@@ -3,6 +3,8 @@
 require 'active_admin/base_controller/page_configurations'
 
 module ActiveAdmin
+  # BaseController for ActiveAdmin. 
+  # It implements ActiveAdmin controllers core features.
   class BaseController < ::InheritedResources::Base
     helper ::ActiveAdmin::ViewHelpers
 

lib/active_admin/config.rb

@@ -6,6 +6,9 @@ class Config; end
 require 'active_admin/config/menu'
 
 module ActiveAdmin
+
+  # Config implements the common API to Page and Resource.
+  #
   class Config
     # The namespace this config belongs to
     attr_reader :namespace

lib/active_admin/page.rb

@@ -1,4 +1,12 @@
 module ActiveAdmin
+  # Page is the primary data storage for page configuration in Active Admin
+  #
+  # When you register a page (ActiveAdmin.page "Status") you are actually creating
+  # a new Page instance within the given Namespace.
+  #
+  # The instance of the current page is available in PageController and views
+  # by calling the #active_admin_config method.
+  #
   class Page < Config
     attr_reader :name
 

lib/active_admin/page_controller.rb

@@ -1,8 +1,10 @@
 module ActiveAdmin
-  # Note: I could try to just inherit from ResourceController
+
+  # All Pages controllers inherit from this controller.
   class PageController < BaseController
 
-    layout false # Page page is a subclass of Base page.
+    # Pages::Page subclasses Page::Base which implements the layout code
+    layout false
 
     actions :index
 

lib/active_admin/resource_controller.rb

@@ -8,6 +8,8 @@
 require 'active_admin/resource_controller/scoping'
 
 module ActiveAdmin
+  # All Resources Controller inherits from this controller.
+  # It implements actions and helpers for resources.
   class ResourceController < BaseController
     layout :determine_active_admin_layout
 

spec/unit/namespace_spec.rb

@@ -318,5 +318,5 @@ module ::Mock; class Resource; def self.has_many(arg1, arg2); end; end; end
         end
       end # describe "setting a condition for displaying"
     end # describe "adding to the menu"
-  end
+  end # describe "registering a page"
 end