avo 2.2.1 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ed006aa7c57368aa03156290f54f757484daff2434ad0f235fa1cdabd0489e4
-  data.tar.gz: 5596ead68c48c161977b477ad5b689be6228957b56f818d0a2ba015f3bf250be
+  metadata.gz: 35ab86df7a30aa58a644902eea79236c3b46f3f77eb86fc791e100dbdfc4c278
+  data.tar.gz: a1c038e4cfd7101b35361638152c60f1ec06d456364909860cb9296ffa1aa99a
 SHA512:
-  metadata.gz: 68a9010fd5eec2c2c45527cc3bb46c751eefbde06894d4e8857f9d86c8417fdc13d835422479efd5361e16c677ecfa57a3ae0a375b4cd84598d5e88bd85dd2bd
-  data.tar.gz: e2adc97bfcac2b881d9780d60bdc323186362f76c3139f03b0282ac1275f64cba2555c46ad6617aab3fff886c12e1322debbd1e7b38cd107f082129a6f392900
+  metadata.gz: 9976990e8b22f579579f2e983e1990a058fe8f91e27e40972b8ee745a879d3200eb134a9583fb7c7c7f8991e6e44dd18ba5d832914025b8faa881336a5da2168
+  data.tar.gz: 7f16c6e613a17e130a7c2352ac343da1c29b95be680f697dc51f8f95ffbb779751b7fd73ece5f905d020ca2a275cce4c61c07ebdda97a95321efb87f08a0979e

data/Gemfile

@@ -84,7 +84,7 @@ group :development do
 end
 
 group :development, :test do
-  gem 'ap'
+  gem "awesome_print"
   gem "faker", require: false
 end
 

data/Gemfile.lock

@@ -1,12 +1,13 @@
 PATH
   remote: .
   specs:
-    avo (2.2.1)
+    avo (2.2.2)
       active_link_to
       addressable
       breadcrumbs_on_rails
       chartkick
       countries
+      docile
       dry-initializer
       hotwire-rails
       httparty
@@ -89,13 +90,12 @@ GEM
       activerecord (>= 4.2)
     addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
-    ap (0.1.1)
-      httparty (>= 0.7.7)
     appraisal (2.4.1)
       bundler
       rake
       thor (>= 0.14.0)
     ast (2.4.2)
+    awesome_print (1.9.2)
     aws-eventstream (1.2.0)
     aws-partitions (1.551.0)
     aws-sdk-core (3.125.5)
@@ -242,7 +242,7 @@ GEM
       net-protocol
       timeout
     nio4r (2.5.8)
-    nokogiri (1.13.3)
+    nokogiri (1.13.4)
       mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
     orm_adapter (0.5.0)
@@ -418,9 +418,9 @@ DEPENDENCIES
   active_median
   acts_as_list
   addressable
-  ap
   appraisal
   avo!
+  awesome_print
   aws-sdk-s3
   bootsnap (>= 1.4.2)
   breadcrumbs_on_rails

data/app/assets/svgs/{dashboards-icon.svg → dashboards.svg}

@@ -1,4 +1,4 @@
-<svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg">
+<svg viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg">
 <path d="M8.4 2H2V8.4H8.4V2Z" stroke="#757D8A" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"/>
 <path d="M18 2H11.6V8.4H18V2Z" stroke="#757D8A" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"/>
 <path d="M8.4 11.6001H2V18.0001H8.4V11.6001Z" stroke="#757D8A" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"/>

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

@@ -17,6 +17,19 @@ class Avo::Index::FieldWrapperComponent < ViewComponent::Base
       result += " py-3"
     end
 
+    result += " #{text_align_classes}"
+
     result
   end
+
+  private
+
+  def text_align_classes
+    case @field.index_text_align.to_sym
+    when :right
+      'text-right'
+    when :center
+      'text-center'
+    end
+  end
 end

data/app/components/avo/profile_item_component.html.erb

@@ -1,3 +1,3 @@
-<%= link_to @path, class: "flex-1 flex items-center justify-center bg-white text-left cursor-pointer text-gray-800 font-semibold hover:bg-blue-100 block px-4 py-1 w-full py-3 text-center rounded w-full" do %>
-  <%= @icon if @icon.present? %> <%= @label %>
+<%= link_to path, class: "flex-1 flex items-center justify-center bg-white text-left cursor-pointer text-gray-800 font-semibold hover:bg-blue-100 block px-4 py-1 w-full py-3 text-center rounded w-full", target: target do %>
+  <%= helpers.svg(icon, class: 'h-4 mr-1') if icon.present? %> <%= label %>
 <% end %>

data/app/components/avo/profile_item_component.rb

@@ -1,6 +1,12 @@
 # frozen_string_literal: true
 
 class Avo::ProfileItemComponent < ViewComponent::Base
+  attr_reader :label
+  attr_reader :icon
+  attr_reader :path
+  attr_reader :active
+  attr_reader :target
+
   def initialize(label: nil, icon: nil, path: nil, active: :inclusive, target: nil)
     @label = label
     @icon = icon

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+class Avo::Sidebar::BaseItemComponent < ViewComponent::Base
+  attr_reader :item
+
+  def initialize(item: nil)
+    @item = item
+  end
+
+  def items
+    item.items
+  end
+
+  def key
+    result = "avo.#{request.host}.main_menu.#{item.name.underscore}"
+
+    if item.icon.present?
+      result += ".#{item.icon.parameterize.underscore}"
+    end
+
+    result
+  end
+
+  def collapsable
+    item.collapsable
+  end
+
+  def collapsed
+    item.collapsed
+  end
+end

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

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

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

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class Avo::Sidebar::GroupComponent < Avo::Sidebar::BaseItemComponent
+end

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

@@ -0,0 +1,14 @@
+<div class="flex justify-between p-4 py-2 text-gray-500">
+  <div class="flex items-center text-sm uppercase font-semibold leading-none space-x-1">
+    <span class="min-w-[20px]"><%= icon %></span> <span><%= label %></span>
+  </div>
+  <% if collapsable %>
+    <div class="cursor-pointer"
+      data-action="click->menu#triggerCollapse"
+      data-menu-key-param="<%= key %>"
+      data-menu-target="svg"
+    >
+      <%= helpers.svg 'heroicons/outline/chevron-down', class: 'h-5'%>
+    </div>
+  <% end %>
+</div>

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class Avo::Sidebar::HeadingComponent < ViewComponent::Base
+  attr_reader :collapsable
+  attr_reader :icon
+  attr_reader :key
+  attr_reader :label
+
+  def initialize(label: nil, icon: nil, collapsable: false, key: nil)
+    @collapsable = collapsable
+    @icon = icon
+    @key = key
+    @label = label
+  end
+end

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

@@ -0,0 +1,16 @@
+<% if item.is_a? Avo::Menu::Link %>
+  <%= render Avo::Sidebar::LinkComponent.new label: item.name, path: item.path, target: item.target %>
+<% end %>
+<% if item.is_a? Avo::Menu::Resource %>
+  <%= render Avo::Sidebar::LinkComponent.new label: resource.navigation_label, path: helpers.resources_path(resource: resource) %>
+<% end %>
+<% if item.is_a? Avo::Menu::Dashboard %>
+  <%= render Avo::Sidebar::LinkComponent.new label: dashboard.navigation_label, path: dashboard.navigation_path %>
+<% end %>
+<% if item.is_a? Avo::Menu::Section %>
+  <%= render Avo::Sidebar::SectionComponent.new item: item %>
+<% end %>
+<% if item.is_a? Avo::Menu::Group %>
+  <%= render Avo::Sidebar::GroupComponent.new item: item %>
+<% end %>
+

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class Avo::Sidebar::ItemSwitcherComponent < Avo::Sidebar::BaseItemComponent
+  def resource
+    item.parsed_resource
+  end
+
+  def dashboard
+    item.parsed_dashboard
+  end
+
+  def render?
+    item.visible?
+  end
+end

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

@@ -0,0 +1,12 @@
+<% if path.present? %>
+  <%= send link_method, path, class: classes, active: active, target: target do %>
+    <%= label %>
+    <% if target == :_blank %>
+      <%= helpers.svg('heroicons/outline/external-link', class: 'self-center ml-auto h-3') %>
+    <% end %>
+  <% end %>
+<% else %>
+  <%= content_tag :div, class: classes, active: active, target: target do %>
+    <%= label %>
+  <% end %>
+<% end %>

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+class Avo::Sidebar::LinkComponent < ViewComponent::Base
+  attr_reader :active
+  attr_reader :target
+  attr_reader :label
+  attr_reader :path
+
+  def initialize(label: nil, path: nil, active: :inclusive, target: nil)
+    @label = label
+    @path = path
+    @active = active
+    @target = target
+  end
+
+  def is_external?
+    URI(path).scheme.present?
+  end
+
+  # For external links active_link_to marks them all as active.
+  def link_method
+    is_external? ? :link_to : :active_link_to
+  end
+
+  def classes
+    "px-4 flex-1 flex mx-6 leading-none py-2 text-black rounded font-medium hover:bg-gray-150"
+  end
+end

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

@@ -0,0 +1,15 @@
+<div class="space-y-1"
+  <% if collapsable %>
+    data-controller="menu"
+    data-menu-target="self"
+    data-menu-key-param="<%= key %>"
+    data-menu-collapsed-param="<%= 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">
+    <% items.each do |item| %>
+      <%= render Avo::Sidebar::ItemSwitcherComponent.new item: item %>
+    <% end %>
+  </div>
+</div>

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

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class Avo::Sidebar::SectionComponent < Avo::Sidebar::BaseItemComponent
+  def icon
+    return nil if item.icon.nil?
+
+    item.icon
+  end
+end

data/app/components/avo/sidebar_component.html.erb

@@ -7,41 +7,50 @@
       </div>
     </div>
     <div class="flex-1 flex flex-col justify-between overflow-auto mt-3">
-      <div class="space-y-6">
-        <%= render Avo::SidebarItemComponent.new label: 'Get started', path: helpers.avo.root_path, active: :exclusive if Rails.env.development? && Avo.configuration.home_path.nil?  %>
+      <div class="space-y-6 mb-4">
+        <%= render Avo::Sidebar::LinkComponent.new label: 'Get started', path: helpers.avo.root_path, active: :exclusive if Rails.env.development? && Avo.configuration.home_path.nil? %>
 
-        <% if dashboards.present? %>
-          <div>
-            <%= render Avo::SidebarHeadingComponent.new label: t('avo.dashboards'), icon: helpers.svg('dashboards-icon', class: 'h-4') %>
-
-            <div class="w-full space-y-1">
-              <% dashboards.sort_by { |r| r.navigation_label }.each do |dashboard| %>
-                <%= render Avo::SidebarItemComponent.new label: dashboard.navigation_label, path: dashboard.navigation_path %>
-              <% end %>
-            </div>
+        <% if Avo::App.license.has_with_trial(:menu_editor) && Avo.configuration.main_menu.present? %>
+          <div class="text-black space-y-4">
+            <% Avo::App.main_menu.items.each do |item| %>
+              <%= render Avo::Sidebar::ItemSwitcherComponent.new item: item %>
+            <% end %>
           </div>
-        <% end %>
+        <% else %>
 
-        <div>
-          <%= render Avo::SidebarHeadingComponent.new label: t('avo.resources'), icon: helpers.svg('resources-icon', class: 'h-4') %>
+          <% if dashboards.present? %>
+            <div>
+              <%= render Avo::Sidebar::HeadingComponent.new label: t('avo.dashboards'), icon: helpers.svg('dashboards', class: 'h-4') %>
 
-          <div class="w-full space-y-1">
-            <% resources.sort_by { |r| r.navigation_label }.each do |resource| %>
-              <%= render Avo::SidebarItemComponent.new label: resource.navigation_label, path: helpers.resources_path(resource: resource) %>
-            <% end %>
-          </div>
-        </div>
+              <div class="w-full space-y-1">
+                <% dashboards.sort_by { |r| r.navigation_label }.each do |dashboard| %>
+                  <%= render Avo::Sidebar::LinkComponent.new label: dashboard.navigation_label, path: dashboard.navigation_path %>
+                <% end %>
+              </div>
+            </div>
+          <% end %>
 
-        <% if tools.present? %>
           <div>
-            <%= render Avo::SidebarHeadingComponent.new label: t('avo.tools'), icon: helpers.svg('tools-icon', class: 'h-4') %>
+            <%= render Avo::Sidebar::HeadingComponent.new label: t('avo.resources'), icon: helpers.svg('resources', class: 'h-4') %>
 
             <div class="w-full space-y-1">
-              <% tools.each do |partial| %>
-                <%= render partial: "/avo/sidebar/items/#{partial}" %>
+              <% resources.sort_by { |r| r.navigation_label }.each do |resource| %>
+                <%= render Avo::Sidebar::LinkComponent.new label: resource.navigation_label, path: helpers.resources_path(resource: resource) %>
               <% end %>
             </div>
           </div>
+
+          <% if tools.present? %>
+            <div>
+              <%= render Avo::Sidebar::HeadingComponent.new label: t('avo.tools'), icon: helpers.svg('tools', class: 'h-4') %>
+
+              <div class="w-full space-y-1">
+                <% tools.each do |partial| %>
+                  <%= render partial: "/avo/sidebar/items/#{partial}" %>
+                <% end %>
+              </div>
+            </div>
+          <% end %>
         <% end %>
 
         <%= render partial: "/avo/partials/sidebar_extra" %>

data/app/components/avo/sidebar_component.rb

@@ -2,20 +2,14 @@
 
 class Avo::SidebarComponent < ViewComponent::Base
   def dashboards
-    return [] if Avo::App.license.lacks_with_trial(:dashboards)
-
-    Avo::App.get_dashboards(helpers._current_user).select do |dashboard|
-      dashboard.is_visible?
-    end
+    Avo::App.dashboards_for_navigation
   end
 
   def resources
-    Avo::App.resources_navigation(helpers._current_user)
+    Avo::App.resources_for_navigation
   end
 
   def tools
-    return [] if Avo::App.license.lacks_with_trial(:custom_tools)
-
-    Avo::App.get_sidebar_partials
+    Avo::App.tools_for_navigation
   end
 end

data/app/components/avo/sidebar_profile_component.html.erb

@@ -25,8 +25,17 @@
         class="hidden absolute flex flex-col inset-auto right-0 -mt-12 bg-white rounded min-w-[200px] shadow-context -translate-y-full"
         data-toggle-panel-target="panel"
       >
+        <% if Avo::App.license.has_with_trial(:menu_editor) && Avo.configuration.profile_menu.present? %>
+          <div class="text-black space-y-4">
+            <% Avo::App.profile_menu.items.each do |item| %>
+              <% if item.is_a? Avo::Menu::Link %>
+                <%= render Avo::ProfileItemComponent.new label: item.name, path: item.path, icon: item.icon %>
+              <% end %>
+            <% end %>
+          </div>
+        <% end %>
         <%# Example link below %>
-        <%#= render Avo::ProfileItemComponent.new label: 'Profile', path: '/profile', icon: helpers.svg('user-circle', class: 'h-4 mr-1') %>
+        <%#= render Avo::ProfileItemComponent.new label: 'Profile', path: '/profile', icon: 'user-circle' %>
         <%= button_to helpers.main_app.send(destroy_user_session_path),
           method: :delete,
           form: { "data-turbo" => "false" },

data/app/controllers/avo/application_controller.rb

@@ -19,7 +19,6 @@ module Avo
     before_action :set_container_classes
     before_action :add_initial_breadcrumbs
     before_action :set_view
-    before_action :set_model_to_fill
 
     rescue_from Pundit::NotAuthorizedError, with: :render_unauthorized
     rescue_from ActiveRecord::RecordInvalid, with: :exception_logger
@@ -285,7 +284,7 @@ module Avo
     end
 
     def set_locale
-      I18n.locale = params[:locale] || I18n.default_locale
+      I18n.locale = params[:set_locale] || I18n.default_locale
 
       I18n.default_locale = I18n.locale
     end

data/app/helpers/avo/application_helper.rb

@@ -71,6 +71,8 @@ module Avo
     end
 
     def svg(file_name, **args)
+      return if file_name.nil?
+
       options = {}
       options[:class] = args[:class].present? ? args[:class] : ""
       options[:class] += args[:extra_class].present? ? " #{args[:extra_class]}" : ""

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

@@ -0,0 +1,60 @@
+import { Controller } from '@hotwired/stimulus'
+import isNull from 'lodash/isNull'
+
+export default class extends Controller {
+  static targets = ['svg', 'items', 'self'];
+
+  collapsed = false;
+
+  get key() {
+    return this.selfTarget.getAttribute('data-menu-key-param')
+  }
+
+  defaultState() {
+    return this.selfTarget.getAttribute('data-menu-collapsed-param') === 'collapsed'
+  }
+
+  connect() {
+    if (this.getState() === 'collapsed') {
+      this.collapsed = true
+      this.markCollapsed()
+    } else if (isNull(this.getState()) && this.defaultState()) {
+      this.collapsed = true
+      this.markCollapsed()
+    }
+  }
+
+  triggerCollapse() {
+    this.collapsed = !this.collapsed
+
+    this.updateDom()
+  }
+
+  updateDom() {
+    if (this.collapsed) {
+      this.markCollapsed()
+    } else {
+      this.markExpanded()
+    }
+  }
+
+  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/app/javascript/js/controllers.js

@@ -15,6 +15,7 @@ import ItemSelectAllController from './controllers/item_select_all_controller'
 import ItemSelectorController from './controllers/item_selector_controller'
 import KeyValueController from './controllers/fields/key_value_controller'
 import LoadingButtonController from './controllers/loading_button_controller'
+import MenuController from './controllers/menu_controller'
 import MobileController from './controllers/mobile_controller'
 import ModalController from './controllers/modal_controller'
 import MultipleSelectFilterController from './controllers/multiple_select_filter_controller'
@@ -39,6 +40,7 @@ application.register('hidden-input', HiddenInputController)
 application.register('item-select-all', ItemSelectAllController)
 application.register('item-selector', ItemSelectorController)
 application.register('loading-button', LoadingButtonController)
+application.register('menu', MenuController)
 application.register('mobile', MobileController)
 application.register('modal', ModalController)
 application.register('multiple-select-filter', MultipleSelectFilterController)

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

@@ -11,7 +11,7 @@
   end
   set_value = {} if set_value.nil?
 %>
-<div data-controller="boolean-filter">
+<div data-controller="boolean-filter" data-filter-name="<%= filter.name %>">
   <%= filter_wrapper name: filter.name do %>
     <div class="flex items-center">
       <div class="space-y-2">

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

@@ -1,12 +1,15 @@
 <%
+  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]))
-    set_value = decoded_filters_param[filter.class.to_s]
-  rescue => exception
-    set_value = filter.options.keys
+    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">
+<div data-controller="multiple-select-filter" data-filter-name="<%= filter.name %>">
   <%= filter_wrapper name: filter.name do %>
     <%= select_tag filter.id, options_for_select(filter.options.invert, set_value),
       class: input_classes('w-full mb-0'),

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

@@ -6,7 +6,7 @@
     set_value = filter.default
   end
 %>
-<div data-controller="select-filter">
+<div data-controller="select-filter" data-filter-name="<%= filter.name %>">
   <%= filter_wrapper name: filter.name do %>
     <%= select_tag filter.id, options_for_select(filter.options.invert, set_value),
       class: input_classes('w-full mb-0'),

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

@@ -6,7 +6,7 @@
     set_value = filter.default
   end
 %>
-<div data-controller="text-filter">
+<div data-controller="text-filter" data-filter-name="<%= filter.name %>">
   <%= filter_wrapper name: filter.name do %>
     <%= text_field_tag filter.id, set_value,
       class: input_classes('w-full mb-0'),

data/avo.gemspec

@@ -47,4 +47,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency "breadcrumbs_on_rails"
   spec.add_dependency "chartkick"
   spec.add_dependency "dry-initializer"
+  spec.add_dependency "docile"
 end