Class: Avo::Views::ResourceIndexComponent

Inherits:
ResourceComponent
  • Object
show all
Includes:
ApplicationHelper, ResourcesHelper
Defined in:
app/components/avo/views/resource_index_component.rb

Instance Method Summary collapse

Methods included from ApplicationHelper

#a_button, #a_link, #button_classes, #card_classes, #chart_color, #container_classes, #container_is_full_width?, #d, #decode_filter_params, #e, #empty_state, #encode_filter_params, #frame_id, #get_model_class, #input_classes, #mount_path, #number_to_social, #pagy_major_version, #possibly_rails_authentication?, #render_license_warning, #root_path_without_url, #svg, #white_panel_classes

Methods included from ResourcesHelper

#field_wrapper, #filter_wrapper, #index_field_wrapper, #item_selector_data_attributes, #record_path, #record_title, #resource_for_record, #resource_grid, #resource_show_path, #resource_table

Instance Method Details

#attach_path ⇒ Object 



97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'app/components/avo/views/resource_index_component.rb', line 97

def attach_path
  current_path = CGI.unescape(request.env["PATH_INFO"]).split("/").select(&:present?)

  Avo.root_path(
    paths: [*current_path, "new"],
    query: {
      view: @parent_resource&.view&.to_s,
      turbo_frame: params[:turbo_frame],
      for_attribute: field&.try(:for_attribute)
    }.compact
  )
end

#authorized_to_search? ⇒ Boolean

Returns:

  • (Boolean) 


135
136
137
138
 
# File 'app/components/avo/views/resource_index_component.rb', line 135

def authorized_to_search?
  # Hide the search if the authorization prevents it
  @resource.authorization.authorize_action("search", raise_exception: false)
end

#available_view_types ⇒ Object 



36
37
38
 
# File 'app/components/avo/views/resource_index_component.rb', line 36

def available_view_types
  @index_params[:available_view_types]
end

#back_path ⇒ Object 



172
173
174
175
176
177
178
179
180
181
 
# File 'app/components/avo/views/resource_index_component.rb', line 172

def back_path
  # The `return_to` param takes precedence over anything else.
  return params[:return_to] if params[:return_to].present?

  # Show Go Back link only when association page is opened
  # as a standalone page
  if @reflection.present? && !helpers.turbo_frame_request?
    helpers.resource_path(record: @parent_record, resource: @parent_resource)
  end
end

#can_attach? ⇒ Boolean

Returns:

  • (Boolean) 


51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'app/components/avo/views/resource_index_component.rb', line 51

def can_attach?
  return false if has_reflection_and_is_read_only

  reflection_class = if @reflection.is_a?(::ActiveRecord::Reflection::ThroughReflection)
    @reflection.through_reflection.class
  else
    @reflection.class
  end

  return false unless reflection_class.in? [
    ActiveRecord::Reflection::HasManyReflection,
    ActiveRecord::Reflection::HasAndBelongsToManyReflection
  ]

  authorize_association_for(:attach)
end

#can_render_scopes? ⇒ Boolean

Returns:

  • (Boolean) 


168
169
170
 
# File 'app/components/avo/views/resource_index_component.rb', line 168

def can_render_scopes?
  defined?(Avo::Advanced)
end

#can_see_the_create_button? ⇒ Boolean

The Create button is dependent on the new? policy method. The create? should be called only when the user clicks the Save button so the developers gets access to the params from the form.

Returns:

  • (Boolean) 


42
43
44
45
46
47
48
49
 
# File 'app/components/avo/views/resource_index_component.rb', line 42

def can_see_the_create_button?
  # Disable creation for ArrayResources
  return false if @resource.resource_type_array?

  return authorize_association_for(:create) if @reflection.present?

  @resource.authorization.authorize_action(:new, raise_exception: false) && !has_reflection_and_is_read_only
end

#create_path ⇒ Object 



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'app/components/avo/views/resource_index_component.rb', line 68

def create_path
  args = {}

  if @reflection.present?
    args = {
      via_resource_class: @parent_resource.class,
      via_relation_class: reflection_model_class,
      via_record_id: @parent_record.to_param
    }

    if @reflection.class.in? [
      ActiveRecord::Reflection::ThroughReflection,
      ActiveRecord::Reflection::HasAndBelongsToManyReflection
    ]
      args[:via_relation] = params[:resource_name]
    end

    if @reflection.is_a? ActiveRecord::Reflection::HasManyReflection
      args[:via_relation] = @reflection.name
    end

    if @reflection.inverse_of.present?
      args[:via_relation] = @reflection.inverse_of.name
    end
  end

  helpers.new_resource_path(resource: @resource, **args)
end

#description ⇒ Object 



120
121
122
123
124
125
 
# File 'app/components/avo/views/resource_index_component.rb', line 120

def description
  # If this is a has many association, the user can pass a description to be shown just for this association.
  return field&.description(query: @query) if @reflection.present?

  @resource.description
end

#render_dynamic_filters_button ⇒ Object 



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'app/components/avo/views/resource_index_component.rb', line 140

def render_dynamic_filters_button
  return unless Avo.avo_dynamic_filters_installed?
  return unless @resource.has_filters?
  return if Avo::DynamicFilters.configuration.always_expanded

  a_button size: :sm,
    color: :primary,
    icon: "avo/filter",
    data: {
      controller: "avo-filters",
      action: "click->avo-filters#toggleFiltersArea",
      avo_filters_dynamic_filters_component_id_value: dynamic_filters_component_id
    } do
    Avo::DynamicFilters.configuration.button_label
  end
end

#scopes_list ⇒ Object 



157
158
159
160
161
162
163
164
165
166
 
# File 'app/components/avo/views/resource_index_component.rb', line 157

def scopes_list
  Avo::Advanced::Scopes::ListComponent.new(
    scopes: @scopes,
    resource: @resource,
    turbo_frame: @turbo_frame,
    parent_record: @parent_record,
    query: @query,
    loader: @resource.entity_loader(:scope)
  )
end

#show_search_input ⇒ Object 



127
128
129
130
131
132
133
 
# File 'app/components/avo/views/resource_index_component.rb', line 127

def show_search_input
  return false unless authorized_to_search?
  return false unless @resource.class.search_query.present?
  return false if field&.hide_search_input

  true
end

#singular_resource_name ⇒ Object 



110
111
112
113
114
115
116
117
118
 
# File 'app/components/avo/views/resource_index_component.rb', line 110

def singular_resource_name
  if @reflection.present?
    return name.singularize if field.present?

    reflection_resource.name
  else
    @resource.singular_name || @resource.model_class.model_name.name.downcase
  end
end

#title ⇒ Object 



22
23
24
25
26
27
28
29
30
 
# File 'app/components/avo/views/resource_index_component.rb', line 22

def title
  if @reflection.present?
    return name if field.present?

    reflection_resource.plural_name
  else
    @resource.plural_name
  end
end

#view_type ⇒ Object 



32
33
34
 
# File 'app/components/avo/views/resource_index_component.rb', line 32

def view_type
  @index_params[:view_type]
end