avo 2.18.1 → 2.19.0

data/app/controllers/avo/application_controller.rb

@@ -1,5 +1,11 @@
 module Avo
   class ApplicationController < ::ActionController::Base
+    if defined?(Pundit::Authorization)
+      Avo::ApplicationController.include Pundit::Authorization
+    elsif defined?(Pundit)
+      Avo::ApplicationController.include Pundit
+    end
+
     include Pagy::Backend
     include Avo::ApplicationHelper
     include Avo::UrlHelpers

data/app/controllers/avo/base_controller.rb

@@ -2,6 +2,8 @@ require_dependency "avo/application_controller"
 
 module Avo
   class BaseController < ApplicationController
+    include Avo::Concerns::FiltersSessionHandler
+
     before_action :set_resource_name
     before_action :set_resource
     before_action :hydrate_resource
@@ -302,11 +304,14 @@ module Avo
     end
 
     def set_filters
-      @filters = @resource.get_filters.map do |filter_class|
-        filter = filter_class.new
-
-        filter
-      end
+      @filters = @resource
+        .get_filters
+        .map do |filter_class|
+          filter_class.new
+        end
+        .select do |filter|
+          filter.visible_in_view(resource: @resource, parent_model: @parent_model, parent_resource: @parent_resource)
+        end
     end
 
     def set_actions
@@ -316,12 +321,14 @@ module Avo
           action.new(model: @model, resource: @resource, view: @view)
         end
         .select do |action|
-          action.visible_in_view
+          action.visible_in_view(parent_model: @parent_model, parent_resource: @parent_resource)
         end
     end
 
     def set_applied_filters
-      @applied_filters = Avo::Filters::BaseFilter.decode_filters(params[Avo::Filters::BaseFilter::PARAM_KEY])
+      reset_filters if params[:reset_filter]
+
+      @applied_filters = Avo::Filters::BaseFilter.decode_filters(fetch_filters)
 
       # Some filters react to others and will have to be merged into this
       @applied_filters = @applied_filters.merge reactive_filters

data/app/controllers/avo/dashboards/cards_controller.rb

@@ -0,0 +1,37 @@
+require_dependency "avo/application_controller"
+
+module Avo
+  module Dashboards
+    class CardsController < ApplicationController
+      before_action :set_dashboard
+      before_action :set_card
+      before_action :detect_chartkick
+
+      def show
+        render(:chartkick_missing) unless @chartkick_installed
+      end
+
+      private
+
+      def set_dashboard
+        @dashboard = Avo::App.get_dashboard_by_id params[:dashboard_id]
+
+        raise ActionController::RoutingError.new("Not Found") if @dashboard.nil? || @dashboard.is_hidden?
+      end
+
+      def set_card
+        @card = @dashboard.item_at_index(params[:index].to_i).tap do |card|
+          card.hydrate(dashboard: @dashboard, params: params)
+        end
+      end
+
+      def detect_chartkick
+        @chartkick_installed = if @card.class.ancestors.map(&:to_s).include?("Avo::Dashboards::ChartkickCard")
+          defined?(Chartkick)
+        else
+          true
+        end
+      end
+    end
+  end
+end

data/app/helpers/avo/application_helper.rb

@@ -102,7 +102,11 @@ module Avo
     end
 
     def root_path_without_url
-      Avo::App.root_path.to_s.delete_prefix(request.base_url.to_s).delete_suffix "/"
+      Avo::App.root_path
+        .to_s
+        .delete_prefix(request.base_url.to_s)
+        .delete_suffix("/")
+        .gsub("/?", "?")
     rescue
       Avo.configuration.root_path
     end

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

@@ -76,7 +76,7 @@ export default class extends Controller {
     // This line fixes a bug where the search box would be duplicated on back navigation.
     this.autocompleteTarget.innerHTML = ''
 
-    autocomplete({
+    const { destroy } = autocomplete({
       container: this.autocompleteTarget,
       placeholder: this.translationKeys.placeholder,
       translations: {
@@ -101,7 +101,7 @@ export default class extends Controller {
     })
 
     // document.addEventListener('turbo:before-render', destroy)
-    // this.destroyMethod = destroy
+    this.destroyMethod = destroy
 
     // When using search for belongs-to
     if (this.buttonTarget.dataset.shouldBeDisabled !== 'true') {
@@ -109,6 +109,15 @@ export default class extends Controller {
     }
   }
 
+  disconnect() {
+    // Don't leave open autocompletes around when disconnected. Otherwise it will still
+    // be visible when navigating back to this page.
+    if (this.destroyMethod) {
+      this.destroyMethod()
+      this.destroyMethod = null
+    }
+  }
+
   addSource(resourceName, data) {
     const that = this
 

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

@@ -3,3 +3,4 @@
     <%= Avo.configuration.branding.css_colors %>
   }
 </style>
+<%= favicon_link_tag Avo.configuration.branding.favicon %>

data/avo.gemspec

@@ -35,7 +35,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "activerecord", ">= 6.0"
   spec.add_dependency "actionview", ">= 6.0"
   spec.add_dependency "pagy"
-  spec.add_dependency "zeitwerk"
+  spec.add_dependency "zeitwerk", ">= 2.6.2"
   spec.add_dependency "httparty"
   spec.add_dependency "active_link_to"
   spec.add_dependency "view_component"

data/bin/init

@@ -9,7 +9,17 @@ app_root do
   )
 
   header 'Configuring git'
-  run! 'git remote add upstream https://github.com/avo-hq/avo.git'
+  target_upstream = "https://github.com/avo-hq/avo.git"
+  current_upstream = `git config --get remote.upstream.url`.chomp
+  if current_upstream.nil? || current_upstream.empty?
+    puts "Adding new remote 'upstream' to #{target_upstream}"
+    run! "git remote add upstream #{target_upstream}"
+  elsif current_upstream != target_upstream
+    puts "Updating existing remote 'upstream' to #{target_upstream}"
+    run! "git remote set-url upstream #{target_upstream}"
+  else
+    puts "Remote 'upstream' already points to #{target_upstream}, no change"
+  end
 
   header 'Installing gems'
   run! 'bundle install'

data/bin/test

@@ -7,6 +7,7 @@ export NODE_ENV="test"
 if [[ -z "$1" ]] || [[ "$1" == "unit" ]]; then
   bundle exec rspec ./spec --tag type:feature
   bundle exec rspec ./spec --tag type:controller
+  bundle exec rspec ./spec --tag type:component
 fi;
 
 # Run system tests

data/config/routes.rb

@@ -7,7 +7,7 @@ Avo::Engine.routes.draw do
   post "/rails/active_storage/direct_uploads", to: "/active_storage/direct_uploads#create"
 
   resources :dashboards do
-    resources :cards
+    resources :cards, controller: "dashboards/cards"
   end
 
   scope "avo_api", as: "avo_api" do
@@ -33,7 +33,7 @@ Avo::Engine.routes.draw do
 
     # Generate resource routes as below:
     # resources :posts
-    Avo::DynamicRouter.routes(self)
+    Avo::DynamicRouter.routes
 
     # Associations
     get "/:resource_name/:id/:related_name/new", to: "associations#new", as: "associations_new"

data/db/factories.rb

@@ -60,6 +60,16 @@ FactoryBot.define do
     type { "Spouse" }
   end
 
+  factory :sibling do
+    name { "#{Faker::Name.first_name} #{Faker::Name.last_name}" }
+    type { "Sibling" }
+  end
+
+  factory :brother do
+    name { "#{Faker::Name.first_name} #{Faker::Name.last_name}" }
+    type { "Brother" }
+  end
+
   factory :fish do
     name { %w[Tilapia Salmon Trout Catfish Pangasius Carp].sample }
   end

data/lib/avo/app.rb

@@ -17,6 +17,14 @@ module Avo
     class_attribute :error_messages
 
     class << self
+      def eager_load(entity)
+        paths = Avo::ENTITIES.fetch entity
+
+        return unless paths.present?
+
+        Rails.autoloaders.main.eager_load_dir(Rails.root.join(*paths).to_s)
+      end
+
       def boot
         init_fields
 
@@ -91,7 +99,7 @@ module Avo
           has_model = resource.model_class.present?
 
           unless has_model
-            possible_model = resource.class.to_s.gsub 'Resource', ''
+            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",
@@ -119,6 +127,8 @@ module Avo
       end
 
       def init_dashboards
+        eager_load :dashboards unless Rails.application.config.eager_load
+
         self.dashboards = Dashboards::BaseDashboard.descendants
           .select do |dashboard|
             dashboard != Dashboards::BaseDashboard

data/lib/avo/base_action.rb

@@ -34,9 +34,9 @@ module Avo
       def form_data_attributes
         # We can't respond with a file download from Turbo se we disable it on the form
         if may_download_file
-          {turbo: false, remote: false}
+          {turbo: false, remote: false, action_target: :form}
         else
-          {"turbo-frame": "_top", "action-target": "form"}
+          {turbo_frame: :_top, action_target: :form}
         end
       end
 
@@ -114,15 +114,25 @@ module Avo
       self
     end
 
-    def visible_in_view
-      # Run the visible block if available
-      return instance_exec(resource: self.class.resource, view: view, &visible) if visible.present?
+    def visible_in_view(parent_model: nil, parent_resource: nil)
+      if visible.blank?
+        # Hide on the :new view by default
+        return false if view == :new
 
-      # Hide on the :new view by default
-      return false if view == :new
+        # Show on all other views
+        return true
+      end
 
-      # Show on all other views
-      true
+      # Run the visible block if available
+      Avo::Hosts::VisibilityHost.new(
+        block: visible,
+        model: self.class.model,
+        params: params,
+        parent_model: parent_model,
+        parent_resource: parent_resource,
+        resource: self.class.resource,
+        view: self.class.view,
+      ).handle
     end
 
     def param_id

data/lib/avo/base_resource.rb

@@ -49,6 +49,7 @@ module Avo
     class_attribute :record_selector, default: true
     class_attribute :keep_filters_panel_open, default: false
     class_attribute :extra_params
+    class_attribute :link_to_child_resource, default: false
 
     class << self
       delegate :t, to: ::I18n
@@ -422,9 +423,7 @@ module Avo
     end
 
     def label
-      label_field.value || model_title
-    rescue
-      model_title
+      label_field&.value || model_title
     end
 
     def avatar_field
@@ -460,9 +459,7 @@ module Avo
     end
 
     def description
-      description_field.value
-    rescue
-      nil
+      description_field&.value
     end
 
     def form_scope

data/lib/avo/concerns/filters_session_handler.rb

@@ -0,0 +1,43 @@
+
+module Avo
+  module Concerns
+    module FiltersSessionHandler
+      def reset_filters
+        return unless cache_resource_filters?
+
+        session.delete(filters_session_key)
+      end
+
+      def fetch_filters
+        return filters_from_params unless cache_resource_filters?
+
+        (filters_from_params && save_filters_to_session) || filters_from_session
+      end
+
+      def filters_from_params
+        params[Avo::Filters::BaseFilter::PARAM_KEY].presence
+      end
+
+      def save_filters_to_session
+        session[filters_session_key] = params[Avo::Filters::BaseFilter::PARAM_KEY]
+      end
+
+      def filters_from_session
+        session[filters_session_key]
+      end
+
+      def filters_session_key
+        @filters_session_key ||= '/filters/' << %w[
+          turbo_frame controller resource_name related_name
+          action id
+        ].map { |key| params[key] }.compact.join('/')
+      end
+
+      def cache_resource_filters?
+        return Avo.configuration.cache_resource_filters unless Avo.configuration.cache_resource_filters.is_a?(Proc)
+
+        Avo.configuration.cache_resource_filters.call(current_user: current_user, resource: @resource)
+      end
+    end
+  end
+end

data/lib/avo/concerns/has_fields.rb

@@ -270,6 +270,8 @@ module Avo
           end
           # each field has it's own visibility checker
           if item.respond_to? :visible?
+            item.hydrate(view: view) if item.view.nil?
+
             next unless item.visible?
           end
           # check if the user is authorized to view it

data/lib/avo/concerns/visible_items.rb

@@ -0,0 +1,44 @@
+# This concern helps us figure out what items are visible for each tab, panel or sidebar
+module Avo
+  module Concerns
+    module VisibleItems
+      extend ActiveSupport::Concern
+      def items
+        if items_holder.present?
+          items_holder.items
+        else
+          []
+        end
+      end
+
+      def visible_items
+        items
+          .map do |item|
+            visible(item) ? item : nil
+          end
+          .compact
+      end
+
+      def visible(item)
+        if item.is_field?
+          item.visible? && item.visible_on?(view)
+        else
+          item.visible?
+        end
+      end
+
+      def visible?
+        any_item_visible = visible_items.any?
+        return any_item_visible unless respond_to?(:visible_on?)
+
+        visible_on?(view) && any_item_visible
+      end
+
+      def hydrate(view: nil)
+        @view = view
+
+        self
+      end
+    end
+  end
+end

data/lib/avo/configuration/branding.rb

@@ -1,10 +1,11 @@
 class Avo::Configuration::Branding
-  def initialize(colors: nil, chart_colors: nil, logo: nil, logomark: nil, placeholder: nil)
+  def initialize(colors: nil, chart_colors: nil, logo: nil, logomark: nil, placeholder: nil, favicon: nil)
     @colors = colors || {}
     @chart_colors = chart_colors
     @logo = logo
     @logomark = logomark
     @placeholder = placeholder
+    @favicon = favicon
 
     @default_colors = {
       background: "#F6F6F7",
@@ -16,7 +17,8 @@ class Avo::Configuration::Branding
     @default_chart_colors = ["#0B8AE2", "#34C683", "#2AB1EE", "#34C6A8"]
     @default_logo = "/avo-assets/logo.png"
     @default_logomark = "/avo-assets/logomark.png"
-    @default_placeholder = "placeholder.svg"
+    @default_placeholder = "/avo-assets/placeholder.svg"
+    @default_favicon = "/avo-assets/favicon.ico"
   end
 
   def css_colors
@@ -53,6 +55,12 @@ class Avo::Configuration::Branding
     @chart_colors || @default_chart_colors
   end
 
+  def favicon
+    return @default_favicon if Avo::App.license.lacks_with_trial(:branding)
+
+    @favicon || @default_favicon
+  end
+
   private
 
   def colors

data/lib/avo/configuration.rb

@@ -20,6 +20,7 @@ module Avo
     attr_accessor :full_width_container
     attr_accessor :full_width_index_view
     attr_accessor :cache_resources_on_index_view
+    attr_accessor :cache_resource_filters
     attr_accessor :context
     attr_accessor :display_breadcrumbs
     attr_accessor :hide_layout_when_printing
@@ -39,6 +40,7 @@ module Avo
     attr_accessor :resource_default_view
     attr_accessor :authorization_client
     attr_accessor :field_wrapper_layout
+    attr_accessor :sign_out_path_name
     attr_writer :branding
 
     def initialize
@@ -68,6 +70,7 @@ module Avo
       @full_width_container = false
       @full_width_index_view = false
       @cache_resources_on_index_view = Avo::PACKED
+      @cache_resource_filters = false
       @context = proc {}
       @initial_breadcrumbs = proc {
         add_breadcrumb I18n.t("avo.home").humanize, avo.root_path

data/lib/avo/dynamic_router.rb

@@ -1,21 +1,22 @@
 module Avo
-  module DynamicRouter
-    def self.routes(router)
-      Rails.application.eager_load! unless Rails.env.production?
+  class DynamicRouter
+    def self.routes
+      Avo::Engine.routes.draw do
+        scope "resources", as: "resources" do
+          Avo::App.eager_load(:resources) unless Rails.application.config.eager_load
 
-      BaseResource.descendants
-        .select do |resource|
-          resource != :BaseResource
-        end
-        .select do |resource|
-          resource.is_a? Class
-        end
-        # .select do |resource|
-        #   resource.model_class.present?
-        # end
-        .map do |resource|
-          router.resources resource.new.route_key
+          BaseResource.descendants
+            .select do |resource|
+              resource != :BaseResource
+            end
+            .select do |resource|
+              resource.is_a? Class
+            end
+            .map do |resource|
+              resources resource.new.route_key
+            end
         end
+      end
     end
   end
 end

data/lib/avo/engine.rb

@@ -27,15 +27,7 @@ module Avo
     end
 
     initializer "avo.autoload" do |app|
-      [
-        ["app", "avo", "fields"],
-        ["app", "avo", "filters"],
-        ["app", "avo", "actions"],
-        ["app", "avo", "resources"],
-        ["app", "avo", "dashboards"],
-        ["app", "avo", "cards"],
-        ["app", "avo", "resource_tools"]
-      ].each do |path_params|
+      Avo::ENTITIES.values.each do |path_params|
         path = Rails.root.join(*path_params)
 
         if File.directory? path.to_s
@@ -72,6 +64,11 @@ module Avo
       g.test_framework :rspec, view_specs: false
     end
 
+    generators do |app|
+      Rails::Generators.configure! app.config.generators
+      require_relative "../generators/model_generator"
+    end
+
     # After deploy we want to make sure the license response is being cleared.
     # We need a fresh license response.
     # This is disabled in development because the initialization process might be triggered more than once.

data/lib/avo/fields/base_field.rb

@@ -14,6 +14,7 @@ module Avo
       include Avo::Concerns::HasHTMLAttributes
       include Avo::Fields::Concerns::IsRequired
       include Avo::Fields::Concerns::IsReadonly
+      include Avo::Fields::Concerns::HasDefault
 
       delegate :view_context, to: ::Avo::App
       delegate :simple_format, :content_tag, to: :view_context
@@ -83,7 +84,7 @@ module Avo
 
         @args = args
 
-        @updatable = true
+        @updatable = !readonly
         @computable = true
         @computed = block.present?
         @computed_value = nil
@@ -145,9 +146,11 @@ module Avo
       end
 
       def placeholder
-        return @placeholder if @placeholder.present?
+        if @placeholder.respond_to?(:call)
+          return Avo::Hosts::ResourceViewRecordHost.new(block: @placeholder, record: @model, resource: @resource, view: @view).handle
+        end
 
-        name
+        @placeholder || name
       end
 
       def visible?
@@ -166,15 +169,9 @@ module Avo
         # Get model value
         final_value = @model.send(property) if is_model?(@model) && @model.respond_to?(property)
 
-        # On new views and actions modals we need to prefill the fields
-        if @view.in?([:new, :create]) || @action.present?
-          if default.present?
-            final_value = if default.respond_to?(:call)
-              default.call
-            else
-              default
-            end
-          end
+        # On new views and actions modals we need to prefill the fields with the default value
+        if should_fill_with_default_value? && default.present?
+          final_value = computed_default_value
         end
 
         # Run computable callback block if present
@@ -269,6 +266,18 @@ module Avo
       def is_model?(model)
         model_or_class(model) == "model"
       end
+
+      def should_fill_with_default_value?
+        on_create? || in_action?
+      end
+
+      def on_create?
+        @view.in?([:new, :create])
+      end
+
+      def in_action?
+        @action.present?
+      end
     end
   end
 end

data/lib/avo/fields/concerns/has_default.rb

@@ -0,0 +1,17 @@
+module Avo
+  module Fields
+    module Concerns
+      module HasDefault
+        extend ActiveSupport::Concern
+
+        def computed_default_value
+          if default.respond_to? :call
+            Avo::Hosts::ResourceViewRecordHost.new(block: default, record: model, view: view, resource: resource).handle
+          else
+            default
+          end
+        end
+      end
+    end
+  end
+end

data/lib/avo/fields/concerns/is_readonly.rb

@@ -6,7 +6,7 @@ module Avo
 
         def is_readonly?
           if readonly.respond_to? :call
-            Avo::Hosts::ViewRecordHost.new(block: readonly, record: model, view: view).handle
+            Avo::Hosts::ResourceViewRecordHost.new(block: readonly, record: model, view: view, resource: resource).handle
           else
             readonly
           end