avo 1.22.1.pre.1 → 1.22.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2f085164d251b53a73da2c5b3cf9c10e0aca42c908a9c3ca468514b02a0f4bf
-  data.tar.gz: e5191a70ef9847c7015435d90b848a9659a4d720d222d4dcd3ab35ddcda96df1
+  metadata.gz: d1b3e02ee566af1fcf8ac642f0b59693fc9ca60840f5a57e46c0e57df32831c9
+  data.tar.gz: 621dc29f10b4693db5e09531fb7cd8cd591666e0be8d098d3927a48e0e2cb0dd
 SHA512:
-  metadata.gz: 1f441c0b258365c4d8d5539f0ec7debf9810ad7efb30252ebf072bf167754e8f20ff6438c39f6b5f75453d732765227280797d51753fb1048d64b1168e1f2821
-  data.tar.gz: 064a57f7a9211ca10a1bf84aa04efe673b9d67b4eb70b2e10cbf63233cb50c9fc309b66ebcb05bbebadc60bd6d39d6712c18755b3f1192af510753e169fca9ca
+  metadata.gz: 325009723e404b72ab8ff8cde8c0491ecf4c520b075b7731ee837c56998f1c45d57b50805ebbce1358dfff3b9f7e6b8a53d3ada14a9fe365523a6a3f077dbf29
+  data.tar.gz: de4a2bcb927f0d1eb4053185e3683c0d44d06c0fce7848f3740edaee52cdabfc3c6a5cde067b6ad9f8506013ea8eb214639073e19793cc9fc4e51b72bbdcaf38

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    avo (1.22.1.pre.1)
+    avo (1.22.2)
       active_link_to
       addressable
       breadcrumbs_on_rails
@@ -215,7 +215,7 @@ GEM
     mime-types-data (3.2022.0105)
     mini_magick (4.11.0)
     mini_mime (1.1.2)
-    mini_portile2 (2.7.1)
+    mini_portile2 (2.8.0)
     minitest (5.15.0)
     msgpack (1.4.4)
     multi_xml (0.6.0)
@@ -227,8 +227,8 @@ GEM
       net-protocol
       timeout
     nio4r (2.5.8)
-    nokogiri (1.13.1)
-      mini_portile2 (~> 2.7.0)
+    nokogiri (1.13.3)
+      mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
     orm_adapter (0.5.0)
     pagy (5.10.1)

data/app/components/avo/fields/belongs_to_field/autocomplete_component.rb

@@ -13,35 +13,35 @@ class Avo::Fields::BelongsToField::AutocompleteComponent < ViewComponent::Base
   end
 
   def field_label
-    if searchable?
-      # New records won't have the value (instantiated model) present but the polymorphic_type and polymorphic_id prefilled
-      if new_record? && has_polymorphic_association?
-        @polymorphic_record.send(polymorphic_fields[:label])
-      else
-        @field.value&.class == @type ? @field.field_label : nil
-      end
-    else
-      @field.field_label
+    result = @field.field_label
+
+    # New records won't have the value (instantiated model) present but the polymorphic_type and polymorphic_id prefilled
+    if should_prefill?
+      result = @field.value&.class == @type ? @field.field_label : nil
     end
+
+    result
   end
 
   def field_value
-    if searchable?
-      # New records won't have the value (instantiated model) present but the polymorphic_type and polymorphic_id prefilled
-      if new_record? && has_polymorphic_association?
-        @polymorphic_record.send(polymorphic_fields[:id])
-      else
-        @field.value&.class == @type ? @field.field_value : nil
-      end
-    else
-      @field.field_value
+    result = @field.field_value
+
+    # New records won't have the value (instantiated model) present but the polymorphic_type and polymorphic_id prefilled
+    if should_prefill?
+      result = @field.value&.class == @type ? @field.field_value : nil
     end
+
+    result
   end
 
   private
 
+  def should_prefill?
+    @field.is_polymorphic? && searchable? && !(new_record? && has_polymorphic_association?)
+  end
+
   def searchable?
-    @type.present?
+    @field.searchable
   end
 
   def new_record?

data/app/components/avo/fields/belongs_to_field/edit_component.html.erb

@@ -13,7 +13,7 @@
     data-association-class="<%= @field&.target_resource&.model_class || nil %>"
   >
   <%= edit_field_wrapper field: @field, index: @index, form: @form, resource: @resource, displayed_in_modal: @displayed_in_modal do %>
-    <%= @form.select "#{@field.foreign_key}_type", @field.types.map { |type| [type.to_s.underscore.humanize, type.to_s] },
+    <%= @form.select @field.type_input_foreign_key, @field.types.map { |type| [type.to_s.underscore.humanize, type.to_s] },
       {
         value: @field.value,
         include_blank: @field.placeholder,
@@ -29,7 +29,7 @@
         # If the select field is disabled, no value will be sent. It's how HTML works.
         # Thus the extra hidden field to actually send the related id to the server.
         if disabled %>
-      <%= @form.hidden_field "#{@field.foreign_key}_type" %>
+      <%= @form.hidden_field @field.type_input_foreign_key %>
     <% end %>
   <% end %>
   <% @field.types.each do |type| %>
@@ -43,15 +43,16 @@
             field: @field,
             type: type,
             model_key: model_keys[type.to_s],
-            foreign_key: "#{@field.foreign_key}_id",
+            foreign_key: @field.id_input_foreign_key,
             resource: @resource,
             disabled: disabled,
             polymorphic_record: polymorphic_record
           %>
         <% else %>
-          <%= @form.select "#{@field.foreign_key}_id", options_for_select(@field.values_for_type(type), @resource.present? && @resource.model.present? ? @resource.model["#{@field.foreign_key}_id"] : nil),
+          <%= @form.select @field.id_input_foreign_key,
+            options_for_select(@field.values_for_type(type), @resource.present? && @resource.model.present? ? @resource.model[@field.id_input_foreign_key] : nil),
             {
-              value: @resource.model["#{@field.foreign_key}_id"].to_s,
+              value: @resource.model[@field.id_input_foreign_key].to_s,
               include_blank: @field.placeholder,
             },
             {
@@ -63,7 +64,7 @@
             # If the select field is disabled, no value will be sent. It's how HTML works.
             # Thus the extra hidden field to actually send the related id to the server.
             if disabled %>
-              <%= @form.hidden_field "#{@field.foreign_key}_id" %>
+              <%= @form.hidden_field @field.id_input_foreign_key %>
             <% end %>
         <% end %>
       <% end %>
@@ -76,12 +77,12 @@
       <%= render Avo::Fields::BelongsToField::AutocompleteComponent.new form: @form,
         field: @field,
         model_key: @field.target_resource&.model_key,
-        foreign_key: @field.foreign_key,
+        foreign_key: @field.id_input_foreign_key,
         resource: @resource,
         disabled: disabled
       %>
     <% else %>
-      <%= @form.select @field.foreign_key, @field.options.map { |o| [o[:label], o[:value]] },
+      <%= @form.select @field.id_input_foreign_key, @field.options,
         {
           include_blank: @field.placeholder,
           value: @field.value
@@ -95,7 +96,7 @@
         # If the select field is disabled, no value will be sent. It's how HTML works.
         # Thus the extra hidden field to actually send the related id to the server.
         if disabled %>
-        <%= @form.hidden_field @field.foreign_key %>
+        <%= @form.hidden_field @field.id_input_foreign_key %>
       <% end %>
     <% end %>
   <% end %>

data/app/components/avo/fields/select_field/edit_component.html.erb

@@ -1,6 +1,6 @@
 <%= edit_field_wrapper field: @field, index: @index, form: @form, resource: @resource, displayed_in_modal: @displayed_in_modal do %>
   <%= @form.select @field.id, @field.options_for_select, { selected: @field.value, prompt: @field.placeholder }, {
-      class: helpers.input_classes(' w-full', has_error: @field.model_errors.include?(@field.id)),
-      disabled: @field.readonly,
-      value: @field.model.present? ? @field.model[@field.id] : @field.value } %>
+    class: helpers.input_classes(' w-full', has_error: @field.model_errors.include?(@field.id)),
+    disabled: @field.readonly,
+    value: @field.model.present? ? @field.model[@field.id] : @field.value } %>
 <% end %>

data/app/controllers/avo/base_controller.rb

@@ -84,6 +84,7 @@ module Avo
     def new
       @model = @resource.model_class.new
       @resource = @resource.hydrate(model: @model, view: :new, user: _current_user)
+      # abort @model.course.inspect
 
       @page_title = @resource.default_panel_name
       add_breadcrumb resource_name.humanize, resources_path(resource: @resource)

data/app/controllers/avo/relations_controller.rb

@@ -37,10 +37,7 @@ module Avo
       query = @authorization.apply_policy @attachment_class
 
       @options = query.all.map do |model|
-        {
-          value: model.id,
-          label: model.send(@attachment_resource.class.title)
-        }
+        [model.send(@attachment_resource.class.title), model.id]
       end
     end
 

data/app/javascript/avo.js

@@ -59,6 +59,7 @@ document.addEventListener('turbo:before-fetch-response', (e) => {
 })
 document.addEventListener('turbo:visit', () => document.body.classList.add('turbo-loading'))
 document.addEventListener('turbo:submit-start', () => document.body.classList.add('turbo-loading'))
+document.addEventListener('turbo:submit-end', () => document.body.classList.remove('turbo-loading'))
 document.addEventListener('turbo:before-cache', () => {
   document.querySelectorAll('[data-turbo-remove-before-cache]').forEach((element) => element.remove())
 })

data/app/javascript/js/controllers/fields/belongs_to_field_controller.js

@@ -58,29 +58,16 @@ export default class extends Controller {
 
       if (this.isSearchable) {
         const textInput = target.querySelector('input[type="text"]')
-        if (textInput) {
-          textInput.setAttribute('valid-name', textInput.getAttribute('name'))
-        }
+        if (textInput) this.nameToValidName(textInput)
 
         const hiddenInput = target.querySelector('input[type="hidden"]')
-        if (hiddenInput) {
-          hiddenInput.setAttribute(
-            'valid-name',
-            hiddenInput.getAttribute('name'),
-          )
-        }
+        if (hiddenInput) this.nameToValidName(hiddenInput)
       } else {
         const select = target.querySelector('select')
-        if (select) {
-          select.setAttribute('valid-name', select.getAttribute('name'))
-        }
+        if (select) this.nameToValidName(select)
+
         const hiddenInput = target.querySelector('input[type="hidden"]')
-        if (hiddenInput) {
-          hiddenInput.setAttribute(
-            'valid-name',
-            hiddenInput.getAttribute('name'),
-          )
-        }
+        if (hiddenInput) this.nameToValidName(hiddenInput)
 
         if (this.selectedType !== type) {
           select.selectedIndex = 0
@@ -108,13 +95,16 @@ export default class extends Controller {
       const textInput = target.querySelector('input[type="text"]')
       const hiddenInput = target.querySelector('input[type="hidden"]')
 
-      textInput.setAttribute('name', textInput.getAttribute('valid-name'))
-      hiddenInput.setAttribute('name', hiddenInput.getAttribute('valid-name'))
+      this.validNameToName(textInput)
+      this.validNameToName(hiddenInput)
     } else {
       const select = target.querySelector('select')
       const hiddenInput = target.querySelector('input[type="hidden"]')
-      select.setAttribute('name', select.getAttribute('valid-name'))
-      hiddenInput.setAttribute('name', hiddenInput.getAttribute('valid-name'))
+      this.validNameToName(select)
+
+      if (hiddenInput) {
+        this.validNameToName(hiddenInput)
+      }
     }
   }
 
@@ -135,4 +125,12 @@ export default class extends Controller {
       } catch (error) {}
     }
   }
+
+  validNameToName(target) {
+    target.setAttribute('name', target.getAttribute('valid-name'))
+  }
+
+  nameToValidName(target) {
+    target.setAttribute('valid-name', target.getAttribute('name'))
+  }
 }

data/app/views/avo/partials/_turbo_frame_wrap.html.erb

@@ -3,7 +3,7 @@
     # When rendering the frames the flashed content gets lost.
     # By including the alerts partial, the stimulus will pick them up and display them to the user.
   %>
-  <%= render partial: 'avo/partials/alerts'if flash.present? if flash.present? %>
+  <%= render partial: 'avo/partials/alerts' if flash.present? && name.present? %>
 
   <%= yield %>
 <% if name.present? %></turbo-frame><% end %>

data/app/views/avo/relations/new.html.erb

@@ -11,7 +11,7 @@
 
       <div class="flex-1 flex items-center justify-center px-8 text-lg mt-8 mb-12">
         <div class="flex-1 flex flex-col items-center justify-center px-24 text-base">
-          <%= form.select :related_id, options_for_select(@options.map { |o| [o[:label], o[:value]] }, nil),
+          <%= form.select :related_id, options_for_select(@options, nil),
             {
               include_blank: t('avo.choose_an_option'),
             },

data/db/factories.rb

@@ -17,7 +17,7 @@ FactoryBot.define do
   end
 
   factory :post do
-    name { Faker::Quote.unique.famous_last_words }
+    name { Faker::Quote.famous_last_words }
     body { Faker::Lorem.paragraphs(number: rand(4...10)).join("\n") }
     is_featured { [true, false].sample }
     published_at do
@@ -42,11 +42,11 @@ FactoryBot.define do
   end
 
   factory :comment do
-    body { Faker::Lorem.paragraphs(number: rand(4...10)).join("\n") }
+    body { Faker::Lorem.paragraphs(number: rand(4...10)).join(' ') }
   end
 
   factory :review do
-    body { Faker::Lorem.paragraphs(number: rand(4...10)).join("\n") }
+    body { Faker::Lorem.paragraphs(number: rand(4...10)).join(' ') }
   end
 
   factory :person do

data/lib/avo/base_resource.rb

@@ -127,23 +127,29 @@ module Avo
           field.visible?
         end
         .select do |field|
+          is_valid = true
+
           # Strip out the reflection field in index queries with a parent association.
           if reflection.present?
-            if reflection.options.present? &&
-                field.respond_to?(:polymorphic_as) &&
-                field.polymorphic_as.to_s == reflection.options[:as].to_s
-              next
-            end
-
-            if field.respond_to?(:foreign_key) &&
-                reflection.respond_to?(:foreign_key) &&
-                reflection.foreign_key != field.foreign_key &&
-                @params[:resource_name] == field.resource.model_key
-              next
+            # regular non-polymorphic association
+            # we're matching the reflection inverse_of foriegn key with the field's foreign_key
+            if field.is_a?(Avo::Fields::BelongsToField)
+              if field.respond_to?(:foreign_key) &&
+                reflection.inverse_of.foreign_key == field.foreign_key
+                is_valid = false
+              end
+
+              # polymorphic association
+              if field.respond_to?(:foreign_key) &&
+                field.is_polymorphic? &&
+                reflection.respond_to?(:polymorphic?) &&
+                reflection.inverse_of.foreign_key == field.reflection.foreign_key
+                is_valid = false
+              end
             end
           end
 
-          true
+          is_valid
         end
 
       if panel.present?

data/lib/avo/fields/base_field.rb

@@ -128,11 +128,14 @@ module Avo
         # Get model value
         final_value = @model.send(property) if (model_or_class(@model) == "model") && @model.respond_to?(property)
 
+        # On new views and actions modals we need to prefill the fields
         if (@view === :new) || @action.present?
-          final_value = if default.present? && default.respond_to?(:call)
-            default.call
-          else
-            default
+          if default.present?
+            final_value = if default.respond_to?(:call)
+              default.call
+            else
+              default
+            end
           end
         end
 

data/lib/avo/fields/belongs_to_field.rb

@@ -1,5 +1,62 @@
 module Avo
   module Fields
+
+    # The field can be in multiple scenarios where it needs different types of data and displays the state differently.
+    # For example the non-polymorphic, non-searchable variant is the easiest to support. You only need to populate a simple select with the ID of the associated record and the list of records.
+    # For the searchable polymorphic variant you need to provide the type of the association (Post, Project, Team), the label of the associated record ("Cool post title") and the ID of that record.
+    # Furthermore, the way Avo works, it needs to do some queries on the back-end to fetch the required information.
+    #
+    # Field scenarios:
+    # 1. Create new record
+    #   List of records
+    # 2. Create new record as association
+    #   List of records, the ID
+    # 3. Create new searchable record
+    #   Nothing really. The records will be fetched from the search API
+    # 4. Create new searchable record as association
+    #   The associated record label and ID. The records will be fetched from the search API
+    # 5. Create new polymorphic record
+    #   Type & ID
+    # 6. Create new polymorphic record as association
+    #   Type, list of records, and ID
+    # 7. Create new polymorphic searchable record
+    #   Type, Label and ID
+    # 8. Create new polymorphic searchable record as association
+    #   Type, Label and ID
+    # 9. Edit a record
+    #   List of records & ID
+    # 10. Edit a record as searchable
+    #   Label and ID
+    # 11. Edit a record as an association
+    #   List and ID
+    # 12. Edit a record as an searchable association
+    #   Label and ID
+    # 13. Edit a polymorphic record
+    #   Type, List of records & ID
+    # 14. Edit a polymorphic record as searchable
+    #   Type, Label and ID
+    # 15. Edit a polymorphic record as an association
+    #   Type, List and ID
+    # 16. Edit a polymorphic record as an searchable association
+    #   Type, Label and ID
+    # Also all of the above with a namespaced model `Course/Link`
+
+    # Variants
+    # 1. Select belongs to
+    # 2. Searchable belongs to
+    # 3. Select Polymorphic belongs to
+    # 4. Searchable Polymorphic belongs to
+
+    # Requirements
+    # - list
+    # - ID
+    # - label
+    # - Type
+    # - foreign_key
+    # - foreign_key for poly type
+    # - foreign_key for poly id
+    # - is_disabled?
+
     class BelongsToField < BaseField
       attr_reader :polymorphic_as
       attr_reader :relation_method
@@ -21,7 +78,13 @@ module Avo
       end
 
       def value
-        super(polymorphic_as)
+        if is_polymorphic?
+          # Get the value from the pre-filled assoociation record
+          super(polymorphic_as)
+        else
+          # Get the value from the pre-filled assoociation record
+          super(relation_method)
+        end
       end
 
       # The value
@@ -39,22 +102,42 @@ module Avo
       end
 
       def options
-        ::Avo::Services::AuthorizationService.apply_policy(user, target_resource.class.query_scope).all.map do |model|
-          {
-            value: model.id,
-            label: model.send(target_resource.class.title)
-          }
-        end
+        values_for_type
       end
 
-      def values_for_type(type)
-        ::Avo::Services::AuthorizationService.apply_policy(user, type).all.map do |model|
-          [model.send(App.get_resource_by_model_name(type).class.title), model.id]
+      def values_for_type(model = nil)
+        resource = target_resource
+        resource = App.get_resource_by_model_name model if model.present?
+
+        ::Avo::Services::AuthorizationService.apply_policy(user, resource.class.query_scope).all.map do |model|
+          [model.send(resource.class.title), model.id]
         end
       end
 
       def database_value
         target_resource.id
+      rescue
+        nil
+      end
+
+      def type_input_foreign_key
+        if is_polymorphic?
+          "#{foreign_key}_type"
+        end
+      end
+
+      def id_input_foreign_key
+        if is_polymorphic?
+          "#{foreign_key}_id"
+        else
+          foreign_key
+        end
+      end
+
+      def is_polymorphic?
+        polymorphic_as.present?
+      rescue
+        false
       end
 
       def foreign_key
@@ -73,6 +156,13 @@ module Avo
         nil
       end
 
+      # Get the model reflection instance
+      def reflection
+        reflection_for_key(id)
+      rescue
+        nil
+      end
+
       def relation_model_class
         @resource.model_class
       end
@@ -118,7 +208,7 @@ module Avo
       end
 
       def target_resource
-        if polymorphic_as.present?
+        if is_polymorphic?
           if value.present?
             return App.get_resource_by_model_name(value.class)
           else

data/lib/avo/version.rb

@@ -1,3 +1,3 @@
 module Avo
-  VERSION = "1.22.1.pre.1"
+  VERSION = "1.22.2"
 end

data/public/avo-assets/avo.js

@@ -81101,22 +81101,18 @@
         const { type } = target.dataset;
         if (this.isSearchable) {
           const textInput = target.querySelector('input[type="text"]');
-          if (textInput) {
-            textInput.setAttribute("valid-name", textInput.getAttribute("name"));
-          }
+          if (textInput)
+            this.nameToValidName(textInput);
           const hiddenInput = target.querySelector('input[type="hidden"]');
-          if (hiddenInput) {
-            hiddenInput.setAttribute("valid-name", hiddenInput.getAttribute("name"));
-          }
+          if (hiddenInput)
+            this.nameToValidName(hiddenInput);
         } else {
           const select = target.querySelector("select");
-          if (select) {
-            select.setAttribute("valid-name", select.getAttribute("name"));
-          }
+          if (select)
+            this.nameToValidName(select);
           const hiddenInput = target.querySelector('input[type="hidden"]');
-          if (hiddenInput) {
-            hiddenInput.setAttribute("valid-name", hiddenInput.getAttribute("name"));
-          }
+          if (hiddenInput)
+            this.nameToValidName(hiddenInput);
           if (this.selectedType !== type) {
             select.selectedIndex = 0;
           }
@@ -81134,13 +81130,15 @@
       if (this.isSearchable) {
         const textInput = target.querySelector('input[type="text"]');
         const hiddenInput = target.querySelector('input[type="hidden"]');
-        textInput.setAttribute("name", textInput.getAttribute("valid-name"));
-        hiddenInput.setAttribute("name", hiddenInput.getAttribute("valid-name"));
+        this.validNameToName(textInput);
+        this.validNameToName(hiddenInput);
       } else {
         const select = target.querySelector("select");
         const hiddenInput = target.querySelector('input[type="hidden"]');
-        select.setAttribute("name", select.getAttribute("valid-name"));
-        hiddenInput.setAttribute("name", hiddenInput.getAttribute("valid-name"));
+        this.validNameToName(select);
+        if (hiddenInput) {
+          this.validNameToName(hiddenInput);
+        }
       }
     }
     invalidateTarget(target) {
@@ -81158,6 +81156,12 @@
         }
       }
     }
+    validNameToName(target) {
+      target.setAttribute("name", target.getAttribute("valid-name"));
+    }
+    nameToValidName(target) {
+      target.setAttribute("valid-name", target.getAttribute("name"));
+    }
   };
   __publicField(belongs_to_field_controller_default, "targets", ["select", "type", "loadAssociationLink"]);
 
@@ -87796,6 +87800,7 @@
   });
   document.addEventListener("turbo:visit", () => document.body.classList.add("turbo-loading"));
   document.addEventListener("turbo:submit-start", () => document.body.classList.add("turbo-loading"));
+  document.addEventListener("turbo:submit-end", () => document.body.classList.remove("turbo-loading"));
   document.addEventListener("turbo:before-cache", () => {
     document.querySelectorAll("[data-turbo-remove-before-cache]").forEach((element) => element.remove());
   });