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

Methods included from Helpers::Collection

#collection_is_empty?, #collection_size

Methods inherited from Base

#build

Instance Method Details

#any_table_tools? ⇒ Boolean (protected)

Returns:

  • (Boolean) 


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

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) 



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

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) 



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

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) 



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

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) 



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

def build_scopes
  if active_admin_config.scopes.any?
    scope_options = {
      :scope_count => config[:scope_count].nil? ? true : config[:scope_count]
    }

    scopes_renderer active_admin_config.scopes, scope_options
  end
end

#build_table_tools ⇒ Object (protected) 



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

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 



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

def config
  active_admin_config.get_page_presenter(:index, params[:as]) || default_index_config
end

#default_index_config ⇒ Object (protected)

Creates a default configuration for the resource class. This is a table with each column displayed as well as all the default actions



106
107
108
109
110
111
112
113
114
115
 
# File 'lib/active_admin/views/pages/index.rb', line 106

def default_index_config
  @default_index_config ||= ::ActiveAdmin::PagePresenter.new(:as => :table) do |display|
    selectable_column
    id_column
    resource_class.content_columns.each do |col|
      column col.name.to_sym
    end
    default_actions
  end
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.



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

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) 


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

def items_in_collection?
  !collection_is_empty?
end

#main_content ⇒ Object

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



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

def main_content
  wrap_with_batch_action_form do
    build_table_tools
    build_collection
  end
end

#render_blank_slate ⇒ Object (protected) 



124
125
126
127
128
129
130
 
# File 'lib/active_admin/views/pages/index.rb', line 124

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')
    blank_slate_content += " " + link_to(I18n.t("active_admin.blank_slate.link"), new_resource_path)
  end
  insert_tag(view_factory.blank_slate, blank_slate_content)
end

#render_empty_results ⇒ Object (protected) 



132
133
134
135
 
# File 'lib/active_admin/views/pages/index.rb', line 132

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) 



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/active_admin/views/pages/index.rb', line 137

def render_index
  renderer_class = find_index_renderer_class(config[:as])
  paginator      = config[:paginator].nil?      ? true : config[:paginator]
  download_links = config[:download_links].nil? ? active_admin_config.namespace.download_links : config[:download_links]
  pagination_total = config[:pagination_total].nil? ? true : config[:pagination_total]

  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,
                                   :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
16
 
# File 'lib/active_admin/views/pages/index.rb', line 9

def title
  case config[:title]
  when Proc then controller.instance_eval(&config[:title])
  when String then config[:title]
  else
    active_admin_config.plural_resource_label
  end
end

#wrap_with_batch_action_form(&block) ⇒ Object (protected) 



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

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