avo 1.6.4.pre.1 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76444abfc4fae22802837e03aa92b0d16558983c096d0c865208fc783ca1e01a
-  data.tar.gz: 6c8e39471f030161b642511418122425356f8678bbfcda531104160e4836d6b4
+  metadata.gz: e58bf8c94a89819523d1ef5abf6390ea2fb754d589c434a5de0d9daef0a231d0
+  data.tar.gz: 4662ea67f1f2653a495617d02ea279ed919889d33c599642394ca3f35e726f1b
 SHA512:
-  metadata.gz: 4bba3763a17001a1a7706cb65b2c95ec73907293af9f446f8b0aa51e0ecd0d1e00f52953a49e9fc9450834584ec620ea77b86a68e1dade07ac5190cf5fade154
-  data.tar.gz: 6d0cf9a063eb31f6db21198efc0d9ac80654193901bbd2734074b267aa9a147561502e7f1a5585dfdba0de47680dfa5809c69078012518932ea5561043516f19
+  metadata.gz: 6743f19e795f59bed7ac32436e67a73a8bfbfdb7d267dd12de510d93d64bfe7f592cf400c1aef2e1cab4538ada6b614191aac596ecd3f19444b9ef0fb42e8518
+  data.tar.gz: 16360a9602b08cc7f973cddda9106546c6cded669ce9592d80b6b647a0e53ec1f3d74468f8d04c8db632610059e234552b3b5debfa444489af0b4090677e4e96

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    avo (1.6.4.pre.1)
+    avo (1.7.0)
       active_link_to
       addressable
       breadcrumbs_on_rails
@@ -333,7 +333,7 @@ GEM
       thread_safe (~> 0.1)
     unicode-display_width (2.0.0)
     unicode_utils (1.4.0)
-    view_component (2.28.0)
+    view_component (2.32.0)
       activesupport (>= 5.0.0, < 7.0)
     warden (1.2.9)
       rack (>= 2.0.9)

data/README.md

@@ -56,6 +56,6 @@ $ bundle install
 
 Please read [CONTRIBUTING.MD](./CONTRIBUTING.MD)
 
-# Upgrade guide
+# Upgrade Guide
 
-Please read the [UPGRADE_GUIDE.MD](https://docs.avohq.io/0.5.x/upgrade.html)
+Please read the [UPGRADE_GUIDE.MD](https://docs.avohq.io/1.0/upgrade.html)

data/app/components/avo/edit/field_wrapper_component.html.erb

@@ -1,7 +1,7 @@
 <div class="flex items-center py-0 leading-tight <%= @classes %> min-h-16" data-field-id="<%= @field.id %>" data-field-type="<%= @field.type %>">
   <div class="h-16 flex self-start items-center text-blue-gray-800">
     <div class="<% if @displayed_in_modal %> md:w-48 <% else %> md:w-64 <% end %> w-48 px-8 flex" data-slot="label">
-      <%= @form.label @field.id, @field.name %> <% if @field.required %> <span class="text-red-600">*</span> <% end %>
+      <%= @form.label @field.id, label %> <% if @field.required %> <span class="text-red-600">*</span> <% end %>
     </div>
   </div>
   <div class="flex-1 flex flex-row min-h-inherit">

data/app/components/avo/edit/field_wrapper_component.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class Avo::Edit::FieldWrapperComponent < ViewComponent::Base
-  def initialize(field: nil, dash_if_blank: true, full_width: false, displayed_in_modal: false, form: nil, resource: {}, **args)
+  def initialize(field: nil, dash_if_blank: true, full_width: false, displayed_in_modal: false, form: nil, resource: {}, label: nil, **args)
     @field = field
     @dash_if_blank = dash_if_blank
     @classes = args[:class].present? ? args[:class] : ""
@@ -11,9 +11,14 @@ class Avo::Edit::FieldWrapperComponent < ViewComponent::Base
     @resource = resource
     @model = resource.present? ? resource.model : nil
     @full_width = full_width
+    @label = label
 
     if (@index != 0) || @displayed_in_modal
       @classes += " border-t"
     end
   end
+
+  def label
+    @label || @field.name
+  end
 end

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

@@ -1,18 +1,68 @@
-<%= 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.types.present? %>
+  <div data-controller="belongs-to-field">
+    <%= 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] },
+        {
+          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'
+        }
+        %>
+      <%
+        # 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" %>
+      <% end %>
+    <% end %>
+    <% @field.types.each do |type| %>
+      <div class="hidden"
+        data-belongs-to-field-target="type"
+        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 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>
+    <% end %>
+  </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 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 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.foreign_key %>
+    <% end %>
   <% end %>
 <% end %>

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

@@ -3,7 +3,7 @@
 class Avo::Fields::BelongsToField::EditComponent < Avo::Fields::EditComponent
   def disabled
     return true if @field.readonly
-    return true if @field.target_resource.model_class.name == params[:via_resource_class]
+    return true if @field.target_resource.present? && @field.target_resource.model_class.name == params[:via_resource_class]
     return true if @field.id.to_s == params[:via_relation].to_s
 
     false

data/app/controllers/avo/base_controller.rb

@@ -21,6 +21,11 @@ module Avo
         @query = @authorization.apply_policy @resource.model_class
       end
 
+      # Remove default_scope for index view
+      if @resource.unscoped_queries_on_index
+        @query = @query.unscoped
+      end
+
       # Eager load the relations
       if @resource.includes.present?
         @query = @query.includes(*@resource.includes)

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

@@ -0,0 +1,65 @@
+import { Controller } from 'stimulus'
+
+export default class extends Controller {
+  static targets = ['select', 'type']
+
+  get selectedType() {
+    return this.selectTarget.value
+  }
+
+  connect() {
+    this.setValidNames()
+    this.changedType()
+  }
+
+  setValidNames() {
+    this.typeTargets.forEach((target) => {
+      const { type } = target.dataset
+      const select = target.querySelector('select')
+      const name = select.getAttribute('name')
+
+      select.setAttribute('valid-name', name)
+      if (this.selectedType !== type) {
+        select.selectedIndex = 0
+      }
+    })
+  }
+
+  changedType() {
+    this.hideAllTypeTargets()
+    this.enableType(this.selectTarget.value)
+  }
+
+  hideAllTypeTargets() {
+    this.typeTargets.forEach((target) => {
+      this.hideTarget(target)
+      this.invalidateTarget(target)
+    })
+  }
+
+  hideTarget(target) {
+    target.classList.add('hidden')
+  }
+
+  invalidateTarget(target) {
+    const select = target.querySelector('select')
+
+    select.setAttribute('name', '')
+  }
+
+  validateTarget(target) {
+    const select = target.querySelector('select')
+    const validName = select.getAttribute('valid-name')
+
+    select.setAttribute('name', validName)
+  }
+
+  enableType(type) {
+    const target = this.typeTargets.find((typeTarget) => typeTarget.dataset.type === type)
+
+    if (target) {
+      target.classList.remove('hidden')
+      this.validateTarget(target)
+    }
+  }
+}

data/db/factories.rb

@@ -40,4 +40,8 @@ FactoryBot.define do
     meta { [{foo: "bar", hey: "hi"}, {bar: "baz"}, {hoho: "hohoho"}].sample }
     progress { Faker::Number.between(from: 0, to: 100) }
   end
+
+  factory :comment do
+    body { Faker::Lorem.paragraphs(number: rand(4...10)).join("\n") }
+  end
 end

data/lib/avo/base_resource.rb

@@ -22,6 +22,7 @@ module Avo
     class_attribute :fields
     class_attribute :grid_loader
     class_attribute :visible_on_sidebar, default: true
+    class_attribute :unscoped_queries_on_index, default: false
 
     class << self
       def grid(&block)
@@ -87,20 +88,30 @@ module Avo
     end
 
     def get_fields(panel: nil, reflection: nil)
-      fields = get_field_definitions.select do |field|
-        field.send("show_on_#{@view}")
-      end
+      fields = get_field_definitions
+        .select do |field|
+          field.send("show_on_#{@view}")
+        end
         .select do |field|
-                 field.visible?
-               end
+          field.visible?
+        end
         .select do |field|
-        unless field.respond_to?(:foreign_key) &&
-            reflection.present? &&
-            reflection.respond_to?(:foreign_key) &&
-            reflection.foreign_key == field.foreign_key
+          # Strip out the reflection field in index queries with a parent association.
+          if reflection.present? &&
+              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.present? &&
+              reflection.respond_to?(:foreign_key) &&
+              reflection.foreign_key != field.foreign_key
+            next
+          end
+
           true
         end
-      end
 
       if panel.present?
         fields = fields.select do |field|
@@ -216,28 +227,6 @@ module Avo
       self.class.context
     end
 
-    def query_search(via_resource_name:, via_resource_id:, user:, query: "")
-      # model_class = self.model
-
-      db_query = AuthorizationService.apply_policy(user, model_class)
-
-      if via_resource_name.present?
-        related_model = App.get_resource_by_name(via_resource_name).model
-
-        db_query = related_model.find(via_resource_id).public_send(plural_name.downcase)
-      end
-
-      new_query = []
-
-      [search].flatten.each_with_index do |search_by, index|
-        new_query.push "or" if index != 0
-
-        new_query.push "text(#{search_by}) ILIKE '%#{query}%'"
-      end
-
-      db_query.where(new_query.join(" "))
-    end
-
     def attached_file_fields
       get_field_definitions.select do |field|
         [Avo::Fields::FileField, Avo::Fields::FilesField].include? field.class
@@ -250,14 +239,17 @@ module Avo
         .reject do |field|
           field.computed
         end
-        .map { |field| [field.database_id(model).to_s, field] }.to_h
+        .map do |field|
+          [field.database_id(model).to_s, field]
+        end
+        .to_h
 
       params.each do |key, value|
         field = fields_by_database_id[key]
 
         next unless field.present?
 
-        model = field.fill_field model, key, value
+        model = field.fill_field model, key, value, params
       end
 
       model
@@ -295,19 +287,22 @@ module Avo
 
     # We will not overwrite any attributes that come pre-filled in the model.
     def hydrate_model_with_default_values
-      default_values = get_fields.select do |field|
-        !field.computed
-      end
+      default_values = get_fields
+        .select do |field|
+          !field.computed
+        end
         .map do |field|
           id = field.id
           value = field.value
 
-          if field.respond_to? :foreign_key
+          if field.type == "belongs_to"
             id = field.foreign_key.to_sym
 
             reflection = @model._reflections[@params[:via_relation]]
 
-            if reflection.present? && reflection.foreign_key.present? && field.id.to_s == @params[:via_relation].to_s
+            if field.polymorphic_as.present? && field.types.map(&:to_s).include?(@params["via_relation_class"])
+              value = @params["via_relation_class"].safe_constantize.find(@params[:via_resource_id])
+            elsif reflection.present? && reflection.foreign_key.present? && field.id.to_s == @params[:via_relation].to_s
               value = @params[:via_resource_id]
             end
           end
@@ -316,8 +311,8 @@ module Avo
         end
         .to_h
         .select do |id, value|
-        value.present?
-      end
+          value.present?
+        end
 
       default_values.each do |id, value|
         if @model.send(id).nil?

data/lib/avo/fields/base_field.rb

@@ -91,9 +91,11 @@ module Avo
         end
       end
 
-      def value
+      def value(property = nil)
+        property ||= id
+
         # Get model value
-        final_value = @model.send(id) if (model_or_class(@model) == "model") && @model.respond_to?(id)
+        final_value = @model.send(property) if (model_or_class(@model) == "model") && @model.respond_to?(property)
 
         if (@view === :new) || @action.present?
           final_value = if default.present? && default.respond_to?(:call)
@@ -114,7 +116,7 @@ module Avo
         final_value
       end
 
-      def fill_field(model, key, value)
+      def fill_field(model, key, value, params)
         return model unless model.methods.include? key.to_sym
 
         model.send("#{key}=", value)

data/lib/avo/fields/belongs_to_field.rb

@@ -2,7 +2,9 @@ module Avo
   module Fields
     class BelongsToField < BaseField
       attr_reader :searchable
+      attr_reader :polymorphic_as
       attr_reader :relation_method
+      attr_reader :types
 
       def initialize(id, **args, &block)
         args[:placeholder] ||= I18n.t("avo.choose_an_option")
@@ -10,11 +12,17 @@ module Avo
         super(id, **args, &block)
 
         @searchable = args[:searchable] == true
+        @polymorphic_as = args[:polymorphic_as]
+        @types = args[:types]
         @relation_method = name.to_s.parameterize.underscore
       end
 
+      def value
+        super(polymorphic_as)
+      end
+
       def options
-        target_resource.model_class.all.map do |model|
+        ::Avo::Services::AuthorizationService.apply_policy(user, target_resource.model_class).all.map do |model|
           {
             value: model.id,
             label: model.send(target_resource.class.title)
@@ -22,22 +30,32 @@ module Avo
         end
       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]
+        end
+      end
+
       def database_value
         target_resource.id
       end
 
       def foreign_key
+        return polymorphic_as if polymorphic_as.present?
+
         if @model.present?
-          if @model.instance_of?(Class)
-            @model.reflections[@relation_method].foreign_key
-          else
-            @model.class.reflections[@relation_method].foreign_key
-          end
-        elsif @resource.present?
+          get_model_class(@model).reflections[@relation_method].foreign_key
+        elsif @resource.present? && @resource.model_class.reflections[@relation_method].present?
           @resource.model_class.reflections[@relation_method].foreign_key
         end
       end
 
+      def reflection_for_key(key)
+        get_model_class(get_model).reflections[key.to_s]
+      rescue
+        nil
+      end
+
       def relation_model_class
         @resource.model_class
       end
@@ -47,16 +65,82 @@ module Avo
       end
 
       def to_permitted_param
+        if polymorphic_as.present?
+          return ["#{polymorphic_as}_type".to_sym, "#{polymorphic_as}_id".to_sym]
+        end
+
         foreign_key.to_sym
       end
 
+      def fill_field(model, key, value, params)
+        return model unless model.methods.include? key.to_sym
+
+        if polymorphic_as.present?
+          model.send("#{polymorphic_as}_type=", params["#{polymorphic_as}_type"])
+
+          # If the type is blank, reset the id too.
+          if params["#{polymorphic_as}_type"].blank?
+            model.send("#{polymorphic_as}_id=", nil)
+          else
+            model.send("#{polymorphic_as}_id=", params["#{polymorphic_as}_id"])
+          end
+        else
+          model.send("#{key}=", value)
+        end
+
+        model
+      end
+
+      def database_id(model)
+        # If the field is a polymorphic value, return the polymorphic_type as key and pre-fill the _id in fill_field.
+        return "#{polymorphic_as}_type" if polymorphic_as.present?
+
+        foreign_key
+      rescue
+        id
+      end
+
       def target_resource
-        if @model._reflections[id.to_s].klass.present?
-          App.get_resource_by_model_name @model._reflections[id.to_s].klass.to_s
-        elsif @model._reflections[id.to_s].options[:class_name].present?
-          App.get_resource_by_model_name @model._reflections[id.to_s].options[:class_name]
+        if polymorphic_as.present?
+          if value.present?
+            return App.get_resource_by_model_name(value.class)
+          else
+            return nil
+          end
+        end
+
+        reflection_key = polymorphic_as || id
+
+        if @model._reflections[reflection_key.to_s].klass.present?
+          App.get_resource_by_model_name @model._reflections[reflection_key.to_s].klass.to_s
+        elsif @model._reflections[reflection_key.to_s].options[:class_name].present?
+          App.get_resource_by_model_name @model._reflections[reflection_key.to_s].options[:class_name]
+        else
+          App.get_resource_by_name reflection_key.to_s
+        end
+      end
+
+      def get_model
+        return @model if @model.present?
+
+        @resource.model
+      rescue
+        nil
+      end
+
+      def name
+        return polymorphic_as.to_s.humanize if polymorphic_as.present? && view == :index
+
+        super
+      end
+
+      private
+
+      def get_model_class(model)
+        if model.instance_of?(Class)
+          model
         else
-          App.get_resource_by_name id.to_s
+          model.class
         end
       end
     end