avo 3.0.0.pre18 → 3.0.0.pre19

data/app/controllers/avo/base_controller.rb

@@ -75,6 +75,8 @@ module Avo
       @resources = @records.map do |record|
         @resource.hydrate(record: record, params: params).dup
       end
+
+      set_component_for __method__
     end
 
     def show
@@ -98,6 +100,8 @@ module Avo
 
       add_breadcrumb @resource.record_title
       add_breadcrumb I18n.t("avo.details").upcase_first
+
+      set_component_for __method__
     end
 
     def new
@@ -119,6 +123,8 @@ module Avo
 
       add_breadcrumb @resource.plural_name.humanize, resources_path(resource: @resource)
       add_breadcrumb t("avo.new").humanize
+
+      set_component_for __method__, fallback_view: :edit
     end
 
     def create
@@ -161,6 +167,8 @@ module Avo
       add_breadcrumb t("avo.new").humanize
       set_actions
 
+      set_component_for :edit
+
       if saved
         create_success_action
       else
@@ -170,6 +178,8 @@ module Avo
 
     def edit
       set_actions
+
+      set_component_for __method__
     end
 
     def update
@@ -178,6 +188,8 @@ module Avo
       @resource = @resource.hydrate(record: @record, view: :edit, user: _current_user)
       set_actions
 
+      set_component_for :edit
+
       if saved
         update_success_action
       else
@@ -517,7 +529,7 @@ module Avo
 
       if @resource.class.send(action) == :index
         resources_path(resource: @resource)
-      elsif @resource.class.send(action) == :edit || Avo.configuration.resource_default_view == :edit
+      elsif @resource.class.send(action) == :edit || Avo.configuration.resource_default_view.edit?
         edit_resource_path(resource: @resource, record: @resource.record)
       else
         resource_path(record: @record, resource: @resource)
@@ -540,5 +552,31 @@ module Avo
     def pagy_query
       @query
     end
+
+    # Set the view component for the current view
+    # It will try to use the custom component if it's set, otherwise it will use the default one
+    def set_component_for(view, fallback_view: nil)
+      # Fetch the components from the resource
+      components = Avo::ExecutionContext.new(
+        target: @resource.components,
+        resource: @resource,
+        record: @record,
+        view: @view
+      ).handle
+
+      # If the component is not set, use the default one
+      if (custom_component = components.dig("resource_#{view}_component".to_sym)).nil?
+        return @component = "Avo::Views::Resource#{(fallback_view || view).to_s.classify}Component".constantize
+      end
+
+      # If the component is set, try to use it
+      @component = custom_component.to_s.safe_constantize
+
+      # If the component is not found, raise an error
+      if @component.nil?
+        raise "The component '#{custom_component}' was not found.\n" \
+        "That component was fetched from 'self.components' option inside '#{@resource.class}' resource."
+      end
+    end
   end
 end

data/app/controllers/avo/search_controller.rb

@@ -9,6 +9,8 @@ module Avo
 
     def show
       render json: search_resources([resource])
+    rescue => error
+      render_search_error(error)
     end
 
     private
@@ -40,14 +42,14 @@ module Avo
         query: resource.query_scope
       ).handle
 
+      query = apply_scope(query) if should_apply_any_scope?
+
       # Get the count
       results_count = query.reselect(resource.model_class.primary_key).count
 
       # Get the results
       query = query.limit(8)
 
-      query = apply_scope(query) if should_apply_any_scope?
-
       results = apply_search_metadata(query, resource)
 
       header = resource.plural_name
@@ -164,5 +166,20 @@ module Avo
       parent_resource = Avo.resource_manager.get_resource_by_model_class params[:via_reflection_class]
       parent_resource.find_record params[:via_reflection_id], params: params
     end
+
+    def render_search_error(error)
+      raise error unless Rails.env.development?
+
+      render json: {
+        error: {
+          header: "🚨 An error occurred while searching. 🚨",
+          help: "Please see the error and fix it before deploying.",
+          results: {
+            _label: error.message
+          },
+          count: 1
+        }
+      }, status: 500
+    end
   end
 end

data/app/controllers/concerns/avo/initializes_avo.rb

@@ -7,6 +7,7 @@ module Avo
       Avo::Current.view_context = view_context
       Avo.init
       Avo::Current.license = Licensing::LicenseManager.new(Licensing::HQ.new(request).response).license
+      Avo::Current.locale = locale
       Avo.plugin_manager.init_plugins
     end
 

data/app/helpers/avo/resources_helper.rb

@@ -38,7 +38,7 @@ module Avo
     end
 
     def item_selector_init(resource)
-      "data-resource-name='#{resource.model_key}' data-resource-id='#{resource.record.id}' data-controller='item-selector'"
+      "data-resource-name='#{resource.model_key}' data-resource-id='#{resource.record.to_param}' data-controller='item-selector'"
     end
 
     def item_selector_input(floating: false, size: :md)

data/app/helpers/avo/url_helpers.rb

@@ -94,7 +94,7 @@ module Avo
     end
 
     def resource_view_path(**args)
-      if Avo.configuration.resource_default_view == :edit
+      if Avo.configuration.resource_default_view.edit?
         edit_resource_path(**args)
       else
         resource_path(**args)

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

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

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

@@ -1,5 +1,5 @@
 <%= render Avo::TurboFrameWrapperComponent.new(params[:turbo_frame]) do %>
-  <%= render Avo::Views::ResourceIndexComponent.new(
+  <%= render @component.new(
       resource: @resource,
       resources: @resources,
       records: @records,

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

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

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

@@ -1,5 +1,5 @@
 <%= render Avo::TurboFrameWrapperComponent.new(params[:turbo_frame]) do %>
-  <%= render Avo::Views::ResourceShowComponent.new(
+  <%= render @component.new(
     resource: @resource,
     reflection: @reflection,
     actions: @actions,

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

@@ -12,10 +12,18 @@
     <%= render Avo::AssetManager::StylesheetComponent.new asset_manager: Avo.asset_manager %>
     <% if Avo::PACKED %>
       <%= javascript_include_tag "/avo-assets/avo.base", "data-turbo-track": "reload", defer: true %>
-      <%= stylesheet_link_tag "/avo-assets/avo.base", "data-turbo-track": "reload", defer: true %>
+      <% if Rails.root.join("config", "avo", "tailwind.config.js").exist? %>
+        <%= stylesheet_link_tag "avo.tailwind", "data-turbo-track": "reload", defer: true %>
+      <% else %>
+        <%= stylesheet_link_tag "/avo-assets/avo.base", "data-turbo-track": "reload", defer: true %>
+      <% end %>
     <% else %>
       <%= javascript_include_tag "avo.base", "data-turbo-track": "reload", defer: true %>
-      <%= stylesheet_link_tag "avo.base", "data-turbo-track": "reload", defer: true %>
+      <% if Rails.root.join("config", "avo", "tailwind.config.js").exist? %>
+        <%= stylesheet_link_tag "avo.tailwind", "data-turbo-track": "reload", defer: true %>
+      <% else %>
+        <%= stylesheet_link_tag "avo.base", "data-turbo-track": "reload", defer: true %>
+      <% end %>
       <% if Rails.env.development? %>
         <%= javascript_include_tag "hotwire-livereload", defer: true %>
       <% end %>

data/bin/dev

@@ -3,6 +3,8 @@
 PORT="${PORT:-3030}"
 export PORT
 
+bundle exec rake avo:sym_link
+
 if command -v overmind &> /dev/null; then
   overmind start -f Procfile.dev "$@"
 else

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/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

@@ -25,7 +25,7 @@ module Avo
     delegate :view, to: :class
     # TODO: find a differnet way to delegate this to the uninitialized Current variable
     delegate :context, to: Avo::Current
-    def curent_user
+    def current_user
       Avo::Current.user
     end
     delegate :params, to: Avo::Current
@@ -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,10 +9,11 @@ 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
-    def curent_user
+    def current_user
       Avo::Current.user
     end
     delegate :params, to: Avo::Current
@@ -65,6 +66,7 @@ module Avo
     class_attribute :extra_params
     class_attribute :link_to_child_resource, default: false
     class_attribute :map_view
+    class_attribute :components, default: {}
 
     # EXTRACT:
     class_attribute :ordering
@@ -232,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
@@ -293,19 +295,23 @@ module Avo
 
       # def get_action_arguments / def get_filter_arguments / def get_scope_arguments
       define_method "get_#{entity}_arguments" do |entity_class|
-        send("get_#{plural_entity}").find { |entity| entity[:class].to_s == entity_class.to_s }[:arguments]
+        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]
       end
     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
@@ -440,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

@@ -12,7 +12,6 @@ module Avo
     attr_accessor :locale
     attr_accessor :currency
     attr_accessor :default_view_type
-    attr_accessor :license
     attr_accessor :license_key
     attr_accessor :authorization_methods
     attr_accessor :authenticate
@@ -37,12 +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"
@@ -54,7 +55,6 @@ module Avo
       @locale = nil
       @currency = "USD"
       @default_view_type = :table
-      @license = "community"
       @license_key = nil
       @current_user = proc {}
       @authenticate = proc {}
@@ -89,10 +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)
@@ -140,6 +142,28 @@ module Avo
     def app_name
       Avo::ExecutionContext.new(target: @app_name).handle
     end
+
+    def license=(value)
+      if Rails.env.development?
+        puts "[Avo DEPRECATION WARNING]: The `config.license` configuration option is no longer supported and will be removed in future versions. Please discontinue its use and solely utilize the `license_key` instead."
+      end
+    end
+
+    def license
+      gems = Gem::Specification.map {|gem| gem.name}
+
+      @license ||= if gems.include?("avo-advanced")
+        "advanced"
+      elsif gems.include?("avo-pro")
+        "pro"
+      elsif gems.include?("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,16 +24,11 @@ class Avo::Current < ActiveSupport::CurrentAttributes
   attribute :resource_manager
   attribute :tool_manager
   attribute :plugin_manager
+  attribute :locale
 
   delegate :params, to: :request
 
   def request
     view_context.request || ActionDispatch::Request.empty
   end
-
-  def current_user
-    Rails.logger.warn "DEPRECATION WARNING: Avo::Current.current_user become deprecated and will become obsolete on futhure versions. Please use Avo::Current.user instead."
-
-    user
-  end
 end

data/lib/avo/dsl/field_parser.rb

@@ -47,7 +47,7 @@ module Avo
         else
           # The symbol can be transformed to a class and found.
           class_name = as.to_s.camelize
-          field_class = "#{class_name}Field"
+          field_class = "Avo::Fields::#{class_name}Field"
 
           # Discover & load custom field classes
           if Object.const_defined? field_class

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