avo 2.46.0 → 3.0.0.pre2

data/lib/avo/base_resource.rb

@@ -3,52 +3,52 @@ module Avo
     extend ActiveSupport::DescendantsTracker
 
     include ActionView::Helpers::UrlHelper
-    include Avo::Concerns::HasFields
-    include Avo::Concerns::CanReplaceFields
-    include Avo::Concerns::HasEditableControls
-    include Avo::Concerns::HasResourceStimulusControllers
+    include Avo::Concerns::HasItems
+    include Avo::Concerns::CanReplaceItems
+    include Avo::Concerns::HasControls
+    include Avo::Concerns::HasStimulusControllers
     include Avo::Concerns::ModelClassConstantized
-    include Avo::Concerns::Pagination
 
-    delegate :view_context, to: ::Avo::App
-    delegate :current_user, to: ::Avo::App
-    delegate :params, to: ::Avo::App
+    delegate :context, to: Avo::Current
+    delegate :current_user, to: Avo::Current
+    delegate :params, to: Avo::Current
+    delegate :request, to: Avo::Current
+    delegate :view_context, to: Avo::Current
     delegate :simple_format, :content_tag, to: :view_context
     delegate :main_app, to: :view_context
     delegate :avo, to: :view_context
     delegate :resource_path, to: :view_context
     delegate :resources_path, to: :view_context
     delegate :t, to: ::I18n
-    delegate :context, to: ::Avo::App
 
     attr_accessor :view
     attr_accessor :reflection
     attr_accessor :user
     attr_accessor :params
+    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 :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 :visible_on_sidebar, default: true
     class_attribute :unscoped_queries_on_index, default: false
-    class_attribute :resolve_query_scope
+    class_attribute :resolve_index_query
     class_attribute :resolve_find_scope
     # TODO: refactor this into a Host without args
     class_attribute :find_record_method, default: ->(model_class:, id:, params:) {
       model_class.find id
     }
-    class_attribute :ordering
     class_attribute :hide_from_global_search, default: false
     class_attribute :after_create_path, default: :show
     class_attribute :after_update_path, default: :show
@@ -56,11 +56,13 @@ module Avo
     class_attribute :keep_filters_panel_open, default: false
     class_attribute :extra_params
     class_attribute :link_to_child_resource, default: false
-    class_attribute :map_view
+
+    # EXTRACT:
+    class_attribute :ordering
 
     class << self
       delegate :t, to: ::I18n
-      delegate :context, to: ::Avo::App
+      delegate :context, to: ::Avo::Current
 
       def grid(&block)
         grid_collector = GridCollector.new
@@ -72,7 +74,7 @@ module Avo
       def action(action_class, arguments: {})
         self.actions_loader ||= Avo::Loaders::Loader.new
 
-        action = { class: action_class, arguments: arguments }
+        action = {class: action_class, arguments: arguments}
         self.actions_loader.use action
       end
 
@@ -89,28 +91,38 @@ module Avo
         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
+      end
+
       # This resolves the scope when doing "where" queries (not find queries)
       def query_scope
-        final_scope = resolve_query_scope.present? ? resolve_query_scope.call(model_class: model_class) : model_class
+        final_scope = if resolve_index_query.present?
+          Avo::ExecutionContext.new(target: resolve_index_query, model_class: model_class).handle
+        else
+          model_class
+        end
 
         authorization.apply_policy final_scope
       end
 
       # This resolves the scope when finding records (not "where" queries)
       def find_scope
-        final_scope = resolve_find_scope.present? ? resolve_find_scope.call(model_class: model_class) : model_class
+        final_scope = if resolve_find_scope.present?
+          Avo::ExecutionContext.new(target: resolve_find_scope, model_class: model_class).handle
+        else
+          model_class
+        end
 
         authorization.apply_policy final_scope
       end
 
       def authorization
-        Avo::Services::AuthorizationService.new Avo::App.current_user, model_class, policy_class: authorization_policy
-      end
-
-      def order_actions
-        return {} if ordering.blank?
-
-        ordering.dig(:actions) || {}
+        Avo::Services::AuthorizationService.new Avo::Current.current_user, model_class, policy_class: authorization_policy
       end
 
       def get_record_associations(record)
@@ -134,13 +146,15 @@ module Avo
         ApplicationRecord.descendants
       end
 
-      def valid_model_class(model_class)
+      def get_model_by_name(model_name)
         get_available_models.find do |m|
-          m.to_s == model_class.to_s
+          m.to_s == model_name.to_s
         end
       end
     end
 
+    delegate :context, to: ::Avo::Current
+
     def initialize
       unless self.class.model_class.present?
         if model_class.present? && model_class.respond_to?(:base_class)
@@ -149,19 +163,13 @@ module Avo
       end
     end
 
-    def record
-      @model
-    end
-    alias_method :model, :record
-
-
-    def hydrate(model: nil, view: nil, user: nil, params: nil)
+    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?
 
-      if model.present?
-        @model = model
+      if record.present?
+        @record = record
 
         hydrate_model_with_default_values if @view == :new
       end
@@ -172,7 +180,7 @@ module Avo
     def get_grid_fields
       return if self.class.grid_loader.blank?
 
-      self.class.grid_loader.hydrate(model: @model, view: @view, resource: self)
+      self.class.grid_loader.hydrate(record: @record, view: @view, resource: self)
     end
 
     def get_filters
@@ -199,45 +207,47 @@ module Avo
       action[:arguments]
     end
 
+    def get_scopes
+      return [] if self.class.scopes_loader.blank?
+
+      self.class.scopes_loader.bag
+    end
+
     def default_panel_name
       return @params[:related_name].capitalize if @params.present? && @params[:related_name].present?
 
       case @view
       when :show
-        model_title
+        record_title
       when :edit
-        model_title
+        record_title
       when :new
         t("avo.create_new_item", item: name.downcase).upcase_first
       end
     end
 
-    def class_name_without_resource
-      self.class.name.demodulize.delete_suffix("Resource")
+    def class_name
+      self.class.name.demodulize
     end
 
     def model_class
       # get the model class off of the static property
       return self.class.model_class if self.class.model_class.present?
 
-      # get the model class off of the model for STI models
-      return @model.base_class if @model.present?
+      # get the model class off of the record
+      return @record.base_class if @record.present?
 
       # generate a model class
-      class_name_without_resource.safe_constantize
+      class_name.safe_constantize
     end
 
-    def model_id
-      @model.send id
-    end
-
-    def model_title
-      return name if @model.nil?
+    def record_title
+      return name if @record.nil?
 
-      the_title = @model.send title
+      the_title = @record.send title
       return the_title if the_title.present?
 
-      model_id
+      @record.id
     rescue
       name
     end
@@ -253,18 +263,16 @@ module Avo
     end
 
     def translation_key
-      return "avo.resource_translations.#{class_name_without_resource.underscore}" if ::Avo::App.translation_enabled
-
-      self.class.translation_key
+      self.class.translation_key || "avo.resource_translations.#{class_name.underscore}"
     end
 
     def name
-      default = class_name_without_resource.to_s.gsub('::', ' ').underscore.humanize
+      default = class_name.underscore.humanize
 
       return @name if @name.present?
 
-      if translation_key && ::Avo::App.translation_enabled
-        t(translation_key, count: 1, default: default).humanize
+      if translation_key
+        t(translation_key, count: 1, default: default).capitalize
       else
         default
       end
@@ -277,8 +285,8 @@ module Avo
     def plural_name
       default = name.pluralize
 
-      if translation_key && ::Avo::App.translation_enabled
-        t(translation_key, count: 2, default: default).humanize
+      if translation_key
+        t(translation_key, count: 2, default: default).capitalize
       else
         default
       end
@@ -298,20 +306,19 @@ module Avo
       view_types = [:table]
 
       view_types << :grid if get_grid_fields.present?
-      view_types << :map if map_view.present?
 
       view_types
     end
 
-    def attachment_fields
+    def attached_file_fields
       get_field_definitions.select do |field|
         [Avo::Fields::FileField, Avo::Fields::FilesField].include? field.class
       end
     end
 
-    # Map the received params to their actual fields.
-    def fields_by_database_id
-      get_field_definitions
+    def fill_record(record, params, extra_params: [])
+      # Map the received params to their actual fields
+      fields_by_database_id = get_field_definitions
         .reject do |field|
           field.computed
         end
@@ -319,30 +326,28 @@ module Avo
           [field.database_id.to_s, field]
         end
         .to_h
-    end
 
-    def fill_model(model, params, extra_params: [])
       # Write the field values
       params.each do |key, value|
         field = fields_by_database_id[key]
 
         next unless field.present?
 
-        model = field.fill_field model, key, value, params
+        record = field.fill_field record, key, value, params
       end
 
-      # Write the user configured extra params to the model
+      # Write the user configured extra params to the record
       if extra_params.present?
         # Let Rails fill in the rest of the params
-        model.assign_attributes params.permit(extra_params)
+        record.assign_attributes params.permit(extra_params)
       end
 
-      model
+      record
     end
 
     def authorization(user: nil)
-      current_user = user || Avo::App.current_user
-      Avo::Services::AuthorizationService.new(current_user, model || model_class, policy_class: authorization_policy)
+      current_user = user || Avo::Current.current_user
+      Avo::Services::AuthorizationService.new(current_user, record || model_class, policy_class: authorization_policy)
     end
 
     def file_hash
@@ -363,54 +368,57 @@ module Avo
       Digest::MD5.hexdigest(content_to_be_hashed)
     end
 
-    def cache_hash(parent_model)
-      if parent_model.present?
-        [model, file_hash, parent_model]
+    def cache_hash(parent_record)
+      if parent_record.present?
+        [record, file_hash, parent_record]
       else
-        [model, file_hash]
+        [record, file_hash]
       end
     end
 
-    # We will not overwrite any attributes that come pre-filled in the model.
+    # We will not overwrite any attributes that come pre-filled in the record.
     def hydrate_model_with_default_values
       default_values = get_fields
         .select do |field|
           !field.computed
         end
         .map do |field|
+          id = field.id
           value = field.value
 
           if field.type == "belongs_to"
+            id = field.foreign_key.to_sym
 
-            reflection = @model._reflections[@params[:via_relation]]
+            reflection = @record._reflections[@params[:via_relation]]
 
             if field.polymorphic_as.present? && field.types.map(&:to_s).include?(@params[:via_relation_class])
               # set the value to the actual record
-              via_resource = ::Avo::App.get_resource_by_model_name(@params[:via_relation_class])
-              value = via_resource.find_record(@params[:via_resource_id])
+              value = @params[:via_relation_class].safe_constantize.find(@params[:via_record_id])
             elsif reflection.present? && reflection.foreign_key.present? && field.id.to_s == @params[:via_relation].to_s
-              resource = Avo::App.get_resource_by_model_name params[:via_relation_class]
-              model = resource.find_record @params[:via_resource_id], params: params
+              resource = Avo::App.resources.get_resource_by_model_class params[:via_relation_class]
+              record = resource.find_record @params[:via_record_id], params: params
               id_param = reflection.options[:primary_key] || :id
 
-              value = model.send(id_param)
+              value = record.send(id_param)
             end
           end
 
-          [field, value]
+          [id, value]
         end
         .to_h
-        .select do |_, value|
+        .select do |id, value|
           value.present?
         end
 
-      default_values.each do |field, value|
-        field.assign_value record: @model, value: value
+      default_values.each do |id, value|
+        if @record.send(id).nil?
+          @record.send("#{id}=", value)
+        end
       end
     end
 
     def route_key
-      class_name_without_resource.underscore.pluralize
+      class_name.underscore.pluralize
     end
 
     def singular_route_key
@@ -434,7 +442,7 @@ module Avo
     end
 
     def record_path
-      resource_path(model: model, resource: self)
+      resource_path(record: record, resource: self)
     end
 
     def records_path
@@ -450,7 +458,7 @@ module Avo
     end
 
     def label
-      label_field&.value || model_title
+      label_field&.value || record_title
     end
 
     def avatar_field
@@ -493,12 +501,8 @@ module Avo
       model_class.base_class.to_s.underscore.downcase
     end
 
-    def ordering_host(**args)
-      Avo::Hosts::Ordering.new resource: self, options: self.class.ordering, **args
-    end
-
-    def has_model_id?
-      model.present? && model.id.present?
+    def has_record_id?
+      record.present? && record_id.present?
     end
 
     def find_record(id, query: nil, params: nil)
@@ -506,5 +510,13 @@ module Avo
 
       self.class.find_record_method.call(model_class: query, id: id, params: params)
     end
+
+    def id_attribute
+      :id
+    end
+
+    def record_id
+      record.send(id_attribute)
+    end
   end
 end

data/lib/avo/base_resource_tool.rb

@@ -1,36 +1,29 @@
 module Avo
   class BaseResourceTool
-    include Avo::Concerns::IsResourceItem
-    include Avo::Fields::FieldExtensions::VisibleInDifferentViews
+    prepend Avo::Concerns::IsResourceItem
+
+    include Avo::Concerns::HasItemType
+    include Avo::Concerns::IsVisible
+    include Avo::Concerns::VisibleInDifferentViews
 
     class_attribute :name
     class_attribute :partial
-    class_attribute :item_type, default: :tool
 
     attr_accessor :params
-    attr_accessor :resource
-    attr_accessor :view
 
     def initialize(**args)
       # Set the visibility
-      show_on Avo.configuration.resource_default_view
-
-      show_on args[:show_on] if args[:show_on].present?
-      hide_on args[:hide_on] if args[:hide_on].present?
-      only_on args[:only_on] if args[:only_on].present?
-      except_on args[:except_on] if args[:except_on].present?
-    end
+      only_on Avo.configuration.resource_default_view
 
-    def hydrate(view: nil)
-      @view = view if view.present?
+      @args = args
 
-      self
+      post_initialize if respond_to?(:post_initialize)
     end
 
     def partial
       return self.class.partial if self.class.partial.present?
 
-      "avo/resource_tools/#{self.class.to_s.underscore}"
+      self.class.to_s.underscore
     end
   end
 end

data/lib/avo/concerns/{can_replace_fields.rb → can_replace_items.rb}

@@ -1,6 +1,6 @@
 module Avo
   module Concerns
-    module CanReplaceFields
+    module CanReplaceItems
       extend ActiveSupport::Concern
 
       included do
@@ -12,7 +12,7 @@ module Avo
           # back-up the previous items
           self.backup_items_holder = items_holder
 
-          self.items_holder = Avo::ItemsHolder.new
+          self.items_holder = Avo::Resources::Items::Holder.new
 
           instance_eval(&block)
         end
@@ -22,7 +22,7 @@ module Avo
         end
 
         def with_new_items(&block)
-          self.items_holder = Avo::ItemsHolder.new
+          self.items_holder = Avo::Resources::Items::Holder.new
 
           instance_eval(&block)
         end

data/lib/avo/concerns/filters_session_handler.rb

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

data/lib/avo/concerns/has_controls.rb

@@ -0,0 +1,37 @@
+module Avo
+  module Concerns
+    module HasControls
+      extend ActiveSupport::Concern
+      include Avo::Resources::Controls
+
+      included do
+        class_attribute :show_controls
+        class_attribute :edit_controls
+        class_attribute :index_controls
+        class_attribute :row_controls
+      end
+
+      def render_show_controls
+        [BackButton.new, DeleteButton.new, DetachButton.new, ActionsList.new, EditButton.new]
+      end
+
+      def render_edit_controls
+        [BackButton.new(label: I18n.t("avo.cancel").capitalize), DeleteButton.new, ActionsList.new, SaveButton.new]
+      end
+
+      def render_index_controls(item:)
+        [AttachButton.new(item: item), ActionsList.new(as_index_control: true), CreateButton.new(item: item)]
+      end
+
+      def render_row_controls(item:)
+        [
+          OrderControls.new,
+          ShowButton.new(item: item),
+          EditButton.new(item: item),
+          DetachButton.new(item: item),
+          DeleteButton.new(item: item)
+        ]
+      end
+    end
+  end
+end

data/lib/avo/concerns/has_item_type.rb

@@ -0,0 +1,38 @@
+# This concern helps us figure out what kind of items (field, tool, tab_group, or panel) have been passed to the resource or action.
+module Avo
+  module Concerns
+    module HasItemType
+      def is_field?
+        self.class.ancestors.include?(Avo::Fields::BaseField)
+      end
+
+      def is_heading?
+        self.class.ancestors.include?(Avo::Fields::HeadingField)
+      end
+
+      def is_panel?
+        self.class.ancestors.include?(Avo::Resources::Items::Panel)
+      end
+
+      def is_main_panel?
+        self.class.ancestors.include?(Avo::Resources::Items::MainPanel)
+      end
+
+      def is_tool?
+        self.class.ancestors.include?(Avo::BaseResourceTool)
+      end
+
+      def is_tab?
+        self.class.ancestors.include?(Avo::Resources::Items::Tab)
+      end
+
+      def is_tab_group?
+        self.class.ancestors.include?(Avo::Resources::Items::TabGroup)
+      end
+
+      def is_sidebar?
+        self.class.ancestors.include?(Avo::Resources::Items::Sidebar)
+      end
+    end
+  end
+end