Class: ActiveAdmin::Resource

Inherits:
Object
  • Object
show all
Includes:
Authorization, ActionItems, Attributes, Base, Controllers, Includes, Menu, Naming, Ordering, PagePresenters, Pagination, Routes, ScopeTo, 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/includes.rb,
lib/active_admin/resource/ordering.rb,
lib/active_admin/resource/scope_to.rb,
lib/active_admin/resource/sidebars.rb,
lib/active_admin/resource/attributes.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, Attributes, Base, Controllers, Includes, Menu, Naming, Ordering, PagePresenters, Pagination, Routes, ScopeTo, 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

#max_per_page, #paginate, #per_page

Attributes included from Menu

#menu_item

Instance Method Summary collapse

Methods included from Attributes

#counter_cache_col?, #default_attributes, #filtered_col?, #foreign_methods, #method_for_column, #primary_col?, #reject_col?, #sti_col?

Methods included from Ordering

#ordering

Methods included from Routes

#route_batch_action_path, #route_builder, #route_collection_path, #route_edit_instance_path, #route_instance_path, #route_member_action_path, #route_prefix, #route_uncountable?

Methods included from Sidebars

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

Methods included from ScopeTo

#scope_to, #scope_to?, #scope_to_association_method, #scope_to_config, #scope_to_method

Methods included from Includes

#includes

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

#param_key, #plural_resource_label, #resource_label, #resource_name

Methods included from Menu

#add_to_menu, #default_menu_options, #include_in_menu?, #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, #remove_action_item

Methods included from Base

#initialize

Instance Attribute Details


166
167
168
# File 'lib/active_admin/resource.rb', line 166

def breadcrumb
  instance_variable_defined?(:@breadcrumb) ? @breadcrumb : namespace.breadcrumb
end

#collection_actionsObject (readonly)

An array of collection actions defined for this resource


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

def collection_actions
  @collection_actions
end

#create_anotherObject


174
175
176
# File 'lib/active_admin/resource.rb', line 174

def create_another
  instance_variable_defined?(:@create_another) ? @create_another : namespace.create_another
end

#csv_builderObject

The csv builder for this resource


162
163
164
# File 'lib/active_admin/resource.rb', line 162

def csv_builder
  @csv_builder || default_csv_builder
end

#decorator_class_nameObject

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


68
69
70
# File 'lib/active_admin/resource.rb', line 68

def decorator_class_name
  @decorator_class_name
end

#dslObject

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


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

def dsl
  @dsl
end

#member_actionsObject (readonly)

An array of member actions defined for this resource


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

def member_actions
  @member_actions
end

#namespaceObject (readonly)

The namespace this config belongs to


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

def namespace
  @namespace
end

#order_clauseObject


170
171
172
# File 'lib/active_admin/resource.rb', line 170

def order_clause
  @order_clause || namespace.order_clause
end

#resource_class_nameObject (readonly)

The name of the resource class


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

def resource_class_name
  @resource_class_name
end

#sort_orderObject


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

def sort_order
  @sort_order ||= (resource_class.respond_to?(:primary_key) ? resource_class.primary_key.to_s : "id") + "_desc"
end

Instance Method Details

#association_columnsObject


191
192
193
# File 'lib/active_admin/resource.rb', line 191

def association_columns
  @association_columns ||= resource_attributes.select { |key, value| key != value }.values
end

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


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

def belongs_to(target, options = {})
  @belongs_to = Resource::BelongsTo.new(self, target, options)
  self.menu_item_options = false if @belongs_to.required?
  options[:class_name] ||= @belongs_to.resource.resource_class_name if @belongs_to.resource
  controller.send :belongs_to, target, options.dup
end

#belongs_to?Boolean

Do we belong to another resource?

Returns:

  • (Boolean)

157
158
159
# File 'lib/active_admin/resource.rb', line 157

def belongs_to?
  !!belongs_to_config
end

#belongs_to_configObject


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

def belongs_to_config
  @belongs_to
end

#belongs_to_paramObject


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

def belongs_to_param
  if belongs_to? && belongs_to_config.required?
    belongs_to_config.to_param
  end
end

#clear_collection_actions!Object


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

def clear_collection_actions!
  @collection_actions = []
end

#clear_member_actions!Object

Clears all the member actions this resource knows about


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

def clear_member_actions!
  @member_actions = []
end

#content_columnsObject


195
196
197
# File 'lib/active_admin/resource.rb', line 195

def content_columns
  @content_columns ||= resource_attributes.select { |key, value| key == value }.values
end

#decorator_classObject


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

def decorator_class
  decorator_class_name&.constantize
end

#defined_actionsObject

Return only defined resource actions


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

def defined_actions
  controller.instance_methods.map(&:to_sym) & ResourceController::ACTIVE_ADMIN_ACTIONS
end

#find_resource(id) ⇒ Object


178
179
180
181
# File 'lib/active_admin/resource.rb', line 178

def find_resource(id)
  resource = resource_class.public_send *method_for_find(id)
  (decorator_class && resource) ? decorator_class.new(resource) : resource
end

#resource_attributesObject


187
188
189
# File 'lib/active_admin/resource.rb', line 187

def resource_attributes
  @resource_attributes ||= default_attributes
end

#resource_classObject

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


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

def resource_class
  resource_class_name.constantize
end

#resource_column_namesObject


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

def resource_column_names
  resource_class.column_names
end

#resource_columnsObject


183
184
185
# File 'lib/active_admin/resource.rb', line 183

def resource_columns
  resource_attributes.values
end

#resource_name_extensionObject


109
110
111
# File 'lib/active_admin/resource.rb', line 109

def resource_name_extension
  @resource_name_extension ||= define_resource_name_extension(self)
end

#resource_quoted_column_name(column) ⇒ Object


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

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

#resource_table_nameObject


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

def resource_table_name
  resource_class.quoted_table_name
end