Class: Avo::Resources::Base

Inherits:
Object
  • Object
show all
Extended by:
ActiveSupport::DescendantsTracker
Includes:
ActionView::Helpers::UrlHelper, Concerns::CanReplaceItems, Concerns::HasControls, Concerns::HasCoverPhoto, Concerns::HasDescription, Concerns::HasDiscreetInformation, Concerns::HasFieldDiscovery, Concerns::HasHelpers, Concerns::HasItems, Concerns::HasProfilePhoto, Concerns::HasResourceStimulusControllers, Concerns::Hydration, Concerns::ModelClassConstantized, Concerns::Pagination, Concerns::RowControlsConfiguration
Defined in:
lib/avo/resources/base.rb

Direct Known Subclasses

BaseResource, ArrayResource

Constant Summary collapse

VIEW_METHODS_MAPPING = 
{
  index: [:index_fields, :display_fields],
  show: [:show_fields, :display_fields],
  edit: [:edit_fields, :form_fields],
  update: [:edit_fields, :form_fields],
  new: [:new_fields, :form_fields],
  create: [:new_fields, :form_fields]
}

Constants included from Concerns::HasFieldDiscovery

Concerns::HasFieldDiscovery::COLUMN_NAMES_TO_IGNORE

Instance Attribute Summary collapse

Attributes included from Concerns::HasItems

#items_holder

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Concerns::RowControlsConfiguration

#controls_placement, #render_row_controls_on_the_left?, #render_row_controls_on_the_right?, #row_controls_classes, #row_controls_configurations

Methods included from Concerns::HasDiscreetInformation

#discreet_information

Methods included from Concerns::Pagination

#apply_pagination, #pagination_type

Methods included from Concerns::HasHelpers

#helpers

Methods included from Concerns::HasProfilePhoto

#profile_photo

Methods included from Concerns::HasCoverPhoto

#cover_photo

Methods included from Concerns::HasDescription

#description

Methods included from Concerns::HasResourceStimulusControllers

#add_stimulus_attributes_for, #get_stimulus_controllers, #stimulus_data_attributes

Methods included from Concerns::HasControls

#render_edit_controls, #render_index_controls, #render_row_controls, #render_show_controls

Methods included from Concerns::CanReplaceItems

#with_new_items

Methods included from Concerns::HasItems

#fields, #get_field, #get_field_definitions, #get_fields, #get_items, #get_preview_fields, #invalid_fields, #is_empty?, #items, #only_fields, #tab_groups, #visible_items

Methods included from Concerns::HasFieldDiscovery

#discover_associations, #discover_columns, #model_db_columns

Constructor Details

#initialize(record: nil, view: nil, user: nil, params: nil) ⇒ Base

Returns a new instance of Base.



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/avo/resources/base.rb', line 262

def initialize(record: nil, view: nil, user: nil, params: nil)
  @view = Avo::ViewInquirer.new(view) if view.present?
  @user = user if user.present?
  @params = params if params.present?

  if record.present?
    @record = record

    hydrate_model_with_default_values if @view&.new?
  end

  unless self.class.model_class.present?
    if model_class.present? && model_class.respond_to?(:base_class)
      self.class.model_class = model_class.base_class
    end
  end
end

Instance Attribute Details

#record ⇒ Object

Returns the value of attribute record.



49
50
51
 
# File 'lib/avo/resources/base.rb', line 49

def record
  @record
end

#reflection ⇒ Object

Returns the value of attribute reflection.



47
48
49
 
# File 'lib/avo/resources/base.rb', line 47

def reflection
  @reflection
end

#user ⇒ Object

Returns the value of attribute user.



48
49
50
 
# File 'lib/avo/resources/base.rb', line 48

def user
  @user
end

#view ⇒ Object

Returns the value of attribute view.



46
47
48
 
# File 'lib/avo/resources/base.rb', line 46

def view
  @view
end

Class Method Details

.action(action_class, arguments: {}) ⇒ Object 



93
94
95
 
# File 'lib/avo/resources/base.rb', line 93

def action(action_class, arguments: {})
  deprecated_dsl_api __method__, "actions"
end

.authorization ⇒ Object 



122
123
124
 
# File 'lib/avo/resources/base.rb', line 122

def authorization
  Avo::Services::AuthorizationService.new Avo::Current.user, model_class, policy_class: authorization_policy
end

.class_name ⇒ Object 



167
168
169
 
# File 'lib/avo/resources/base.rb', line 167

def class_name
  @class_name ||= to_s.demodulize
end

.fetch_search(key, record: nil) ⇒ Object 



245
246
247
248
 
# File 'lib/avo/resources/base.rb', line 245

def fetch_search(key, record: nil)
  # self.class.fetch_search
  Avo::ExecutionContext.new(target: search[key], resource: self, record: record).handle
end

.filter(filter_class, arguments: {}) ⇒ Object 



97
98
99
 
# File 'lib/avo/resources/base.rb', line 97

def filter(filter_class, arguments: {})
  deprecated_dsl_api __method__, "filters"
end

.find_record(id, query: nil, params: nil) ⇒ Object 



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/avo/resources/base.rb', line 216

def find_record(id, query: nil, params: nil)
  query ||= find_scope # If no record is given we'll use the default

  if single_includes.present?
    query = query.includes(*single_includes)
  end

  if single_attachments.present?
    single_attachments.each do |attachment|
      query = query.send(:"with_attached_#{attachment}")
    end
  end

  Avo::ExecutionContext.new(
    target: find_record_method,
    query: query,
    id: id,
    params: params
  ).handle
end

.find_scope ⇒ Object

This resolves the scope when finding records (not “where” queries)

It’s used to apply the authorization feature.



118
119
120
 
# File 'lib/avo/resources/base.rb', line 118

def find_scope
  authorization.apply_policy model_class
end

.get_available_models ⇒ Object 



134
135
136
 
# File 'lib/avo/resources/base.rb', line 134

def get_available_models
  ApplicationRecord.descendants
end

.get_model_by_name(model_name) ⇒ Object 



138
139
140
141
142
 
# File 'lib/avo/resources/base.rb', line 138

def get_model_by_name(model_name)
  get_available_models.find do |m|
    m.to_s == model_name.to_s
  end
end

.model_class(record_class: nil) ⇒ Object

Returns the model class being used for this resource.

The Resource instance has a model_class method too so it can support the STI use cases where we figure out the model class from the record



148
149
150
151
152
153
154
155
156
157
 
# File 'lib/avo/resources/base.rb', line 148

def model_class(record_class: nil)
  # get the model class off of the static property
  return constantized_model_class if @model_class.present?

  # get the model class off of the record for STI models
  return record_class if record_class.present?

  # generate a model class
  class_name.safe_constantize
end

.model_key ⇒ Object

This is used as the model class ID We use this instead of the route_key to maintain compatibility with uncountable models With uncountable models route key appends an _index suffix (Fish->fish_index) Example: User->users, MediaItem->media_items, Fish->fish



163
164
165
 
# File 'lib/avo/resources/base.rb', line 163

def model_key
  @model_key ||= model_class.model_name.plural
end

.name ⇒ Object Also known as: singular_name 



184
185
186
 
# File 'lib/avo/resources/base.rb', line 184

def name
  name_from_translation_key(count: 1, default: class_name.underscore.humanize)
end

.name_from_translation_key(count:, default:) ⇒ Object

Get the name from the translation_key and fallback to default It can raise I18n::InvalidPluralizationData when using only resource_translation without pluralization keys like: one, two or other key Example:

en:

avo:
  resource_translations:
    product:
      save: "Save product"



202
203
204
205
206
 
# File 'lib/avo/resources/base.rb', line 202

def name_from_translation_key(count:, default:)
  t(translation_key, count:, default:).humanize
rescue I18n::InvalidPluralizationData
  default
end

.navigation_label ⇒ Object 



212
213
214
 
# File 'lib/avo/resources/base.rb', line 212

def navigation_label
  plural_name.humanize
end

.plural_name ⇒ Object 



189
190
191
 
# File 'lib/avo/resources/base.rb', line 189

def plural_name
  name_from_translation_key(count: 2, default: name.pluralize)
end

.query_scope ⇒ Object

This resolves the scope when doing “where” queries (not find queries)

It’s used to apply the authorization feature.



108
109
110
111
112
113
 
# File 'lib/avo/resources/base.rb', line 108

def query_scope
  authorization.apply_policy Avo::ExecutionContext.new(
    target: index_query,
    query: model_class
  ).handle
end

.route_key ⇒ Object 



171
172
173
 
# File 'lib/avo/resources/base.rb', line 171

def route_key
  class_name.underscore.pluralize
end

.scope(scope_class) ⇒ Object 



101
102
103
 
# File 'lib/avo/resources/base.rb', line 101

def scope(scope_class)
  deprecated_dsl_api __method__, "scopes"
end

.search_query ⇒ Object 



237
238
239
 
# File 'lib/avo/resources/base.rb', line 237

def search_query
  search.dig(:query)
end

.search_results_count ⇒ Object 



241
242
243
 
# File 'lib/avo/resources/base.rb', line 241

def search_results_count
  search.dig(:results_count)
end

.singular_route_key ⇒ Object 



175
176
177
 
# File 'lib/avo/resources/base.rb', line 175

def singular_route_key
  route_key.singularize
end

.translation_key ⇒ Object 



179
180
181
 
# File 'lib/avo/resources/base.rb', line 179

def translation_key
  custom_translation_key || "avo.resource_translations.#{class_name.underscore}"
end

.underscore_name ⇒ Object 



208
209
210
 
# File 'lib/avo/resources/base.rb', line 208

def underscore_name
  name.demodulize.underscore
end

.valid_association_name(record, association_name) ⇒ Object 



126
127
128
 
# File 'lib/avo/resources/base.rb', line 126

def valid_association_name(record, association_name)
  association_name if record.class.reflect_on_association(association_name).present?
end

.valid_attachment_name(record, association_name) ⇒ Object 



130
131
132
 
# File 'lib/avo/resources/base.rb', line 130

def valid_attachment_name(record, association_name)
  association_name if record.class.reflect_on_attachment(association_name).present?
end

Instance Method Details

#attachment_fields ⇒ Object 



447
448
449
450
451
 
# File 'lib/avo/resources/base.rb', line 447

def attachment_fields
  get_field_definitions.select do |field|
    [Avo::Fields::FileField, Avo::Fields::FilesField].include? field.class
  end
end

#authorization(user: nil) ⇒ Object 



492
493
494
495
 
# File 'lib/avo/resources/base.rb', line 492

def authorization(user: nil)
  current_user = user || Avo::Current.user
  Avo::Services::AuthorizationService.new(current_user, record || model_class, policy_class: authorization_policy)
end

#available_view_types ⇒ Object 



428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
 
# File 'lib/avo/resources/base.rb', line 428

def available_view_types
  if self.class.view_types.present?
    return Array(
      Avo::ExecutionContext.new(
        target: self.class.view_types,
        resource: self,
        record: record
      ).handle
    )
  end

  view_types = [:table]

  view_types << :grid if self.class.grid_view.present?
  view_types << :map if map_view.present?

  view_types
end

#avatar ⇒ Object 



590
591
592
593
594
595
596
597
598
 
# File 'lib/avo/resources/base.rb', line 590

def avatar
  return avatar_field.to_image if avatar_field.respond_to? :to_image

  return avatar_field.value.variant(resize_to_limit: [480, 480]) if avatar_field.type == "file"

  avatar_field.value
rescue
  nil
end

#avatar_field ⇒ Object 



582
583
584
585
586
587
588
 
# File 'lib/avo/resources/base.rb', line 582

def avatar_field
  get_field_definitions.find do |field|
    field.as_avatar.present?
  end
rescue
  nil
end

#avatar_type ⇒ Object 



600
601
602
603
604
 
# File 'lib/avo/resources/base.rb', line 600

def avatar_type
  avatar_field.as_avatar
rescue
  nil
end

#cache_hash(parent_record) ⇒ Object 



518
519
520
521
522
523
524
525
526
 
# File 'lib/avo/resources/base.rb', line 518

def cache_hash(parent_record)
  result = [record, file_hash]

  if parent_record.present?
    result << parent_record
  end

  result
end

#current_user ⇒ Object 



24
25
26
 
# File 'lib/avo/resources/base.rb', line 24

def current_user
  Avo::Current.user
end

#custom_components ⇒ Object 



638
639
640
641
642
643
644
645
 
# File 'lib/avo/resources/base.rb', line 638

def custom_components
  @custom_components ||= Avo::ExecutionContext.new(
    target: components,
    resource: self,
    record: @record,
    view: @view
  ).handle.with_indifferent_access
end

#default_panel_name ⇒ Object 



386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/avo/resources/base.rb', line 386

def default_panel_name
  return @params[:related_name].capitalize if @params.present? && @params[:related_name].present?

  case @view.to_sym
  when :show
    record_title
  when :edit
    record_title
  when :new
    t("avo.create_new_item", item: name.humanize(capitalize: false)).upcase_first
  end
end

#description_attributes ⇒ Object 



622
623
624
625
626
627
628
 
# File 'lib/avo/resources/base.rb', line 622

def description_attributes
  {
    view: view,
    resource: self,
    record: record
  }
end

#detect_fields ⇒ Object 



280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/avo/resources/base.rb', line 280

def detect_fields
  self.items_holder = Avo::Resources::Items::Holder.new(parent: self)

  # Used in testing to replace items
  if temporary_items.present?
    instance_eval(&temporary_items)
  else
    fetch_fields
  end

  self
end

#divider(**kwargs) ⇒ Object 



327
328
329
 
# File 'lib/avo/resources/base.rb', line 327

def divider(**kwargs)
  entity_loader(:action).use({class: Divider, **kwargs}.compact)
end

#entity_loader(entity) ⇒ Object 



630
631
632
 
# File 'lib/avo/resources/base.rb', line 630

def entity_loader(entity)
  instance_variable_get(:"@#{entity.to_s.pluralize}_loader")
end

#fetch_cards ⇒ Object 



323
324
325
 
# File 'lib/avo/resources/base.rb', line 323

def fetch_cards
  cards
end

#fetch_fields ⇒ Object 



304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/avo/resources/base.rb', line 304

def fetch_fields
  if view.preview?
    [:fields, :index_fields, :show_fields, :display_fields].each do |fields_method|
      send(fields_method) if respond_to?(fields_method)
    end

    return
  end

  possible_methods_for_view = VIEW_METHODS_MAPPING[view.to_sym]

  # Safe navigation operator is used because the view can be "destroy"
  possible_methods_for_view&.each do |method_for_view|
    return send(method_for_view) if respond_to?(method_for_view)
  end

  fields
end

#fetch_record_title ⇒ Object 



413
414
415
416
417
418
419
420
421
422
423
424
425
426
 
# File 'lib/avo/resources/base.rb', line 413

def fetch_record_title
  return name if @record.nil?

  # Get the title from the record if title is not set, try to get the name, title or label, or fallback to the to_param
  return @record.try(:name) || @record.try(:title) || @record.try(:label) || @record.to_param if title.nil?

  # If the title is a symbol, get the value from the record else execute the block/string
  case title
  when Symbol
    @record.send title
  when Proc
    Avo::ExecutionContext.new(target: title, resource: self, record: @record).handle
  end
end

#fields_by_database_id ⇒ Object

Map the received params to their actual fields



454
455
456
457
458
459
460
461
462
463
 
# File 'lib/avo/resources/base.rb', line 454

def fields_by_database_id
  get_field_definitions
    .reject do |field|
      field.computed
    end
    .map do |field|
      [field.database_id.to_s, field]
    end
    .to_h
end

#file_hash ⇒ Object 



497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
 
# File 'lib/avo/resources/base.rb', line 497

def file_hash
  content_to_be_hashed = ""

  resource_path = Rails.root.join("app", "avo", "resources", "#{file_name}.rb").to_s
  if File.file? resource_path
    content_to_be_hashed += File.read(resource_path)
  end

  # policy file hash
  policy_path = Rails.root.join("app", "policies", "#{file_name.gsub("_resource", "")}_policy.rb").to_s
  if File.file? policy_path
    content_to_be_hashed += File.read(policy_path)
  end

  Digest::MD5.hexdigest(content_to_be_hashed)
end

#file_name ⇒ Object 



514
515
516
 
# File 'lib/avo/resources/base.rb', line 514

def file_name
  @file_name ||= self.class.underscore_name.tr(" ", "_")
end

#fill_record(record, permitted_params, extra_params: [], fields: nil) ⇒ Object 



465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
 
# File 'lib/avo/resources/base.rb', line 465

def fill_record(record, permitted_params, extra_params: [], fields: nil)
  # Write the field values
  permitted_params.each do |key, value|
    field = if fields.present?
      fields.find { |f| f.id == key.to_sym }
    else
      fields_by_database_id[key]
    end

    next unless field.present?

    record = field.fill_field record, key, value, permitted_params
  end

  # Write the user configured extra params to the record
  if extra_params.present?
    # Pick only the extra params
    # params at this point are already permited, only need the keys to access them
    extra_attributes = permitted_params.slice(*flatten_keys(extra_params))

    # Let Rails fill in the rest of the params
    record.assign_attributes extra_attributes
  end

  record
end

#form_scope ⇒ Object 



606
607
608
 
# File 'lib/avo/resources/base.rb', line 606

def form_scope
  model_class.base_class.to_s.underscore.downcase
end

#get_external_link ⇒ Object 



651
652
653
654
655
 
# File 'lib/avo/resources/base.rb', line 651

def get_external_link
  return unless record.persisted?

  Avo::ExecutionContext.new(target: external_link, resource: self, record: record).handle
end

#has_record_id? ⇒ Boolean

Returns:

  • (Boolean) 


610
611
612
 
# File 'lib/avo/resources/base.rb', line 610

def has_record_id?
  record.present? && record_id.present?
end

#hydrate ⇒ Object 



376
377
378
379
380
381
382
383
384
 
# File 'lib/avo/resources/base.rb', line 376

def hydrate(...)
  super

  if @record.present?
    hydrate_model_with_default_values if @view&.new?
  end

  self
end

#hydrate_model_with_default_values ⇒ Object

We will not overwrite any attributes that come pre-filled in the record.



529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
 
# File 'lib/avo/resources/base.rb', line 529

def hydrate_model_with_default_values
  default_values = get_fields
    .select do |field|
      !field.computed && !field.is_a?(Avo::Fields::HeadingField)
    end
    .map do |field|
      value = field.value

      if field.type == "belongs_to"

        reflection = @record.class.reflect_on_association(@params[:via_relation]) if @params[:via_relation].present?

        if field.polymorphic_as.present? && field.types.map(&:to_s).include?(@params[:via_relation_class])
          # set the value to the actual record
          via_resource = Avo.resource_manager.get_resource_by_model_class(@params[:via_relation_class])
          value = via_resource.find_record(@params[:via_record_id])
        elsif reflection.present? && reflection.foreign_key.present? && field.id.to_s == @params[:via_relation].to_s
          resource = Avo.resource_manager.get_resource_by_model_class params[:via_relation_class]
          record = resource.find_record @params[:via_record_id], params: params
          id_param = reflection.options[:primary_key] || :id

          value = record.send(id_param)
        end
      end

      [field, value]
    end
    .to_h
    .select do |_, value|
      value.present?
    end

  default_values.each do |field, value|
    field.assign_value record: @record, value: value
  end
end

#id_attribute ⇒ Object 



614
615
616
 
# File 'lib/avo/resources/base.rb', line 614

def id_attribute
  :id
end

#model_class ⇒ Object

Returns the model class being used for this resource.

We use the class method as a fallback but we pass it the record too so it can support the STI use cases where we figure out the model class from that record.



403
404
405
406
407
 
# File 'lib/avo/resources/base.rb', line 403

def model_class
  record_class = @record&.class

  self.class.model_class record_class: record_class
end

#model_name ⇒ Object 



566
567
568
 
# File 'lib/avo/resources/base.rb', line 566

def model_name
  model_class.model_name
end

#record_id ⇒ Object 



618
619
620
 
# File 'lib/avo/resources/base.rb', line 618

def record_id
  record.send(id_attribute)
end

#record_param ⇒ Object 



634
635
636
 
# File 'lib/avo/resources/base.rb', line 634

def record_param
  @record_param ||= @record.persisted? ? @record.to_param : nil
end

#record_path ⇒ Object 



574
575
576
 
# File 'lib/avo/resources/base.rb', line 574

def record_path
  resource_path(record: record, resource: self)
end

#record_title ⇒ Object 



409
410
411
 
# File 'lib/avo/resources/base.rb', line 409

def record_title
  fetch_record_title.to_s
end

#records_path ⇒ Object 



578
579
580
 
# File 'lib/avo/resources/base.rb', line 578

def records_path
  resources_path(resource: self)
end

#resolve_component(original_component) ⇒ Object 



647
648
649
 
# File 'lib/avo/resources/base.rb', line 647

def resolve_component(original_component)
  custom_components.dig(original_component.to_s)&.to_s&.safe_constantize || original_component
end

#resource_type_array? ⇒ Boolean

Returns:

  • (Boolean) 


657
 
# File 'lib/avo/resources/base.rb', line 657

def resource_type_array? = false

#singular_model_key ⇒ Object 



570
571
572
 
# File 'lib/avo/resources/base.rb', line 570

def singular_model_key
  model_class.model_name.singular
end

#sort_by_param ⇒ Object 



659
660
661
662
663
664
665
666
667
 
# File 'lib/avo/resources/base.rb', line 659

def sort_by_param
  available_columns = model_class.column_names

  if available_columns.include?(default_sort_column.to_s)
    default_sort_column
  elsif available_columns.include?("created_at")
    :created_at
  end
end

#sorting_supported? ⇒ Boolean

Returns:

  • (Boolean) 


669
 
# File 'lib/avo/resources/base.rb', line 669

def sorting_supported? = true