avo 2.3.1.pre.6 → 2.5.0

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

@@ -68,8 +68,15 @@ export default class extends Controller {
     }
 
     if (this.isBelongsToSearch) {
-      // eslint-disable-next-line camelcase
-      params = { ...params, via_association: this.dataset.viaAssociation }
+      params = {
+        ...params,
+        // eslint-disable-next-line camelcase
+        via_association_id: this.dataset.viaAssociationId,
+        // eslint-disable-next-line camelcase
+        via_reflection_class: this.dataset.viaReflectionClass,
+        // eslint-disable-next-line camelcase
+        via_reflection_id: this.dataset.viaReflectionId,
+      }
     }
 
     return url.segment(segments).search(params).toString()

data/app/javascript/js/controllers/select_filter_controller.js

@@ -4,7 +4,7 @@ export default class extends BaseFilterController {
   static targets = ['selector']
 
   getFilterValue() {
-    return this.selectorTarget.value
+    return this.selectorTarget.value === '' ? null : this.selectorTarget.value
   }
 
   getFilterClass() {

data/app/views/avo/base/_boolean_filter.html.erb

@@ -1,33 +1,28 @@
-<%
-  begin
-    decoded_filters_param = JSON.parse(Base64.decode64(params[:filters]))
-    set_value = decoded_filters_param[filter.class.to_s]
-  rescue => exception
-    if filter.default.present?
-      set_value = filter.default.stringify_keys
-    else
-      set_value = {}
-    end
-  end
-  set_value = {} if set_value.nil?
-%>
-<div data-controller="boolean-filter" data-filter-name="<%= filter.name %>">
+<div
+  data-controller="boolean-filter"
+  data-filter-name="<%= filter.name %>"
+  data-boolean-filter-keep-filters-panel-open-value="<%= @resource.keep_filters_panel_open %>"
+>
   <%= filter_wrapper name: filter.name do %>
     <div class="flex items-center">
-      <div class="space-y-2">
-        <% filter.options.each do |value, label| %>
-          <label class="flex items-center text-gray-700 text-sm">
-            <%= check_box_tag filter.id, value, set_value[value.to_s],
-              class: 'mr-2 text-lg h-4 w-4',
-              id: "avo_filters_#{filter.id.parameterize.underscore}",
-              'data-filter-class': filter.class,
-              'data-boolean-filter-target': 'option',
-              'data-action': 'input->boolean-filter#changeFilter'
-            %>
-            <%= label %>
-          </label>
-        <% end %>
-      </div>
+      <% if filter.options.empty? %>
+        <div class="text-sm text-gray-600"><%= filter.class.empty_message %></div>
+      <% else %>
+        <div class="space-y-2">
+          <% filter.options.each do |value, label| %>
+            <label class="flex items-center text-gray-700 text-sm">
+              <%= check_box_tag filter.id, value, filter.selected_value(value.to_s, @applied_filters),
+                class: 'mr-2 text-lg h-4 w-4',
+                id: "avo_filters_#{filter.id.parameterize.underscore}",
+                'data-filter-class': filter.class,
+                'data-boolean-filter-target': 'option',
+                'data-action': 'input->boolean-filter#changeFilter'
+              %>
+              <%= label %>
+            </label>
+          <% end %>
+        </div>
+      <% end %>
       <%= link_to 'url_redirect', request.url, data: { 'boolean-filter-target': 'urlRedirect', 'turbo-frame': params[:turbo_frame] }, style: 'hidden', class: 'hidden' %>
     </div>
   <% end %>

data/app/views/avo/base/_multiple_select_filter.html.erb

@@ -1,17 +1,10 @@
-<%
-  set_value = filter.default.present? ? filter.default.select { |key, value| value }.keys.map(&:to_sym) : {}
-
-  begin
-    decoded_filters_param = JSON.parse(Base64.decode64(params[:filters]))
-    if decoded_filters_param[filter.class.to_s].present?
-      set_value = decoded_filters_param[filter.class.to_s]
-    end
-  rescue
-  end
-%>
-<div data-controller="multiple-select-filter" data-filter-name="<%= filter.name %>">
+<div
+  data-controller="multiple-select-filter"
+  data-filter-name="<%= filter.name %>"
+  data-multiple-select-filter-keep-filters-panel-open-value="<%= @resource.keep_filters_panel_open %>"
+>
   <%= filter_wrapper name: filter.name do %>
-    <%= select_tag filter.id, options_for_select(filter.options.invert, set_value),
+    <%= select_tag filter.id, options_for_select(filter.options.invert, filter.selected_value(@applied_filters)),
       class: input_classes('w-full mb-0'),
       multiple: true,
       id: "avo_filters_#{filter.id.parameterize.underscore}",
@@ -19,7 +12,7 @@
       'data-multiple-select-filter-target': 'selector'
     %>
     <div class="flex justify-end">
-      <%= a_button class: 'mt-4', color: :blue, size: :sm, data: { action: "multiple-select-filter#changeFilter" } do %>
+      <%= a_button class: 'mt-4', color: :blue, size: :xs, data: { action: "multiple-select-filter#changeFilter" } do %>
         Filter by <%=filter.name %>
       <% end %>
     </div>

data/app/views/avo/base/_select_filter.html.erb

@@ -1,14 +1,10 @@
-<%
-  begin
-    decoded_filters_param = JSON.parse(Base64.decode64(params[:filters]))
-    set_value = decoded_filters_param[filter.class.to_s]
-  rescue => exception
-    set_value = filter.default
-  end
-%>
-<div data-controller="select-filter" data-filter-name="<%= filter.name %>">
+<div
+  data-controller="select-filter"
+  data-filter-name="<%= filter.name %>"
+  data-select-filter-keep-filters-panel-open-value="<%= @resource.keep_filters_panel_open %>"
+>
   <%= filter_wrapper name: filter.name do %>
-    <%= select_tag filter.id, options_for_select(filter.options.invert, set_value),
+    <%= select_tag filter.id, options_for_select(filter.options.invert, filter.applied_or_default_value(@applied_filters)),
       class: input_classes('w-full mb-0'),
       include_blank: '—',
       id: "avo_filters_#{filter.id.parameterize.underscore}",

data/app/views/avo/base/_text_filter.html.erb

@@ -1,14 +1,10 @@
-<%
-  begin
-    decoded_filters_param = JSON.parse(Base64.decode64(params[:filters]))
-    set_value = decoded_filters_param[filter.class.to_s]
-  rescue => exception
-    set_value = filter.default
-  end
-%>
-<div data-controller="text-filter" data-filter-name="<%= filter.name %>">
+<div
+  data-controller="text-filter"
+  data-filter-name="<%= filter.name %>"
+  data-text-filter-keep-filters-panel-open-value="<%= @resource.keep_filters_panel_open %>"
+>
   <%= filter_wrapper name: filter.name do %>
-    <%= text_field_tag filter.id, set_value,
+    <%= text_field_tag filter.id, filter.applied_or_default_value(@applied_filters),
       class: input_classes('w-full mb-0'),
       id: "avo_filters_#{filter.id.parameterize.underscore}",
       'data-filter-class': filter.class.to_s,
@@ -16,7 +12,7 @@
       'data-action': 'keypress->text-filter#tryToSubmit'
     %>
     <div class="flex justify-end">
-      <%= a_button class: 'mt-4', color: :blue, data: { action: "text-filter#changeFilter" }, size: :sm do %>
+      <%= a_button class: 'mt-4', color: :blue, data: { action: "text-filter#changeFilter" }, size: :xs do %>
         <%= filter.button_label || "Filter by #{filter.name}" %>
       <% end %>
     </div>

data/app/views/avo/base/index.html.erb

@@ -10,6 +10,7 @@
       reflection: @reflection,
       turbo_frame: params[:turbo_frame],
       parent_model: @parent_model,
+      applied_filters: @applied_filters,
     )
   %>
 <% end %>

data/app/views/avo/debug/index.html.erb

@@ -21,7 +21,7 @@
       <div class="grid gap-4 sm:grid-cols-3">
         <div class="relative flex flex-col bg-white rounded shadow-panel p-4 space-y-4 h-full col-span-1">
           <div class="font-semibold">License info</div>
-          <div class="flex flex-col justify-between flex-1">
+          <div class="flex flex-col flex-1">
             <div>
               <div class="text-xl font-semibold"><%= license.name %></div>
               <% if license.response['reason'] %>
@@ -57,7 +57,7 @@
             <div class="flex justify-end mt-4">
               <%= a_button style: :outline,
                 color: :blue,
-                url: '/admin/avo_private/debug/refresh_license',
+                url: "#{root_path}avo_private/debug/refresh_license",
                 method: :post,
                 loading: true,
                 icon: 'heroicons/outline/refresh' do %>
@@ -67,7 +67,7 @@
           </div>
         </div>
         <div class="relative bg-white rounded shadow-panel p-4 space-y-4 col-span-2">
-          <turbo-frame id="debug-report" src="/admin/avo_private/debug/report" target="_top" class="block">
+          <turbo-frame id="debug-report" src="<%= root_path %>avo_private/debug/report" target="_top" class="block">
             Loading...
           </turbo-frame>
         </div>

data/app/views/avo/debug/report.html.erb

@@ -1,5 +1,5 @@
 <turbo-frame id="debug-report">
-  <div class="font-semibold">Debug report</div>
+  <div class="font-semibold">Debug report <small class="font-normal">(don't post this anywhere public)</small></div>
   <div>
     <% if defined?(ap) %>
       <%== ap Avo::App.debug_report(request) %>

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

@@ -1,3 +1,3 @@
-<div class="text-center text-sm text-gray-700">
+<div class="text-center text-sm text-gray-700 <%= 'print:hidden' if Avo.configuration.hide_layout_when_printing %>">
   <a href="https://avohq.io/" target="_blank">Avo</a> · &copy; <%= Date.today.year %> AvoHQ · <span title="<%= Avo::App.license.valid ? 'valid' : 'invalid'%> <%= Avo::App.license.id %> license">v<%= Avo::VERSION %></span>
 </div>

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

@@ -1,4 +1,7 @@
-<div class="relative bg-white p-2 w-full flex flex-shrink-0 items-center z-50 px-4 lg:px-8 border-b space-x-4 lg:space-x-0 min-h-[4rem]" v-if="layout !== 'blank'">
+<div
+  class="relative bg-white p-2 w-full flex flex-shrink-0 items-center z-50 px-4 lg:px-8 border-b space-x-4 lg:space-x-0 min-h-[4rem] <%= 'print:hidden' if Avo.configuration.hide_layout_when_printing %>"
+  v-if="layout !== 'blank'"
+>
   <%= a_button class: 'lg:hidden', icon: 'menu', data: { action: 'click->mobile#toggleSidebar' } %>
   <div class="flex-1 flex items-center justify-between lg:justify-start space-x-8">
     <div class="m-0">

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

@@ -0,0 +1,2 @@
+<%# Example link item below %>
+<%#= render Avo::Sidebar::LinkComponent.new label: 'Label', path: '/path' %>

data/db/factories.rb

@@ -25,7 +25,7 @@ FactoryBot.define do
         Time.now - rand(10...365).days
       end
     end
-    status { 0 }
+    status { ::Post.statuses.keys.sample }
   end
 
   factory :project do
@@ -42,11 +42,11 @@ FactoryBot.define do
   end
 
   factory :comment do
-    body { Faker::Lorem.paragraphs(number: rand(4...10)).join(' ') }
+    body { Faker::Lorem.paragraphs(number: rand(4...10)).join(" ") }
   end
 
   factory :review do
-    body { Faker::Lorem.paragraphs(number: rand(4...10)).join(' ') }
+    body { Faker::Lorem.paragraphs(number: rand(4...10)).join(" ") }
   end
 
   factory :person do
@@ -64,6 +64,8 @@ FactoryBot.define do
 
   factory :course do
     name { Faker::Educator.unique.course_name }
+    country { Course.countries.sample }
+    city { Course.cities.stringify_keys[country].sample }
   end
 
   factory :course_link, class: "Course::Link" do

data/lib/avo/app.rb

@@ -104,37 +104,62 @@ module Avo
           end
       end
 
+      def has_main_menu?
+        return false if Avo::App.license.lacks_with_trial(:menu_editor)
+        return false if Avo.configuration.main_menu.nil?
+
+        true
+      end
+
+      def has_profile_menu?
+        return false if Avo::App.license.lacks_with_trial(:menu_editor)
+        return false if Avo.configuration.profile_menu.nil?
+
+        true
+      end
+
       def main_menu
-        return [] if Avo::App.license.lacks_with_trial(:menu_builder)
-        return [] if Avo.configuration.main_menu.nil?
+        # Return empty menu if the app doesn't have the profile menu configured
+        return Avo::Menu::Builder.new.build unless has_main_menu?
 
         Avo::Menu::Builder.parse_menu(&Avo.configuration.main_menu)
       end
 
       def profile_menu
-        return [] if Avo::App.license.lacks_with_trial(:menu_builder)
-        return [] if Avo.configuration.profile_menu.nil?
+        # Return empty menu if the app doesn't have the profile menu configured
+        return Avo::Menu::Builder.new.build unless has_profile_menu?
 
         Avo::Menu::Builder.parse_menu(&Avo.configuration.profile_menu)
       end
 
-      def debug_report(request)
+      def debug_report(request = nil)
         payload = {}
+
         hq = Avo::Licensing::HQ.new(request)
 
-        payload[:hq_payload] = hq.payload
-        payload[:license_id] = Avo::App.license.id
-        payload[:license_valid] = Avo::App.license.valid?
-        payload[:license_payload] = Avo::App.license.payload
-        payload[:license_response] = Avo::App.license.response
-        payload[:cache_store] = self.cache_store.class.to_s
-        payload[:avo_metadata] = hq.avo_metadata
+        payload[:thread_count] = get_thread_count
+        payload[:hq_payload] = hq&.payload
+        payload[:license_id] = Avo::App&.license&.id
+        payload[:license_valid] = Avo::App&.license&.valid?
+        payload[:license_payload] = Avo::App&.license&.payload
+        payload[:license_response] = Avo::App&.license&.response
+        payload[:license_abilities] = Avo::App&.license&.abilities
+        payload[:cache_store] = self.cache_store&.class&.to_s
+        payload[:avo_metadata] = hq&.avo_metadata
         payload[:app_timezone] = Time.now.zone
+        payload[:cache_key] = Avo::Licensing::HQ.cache_key
+        payload[:cache_key_contents] = hq&.cached_response
 
         payload
       rescue => e
         e
       end
+
+      def get_thread_count
+        Thread.list.select {|thread| thread.status == "run"}.count
+      rescue => e
+        e
+      end
     end
   end
 end

data/lib/avo/base_resource.rb

@@ -44,6 +44,7 @@ module Avo
     class_attribute :after_update_path, default: :show
     class_attribute :invalid_fields
     class_attribute :record_selector, default: true
+    class_attribute :keep_filters_panel_open, default: false
 
     class << self
       delegate :t, to: ::I18n

data/lib/avo/configuration.rb

@@ -20,6 +20,7 @@ module Avo
     attr_accessor :cache_resources_on_index_view
     attr_accessor :context
     attr_accessor :display_breadcrumbs
+    attr_accessor :hide_layout_when_printing
     attr_accessor :initial_breadcrumbs
     attr_accessor :home_path
     attr_accessor :search_debounce
@@ -64,6 +65,7 @@ module Avo
         add_breadcrumb I18n.t("avo.home").humanize, avo.root_path
       }
       @display_breadcrumbs = true
+      @hide_layout_when_printing = false
       @home_path = nil
       @search_debounce = 300
       @view_component_path = "app/components"

data/lib/avo/engine.rb

@@ -63,5 +63,18 @@ module Avo
     config.generators do |g|
       g.test_framework :rspec, view_specs: false
     end
+
+    # After deploy we want to make sure the license response is being cleared.
+    # We need a fresh license response.
+    # This is disabled in development because the initialization process might be triggered more than once.
+    config.after_initialize do
+      unless Rails.env.development?
+        begin
+          Licensing::HQ.new.clear_response
+        rescue => exception
+          puts "Failed to clear Avo HQ response: #{e.message}"
+        end
+      end
+    end
   end
 end

data/lib/avo/fields/belongs_to_field.rb

@@ -62,6 +62,8 @@ module Avo
       attr_reader :relation_method
       attr_reader :types # for Polymorphic associations
       attr_reader :allow_via_detaching
+      attr_reader :scope
+      attr_reader :polymorphic_help
 
       def initialize(id, **args, &block)
         args[:placeholder] ||= I18n.t("avo.choose_an_option")
@@ -73,6 +75,8 @@ module Avo
         @types = args[:types]
         @relation_method = id.to_s.parameterize.underscore
         @allow_via_detaching = args[:allow_via_detaching] == true
+        @scope = args[:scope]
+        @polymorphic_help = args[:polymorphic_help]
       end
 
       def searchable
@@ -111,7 +115,13 @@ module Avo
         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|
+        query = Avo::Services::AuthorizationService.apply_policy(user, resource.class.query_scope)
+
+        if scope.present?
+          query = Avo::Hosts::AssociationScopeHost.new(block: scope, query: query, parent: get_model).handle
+        end
+
+        query.all.map do |model|
           [model.send(resource.class.title), model.id]
         end
       end

data/lib/avo/fields/code_field.rb

@@ -14,7 +14,7 @@ module Avo
         super(id, **args, &block)
 
         @language = args[:language].present? ? args[:language].to_s : "javascript"
-        @theme = args[:theme].present? ? args[:theme].to_s : "material-darker"
+        @theme = args[:theme].present? ? args[:theme].to_s : "default"
         @height = args[:height].present? ? args[:height].to_s : "auto"
         @tab_size = args[:tab_size].present? ? args[:tab_size] : 2
         @indent_with_tabs = args[:indent_with_tabs].present? ? args[:indent_with_tabs] : false

data/lib/avo/fields/has_base_field.rb

@@ -3,6 +3,7 @@ module Avo
     class HasBaseField < BaseField
       attr_accessor :display
       attr_accessor :scope
+      attr_accessor :description
 
       def initialize(id, **args, &block)
         super(id, **args, &block)
@@ -10,6 +11,7 @@ module Avo
         @scope = args[:scope].present? ? args[:scope] : nil
         @display = args[:display].present? ? args[:display] : :show
         @searchable = args[:searchable] == true
+        @description = args[:description]
       end
 
       def searchable

data/lib/avo/filters/base_filter.rb

@@ -1,13 +1,26 @@
 module Avo
   module Filters
     class BaseFilter
+      PARAM_KEY = :filters unless const_defined?(:PARAM_KEY)
+
       class_attribute :name, default: "Filter"
       class_attribute :component, default: "boolean-filter"
-      class_attribute :default, default: ""
+      class_attribute :default, default: nil
       class_attribute :template, default: "avo/base/select_filter"
+      class_attribute :empty_message, default: I18n.t("avo.no_options_available")
+
+      delegate :params, to: Avo::App
+
+      class << self
+        def decode_filters(filter_params)
+          JSON.parse(Base64.decode64(filter_params))
+        rescue
+          {}
+        end
+      end
 
       def apply_query(request, query, value)
-        value.symbolize_keys! if value.is_a? Hash
+        value.stringify_keys! if value.is_a? Hash
 
         apply(request, query, value)
       end
@@ -15,6 +28,26 @@ module Avo
       def id
         self.class.name.underscore.tr("/", "_")
       end
+
+      # Get the applied value this filter.
+      # If it's not present return the default value.
+      def applied_or_default_value(applied_filters)
+        # Get the values for this particular filter
+        applied_value = applied_filters[self.class.to_s]
+
+        # Return that value if present
+        return applied_value unless applied_value.nil?
+
+        # Return that default
+        default
+      rescue
+        default
+      end
+
+      # Fetch the applied filters from the params
+      def applied_filters
+        self.class.decode_filters params[PARAM_KEY]
+      end
     end
   end
 end

data/lib/avo/filters/boolean_filter.rb

@@ -2,6 +2,18 @@ module Avo
   module Filters
     class BooleanFilter < BaseFilter
       self.template = "avo/base/boolean_filter"
+
+      def selected_value(item, applied_filters)
+        # See if there are any applied rules for this particular filter
+        if applied_filters[self.class.to_s].present?
+          # Symbolize the keys because they are returned from de-serialization (JSON and Base64)
+          applied_filters[self.class.to_s].stringify_keys.dig(item.to_s)
+        else
+          applied_or_default_value(applied_filters).stringify_keys.dig(item.to_s)
+        end
+      rescue
+        false
+      end
     end
   end
 end

data/lib/avo/filters/multiple_select_filter.rb

@@ -2,6 +2,21 @@ module Avo
   module Filters
     class MultipleSelectFilter < BaseFilter
       self.template = "avo/base/multiple_select_filter"
+
+      # The input expects an array of strings for the value
+      # Ex: ['admins', 'non_admins']
+      def selected_value(applied_filters)
+        # Get the values for this particular filter
+        applied_value = applied_filters[self.class.to_s]
+
+        # Return that value if present
+        return applied_value unless applied_value.nil?
+
+        # Return that default
+        return default unless default.nil?
+
+        []
+      end
     end
   end
 end

data/lib/avo/filters/text_filter.rb

@@ -4,6 +4,10 @@ module Avo
       class_attribute :button_label
 
       self.template = "avo/base/text_filter"
+
+      def selected_value(applied_filters)
+        applied_or_default_value
+      end
     end
   end
 end

data/lib/avo/hosts/association_scope_host.rb

@@ -0,0 +1,8 @@
+module Avo
+  module Hosts
+    class AssociationScopeHost < BaseHost
+      option :parent
+      option :query
+    end
+  end
+end