Class: ActiveAdmin::Views::PaginatedCollection

Inherits:
Component
  • Object
show all
Defined in:
lib/active_admin/views/components/paginated_collection.rb

Overview

Wraps the content with pagination and available formats.

Example:

paginated_collection collection, :entry_name => "Post" do
  div do
    h2 "Inside the
  end
end

This will create a div with a sentence describing the number of posts in one of the following formats:

  • “No Posts found”

  • “Displaying all 10 Posts”

  • “Displaying Posts 1 - 30 of 31 in total”

It will also generate pagination links.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Component

#default_class_name, #initialize, #tag_name

Constructor Details

This class inherits a constructor from ActiveAdmin::Component

Instance Attribute Details

#collection ⇒ Object (readonly)

Returns the value of attribute collection.



26
27
28
 
# File 'lib/active_admin/views/components/paginated_collection.rb', line 26

def collection
  @collection
end

Instance Method Details

#add_child(*args, &block) ⇒ Object

Override add_child to insert all children into the @contents div



53
54
55
56
57
58
59
 
# File 'lib/active_admin/views/components/paginated_collection.rb', line 53

def add_child(*args, &block)
  if @built
    @contents.add_child(*args, &block)
  else
    super
  end
end

#build(collection, options = {}) ⇒ Object

Builds a new paginated collection component

Parameters:

  • collection (Array) —

    A “paginated” collection from kaminari

  • options (Hash) (defaults to: {}) —

    These options will be passed on to the page_entries_info method. Useful keys:

    :entry_name - The name to display for this resource collection
:param_name - Parameter name for page number in the links (:page by default)
:download_links - Set to false to skip download format links



37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/active_admin/views/components/paginated_collection.rb', line 37

def build(collection, options = {})
  @collection = collection
  @param_name     = options.delete(:param_name)
  @download_links = options.delete(:download_links)

  unless collection.respond_to?(:num_pages)
    raise(StandardError, "Collection is not a paginated scope. Set collection.page(params[:page]).per(10) before calling :paginated_collection.")
  end
  

  @contents = div(:class => "paginated_collection_contents")
  build_pagination_with_formats(options)
  @built = true
end

#build_download_format_links(formats = [:csv, :xml, :json]) ⇒ Object (protected)

TODO: Refactor to new HTML DSL



79
80
81
82
83
84
85
86
 
# File 'lib/active_admin/views/components/paginated_collection.rb', line 79

def build_download_format_links(formats = [:csv, :xml, :json])
  links = formats.collect do |format|
    link_to format.to_s.upcase, { :format => format}.merge(request.query_parameters.except(:commit, :format))
  end
  div :class => "download_links" do
		  text_node [I18n.t('active_admin.download'), links].flatten.join(" ").html_safe
  end
end

#build_pagination ⇒ Object (protected) 



71
72
73
74
75
76
 
# File 'lib/active_admin/views/components/paginated_collection.rb', line 71

def build_pagination
  options =  request.query_parameters.except(:commit, :format)
  options[:param_name] = @param_name if @param_name

  text_node paginate(collection, options.symbolize_keys)
end

#build_pagination_with_formats(options) ⇒ Object (protected) 



63
64
65
66
67
68
69
 
# File 'lib/active_admin/views/components/paginated_collection.rb', line 63

def build_pagination_with_formats(options)
  div :id => "index_footer" do
    build_pagination
    div(page_entries_info(options).html_safe, :class => "pagination_information")
    build_download_format_links unless @download_links == false
  end
end

#page_entries_info(options = {}) ⇒ Object (protected)

modified from will_paginate



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/active_admin/views/components/paginated_collection.rb', line 89

def page_entries_info(options = {})
  if options[:entry_name]
    entry_name = options[:entry_name]
    entries_name = options[:entries_name]
  elsif collection.empty?
    entry_name = I18n.translate("active_admin.pagination.entry", :count => 1, :default => 'entry')
    entries_name = I18n.translate("active_admin.pagination.entry", :count => 2, :default => 'entries')
  else
    begin
      entry_name = I18n.translate!("activerecord.models.#{collection.first.class.model_name.i18n_key}", :count => 1)
      entries_name = I18n.translate!("activerecord.models.#{collection.first.class.model_name.i18n_key}", :count => collection.size)
    rescue I18n::MissingTranslationData
      entry_name = collection.first.class.name.underscore.sub('_', ' ')
    end
  end
  entries_name = entry_name.pluralize unless entries_name

  if collection.num_pages < 2
    case collection.size
    when 0; I18n.t('active_admin.pagination.empty', :model => entries_name)
    when 1; I18n.t('active_admin.pagination.one', :model => entry_name)
    else;   I18n.t('active_admin.pagination.one_page', :model => entries_name, :n => collection.size)
    end
  else
    offset = collection.current_page * collection.size
    total  = collection.total_count
    I18n.t('active_admin.pagination.multiple', :model => entries_name, :from => (offset - collection.size + 1), :to => offset > total ? total : offset, :total => total)
  end
end