feature: nested (#3738)

* wip

* wip

* wip

* nested controller

* translate avo.nested.add

* lint

* rubocop:disable Style/ArgumentsForwarding

* rename

* i18n

* keep nested fields position

* .

* lint / comment

* wip

* confurm

* nested_on

* fix bug

* refactor option as hash

* lint

Author: Paul-Bob

Diff for: app/components/avo/field_wrapper_component.html.erb

@@ -38,8 +38,8 @@
         </div>
       <% elsif on_edit? %>
         <%= content %>
-        <% if record.present? and record.errors.include? @field.id %>
-          <div class="text-red-600 mt-2 text-sm"><%= record.errors.full_messages_for(@field.id).to_sentence %></div>
+        <% if @field.record_errors.include?(@field.id) %>
+          <div class="text-red-600 mt-2 text-sm"><%= @field.record_errors.full_messages_for(@field.id).to_sentence %></div>
         <% end %>
         <% if help.present? %>
           <div class="text-gray-600 mt-2 text-sm"><%= sanitize help %></div>

Diff for: app/components/avo/fields/common/nested_field_component.html.erb

@@ -0,0 +1,6 @@
+<%= render Avo::Advanced::Nested::FieldComponent.new(
+  field: @field,
+  parent_resource: @field.resource,
+  view: @view,
+  form: @form
+) %>

Diff for: app/components/avo/fields/common/nested_field_component.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+class Avo::Fields::Common::NestedFieldComponent < Avo::BaseComponent
+  prop :field
+  prop :view
+  prop :form
+  prop :kwargs, kind: :**
+
+  def render?
+    Avo.plugin_manager.installed?("avo-advanced")
+  end
+end

Diff for: app/components/avo/items/switcher_component.rb

@@ -65,7 +65,7 @@ def tab_group_component
 
   def field_component
     final_item = item.dup.hydrate(resource: @resource, record: @resource.record, user: resource.user, view: view)
-    final_item.component_for_view(@view).new(field: final_item, resource: @resource, index: index, form: form, turbo_frame_loading: :lazy, **@field_component_extra_args)
+    final_item.component_for_view(@view).new(field: final_item, resource: @resource, index: index, form: form, view: @view, turbo_frame_loading: :lazy, **@field_component_extra_args)
   end
 
   def panel_component

Diff for: app/controllers/avo/base_controller.rb

@@ -3,6 +3,7 @@
 module Avo
   class BaseController < ApplicationController
     include Avo::Concerns::FiltersSessionHandler
+    include Avo::Concerns::SafeCall
 
     before_action :set_resource_name
     before_action :set_resource
@@ -285,7 +286,12 @@ def model_params
     end
 
     def permitted_params
-      @resource.get_field_definitions.select(&:updatable).map(&:to_permitted_param).concat(extra_params).uniq
+      @resource.get_field_definitions
+        .select(&:updatable)
+        .map(&:to_permitted_param)
+        .concat(extra_params)
+        .push(@resource.safe_call(:nested_params))
+        .uniq
     end
 
     def extra_params
@@ -577,10 +583,6 @@ def set_pagy_locale
       @pagy_locale = locale.to_s || Avo.configuration.default_locale || "en"
     end
 
-    def safe_call(method)
-      send(method) if respond_to?(method, true)
-    end
-
     def pagy_query
       @query
     end

Diff for: app/javascript/js/controllers.js

@@ -27,6 +27,7 @@ import MediaLibraryController from './controllers/media_library_controller'
 import MenuController from './controllers/menu_controller'
 import ModalController from './controllers/modal_controller'
 import MultipleSelectFilterController from './controllers/multiple_select_filter_controller'
+import NestedFormController from './controllers/nested_form_controller'
 import PanelRefreshController from './controllers/fields/panel_refresh_controller'
 import PerPageController from './controllers/per_page_controller'
 import PreviewController from './controllers/preview_controller'
@@ -64,31 +65,32 @@ application.register('dashboard-card', DashboardCardController)
 application.register('date-time-filter', DateTimeFilterController)
 application.register('filter', FilterController)
 application.register('form', FormController)
-application.register('panel-refresh', PanelRefreshController)
 application.register('hidden-input', HiddenInputController)
 application.register('input-autofocus', InputAutofocusController)
 application.register('item-select-all', ItemSelectAllController)
 application.register('item-selector', ItemSelectorController)
 application.register('loading-button', LoadingButtonController)
-application.register('media-library', MediaLibraryController)
 application.register('media-library-attach', MediaLibraryAttachController)
+application.register('media-library', MediaLibraryController)
 application.register('menu', MenuController)
 application.register('modal', ModalController)
 application.register('multiple-select-filter', MultipleSelectFilterController)
+application.register('nested-form', NestedFormController)
+application.register('panel-refresh', PanelRefreshController)
 application.register('per-page', PerPageController)
 application.register('preview', PreviewController)
 application.register('record-selector', RecordSelectorController)
 application.register('resource-edit', ResourceEditController)
 application.register('resource-index', ResourceIndexController)
 application.register('resource-show', ResourceShowController)
 application.register('search', SearchController)
-application.register('select', SelectController)
 application.register('select-filter', SelectFilterController)
+application.register('select', SelectController)
 application.register('self-destroy', SelfDestroyController)
 application.register('sidebar', SidebarController)
 application.register('sign-out', SignOutController)
-application.register('tabs', TabsController)
 application.register('table-row', TableRowController)
+application.register('tabs', TabsController)
 application.register('text-filter', TextFilterController)
 application.register('tippy', TippyController)
 application.register('toggle', ToggleController)
@@ -103,7 +105,7 @@ application.register('key-value', KeyValueController)
 application.register('progress-bar-field', ProgressBarFieldController)
 application.register('reload-belongs-to-field', ReloadBelongsToFieldController)
 application.register('tags-field', TagsFieldController)
-application.register('trix-field', TrixFieldController)
 application.register('tiptap-field', TiptapFieldController)
+application.register('trix-field', TrixFieldController)
 
 // Custom controllers

Diff for: app/javascript/js/controllers/nested_form_controller.js

@@ -0,0 +1,36 @@
+import NestedForm from 'stimulus-rails-nested-form'
+
+export default class extends NestedForm {
+  static targets = [
+    'addButton',
+    'removeButton',
+    'nestedRecord',
+  ]
+
+  static values = {
+    // `limit` restricts `has_one` to a single nested record or allows unlimited nesting.
+    // This could easily be extended into a configurable field option, allowing developers
+    // to specify a custom limit for nested records during creation.
+    // Default is 0 which is considered unlimited
+    limit: Number,
+    confirmMessage: String,
+  }
+
+  add(event) {
+    super.add(event)
+    this.toggleAddButton()
+  }
+
+  remove(event) {
+    if (confirm(this.confirmMessageValue)) {
+      super.remove(event)
+      this.toggleAddButton()
+    }
+  }
+
+  toggleAddButton() {
+    if (this.limitValue > 0) {
+      this.addButtonTarget.classList.toggle('hidden', this.nestedRecordTargets.length >= this.limitValue)
+    }
+  }
+}

Diff for: lib/avo/concerns/has_items.rb

@@ -116,16 +116,25 @@ def only_fields(only_root: false)
           end
 
           if item.is_row?
-            fields << extract_fields(tab)
+            fields << extract_fields(item)
           end
         end
 
         fields.flatten
       end
 
       def get_field_definitions(only_root: false)
-        only_fields(only_root: only_root).map do |field|
-          field.hydrate(resource: self, user: user, view: view)
+        only_fields(only_root:).map do |field|
+          # When nested field hydrate the field with the nested resource
+          resource = if field.try(:nested_on?, view)
+            Avo.resource_manager.get_resource_by_model_class(model_class.reflections[field.id.to_s].klass)
+              .new(view:, params:)
+              .detect_fields
+          else
+            self
+          end
+
+          field.hydrate(resource:, user:, view:)
         end
       end
 
@@ -273,6 +282,9 @@ def visible_items
               item.is_heading? ||
               item.is_a?(Avo::Fields::LocationField)
 
+            # Skip nested fields
+            next true if item.try(:nested_on?, view)
+
             item.resource.record.respond_to?(:"#{item.try(:for_attribute) || item.id}=")
           end
           .select do |item|
@@ -327,11 +339,17 @@ def is_standalone?(item)
       def hydrate_item(item)
         return unless item.respond_to? :hydrate
 
-        item.hydrate(
-          view: view,
-          # Use self when this is executed from a resource context, call resource otherwise.
-          resource: self.class.ancestors.include?(Avo::Resources::Base) ? self : resource
-        )
+        # Use self when this is executed from a resource context, call resource otherwise.
+        the_resource = self.class.ancestors.include?(Avo::Resources::Base) ? self : resource
+
+        if view.form? && item.try(:nested_on?, view)
+          nested_resource = Avo.resource_manager
+            .get_resource_by_model_class(the_resource.model_class.reflections[item.id.to_s].klass)
+            .new(view:)
+            .detect_fields
+        end
+
+        item.hydrate(view:, resource: nested_resource || the_resource)
       end
     end
   end

Diff for: lib/avo/concerns/safe_call.rb

@@ -0,0 +1,11 @@
+module Avo
+  module Concerns
+    module SafeCall
+      # rubocop:disable Style/ArgumentsForwarding
+      def safe_call(method, **kwargs)
+        send(method, **kwargs) if respond_to?(method, true)
+      end
+      # rubocop:enable Style/ArgumentsForwarding
+    end
+  end
+end

Diff for: lib/avo/fields/concerns/nested.rb

@@ -0,0 +1,49 @@
+# Adds the ability to set the visibility of an item in the execution context.
+module Avo
+  module Fields
+    module Concerns
+      module Nested
+        extend ActiveSupport::Concern
+
+        attr_reader :nested
+
+        unless defined?(NESTED_DEFAULT)
+          NESTED_DEFAULT = {
+            on: [:new, :edit]
+          }
+        end
+
+        def initialize_nested(**args)
+          if args[:nested].nil?
+            @nested = {}
+            return
+          end
+
+          @nested = (args[:nested] == true) ? NESTED_DEFAULT : args[:nested]
+
+          @nested[:on] = [:new, :edit] if @nested[:on] == :forms
+        end
+
+        def component_for_view(view = Avo::ViewInquirer.new("index"))
+          view = Avo::ViewInquirer.new(view)
+
+          nested_on?(view) ? Avo::Fields::Common::NestedFieldComponent : super(view)
+        end
+
+        def nested_on?(view)
+          return false if view.display? || @nested[:on].nil?
+
+          view = if view.create?
+            "new"
+          elsif view.update?
+            "edit"
+          else
+            view
+          end
+
+          Array.wrap(@nested[:on]).map(&:to_s).include?(view)
+        end
+      end
+    end
+  end
+end

Diff for: lib/avo/fields/has_one_field.rb

@@ -1,11 +1,25 @@
 module Avo
   module Fields
     class HasOneField < FrameBaseField
+      include Avo::Fields::Concerns::Nested
+
       attr_reader :attach_fields,
         :attach_scope
 
       def initialize(id, **args, &block)
-        hide_on :forms
+        initialize_nested(**args)
+
+        if @nested[:on]
+          nested_on = Array.wrap(@nested[:on])
+
+          if !nested_on.include?(:new)
+            hide_on :new
+          elsif !nested_on.include?(:edit)
+            hide_on :edit
+          end
+        else
+          hide_on :forms
+        end
 
         super(id, **args, &block)
 

Diff for: lib/avo/fields/many_frame_base_field.rb

@@ -2,6 +2,7 @@ module Avo
   module Fields
     class ManyFrameBaseField < FrameBaseField
       include Avo::Fields::Concerns::IsSearchable
+      include Avo::Fields::Concerns::Nested
 
       attr_reader :scope,
         :hide_search_input,
@@ -10,7 +11,17 @@ class ManyFrameBaseField < FrameBaseField
       def initialize(id, **args, &block)
         args[:updatable] = false
 
-        only_on Avo.configuration.resource_default_view
+        initialize_nested(**args)
+
+        if @nested[:on]
+          if Avo.configuration.resource_default_view.edit?
+            only_on Array.wrap(@nested[:on]) + [:edit]
+          else
+            only_on Array.wrap(@nested[:on]) + [:show]
+          end
+        else
+          only_on Avo.configuration.resource_default_view
+        end
 
         super(id, **args, &block)
 

Diff for: lib/avo/resources/base.rb

@@ -18,6 +18,7 @@ class Base
       include Avo::Concerns::Pagination
       include Avo::Concerns::HasDiscreetInformation
       include Avo::Concerns::RowControlsConfiguration
+      include Avo::Concerns::SafeCall
 
       # Avo::Current methods
       delegate :context, to: Avo::Current
@@ -451,8 +452,9 @@ def attachment_fields
       end
 
       # Map the received params to their actual fields
-      def fields_by_database_id
-        get_field_definitions
+      # 'resource' argument is used on avo-advanced, don't remove
+      def fields_by_database_id(resource: self)
+        resource.get_field_definitions
           .reject do |field|
             field.computed
           end
@@ -479,14 +481,14 @@ def fill_record(record, permitted_params, extra_params: [], fields: nil)
         # 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
+          # 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
 
-        record
+        safe_call(:fill_nested_records, record:, permitted_params:) || record
       end
 
       def authorization(user: nil)

Diff for: lib/generators/avo/templates/locales/avo.ar.yml

@@ -78,6 +78,8 @@ ar:
     more: المزيد
     more_content: المزيد من المحتوى
     more_records_available: هناك المزيد من السجلات المتاحة.
+    nested:
+      add_new_item: إضافة %{item} جديدة
     new: جديد
     next_page: الصفحة التالية
     no_cancel: لا، إلغاء

Diff for: lib/generators/avo/templates/locales/avo.de.yml

@@ -68,6 +68,8 @@ de:
     more: Mehr
     more_content: Mehr Inhalt
     more_records_available: Es sind weitere Datensätze verfügbar.
+    nested:
+      add_new_item: Neues %{item} hinzufügen
     new: neu
     next_page: Nächste Seite
     no_cancel: Nein, abbrechen