avo 2.46.0 → 3.0.2

data/lib/avo/fields/base_field.rb

@@ -2,21 +2,26 @@ module Avo
   module Fields
     class BaseField
       extend ActiveSupport::DescendantsTracker
-      extend Avo::Fields::FieldExtensions::HasFieldName
 
-      include Avo::Concerns::IsResourceItem
-      include Avo::Concerns::HandlesFieldArgs
-
-      include ActionView::Helpers::UrlHelper
-      include Avo::Fields::FieldExtensions::VisibleInDifferentViews
-
-      include Avo::Concerns::HasHTMLAttributes
-      include Avo::Fields::Concerns::IsRequired
+      prepend Avo::Concerns::HasItemType
+      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
+      include Avo::Fields::Concerns::HandlesFieldArgs
       include Avo::Fields::Concerns::IsReadonly
       include Avo::Fields::Concerns::IsDisabled
-      include Avo::Fields::Concerns::HasDefault
+      include Avo::Fields::Concerns::IsRequired
+      include Avo::Fields::Concerns::UseViewComponents
 
-      delegate :view_context, to: ::Avo::App
+      include ActionView::Helpers::UrlHelper
+
+      delegate :app, to: ::Avo::Current
+      delegate :view_context, to: :app
+      delegate :context, to: :app
       delegate :simple_format, :content_tag, to: :view_context
       delegate :main_app, to: :view_context
       delegate :avo, to: :view_context
@@ -33,12 +38,9 @@ module Avo
       attr_reader :autocomplete
       attr_reader :help
       attr_reader :default
-      attr_reader :visible
-      attr_reader :as_label
       attr_reader :as_avatar
-      attr_reader :as_description
-      attr_reader :index_text_align
       attr_reader :stacked
+      attr_reader :for_presentation_only
 
       # Private options
       attr_reader :computable # if allowed to be computable
@@ -46,19 +48,14 @@ module Avo
       attr_reader :computed_value # the value after computation
 
       # Hydrated payload
-      attr_reader :model
-      attr_reader :view
-      attr_reader :resource
-      attr_reader :action
-      attr_reader :user
-      attr_reader :panel_name
+      attr_accessor :record
+      attr_accessor :action
+      attr_accessor :user
+      attr_accessor :panel_name
 
       class_attribute :field_name_attribute
-      class_attribute :item_type, default: :field
 
       def initialize(id, **args, &block)
-        super(id, **args, &block)
-
         @id = id
         @name = args[:name]
         @translation_key = args[:translation_key]
@@ -76,16 +73,14 @@ 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
-        @index_text_align = args[:index_text_align] || :left
         @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]
-        @action = args[:action]
+        @components = args[:components] || {}
 
         @args = args
 
@@ -93,34 +88,19 @@ module Avo
         @computed = block.present?
         @computed_value = nil
 
-        # Set the visibility
-        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?
+        post_initialize if respond_to?(:post_initialize)
       end
 
-      def hydrate(**kwargs)
-        # List of permitted keyword argument keys as symbols
-        permited_kwargs_keys = %i[model resource action view panel_name user]
-
-        # Check for unrecognized keys
-        unrecognized_keys = kwargs.keys - permited_kwargs_keys
-        raise ArgumentError, "Unrecognized argument(s): #{unrecognized_keys.join(', ')}" if unrecognized_keys.any?
-
-        # Set instance variables with provided values
-        kwargs.each do |key, value|
-          instance_variable_set("@#{key}", value)
-        end
-
-        # Return self for method chaining, if desired
-        self
+      def translation_key
+        @translation_key || "avo.field_translations.#{@id}"
       end
 
-      def translation_key
-        return @translation_key if @translation_key.present?
+      def translated_name(default:)
+        t(translation_key, count: 1, default: default).humanize
+      end
 
-        "avo.field_translations.#{@id}"
+      def translated_plural_name(default:)
+        t(translation_key, count: 2, default: default).humanize
       end
 
       # Getting the name of the resource (user/users, post/posts)
@@ -130,8 +110,8 @@ module Avo
       def name
         return @name if custom_name?
 
-        if translation_key && ::Avo::App.translation_enabled
-          t(translation_key, count: 1, default: default_name).humanize
+        if translation_key
+          translated_name default: default_name
         else
           default_name
         end
@@ -140,15 +120,19 @@ 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
+          translated_plural_name default: default
         else
           default
         end
       end
 
+      def table_header_label
+        name
+      end
+
       def custom_name?
-        @name.present?
+        !@name.nil?
       end
 
       def default_name
@@ -156,21 +140,7 @@ module Avo
       end
 
       def placeholder
-        if @placeholder.respond_to?(:call)
-          return Avo::Hosts::ResourceViewRecordHost.new(block: @placeholder, record: @model, resource: @resource, view: @view).handle
-        end
-
-        @placeholder || name
-      end
-
-      def visible?
-        return true if visible.nil?
-
-        if visible.respond_to?(:call)
-          visible.call resource: @resource
-        else
-          visible
-        end
+        Avo::ExecutionContext.new(target: @placeholder || name, record: record, resource: @resource, view: @view).handle
       end
 
       def value(property = nil)
@@ -178,8 +148,8 @@ module Avo
 
         property ||= id
 
-        # Get model value
-        final_value = @model.send(property) if is_model?(@model) && @model.respond_to?(property)
+        # Get record value
+        final_value = record.send(property) if is_model?(record) && record.respond_to?(property)
 
         # On new views and actions modals we need to prefill the fields with the default value
         if should_fill_with_default_value? && default.present?
@@ -188,52 +158,57 @@ module Avo
 
         # Run computable callback block if present
         if computable && block.present?
-          final_value = instance_exec(@model, @resource, @view, self, &block)
+          final_value = execute_block
         end
 
-        if @format_using.present?
-          # Apply the changes in the
-          Avo::ExecutionContext.new(
-            target: @format_using,
-            model: model,
-            key: property,
+        # Run the value through resolver if present
+        if format_using.present?
+          final_value = Avo::ExecutionContext.new(
+            target: format_using,
             value: final_value,
+            record: record,
             resource: resource,
             view: view,
             field: self,
-            delegate_missing_to: :view_context,
             include: self.class.included_modules
           ).handle
-        else
-          final_value
         end
-      end
-
-      # Fills the model with the received value on create and update actions.
-      def fill_field(model, key, value, params)
-        return model unless model.methods.include? key.to_sym
-
-        if @update_using.present?
-          value = update_using(model, key, value, params)
-        end
-
-        model.public_send("#{key}=", value)
 
-        model
+        final_value
       end
 
-      def update_using(model, key, value, params)
+      def execute_block
         Avo::ExecutionContext.new(
-          target: @update_using,
-          model: model,
-          key: key,
-          value: value,
+          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
+
+        if @update_using.present?
+          value = Avo::ExecutionContext.new(
+            target: @update_using,
+            record: record,
+            key: key,
+            value: value,
+            resource: resource,
+            field: self,
+            include: self.class.included_modules
+          ).handle
+        end
+
+        record.public_send("#{key}=", value)
+
+        record
+      end
+
       # Try to see if the field has a different database ID than it's name
       def database_id
         foreign_key
@@ -253,25 +228,8 @@ module Avo
         id.to_sym
       end
 
-      def view_component_name
-        "#{type.camelize}Field"
-      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 = "::Avo::Fields::#{view_component_name}::#{view.to_s.camelize}Component"
-        component_class.constantize
-      rescue
-        # 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 model_errors
-        model.nil? ? {} : model.errors
+      def record_errors
+        record.nil? ? {} : record.errors
       end
 
       def type
@@ -292,8 +250,12 @@ module Avo
         !visible_in_reflection?
       end
 
+      def options_for_filter
+        options
+      end
+
       def updatable
-        !is_readonly? && visible?
+        !is_disabled? && visible?
       end
 
       # Used by Avo to fill the record with the default value on :new and :edit views
@@ -320,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

@@ -57,6 +57,7 @@ module Avo
     # - is_disabled?
 
     class BelongsToField < BaseField
+      include Avo::Fields::Concerns::IsSearchable
       include Avo::Fields::Concerns::UseResource
 
       attr_accessor :target
@@ -84,10 +85,6 @@ module Avo
         @use_resource = args[:use_resource] || nil
       end
 
-      def searchable
-        @searchable && ::Avo::App.license.has_with_trial(:searchable_associations)
-      end
-
       def value
         if is_polymorphic?
           # Get the value from the pre-filled assoociation record
@@ -107,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
@@ -118,16 +113,16 @@ module Avo
 
       def values_for_type(model = nil)
         resource = target_resource
-        resource = App.get_resource_by_model_name model if model.present?
+        resource = Avo.resource_manager.get_resource_by_model_class model if model.present?
 
-        query = resource.class.query_scope
+        query = resource.query_scope
 
         if attach_scope.present?
-          query = Avo::Hosts::AssociationScopeHost.new(block: attach_scope, query: query, parent: get_model).handle
+          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.new(record: record).record_title, record.id]
         end
       end
 
@@ -160,8 +155,8 @@ module Avo
       def foreign_key
         return polymorphic_as if polymorphic_as.present?
 
-        if @model.present?
-          get_model_class(@model).reflections[@relation_method].foreign_key
+        if @record.present?
+          get_model_class(@record).reflections[@relation_method].foreign_key
         elsif @resource.present? && @resource.model_class.reflections[@relation_method].present?
           @resource.model_class.reflections[@relation_method].foreign_key
         end
@@ -185,7 +180,8 @@ module Avo
       end
 
       def label
-        value.send(target_resource.class.title)
+        return if target_resource.blank?
+        target_resource.new(record: value)&.record_title
       end
 
       def to_permitted_param
@@ -237,7 +233,7 @@ module Avo
 
         if is_polymorphic?
           if value.present?
-            return App.get_resource_by_model_name(value.class)
+            return Avo.resource_manager.get_resource_by_model_class(value.class)
           else
             return nil
           end
@@ -245,25 +241,25 @@ module Avo
 
         reflection_key = polymorphic_as || id
 
-        if @model._reflections[reflection_key.to_s].klass.present?
-          App.get_resource_by_model_name @model._reflections[reflection_key.to_s].klass.to_s
-        elsif @model._reflections[reflection_key.to_s].options[:class_name].present?
-          App.get_resource_by_model_name @model._reflections[reflection_key.to_s].options[:class_name]
+        if @record._reflections[reflection_key.to_s].klass.present?
+          Avo.resource_manager.get_resource_by_model_class @record._reflections[reflection_key.to_s].klass.to_s
+        elsif @record._reflections[reflection_key.to_s].options[:class_name].present?
+          Avo.resource_manager.get_resource_by_model_class @record._reflections[reflection_key.to_s].options[:class_name]
         else
           App.get_resource_by_name reflection_key.to_s
         end
       end
 
       def get_model
-        return @model if @model.present?
+        return @record if @record.present?
 
-        @resource.model
+        @resource.record
       rescue
         nil
       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/file_authorization.rb

@@ -6,7 +6,7 @@ module Avo
 
         delegate :authorization, to: :@resource
         delegate :authorize_action, to: :authorization
-        delegate :id, :model, to: :@field
+        delegate :id, :record, to: :@field
 
         def can_upload_file?
           authorize_file_action(:upload)
@@ -23,7 +23,7 @@ module Avo
         private
 
         def authorize_file_action(action)
-          authorize_action("#{action}_#{id}?", record: model, raise_exception: false)
+          authorize_action("#{action}_#{id}?", record: record, raise_exception: false)
         end
       end
     end

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

@@ -0,0 +1,49 @@
+module Avo
+  module Fields
+    module Concerns
+      module HandlesFieldArgs
+        extend ActiveSupport::Concern
+
+        private
+
+        # Add an instance variable from args
+        # That may be a string, boolean, or array
+        # Each args should also have a default value
+        def add_prop_from_args(args = {}, name: nil, type: :string, default: nil)
+          value = default
+
+          if type == :boolean
+            case args[name.to_sym]
+            when nil
+              value = default
+            when false
+              value = false
+            when true
+              value = true
+            end
+          else
+            value = args[name.to_sym] unless args.dig(name.to_sym).nil?
+          end
+
+          instance_variable_set(:"@#{name}", value)
+        end
+
+        def add_boolean_prop(args, name, default = false)
+          add_prop_from_args args, name: name, default: default, type: :boolean
+        end
+
+        def add_array_prop(args, name, default = [])
+          add_prop_from_args args, name: name, default: default, type: :array
+        end
+
+        def add_object_prop(args, name, default = {})
+          add_prop_from_args args, name: name, default: default, type: :object
+        end
+
+        def add_string_prop(args, name, default = nil)
+          add_prop_from_args args, name: name, default: default, type: :string
+        end
+      end
+    end
+  end
+end

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

@@ -5,11 +5,7 @@ module Avo
         extend ActiveSupport::Concern
 
         def computed_default_value
-          if default.respond_to? :call
-            Avo::Hosts::ResourceViewRecordHost.new(block: default, record: model, view: view, resource: resource).handle
-          else
-            default
-          end
+          Avo::ExecutionContext.new(target: default, record: record, view: view, resource: resource).handle
         end
       end
     end

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

@@ -0,0 +1,22 @@
+module Avo
+  module Fields
+    module Concerns
+      module HasFieldName
+        extend ActiveSupport::Concern
+
+        class_methods do
+          def field_name(name)
+            self.field_name_attribute = name
+          end
+
+          # Get the field name
+          def get_field_name
+            return field_name_attribute if field_name_attribute.present?
+
+            to_s.demodulize.underscore.gsub "_field", ""
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,112 @@
+module Avo
+  module Fields
+    module Concerns
+      module HasHTMLAttributes
+        extend ActiveSupport::Concern
+
+        attr_reader :html
+
+        # Used to get attributes for elements and views
+        #
+        # examples:
+        # get_html :data, view: :edit, element: :input
+        # 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
+
+          parsed = parse_html
+
+          attributes = if parsed.is_a? Hash
+            get_html_from_hash name, element: element, hash: parsed, view: view
+          elsif parsed.is_a? Avo::HTML::Builder
+            get_html_from_block name, element: element, html_builder: parsed, view: view
+          elsif parsed.nil?
+            # Handle empty parsed by returning an empty state
+            default_attribute_value name
+          end
+
+          add_default_data_attributes attributes, name, element, view
+        end
+
+        private
+
+        # Returns Hash, HTML::Builder, or nil.
+        def parse_html
+          return if @html.nil?
+
+          if @html.is_a? Hash
+            @html
+          elsif @html.respond_to? :call
+            Avo::HTML::Builder.parse_block(record: record, resource: resource, &@html)
+          end
+        end
+
+        def default_attribute_value(name)
+          name == :data ? {} : ""
+        end
+
+        def add_default_data_attributes(attributes, name, element, view)
+          if !attributes.nil? && name == :data && element == :input && view.in?([:edit, :new]) && resource.present? && resource.respond_to?(:get_stimulus_controllers)
+            extra_attributes = resource.get_stimulus_controllers
+              .split(" ")
+              .map do |controller|
+                [:"#{controller}-target", "#{id.to_s.underscore}_#{type.to_s.underscore}_input".camelize(:lower)]
+              end
+              .to_h
+
+            attributes.merge extra_attributes
+          else
+            attributes
+          end
+        end
+
+        def get_html_from_block(name = nil, element:, html_builder:, view:)
+          values = []
+
+          # get view ancestor
+          values << html_builder.dig_stack(view, element, name)
+          # get element ancestor
+          values << html_builder.dig_stack(element, name)
+          # get direct ancestor
+          values << html_builder.dig_stack(name)
+
+          values_type = if name == :data
+            :hash
+          else
+            :string
+          end
+
+          merge_values_as(as: values_type, values: values)
+        end
+
+        def get_html_from_hash(name = nil, element:, hash:, view:)
+          # @todo: what if this is not a Hash but a string?
+          hash.dig(view, element, name) || {}
+        end
+
+        # Merge the values from all possible locations.
+        # If the result is "blank", return nil so the attributes are not outputted to the DOM.
+        #
+        # Ex: if the style attribute is empty return `nil` instead of an empty space `" "`
+        def merge_values_as(as: :array, values: [])
+          result = if as == :array
+            values.flatten
+          elsif as == :string
+            values.select do |value|
+              value.is_a? String
+            end.join " "
+          elsif as == :hash
+            values.reduce({}, :merge)
+          end
+
+          result if result.present?
+        end
+      end
+    end
+  end
+end

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

@@ -7,11 +7,7 @@ module Avo
         attr_reader :disabled
 
         def is_disabled?
-          if disabled.respond_to? :call
-            Avo::Hosts::ResourceViewRecordHost.new(block: disabled, record: model, view: view, resource: resource).handle
-          else
-            disabled
-          end
+          Avo::ExecutionContext.new(target: disabled, record: record, view: view, resource: resource).handle
         end
       end
     end