avo 3.0.1.beta7 → 3.0.1.beta9

data/config/routes.rb

@@ -4,9 +4,10 @@ Avo::Engine.routes.draw do
   get "resources", to: redirect(Avo.configuration.root_path)
   get "dashboards", to: redirect(Avo.configuration.root_path)
 
-  mount Avo::DynamicFilters::Engine, at: "/avo-dynamic_filters" if defined?(Avo::DynamicFilters::Engine)
-  mount Avo::Dashboards::Engine, at: "/dashboards" if defined?(Avo::Dashboards::Engine)
-  mount Avo::Pro::Engine, at: "/avo-pro" if defined?(Avo::Pro::Engine)
+  # Mount Avo engines routes by default but leave it configurable in case the user wants to nest these under a scope.
+  if Avo.configuration.mount_avo_engines
+    instance_exec(&Avo.mount_engines)
+  end
 
   post "/rails/active_storage/direct_uploads", to: "/active_storage/direct_uploads#create"
 

data/db/factories.rb

@@ -38,7 +38,7 @@ FactoryBot.define do
   factory :project do
     name { Faker::App.name }
     status { ['closed', :rejected, :failed, 'loading', :running, :waiting].sample }
-    stage { ["Discovery", "Idea", "Done", "On hold", "Cancelled"].sample }
+    stage { ["Discovery", "Idea", "Done", "On hold", "Cancelled", "Drafting"].sample }
     budget { Faker::Number.decimal(l_digits: 4) }
     country { Faker::Address.country_code }
     description { Faker::Markdown.sandwich(sentences: 5) }

data/lib/avo/base_action.rb

@@ -65,7 +65,7 @@ module Avo
       self.class.record = record
       self.class.resource = resource
       self.class.user = user
-      self.class.view = view
+      self.class.view = Avo::ViewInquirer.new(view)
       @arguments = arguments
 
       self.class.message ||= I18n.t("avo.are_you_sure_you_want_to_run_this_option")
@@ -101,39 +101,34 @@ module Avo
     end
 
     def handle_action(**args)
-      records, fields, current_user, resource = args.values_at(:records, :fields, :current_user, :resource)
-      # Fetching the field definitions and not the actual fields (get_fields) because they will break if the user uses a `visible` block and adds a condition using the `params` variable. The params are different in the show method and the handle method.
-      action_fields = get_field_definitions.map { |field| [field.id, field] }.to_h
-
-      # For some fields, like belongs_to, the id and database_id differ (user vs user_id).
-      # That's why we need to fetch the database_id for when we process the action.
-      action_fields_by_database_id = action_fields.map do |id, value|
-        [value.database_id.to_sym, value]
-      end.to_h
+      processed_fields = if args[:fields].present?
+        # Fetching the field definitions and not the actual fields (get_fields) because they will break if the user uses a `visible` block and adds a condition using the `params` variable. The params are different in the show method and the handle method.
+        action_fields = get_field_definitions.map { |field| [field.id, field] }.to_h
+
+        # For some fields, like belongs_to, the id and database_id differ (user vs user_id).
+        # That's why we need to fetch the database_id for when we process the action.
+        action_fields_by_database_id = action_fields.map do |id, value|
+          [value.database_id.to_sym, value]
+        end.to_h
 
-      if fields.present?
-        processed_fields = fields.to_unsafe_h.map do |name, value|
+        args[:fields].to_unsafe_h.map do |name, value|
           field = action_fields_by_database_id[name.to_sym]
 
           next if field.blank?
 
           [name, field.resolve_attribute(value)]
-        end
-
-        processed_fields = processed_fields.reject(&:blank?).to_h
+        end.reject(&:blank?).to_h
       else
-        processed_fields = {}
+        {}
       end
 
-      args = {
+      handle(
         fields: processed_fields.with_indifferent_access,
-        current_user: current_user,
-        resource: resource
-      }
-
-      args[:records] = records
-
-      handle(**args)
+        current_user: args[:current_user],
+        resource: args[:resource],
+        records: args[:query],
+        query: args[:query]
+      )
 
       self
     end
@@ -141,7 +136,7 @@ module Avo
     def visible_in_view(parent_resource: nil)
       if visible.blank?
         # Hide on the :new view by default
-        return false if view == :new
+        return false if view.new?
 
         # Show on all other views
         return true

data/lib/avo/base_resource.rb

@@ -9,6 +9,7 @@ module Avo
     include Avo::Concerns::HasStimulusControllers
     include Avo::Concerns::ModelClassConstantized
     include Avo::Concerns::HasDescription
+    include Avo::Concerns::HasHelpers
 
     # Avo::Current methods
     delegate :context, to: Avo::Current
@@ -233,14 +234,14 @@ module Avo
     delegate :model_key, to: :class
 
     def initialize(record: nil, view: nil, user: nil, params: nil)
-      @view = view if view.present?
+      @view = Avo::ViewInquirer.new(view) if view.present?
       @user = user if user.present?
       @params = params if params.present?
 
       if record.present?
         @record = record
 
-        hydrate_model_with_default_values if @view == :new
+        hydrate_model_with_default_values if @view&.new?
       end
 
       detect_fields
@@ -295,7 +296,7 @@ module Avo
       # def get_action_arguments / def get_filter_arguments / def get_scope_arguments
       define_method "get_#{entity}_arguments" do |entity_class|
         klass = send("get_#{plural_entity}").find { |entity| entity[:class].to_s == entity_class.to_s }
-        
+
         raise "Couldn't find '#{entity_class}' in the 'def #{plural_entity}' method on your '#{self.class}' resource." if klass.nil?
 
         klass[:arguments]
@@ -303,14 +304,14 @@ module Avo
     end
 
     def hydrate(record: nil, view: nil, user: nil, params: nil)
-      @view = view if view.present?
+      @view = Avo::ViewInquirer.new(view) if view.present?
       @user = user if user.present?
       @params = params if params.present?
 
       if record.present?
         @record = record
 
-        hydrate_model_with_default_values if @view == :new
+        hydrate_model_with_default_values if @view&.new?
       end
 
       self
@@ -445,7 +446,7 @@ module Avo
     def hydrate_model_with_default_values
       default_values = get_fields
         .select do |field|
-          !field.computed
+          !field.computed && !field.is_a?(Avo::Fields::HeadingField)
         end
         .map do |field|
           value = field.value

data/lib/avo/concerns/filters_session_handler.rb

@@ -26,16 +26,16 @@ module Avo
       end
 
       def filters_session_key
-        @filters_session_key ||= '/filters/' << %w[
+        @filters_session_key ||= "/filters/" << %w[
           turbo_frame controller resource_name related_name
           action id
-        ].map { |key| params[key] }.compact.join('/')
+        ].map { |key| params[key] }.compact.join("/")
       end
 
       def cache_resource_filters?
         Avo::ExecutionContext.new(
           target: Avo.configuration.cache_resource_filters,
-          current_user: current_user,
+          current_user: _current_user,
           resource: @resource
         ).handle
       end

data/lib/avo/concerns/has_helpers.rb

@@ -0,0 +1,18 @@
+module Avo
+  module Concerns
+    module HasHelpers
+      def helpers
+        @helpers ||= Class.new do
+          def initialize
+            helper_names = ActionController::Base.all_helpers_from_path Rails.root.join("app", "helpers")
+            helpers = ActionController::Base.modules_for_helpers helper_names
+
+            helpers.each do |helper|
+              extend helper
+            end
+          end
+        end.new
+      end
+    end
+  end
+end

data/lib/avo/concerns/has_items.rb

@@ -30,10 +30,6 @@ module Avo
           deprecated_dsl_api __method__, "fields"
         end
 
-        def heading(body, **args)
-          deprecated_dsl_api __method__, "fields"
-        end
-
         def sidebar(**args, &block)
           deprecated_dsl_api __method__, "fields"
         end
@@ -273,7 +269,7 @@ module Avo
           end
           .select do |item|
             # On location field we can have field coordinates and setters with different names like latitude and longitude
-            if !item.is_a?(Avo::Fields::LocationField) && !item.is_heading? && view.in?([:edit, :update, :new, :create])
+            if !item.is_a?(Avo::Fields::LocationField) && !item.is_heading? && view.in?(%w[edit update new create])
               if item.respond_to?(:id)
                 item.resource.record.respond_to?("#{item.id}=")
               else

data/lib/avo/concerns/visible_in_different_views.rb

@@ -61,7 +61,7 @@ module Avo
       def except_on(*where)
         show_on_all
         normalize_views(where).flatten.each do |view|
-          show_on_view view
+          hide_on_view view
         end
       end
 
@@ -113,12 +113,18 @@ module Avo
 
       def normalize_views(*views_and_groups)
         forms = views_and_groups.flatten! & [:forms]
+        display = views_and_groups & [:display]
 
         if forms.present?
           views_and_groups -= forms
           views_and_groups += [:new, :edit]
         end
 
+        if display.present?
+          views_and_groups -= display
+          views_and_groups += [:index, :show]
+        end
+
         views_and_groups.flatten.uniq
       end
     end

data/lib/avo/concerns/visible_items.rb

@@ -0,0 +1,43 @@
+# 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
+        items_holder&.items || []
+      end
+
+      def visible_items
+        items
+          .select do |item|
+            if item.respond_to? :hydrate
+              item.hydrate(view: view, resource: resource)
+            end
+
+            visible(item)
+          end
+      end
+
+      def visible(item)
+        return item.visible? if !item.is_field?
+
+        return false if item.respond_to?(:authorized?) && item.resource.present? && !item.authorized?
+
+        item.visible? && item.visible_in_view?(view: view)
+      end
+
+      def visible?
+        any_item_visible = visible_items.any?
+        return any_item_visible if !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.rb

@@ -36,13 +36,14 @@ module Avo
     attr_accessor :main_menu
     attr_accessor :profile_menu
     attr_accessor :model_resource_mapping
-    attr_accessor :resource_default_view
+    attr_reader :resource_default_view
     attr_accessor :authorization_client
     attr_accessor :field_wrapper_layout
     attr_accessor :sign_out_path_name
     attr_accessor :resources
     attr_accessor :prefix_path
     attr_accessor :resource_parent_controller
+    attr_accessor :mount_avo_engines
 
     def initialize
       @root_path = "/avo"
@@ -88,11 +89,12 @@ module Avo
       @main_menu = nil
       @profile_menu = nil
       @model_resource_mapping = {}
-      @resource_default_view = :show
+      @resource_default_view = Avo::ViewInquirer.new("show")
       @authorization_client = :pundit
       @field_wrapper_layout = :inline
       @resources = nil
       @resource_parent_controller = "Avo::ResourcesController"
+      @mount_avo_engines = true
     end
 
     def current_user_method(&block)
@@ -158,6 +160,10 @@ module Avo
         "community"
       end
     end
+
+    def resource_default_view=(view)
+      @resource_default_view = Avo::ViewInquirer.new(view.to_s)
+    end
   end
 
   def self.configuration

data/lib/avo/current.rb

@@ -24,6 +24,7 @@ class Avo::Current < ActiveSupport::CurrentAttributes
   attribute :resource_manager
   attribute :tool_manager
   attribute :plugin_manager
+  attribute :locale
 
   delegate :params, to: :request
 

data/lib/avo/execution_context.rb

@@ -1,6 +1,8 @@
 module Avo
   class ExecutionContext
-    attr_accessor :target, :context, :params, :view_context, :current_user, :request, :include, :main_app, :avo
+    include Avo::Concerns::HasHelpers
+
+    attr_accessor :target, :context, :params, :view_context, :current_user, :request, :include, :main_app, :avo, :locale
 
     def initialize(**args)
       # Extend the class with custom modules if required.
@@ -24,6 +26,7 @@ module Avo
       @params ||= Avo::Current.params
       @request ||= Avo::Current.request
       @view_context ||= Avo::Current.view_context
+      @locale ||= Avo::Current.locale
       @main_app ||= @view_context.main_app
       @avo ||= @view_context.avo
     end

data/lib/avo/fields/badge_field.rb

@@ -8,7 +8,7 @@ module Avo
 
         hide_on [:edit, :new]
 
-        default_options = {info: :info, success: :success, danger: :danger, warning: :warning}
+        default_options = {info: :info, success: :success, danger: :danger, warning: :warning, neutral: :neutral}
         @options = args[:options].present? ? default_options.merge(args[:options]) : default_options
       end
     end

data/lib/avo/fields/base_field.rb

@@ -7,6 +7,7 @@ module Avo
       prepend Avo::Concerns::IsResourceItem
       include Avo::Concerns::IsVisible
       include Avo::Concerns::VisibleInDifferentViews
+      include Avo::Concerns::HasHelpers
       include Avo::Fields::Concerns::HasFieldName
       include Avo::Fields::Concerns::HasDefault
       include Avo::Fields::Concerns::HasHTMLAttributes
@@ -14,6 +15,7 @@ module Avo
       include Avo::Fields::Concerns::IsReadonly
       include Avo::Fields::Concerns::IsDisabled
       include Avo::Fields::Concerns::IsRequired
+      include Avo::Fields::Concerns::UseViewComponents
 
       include ActionView::Helpers::UrlHelper
 
@@ -73,11 +75,12 @@ module Avo
         @visible = args[:visible]
         @as_avatar = args[:as_avatar] || false
         @html = args[:html] || nil
-        @view = args[:view] || nil
+        @view = Avo::ViewInquirer.new(args[:view]) || nil
         @value = args[:value] || nil
         @stacked = args[:stacked] || nil
         @for_presentation_only = args[:for_presentation_only] || false
         @resource = args[:resource]
+        @components = args[:components] || {}
 
         @args = args
 
@@ -155,14 +158,7 @@ module Avo
 
         # Run computable callback block if present
         if computable && block.present?
-          final_value = Avo::ExecutionContext.new(
-            target: block,
-            record: record,
-            resource: @resource,
-            view: @view,
-            field: self,
-            include: self.class.included_modules
-          ).handle
+          final_value = execute_block
         end
 
         # Run the value through resolver if present
@@ -181,6 +177,17 @@ module Avo
         final_value
       end
 
+      def execute_block
+        Avo::ExecutionContext.new(
+          target: block,
+          record: record,
+          resource: resource,
+          view: view,
+          field: self,
+          include: self.class.included_modules
+        ).handle
+      end
+
       # Fills the record with the received value on create and update actions.
       def fill_field(record, key, value, params)
         return record unless record.methods.include? key.to_sym
@@ -192,7 +199,8 @@ module Avo
             key: key,
             value: value,
             resource: resource,
-            field: self
+            field: self,
+            include: self.class.included_modules
           ).handle
         end
 
@@ -220,35 +228,8 @@ module Avo
         id.to_sym
       end
 
-      def view_component_name
-        "#{type.camelize}Field"
-      end
-
-      # For custom components the namespace will be different than Avo::Fields so we should take that into account.
-      def view_component_namespace
-        "#{self.class.to_s.deconstantize}::#{view_component_name}"
-      end
-
-      # Try and build the component class or fallback to a blank one
-      def component_for_view(view = :index)
-        # Use the edit variant for all "update" views
-        view = :edit if view.in? [:new, :create, :update]
-
-        component_class = "#{view_component_namespace}::#{view.to_s.camelize}Component"
-        component_class.constantize
-      rescue
-        unless Rails.env.test?
-          Avo.logger.info "Failed to find component for the `#{self.class}` field on the `#{view}` view."
-        end
-        # When returning nil, a race condition happens and throws an error in some environments.
-        # See https://github.com/avo-hq/avo/pull/365
-        ::Avo::BlankFieldComponent
-      end
-
       def record_errors
-        return {} if record.nil?
-
-        record.errors
+        record.nil? ? {} : record.errors
       end
 
       def type
@@ -289,11 +270,7 @@ module Avo
       private
 
       def model_or_class(model)
-        if model.instance_of?(String)
-          "class"
-        else
-          "model"
-        end
+        model.instance_of?(String) ? "class" : "model"
       end
 
       def is_model?(model)
@@ -305,7 +282,7 @@ module Avo
       end
 
       def on_create?
-        @view.in?([:new, :create])
+        @view.in?(%w[new create])
       end
 
       def in_action?

data/lib/avo/fields/belongs_to_field.rb

@@ -259,7 +259,7 @@ module Avo
       end
 
       def name
-        return polymorphic_as.to_s.humanize if polymorphic_as.present? && view == :index
+        return polymorphic_as.to_s.humanize if polymorphic_as.present? && view.index?
 
         super
       end

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

@@ -13,6 +13,8 @@ module Avo
         # get_html :classes, view: :show, element: :wrapper
         # get_html :styles, view: :index, element: :wrapper
         def get_html(name = nil, element:, view:)
+          view = view.to_sym if view.present?
+
           if [view, element].any?(&:nil?)
             default_attribute_value name
           end

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

@@ -0,0 +1,45 @@
+module Avo
+  module Fields
+    module Concerns
+      module UseViewComponents
+        extend ActiveSupport::Concern
+
+        included do
+          attr_reader :components
+        end
+
+        def view_component_name
+          "#{type.camelize}Field"
+        end
+
+        # For custom components the namespace will be different than Avo::Fields so we should take that into account.
+        def view_component_namespace
+          "#{self.class.to_s.deconstantize}::#{view_component_name}"
+        end
+
+        # Try and build the component class or fallback to a blank one
+        def component_for_view(view = :index)
+          # Use the edit variant for all "update" views
+          view = :edit if view.in? [:new, :create, :update]
+
+          custom_components = Avo::ExecutionContext.new(
+            target: components,
+            resource: @resource,
+            record: @record,
+            view: view
+          ).handle
+
+          component_class = custom_components.dig("#{view}_component".to_sym) || "#{view_component_namespace}::#{view.to_s.camelize}Component"
+          component_class.to_s.constantize
+        rescue
+          unless Rails.env.test?
+            Avo.logger.info "Failed to find component for the `#{self.class}` field on the `#{view}` view."
+          end
+          # When returning nil, a race condition happens and throws an error in some environments.
+          # See https://github.com/avo-hq/avo/pull/365
+          ::Avo::BlankFieldComponent
+        end
+      end
+    end
+  end
+end

data/lib/avo/fields/external_image_field.rb

@@ -4,12 +4,12 @@ module Avo
       attr_reader :width
       attr_reader :height
       attr_reader :radius
-      attr_reader :link_to_resource
+      attr_reader :link_to_record
 
       def initialize(id, **args, &block)
         super(id, **args, &block)
 
-        @link_to_resource = args[:link_to_resource].present? ? args[:link_to_resource] : false
+        @link_to_record = args[:link_to_record].present? ? args[:link_to_record] : false
 
         @width = args[:width].present? ? args[:width] : 40
         @height = args[:height].present? ? args[:height] : 40

data/lib/avo/fields/file_field.rb

@@ -1,7 +1,7 @@
 module Avo
   module Fields
     class FileField < BaseField
-      attr_accessor :link_to_resource
+      attr_accessor :link_to_record
       attr_accessor :is_avatar
       attr_accessor :is_image
       attr_accessor :is_audio
@@ -12,7 +12,7 @@ module Avo
       def initialize(id, **args, &block)
         super(id, **args, &block)
 
-        @link_to_resource = args[:link_to_resource].present? ? args[:link_to_resource] : false
+        @link_to_record = args[:link_to_record].present? ? args[:link_to_record] : false
         @is_avatar = args[:is_avatar].present? ? args[:is_avatar] : false
         @is_image = args[:is_image].present? ? args[:is_image] : @is_avatar
         @is_audio = args[:is_audio].present? ? args[:is_audio] : false

data/lib/avo/fields/gravatar_field.rb

@@ -4,7 +4,7 @@ require "erb"
 module Avo
   module Fields
     class GravatarField < BaseField
-      attr_reader :link_to_resource
+      attr_reader :link_to_record
       attr_reader :rounded
       attr_reader :size
       attr_reader :default
@@ -16,7 +16,7 @@ module Avo
 
         hide_on [:edit, :new]
 
-        @link_to_resource = args[:link_to_resource].present? ? args[:link_to_resource] : false
+        @link_to_record = args[:link_to_record].present? ? args[:link_to_record] : false
         @rounded = args[:rounded].nil? ? true : args[:rounded]
         @size = args[:size].present? ? args[:size].to_i : 32
         @default = args[:default].present? ? ERB::Util.url_encode(args[:default]).to_s : ""

data/lib/avo/fields/has_base_field.rb

@@ -79,8 +79,8 @@ module Avo
 
       # Adds the view override component
       # has_one, has_many, has_and_belongs_to_many fields don't have edit views
-      def component_for_view(view = :index)
-        view = :show if view.in? [:new, :create, :update, :edit]
+      def component_for_view(view = Avo::ViewInquirer.new("index"))
+        view = Avo::ViewInquirer.new("show") if view.in? %w[new create update edit]
 
         super view
       end

data/lib/avo/fields/heading_field.rb

@@ -4,35 +4,27 @@ module Avo
   module Fields
     class HeadingField < BaseField
       attr_reader :as_html
-      attr_reader :empty
-
-      def initialize(content, **args, &block)
-        # Mark the field as empty if there's no content passed
-        @empty = content.blank?
-        # Add dummy content
-        content ||= SecureRandom.hex
 
+      def initialize(id, **args, &block)
         args[:updatable] = false
+        @label = args[:label] || id.to_s.humanize
 
-        super(content, **args, &block)
+        super(id, **args, &block)
 
         # this field is not used to update anything
         @for_presentation_only = true
 
         hide_on :index
 
-        @as_html = args[:as_html].present? ? args[:as_html] : false
+        @as_html = args[:as_html].presence || false
       end
 
       def id
         "heading_#{name.to_s.parameterize.underscore}"
       end
 
-      # Override the value method if the field is empty
       def value
-        return nil if empty
-
-        super
+        block.present? ? execute_block : @label
       end
     end
   end