avo 2.1.2.pre2 → 2.2.2

data/app/components/avo/views/resource_show_component.html.erb

@@ -35,12 +35,12 @@
                 method: :delete,
                 local: true,
                 title: t('avo.delete_item', item: @resource.model.model_name.name.downcase).capitalize,
-                spinner: true,
+                loading: true,
+                confirm: t('avo.are_you_sure', item: @resource.model.model_name.name.downcase),
                 color: :red,
                 icon: 'trash',
                 form_class: 'flex flex-col sm:flex-row sm:inline-flex',
                 data: {
-                  confirm: t('avo.are_you_sure', item: @resource.model.model_name.name.downcase),
                   control: :destroy,
                   'resource-id': @resource.model.id,
                   'tippy': 'tooltip',

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/controllers/avo/base_controller.rb

@@ -44,7 +44,7 @@ module Avo
         unless @index_params[:sort_by].eql? :created_at
           @query = @query.unscope(:order)
         end
-        @query = @query.order(Arel.sql("#{@resource.model_class.table_name}.#{@index_params[:sort_by]} #{@index_params[:sort_direction]}"))
+        @query = @query.order("#{@resource.model_class.table_name}.#{@index_params[:sort_by]} #{@index_params[:sort_direction]}")
       end
 
       # Apply filters

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/loading_button_controller.js

@@ -1,3 +1,4 @@
+/* eslint-disable no-alert */
 import { Controller } from '@hotwired/stimulus'
 
 export default class extends Controller {
@@ -6,17 +7,53 @@ export default class extends Controller {
   <div class="double-bounce2"></div>
 </div>`;
 
+  confirmed = false
+
   connect() {
-    const button = this.context.scope.element
-    this.context.scope.element.addEventListener('click', () => {
-      button.style.width = `${button.getBoundingClientRect().width}px`
-      button.style.height = `${button.getBoundingClientRect().height}px`
-      button.innerHTML = this.spinnerMarkup
-      button.classList.add('justify-center')
-
-      setTimeout(() => {
-        button.setAttribute('disabled', 'disabled')
-      }, 1)
+    this.context.scope.element.addEventListener('click', (e) => {
+      // If the user has to confirm the action
+      if (this.confirmationMessage) {
+        // Intervene only if not confirmed
+        if (!this.confirmed) {
+          e.preventDefault()
+          if (window.confirm(this.confirmationMessage)) {
+            this.applyLoader()
+          }
+        }
+      } else {
+        this.applyLoader()
+      }
     })
   }
+
+  get button() {
+    return this.context.scope.element
+  }
+
+  get confirmationMessage() {
+    return this.context.scope.element.getAttribute('data-avo-confirm')
+  }
+
+  applyLoader() {
+    const { button } = this
+
+    button.style.width = `${button.getBoundingClientRect().width}px`
+    button.style.height = `${button.getBoundingClientRect().height}px`
+    button.innerHTML = this.spinnerMarkup
+    button.classList.add('justify-center')
+
+    setTimeout(() => {
+      this.markConfirmed()
+      button.click()
+      button.setAttribute('disabled', 'disabled')
+    }, 1)
+  }
+
+  markConfirmed() {
+    this.confirmed = true
+  }
+
+  markUnconfirmed() {
+    this.confirmed = false
+  }
 }

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/search_controller.js

@@ -88,6 +88,9 @@ export default class extends Controller {
     } else {
       Turbo.visit(item._url, { action: 'advance' })
     }
+
+    // On searchable belongs to the class `aa-Detached` remains on the body making it unscrollable
+    document.body.classList.remove('aa-Detached')
   }
 
   addSource(resourceName, data) {
@@ -102,7 +105,7 @@ export default class extends Controller {
           return `${data.header.toUpperCase()} ${data.help}`
         },
         item({ item, createElement }) {
-          let element = ''
+          const children = []
 
           if (item._avatar) {
             let classes
@@ -117,22 +120,37 @@ export default class extends Controller {
                 break
             }
 
-            element += `<img src="${item._avatar}" alt="${item._label}" class="flex-shrink-0 w-8 h-8 my-[2px] inline mr-2 ${classes}" />`
+            children.push(
+              createElement('img', {
+                src: item._avatar,
+                alt: item._label,
+                class: `flex-shrink-0 w-8 h-8 my-[2px] inline mr-2 ${classes}`,
+              }),
+            )
           }
-          element += `<div>${item._label}`
 
+          const labelChildren = [item._label]
           if (item._description) {
-            element += `<div class="aa-ItemDescription">${item._description}</div>`
+            labelChildren.push(
+              createElement(
+                'div',
+                {
+                  class: 'aa-ItemDescription',
+                },
+                item._description,
+              ),
+            )
           }
 
-          element += '</div>'
+          children.push(createElement('div', null, labelChildren))
 
-          return createElement('div', {
-            class: 'flex',
-            dangerouslySetInnerHTML: {
-              __html: element,
+          return createElement(
+            'div',
+            {
+              class: 'flex',
             },
-          })
+            children,
+          )
         },
         noResults() {
           return that.translationKeys.no_item_found.replace(

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/app/views/avo/partials/_table_header.html.erb

@@ -1,10 +1,11 @@
-
 <thead class="bg-white border-b border-gray-200 pb-1">
-  <th class="rounded-lg">
-    <%== item_select_all_input %>
-  </th>
-  <%
-    fields.each_with_index do |field, index|
+  <% if @resource.record_selector %>
+    <th class="rounded-lg">
+      <%== item_select_all_input %>
+    </th>
+  <% end %>
+  <% fields.each_with_index do |field, index|  %>
+    <%
       if params[:sort_by] == field.id.to_s
         if params[:sort_direction] == 'asc'
           sort_by = nil
@@ -28,8 +29,7 @@
         sort_by = field.id
         sort_direction = 'desc'
       end
-      classes = "text-gray-500 tracking-tight leading-tight text-sm font-semibold"
-  %>
+      classes = "text-gray-500 tracking-tight leading-tight text-sm font-semibold" %>
     <th class="text-left uppercase px-3 py-4 whitespace-nowrap rounded-l">
       <% if field.sortable %>
         <%= link_to params.permit!.merge(sort_by: sort_by, sort_direction: sort_direction), class: "flex items-center #{classes} #{'cursor-pointer' if field.sortable}", 'data-turbo-frame': params[:turbo_frame] do %>
@@ -37,14 +37,13 @@
           <%= render partial: 'avo/partials/sortable_component', locals: {field: field} %>
         <% end %>
       <% else %>
-          <div class="flex items-center <%= classes %>">
-            <%= field.name %>
-          </div>
+        <div class="flex items-center <%= classes %>">
+          <%= field.name %>
+        </div>
       <% end %>
     </th>
   <% end %>
-
   <th class="w-24">
-    <!-- Controls cell -->
+    <!-- Item controls cell -->
   </th>
 </thead>

data/app/views/layouts/avo/application.html.erb

@@ -16,6 +16,9 @@
   <% else %>
     <%= javascript_include_tag "avo", "data-turbo-track": "reload", defer: true %>
     <%= stylesheet_link_tag "avo", "data-turbo-track": "reload", defer: true %>
+    <% if Rails.env.development? %>
+      <%= javascript_include_tag "hotwire-livereload", defer: true %>
+    <% end %>
   <% end %>
 </head>
 <body class="bg-application os-mac">

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

data/bin/helpers.rb

@@ -22,8 +22,14 @@ end
 
 def ask(question:, valid_answers: [])
   puts "\n#{question} (#{valid_answers.join('/')})"
+  # An uppercase option is treated as a default answer.  Otherwise, we disregard case, and always
+  # return the answer in lowercase.
+  default_answer = valid_answers.select { |val| val == val.upcase }.first&.downcase
 
-  input = gets.chomp
+  valid_answers.map!(&:downcase)
+
+  input = gets.downcase.chomp
+  input = default_answer if input == ''
 
   while !valid_answers.include?(input)
     puts 'Invalid input, please try again.'

data/bin/init

@@ -17,7 +17,7 @@ app_root do
   header 'Installing Yarn packages'
   run! 'yarn'
 
-  if use_docker
+  if use_docker == 'y'
     header 'Creating the Docker volume'
     run! 'docker volume create --name=avo-db-data'
 
@@ -28,7 +28,7 @@ app_root do
   header 'Preparing the database'
   run! 'bin/rails db:setup'
 
-  if use_docker
+  if use_docker == 'y'
     header 'Stopping the Docker image'
     run! 'docker-compose stop'
   end

data/lib/avo/app.rb

@@ -1,5 +1,7 @@
 module Avo
   class App
+    include Avo::Concerns::FetchesThings
+
     class_attribute :resources, default: []
     class_attribute :dashboards, default: []
     class_attribute :cache_store, default: nil
@@ -102,96 +104,16 @@ module Avo
           end
       end
 
-      # Returns the Avo dashboard by id
-      def get_dashboard_by_id(id)
-        dashboards.find do |dashboard|
-          dashboard.id == id
-        end
-      end
-
-      # Returns the Avo resource by camelized name
-      #
-      # get_resource_by_name('User') => UserResource
-      def get_resource(resource)
-        resources.find do |available_resource|
-          "#{resource}Resource".safe_constantize == available_resource.class
-        end
-      end
-
-      # Returns the Avo resource by singular snake_cased name
-      #
-      # get_resource_by_name('user') => UserResource
-      def get_resource_by_name(name)
-        get_resource name.singularize.camelize
-      end
-
-      # Returns the Avo resource by singular snake_cased name
-      #
-      # get_resource_by_name('User') => UserResource
-      # get_resource_by_name(User) => UserResource
-      def get_resource_by_model_name(name)
-        resources.find do |resource|
-          resource.model_class.model_name.name == name.to_s
-        end
-      end
-
-      # Returns the Avo resource by singular snake_cased name
-      #
-      # get_resource_by_controller_name('delayed_backend_active_record_jobs') => DelayedJobResource
-      # get_resource_by_controller_name('users') => UserResource
-      def get_resource_by_controller_name(name)
-        resources.find do |resource|
-          resource.model_class.to_s.pluralize.underscore.tr("/", "_") == name.to_s
-        end
-      end
-
-      # Returns the Rails model class by singular snake_cased name
-      #
-      # get_model_class_by_name('user') => User
-      def get_model_class_by_name(name)
-        name.to_s.camelize.singularize
-      end
+      def main_menu
+        return nil if Avo::App.license.lacks_with_trial(:menu_builder)
 
-      def get_available_resources(user = nil)
-        resources.select do |resource|
-          Services::AuthorizationService.authorize user, resource.model_class, Avo.configuration.authorization_methods.stringify_keys["index"], raise_exception: false
-        end
-          .sort_by { |r| r.name }
+        Avo::Menu::Builder.parse_menu(&Avo.configuration.main_menu)
       end
 
-      def get_available_dashboards(user = nil)
-        dashboards.sort_by { |r| r.name }
-      end
+      def profile_menu
+        return nil if Avo::App.license.lacks_with_trial(:menu_builder)
 
-      def resources_navigation(user = nil)
-        get_available_resources(user)
-          .select do |resource|
-            resource.model_class.present?
-          end
-          .select do |resource|
-            resource.visible_on_sidebar
-          end
-      end
-
-      def get_dashboards(user = nil)
-        return [] unless App.license.has_with_trial(:resource_ordering)
-
-        get_available_dashboards(user)
-      end
-
-      # Insert any partials that we find in app/views/avo/sidebar/items.
-      def get_sidebar_partials
-        Dir.glob(Rails.root.join("app", "views", "avo", "sidebar", "items", "*.html.erb"))
-          .map do |path|
-            File.basename path
-          end
-          .map do |filename|
-            # remove the leading underscore (_)
-            filename[0] = ""
-            # remove the extension
-            filename.gsub!(".html.erb", "")
-            filename
-          end
+        Avo::Menu::Builder.parse_menu(&Avo.configuration.profile_menu)
       end
     end
   end

data/lib/avo/base_resource.rb

@@ -43,6 +43,7 @@ module Avo
     class_attribute :after_create_path, default: :show
     class_attribute :after_update_path, default: :show
     class_attribute :invalid_fields
+    class_attribute :record_selector, default: true
 
     class << self
       delegate :t, to: ::I18n
@@ -285,9 +286,6 @@ module Avo
     end
 
     def name
-      # return 'hwhwhw'
-
-
       default = class_name_without_resource.titlecase
 
       return @name if @name.present?

data/lib/avo/concerns/fetches_things.rb

@@ -0,0 +1,127 @@
+module Avo
+  module Concerns
+    module FetchesThings
+      extend ActiveSupport::Concern
+
+      class_methods do
+        # Returns the Avo dashboard by id
+        #
+        # get_dashboard_by_id(:dashy) -> Dashy
+        def get_dashboard_by_id(id)
+          dashboards.find do |dashboard|
+            dashboard.id == id
+          end
+        end
+
+        # Returns the Avo dashboard by name
+        #
+        # get_dashboard_by_name(:dashy) -> Dashy
+        def get_dashboard_by_name(name)
+          dashboards.find do |dashboard|
+            dashboard.name == name
+          end
+        end
+
+        # Returns the Avo resource by camelized name
+        #
+        # get_resource_by_name('User') => UserResource
+        def get_resource(resource)
+          possible_resource = "#{resource}Resource".gsub "ResourceResource", "Resource"
+
+          resources.find do |available_resource|
+            possible_resource.safe_constantize == available_resource.class
+          end
+        end
+
+        # Returns the Avo resource by singular snake_cased name
+        #
+        # get_resource_by_name('user') => UserResource
+        def get_resource_by_name(name)
+          get_resource name.singularize.camelize
+        end
+
+        # Returns the Avo resource by singular snake_cased name
+        #
+        # get_resource_by_name('User') => UserResource
+        # get_resource_by_name(User) => UserResource
+        def get_resource_by_model_name(name)
+          resources.find do |resource|
+            resource.model_class.model_name.name == name.to_s
+          end
+        end
+
+        # Returns the Avo resource by singular snake_cased name
+        #
+        # get_resource_by_controller_name('delayed_backend_active_record_jobs') => DelayedJobResource
+        # get_resource_by_controller_name('users') => UserResource
+        def get_resource_by_controller_name(name)
+          resources.find do |resource|
+            resource.model_class.to_s.pluralize.underscore.tr("/", "_") == name.to_s
+          end
+        end
+
+        # Returns the Avo resource by some name
+        def guess_resource(name)
+          get_resource_by_name(name.to_s) || get_resource_by_model_name(name)
+        end
+
+        # Returns the Rails model class by singular snake_cased name
+        #
+        # get_model_class_by_name('user') => User
+        def get_model_class_by_name(name)
+          name.to_s.camelize.singularize
+        end
+
+        def get_available_resources(user = nil)
+          resources.select do |resource|
+            Services::AuthorizationService.authorize user, resource.model_class, Avo.configuration.authorization_methods.stringify_keys["index"], raise_exception: false
+          end
+            .sort_by { |r| r.name }
+        end
+
+        def get_available_dashboards(user = nil)
+          dashboards.sort_by { |r| r.name }
+        end
+
+        def resources_for_navigation(user = nil)
+          get_available_resources(current_user)
+            .select do |resource|
+              resource.model_class.present?
+            end
+            .select do |resource|
+              resource.visible_on_sidebar
+            end
+        end
+
+        def dashboards_for_navigation(user = nil)
+          return [] if App.license.lacks_with_trial(:resource_ordering)
+
+          get_available_dashboards(user).select do |dashboard|
+            dashboard.is_visible?
+          end
+        end
+
+        # Insert any partials that we find in app/views/avo/sidebar/items.
+        def get_sidebar_partials
+          Dir.glob(Rails.root.join("app", "views", "avo", "sidebar", "items", "*.html.erb"))
+            .map do |path|
+              File.basename path
+            end
+            .map do |filename|
+              # remove the leading underscore (_)
+              filename[0] = ""
+              # remove the extension
+              filename.gsub!(".html.erb", "")
+              filename
+            end
+        end
+
+        def tools_for_navigation
+          return [] if Avo::App.license.lacks_with_trial(:custom_tools)
+
+          get_sidebar_partials
+        end
+      end
+    end
+  end
+end