Class: ActiveAdmin::Namespace
- Inherits:
-
Object
- Object
- ActiveAdmin::Namespace
- Defined in:
- lib/active_admin/namespace.rb
Overview
Namespaces are the basic organizing principle for resources within Active Admin
Each resource is registered into a namespace which defines:
* the namespaceing for routing
* the module to namespace controllers
* the menu which gets displayed (other resources in the same namespace)
For example:
ActiveAdmin.register Post, namespace: :admin
Will register the Post model into the “admin” namespace. This will namespace the urls for the resource to “/admin/posts” and will set the controller to Admin::PostsController
You can also register to the “root” namespace, which is to say no namespace at all.
ActiveAdmin.register Post, namespace: false
This will register the resource to an instantiated namespace called :root. The resource will be accessible from “/posts” and the controller will be PostsController.
Defined Under Namespace
Classes: Store
Constant Summary collapse
- RegisterEvent =
'active_admin.namespace.register'.freeze
Instance Attribute Summary collapse
-
#application ⇒ Object
readonly
Returns the value of attribute application.
-
#menus ⇒ Object
readonly
Returns the value of attribute menus.
-
#resources ⇒ Object
readonly
Returns the value of attribute resources.
Class Method Summary collapse
Instance Method Summary collapse
-
#add_current_user_to_menu(menu, priority = 10, html_options = {}) ⇒ Object
The default user session menu item.
-
#add_logout_button_to_menu(menu, priority = 20, html_options = {}) ⇒ Object
The default logout menu item.
-
#build_default_utility_nav ⇒ Object
protected
Builds the default utility navigation in top right header with current user & logout button.
-
#build_menu(name = DEFAULT_MENU) {|ActiveAdmin::Menu| ... } ⇒ void
Add a callback to be ran when we build the menu.
- #build_menu_collection ⇒ Object protected
- #build_page(name, options) ⇒ Object protected
- #fetch_menu(name) ⇒ Object
-
#find_or_build_resource(resource_class, options) ⇒ Object
protected
Either returns an existing Resource instance or builds a new one.
-
#initialize(application, name) ⇒ Namespace
constructor
A new instance of Namespace.
- #method_missing(method, *args) ⇒ Object
-
#module_name ⇒ Object
Returns the name of the module if required.
- #name ⇒ Object
- #parse_page_registration_block(config, &block) ⇒ Object protected
- #parse_registration_block(config, &block) ⇒ Object protected
-
#register(resource_class, options = {}, &block) ⇒ Object
Register a resource into this namespace.
-
#register_module ⇒ Object
protected
Creates a ruby module to namespace all the classes in if required.
- #register_page(name, options = {}, &block) ⇒ Object
-
#register_page_controller(config) ⇒ Object
protected
TODO: replace `eval` with `Class.new`.
-
#register_resource_controller(config) ⇒ Object
protected
TODO: replace `eval` with `Class.new`.
- #reset_menu! ⇒ Object
-
#resource_for(klass) ⇒ Object
Returns the first registered ActiveAdmin::Resource instance for a given class.
- #respond_to_missing?(method, include_private = false) ⇒ Boolean
- #root? ⇒ Boolean
- #route_prefix ⇒ Object
- #settings ⇒ Object
-
#unload! ⇒ Object
Unload all the registered resources for this namespace.
- #unload_resources! ⇒ Object protected
Constructor Details
#initialize(application, name) ⇒ Namespace
Returns a new instance of Namespace.
38 39 40 41 42 43 44 |
# File 'lib/active_admin/namespace.rb', line 38 def initialize(application, name) @application = application @name = name.to_s.underscore @resources = ResourceCollection.new register_module unless root? end |
Dynamic Method Handling
This class handles dynamic methods through the method_missing method
#method_missing(method, *args) ⇒ Object
58 59 60 |
# File 'lib/active_admin/namespace.rb', line 58 def method_missing(method, *args) settings.respond_to?(method) ? settings.send(method, *args) : super end |
Instance Attribute Details
#application ⇒ Object (readonly)
Returns the value of attribute application.
36 37 38 |
# File 'lib/active_admin/namespace.rb', line 36 def application @application end |
#menus ⇒ Object (readonly)
Returns the value of attribute menus.
36 37 38 |
# File 'lib/active_admin/namespace.rb', line 36 def @menus end |
#resources ⇒ Object (readonly)
Returns the value of attribute resources.
36 37 38 |
# File 'lib/active_admin/namespace.rb', line 36 def resources @resources end |
Class Method Details
.setting(name, default) ⇒ Object
29 30 31 |
# File 'lib/active_admin/namespace.rb', line 29 def setting(name, default) Deprecation.warn "This method does not do anything and will be removed." end |
Instance Method Details
#add_current_user_to_menu(menu, priority = 10, html_options = {}) ⇒ Object
The default user session menu item
165 166 167 168 169 170 171 172 |
# File 'lib/active_admin/namespace.rb', line 165 def (, priority = 10, = {}) if current_user_method .add id: 'current_user', priority: priority, html_options: , label: -> { display_name current_active_admin_user }, url: -> { auto_url_for(current_active_admin_user) }, if: :current_active_admin_user? end end |
#add_logout_button_to_menu(menu, priority = 20, html_options = {}) ⇒ Object
The default logout menu item
149 150 151 152 153 154 155 156 157 |
# File 'lib/active_admin/namespace.rb', line 149 def (, priority = 20, = {}) if logout_link_path = .reverse_merge(method: logout_link_method || :get) .add id: 'logout', priority: priority, html_options: , label: ->{ I18n.t 'active_admin.logout' }, url: ->{ render_or_call_method_or_proc_on self, active_admin_namespace.logout_link_path }, if: :current_active_admin_user? end end |
#build_default_utility_nav ⇒ Object (protected)
Builds the default utility navigation in top right header with current user & logout button
189 190 191 192 193 194 195 |
# File 'lib/active_admin/namespace.rb', line 189 def build_default_utility_nav return if @menus.exists? :utility_navigation @menus. :utility_navigation do || end end |
#build_menu(name = DEFAULT_MENU) {|ActiveAdmin::Menu| ... } ⇒ void
This method returns an undefined value.
Add a callback to be ran when we build the menu
135 136 137 138 139 140 141 |
# File 'lib/active_admin/namespace.rb', line 135 def (name = DEFAULT_MENU) @menus.before_build do || . name do || yield end end end |
#build_menu_collection ⇒ Object (protected)
176 177 178 179 180 181 182 183 184 185 186 |
# File 'lib/active_admin/namespace.rb', line 176 def @menus = MenuCollection.new @menus.on_build do build_default_utility_nav resources.each do |resource| resource.(@menus) end end end |
#build_page(name, options) ⇒ Object (protected)
202 203 204 |
# File 'lib/active_admin/namespace.rb', line 202 def build_page(name, ) resources.add Page.new(self, name, ) end |
#fetch_menu(name) ⇒ Object
121 122 123 |
# File 'lib/active_admin/namespace.rb', line 121 def (name) @menus.fetch(name) end |
#find_or_build_resource(resource_class, options) ⇒ Object (protected)
Either returns an existing Resource instance or builds a new one.
198 199 200 |
# File 'lib/active_admin/namespace.rb', line 198 def find_or_build_resource(resource_class, ) resources.add Resource.new(self, resource_class, ) end |
#module_name ⇒ Object
102 103 104 |
# File 'lib/active_admin/namespace.rb', line 102 def module_name root? ? nil : @name.camelize end |
#name ⇒ Object
46 47 48 |
# File 'lib/active_admin/namespace.rb', line 46 def name @name.to_sym end |
#parse_page_registration_block(config, &block) ⇒ Object (protected)
245 246 247 |
# File 'lib/active_admin/namespace.rb', line 245 def parse_page_registration_block(config, &block) PageDSL.new(config).run_registration_block(&block) end |
#parse_registration_block(config, &block) ⇒ Object (protected)
240 241 242 243 |
# File 'lib/active_admin/namespace.rb', line 240 def parse_registration_block(config, &block) config.dsl = ResourceDSL.new(config) config.dsl.run_registration_block(&block) end |
#register(resource_class, options = {}, &block) ⇒ Object
Register a resource into this namespace. The preffered method to access this is to use the global registration ActiveAdmin.register which delegates to the proper namespace instance.
65 66 67 68 69 70 71 72 73 74 75 76 77 78 |
# File 'lib/active_admin/namespace.rb', line 65 def register(resource_class, = {}, &block) config = find_or_build_resource(resource_class, ) # Register the resource register_resource_controller(config) parse_registration_block(config, &block) if block_given? # Dispatch a registration event ActiveSupport::Notifications.publish ActiveAdmin::Resource::RegisterEvent, config # Return the config config end |
#register_module ⇒ Object (protected)
Creates a ruby module to namespace all the classes in if required
228 229 230 231 232 |
# File 'lib/active_admin/namespace.rb', line 228 def register_module unless Object.const_defined? module_name Object.const_set module_name, Module.new end end |
#register_page(name, options = {}, &block) ⇒ Object
80 81 82 83 84 85 86 87 88 89 |
# File 'lib/active_admin/namespace.rb', line 80 def register_page(name, = {}, &block) config = build_page(name, ) # Register the resource register_page_controller(config) parse_page_registration_block(config, &block) if block_given? config end |
#register_page_controller(config) ⇒ Object (protected)
TODO: replace `eval` with `Class.new`
207 208 209 210 |
# File 'lib/active_admin/namespace.rb', line 207 def register_page_controller(config) eval "class ::#{config.controller_name} < ActiveAdmin::PageController; end" config.controller.active_admin_config = config end |
#register_resource_controller(config) ⇒ Object (protected)
TODO: replace `eval` with `Class.new`
235 236 237 238 |
# File 'lib/active_admin/namespace.rb', line 235 def register_resource_controller(config) eval "class ::#{config.controller_name} < ActiveAdmin::ResourceController; end" config.controller.active_admin_config = config end |
#reset_menu! ⇒ Object
125 126 127 |
# File 'lib/active_admin/namespace.rb', line 125 def @menus.clear! end |
#resource_for(klass) ⇒ Object
Returns the first registered ActiveAdmin::Resource instance for a given class
117 118 119 |
# File 'lib/active_admin/namespace.rb', line 117 def resource_for(klass) resources[klass] end |
#respond_to_missing?(method, include_private = false) ⇒ Boolean
54 55 56 |
# File 'lib/active_admin/namespace.rb', line 54 def respond_to_missing?(method, include_private = false) settings.respond_to?(method) || super end |
#root? ⇒ Boolean
91 92 93 |
# File 'lib/active_admin/namespace.rb', line 91 def root? name == :root end |
#route_prefix ⇒ Object
106 107 108 |
# File 'lib/active_admin/namespace.rb', line 106 def route_prefix root? ? nil : @name end |
#settings ⇒ Object
50 51 52 |
# File 'lib/active_admin/namespace.rb', line 50 def settings @settings ||= SettingsNode.build(application.namespace_settings) end |
#unload! ⇒ Object
Unload all the registered resources for this namespace
111 112 113 114 |
# File 'lib/active_admin/namespace.rb', line 111 def unload! unload_resources! end |
#unload_resources! ⇒ Object (protected)
212 213 214 215 216 217 218 219 220 221 222 223 224 225 |
# File 'lib/active_admin/namespace.rb', line 212 def unload_resources! resources.each do |resource| parent = (module_name || 'Object').constantize name = resource.controller_name.split('::').last parent.send(:remove_const, name) if parent.const_defined?(name, false) # Remove circular references resource.controller.active_admin_config = nil if resource.is_a?(Resource) && resource.dsl resource.dsl.run_registration_block { @config = nil } end end @resources = ResourceCollection.new end |