module ActiveAdmin::ResourceController::DataAccess

This module overrides most of the data access methods in Inherited Resources to provide Active Admin with it’s data.

The module also deals with authorization and resource callbacks.

Protected Instance Methods

apply_authorization_scope(collection) click to toggle source

Gives the authorization library a change to pre-scope the collection.

In the case of the CanCan adapter, it calls ‘#accessible_by` on the collection.

@param [ActiveRecord::Relation] collection The collection to scope

@retruns [ActiveRecord::Relation] a scoped collection of query

# File lib/active_admin/resource_controller/data_access.rb, line 205
def apply_authorization_scope(collection)
  action_name = action_to_permission(params[:action])
  active_admin_authorization.scope_collection(collection, action_name)
end
apply_filtering(chain) click to toggle source

Applies any Ransack search methods to the currently scoped collection. Both ‘search` and `ransack` are provided, but we use `ransack` to prevent conflicts.

# File lib/active_admin/resource_controller/data_access.rb, line 224
def apply_filtering(chain)
  @search = chain.ransack clean_search_params params[:q]
  @search.result
end
apply_pagination(chain) click to toggle source
# File lib/active_admin/resource_controller/data_access.rb, line 260
def apply_pagination(chain)
  page_method_name = Kaminari.config.page_method_name
  page = params[Kaminari.config.param_name]

  chain.send(page_method_name, page).per(per_page)
end
apply_scoping(chain) click to toggle source
# File lib/active_admin/resource_controller/data_access.rb, line 238
def apply_scoping(chain)
  @collection_before_scope = chain

  if current_scope
    scope_chain(current_scope, chain)
  else
    chain
  end
end
apply_sorting(chain) click to toggle source
# File lib/active_admin/resource_controller/data_access.rb, line 210
def apply_sorting(chain)
  params[:order] ||= active_admin_config.sort_order

  order_clause = OrderClause.new params[:order]

  if order_clause.valid?
    chain.reorder(order_clause.to_sql(active_admin_config))
  else
    chain # just return the chain
  end
end
build_new_resource() click to toggle source

Builds a new resource. This method uses the method_for_build provided by Inherited Resources.

@returns [ActiveRecord::Base] An un-saved active record base object

# File lib/active_admin/resource_controller/data_access.rb, line 134
def build_new_resource
  scoped_collection.send(method_for_build, *resource_params)
end
build_resource() click to toggle source

Builds, memoize and authorize a new instance of the resource. The actual work of building the new instance is delegated to the build_new_resource method.

This method is used to instantiate and authorize new resources in the new and create controller actions.

@returns [ActiveRecord::Base] An un-saved active record base object

# File lib/active_admin/resource_controller/data_access.rb, line 115
def build_resource
  _resource = get_resource_ivar

  return _resource if _resource

  _resource = build_new_resource

  run_build_callbacks _resource
  authorize_resource! _resource

  _resource = apply_decorator(_resource)

  set_resource_ivar(_resource)
end
clean_search_params(search_params) click to toggle source
# File lib/active_admin/resource_controller/data_access.rb, line 229
def clean_search_params(search_params)
  return {} unless search_params.is_a?(Hash)
  search_params = search_params.dup
  search_params.delete_if do |key, value|
    value == ""
  end
  search_params
end
collection() click to toggle source

Retrieve, memoize and authorize the current collection from the db. This method delegates the finding of the collection to find_collection.

Once collection has been called, the collection is available using either the @collection instance variable or an instance variable named after the resource that the collection is for. eg: Post => @post.

@returns [ActiveRecord::Relation] The collection for the index

# File lib/active_admin/resource_controller/data_access.rb, line 29
def collection
  _collection = get_collection_ivar

  return _collection if _collection

  _collection = find_collection
  authorize! ActiveAdmin::Authorization::READ, active_admin_config.resource_class

  set_collection_ivar _collection
end
collection_before_scope() click to toggle source
# File lib/active_admin/resource_controller/data_access.rb, line 248
def collection_before_scope
  @collection_before_scope
end
create_resource(object) click to toggle source

Calls all the appropriate callbacks and then creates the new resource.

@param [ActiveRecord::Base] object The new resource to create

@returns [void]

# File lib/active_admin/resource_controller/data_access.rb, line 143
def create_resource(object)
  run_create_callbacks object do
    save_resource(object)
  end
end
current_scope() click to toggle source
# File lib/active_admin/resource_controller/data_access.rb, line 252
def current_scope
  @current_scope ||= if params[:scope]
    active_admin_config.get_scope_by_id(params[:scope]) if params[:scope]
  else
    active_admin_config.default_scope(self)
  end
end
destroy_resource(object) click to toggle source

Destroys an object from the database and calls appropriate callbacks.

@returns [void]

# File lib/active_admin/resource_controller/data_access.rb, line 185
def destroy_resource(object)
  run_destroy_callbacks object do
    object.destroy
  end
end
find_collection() click to toggle source

Does the actual work of retrieving the current collection from the db. This is a great method to override if you would like to perform some additional db # work before your controller returns and authorizes the collection.

@returns [ActiveRecord::Relation] The collectin for the index

# File lib/active_admin/resource_controller/data_access.rb, line 47
def find_collection
  collection = scoped_collection

  collection = apply_authorization_scope(collection)
  collection = apply_sorting(collection)
  collection = apply_filtering(collection)
  collection = apply_scoping(collection)
  collection = apply_pagination(collection)
  collection = apply_collection_decorator(collection)

  collection
end
find_resource() click to toggle source

Does the actual work of finding a resource in the database. This method uses the finder method as defined in InheritedResources.

@returns [ActiveRecord::Base] An active record object.

# File lib/active_admin/resource_controller/data_access.rb, line 102
def find_resource
  scoped_collection.send(method_for_find, params[:id])
end
max_csv_records() click to toggle source
# File lib/active_admin/resource_controller/data_access.rb, line 274
def max_csv_records
  10_000
end
max_per_page() click to toggle source
# File lib/active_admin/resource_controller/data_access.rb, line 278
def max_per_page
  10_000
end
per_page() click to toggle source
# File lib/active_admin/resource_controller/data_access.rb, line 267
def per_page
  return max_csv_records if request.format == 'text/csv'
  return max_per_page if active_admin_config.paginate == false

  @per_page || active_admin_config.per_page
end
resource() click to toggle source

Retrieve, memoize and authorize a resource based on params. The actual work of finding the resource is done in find_resource.

This method is used on all the member actions:

* show
* edit
* update
* destroy

@returns [ActiveRecord::Base] An active record object

# File lib/active_admin/resource_controller/data_access.rb, line 85
def resource
  _resource = get_resource_ivar

  return _resource if _resource

  _resource = find_resource
  authorize_resource! _resource

  _resource = apply_decorator(_resource)

  set_resource_ivar(_resource)
end
save_resource(object) click to toggle source

Calls all the appropriate callbacks and then saves the new resource.

@param [ActiveRecord::Base] object The new resource to save

@returns [void]

# File lib/active_admin/resource_controller/data_access.rb, line 154
def save_resource(object)
  run_save_callbacks object do
    object.save
  end
end
scoped_collection() click to toggle source

Override this method in your controllers to modify the start point of our searches and index.

This method should return an ActiveRecord::Relation object so that the searching and filtering can be applied on top

Note, unless you are doing something special, you should use the scope_to method from the Scoping module instead of overriding this method.

# File lib/active_admin/resource_controller/data_access.rb, line 70
def scoped_collection
  end_of_association_chain
end
update_resource(object, attributes) click to toggle source

Update an object with the given attributes. Also calls the appropriate callbacks for update action.

@param [ActiveRecord::Base] object The instance to update

@param [Array] attributes An array with the attributes in the first position

and the Active Record "role" in the second. The role
may be set to nil.

@returns [void]

# File lib/active_admin/resource_controller/data_access.rb, line 170
def update_resource(object, attributes)
  if object.respond_to?(:assign_attributes)
    object.assign_attributes(*attributes)
  else
    object.attributes = attributes[0]
  end

  run_update_callbacks object do
    save_resource(object)
  end
end