Class: Avo::Resources::Base

Inherits:
Object
  • Object
show all
Extended by:
ActiveSupport::DescendantsTracker
Includes:
ActionView::Helpers::UrlHelper, Concerns::AbstractResource, 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, Concerns::SafeCall
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::SafeCall

#safe_call

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.



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/avo/resources/base.rb', line 268

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.



53
54
55
 
# File 'lib/avo/resources/base.rb', line 53

def record
  @record
end

#reflection ⇒ Object

Returns the value of attribute reflection.



51
52
53
 
# File 'lib/avo/resources/base.rb', line 51

def reflection
  @reflection
end

#user ⇒ Object

Returns the value of attribute user.



52
53
54
 
# File 'lib/avo/resources/base.rb', line 52

def user
  @user
end

#view ⇒ Object

Returns the value of attribute view.



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

def view
  @view
end

Class Method Details

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



99
100
101
 
# File 'lib/avo/resources/base.rb', line 99

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

.authorization ⇒ Object 



128
129
130
 
# File 'lib/avo/resources/base.rb', line 128

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

.class_name ⇒ Object 



173
174
175
 
# File 'lib/avo/resources/base.rb', line 173

def class_name
  @class_name ||= to_s.demodulize
end

.fetch_search(key, record: nil) ⇒ Object 



251
252
253
254
 
# File 'lib/avo/resources/base.rb', line 251

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 



103
104
105
 
# File 'lib/avo/resources/base.rb', line 103

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

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



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/avo/resources/base.rb', line 222

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.



124
125
126
 
# File 'lib/avo/resources/base.rb', line 124

def find_scope
  authorization.apply_policy model_class
end

.get_available_models ⇒ Object 



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

def get_available_models
  ApplicationRecord.descendants
end

.get_model_by_name(model_name) ⇒ Object 



144
145
146
147
148
 
# File 'lib/avo/resources/base.rb', line 144

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



154
155
156
157
158
159
160
161
162
163
 
# File 'lib/avo/resources/base.rb', line 154

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



169
170
171
 
# File 'lib/avo/resources/base.rb', line 169

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

.name ⇒ Object Also known as: singular_name 



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

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"



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

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

.navigation_label ⇒ Object 



218
219
220
 
# File 'lib/avo/resources/base.rb', line 218

def navigation_label
  plural_name.humanize
end

.plural_name ⇒ Object 



195
196
197
 
# File 'lib/avo/resources/base.rb', line 195

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.



114
115
116
117
118
119
 
# File 'lib/avo/resources/base.rb', line 114

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

.route_key ⇒ Object 



177
178
179
 
# File 'lib/avo/resources/base.rb', line 177

def route_key
  class_name.underscore.pluralize
end

.scope(scope_class) ⇒ Object 



107
108
109
 
# File 'lib/avo/resources/base.rb', line 107

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

.search_query ⇒ Object 



243
244
245
 
# File 'lib/avo/resources/base.rb', line 243

def search_query
  search.dig(:query)
end

.search_results_count ⇒ Object 



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

def search_results_count
  search.dig(:results_count)
end

.singular_route_key ⇒ Object 



181
182
183
 
# File 'lib/avo/resources/base.rb', line 181

def singular_route_key
  route_key.singularize
end

.translation_key ⇒ Object 



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

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

.underscore_name ⇒ Object 



214
215
216
 
# File 'lib/avo/resources/base.rb', line 214

def underscore_name
  name.demodulize.underscore
end

.valid_association_name(record, association_name) ⇒ Object 



132
133
134
 
# File 'lib/avo/resources/base.rb', line 132

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 



136
137
138
 
# File 'lib/avo/resources/base.rb', line 136

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 



453
454
455
456
457
 
# File 'lib/avo/resources/base.rb', line 453

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

#authorization(user: nil) ⇒ Object 



499
500
501
502
 
# File 'lib/avo/resources/base.rb', line 499

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 



434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'lib/avo/resources/base.rb', line 434

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 



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

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 



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

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

#avatar_type ⇒ Object 



607
608
609
610
611
 
# File 'lib/avo/resources/base.rb', line 607

def avatar_type
  avatar_field.as_avatar
rescue
  nil
end

#cache_hash(parent_record) ⇒ Object 



525
526
527
528
529
530
531
532
533
 
# File 'lib/avo/resources/base.rb', line 525

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

  if parent_record.present?
    result << parent_record
  end

  result
end

#current_user ⇒ Object 



28
29
30
 
# File 'lib/avo/resources/base.rb', line 28

def current_user
  Avo::Current.user
end

#custom_components ⇒ Object 



645
646
647
648
649
650
651
652
 
# File 'lib/avo/resources/base.rb', line 645

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 



392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/avo/resources/base.rb', line 392

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 



629
630
631
632
633
634
635
 
# File 'lib/avo/resources/base.rb', line 629

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

#detect_fields ⇒ Object 



286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/avo/resources/base.rb', line 286

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 



333
334
335
 
# File 'lib/avo/resources/base.rb', line 333

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

#entity_loader(entity) ⇒ Object 



637
638
639
 
# File 'lib/avo/resources/base.rb', line 637

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

#fetch_cards ⇒ Object 



329
330
331
 
# File 'lib/avo/resources/base.rb', line 329

def fetch_cards
  cards
end

#fetch_fields ⇒ Object 



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/avo/resources/base.rb', line 310

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 



419
420
421
422
423
424
425
426
427
428
429
430
431
432
 
# File 'lib/avo/resources/base.rb', line 419

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(resource: self) ⇒ Object

Map the received params to their actual fields ‘resource’ argument is used on avo-advanced, don’t remove



461
462
463
464
465
466
467
468
469
470
 
# File 'lib/avo/resources/base.rb', line 461

def fields_by_database_id(resource: self)
  resource.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 



504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
 
# File 'lib/avo/resources/base.rb', line 504

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 



521
522
523
 
# File 'lib/avo/resources/base.rb', line 521

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

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



472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
 
# File 'lib/avo/resources/base.rb', line 472

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 permitted, 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

  safe_call(:fill_nested_records, record:, permitted_params:) || record
end

#form_scope ⇒ Object 



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

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

#get_external_link ⇒ Object 



658
659
660
661
662
 
# File 'lib/avo/resources/base.rb', line 658

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) 


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

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

#hydrate ⇒ Object 



382
383
384
385
386
387
388
389
390
 
# File 'lib/avo/resources/base.rb', line 382

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.



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
565
566
567
568
569
570
571
 
# File 'lib/avo/resources/base.rb', line 536

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 



621
622
623
 
# File 'lib/avo/resources/base.rb', line 621

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.



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

def model_class
  record_class = @record&.class

  self.class.model_class record_class: record_class
end

#model_name ⇒ Object 



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

def model_name
  model_class.model_name
end

#record_id ⇒ Object 



625
626
627
 
# File 'lib/avo/resources/base.rb', line 625

def record_id
  record.send(id_attribute)
end

#record_param ⇒ Object 



641
642
643
 
# File 'lib/avo/resources/base.rb', line 641

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

#record_path ⇒ Object 



581
582
583
 
# File 'lib/avo/resources/base.rb', line 581

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

#record_title ⇒ Object 



415
416
417
 
# File 'lib/avo/resources/base.rb', line 415

def record_title
  fetch_record_title.to_s
end

#records_path ⇒ Object 



585
586
587
 
# File 'lib/avo/resources/base.rb', line 585

def records_path
  resources_path(resource: self)
end

#resolve_component(original_component) ⇒ Object 



654
655
656
 
# File 'lib/avo/resources/base.rb', line 654

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) 


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

def resource_type_array? = false

#singular_model_key ⇒ Object 



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

def singular_model_key
  model_class.model_name.singular
end

#sort_by_param ⇒ Object 



666
667
668
669
670
671
672
673
674
 
# File 'lib/avo/resources/base.rb', line 666

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) 


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

def sorting_supported? = true