avo 3.0.0.pre11 → 3.0.0.pre13

data/app/controllers/avo/search_controller.rb

@@ -37,11 +37,11 @@ module Avo
       query = Avo::ExecutionContext.new(
         target: resource.search_query,
         params: params,
-        query: resource.class.scope
+        query: resource.class.query_scope
       ).handle
 
       # Get the count
-      results_count = query.reselect(:id).count
+      results_count = query.reselect(resource.model_class.primary_key).count
 
       # Get the results
       query = query.limit(8)
@@ -58,7 +58,7 @@ module Avo
 
       result_object = {
         header: header,
-        help: resource.class.search_query_help,
+        help: resource.fetch_search(:help) || "",
         results: results,
         count: results.count
       }
@@ -112,21 +112,17 @@ module Avo
         # resource = avo_resource.dup.hydrate(record: record).hydrate_fields
         resource = avo_resource.dup.hydrate(record: record)
 
-        fetch_result_information record, resource
+        fetch_result_information record, resource, resource.fetch_search(:item)
       end
     end
 
     private
 
-    def fetch_result_information(record, resource)
+    def fetch_result_information(record, resource, item)
       {
         _id: record.id,
-        _label: resource.label,
-        _url: Avo::ExecutionContext.new(
-          target: resource.search_result_path || resource.record_path,
-          resource: resource,
-          record: record
-        ).handle,
+        _label: item&.dig(:title) || resource.record_title,
+        _url: resource.fetch_search(:result_path) || resource.record_path
       }
     end
 

data/app/javascript/js/controllers/fields/{simple_mde_controller.js → easy_mde_controller.js}

@@ -1,5 +1,5 @@
 import { Controller } from '@hotwired/stimulus'
-import SimpleMDE from 'simplemde'
+import EasyMDE from 'easymde'
 
 export default class extends Controller {
   static targets = ['element']
@@ -27,9 +27,9 @@ export default class extends Controller {
       options.status = false
     }
 
-    const simpleMde = new SimpleMDE(options)
+    const easyMde = new EasyMDE(options)
     if (this.view === 'show') {
-      simpleMde.codemirror.options.readOnly = true
+      easyMde.codemirror.options.readOnly = true
     }
   }
 }

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

@@ -211,7 +211,9 @@ export default class extends Controller {
   searchUrl(query) {
     const url = URI()
 
-    return url.segment([window.Avo.configuration.root_path, ...this.searchSegments()]).search(this.searchParams(query)).readable().toString()
+    return url.segment([window.Avo.configuration.root_path, ...this.searchSegments()])
+      .search(this.searchParams(encodeURIComponent(query)))
+      .readable().toString()
   }
 
   searchSegments() {

data/app/javascript/js/controllers.js

@@ -10,6 +10,7 @@ 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 EasyMdeController from './controllers/fields/easy_mde_controller'
 import FilterController from './controllers/filter_controller'
 import HiddenInputController from './controllers/hidden_input_controller'
 import InputAutofocusController from './controllers/input_autofocus_controller'
@@ -31,7 +32,6 @@ import SelectController from './controllers/select_controller'
 import SelectFilterController from './controllers/select_filter_controller'
 import SelfDestroyController from './controllers/self_destroy_controller'
 import SidebarController from './controllers/sidebar_controller'
-import SimpleMdeController from './controllers/fields/simple_mde_controller'
 import TabsController from './controllers/tabs_controller'
 import TextFilterController from './controllers/text_filter_controller'
 import TippyController from './controllers/tippy_controller'
@@ -73,9 +73,9 @@ application.register('toggle', ToggleController)
 application.register('belongs-to-field', BelongsToFieldController)
 application.register('code-field', CodeFieldController)
 application.register('date-field', DateFieldController)
+application.register('easy-mde', EasyMdeController)
 application.register('key-value', KeyValueController)
 application.register('progress-bar-field', ProgressBarFieldController)
-application.register('simple-mde', SimpleMdeController)
 application.register('trix-field', TrixFieldController)
 
 // Custom controllers

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

@@ -9,7 +9,7 @@
   >
     <%= form_with model: @record,
       scope: 'fields',
-      url: "#{@resource.records_path}/actions",
+      url: Avo::Services::URIService.parse(@resource.records_path).append_paths("actions").to_s,
       local: true,
       data: @action.class.form_data_attributes do |form|
     %>
@@ -23,6 +23,7 @@
       <%= hidden_field_tag :action_id, @action.param_id %>
       <%= form.hidden_field :avo_resource_ids, value: params[:id] || params[:resource_ids], 'data-action-target': 'resourceIds' %>
       <%= form.hidden_field :avo_selected_query, 'data-action-target': 'selectedAllQuery' %>
+      <%= form.hidden_field :arguments, value: params[:arguments] %>
       <% if @action.get_fields.present? %>
         <div class="my-4 -mx-6">
           <% @action.get_fields.each_with_index do |field, index| %>

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

@@ -0,0 +1,2 @@
+<%# Example link below %>
+<%#= render Avo::ProfileItemComponent.new label: 'Profile', path: '/profile', icon: 'user-circle' %>

data/lib/avo/app.rb

@@ -38,7 +38,7 @@ module Avo
           when "ActiveSupport::Cache::MemCacheStore", "ActiveSupport::Cache::RedisCacheStore"
             Rails.cache
           else
-            ActiveSupport::Cache.lookup_store(:file_store, "/tmp/cache")
+            ActiveSupport::Cache.lookup_store(:file_store, Rails.root.join("tmp", "cache"))
           end
         elsif Rails.env.test?
           Rails.cache

data/lib/avo/base_action.rb

@@ -86,7 +86,14 @@ module Avo
 
     def get_attributes_for_action
       get_fields.map do |field|
-        [field.id, field.value || field.default]
+        value = field.value || Avo::ExecutionContext.new(
+          target: field.default,
+          record: self.class.record,
+          resource: self.class.resource,
+          view: view
+        ).handle
+
+        [field.id, value]
       end.to_h
     end
 

data/lib/avo/base_resource.rb

@@ -8,6 +8,7 @@ module Avo
     include Avo::Concerns::HasControls
     include Avo::Concerns::HasStimulusControllers
     include Avo::Concerns::ModelClassConstantized
+    include Avo::Concerns::HasDescription
 
     # Avo::Current methods
     delegate :context, to: Avo::Current
@@ -37,20 +38,17 @@ module Avo
     attr_accessor :record
 
     class_attribute :id, default: :id
-    class_attribute :title, default: :id
-    class_attribute :description, default: :id
-    class_attribute :search_query, default: nil
-    class_attribute :search_query_help, default: ""
-    class_attribute :search_result_path
+    class_attribute :title
+    class_attribute :search, default: {}
     class_attribute :includes, default: []
     class_attribute :authorization_policy
     class_attribute :translation_key
     class_attribute :default_view_type, default: :table
     class_attribute :devise_password_optional, default: false
-    class_attribute :actions_loader
     class_attribute :scopes_loader
     class_attribute :filters_loader
-    class_attribute :grid_loader
+    class_attribute :view_types
+    class_attribute :grid_view
     class_attribute :visible_on_sidebar, default: true
     class_attribute :index_query, default: -> {
       query
@@ -58,7 +56,6 @@ module Avo
     class_attribute :find_record_method, default: -> {
       query.find id
     }
-    class_attribute :hide_from_global_search, default: false
     class_attribute :after_create_path, default: :show
     class_attribute :after_update_path, default: :show
     class_attribute :record_selector, default: true
@@ -74,39 +71,16 @@ module Avo
       delegate :t, to: ::I18n
       delegate :context, to: ::Avo::Current
 
-      def grid(&block)
-        grid_collector = GridCollector.new
-        grid_collector.instance_eval(&block)
-
-        self.grid_loader = grid_collector
-      end
-
       def action(action_class, arguments: {})
-        self.actions_loader ||= Avo::Loaders::Loader.new
-
-        action = {class: action_class, arguments: arguments}
-        self.actions_loader.use action
+        deprecated_dsl_api __method__, "actions"
       end
 
       def filter(filter_class, arguments: {})
-        self.filters_loader ||= Avo::Loaders::Loader.new
-
-        filter = { class: filter_class , arguments: arguments }
-        self.filters_loader.use filter
+        deprecated_dsl_api __method__, "filters"
       end
 
-      # This is the search_query scope
-      # This should be removed and passed to the search block
-      def scope
-        query_scope
-      end
-
-      def scopes(*args)
-        self.scopes_loader ||= Avo::Loaders::Loader.new
-
-        args.each do |scope_class|
-          self.scopes_loader.use scope_class
-        end
+      def scope(scope_class)
+        deprecated_dsl_api __method__, "scopes"
       end
 
       # This resolves the scope when doing "where" queries (not find queries)
@@ -195,54 +169,47 @@ module Avo
       # blank fields method
     end
 
-    def hydrate(record: nil, view: nil, user: nil, params: nil)
-      @view = view if view.present?
-      @user = user if user.present?
-      @params = params if params.present?
+    [:action, :filter, :scope].each do |entity|
+      plural_entity = entity.to_s.pluralize
 
-      if record.present?
-        @record = record
-
-        hydrate_model_with_default_values if @view == :new
+      # def actions / def filters / def scopes
+      define_method plural_entity do
+        # blank entity method
       end
 
-      self
-    end
-
-    def get_grid_fields
-      return if self.class.grid_loader.blank?
-
-      self.class.grid_loader.hydrate(record: @record, view: @view, resource: self)
-    end
-
-    def get_filters
-      return [] if self.class.filters_loader.blank?
-
-      self.class.filters_loader.bag
-    end
+      # def action / def filter / def scope
+      define_method entity do |entity_class, arguments: {}|
+        entity_loader(entity).use({class: entity_class, arguments: arguments})
+      end
 
-    def get_filter_arguments(filter_class)
-      filter = get_filters.find { |filter| filter[:class] == filter_class.constantize }
+      # def get_actions / def get_filters / def get_scopes
+      define_method "get_#{plural_entity}" do
+        return entity_loader(entity).bag if entity_loader(entity).present?
 
-      filter[:arguments]
-    end
+        instance_variable_set("@#{plural_entity}_loader", Avo::Loaders::Loader.new)
+        send plural_entity
 
-    def get_actions
-      return [] if self.class.actions_loader.blank?
+        entity_loader(entity).bag
+      end
 
-      self.class.actions_loader.bag
+      # 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] == entity_class.constantize }[:arguments]
+      end
     end
 
-    def get_action_arguments(action_class)
-      action = get_actions.find { |action| action[:class].to_s == action_class.to_s }
+    def hydrate(record: nil, view: nil, user: nil, params: nil)
+      @view = view if view.present?
+      @user = user if user.present?
+      @params = params if params.present?
 
-      action[:arguments]
-    end
+      if record.present?
+        @record = record
 
-    def get_scopes
-      return [] if self.class.scopes_loader.blank?
+        hydrate_model_with_default_values if @view == :new
+      end
 
-      self.class.scopes_loader.bag
+      self
     end
 
     def default_panel_name
@@ -272,21 +239,15 @@ module Avo
     def record_title
       return name if @record.nil?
 
-      the_title = @record.send title
-      return the_title if the_title.present?
-
-      @record.id
-    rescue
-      name
-    end
-
-    def resource_description
-      return instance_exec(&self.class.description) if self.class.description.respond_to? :call
+      # Get the title from the record if title is not set, try to get the name, title or label, or fallback to the id
+      return @record.try(:name) || @record.try(:title) || @record.try(:label) || @record.id  if title.nil?
 
-      # Show the description only on the resource index view.
-      # If the user wants to conditionally it on all pages, they should use a block.
-      if view == :index
-        return self.class.description if self.class.description.is_a? String
+      # If the title is a symbol, get the value from the record else execute the block/string
+      case title
+      when Symbol
+        @record.send title
+      when Proc
+        Avo::ExecutionContext.new(target: title, resource: self, record: @record).handle
       end
     end
 
@@ -295,10 +256,10 @@ module Avo
     end
 
     def name
-      default = class_name.underscore.humanize
-
       return @name if @name.present?
 
+      default = class_name.underscore.humanize
+
       if translation_key
         t(translation_key, count: 1, default: default).capitalize
       else
@@ -331,9 +292,19 @@ module Avo
     end
 
     def available_view_types
+      if self.class.view_types.present?
+        return Array(
+          Avo::ExecutionContext.new(
+            target: self.class.view_types,
+            resource: self,
+            record: record
+          ).handle
+        )
+      end
+
       view_types = [:table]
 
-      view_types << :grid if get_grid_fields.present?
+      view_types << :grid if self.class.grid_view.present?
       view_types << :map if map_view.present?
 
       view_types
@@ -471,18 +442,6 @@ module Avo
       resources_path(resource: self)
     end
 
-    def label_field
-      get_field_definitions.find do |field|
-        field.as_label.present?
-      end
-    rescue
-      nil
-    end
-
-    def label
-      label_field&.value || record_title
-    end
-
     def avatar_field
       get_field_definitions.find do |field|
         field.as_avatar.present?
@@ -507,18 +466,6 @@ module Avo
       nil
     end
 
-    def description_field
-      get_field_definitions.find do |field|
-        field.as_description.present?
-      end
-    rescue
-      nil
-    end
-
-    def description
-      description_field&.value
-    end
-
     def form_scope
       model_class.base_class.to_s.underscore.downcase
     end
@@ -543,5 +490,27 @@ module Avo
     def record_id
       record.send(id_attribute)
     end
+
+    def description_attributes
+      {
+        view: view,
+        resource: self,
+        record: record
+      }
+    end
+
+    def search_query
+      self.class.search.dig(:query)
+    end
+
+    def fetch_search(key)
+      Avo::ExecutionContext.new(target: self.class.search[key], resource: self, record: record).handle
+    end
+
+    private
+
+    def entity_loader(entity)
+      instance_variable_get("@#{entity.to_s.pluralize}_loader")
+    end
   end
 end

data/lib/avo/concerns/breadcrumbs.rb

@@ -50,7 +50,7 @@ module Avo
           when Symbol
             context.send(name)
           when Proc
-            name.call(context)
+            Avo::ExecutionContext.new(target: name, context: context).handle
           else
             name.to_s
           end
@@ -61,7 +61,7 @@ module Avo
           when Symbol
             context.send(path)
           when Proc
-            path.call(context)
+            Avo::ExecutionContext.new(target: path, context: context).handle
           else
             context.url_for(path)
           end

data/lib/avo/concerns/filters_session_handler.rb

@@ -1,4 +1,3 @@
-
 module Avo
   module Concerns
     module FiltersSessionHandler
@@ -34,9 +33,11 @@ module Avo
       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)
+        Avo::ExecutionContext.new(
+          target: Avo.configuration.cache_resource_filters,
+          current_user: current_user,
+          resource: @resource
+        ).handle
       end
     end
   end

data/lib/avo/concerns/has_description.rb

@@ -0,0 +1,23 @@
+# Adds the ability to set the visibility of an item in the execution context.
+module Avo
+  module Concerns
+    module HasDescription
+      extend ActiveSupport::Concern
+
+      class_methods do
+        attr_accessor :description
+      end
+
+      def description
+        Avo::ExecutionContext.new(target: @description || self.class.description, **description_attributes).handle
+      end
+
+      private
+
+      # Override this method to add custom attributes to the description execution context.
+      def description_attributes
+        {}
+      end
+    end
+  end
+end

data/lib/avo/concerns/has_items.rb

@@ -4,34 +4,34 @@ module Avo
       extend ActiveSupport::Concern
 
       class_methods do
-        def deprecated_dsl_api(name = nil)
-          message = "This API was deprecated. Please use the `#{name}` method inside the `fields` method."
+        def deprecated_dsl_api(name, method)
+          message = "This API was deprecated. Please use the `#{name}` method inside the `#{method}` method."
           raise DeprecatedAPIError.new message
         end
 
         # DSL methods
         def field(name, as: :text, **args, &block)
-          deprecated_dsl_api "field"
+          deprecated_dsl_api __method__, "fields"
         end
 
         def panel(name = nil, **args, &block)
-          deprecated_dsl_api "panel"
+          deprecated_dsl_api __method__, "fields"
         end
 
         def tabs(**args, &block)
-          deprecated_dsl_api "tabs"
+          deprecated_dsl_api __method__, "fields"
         end
 
         def tool(klass, **args)
-          deprecated_dsl_api "tool"
+          deprecated_dsl_api __method__, "fields"
         end
 
         def heading(body, **args)
-          deprecated_dsl_api "heading"
+          deprecated_dsl_api __method__, "fields"
         end
 
         def sidebar(**args, &block)
-          deprecated_dsl_api "sidebar"
+          deprecated_dsl_api __method__, "fields"
         end
         # END DSL methods
       end

data/lib/avo/configuration.rb

@@ -2,8 +2,9 @@ module Avo
   class Configuration
     include ResourceConfiguration
 
+    attr_writer :app_name
+    attr_writer :branding
     attr_writer :root_path
-    attr_accessor :app_name
     attr_accessor :timezone
     attr_accessor :per_page
     attr_accessor :per_page_steps
@@ -42,7 +43,6 @@ module Avo
     attr_accessor :sign_out_path_name
     attr_accessor :resources
     attr_accessor :prefix_path
-    attr_writer :branding
 
     def initialize
       @root_path = "/avo"
@@ -136,6 +136,10 @@ module Avo
     def branding
       Avo::Configuration::Branding.new(**@branding || {})
     end
+
+    def app_name
+      Avo::ExecutionContext.new(target: @app_name).handle
+    end
   end
 
   def self.configuration

data/lib/avo/engine.rb

@@ -91,5 +91,10 @@ module Avo
       Rails::Generators.configure! app.config.generators
       require_relative "../generators/model_generator"
     end
+
+    initializer "avo.locales" do |app|
+      I18n.load_path += Dir[Avo::Engine.root.join("lib", "generators", "avo", "templates", "locales", "*.{rb,yml}")]
+      I18n.load_path += Dir[Rails.root.join("config", "locales", "*.{rb,yml}")]
+    end
   end
 end

data/lib/avo/fields/base_field.rb

@@ -36,9 +36,7 @@ module Avo
       attr_reader :autocomplete
       attr_reader :help
       attr_reader :default
-      attr_reader :as_label
       attr_reader :as_avatar
-      attr_reader :as_description
       attr_reader :stacked
       attr_reader :for_presentation_only
 
@@ -72,9 +70,7 @@ module Avo
         @help = args[:help] || nil
         @default = args[:default] || nil
         @visible = args[:visible]
-        @as_label = args[:as_label] || false
         @as_avatar = args[:as_avatar] || false
-        @as_description = args[:as_description] || false
         @html = args[:html] || nil
         @view = args[:view] || nil
         @value = args[:value] || nil

data/lib/avo/fields/belongs_to_field.rb

@@ -104,9 +104,7 @@ module Avo
 
       # What the user sees in the text field
       def field_label
-        value.send(target_resource.class.title)
-      rescue
-        nil
+        label
       end
 
       def options
@@ -123,8 +121,8 @@ module Avo
           query = Avo::ExecutionContext.new(target: attach_scope, query: query, parent: get_model).handle
         end
 
-        query.all.map do |model|
-          [model.send(resource.class.title), model.id]
+        query.all.map do |record|
+          [resource.hydrate(record: record).record_title, record.id]
         end
       end
 
@@ -182,7 +180,7 @@ module Avo
       end
 
       def label
-        value.send(target_resource.class.title)
+        target_resource.hydrate(record: value).record_title
       end
 
       def to_permitted_param
@@ -197,10 +195,12 @@ module Avo
         return model unless model.methods.include? key.to_sym
 
         if polymorphic_as.present?
-          model.send("#{polymorphic_as}_type=", params["#{polymorphic_as}_type"])
+          valid_model_class = valid_polymorphic_class params["#{polymorphic_as}_type"]
+
+          model.send("#{polymorphic_as}_type=", valid_model_class)
 
           # If the type is blank, reset the id too.
-          if params["#{polymorphic_as}_type"].blank?
+          if valid_model_class.blank?
             model.send("#{polymorphic_as}_id=", nil)
           else
             model.send("#{polymorphic_as}_id=", params["#{polymorphic_as}_id"])
@@ -212,6 +212,12 @@ module Avo
         model
       end
 
+      def valid_polymorphic_class(possible_class)
+        types.find do |type|
+          type.to_s == possible_class.to_s
+        end
+      end
+
       def database_id
         # If the field is a polymorphic value, return the polymorphic_type as key and pre-fill the _id in fill_field.
         return "#{polymorphic_as}_type" if polymorphic_as.present?