avo 3.0.0.pre12 → 3.0.0.pre13

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

@@ -38,19 +38,17 @@ module Avo
     attr_accessor :record
 
     class_attribute :id, default: :id
-    class_attribute :title, 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,12 +239,16 @@ module Avo
     def record_title
       return name if @record.nil?
 
-      the_title = @record.send title
-      return the_title if the_title.present?
+      # 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?
 
-      @record.id
-    rescue
-      name
+      # 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
 
     def translation_key
@@ -285,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
@@ -321,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
@@ -461,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?
@@ -497,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 search_description
-      description_field&.value
-    end
-
     def form_scope
       model_class.base_class.to_s.underscore.downcase
     end
@@ -541,5 +498,19 @@ module Avo
         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/filters_session_handler.rb

@@ -1,4 +1,3 @@
-
 module Avo
   module Concerns
     module FiltersSessionHandler

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?

data/lib/avo/fields/has_base_field.rb

@@ -50,7 +50,7 @@ module Avo
 
       # What the user sees in the text field
       def field_label
-        value.send(target_resource.class.title)
+        target_resource.hydrate(record: value).record_title
       rescue
         nil
       end

data/lib/avo/resources/controls/actions_list.rb

@@ -2,13 +2,14 @@ module Avo
   module Resources
     module Controls
       class ActionsList < BaseControl
-        attr_reader :color, :exclude, :style
+        attr_reader :color, :exclude, :include, :style
 
         def initialize(**args)
           super(**args)
 
           @color = args[:color] || :primary
           @exclude = args[:exclude] || []
+          @include = args[:include] || []
           @style = args[:style] || :outline
         end
       end

data/lib/avo/services/debug_service.rb

@@ -55,7 +55,7 @@ class Avo::Services::DebugService
         fields_per_resource: fields_per_resource,
         custom_fields_count: custom_fields_count,
         field_types: field_types,
-        **other_metadata(:actions),
+        # **other_metadata(:actions), #FIEXME: this is fetching actions without hydration
         **other_metadata(:filters),
         main_menu_present: Avo.configuration.main_menu.present?,
         profile_menu_present: Avo.configuration.profile_menu.present?,

data/lib/avo/version.rb

@@ -1,3 +1,3 @@
 module Avo
-  VERSION = "3.0.0.pre12" unless const_defined?(:VERSION)
+  VERSION = "3.0.0.pre13" unless const_defined?(:VERSION)
 end

data/lib/generators/avo/eject_generator.rb

@@ -17,6 +17,7 @@ module Generators
         pre_head: "app/views/avo/partials/_pre_head.html.erb",
         scripts: "app/views/avo/partials/_scripts.html.erb",
         sidebar_extra: "app/views/avo/partials/_sidebar_extra.html.erb",
+        profile_menu_extra: "app/views/avo/partials/_profile_menu_extra.html.erb",
       }
 
       def handle

data/lib/generators/avo/install_generator.rb

@@ -13,7 +13,6 @@ module Generators
         route "mount Avo::Engine, at: Avo.configuration.root_path"
 
         template "initializer/avo.tt", "config/initializers/avo.rb"
-        directory File.join(__dir__, "templates", "locales"), "config/locales"
         create_resources
       end
 

data/lib/generators/avo/resource_generator.rb

@@ -135,6 +135,9 @@ module Generators
         fields_string = ""
 
         fields.each do |field_name, field_options|
+          # if field_options are not available (likely a missing resource for an association), skip the field
+          fields_string += "\n  # Could not generate a field for #{field_name}" and next unless field_options
+
           options = ""
           field_options[:options].each { |k, v| options += ", #{k}: #{v}" } if field_options[:options].present?
 
@@ -181,7 +184,7 @@ module Generators
       end
 
       def field_from_through_association(association)
-        if association.through_reflection.is_a? ActiveRecord::Reflection::HasManyReflection
+        if association.through_reflection.is_a?(ActiveRecord::Reflection::HasManyReflection) || association.through_reflection.is_a?(ActiveRecord::Reflection::ThroughReflection)
           {
             field: "has_many",
             options: {

data/lib/generators/avo/templates/resource/resource.tt

@@ -1,9 +1,8 @@
 class Avo::Resources::<%= resource_class %> < Avo::BaseResource
-  self.title = :id
   self.includes = []<%= model_class_from_args %>
-  # self.search_query = -> do
-  #   query.ransack(id_eq: params[:q], m: "or").result(distinct: false)
-  # end
+  # self.search = {
+  #   query: -> { query.ransack(id_eq: params[:q], m: "or").result(distinct: false) }
+  # }
 
   def fields
     field :id, as: :id<%= generate_fields %>

data/lib/tasks/avo_tasks.rake

@@ -63,3 +63,30 @@ task "avo:gem_paths" do
   # avo:/Users/adrian/work/avocado/avo-3,avo_filters:/Users/adrian/work/avocado/advanced/avo_filters
   puts result
 end
+
+desc "Symlink registered gems in `./tmp/gems` so their views, etc. can be inspected by Tailwind CSS."
+task "avo:link" do
+  Avo::App.boot
+  abort Avo.plugin_manager.plugins.inspect
+  if Dir.exist?("tmp/gems")
+    puts "Removing previously linked gems."
+    `rm -f tmp/gems/*`
+  else
+    if File.exist?("tmp/gems")
+      raise "A file named `tmp/gems` already exists? It has to be removed before we can create the required directory."
+    end
+
+    puts "Creating 'tmp/gems' directory."
+    `mkdir tmp/gems`
+  end
+
+  `touch tmp/gems/.keep`
+
+  Avo.plugin_manager.plugins.each do |linked_gem|
+    target = `bundle show #{linked_gem}`.chomp
+    if target.present?
+      puts "Linking '#{linked_gem}' to '#{target}'."
+      `ln -s #{target} tmp/gems/#{linked_gem}`
+    end
+  end
+end