avo 2.2.2 → 2.3.1.pre.2

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

@@ -12,7 +12,7 @@ class Avo::Sidebar::BaseItemComponent < ViewComponent::Base
   end
 
   def key
-    result = "avo.#{request.host}.main_menu.#{item.name.underscore}"
+    result = "avo.#{request.host}.main_menu.#{item.name.to_s.underscore}"
 
     if item.icon.present?
       result += ".#{item.icon.parameterize.underscore}"

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

@@ -3,24 +3,26 @@
     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 ">
-    <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'%>
+  <% if item.name.present? %>
+    <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>
-    <% end %>
-  </div>
-  <div class="w-full space-y-1" data-menu-target="items">
+      <% if collapsable %>
+        <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"%>
+        </div>
+      <% end %>
+    </div>
+  <% end %>
+  <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

@@ -1,13 +1,13 @@
-<div class="space-y-1"
+<div class="space-y-1 mb-4"
   <% if collapsable %>
     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/components/avo/sidebar_component.html.erb

@@ -11,7 +11,7 @@
         <%= 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 Avo::App.license.has_with_trial(:menu_editor) && Avo.configuration.main_menu.present? %>
-          <div class="text-black space-y-4">
+          <div class="text-black">
             <% Avo::App.main_menu.items.each do |item| %>
               <%= render Avo::Sidebar::ItemSwitcherComponent.new item: item %>
             <% end %>

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

@@ -16,27 +16,25 @@
       <% end %>
     <% end %>
     <% c.body do %>
-      <% if @resource.search_query.present? || @filters.present? || available_view_types.count > 1 %>
-        <div class="flex flex-col xs:flex-row xs:justify-between space-y-2 xs:space-y-0 py-4"
-          data-selected-resources-name="<%= @resource.model_key %>"
-          data-selected-resources="[]"
-        >
-          <% if @resource.search_query.present? %>
-            <div class="flex items-center px-4 w-64">
-              <%= render partial: 'avo/partials/resource_search', locals: {resource: @resource.model_key} %>
-            </div>
-          <% else %>
-            <%# Offset for the space-y-2 property when the serach is missing %>
-            <div class="-mb-2"></div>
-          <% end %>
-          <% if @filters.present? || available_view_types.count > 1 %>
-            <div class="justify-self-end flex justify-start xs:justify-end items-center px-4 space-x-3">
-              <%= render Avo::FiltersComponent.new filters: @filters, resource: @resource %>
-              <%= render partial: 'avo/partials/view_toggle_button', locals: { available_view_types: available_view_types, view_type: view_type, turbo_frame: @turbo_frame } if available_view_types.count > 1 %>
-            </div>
-          <% end %>
-        </div>
-      <% end %>
+      <div class="flex flex-col xs:flex-row xs:justify-between space-y-2 xs:space-y-0 py-4 <%= 'hidden' if @resource.search_query.nil? && @filters.empty? && available_view_types.count <= 1 %>"
+        data-selected-resources-name="<%= @resource.model_key %>"
+        data-selected-resources="[]"
+      >
+        <% if @resource.search_query.present? %>
+          <div class="flex items-center px-4 w-64">
+            <%= render partial: 'avo/partials/resource_search', locals: {resource: @resource.model_key} %>
+          </div>
+        <% else %>
+          <%# Offset for the space-y-2 property when the serach is missing %>
+          <div class="-mb-2"></div>
+        <% end %>
+        <% if @filters.present? || available_view_types.count > 1 %>
+          <div class="justify-self-end flex justify-start xs:justify-end items-center px-4 space-x-3">
+            <%= render Avo::FiltersComponent.new filters: @filters, resource: @resource %>
+            <%= render partial: 'avo/partials/view_toggle_button', locals: { available_view_types: available_view_types, view_type: view_type, turbo_frame: @turbo_frame } if available_view_types.count > 1 %>
+          </div>
+        <% end %>
+      </div>
       <% if view_type.to_sym == :table %>
         <% if @resources.present? %>
           <div class="w-full overflow-auto flex flex-col mt-0">

data/app/controllers/avo/actions_controller.rb

@@ -34,7 +34,7 @@ module Avo
     private
 
     def action_params
-      params.permit(:resource_name, :action_id, fields: {})
+      params.permit(:authenticity_token, :resource_name, :action_id, fields: {})
     end
 
     def set_action

data/app/controllers/avo/application_controller.rb

@@ -275,8 +275,12 @@ module Avo
       request.original_url.match?(/.*#{Avo::App.root_path}\/dashboards\/.*/)
     end
 
+    def on_debug_path
+      request.original_url.match?(/.*#{Avo::App.root_path}\/avo_private\/debug.*/)
+    end
+
     def on_custom_tool_page
-      !(on_root_path || on_resources_path || on_api_path || on_dashboards_path)
+      !(on_root_path || on_resources_path || on_api_path || on_dashboards_path || on_debug_path)
     end
 
     def model_param_key

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

@@ -0,0 +1,24 @@
+require_dependency "avo/application_controller"
+
+module Avo
+  class DebugController < ApplicationController
+    def index
+    end
+
+    def refresh_license
+      license = Licensing::LicenseManager.refresh_license request
+
+      if license.valid?
+        flash[:notice] = "avohq.io responded: \"#{license.id.humanize} license is valid\"."
+      else
+        if license.response['reason'].present?
+          flash[:error] = "avohq.io responded: \"#{license.response['reason']}\"."
+        else
+          flash[:error] = license.response['error']
+        end
+      end
+
+      redirect_back fallback_location: avo.avo_private_debug_index_path
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+import { Controller } from '@hotwired/stimulus'
+
+export default class extends Controller {
+  copy() {
+    const str = this.context.element.dataset.text
+    /* ——— Derived from: https://hackernoon.com/copying-text-to-clipboard-with-javascript-df4d4988697f
+          improved to add iOS device compatibility——— */
+    const el = document.createElement('textarea') // Create a <textarea> element
+
+    const storeContentEditable = el.contentEditable
+    const storeReadOnly = el.readOnly
+
+    el.value = str // Set its value to the string that you want copied
+    el.contentEditable = true
+    el.readOnly = false
+    el.setAttribute('readonly', false) // Make it readonly false for iOS compatability
+    el.setAttribute('contenteditable', true) // Make it editable for iOS
+    el.style.position = 'absolute'
+    el.style.left = '-9999px' // Move outside the screen to make it invisible
+    document.body.appendChild(el) // Append the <textarea> element to the HTML document
+    const selected = document.getSelection().rangeCount > 0 // Check if there is any content selected previously
+      ? document.getSelection().getRangeAt(0) // Store selection if found
+      : false // Mark as false to know no selection existed before
+    el.select() // Select the <textarea> content
+    el.setSelectionRange(0, 999999)
+    document.execCommand('copy') // Copy - only works as a result of a user action (e.g. click events)
+    document.body.removeChild(el) // Remove the <textarea> element
+    if (selected) {
+      // If a selection existed before copying
+      document.getSelection().removeAllRanges() // Unselect everything on the HTML document
+      document.getSelection().addRange(selected) // Restore the original selection
+    }
+
+    el.contentEditable = storeContentEditable
+    el.readOnly = storeReadOnly
+  }
+}

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/app/javascript/js/controllers.js

@@ -7,6 +7,7 @@ import AttachmentsController from './controllers/attachments_controller'
 import BelongsToFieldController from './controllers/fields/belongs_to_field_controller'
 import BooleanFilterController from './controllers/boolean_filter_controller'
 import CodeFieldController from './controllers/fields/code_field_controller'
+import CopyToClipboardController from './controllers/copy_to_clipboard_controller'
 import DashboardCardController from './controllers/dashboard_card_controller'
 import DateFieldController from './controllers/fields/date_field_controller'
 import FilterController from './controllers/filter_controller'
@@ -34,6 +35,7 @@ application.register('actions-picker', ActionsPickerController)
 application.register('alerts', AlertsController)
 application.register('attachments', AttachmentsController)
 application.register('boolean-filter', BooleanFilterController)
+application.register('copy-to-clipboard', CopyToClipboardController)
 application.register('dashboard-card', DashboardCardController)
 application.register('filter', FilterController)
 application.register('hidden-input', HiddenInputController)

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

@@ -0,0 +1,87 @@
+<%
+  license = Avo::App.license
+  information_items = [
+    'license',
+    'license_key',
+    'ruby_version',
+    'rails_version',
+    'environment',
+    'host',
+    'port',
+    'ip',
+    'app_name',
+  ]
+  hq_payload = Avo::Licensing::HQ.new(request).payload
+%>
+<div class="flex flex-col">
+  <%= render Avo::PanelComponent.new title: 'Debug Avo', description: 'Use this page to debug the Avo license.' do |c| %>
+    <% c.tools do %>
+    <% end %>
+    <% c.bare_content do %>
+      <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>
+              <div class="text-xl font-semibold"><%= license.name %></div>
+              <% if license.response['reason'] %>
+                <dl>
+                  <dt class="font-semibold text-sm">Error</dt>
+                  <dd class="text-red-600"><%= license.response['reason'] %></dd>
+                </dl>
+              <% end %>
+              <% if license.response['error'] %>
+                <dl>
+                  <dt class="font-semibold text-sm">Error</dt>
+                  <dd class="text-red-600"><%= license.response['error'] %></dd>
+                  <dt class="font-semibold text-sm">Exception message</dt>
+                  <dd class="text-red-600"><%= license.response['exception_message'] %></dd>
+                </dl>
+              <% end %>
+              <div class="mt-4">
+                <dl>
+                  <% information_items.each do |item| %>
+                    <dt class="font-semibold text-sm"><%= item.humanize %></dt>
+                    <dd><%= license.response[item] %></dd>
+                  <% end %>
+                  <dt class="font-semibold text-sm">Last fetched at</dt>
+                  <dd><%= license.response['fetched_at'] %> <br>
+                     (<%= time_ago_in_words license.response['fetched_at'] %> ago)</dd>
+                  <dt class="font-semibold text-sm">Cache store</dt>
+                  <dd><%= Avo::App.cache_store.class.to_s %> - <%= Avo::App.cache_store.options.inspect %></dd>
+                </dl>
+              </div>
+            </div>
+            <div class="flex justify-end mt-4">
+              <%= a_button style: :outline,
+                color: :blue,
+                url: '/admin/avo_private/debug/refresh_license',
+                method: :post,
+                loading: true,
+                icon: 'heroicons/outline/refresh' do %>
+                Refresh license
+              <% end %>
+            </div>
+          </div>
+        </div>
+        <div class="relative bg-white rounded shadow-panel p-4 space-y-4 col-span-2">
+          <div class="font-semibold">Debug report</div>
+          <div>
+            <%== ap Avo::App.debug_report(request) %>
+          </div>
+          <div class="flex justify-end">
+            <%= a_button icon: 'heroicons/outline/clipboard',
+              style: :primary,
+              data: {
+                controller: 'copy-to-clipboard',
+                action: "click->copy-to-clipboard#copy",
+                text: Avo::App.debug_report(request),
+              } do %>
+              Copy debug info
+            <% end %>
+          </div>
+        </div>
+      </div>
+    <% end %>
+  <% end %>
+</div>

data/config/routes.rb

@@ -39,8 +39,11 @@ Avo::Engine.routes.draw do
     delete "/:resource_name/:id/:related_name/:related_id", to: "associations#destroy", as: "associations_destroy"
   end
 
+  get "/debug", to: "debug#index", as: "debug_index"
+  post "/debug/refresh_license", to: "debug#refresh_license"
+
   if Rails.env.development? or Rails.env.staging?
-    scope "avo_private", as: "avo_private" do
+    scope "/avo_private", as: "avo_private" do
       get "/design", to: "private#design"
     end
   end

data/lib/avo/app.rb

@@ -115,6 +115,24 @@ module Avo
 
         Avo::Menu::Builder.parse_menu(&Avo.configuration.profile_menu)
       end
+
+      def debug_report(request)
+        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[:app_timezone] = Time.now.zone
+
+        payload
+      rescue => e
+        e
+      end
     end
   end
 end

data/lib/avo/licensing/h_q.rb

@@ -13,13 +13,62 @@ module Avo
       end
 
       def response
-        @hq_response || request
+        make_request
+      end
+
+      def fresh_response
+        make_request(fresh: true)
+      end
+
+      def payload
+        {
+          license: Avo.configuration.license,
+          license_key: Avo.configuration.license_key,
+          avo_version: Avo::VERSION,
+          rails_version: Rails::VERSION::STRING,
+          ruby_version: RUBY_VERSION,
+          environment: Rails.env,
+          ip: current_request.ip,
+          host: current_request.host,
+          port: current_request.port,
+          app_name: app_name
+        }
+      end
+
+      def avo_metadata
+        resources = App.resources
+        field_definitions = resources.map(&:get_field_definitions)
+        fields_count = field_definitions.map(&:count).sum
+        fields_per_resource = sprintf("%0.01f", fields_count / (resources.count + 0.0))
+
+        field_types = {}
+        custom_fields_count = 0
+        field_definitions.each do |fields|
+          fields.each do |field|
+            field_types[field.type] ||= 0
+            field_types[field.type] += 1
+
+            custom_fields_count += 1 if field.custom?
+          end
+        end
+
+        {
+          resources_count: resources.count,
+          fields_count: fields_count,
+          fields_per_resource: fields_per_resource,
+          custom_fields_count: custom_fields_count,
+          field_types: field_types,
+          **other_metadata(:actions),
+          **other_metadata(:filters),
+          main_menu_present: Avo::App.main_menu.present?,
+          profile_menu_present: Avo::App.profile_menu.present?,
+        }
       end
 
       private
 
-      def request
-        return cached_response if has_cached_response
+      def make_request(fresh: false)
+        return cached_response if has_cached_response && !fresh
 
         begin
           perform_and_cache_request
@@ -51,13 +100,12 @@ module Avo
       def cache_response(time, response)
         response.merge!(
           expiry: time,
+          fetched_at: Time.now,
           **payload
         ).stringify_keys!
 
         @cache_store.write(CACHE_KEY, response, expires_in: time)
 
-        @hq_response = response
-
         response
       end
 
@@ -67,55 +115,12 @@ module Avo
         HTTParty.post ENDPOINT, body: payload.to_json, headers: {'Content-type': "application/json"}, timeout: REQUEST_TIMEOUT
       end
 
-      def payload
-        {
-          license: Avo.configuration.license,
-          license_key: Avo.configuration.license_key,
-          avo_version: Avo::VERSION,
-          rails_version: Rails::VERSION::STRING,
-          ruby_version: RUBY_VERSION,
-          environment: Rails.env,
-          ip: current_request.ip,
-          host: current_request.host,
-          port: current_request.port,
-          app_name: app_name
-        }
-      end
-
       def app_name
         Rails.application.class.to_s.split("::").first
       rescue
         nil
       end
 
-      def avo_metadata
-        resources = App.resources
-        field_definitions = resources.map(&:get_field_definitions)
-        fields_count = field_definitions.map(&:count).sum
-        fields_per_resource = sprintf("%0.01f", fields_count / (resources.count + 0.0))
-
-        field_types = {}
-        custom_fields_count = 0
-        field_definitions.each do |fields|
-          fields.each do |field|
-            field_types[field.type] ||= 0
-            field_types[field.type] += 1
-
-            custom_fields_count += 1 if field.custom?
-          end
-        end
-
-        {
-          resources_count: resources.count,
-          fields_count: fields_count,
-          fields_per_resource: fields_per_resource,
-          custom_fields_count: custom_fields_count,
-          field_types: field_types,
-          **other_metadata(:actions),
-          **other_metadata(:filters),
-        }
-      end
-
       def other_metadata(type = :actions)
         resources = App.resources
 

data/lib/avo/licensing/license.rb

@@ -59,6 +59,14 @@ module Avo
       def lacks_with_trial(ability)
         !has_with_trial ability
       end
+
+      def name
+        if id.present?
+          id.humanize
+        else
+          self.class.to_s.split('::').last.underscore.humanize.gsub ' license', ''
+        end
+      end
     end
   end
 end