avo 2.7.0 → 2.9.0

data/app/javascript/js/controllers/fields/tags_field_controller.js

@@ -40,7 +40,6 @@ export default class extends BaseController {
       blacklist: this.disallowedItems,
       enforceWhitelist: this.enforceSuggestions,
       delimiters: this.delimiters.join('|'),
-      maxTags: 10,
       dropdown: {
         maxItems: 20,
         enabled: 0,

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

@@ -22,10 +22,11 @@ export default class extends Controller {
   }
 
   get initiallyCollapsed() {
-    if (this.userState === 'collapsed' || this.defaultState === 'collapsed') return true
-    if (this.userState === 'expanded' || this.defaultState === 'expanded') return false
+    if (this.defaultState === 'collapsed') {
+      return this.userState === 'collapsed'
+    }
 
-    return false
+    return this.userState === 'collapsed'
   }
 
   connect() {

data/app/javascript/js/controllers/resource_edit_controller.js

@@ -0,0 +1,72 @@
+import { Controller } from '@hotwired/stimulus'
+import camelCase from 'lodash/camelCase'
+
+export default class extends Controller {
+  static targets = []
+
+  static values = {
+    view: String,
+  }
+
+  debugOnInput(e) {
+    // eslint-disable-next-line no-console
+    console.log('onInput', e, e.target.value)
+  }
+
+  toggle({ params }) {
+    const { toggleTarget, toggleTargets } = params
+
+    if (toggleTarget) {
+      this.toggleAvoTarget(toggleTarget)
+    }
+
+    if (toggleTargets && toggleTargets.length > 0) {
+      toggleTargets.forEach(this.toggleAvoTarget.bind(this))
+    }
+  }
+
+  disable({ params }) {
+    const { disableTarget, disableTargets } = params
+
+    if (disableTarget) {
+      this.disableAvoTarget(disableTarget)
+    }
+
+    if (disableTargets && disableTargets.length > 0) {
+      disableTargets.forEach(this.disableAvoTarget.bind(this))
+    }
+  }
+
+  // Private
+
+  toggleAvoTarget(targetName) {
+    // compose the default wrapper data value
+    const target = camelCase(targetName)
+    const element = document.querySelector(`[data-resource-edit-target="${target}"]`)
+
+    if (element) {
+      element.classList.toggle('hidden')
+    }
+  }
+
+  disableAvoTarget(targetName) {
+    // compose the default wrapper data value
+    const target = camelCase(targetName)
+
+    // find & disable direct selector
+    document.querySelectorAll(`[data-resource-edit-target="${target}"]`).forEach(this.toggleItemDisabled)
+
+    // find & disable inputs
+    document.querySelectorAll(`[data-resource-edit-target="${target}"] input`).forEach(this.toggleItemDisabled)
+
+    // find & disable select fields
+    document.querySelectorAll(`[data-resource-edit-target="${target}"] select`).forEach(this.toggleItemDisabled)
+
+    // find & disable buttons for belongs_to
+    document.querySelectorAll(`[data-resource-edit-target="${target}"] [data-slot="value"] button`).forEach(this.toggleItemDisabled)
+  }
+
+  toggleItemDisabled(item) {
+    item.disabled = !item.disabled
+  }
+}

data/app/javascript/js/controllers/resource_index_controller.js

@@ -0,0 +1,4 @@
+import { Controller } from '@hotwired/stimulus'
+
+export default class extends Controller {
+}

data/app/javascript/js/controllers/resource_show_controller.js

@@ -0,0 +1,4 @@
+import { Controller } from '@hotwired/stimulus'
+
+export default class extends Controller {
+}

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

@@ -55,7 +55,10 @@ export default class extends Controller {
   searchUrl(query) {
     const url = URI()
 
-    let params = { q: query }
+    return url.segment(this.searchSegments()).search(this.searchParams(query)).toString()
+  }
+
+  searchSegments() {
     let segments = [
       window.Avo.configuration.root_path,
       'avo_api',
@@ -67,6 +70,19 @@ export default class extends Controller {
       segments = [window.Avo.configuration.root_path, 'avo_api', 'search']
     }
 
+    return segments
+  }
+
+  searchParams(query) {
+    let params = {
+      q: query,
+      global: false,
+    }
+
+    if (this.isGlobalSearch) {
+      params.global = true
+    }
+
     if (this.isBelongsToSearch) {
       params = {
         ...params,
@@ -85,13 +101,13 @@ export default class extends Controller {
       }
     }
 
-    return url.segment(segments).search(params).toString()
+    return params
   }
 
   handleOnSelect({ item }) {
     if (this.isBelongsToSearch) {
-      this.hiddenIdTarget.setAttribute('value', item._id)
-      this.buttonTarget.setAttribute('value', item._label)
+      this.updateFieldAttribute(this.hiddenIdTarget, 'value', item._id)
+      this.updateFieldAttribute(this.buttonTarget, 'value', item._label)
 
       document.querySelector('.aa-DetachedOverlay').remove()
 
@@ -180,7 +196,7 @@ export default class extends Controller {
   }
 
   clearValue() {
-    this.clearValueTargets.map((e) => e.setAttribute('value', ''))
+    this.clearValueTargets.map((t) => this.updateFieldAttribute(t, 'value', ''))
     this.clearButtonTarget.classList.add('hidden')
   }
 
@@ -229,4 +245,11 @@ export default class extends Controller {
       this.buttonTarget.removeAttribute('disabled')
     }
   }
+
+  // Private
+
+  updateFieldAttribute(target, attribute, value) {
+    target.setAttribute(attribute, value)
+    target.dispatchEvent(new Event('input'))
+  }
 }

data/app/javascript/js/controllers.js

@@ -20,6 +20,9 @@ import MobileController from './controllers/mobile_controller'
 import ModalController from './controllers/modal_controller'
 import MultipleSelectFilterController from './controllers/multiple_select_filter_controller'
 import PerPageController from './controllers/per_page_controller'
+import ResourceEditController from './controllers/resource_edit_controller'
+import ResourceIndexController from './controllers/resource_index_controller'
+import ResourceShowController from './controllers/resource_show_controller'
 import SearchController from './controllers/search_controller'
 import SelectController from './controllers/select_controller'
 import SelectFilterController from './controllers/select_filter_controller'
@@ -46,6 +49,9 @@ application.register('mobile', MobileController)
 application.register('modal', ModalController)
 application.register('multiple-select-filter', MultipleSelectFilterController)
 application.register('per-page', PerPageController)
+application.register('resource-edit', ResourceEditController)
+application.register('resource-index', ResourceIndexController)
+application.register('resource-show', ResourceShowController)
 application.register('search', SearchController)
 application.register('select', SelectController)
 application.register('select-filter', SelectFilterController)
@@ -61,3 +67,5 @@ application.register('date-field', DateFieldController)
 application.register('key-value', KeyValueController)
 application.register('simple-mde', SimpleMdeController)
 application.register('trix-field', TrixFieldController)
+
+// Custom controllers

data/app/views/avo/associations/new.html.erb

@@ -16,7 +16,8 @@
             field: @field,
             model_key: @field.target_resource&.model_key,
             foreign_key: 'related_id',
-            resource: @resource
+            resource: @resource,
+            view: :new
           %>
         <% else %>
           <div class="flex-1 flex flex-col items-center justify-center px-0 md:px-24 text-base">

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

@@ -6,7 +6,7 @@
   <%= filter_wrapper name: filter.name do %>
     <%= 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: '—',
+      include_blank: filter.class.empty_message || '—',
       id: "avo_filters_#{filter.id.parameterize.underscore}",
       'data-filter-class': filter.class,
       'data-select-filter-target': 'selector',

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

@@ -7,6 +7,7 @@
     <%= 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}",
+      placeholder: filter.class.empty_message,
       'data-filter-class': filter.class.to_s,
       'data-text-filter-target': 'text',
       'data-action': 'keypress->text-filter#tryToSubmit'

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

@@ -1 +1,2 @@
-<%= render Avo::Views::ResourceEditComponent.new(resource: @resource) %>
+<%= render Avo::Views::ResourceEditComponent.new(resource: @resource, view: @view, actions: @actions) %>
+

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

@@ -1 +1 @@
-<%= render Avo::Views::ResourceNewComponent.new(resource: @resource, model: @model) %>
+<%= render Avo::Views::ResourceEditComponent.new(resource: @resource, model: @model, view: @view, actions: @actions) %>

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

@@ -5,13 +5,27 @@
     </a>
   </div>
 <% end %>
-
 <% if Avo::App.error_messages.present? %>
-  <% Avo::App.error_messages.each do |message| %>
-    <div class="w-full inset-auto bottom-0 z-50 mb-4 opacity-75 hover:opacity-100 transition-opacity duration-150">
-      <a href="https://avohq.io/pricing" target="_blank" class="rounded bg-orange-700 text-white py-2 px-4 text-sm block items-center flex leading-tight">
-        <%= svg "exclamation", class: "h-6 inline mr-2 text-bold flex-shrink-0 mr-1" %> <%= message %>
-      </a>
-    </div>
+  <% Avo::App.error_messages.each do |error| %>
+    <% if error.is_a? Hash %>
+      <%
+        url, message, target = error.values_at :url, :message, :target
+      %>
+      <div class="w-full inset-auto bottom-0 z-50 mb-4 opacity-75 hover:opacity-100 transition-opacity duration-150">
+        <a href="<%= url %>" target="<%= target %>" class="rounded bg-orange-700 text-white py-2 px-4 text-sm items-center flex leading-tight space-x-2">
+          <%= svg "exclamation", class: "h-6 inline mr-2 text-bold flex-shrink-0 mr-1" %>
+          <div>
+            <%= simple_format message %>
+          </div>
+        </a>
+      </div>
+    <% elsif error.is_a? String %>
+      <div class="w-full inset-auto bottom-0 z-50 mb-4 opacity-75 hover:opacity-100 transition-opacity duration-150">
+        <div class="rounded bg-orange-700 text-white py-2 px-4 text-sm items-center flex leading-tight space-x-2">
+          <%= svg "exclamation", class: "h-6 inline mr-2 text-bold flex-shrink-0 mr-1" %>
+          <div><%= simple_format error %></div>
+        </div>
+      </div>
+    <% end %>
   <% end %>
 <% end %>

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

@@ -1,3 +1,4 @@
-<%= link_to root_path, class: 'logo-placeholder h-10 bg-white flex justify-start' do %>
-  <%= image_tag '/avo-assets/logo.png', class: 'h-full', title: 'Avo' %>
+<%= link_to root_path, class: 'logo-placeholder h-full w-full flex justify-start' do %>
+  <%= image_tag '/avo-assets/logo.png', class: 'hidden sm:block object-contain', title: 'Avo' %>
+  <%= image_tag '/avo-assets/logomark.png', class: 'sm:hidden object-contain', title: 'Avo' %>
 <% end %>

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

@@ -2,7 +2,7 @@
   class="fixed bg-white p-2 w-full flex flex-shrink-0 items-center z-50 px-4 lg:px-4 border-b space-x-4 lg:space-x-0 h-16 <%= 'print:hidden' if Avo.configuration.hide_layout_when_printing %>"
   v-if="layout !== 'blank'"
 >
-  <div class="flex items-center space-x-2 lg:space-x-0 w-32 sm:w-64 flex-shrink-0">
+  <div class="flex items-center space-x-2 lg:space-x-0 w-auto lg:w-64 flex-shrink-0 h-full">
     <%= a_button class: 'lg:hidden', icon: 'menu', size: :xs, compact: true, style: :text, data: { action: 'click->mobile#toggleSidebar' } %>
     <%= render partial: "avo/partials/logo" %>
   </div>

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

@@ -30,6 +30,14 @@
         sort_direction = 'desc'
       end
       classes = "text-gray-500 tracking-tight leading-tight text-xs font-semibold"
+      classes += case field.index_text_align.to_sym
+        when :right
+          " text-right"
+        when :center
+          " text-center"
+        else
+          ""
+        end
     %>
     <th class="text-left uppercase px-3 py-2 whitespace-nowrap rounded-l">
       <% if field.sortable %>
@@ -38,7 +46,7 @@
           <%= render partial: 'avo/partials/sortable_component', locals: {field: field} %>
         <% end %>
       <% else %>
-        <div class="flex items-center <%= classes %>">
+        <div class="block w-full <%= classes %>">
           <%= field.name %>
         </div>
       <% end %>

data/bin/test

@@ -12,6 +12,7 @@ fi;
 # Run system tests
 if [[ -z "$1" ]] || [[ "$1" == "system" ]]; then
   yarn build:js
+  yarn build:custom-js
   yarn build:css
   bundle exec rspec ./spec --tag type:system
 fi;

data/config/routes.rb

@@ -1,11 +1,14 @@
 Avo::Engine.routes.draw do
   root "home#index"
 
-  get "resources", to: redirect("/admin")
+  get "resources", to: redirect(Avo.configuration.root_path)
+  get "dashboards", to: redirect(Avo.configuration.root_path)
+
   post "/rails/active_storage/direct_uploads", to: "/active_storage/direct_uploads#create"
 
-  get "/dashboards/:dashboard_id", to: "dashboards#show"
-  get "/dashboards/:dashboard_id/cards/:card_id", to: "dashboards#card"
+  resources :dashboards do
+    resources :cards
+  end
 
   scope "avo_api", as: "avo_api" do
     get "/search", to: "search#index"
@@ -45,7 +48,7 @@ Avo::Engine.routes.draw do
     post "/debug/refresh_license", to: "debug#refresh_license"
   end
 
-  if Rails.env.development? or Rails.env.staging?
+  if Rails.env.development? || Rails.env.staging?
     scope "/avo_private", as: "avo_private" do
       get "/design", to: "private#design"
     end

data/db/factories.rb

@@ -72,5 +72,6 @@ FactoryBot.define do
 
   factory :course_link, class: "Course::Link" do
     link { Faker::Internet.url }
+    course { create :course }
   end
 end

data/lib/avo/app.rb

@@ -14,7 +14,7 @@ module Avo
     class_attribute :view_context, default: nil
     class_attribute :params, default: {}
     class_attribute :translation_enabled, default: false
-    class_attribute :error_messages, default: []
+    class_attribute :error_messages
 
     class << self
       def boot
@@ -52,6 +52,7 @@ module Avo
           Rails.logger.debug "[Avo] Failed to set ActiveStorage::Current.url_options, #{exception.inspect}"
         end
 
+        check_bad_resources
         init_resources
         init_dashboards if license.has_with_trial(:dashboards)
       end
@@ -80,6 +81,22 @@ module Avo
         )
       end
 
+      def check_bad_resources
+        resources.each do |resource|
+          has_model = resource.model_class.present?
+
+          unless has_model
+            possible_model = resource.class.to_s.gsub 'Resource', ''
+
+            Avo::App.error_messages.push({
+              url: "https://docs.avohq.io/2.0/resources.html#custom-model-class",
+              target: "_blank",
+              message: "#{resource.class.to_s} does not have a valid model assigned. It failed to find the #{possible_model} model. \n\r Please create that model or assign one using self.model_class = YOUR_MODEL"
+            })
+          end
+        end
+      end
+
       def init_resources
         self.resources = BaseResource.descendants
           .select do |resource|

data/lib/avo/base_action.rb

@@ -1,8 +1,9 @@
 module Avo
   class BaseAction
-    extend FieldsCollector
     extend HasContext
 
+    include Avo::Concerns::HasFields
+
     class_attribute :name, default: nil
     class_attribute :message
     class_attribute :confirm_button_label
@@ -12,7 +13,6 @@ module Avo
     class_attribute :view
     class_attribute :user
     class_attribute :resource
-    class_attribute :fields
     class_attribute :invalid_fields
     class_attribute :standalone, default: false
     class_attribute :visible
@@ -120,9 +120,14 @@ module Avo
     end
 
     def visible_in_view
-      return true unless visible.present?
+      # Run the visible block if available
+      return instance_exec(resource: self.class.resource, view: view, &visible) if visible.present?
+
+      # Hide on the :new view by default
+      return false if view == :new
 
-      instance_exec(resource: self.class.resource, view: view, &visible)
+      # Show on all other views
+      true
     end
 
     def param_id
@@ -153,6 +158,13 @@ module Avo
       self
     end
 
+    # Add a placeholder silent message from when a user wants to do a redirect action or something similar
+    def silent
+      add_message nil, :silent
+
+      self
+    end
+
     def redirect_to(path = nil, &block)
       response[:type] = :redirect
       response[:path] = if block.present?

data/lib/avo/base_card.rb

@@ -52,29 +52,6 @@ module Avo
       @refresh_every || self.class.refresh_every
     end
 
-    def translated_range(range)
-      return "#{range} days" if range.is_a? Integer
-
-      case range
-      when "MTD"
-        "Month to date"
-      when "QTD"
-        "Quarter to date"
-      when "YTD"
-        "Year to date"
-      when "TODAY"
-        "Today"
-      else
-        range
-      end
-    end
-
-    def parsed_ranges
-      return unless ranges.present?
-
-      ranges.map { |range| [translated_range(range), range] }
-    end
-
     def turbo_frame
       "#{dashboard.id}_#{id}"
     end

data/lib/avo/base_resource.rb

@@ -1,13 +1,16 @@
 module Avo
   class BaseResource
     extend ActiveSupport::DescendantsTracker
-    extend FieldsCollector
     extend HasContext
 
     include ActionView::Helpers::UrlHelper
     include Avo::Concerns::HasTools
+    include Avo::Concerns::HasModel
+    include Avo::Concerns::HasFields
+    include Avo::Concerns::HasStimulusControllers
 
-    delegate :view_context, to: "Avo::App"
+    delegate :view_context, to: ::Avo::App
+    delegate :simple_format, :content_tag, to: :view_context
     delegate :main_app, to: :view_context
     delegate :avo, to: :view_context
     delegate :resource_path, to: :view_context
@@ -28,12 +31,10 @@ module Avo
     class_attribute :includes, default: []
     class_attribute :model_class
     class_attribute :translation_key
-    class_attribute :translation_enabled, default: false
     class_attribute :default_view_type, default: :table
     class_attribute :devise_password_optional, default: false
     class_attribute :actions_loader
     class_attribute :filters_loader
-    class_attribute :fields
     class_attribute :grid_loader
     class_attribute :visible_on_sidebar, default: true
     class_attribute :unscoped_queries_on_index, default: false
@@ -106,8 +107,6 @@ module Avo
           self.class.model_class = model_class.base_class
         end
       end
-
-      self.class.translation_enabled = ::Avo::App.translation_enabled
     end
 
     def hydrate(model: nil, view: nil, user: nil, params: nil)
@@ -128,7 +127,7 @@ module Avo
       return [] if self.class.fields.blank?
 
       fields = self.class.fields.map do |field|
-        field.hydrate(resource: self, panel_name: default_panel_name, user: user, translation_enabled: translation_enabled)
+        field.hydrate(resource: self, panel_name: default_panel_name, user: user)
       end
 
       if Avo::App.license.lacks_with_trial(:custom_fields)
@@ -139,7 +138,7 @@ module Avo
 
       if Avo::App.license.lacks_with_trial(:advanced_fields)
         fields = fields.reject do |field|
-          field.type == 'tags'
+          field.type == "tags"
         end
       end
 
@@ -288,7 +287,7 @@ module Avo
     end
 
     def translation_key
-      return "avo.resource_translations.#{class_name_without_resource.underscore}" if self.class.translation_enabled
+      return "avo.resource_translations.#{class_name_without_resource.underscore}" if ::Avo::App.translation_enabled
 
       self.class.translation_key
     end
@@ -298,9 +297,11 @@ module Avo
 
       return @name if @name.present?
 
-      return t(translation_key, count: 1, default: default).capitalize if translation_key
-
-      default
+      if translation_key && ::Avo::App.translation_enabled
+        t(translation_key, count: 1, default: default).capitalize
+      else
+        default
+      end
     end
 
     def singular_name
@@ -310,9 +311,11 @@ module Avo
     def plural_name
       default = name.pluralize
 
-      return t(translation_key, count: 2, default: default).capitalize if translation_key
-
-      default
+      if translation_key && ::Avo::App.translation_enabled
+        t(translation_key, count: 2, default: default).capitalize
+      else
+        default
+      end
     end
 
     def underscore_name
@@ -433,7 +436,11 @@ module Avo
     end
 
     def route_key
-      model_class.model_name.route_key
+      class_name_without_resource.underscore.pluralize
+    end
+
+    def singular_route_key
+      route_key.singularize
     end
 
     # This is used as the model class ID