avo 2.2.2 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35ab86df7a30aa58a644902eea79236c3b46f3f77eb86fc791e100dbdfc4c278
-  data.tar.gz: a1c038e4cfd7101b35361638152c60f1ec06d456364909860cb9296ffa1aa99a
+  metadata.gz: 7aa88764021f40e6a32625569658172b802aa0c2ca31e0fb282cafa5ccc8ba33
+  data.tar.gz: 6e256e598fa099862691a623edfee9d53d0723d0101e681090686e4edd2ae460
 SHA512:
-  metadata.gz: 9976990e8b22f579579f2e983e1990a058fe8f91e27e40972b8ee745a879d3200eb134a9583fb7c7c7f8991e6e44dd18ba5d832914025b8faa881336a5da2168
-  data.tar.gz: 7f16c6e613a17e130a7c2352ac343da1c29b95be680f697dc51f8f95ffbb779751b7fd73ece5f905d020ca2a275cce4c61c07ebdda97a95321efb87f08a0979e
+  metadata.gz: ab132521622ae3dd8dfa75cbf513383b42e6361d64188ced7751560d9808c7b3bb591588ebe831460c992c1d0ee3a6aebed2abfce923d06ccb21da0502373c64
+  data.tar.gz: 3e60dfffdae92341ece77e3bf62236d6104db247399afea1fd6d7a684ad9d1323eff9be12f180ab9ee76f2097036f7cbb48a45720873b66e9dc958b4a0d8fbbf

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    avo (2.2.2)
+    avo (2.3.0)
       active_link_to
       addressable
       breadcrumbs_on_rails

data/app/components/avo/sidebar/group_component.html.erb

@@ -3,7 +3,7 @@
     data-controller="menu"
     data-menu-target="self"
     data-menu-key-param="<%= key %>"
-    data-menu-collapsed-param="<%= collapsed ? 'collapsed' : 'expanded' %>"
+    data-menu-default-collapsed-state="<%= collapsed ? 'collapsed' : 'expanded' %>"
   <% end %>
 >
   <div class="flex justify-between px-10 pt-2 pb-0 text-gray-600 ">
@@ -11,16 +11,16 @@
       <%= item.name %>
     </div>
     <% if collapsable %>
-      <div class="cursor-pointer"
+      <div class="cursor-pointer <%= 'rotate-90' if collapsed %>"
         data-action="click->menu#triggerCollapse"
         data-menu-target="svg"
         data-menu-key-param="<%= key %>"
         >
-        <%= helpers.svg 'heroicons/outline/chevron-down', class: 'h-4'%>
+        <%= helpers.svg 'heroicons/outline/chevron-down', class: "h-4"%>
       </div>
     <% end %>
   </div>
-  <div class="w-full space-y-1" data-menu-target="items">
+  <div class="w-full space-y-1 <%= 'hidden' if collapsed %>" data-menu-target="items">
     <% items.each do |item| %>
       <%= render Avo::Sidebar::ItemSwitcherComponent.new item: item %>
     <% end %>

data/app/components/avo/sidebar/heading_component.html.erb

@@ -3,7 +3,7 @@
     <span class="min-w-[20px]"><%= icon %></span> <span><%= label %></span>
   </div>
   <% if collapsable %>
-    <div class="cursor-pointer"
+    <div class="cursor-pointer <%= 'rotate-90' if collapsed %>"
       data-action="click->menu#triggerCollapse"
       data-menu-key-param="<%= key %>"
       data-menu-target="svg"

data/app/components/avo/sidebar/heading_component.rb

@@ -2,12 +2,14 @@
 
 class Avo::Sidebar::HeadingComponent < ViewComponent::Base
   attr_reader :collapsable
+  attr_reader :collapsed
   attr_reader :icon
   attr_reader :key
   attr_reader :label
 
-  def initialize(label: nil, icon: nil, collapsable: false, key: nil)
+  def initialize(label: nil, icon: nil, collapsable: false, collapsed: false, key: nil)
     @collapsable = collapsable
+    @collapsed = collapsed
     @icon = icon
     @key = key
     @label = label

data/app/components/avo/sidebar/section_component.html.erb

@@ -3,11 +3,11 @@
     data-controller="menu"
     data-menu-target="self"
     data-menu-key-param="<%= key %>"
-    data-menu-collapsed-param="<%= collapsed ? 'collapsed' : 'expanded' %>"
+    data-menu-default-collapsed-state="<%= collapsed ? 'collapsed' : 'expanded' %>"
   <% end %>
 >
-  <%= render Avo::Sidebar::HeadingComponent.new label: item.name, icon: helpers.svg(icon, class: 'h-5'), collapsable: item.collapsable, key: key %>
-  <div class="w-full space-y-1" data-menu-target="items">
+  <%= render Avo::Sidebar::HeadingComponent.new label: item.name, icon: helpers.svg(icon, class: "h-5"), collapsable: item.collapsable, collapsed: collapsed, key: key %>
+  <div class="w-full space-y-1 <%= 'hidden' if collapsed %>" data-menu-target="items">
     <% items.each do |item| %>
       <%= render Avo::Sidebar::ItemSwitcherComponent.new item: item %>
     <% end %>

data/app/controllers/avo/base_controller.rb

@@ -44,7 +44,15 @@ module Avo
         unless @index_params[:sort_by].eql? :created_at
           @query = @query.unscope(:order)
         end
-        @query = @query.order("#{@resource.model_class.table_name}.#{@index_params[:sort_by]} #{@index_params[:sort_direction]}")
+
+        # Check if the sortable field option is actually a proc and we need to do a custom sort
+        field_id = @index_params[:sort_by].to_sym
+        field = @resource.get_field_definitions.find { |field| field.id == field_id }
+        if field&.sortable.is_a?(Proc)
+          @query = field.sortable.call(@query, @index_params[:sort_direction])
+        else
+          @query = @query.order("#{@resource.model_class.table_name}.#{@index_params[:sort_by]} #{@index_params[:sort_direction]}")
+        end
       end
 
       # Apply filters

data/app/javascript/avo.js

@@ -84,3 +84,16 @@ document.addEventListener('turbo:submit-end', () => document.body.classList.remo
 document.addEventListener('turbo:before-cache', () => {
   document.querySelectorAll('[data-turbo-remove-before-cache]').forEach((element) => element.remove())
 })
+
+window.Avo = window.Avo || { configuration: {} }
+
+window.Avo.menus = {
+  resetCollapsedState() {
+    Array.from(document.querySelectorAll('[data-menu-key-param]'))
+      .map((i) => i.getAttribute('data-menu-key-param'))
+      .filter(Boolean)
+      .forEach((key) => {
+        window.localStorage.removeItem(key)
+      })
+  },
+}

data/app/javascript/js/controllers/menu_controller.js

@@ -1,31 +1,46 @@
 import { Controller } from '@hotwired/stimulus'
-import isNull from 'lodash/isNull'
 
 export default class extends Controller {
   static targets = ['svg', 'items', 'self'];
 
-  collapsed = false;
+  collapsed = true;
 
   get key() {
     return this.selfTarget.getAttribute('data-menu-key-param')
   }
 
-  defaultState() {
-    return this.selfTarget.getAttribute('data-menu-collapsed-param') === 'collapsed'
+  get defaultState() {
+    return this.selfTarget.getAttribute('data-menu-default-collapsed-state')
+  }
+
+  get userState() {
+    return window.localStorage.getItem(this.key)
+  }
+
+  set userState(payload) {
+    window.localStorage.setItem(this.key, payload)
+  }
+
+  get initiallyCollapsed() {
+    if (this.userState === 'collapsed' || this.defaultState === 'collapsed') return true
+    if (this.userState === 'expanded' || this.defaultState === 'expanded') return false
+
+    return false
   }
 
   connect() {
-    if (this.getState() === 'collapsed') {
-      this.collapsed = true
-      this.markCollapsed()
-    } else if (isNull(this.getState()) && this.defaultState()) {
+    if (this.initiallyCollapsed) {
       this.collapsed = true
       this.markCollapsed()
+    } else {
+      this.collapsed = false
+      this.markExpanded()
     }
   }
 
   triggerCollapse() {
     this.collapsed = !this.collapsed
+    this.userState = this.collapsed ? 'collapsed' : 'expanded'
 
     this.updateDom()
   }
@@ -41,20 +56,10 @@ export default class extends Controller {
   markCollapsed() {
     this.svgTarget.classList.add('rotate-90')
     this.itemsTarget.classList.add('hidden')
-    this.storeState('collapsed')
   }
 
   markExpanded() {
     this.svgTarget.classList.remove('rotate-90')
     this.itemsTarget.classList.remove('hidden')
-    this.storeState('expanded')
-  }
-
-  getState() {
-    return window.localStorage.getItem(this.key)
-  }
-
-  storeState(payload) {
-    window.localStorage.setItem(this.key, payload)
   }
 }

data/lib/avo/services/authorization_service.rb

@@ -68,11 +68,17 @@ module Avo
         def authorize_action(user, record, action, **args)
           action = Avo.configuration.authorization_methods.stringify_keys[action.to_s] || action
 
+          # If no action passed we should raise error if the user wants that.
+          # If not, just allow it.
+          if action.nil?
+            raise Pundit::NotDefinedError.new 'Policy method is missing' if Avo.configuration.raise_error_on_missing_policy
+
+            return true
+          end
+
           # Add the question mark if it's missing
           action = "#{action}?" unless action.end_with? '?'
 
-          return true if action.nil?
-
           authorize user, record, action, **args
         end
 

data/lib/avo/version.rb

@@ -1,3 +1,3 @@
 module Avo
-  VERSION = "2.2.2"
+  VERSION = "2.3.0"
 end