avo 2.45.0 → 3.0.0.beta1

data/app/controllers/avo/debug_controller.rb

@@ -2,7 +2,19 @@ require_dependency "avo/application_controller"
 
 module Avo
   class DebugController < ApplicationController
-    def index
+    def status
+    end
+
+    def send_to_hq
+      url = "#{ENV["HQ_URL"]}/api/v3/debug_requests"
+      timeout = 10 # seconds
+      license_key = Avo::Services::DebugService.debug_report(request)[:hq_payload][:license_key]
+      body = params[:body]
+      body = {license_key: license_key, body: body, payload: Avo::Services::DebugService.debug_report(request).to_json}.to_json
+
+      HTTParty.post url, body: body, headers: {"Content-Type": "application/json"}, timeout: timeout
+
+      render turbo_stream: turbo_stream.replace(:send_to_hq, plain: "Payload sent to Avo HQ.")
     end
 
     def report
@@ -13,13 +25,13 @@ module Avo
 
       if license.valid?
         flash[:notice] = "avohq.io responded: \"#{license.id.humanize} license is valid\"."
-      elsif license.response['reason'].present?
-        flash[:error] = "avohq.io responded: \"#{license.response['reason']}\"."
+      elsif license.response["reason"].present?
+        flash[:error] = "avohq.io responded: \"#{license.response["reason"]}\"."
       else
-        flash[:error] = license.response['error']
+        flash[:error] = license.response["error"]
       end
 
-      redirect_back fallback_location: avo.avo_private_debug_index_path
+      redirect_back fallback_location: avo.avo_private_status_path
     end
   end
 end

data/app/controllers/avo/home_controller.rb

@@ -14,7 +14,7 @@ module Avo
         redirect_to computed_path
       elsif !Rails.env.development?
         @page_title = "Get started"
-        resource = Avo::App.resources.min_by { |resource| resource.model_key }
+        resource = Avo.resource_manager.all.min_by { |resource| resource.model_key }
         redirect_to resources_path(resource: resource)
       end
     end

data/app/controllers/avo/search_controller.rb

@@ -4,18 +4,8 @@ module Avo
   class SearchController < ApplicationController
     include Rails.application.routes.url_helpers
 
-    before_action :set_resource_name, only: [:show]
-    before_action :set_resource, only: [:show]
-
-    def index
-      raise ActionController::BadRequest.new("This feature requires the pro license https://avohq.io/purchase/pro") if App.license.lacks_with_trial(:global_search)
-
-      resources = Avo::App.resources.reject do |resource|
-        resource.class.hide_from_global_search
-      end
-
-      render json: search_resources(resources)
-    end
+    before_action :set_resource_name, only: :show
+    before_action :set_resource, only: :show
 
     def show
       render json: search_resources([resource])
@@ -28,7 +18,6 @@ module Avo
         .map do |resource|
           # Apply authorization
           next unless @authorization.set_record(resource.model_class).authorize_action(:search, raise_exception: false)
-
           # Filter out the models without a search_query
           next if resource.search_query.nil?
 
@@ -45,20 +34,20 @@ module Avo
     end
 
     def search_resource(resource)
-      query = Avo::Hosts::SearchScopeHost.new(
-        block: resource.search_query,
+      query = Avo::ExecutionContext.new(
+        target: resource.search_query,
         params: params,
-        scope: resource.class.scope
+        query: resource.query_scope
       ).handle
 
-      query = apply_scope(query) if should_apply_any_scope?
-
       # Get the count
       results_count = query.reselect(resource.model_class.primary_key).count
 
       # Get the results
       query = query.limit(8)
 
+      query = apply_scope(query) if should_apply_any_scope?
+
       results = apply_search_metadata(query, resource)
 
       header = resource.plural_name
@@ -69,9 +58,9 @@ module Avo
 
       result_object = {
         header: header,
-        help: resource.class.search_query_help,
+        help: resource.fetch_search(:help) || "",
         results: results,
-        count: results_count
+        count: results.count
       }
 
       [resource.name.pluralize.downcase, result_object]
@@ -96,9 +85,9 @@ module Avo
       # to scope the query.
       # Example usage: Got to a project, create a new review, and search for a user.
       if parent.blank? && params[:via_parent_resource_id].present? && params[:via_parent_resource_class].present? && params[:via_relation].present?
-        parent_resource_class = BaseResource.valid_model_class params[:via_parent_resource_class]
+        parent_resource_class = BaseResource.get_model_by_name params[:via_parent_resource_class]
 
-        reflection_class = BaseResource.valid_model_class params[:via_reflection_class]
+        reflection_class = BaseResource.get_model_by_name params[:via_reflection_class]
 
         grandparent = parent_resource_class.find params[:via_parent_resource_id]
         parent = reflection_class.new(
@@ -106,7 +95,7 @@ module Avo
         )
       end
 
-      Avo::Hosts::AssociationScopeHost.new(block: attach_scope, query: query, parent: parent).handle
+      Avo::ExecutionContext.new(target: attach_scope, query: query, parent: parent).handle
     end
 
     # This scope is applied if the search is being performed on a has_many association
@@ -114,44 +103,34 @@ module Avo
       association_name = BaseResource.valid_association_name(parent, params[:via_association_id])
 
       # Get association records
-      scope = parent.send(association_name)
+      query = parent.send(association_name)
 
       # Apply policy scope if authorization is present
-      scope = resource.authorization&.apply_policy scope
+      query = resource.authorization&.apply_policy query
 
-      Avo::Hosts::SearchScopeHost.new(block: @resource.search_query, params: params, scope: scope).handle
+      Avo::ExecutionContext.new(target: @resource.class.search_query, params: params, query: query).handle
     end
 
-    def apply_search_metadata(models, avo_resource)
-      models.map do |model|
-        resource = avo_resource.dup.hydrate(model: model).hydrate_fields(model: model)
-
-        record_path = if resource.search_result_path.present?
-          Avo::Hosts::ResourceRecordHost.new(block: resource.search_result_path, resource: resource, record: model).handle
-        else
-          resource.record_path
-        end
+    def apply_search_metadata(records, avo_resource)
+      records.map do |record|
+        resource = avo_resource.new(record: record)
 
-        result = {
-          _id: model.id,
-          _label: resource.label,
-          _url: record_path
-        }
-
-        if App.license.has_with_trial(:enhanced_search_results)
-          result[:_description] = resource.description
-          result[:_avatar] = resource.avatar.present? ? main_app.url_for(resource.avatar) : nil
-          result[:_avatar_type] = resource.avatar_type
-        end
-
-        result
+        fetch_result_information record, resource, resource.class.fetch_search(:item, record: record)
       end
     end
 
     private
 
+    def fetch_result_information(record, resource, item)
+      {
+        _id: record.id,
+        _label: item&.dig(:title) || resource.record_title,
+        _url: resource.class.fetch_search(:result_path, record: resource.record) || resource.record_path
+      }
+    end
+
     def should_apply_has_many_scope?
-      params[:via_association] == "has_many" && @resource.search_query.present?
+      params[:via_association] == "has_many" && @resource.class.search_query.present?
     end
 
     def should_apply_attach_scope?
@@ -175,14 +154,14 @@ module Avo
     end
 
     def fetch_field
-      fields = ::Avo::App.get_resource_by_model_name(params[:via_reflection_class]).get_field_definitions
+      fields = Avo.resource_manager.get_resource_by_model_class(params[:via_reflection_class]).new.get_field_definitions
       fields.find { |f| f.id.to_s == params[:via_association_id] }
     end
 
     def fetch_parent
       return unless params[:via_reflection_id].present?
 
-      parent_resource = ::Avo::App.get_resource_by_model_name params[:via_reflection_class]
+      parent_resource = Avo.resource_manager.get_resource_by_model_class params[:via_reflection_class]
       parent_resource.find_record params[:via_reflection_id], params: params
     end
   end

data/app/controllers/avo/team_users_controller.rb

@@ -0,0 +1,4 @@
+# This controller has been generated to enable Rails' resource routes.
+# You shouldn't need to modify it in order to use Avo.
+class Avo::TeamUsersController < Avo::ResourcesController
+end

data/app/controllers/concerns/avo/initializes_avo.rb

@@ -0,0 +1,21 @@
+module Avo
+  module InitializesAvo
+    def init_app
+      Avo::Current.license = Avo::Licensing::NilLicense.new
+      Avo::Current.context = context
+      Avo::Current.user = _current_user
+      Avo::Current.view_context = view_context
+      Avo.init
+      Avo::Current.license = Licensing::LicenseManager.new(Licensing::HQ.new(request).response).license
+      Avo.plugin_manager.init_plugins
+    end
+
+    def _current_user
+      instance_eval(&Avo.configuration.current_user)
+    end
+
+    def context
+      instance_eval(&Avo.configuration.context)
+    end
+  end
+end

data/app/helpers/avo/application_helper.rb

@@ -1,12 +1,7 @@
 module Avo
   module ApplicationHelper
     include ::Pagy::Frontend
-
-    def render_license_warnings
-      render partial: "avo/sidebar/license_warnings", locals: {
-        license: Avo::App.license.properties
-      }
-    end
+    include Avo::ResourcesHelper
 
     def render_license_warning(title: "", message: "", icon: "exclamation")
       render partial: "avo/sidebar/license_warning", locals: {
@@ -119,8 +114,19 @@ module Avo
       Avo::Filters::BaseFilter.encode_filters(filter_params)
     end
 
-    def frame_id(resource)
-      ["frame", resource.model_name.singular, resource.model.id].compact.join("-")
+    def number_to_social(number, start_at: 10_000)
+      return number_with_delimiter(number) if number < start_at
+
+      number_to_human(number,
+        precision: 1,
+        significant: false,
+        round_mode: :down,
+        format: "%n%u",
+        units: {
+          thousand: "K",
+          million: "M",
+          billion: "B"
+        })
     end
 
     private
@@ -144,7 +150,7 @@ module Avo
       field = field_klass.new id, form: form, view: view, **args, &block
 
       # Add the form record to the field so all fields have access to it.
-      field.hydrate(model: form.object) if form.present?
+      field.hydrate(record: form.object) if form.present?
 
       render field.component_for_view(view).new field: field, form: form, **component_options
     end

data/app/helpers/avo/resources_helper.rb

@@ -38,7 +38,7 @@ module Avo
     end
 
     def item_selector_init(resource)
-      "data-resource-name='#{resource.model_key}' data-resource-id='#{resource.model.id}' data-controller='item-selector'"
+      "data-resource-name='#{resource.model_key}' data-resource-id='#{resource.record.id}' data-controller='item-selector'"
     end
 
     def item_selector_input(floating: false, size: :md)

data/app/helpers/avo/url_helpers.rb

@@ -20,14 +20,14 @@ module Avo
     end
 
     def resource_path(
-      model:,
+      record:,
       resource:,
       resource_id: nil,
       keep_query_params: false,
       **args
     )
-      if model.respond_to? :id
-        id = model
+      if record.respond_to? :id
+        id = record
       elsif resource_id.present?
         id = resource_id
       end
@@ -35,29 +35,45 @@ module Avo
       avo.send :"resources_#{resource.singular_route_key}_path", id, **args
     end
 
+    def preview_resource_path(
+      record:,
+      resource:,
+      resource_id: nil,
+      keep_query_params: false,
+      **args
+    )
+      if record.respond_to? resource.id_attribute
+        id = record
+      elsif resource_id.present?
+        id = resource_id
+      end
+
+      avo.send :"preview_resources_#{resource.singular_route_key}_path", id, **args
+    end
+
     def new_resource_path(resource:, **args)
       avo.send :"new_resources_#{resource.singular_route_key}_path", **args
     end
 
-    def edit_resource_path(model:, resource:, **args)
-      avo.send :"edit_resources_#{resource.singular_route_key}_path", model, **args
+    def edit_resource_path(record:, resource:, **args)
+      avo.send :"edit_resources_#{resource.singular_route_key}_path", record, **args
     end
 
-    def resource_attach_path(resource, model_id, related_name, related_id = nil)
-      helpers.avo.resources_associations_new_path(resource.singular_route_key, model_id, related_name)
+    def resource_attach_path(resource, record_id, related_name, related_id = nil)
+      helpers.avo.resources_associations_new_path(resource.singular_route_key, record_id, related_name)
     end
 
     def resource_detach_path(
       model_name, # teams
-      model_id, # 1
+      record_id, # 1
       related_name, # admin
       related_id = nil
     )
-      avo.resources_associations_destroy_path(model_name, model_id, related_name, related_id)
+      avo.resources_associations_destroy_path(model_name, record_id, related_name, related_id)
     end
 
     def related_resources_path(
-      parent_model,
+      parent_record,
       record,
       keep_query_params: false,
       **args
@@ -74,7 +90,7 @@ module Avo
       rescue
       end
 
-      avo.resources_associations_index_path(parent_model.model_name.route_key, record.id, **existing_params, **args)
+      avo.resources_associations_index_path(parent_record.model_name.route_key, record.id, **existing_params, **args)
     end
 
     def resource_view_path(**args)

data/app/javascript/avo.base.js

@@ -12,6 +12,7 @@ import 'chartkick/chart.js/chart.esm'
 
 import './js/active-storage'
 import './js/controllers'
+import './js/custom-stream-actions'
 
 Rails.start()
 

data/app/javascript/js/application.js

@@ -2,9 +2,6 @@ import 'mapkick/bundle'
 
 import { Alert, Popover } from 'tailwindcss-stimulus-components'
 import { Application } from '@hotwired/stimulus'
-import TurboPower from 'turbo_power'
-
-TurboPower.initialize(Turbo.StreamActions)
 
 const application = Application.start()
 

data/app/javascript/js/controllers/action_controller.js

@@ -2,10 +2,12 @@ import { Controller } from '@hotwired/stimulus'
 import { castBoolean } from '../helpers/cast_boolean'
 
 export default class extends Controller {
-  static targets = ['controllerDiv', 'resourceIds', 'submit', 'selectedAllQuery']
+  static targets = ['controllerDiv', 'resourceIds', 'form', 'selectedAllQuery']
 
   connect() {
-    this.resourceIdsTarget.value = this.resourceIds
+    if (this.resourceIdsTarget.value === '') {
+      this.resourceIdsTarget.value = this.resourceIds
+    }
 
     // This value is picked up from the DOM so we check true/false as strings
     if (this.selectionOptions.itemSelectAllSelectedAllValue === 'true') {
@@ -13,7 +15,7 @@ export default class extends Controller {
     }
 
     if (this.noConfirmation) {
-      this.submitTarget.click()
+      this.formTarget.submit()
     } else {
       this.controllerDivTarget.classList.remove('hidden')
     }

data/app/javascript/js/controllers/actions_overflow_controller.js

@@ -0,0 +1,62 @@
+import { Controller } from '@hotwired/stimulus'
+
+export default class extends Controller {
+  static targets = ['content']
+
+  static values = {
+    panelList: Boolean,
+  }
+
+  // get the table or grid component, if both null, get the panel body (for show page for example)
+  get parentTarget() {
+    return document.querySelector('[data-component-name="avo/index/resource_table_component"]')
+      || document.querySelector('[data-component-name="avo/index/resource_grid_component"]')
+      || document.querySelector('[data-target="panel-body"]')
+  }
+
+  childDimensions = null
+
+  parentDimensions = null
+
+  connect() {
+    // We need to make the element visible in order to get it's position
+    this.element.style.display = 'block'
+    this.childDimensions = this.contentTarget.getBoundingClientRect()
+    this.element.style.display = ''
+    this.parentDimensions = this.parentTarget.getBoundingClientRect()
+
+    this.adjustOverflow()
+  }
+
+  adjustOverflow() {
+    this.adjustVerticalOverflow()
+    this.adjustHorizontalOverflow()
+  }
+
+  adjustVerticalOverflow() {
+    if (this.contentBottomOverflow) {
+      this.contentTarget.classList.remove('top-full', 'mt-2')
+      this.contentTarget.classList.add('bottom-full', 'mb-2')
+    }
+  }
+
+  adjustHorizontalOverflow() {
+    if (this.contentLeftOverflow) {
+      this.contentTarget.classList.remove('xl:right-0', 'sm:right-0')
+      this.contentTarget.classList.add('xl:left-0', 'sm:left-0')
+    }
+  }
+
+  get contentBottomOverflow() {
+    // If the list is on panel header, we don't want to adjust the vertical overflow
+    if (this.panelListValue === true) {
+      return false
+    }
+
+    return this.parentDimensions.bottom < this.childDimensions.bottom
+  }
+
+  get contentLeftOverflow() {
+    return this.parentDimensions.left > this.childDimensions.left
+  }
+}

data/app/javascript/js/controllers/filter_controller.js

@@ -98,7 +98,7 @@ export default class extends Controller {
 
     url.query(query)
 
-    this.urlRedirectTarget.href = url
+    this.urlRedirectTarget.href = url.readable().toString()
     this.urlRedirectTarget.click()
   }
 }

data/app/javascript/js/controllers/input_autofocus_controller.js

@@ -0,0 +1,12 @@
+import { Controller } from '@hotwired/stimulus'
+
+export default class extends Controller {
+  static targets = ['element'];
+
+  focus({ params }) {
+    const element = this.context.element.querySelector(params.selector)
+    if (this.element) {
+      element.focus()
+    }
+  }
+}

data/app/javascript/js/controllers/preview_controller.js

@@ -0,0 +1,24 @@
+import { Controller } from '@hotwired/stimulus'
+import tippy from 'tippy.js'
+
+export default class extends Controller {
+  static values = {
+    url: String,
+  }
+
+  connect() {
+    const vm = this;
+
+    tippy(vm.context.element, {
+      content: "loading...",
+      allowHTML: true,
+      theme: 'light',
+      maxWidth: 550,
+      async onShow(instance) {
+        const response = await fetch(vm.urlValue)
+        const content = await response.text()
+        instance.setContent(content)
+      },
+    })
+  }
+}

data/app/javascript/js/controllers/search_controller.js

@@ -212,8 +212,8 @@ export default class extends Controller {
     const url = URI()
 
     return url.segment([window.Avo.configuration.root_path, ...this.searchSegments()])
-              .search(this.searchParams(encodeURIComponent(query)))
-              .readable().toString()
+      .search(this.searchParams(encodeURIComponent(query)))
+      .readable().toString()
   }
 
   searchSegments() {

data/app/javascript/js/controllers/self_destroy_controller.js

@@ -0,0 +1,7 @@
+import { Controller } from '@hotwired/stimulus'
+
+export default class extends Controller {
+  destroy() {
+    this.context.element.remove()
+  }
+}

data/app/javascript/js/controllers/toggle_controller.js

@@ -0,0 +1,48 @@
+import { Controller } from '@hotwired/stimulus'
+import { leave, toggle } from 'el-transition'
+import { useClickOutside } from 'stimulus-use'
+
+export default class extends Controller {
+  static targets = ['panel']
+
+  static values = {
+    // One may want to have an element that is exempt from triggerring the click outside event
+    exemptionContainer: String,
+  }
+
+  get exemptionContainerTarget() {
+    return document.querySelector(this.exemptionContainerValue)
+  }
+
+  connect() {
+    useClickOutside(this)
+  }
+
+  clickOutside(e) {
+    if (this.hasPanelTarget) {
+      if (this.hasExemptionContainerValue) {
+        const inExemptionContainer = this.exemptionContainerTarget.contains(e.target)
+
+        if (!inExemptionContainer) {
+          leave(this.panelTarget)
+        }
+      } else {
+        leave(this.panelTarget)
+      }
+    }
+  }
+
+  togglePanel() {
+    if (this.hasPanelTarget) {
+      toggle(this.panelTarget)
+    }
+  }
+
+  outlet({ params }) {
+    const { outlet } = params
+
+    if (outlet && document.querySelector(outlet)) {
+      document.querySelector(outlet).classList.toggle('hidden')
+    }
+  }
+}