feature: array adapter (#3469)

* feature: array adapter

* update ovei list

* wip: hide unsupported actions, implement show view

* some lint

* revert indentation

* lint

* lint

* rm `ActiveRecordResource` for now

* wip

* rm ostruct requirement

* make it work with array of active records

* has_many field array option

* lint

* fix

* fix flaky test

* fix flaky test

* prepare dummy for tests

* lint

* index tests

* lint & flaky test

* lint

* more tests

* lint

* wait_for_loaded on associations

* rm copyable

* rm comments

* array resource check

* using_wait_time capybara

* .

* fix test

* .

* fix test

* fix test

* wip

* wip

* wip

* wip

* wip

* fix test

* refactor wip

* refactor still wip

* fix test

* wip refactor

* lint

* Revert "wip refactor"

This reverts commit 431435d.

* re-try

* Revert "Revert "wip refactor""

This reverts commit c4884bc.

* re-add display

* rm display

* add description

* fix habtm

* fix attach_fields on has one

* is_searchable?

* add attach_scope to has one field

* rbac changes

* lint

* lint

* minor tweaks

---------

Co-authored-by: Paul Bob <[email protected]>
Co-authored-by: Paul Bob <[email protected]>

Author: adrianthedev

app/components/avo/index/resource_controls_component.rb

@@ -16,6 +16,9 @@ def can_detach?
   end
 
   def can_edit?
+    # Disable edit for ArrayResources
+    return false if @resource.resource_type_array?
+
     return authorize_association_for(:edit) if @reflection.present?
 
     @resource.authorization.authorize_action(:edit, raise_exception: false)

app/components/avo/index/table_row_component.html.erb

@@ -41,7 +41,7 @@
         parent_resource: @parent_resource
       ) %>
     <% else %>
-      <td class="text-center">—</td>
+      <td class="px-3">—</td>
     <% end %>
   <% end %>
   <% if @resource.resource_controls_render_on_the_right? %>

app/components/avo/resource_component.rb

@@ -40,12 +40,18 @@ def detach_path
   end
 
   def can_see_the_edit_button?
+    # Disable edit for ArrayResources
+    return false if @resource.resource_type_array?
+
     return authorize_association_for(:edit) if @reflection.present?
 
     @resource.authorization.authorize_action(:edit, raise_exception: false)
   end
 
   def can_see_the_destroy_button?
+    # Disable destroy for ArrayResources
+    return false if @resource.resource_type_array?
+
     @resource.authorization.authorize_action(:destroy, raise_exception: false)
   end
 

app/components/avo/views/resource_index_component.html.erb

@@ -11,7 +11,7 @@
       description: description,
       cover_photo: resource.cover_photo,
       data: {component: "resources-index"},
-      display_breadcrumbs: @reflection.blank? || (@reflection.present? && !helpers.turbo_frame_request?)
+      display_breadcrumbs: (@reflection.blank? && @parent_resource.blank?) || (@reflection.present? && !helpers.turbo_frame_request?)
     ) do |c| %>
     <% c.with_name_slot do %>
       <%= render Avo::PanelNameComponent.new name: title, url: (params[:turbo_frame].present? && linkable?) ? field.frame_url(add_turbo_frame: false) : nil, target: :_blank do |panel_name_component| %>

app/components/avo/views/resource_index_component.rb

@@ -40,6 +40,9 @@ def available_view_types
   # 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.
   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

app/controllers/avo/array_controller.rb

@@ -0,0 +1,7 @@
+module Avo
+  class ArrayController < BaseController
+    def set_query
+      @query ||= @resource.fetch_records
+    end
+  end
+end

app/controllers/avo/associations_controller.rb

@@ -24,8 +24,20 @@ def index
       @resource = @related_resource
       @parent_record = @parent_resource.find_record(params[:id], params: params)
       @parent_resource.hydrate(record: @parent_record)
-      association_name = BaseResource.valid_association_name(@parent_record, association_from_params)
-      @query = @related_authorization.apply_policy @parent_record.send(association_name)
+
+      # When array field the records are fetched from the field block, from the parent record or from the resource def records
+      # When other field type, like has_many the @query is directly fetched from the parent record
+      # Don't apply policy on array type since it can return an array of hashes where `.all` and other methods used on policy will fail.
+      @query = if @field.type == "array"
+        @resource.fetch_records(Avo::ExecutionContext.new(target: @field.block).handle || @parent_record.try(@field.id))
+      else
+        @related_authorization.apply_policy(
+          @parent_record.send(
+            BaseResource.valid_association_name(@parent_record, association_from_params)
+          )
+        )
+      end
+
       @association_field = find_association_field(resource: @parent_resource, association: params[:related_name])
 
       if @association_field.present? && @association_field.scope.present?
@@ -125,7 +137,8 @@ def set_reflection
     end
 
     def set_attachment_class
-      @attachment_class = @reflection.klass
+      # @reflection is nil whe using an Array field.
+      @attachment_class = @reflection&.klass
     end
 
     def set_attachment_resource

app/controllers/avo/base_application_controller.rb

@@ -84,19 +84,6 @@ def resource
       Avo.resource_manager.get_resource_by_controller_name @resource_name
     end
 
-    def related_resource
-      # Find the field from the parent resource
-      field = find_association_field(resource: @resource, association: params[:related_name])
-
-      return field.use_resource if field&.use_resource.present?
-
-      reflection = @record.class.reflect_on_association(field&.for_attribute || params[:related_name])
-
-      reflected_model = reflection.klass
-
-      Avo.resource_manager.get_resource_by_model_class reflected_model
-    end
-
     def set_resource_name
       @resource_name = resource_name
     end
@@ -118,6 +105,11 @@ def detect_fields
     end
 
     def set_related_resource
+      # Find the field from the parent resource
+      related_resource = find_association_field(resource: @resource, association: params[:related_name])
+        .hydrate(record: @record)
+        .resource_class(params)
+
       raise Avo::MissingResourceError.new(related_resource_name) if related_resource.nil?
 
       action_view = action_name.to_sym

app/controllers/avo/base_controller.rb

@@ -28,11 +28,7 @@ def index
       set_index_params
       set_filters
       set_actions
-
-      # If we don't get a query object predefined from a child controller like associations, just spin one up
-      unless defined? @query
-        @query = @resource.class.query_scope
-      end
+      set_query
 
       # Eager load the associations
       if @resource.includes.present?
@@ -46,7 +42,7 @@ def index
         end
       end
 
-      apply_sorting
+      apply_sorting if @index_params[:sort_by]
 
       # Apply filters to the current query
       filters_to_be_applied.each do |filter_class, filter_value|
@@ -310,18 +306,7 @@ def set_index_params
       set_pagination_params
 
       # Sorting
-      if params[:sort_by].present?
-        @index_params[:sort_by] = params[:sort_by]
-      elsif @resource.model_class.present?
-        available_columns = @resource.model_class.column_names
-        default_sort_column = @resource.default_sort_column
-
-        if available_columns.include?(default_sort_column.to_s)
-          @index_params[:sort_by] = default_sort_column
-        elsif available_columns.include?("created_at")
-          @index_params[:sort_by] = :created_at
-        end
-      end
+      @index_params[:sort_by] = params[:sort_by] || @resource.sort_by_param
 
       @index_params[:sort_direction] = params[:sort_direction] || @resource.default_sort_direction
 
@@ -608,8 +593,6 @@ def apply_pagination
     end
 
     def apply_sorting
-      return if @index_params[:sort_by].nil?
-
       sort_by = @index_params[:sort_by].to_sym
       if sort_by != :created_at
         @query = @query.unscope(:order)
@@ -650,5 +633,10 @@ def set_pagination_params
 
       @index_params[:per_page] = cookies[:per_page] || Avo.configuration.per_page
     end
+
+    # If we don't get a query object predefined from a child controller like associations, just spin one up
+    def set_query
+      @query ||= @resource.class.query_scope
+    end
   end
 end

app/views/avo/partials/_table_header.html.erb

@@ -28,9 +28,10 @@
   <% fields.each_with_index do |field, index|  %>
     <%
       first_option = Avo.configuration.first_sorting_option.to_s
-      second_option = first_option == "desc" ? "asc" : "desc"
 
       if params[:sort_by] == field.id.to_s
+        second_option = first_option == "desc" ? "asc" : "desc"
+
         if params[:sort_direction] == second_option
           sort_by = nil
         else
@@ -65,7 +66,7 @@
       } do %>
       <%= content_tag :div,
         class: "relative flex items-center justify-between w-full" do %>
-        <% if field.sortable %>
+        <% if field.sortable && @resource.sorting_supported? %>
           <%= link_to params.permit!.merge(sort_by: sort_by, sort_direction: sort_direction),
             class: class_names("flex-1 flex justify-between", text_classes),
             'data-turbo-frame': params[:turbo_frame] do %>