Class: ActiveAdmin::Resource

Inherits:
Object
  • Object
show all
Includes:
Authorization, ActionItems, Base, Controllers, Menu, Naming, PagePresenters, Pagination, Routes, Scopes, Sidebars
Defined in:
lib/active_admin/resource.rb,
lib/active_admin/resource/menu.rb,
lib/active_admin/resource/naming.rb,
lib/active_admin/resource/routes.rb,
lib/active_admin/resource/scopes.rb,
lib/active_admin/resource/sidebars.rb,
lib/active_admin/resource/belongs_to.rb,
lib/active_admin/resource/pagination.rb,
lib/active_admin/resource/controllers.rb,
lib/active_admin/resource/action_items.rb,
lib/active_admin/resource/page_presenters.rb

Overview

Resource is the primary data storage for resource configuration in Active Admin

When you register a resource (ActiveAdmin.register Post) you are actually creating a new Resource instance within the given Namespace.

The instance of the current resource is available in ResourceController and views by calling the #active_admin_config method.

Defined Under Namespace

Modules: ActionItems, Base, Controllers, Menu, Naming, PagePresenters, Pagination, Routes, Scopes, Sidebars Classes: BelongsTo, Name

Constant Summary collapse

RegisterEvent =

Event dispatched when a new resource is registered

'active_admin.resource.register'.freeze

Constants included from Authorization

Authorization::CREATE, Authorization::DESTROY, Authorization::READ, Authorization::UPDATE

Instance Attribute Summary collapse

Attributes included from Pagination

#paginate, #per_page

Instance Method Summary collapse

Methods included from Routes

#route_collection_path, #route_prefix, #route_uncountable?

Methods included from Sidebars

#clear_sidebar_sections!, #sidebar_sections, #sidebar_sections?, #sidebar_sections_for

Methods included from Scopes

#default_scope, #get_scope_by_id, #scope, #scopes

Methods included from Pagination

#initialize

Methods included from PagePresenters

#default_index_class, #find_index_class, #get_page_presenter, #page_presenters, #set_index_presenter, #set_page_presenter

Methods included from Naming

#plural_resource_label, #resource_label, #resource_name

Methods included from Menu

#add_to_menu, #default_menu_options, #include_in_menu?, #menu_item, #menu_item_menu_name, #menu_item_menu_name=, #menu_item_options, #menu_item_options=, #navigation_menu, #navigation_menu_name, #navigation_menu_name=

Methods included from Controllers

#controller, #controller_name

Methods included from ActionItems

#action_items, #action_items?, #action_items_for, #add_action_item, #clear_action_items!, #initialize

Methods included from Base

#initialize

Instance Attribute Details

Set breadcrumb builder



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

def breadcrumb
  @breadcrumb
end

#collection_actions ⇒ Object (readonly)

An array of collection actions defined for this resource



37
38
39
 
# File 'lib/active_admin/resource.rb', line 37

def collection_actions
  @collection_actions
end

#csv_builder ⇒ Object

The csv builder for this resource



146
147
148
 
# File 'lib/active_admin/resource.rb', line 146

def csv_builder
  @csv_builder || default_csv_builder
end

#decorator_class_name ⇒ Object

The string identifying a class to decorate our resource with for the view. nil to not decorate.



59
60
61
 
# File 'lib/active_admin/resource.rb', line 59

def decorator_class_name
  @decorator_class_name
end

#dsl ⇒ Object

Store a reference to the DSL so that we can dereference it during garbage collection.



55
56
57
 
# File 'lib/active_admin/resource.rb', line 55

def dsl
  @dsl
end

#member_actions ⇒ Object (readonly)

An array of member actions defined for this resource



34
35
36
 
# File 'lib/active_admin/resource.rb', line 34

def member_actions
  @member_actions
end

#namespace ⇒ Object (readonly)

The namespace this config belongs to



28
29
30
 
# File 'lib/active_admin/resource.rb', line 28

def namespace
  @namespace
end

#resource_class_name ⇒ Object (readonly)

The name of the resource class



31
32
33
 
# File 'lib/active_admin/resource.rb', line 31

def resource_class_name
  @resource_class_name
end

#scope_to ⇒ Object

Scope this resource to an association in the controller



43
44
45
 
# File 'lib/active_admin/resource.rb', line 43

def scope_to
  @scope_to
end

#scope_to_association_method ⇒ Object

If we’re scoping resources, use this method on the parent to return the collection



46
47
48
 
# File 'lib/active_admin/resource.rb', line 46

def scope_to_association_method
  @scope_to_association_method
end

#sort_order ⇒ Object

The default sort order to use in the controller



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

def sort_order
  @sort_order
end

Instance Method Details

#admin_notes? ⇒ Boolean

Are admin notes turned on for this resource

Returns:

  • (Boolean) 


126
127
128
 
# File 'lib/active_admin/resource.rb', line 126

def admin_notes?
  admin_notes.nil? ? ActiveAdmin.admin_notes : admin_notes
end

#belongs_to(target, options = {}) ⇒ Object 



130
131
132
133
134
 
# File 'lib/active_admin/resource.rb', line 130

def belongs_to(target, options = {})
  @belongs_to = Resource::BelongsTo.new(self, target, options)
  self.menu_item_menu_name = target unless @belongs_to.optional?
  controller.belongs_to(target, options.dup)
end

#belongs_to? ⇒ Boolean

Do we belong to another resource

Returns:

  • (Boolean) 


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

def belongs_to?
  !belongs_to_config.nil?
end

#belongs_to_config ⇒ Object 



136
137
138
 
# File 'lib/active_admin/resource.rb', line 136

def belongs_to_config
  @belongs_to
end

#clear_collection_actions! ⇒ Object 



116
117
118
 
# File 'lib/active_admin/resource.rb', line 116

def clear_collection_actions!
  @collection_actions = []
end

#clear_member_actions! ⇒ Object

Clears all the member actions this resource knows about



112
113
114
 
# File 'lib/active_admin/resource.rb', line 112

def clear_member_actions!
  @member_actions = []
end

#decorator_class ⇒ Object 



90
91
92
 
# File 'lib/active_admin/resource.rb', line 90

def decorator_class
  ActiveSupport::Dependencies.constantize(decorator_class_name) if decorator_class_name
end

#defined_actions ⇒ Object

Return only defined resource actions



121
122
123
 
# File 'lib/active_admin/resource.rb', line 121

def defined_actions
  controller.instance_methods.map { |m| m.to_sym } & ResourceController::ACTIVE_ADMIN_ACTIONS
end

#resource ⇒ Object

Deprecated. 


151
152
153
 
# File 'lib/active_admin/resource.rb', line 151

def resource
  resource_class
end

#resource_class ⇒ Object

The class this resource wraps. If you register the Post model, Resource#resource_class will point to the Post class



86
87
88
 
# File 'lib/active_admin/resource.rb', line 86

def resource_class
  ActiveSupport::Dependencies.constantize(resource_class_name)
end

#resource_column_names ⇒ Object 



98
99
100
 
# File 'lib/active_admin/resource.rb', line 98

def resource_column_names
  resource_class.column_names
end

#resource_quoted_column_name(column) ⇒ Object 



102
103
104
 
# File 'lib/active_admin/resource.rb', line 102

def resource_quoted_column_name(column)
  resource_class.connection.quote_column_name(column)
end

#resource_table_name ⇒ Object 



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

def resource_table_name
  resource_class.quoted_table_name
end

#route_instance_path ⇒ Object

Returns the named route for an instance of this resource



107
108
109
 
# File 'lib/active_admin/resource.rb', line 107

def route_instance_path
  [route_prefix, controller.resources_configuration[:self][:route_instance_name], 'path'].compact.join('_').to_sym
end