Class: ActiveAdmin::Application

Inherits:
Object
  • Object
show all
Includes:
AssetRegistration
Defined in:
lib/active_admin/application.rb

Constant Summary collapse

BeforeLoadEvent =

Event that gets triggered on load of Active Admin

'active_admin.application.before_load'.freeze
AfterLoadEvent =
'active_admin.application.after_load'.freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from AssetRegistration

#clear_javascripts!, #clear_stylesheets!, #javascripts, #register_javascript, #register_stylesheet, #stylesheets

Constructor Details

#initializeApplication

Returns a new instance of Application.


41
42
43
# File 'lib/active_admin/application.rb', line 41

def initialize
  @namespaces = Namespace::Store.new
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method, *args) ⇒ Object


30
31
32
33
34
35
36
37
38
# File 'lib/active_admin/application.rb', line 30

def method_missing(method, *args)
  if settings.respond_to?(method)
    settings.send(method, *args)
  elsif namespace_settings.respond_to?(method)
    namespace_settings.send(method, *args)
  else
    super
  end
end

Instance Attribute Details

#namespacesObject (readonly)

Returns the value of attribute namespaces


40
41
42
# File 'lib/active_admin/application.rb', line 40

def namespaces
  @namespaces
end

Class Method Details

.inheritable_setting(name, default) ⇒ Object


13
14
15
# File 'lib/active_admin/application.rb', line 13

def inheritable_setting(name, default)
  NamespaceSettings.register name, default
end

.setting(name, default) ⇒ Object


9
10
11
# File 'lib/active_admin/application.rb', line 9

def setting(name, default)
  ApplicationSettings.register name, default
end

Instance Method Details

#controllers_for_filtersObject


158
159
160
161
162
# File 'lib/active_admin/application.rb', line 158

def controllers_for_filters
  controllers = [BaseController]
  controllers.push *Devise.controllers_for_filters if Dependency.devise?
  controllers
end

#filesObject

Returns ALL the files to be loaded


127
128
129
# File 'lib/active_admin/application.rb', line 127

def files
  load_paths.flatten.compact.uniq.flat_map { |path| Dir["#{path}/**/*.rb"] }.sort
end

#load(file) ⇒ Object


122
123
124
# File 'lib/active_admin/application.rb', line 122

def load(file)
  DatabaseHitDuringLoad.capture { super }
end

#load!Object

Loads all ruby files that are within the load_paths setting. To reload everything simply call `ActiveAdmin.unload!`


112
113
114
115
116
117
118
119
120
# File 'lib/active_admin/application.rb', line 112

def load!
  unless loaded?
    ActiveSupport::Notifications.publish BeforeLoadEvent, self # before_load hook
    files.each { |file| load file } # load files
    namespace(default_namespace) # init AA resources
    ActiveSupport::Notifications.publish AfterLoadEvent, self # after_load hook
    @@loaded = true
  end
end

#loaded?Boolean

Whether all configuration files have been loaded

Returns:

  • (Boolean)

99
100
101
# File 'lib/active_admin/application.rb', line 99

def loaded?
  @@loaded ||= false
end

#namespace(name) {|namespace| ... } ⇒ Namespace

Creates a namespace for the given name

Yields the namespace if a block is given

Yields:

Returns:

  • (Namespace)

    the new or existing namespace


73
74
75
76
77
78
79
80
81
82
83
84
85
# File 'lib/active_admin/application.rb', line 73

def namespace(name)
  name ||= :root

  namespace = namespaces[name.to_sym] ||= begin
    namespace = Namespace.new(self, name)
    ActiveSupport::Notifications.publish ActiveAdmin::Namespace::RegisterEvent, namespace
    namespace
  end

  yield(namespace) if block_given?

  namespace
end

#namespace_settingsObject


22
23
24
# File 'lib/active_admin/application.rb', line 22

def namespace_settings
  @namespace_settings ||= SettingsNode.build(NamespaceSettings)
end

#prepare!Object

Runs after the app's AA initializer


57
58
59
60
# File 'lib/active_admin/application.rb', line 57

def prepare!
  remove_active_admin_load_paths_from_rails_autoload_and_eager_load
  attach_reloader
end

#register(resource, options = {}, &block) ⇒ Object

Registers a brand new configuration for the given resource.


63
64
65
66
# File 'lib/active_admin/application.rb', line 63

def register(resource, options = {}, &block)
  ns = options.fetch(:namespace) { default_namespace }
  namespace(ns).register resource, options, &block
end

#register_page(name, options = {}, &block) ⇒ Object

Register a page

@&block The registration block.

Parameters:

  • name (String)

    The page name

  • [Hash] (Hash)

    a customizable set of options


93
94
95
96
# File 'lib/active_admin/application.rb', line 93

def register_page(name, options = {}, &block)
  ns = options.fetch(:namespace) { default_namespace }
  namespace(ns).register_page name, options, &block
end

#respond_to_missing?(method, include_private = false) ⇒ Boolean

Returns:

  • (Boolean)

26
27
28
# File 'lib/active_admin/application.rb', line 26

def respond_to_missing?(method, include_private = false)
  [settings, namespace_settings].any? { |sets| sets.respond_to?(method) } || super
end

#routes(rails_router) ⇒ Object

Creates all the necessary routes for the ActiveAdmin configurations

Use this within the routes.rb file:

Application.routes.draw do |map|
  ActiveAdmin.routes(self)
end

Parameters:

  • rails_router (ActionDispatch::Routing::Mapper)

140
141
142
143
# File 'lib/active_admin/application.rb', line 140

def routes(rails_router)
  load!
  Router.new(router: rails_router, namespaces: namespaces).apply
end

#settingsObject


18
19
20
# File 'lib/active_admin/application.rb', line 18

def settings
  @settings ||= SettingsNode.build(ApplicationSettings)
end

#setup!Object

Runs before the app's AA initializer


52
53
54
# File 'lib/active_admin/application.rb', line 52

def setup!
  register_default_assets
end

#unload!Object

Removes all defined controllers from memory. Useful in development, where they are reloaded on each request.


105
106
107
108
# File 'lib/active_admin/application.rb', line 105

def unload!
  namespaces.each &:unload!
  @@loaded = false
end