Class: ActiveAdmin::Views::Pages::Index

Inherits:
Base
  • Object
show all
Includes:
Helpers::Collection, ActiveAdmin::ViewHelpers::DownloadFormatLinksHelper
Defined in:
lib/active_admin/views/pages/index.rb

Instance Method Summary collapse

Methods included from ActiveAdmin::ViewHelpers::DownloadFormatLinksHelper

#build_download_format_links, #build_download_formats

Methods included from Helpers::Collection

#collection_is_empty?, #collection_size

Methods inherited from Base

#build, #html_title

Instance Method Details

#any_table_tools? ⇒ Boolean (protected)

Returns:

  • (Boolean) 


70
71
72
73
74
 
# File 'lib/active_admin/views/pages/index.rb', line 70

def any_table_tools?
  active_admin_config.batch_actions.any? ||
  active_admin_config.scopes.any? ||
  active_admin_config.page_presenters[:index].try(:size).try(:>, 1)
end

#build_batch_actions_selector ⇒ Object (protected) 



76
77
78
79
80
 
# File 'lib/active_admin/views/pages/index.rb', line 76

def build_batch_actions_selector
  if active_admin_config.batch_actions.any?
    insert_tag view_factory.batch_action_selector, active_admin_config.batch_actions
  end
end

#build_collection ⇒ Object (protected) 



48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/active_admin/views/pages/index.rb', line 48

def build_collection
  if items_in_collection?
    render_index
  else
    if params[:q] || params[:scope]
      render_empty_results
    else
      render_blank_slate
    end
  end
end

#build_index_list ⇒ Object (protected) 



92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/active_admin/views/pages/index.rb', line 92

def build_index_list
  indexes = active_admin_config.page_presenters[:index]

  if indexes.kind_of?(Hash) && indexes.length > 1
    index_classes = []
    active_admin_config.page_presenters[:index].each do |type, page_presenter|
      index_classes << find_index_renderer_class(page_presenter[:as])
    end

    index_list_renderer index_classes
  end
end

#build_scopes ⇒ Object (protected) 



82
83
84
85
86
87
88
89
90
 
# File 'lib/active_admin/views/pages/index.rb', line 82

def build_scopes
  if active_admin_config.scopes.any?
    scope_options = {
      scope_count: config.fetch(:scope_count, true)
    }

    scopes_renderer active_admin_config.scopes, scope_options
  end
end

#build_table_tools ⇒ Object (protected) 



62
63
64
65
66
67
68
 
# File 'lib/active_admin/views/pages/index.rb', line 62

def build_table_tools
  div class: "table_tools" do
    build_batch_actions_selector
    build_scopes
    build_index_list
  end if any_table_tools?
end

#config ⇒ Object

Retrieves the given page presenter, or uses the default.



18
19
20
21
 
# File 'lib/active_admin/views/pages/index.rb', line 18

def config
  active_admin_config.get_page_presenter(:index, params[:as]) ||
  ActiveAdmin::PagePresenter.new(as: :table)
end

#find_index_renderer_class(klass) ⇒ Object (protected)

Returns the actual class for renderering the main content on the index page. To set this, use the :as option in the page_presenter block.



107
108
109
110
 
# File 'lib/active_admin/views/pages/index.rb', line 107

def find_index_renderer_class(klass)
  klass.is_a?(Class) ? klass :
    ::ActiveAdmin::Views.const_get("IndexAs" + klass.to_s.camelcase)
end

#items_in_collection? ⇒ Boolean (protected)

Returns:

  • (Boolean) 


44
45
46
 
# File 'lib/active_admin/views/pages/index.rb', line 44

def items_in_collection?
  !collection_is_empty?
end

#main_content ⇒ Object

Renders the index configuration that was set in the controller. Defaults to rendering the ActiveAdmin::Pages::Index::Table



25
26
27
28
29
30
 
# File 'lib/active_admin/views/pages/index.rb', line 25

def main_content
  wrap_with_batch_action_form do
    build_table_tools
    build_collection
  end
end

#render_blank_slate ⇒ Object (protected) 



112
113
114
115
116
117
118
 
# File 'lib/active_admin/views/pages/index.rb', line 112

def render_blank_slate
  blank_slate_content = I18n.t("active_admin.blank_slate.content", resource_name: active_admin_config.plural_resource_label)
  if controller.action_methods.include?('new') && authorized?(ActiveAdmin::Auth::CREATE, active_admin_config.resource_class)
    blank_slate_content = [blank_slate_content, blank_slate_link].compact.join(" ")
  end
  insert_tag(view_factory.blank_slate, blank_slate_content)
end

#render_empty_results ⇒ Object (protected) 



120
121
122
123
 
# File 'lib/active_admin/views/pages/index.rb', line 120

def render_empty_results
  empty_results_content = I18n.t("active_admin.pagination.empty", model: active_admin_config.plural_resource_label)
  insert_tag(view_factory.blank_slate, empty_results_content)
end

#render_index ⇒ Object (protected) 



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/active_admin/views/pages/index.rb', line 125

def render_index
  renderer_class = find_index_renderer_class(config[:as])
  paginator        = config.fetch(:paginator, true)
  download_links   = config.fetch(:download_links, active_admin_config.namespace.download_links)
  pagination_total = config.fetch(:pagination_total, true)
  per_page         = config.fetch(:per_page, active_admin_config.per_page)

  paginated_collection(collection, entry_name:       active_admin_config.resource_label,
                                   entries_name:     active_admin_config.plural_resource_label(count: collection_size),
                                   download_links:   download_links,
                                   paginator:        paginator,
                                   per_page:         per_page,
                                   pagination_total: pagination_total) do
    div class: 'index_content' do
      insert_tag(renderer_class, config, collection)
    end
  end
end

#title ⇒ Object 



9
10
11
12
13
14
15
 
# File 'lib/active_admin/views/pages/index.rb', line 9

def title
  if Proc === config[:title]
    controller.instance_exec &config[:title]
  else
    config[:title] || assigns[:page_title] || active_admin_config.plural_resource_label
  end
end

#wrap_with_batch_action_form(&block) ⇒ Object (protected) 



34
35
36
37
38
39
40
 
# File 'lib/active_admin/views/pages/index.rb', line 34

def wrap_with_batch_action_form(&block)
  if active_admin_config.batch_actions.any?
    batch_action_form(&block)
  else
    block.call
  end
end