avo 1.20.1 → 1.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e21fad20822df8f410cc1a6eca03d840949a4acd6bee9e47ea320927fa9c253d
-  data.tar.gz: 61dc6595933b686526948f1ec9f7b37dfaad833f85928609d6bc296f9d6eb694
+  metadata.gz: ad998ae9691ee49081421f3db40c867fadf49c16d692722723277b43a631a1f7
+  data.tar.gz: 572ca7ed862e4e8bc3a784ed6c47402b5725ca9e99e286104f70739263e89590
 SHA512:
-  metadata.gz: 04c07e302dc1cd1ab911edeed99543ab93dd7b8f29ddf460dd42a85e828412b07f3a5f9fd113eeb520185f712b5586f2be89b2cc58271fe3762b26acc7cb3c73
-  data.tar.gz: '09968da7c74ed31cd98d3fe99ef64578bc26466b30db7d10a087ecc63424e42af2809f20c68df228637c4c54acd80e4144d35e64cb21df5d96833e14894c34f2'
+  metadata.gz: 3d69b2cb4c5691376fb8b3e7fcb26fabadde724d1de17fd015d03b94ddb4f833423bd018f033db10b02ad0c773d9151199d9c63acccdc59b707c9f8b18d42d8c
+  data.tar.gz: 40d1d605818269b2af621b3c4640a35117e4f53463151c0e339860ca763d8d8a04a7df4a56c1fa4f43ad8e8fa039ef61518055015bcc4d194cfaddcf430f048e

data/Gemfile

@@ -30,7 +30,7 @@ gem "rails", "~> 6.1.0"
 # Use postgresql as the database for Active Record
 gem "pg", ">= 0.18", "< 2.0"
 # Use Puma as the app server
-gem "puma", "~> 5.5.1"
+gem "puma", "~> 5.6.2"
 # Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
 # gem "jbuilder", "~> 2.7"
 # Use Redis adapter to run Action Cable in production
@@ -77,6 +77,8 @@ group :development do
   # gem 'ruby-prof'
 
   # gem 'pry-rails'
+
+  gem 'htmlbeautifier'
 end
 
 group :development, :test do

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    avo (1.20.1)
+    avo (1.21.0)
       active_link_to
       addressable
       breadcrumbs_on_rails
@@ -175,6 +175,7 @@ GEM
       rails (>= 6.0.0)
       stimulus-rails
       turbo-rails
+    htmlbeautifier (1.4.1)
     httparty (0.20.0)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
@@ -237,7 +238,7 @@ GEM
       ast (~> 2.4.1)
     pg (1.3.1)
     public_suffix (4.0.6)
-    puma (5.5.2)
+    puma (5.6.2)
       nio4r (~> 2.0)
     pundit (2.1.1)
       activesupport (>= 3.0.0)
@@ -417,6 +418,7 @@ DEPENDENCIES
   fuubar
   gem-release
   hotwire-rails
+  htmlbeautifier
   httparty
   image_processing (~> 1.2)
   iso
@@ -427,7 +429,7 @@ DEPENDENCIES
   meta-tags
   net-smtp
   pg (>= 0.18, < 2.0)
-  puma (~> 5.5.1)
+  puma (~> 5.6.2)
   pundit
   rails (~> 6.1.0)
   rails-controller-testing

data/app/assets/svgs/x.svg

@@ -0,0 +1,3 @@
+<svg xmlns="http://www.w3.org/2000/svg" class="h-6 w-6" fill="none" viewBox="0 0 24 24" stroke="currentColor">
+  <path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M6 18L18 6M6 6l12 12" />
+</svg>

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

@@ -0,0 +1,22 @@
+<div data-controller="search" class="resource-search flex items-center h-full w-full" data-turbo-remove-before-cache>
+  <div class="w-full hidden"
+    data-search-target="autocomplete"
+    data-search-resource="<%= @model_key %>"
+    data-translation-keys='{"no_item_found": "<%= I18n.translate 'avo.no_item_found' %>"}'
+    data-via-association="belongs_to"
+  ></div>
+  <div class="relative w-full" autocomplete="off">
+    <%= @form.text_field @field.foreign_key,
+      value: field_label,
+      class: helpers.input_classes('w-full', has_error: @field.model_errors.include?(@field.id)), 'data-search-target': 'button clearValue',
+      placeholder: @field.placeholder,
+      disabled: true %>
+    <div class="absolute top-1/2 left-auto right-3 mr-px -mt-2 cursor-pointer hidden text-gray-500"
+      data-tippy="tooltip"
+      data-search-target="clearButton"
+      title="<%= I18n.translate 'avo.clear_value' %>"
+      data-action="click->search#clearValue"
+      ><%= helpers.svg 'x', class: 'h-4' %></div>
+  </div>
+  <%= @form.hidden_field @foreign_key, value: field_value, 'data-search-target': 'hiddenId clearValue' %>
+</div>

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+class Avo::Fields::BelongsToField::AutocompleteComponent < ViewComponent::Base
+  def initialize(form:, field:, type: nil, model_key:, foreign_key:)
+    @form = form
+    @field = field
+    @type = type
+    @model_key = model_key
+    @foreign_key = foreign_key
+  end
+
+  def field_label
+    if searchable?
+      @field.value&.class == @type ? @field.field_label : nil
+    else
+      @field.field_label
+    end
+  end
+
+  def field_value
+    if searchable?
+      @field.value&.class == @type ? @field.field_value : nil
+    else
+      @field.field_value
+    end
+  end
+
+  private
+
+  def searchable?
+    @type.present?
+  end
+end

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

@@ -1,22 +1,34 @@
-<% if @field.types.present? %>
-  <div data-controller="belongs-to-field">
+<%
+  if @field.types.present? # It's a polymorphic association
+
+  # Set the model keys so we can pass them over
+  model_keys = @field.types.map do |type|
+    resource = Avo::App.get_resource_by_model_name(type.to_s)
+    [type.to_s, resource.model_key]
+  end.to_h
+%>
+  <div data-controller="belongs-to-field"
+    data-searchable="<%= @field.searchable %>"
+    data-association="<%= @field.id %>"
+    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] },
         {
+          value: @field.value,
           include_blank: @field.placeholder,
         },
         {
           class: helpers.input_classes('w-full', has_error: @field.model_errors.include?(@field.id)),
           disabled: disabled,
           'data-belongs-to-field-target': "select",
-          'data-action': 'change->belongs-to-field#changedType'
+          'data-action': 'change->belongs-to-field#changeType'
         }
         %>
       <%
         # 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
-      %>
+        if disabled %>
         <%= @form.hidden_field "#{@field.foreign_key}_type" %>
       <% end %>
     <% end %>
@@ -26,21 +38,18 @@
         data-type="<%= type %>"
       >
         <%= edit_field_wrapper field: @field, index: @index, form: @form, resource: @resource, displayed_in_modal: @displayed_in_modal, label: type.to_s.underscore.humanize do %>
-          <%= @form.select "#{@field.foreign_key}_id", @field.values_for_type(type),
-            {
-              include_blank: @field.placeholder,
-            },
-            {
-              class: helpers.input_classes('w-full', has_error: @field.model_errors.include?(@field.id)),
-              disabled: disabled
-            }
+          <% if @field.searchable %>
+            <%= render Avo::Fields::BelongsToField::AutocompleteComponent.new form: @form, field: @field, type: type, model_key: model_keys[type.to_s], foreign_key: "#{@field.foreign_key}_id" %>
+          <% else %>
+            <%= @form.select "#{@field.foreign_key}_id", options_for_select(@field.values_for_type(type), @field.value&.class == type ? @field.field_value : nil),
+              {
+                include_blank: @field.placeholder,
+              },
+              {
+                class: helpers.input_classes('w-full', has_error: @field.model_errors.include?(@field.id)),
+                disabled: disabled
+              }
             %>
-          <%
-            # 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" %>
           <% end %>
         <% end %>
       </div>
@@ -48,21 +57,18 @@
   </div>
 <% else %>
   <%= edit_field_wrapper field: @field, index: @index, form: @form, resource: @resource, displayed_in_modal: @displayed_in_modal do %>
-    <%= @form.select @field.foreign_key, @field.options.map { |o| [o[:label], o[:value]] },
-      {
-        include_blank: @field.placeholder,
-      },
-      {
-        class: helpers.input_classes('w-full', has_error: @field.model_errors.include?(@field.id)),
-        disabled: disabled
-      }
+    <% if @field.searchable %>
+      <%= render Avo::Fields::BelongsToField::AutocompleteComponent.new form: @form, field: @field, model_key: @field.target_resource&.model_key, foreign_key: @field.foreign_key %>
+    <% else %>
+      <%= @form.select @field.foreign_key, @field.options.map { |o| [o[:label], o[:value]] },
+        {
+          include_blank: @field.placeholder,
+        },
+        {
+          class: helpers.input_classes('w-full', has_error: @field.model_errors.include?(@field.id)),
+          disabled: disabled
+        }
       %>
-    <%
-      # 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 %>
     <% end %>
   <% end %>
 <% end %>

data/app/components/avo/fields/common/files_list_viewer_component.html.erb

@@ -1,5 +1,5 @@
 <div class="relative p-3 bg-slate-200 grid grid-cols-3 xl:grid-cols-4 gap-3 rounded-xl">
   <% @field.value.attachments.each do |file| %>
-    <%= render Avo::Fields::Common::MultipleFileViewerComponent.new id: @field.id, file: file, is_image: @field.is_image, button_size: :xs, resource: @resource %>
+    <%= render Avo::Fields::Common::MultipleFileViewerComponent.new id: @field.id, file: file, is_image: @field.is_image, is_audio: @field.is_audio, button_size: :xs, resource: @resource %>
   <% end %>
 </div>

data/app/components/avo/fields/common/multiple_file_viewer_component.html.erb

@@ -2,6 +2,8 @@
   <% if @file.present? %>
     <% if @file.representable? && @is_image %>
       <%= image_tag helpers.main_app.url_for(@file), class: 'rounded-lg max-h-168 max-w-full' %>
+    <% elsif @is_audio %>
+      <%= audio_tag(helpers.main_app.url_for(@file), controls: true, preload: false, class: 'w-full')%>
     <% else %>
       <div class="relative flex flex-col justify-evenly items-center px-2 rounded-lg border bg-white border-gray-500 py-6 flex-1">
         <div class="flex flex-col justify-center items-center w-full">

data/app/components/avo/fields/common/multiple_file_viewer_component.rb

@@ -3,10 +3,11 @@
 class Avo::Fields::Common::MultipleFileViewerComponent < ViewComponent::Base
   include Avo::ApplicationHelper
 
-  def initialize(id:, file:, is_image:, direct_upload: false, resource:, button_size: :md)
+  def initialize(id:, file:, is_image:, is_audio:, direct_upload: false, resource:, button_size: :md)
     @id = id
     @file = file
     @is_image = is_image
+    @is_audio = is_audio
     @direct_upload = direct_upload
     @button_size = button_size
     @resource = resource

data/app/components/avo/fields/common/single_file_viewer_component.html.erb

@@ -2,6 +2,8 @@
   <% if @file.present? %>
     <% if @file.representable? && @is_image %>
       <%= image_tag helpers.main_app.url_for(@file), class: 'rounded-lg max-h-168 max-w-full' %>
+    <% elsif @is_audio %>
+      <%= audio_tag(helpers.main_app.url_for(@file), controls: true, preload: false, class: 'w-full')%>
     <% else %>
       <div class="relative flex flex-col justify-evenly items-center px-2 rounded-lg border bg-white border-gray-500 min-h-48">
         <div class="flex flex-col justify-center items-center w-full">

data/app/components/avo/fields/common/single_file_viewer_component.rb

@@ -3,10 +3,11 @@
 class Avo::Fields::Common::SingleFileViewerComponent < ViewComponent::Base
   include Avo::ApplicationHelper
 
-  def initialize(id:, file:, is_image:, direct_upload: false, resource:, button_size: :md)
+  def initialize(id:, file:, is_image:, is_audio:, direct_upload: false, resource:, button_size: :md)
     @id = id
     @file = file
     @is_image = is_image
+    @is_audio = is_audio
     @direct_upload = direct_upload
     @button_size = button_size
     @resource = resource

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

@@ -1,7 +1,7 @@
 <%= edit_field_wrapper field: @field, index: @index, form: @form, resource: @resource, displayed_in_modal: @displayed_in_modal do %>
   <% if @field.value.present? %>
     <div class="mb-2">
-      <%= render Avo::Fields::Common::SingleFileViewerComponent.new resource: @resource, id: @field.id, file: @field.value, is_image: @field.is_image, button_size: :md %>
+      <%= render Avo::Fields::Common::SingleFileViewerComponent.new resource: @resource, id: @field.id, file: @field.value, is_image: @field.is_image, is_audio: @field.is_audio, button_size: :md %>
     </div>
   <% end %>
 

data/app/components/avo/fields/file_field/index_component.html.erb

@@ -1,7 +1,9 @@
 <%= index_field_wrapper field: @field do %>
   <% if @field.value.present? %>
     <% if @field.value.attached? && @field.value.representable? && @field.is_image %>
-      <%= link_to_if @field.link_to_resource, image_tag(helpers.main_app.url_for(@field.value), class: 'max-h-full'), resource_path, class: 'block h-8' %>
+      <%= link_to_if @field.link_to_resource, image_tag(helpers.main_app.url_for(@field.value), class: 'max-h-full'), resource_path, class: 'block' %>
+    <% elsif @field.value.attached? && @field.is_audio %>
+      <%= link_to_if @field.link_to_resource, audio_tag(helpers.main_app.url_for(@field.value), controls: true, preload: false, class: 'max-h-full'), resource_path, class: 'block h-8' %>
     <% else %>
       <%= @field.value.filename %>
     <% end %>

data/app/components/avo/fields/file_field/show_component.html.erb

@@ -1,3 +1,3 @@
 <%= show_field_wrapper field: @field do %>
-  <%= render Avo::Fields::Common::SingleFileViewerComponent.new resource: @resource, id: @field.id, file: @field.value.attachment, is_image: @field.is_image, button_size: :md %>
+  <%= render Avo::Fields::Common::SingleFileViewerComponent.new resource: @resource, id: @field.id, file: @field.value.attachment, is_image: @field.is_image, is_audio: @field.is_audio,  button_size: :md %>
 <% end %>

data/app/components/avo/resource_component.rb

@@ -16,6 +16,7 @@ class Avo::ResourceComponent < ViewComponent::Base
 
     if @reflection.present?
       reflection_resource = ::Avo::App.get_resource_by_model_name(@reflection.active_record.name)
+      reflection_resource.hydrate(model: @parent_model) if @parent_model.present?
       association_name = params['related_name']
 
       if association_name.present?

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

@@ -24,7 +24,7 @@
         data-selected-resources="[]"
       >
         <div class="flex items-center px-6 w-64">
-          <%= render partial: 'avo/partials/resource_search', locals: {resource: @resource.model_class.model_name.plural} if @resource.search_query.present? %>
+          <%= render partial: 'avo/partials/resource_search', locals: {resource: @resource.model_key} if @resource.search_query.present? %>
         </div>
         <div class="flex justify-end items-center px-6 space-x-3">
           <%= render partial: 'avo/partials/view_toggle_button', locals: { available_view_types: available_view_types, view_type: view_type, turbo_frame: @turbo_frame } if @models.present? %>

data/app/controllers/avo/relations_controller.rb

@@ -4,11 +4,11 @@ module Avo
   class RelationsController < BaseController
     before_action :set_model, only: [:show, :index, :new, :create, :destroy]
     before_action :set_related_resource_name
-    before_action :set_related_resource
-    before_action :hydrate_related_resource
+    before_action :set_related_resource, only: [:show, :index, :new, :create, :destroy]
+    before_action :hydrate_related_resource, only: [:show, :index, :new, :create, :destroy]
     before_action :set_related_model, only: [:show]
-    before_action :set_attachment_class
-    before_action :set_attachment_resource
+    before_action :set_attachment_class, only: [:show, :index, :new, :create, :destroy]
+    before_action :set_attachment_resource, only: [:show, :index, :new, :create, :destroy]
     before_action :set_attachment_model, only: [:create, :destroy]
     before_action :set_reflection, only: [:index, :show]
 

data/app/controllers/avo/search_controller.rb

@@ -60,7 +60,6 @@ module Avo
           _id: model.id,
           _label: resource.label,
           _url: resource.record_path,
-          model: model
         }
 
         if App.license.has_with_trial(:enhanced_search_results)

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

@@ -1,65 +1,128 @@
 import { Controller } from 'stimulus'
 
 export default class extends Controller {
-  static targets = ['select', 'type']
+  static targets = ['select', 'type', 'loadAssociationLink'];
+
+  defaults = {};
 
   get selectedType() {
     return this.selectTarget.value
   }
 
-  connect() {
-    this.setValidNames()
-    this.changedType()
+  get isSearchable() {
+    return this.context.scope.element.dataset.searchable === 'true'
   }
 
-  setValidNames() {
-    this.typeTargets.forEach((target) => {
-      const { type } = target.dataset
-      const select = target.querySelector('select')
-      const name = select.getAttribute('name')
+  get association() {
+    return this.context.scope.element.dataset.association
+  }
 
-      select.setAttribute('valid-name', name)
-      if (this.selectedType !== type) {
-        select.selectedIndex = 0
-      }
-    })
+  get associationClass() {
+    return this.context.scope.element.dataset.associationClass
   }
 
-  changedType() {
-    this.hideAllTypeTargets()
-    this.enableType(this.selectTarget.value)
+  connect() {
+    this.copyValidNames()
+    this.changeType() // Do the initial type change
   }
 
-  hideAllTypeTargets() {
+  changeType() {
+    this.hideAllTypes()
+    this.showType(this.selectTarget.value)
+  }
+
+  // Private
+
+  hideAllTypes() {
     this.typeTargets.forEach((target) => {
-      this.hideTarget(target)
+      target.classList.add('hidden')
+
       this.invalidateTarget(target)
     })
   }
 
-  hideTarget(target) {
-    target.classList.add('hidden')
-  }
+  /**
+   * Used for invalidating select fields when switching between types so they don't automatically override the previous id.
+   * Ex: There are two types Article and Project and the Comment has commentable_id 3 and commentable_type: Article
+   * When you change the type from Project to Article the Project field will override the commentable_id value
+   * because it was rendered later (alphabetical sorting) and the browser will pick that one up.
+   * So we go and copy the name attribute to valid-name for all types and then copy it back to name when the user selects it.
+   */
 
-  invalidateTarget(target) {
-    const select = target.querySelector('select')
+  /**
+   * This method does the initial copying from name to valid-name.
+   */
+  copyValidNames() {
+    this.typeTargets.forEach((target) => {
+      const { type } = target.dataset
 
-    select.setAttribute('name', '')
-  }
+      if (this.isSearchable) {
+        const textInput = target.querySelector('input[type="text"]')
+        if (textInput) {
+          textInput.setAttribute('valid-name', textInput.getAttribute('name'))
+        }
 
-  validateTarget(target) {
-    const select = target.querySelector('select')
-    const validName = select.getAttribute('valid-name')
+        const hiddenInput = target.querySelector('input[type="hidden"]')
+        if (hiddenInput) {
+          hiddenInput.setAttribute(
+            'valid-name',
+            hiddenInput.getAttribute('name'),
+          )
+        }
+      } else {
+        const select = target.querySelector('select')
+        if (select) {
+          select.setAttribute('valid-name', select.getAttribute('name'))
+        }
 
-    select.setAttribute('name', validName)
+        if (this.selectedType !== type) {
+          select.selectedIndex = 0
+        }
+      }
+    })
   }
 
-  enableType(type) {
-    const target = this.typeTargets.find((typeTarget) => typeTarget.dataset.type === type)
-
+  showType(type) {
+    const target = this.typeTargets.find(
+      (typeTarget) => typeTarget.dataset.type === type,
+    )
     if (target) {
       target.classList.remove('hidden')
+
       this.validateTarget(target)
     }
   }
+
+  /**
+   * Copy value from `valid-name` to `name`
+   */
+  validateTarget(target) {
+    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'))
+    } else {
+      const select = target.querySelector('select')
+      select.setAttribute('name', select.getAttribute('valid-name'))
+    }
+  }
+
+  /**
+   * nullify the `name` attribute
+   */
+  invalidateTarget(target) {
+    if (this.isSearchable) {
+      // Wrapping it in a try/catch to counter turbo's cache system (going back to the edit page after initial save)
+      try {
+        target.querySelector('input[type="text"]').setAttribute('name', '')
+        target.querySelector('input[type="hidden"]').setAttribute('name', '')
+      } catch {}
+    } else if (target) {
+      try {
+        target.querySelector('select').setAttribute('name', '')
+      } catch (error) {}
+    }
+  }
 }