avo 2.7.0 → 2.9.0

data/lib/avo/concerns/fetches_things.rb

@@ -22,6 +22,13 @@ module Avo
           end
         end
 
+        # Filters out the resources that are missing the model_class
+        def valid_resources
+          resources.select do |resource|
+            resource.model_class.present?
+          end
+        end
+
         # Returns the Avo resource by camelized name
         #
         # get_resource_by_name('User') => UserResource
@@ -45,9 +52,10 @@ module Avo
         # get_resource_by_name('User') => UserResource
         # get_resource_by_name(User) => UserResource
         def get_resource_by_model_name(name)
-          resources.find do |resource|
-            resource.model_class.model_name.name == name.to_s
-          end
+          valid_resources
+            .find do |resource|
+              resource.model_class.model_name.name == name.to_s
+            end
         end
 
         # Returns the Avo resource by singular snake_cased name
@@ -55,9 +63,10 @@ module Avo
         # get_resource_by_controller_name('delayed_backend_active_record_jobs') => DelayedJobResource
         # get_resource_by_controller_name('users') => UserResource
         def get_resource_by_controller_name(name)
-          resources.find do |resource|
-            resource.model_class.to_s.pluralize.underscore.tr("/", "_") == name.to_s
-          end
+          valid_resources
+            .find do |resource|
+              resource.model_class.to_s.pluralize.underscore.tr("/", "_") == name.to_s
+            end
         end
 
         # Returns the Avo resource by some name
@@ -73,9 +82,10 @@ module Avo
         end
 
         def get_available_resources(user = nil)
-          resources.select do |resource|
-            Services::AuthorizationService.authorize user, resource.model_class, Avo.configuration.authorization_methods.stringify_keys["index"], raise_exception: false
-          end
+          valid_resources
+            .select do |resource|
+              Services::AuthorizationService.authorize user, resource.model_class, Avo.configuration.authorization_methods.stringify_keys["index"], raise_exception: false
+            end
             .sort_by { |r| r.name }
         end
 
@@ -85,9 +95,6 @@ module Avo
 
         def resources_for_navigation(user = nil)
           get_available_resources(current_user)
-            .select do |resource|
-              resource.model_class.present?
-            end
             .select do |resource|
               resource.visible_on_sidebar
             end

data/lib/avo/concerns/has_fields.rb

@@ -0,0 +1,93 @@
+module Avo
+  module Concerns
+    module HasFields
+      extend ActiveSupport::Concern
+
+      included do
+        class_attribute :fields
+        class_attribute :fields_index, default: 0
+      end
+
+      class_methods do
+        def field(field_name, as:, **args, &block)
+          self.invalid_fields ||= []
+
+          field_instance = parse_field(field_name, as: as, order_index: fields_index, **args, &block)
+
+          if field_instance.present?
+            add_to_fields field_instance
+          else
+            self.invalid_fields << ({
+              name: field_name,
+              as: as,
+              resource: name,
+              message: "There's an invalid field configuration for this resource. <br/> <code class='px-1 py-px rounded bg-red-600'>field :#{field_name}, as: #{as}</code>"
+            })
+          end
+        end
+
+        def parse_field(field_name, as:, **args, &block)
+          # The field is passed as a symbol eg: :text, :color_picker, :trix
+          if as.is_a? Symbol
+            parse_symbol field_name, as: as, **args, &block
+          elsif as.is_a? Class
+            parse_class field_name, as: as, **args, &block
+          end
+        end
+
+        def heading(body, **args)
+          add_to_fields Avo::Fields::HeadingField.new(body, order_index: fields_index, **args)
+        end
+
+        private
+
+        def add_to_fields(instance)
+          self.fields ||= []
+          self.fields << instance
+          self.fields_index += 1
+        end
+
+        def instantiate_field(field_name, klass:, **args, &block)
+          if block
+            klass.new(field_name, **args || {}, &block)
+          else
+            klass.new(field_name, **args || {})
+          end
+        end
+
+        def field_class_from_symbol(symbol)
+          matched_field = Avo::App.fields.find do |field|
+            field[:name].to_s == symbol.to_s
+          end
+
+          return matched_field[:class] if matched_field.present? && matched_field[:class].present?
+        end
+
+        def parse_symbol(field_name, as:, **args, &block)
+          field_class = field_class_from_symbol(as)
+
+          if field_class.present?
+            # The field has been registered before.
+            instantiate_field(field_name, klass: field_class, **args, &block)
+          else
+            # The symbol can be transformed to a class and found.
+            class_name = as.to_s.camelize
+            field_class = "#{class_name}Field"
+
+            # Discover & load custom field classes
+            if Object.const_defined? field_class
+              instantiate_field(field_name, klass: field_class.safe_constantize, **args, &block)
+            end
+          end
+        end
+
+        def parse_class(field_name, as:, **args, &block)
+          # The field has been passed as a class.
+          if Object.const_defined? as.to_s
+            instantiate_field(field_name, klass: as, **args, &block)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/avo/concerns/has_html_attributes.rb

@@ -0,0 +1,110 @@
+module Avo
+  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:)
+        if [view, element].any?(&:nil?) || Avo::App.license.lacks_with_trial(:stimulus_js_integration)
+          default_attribute_value name
+        end
+
+        attributes = if html_builder.is_a? Hash
+          get_html_from_hash name, element: element, view: view
+        elsif html_builder.is_a? Avo::HTML::Builder
+          get_html_from_block name, element: element, view: view
+        elsif html_builder.nil?
+          # Handle empty html_builder by returning an empty state
+          default_attribute_value name
+        end
+
+        add_default_data_attributes attributes, name, element, view
+      end
+
+      private
+
+      def html_builder
+        return @parsed_html if @parsed_html.present?
+
+        return if @html.nil?
+
+        # Memoize the value
+        @parsed_html = if @html.is_a? Hash
+          @html
+        elsif @html.respond_to? :call
+          Avo::HTML::Builder.parse_block(record: model, resource: resource, &@html)
+        end
+
+        @parsed_html
+      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?
+          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
+
+          extra_attributes.merge attributes
+        else
+          attributes
+        end
+      end
+
+      def get_html_from_block(name = nil, element:, 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:, view:)
+        # @todo: what if this is not a Hash but a string?
+        html_builder.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

data/lib/avo/concerns/has_model.rb

@@ -0,0 +1,11 @@
+module Avo
+  module Concerns
+    module HasModel
+      extend ActiveSupport::Concern
+
+      def has_model_id?
+        model.present? && model.id.present?
+      end
+    end
+  end
+end

data/lib/avo/concerns/has_stimulus_controllers.rb

@@ -0,0 +1,42 @@
+module Avo
+  module Concerns
+    module HasStimulusControllers
+      extend ActiveSupport::Concern
+
+      included do
+        class_attribute :stimulus_controllers, default: ""
+      end
+
+      def get_stimulus_controllers
+        return "" if view.nil?
+
+        controllers = []
+
+        case view.to_sym
+        when :show
+          controllers << "resource-show"
+        when :new, :edit
+          controllers << "resource-edit"
+        when :index
+          controllers << "resource-index"
+        end
+
+        controllers << self.class.stimulus_controllers
+
+        controllers.join " "
+      end
+
+      def stimulus_data_attributes
+        attributes = {
+          controller: get_stimulus_controllers,
+        }
+
+        get_stimulus_controllers.split(" ").each do |controller|
+          attributes["#{controller}-view-value"] = view
+        end
+
+        attributes
+      end
+    end
+  end
+end

data/lib/avo/dynamic_router.rb

@@ -14,7 +14,7 @@ module Avo
         #   resource.model_class.present?
         # end
         .map do |resource|
-          router.resources resource.new.model_key
+          router.resources resource.new.route_key
         end
     end
   end

data/lib/avo/engine.rb

@@ -17,8 +17,6 @@ module Avo
       ::Avo::App.boot
     end
 
-    config.i18n.load_path += Dir[Avo::Engine.root.join("lib", "generators", "avo", "templates", "locales", "*.{rb,yml}")]
-
     initializer "avo.autoload" do |app|
       [
         ["app", "avo", "fields"],
@@ -73,7 +71,7 @@ module Avo
         begin
           Licensing::HQ.new.clear_response
         rescue => exception
-          puts "Failed to clear Avo HQ response: #{e.message}"
+          puts "Failed to clear Avo HQ response: #{exception.message}"
         end
       end
     end

data/lib/avo/fields/base_field.rb

@@ -5,10 +5,14 @@ module Avo
       extend Avo::Fields::FieldExtensions::HasFieldName
 
       include Avo::Fields::FieldExtensions::VisibleInDifferentViews
-      include Avo::Concerns::HandlesFieldArgs
       include ActionView::Helpers::UrlHelper
 
-      delegate :view_context, to: "Avo::App"
+      include Avo::Concerns::HandlesFieldArgs
+      include Avo::Concerns::HasHTMLAttributes
+      include Avo::Fields::Concerns::IsRequired
+
+      delegate :view_context, to: ::Avo::App
+      delegate :simple_format, :content_tag, to: :view_context
       delegate :main_app, to: :view_context
       delegate :avo, to: :view_context
       delegate :t, to: ::I18n
@@ -51,7 +55,6 @@ module Avo
         @id = id
         @name = args[:name]
         @translation_key = args[:translation_key]
-        @translation_enabled = ::Avo::App.translation_enabled
         @block = block
         @required = args[:required] || false
         @readonly = args[:readonly] || false
@@ -67,6 +70,7 @@ module Avo
         @as_avatar = args[:as_avatar] || false
         @as_description = args[:as_description] || false
         @index_text_align = args[:index_text_align] || :left
+        @html = args[:html] || nil
 
         @updatable = true
         @computable = true
@@ -80,22 +84,21 @@ module Avo
         except_on args[:except_on] if args[:except_on].present?
       end
 
-      def hydrate(model: nil, resource: nil, action: nil, view: nil, panel_name: nil, user: nil, translation_enabled: nil)
+      def hydrate(model: nil, resource: nil, action: nil, view: nil, panel_name: nil, user: nil)
         @model = model if model.present?
         @view = view if view.present?
         @resource = resource if resource.present?
         @action = action if action.present?
         @user = user if user.present?
         @panel_name = panel_name if panel_name.present?
-        @translation_enabled = translation_enabled if translation_enabled.present?
 
         self
       end
 
       def translation_key
-        return "avo.field_translations.#{@id}" if @translation_enabled
+        return @translation_key if @translation_key.present?
 
-        @translation_key
+        "avo.field_translations.#{@id}"
       end
 
       # Getting the name of the resource (user/users, post/posts)
@@ -105,19 +108,27 @@ module Avo
       def name
         default = @id.to_s.humanize(keep_id_suffix: true)
 
-        return @name if @name.present?
+        return @name if custom_name?
 
-        return t(translation_key, count: 1, default: default).capitalize if translation_key
-
-        default
+        if translation_key && ::Avo::App.translation_enabled
+          t(translation_key, count: 1, default: default).capitalize
+        else
+          default
+        end
       end
 
       def plural_name
         default = name.pluralize
 
-        return t(translation_key, count: 2, default: default).capitalize if translation_key
+        if translation_key && ::Avo::App.translation_enabled
+          t(translation_key, count: 2, default: default).capitalize
+        else
+          default
+        end
+      end
 
-        default
+      def custom_name?
+        @name.present?
       end
 
       def placeholder

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

@@ -0,0 +1,17 @@
+module Avo
+  module Fields
+    module Concerns
+      module IsRequired
+        extend ActiveSupport::Concern
+
+        def is_required?
+          if required.respond_to? :call
+            Avo::Hosts::ViewRecordHost.new(block: required, record: model, view: view).handle
+          else
+            required
+          end
+        end
+      end
+    end
+  end
+end

data/lib/avo/fields/select_field.rb

@@ -10,7 +10,7 @@ module Avo
 
         super(id, **args, &block)
 
-        @options = args[:options].present? ? args[:options] : args[:enum]
+        @options = args[:options] || args[:enum]
         @options = ActiveSupport::HashWithIndifferentAccess.new @options if @options.is_a? Hash
         @enum = args[:enum].present? ? args[:enum] : nil
         @display_value = args[:display_value].present? ? args[:display_value] : false

data/lib/avo/grid_collector.rb

@@ -1,6 +1,6 @@
 module Avo
   class GridCollector
-    include FieldsCollector
+    include Avo::Concerns::HasFields
 
     attr_accessor :cover_field
     attr_accessor :title_field
@@ -13,15 +13,15 @@ module Avo
     end
 
     def cover(field_name, as:, **args, &block)
-      self.cover_field = parse_field(field_name, as: as, **args, &block)
+      self.cover_field = self.class.parse_field(field_name, as: as, **args, &block)
     end
 
     def title(field_name, as:, **args, &block)
-      self.title_field = parse_field(field_name, as: as, **args, &block)
+      self.title_field = self.class.parse_field(field_name, as: as, **args, &block)
     end
 
     def body(field_name, as:, **args, &block)
-      self.body_field = parse_field(field_name, as: as, **args, &block)
+      self.body_field = self.class.parse_field(field_name, as: as, **args, &block)
     end
 
     def hydrate(model:, view:, resource:)

data/lib/avo/hosts/view_record_host.rb

@@ -0,0 +1,7 @@
+module Avo
+  module Hosts
+    class ViewRecordHost < RecordHost
+      option :view
+    end
+  end
+end

data/lib/avo/html/builder.rb

@@ -0,0 +1,117 @@
+class Avo::HTML::Builder
+  class << self
+    def parse_block(record: nil, resource: nil, &block)
+      Docile.dsl_eval(Avo::HTML::Builder.new(record: record, resource: resource), &block).build
+    end
+  end
+
+  attr_accessor :wrapper_stack
+  attr_accessor :data_stack
+  attr_accessor :style_stack
+  attr_accessor :classes_stack
+  attr_accessor :show_stack
+  attr_accessor :edit_stack
+  attr_accessor :index_stack
+  attr_accessor :input_stack
+
+  attr_accessor :record
+  attr_accessor :resource
+
+  delegate :root_path, to: Avo::App
+  delegate :params, to: Avo::App
+  delegate :current_user, to: Avo::App
+
+  def initialize(record: nil, resource: nil)
+    @wrapper_stack = {}
+    @data_stack = {}
+    @style_stack = ""
+    @classes_stack = ""
+    @show_stack = {}
+    @edit_stack = {}
+    @index_stack = {}
+    @input_stack = {}
+
+    @record = record
+    @resource = resource
+  end
+
+  def get_stack(name = nil)
+    # We don't have an edit component for new so we should use edit
+    name = :edit if name == :new
+
+    send "#{name}_stack"
+  end
+
+  def dig_stack(*names)
+    value = get_stack names.shift
+
+    if value.is_a? self.class
+      value.dig_stack(*names)
+    else
+      value
+    end
+  end
+
+  # payload or block
+  def data(payload = nil, &block)
+    assign_property :data, payload, &block
+  end
+
+  # payload or block
+  def style(payload = nil, &block)
+    assign_property :style, payload, &block
+  end
+
+  # payload or block
+  def classes(payload = nil, &block)
+    assign_property :classes, payload, &block
+  end
+
+  # Takes a block
+  def wrapper(&block)
+    capture_block :wrapper, &block
+  end
+
+  # Takes a block
+  def input(&block)
+    capture_block :input, &block
+  end
+
+  # Takes a block
+  def show(&block)
+    capture_block :show, &block
+  end
+
+  # Takes a block
+  def edit(&block)
+    capture_block :edit, &block
+  end
+
+  # Takes a block
+  def index(&block)
+    capture_block :index, &block
+  end
+
+  # Fetch the menu
+  def build
+    self
+  end
+
+  protected
+
+  # Capture and parse the blocks for the nested structure
+  def capture_block(property = nil, &block)
+    send("#{property}_stack=", self.class.parse_block(record: record, resource: resource, &block).build)
+  end
+
+  # Parse the properties and assign them to the blocks
+  def assign_property(property = :data, payload = nil, &block)
+    value = if block.present?
+      Avo::Hosts::RecordHost.new(block: block, record: record).handle
+    else
+      payload
+    end
+
+    send("#{property}_stack=", value)
+  end
+end

data/lib/avo/licensing/pro_license.rb

@@ -14,6 +14,7 @@ module Avo
           :resource_ordering,
           :dashboards,
           :menu_editor,
+          :stimulus_js_integration,
           :advanced_fields
         ]
       end

data/lib/avo/menu/base_item.rb

@@ -17,4 +17,8 @@ class Avo::Menu::BaseItem
       Avo::Hosts::BaseHost.new(block: visible).handle
     end
   end
+
+  def navigation_label
+    label || entity_label
+  end
 end

data/lib/avo/menu/dashboard.rb

@@ -2,6 +2,7 @@ class Avo::Menu::Dashboard < Avo::Menu::BaseItem
   extend Dry::Initializer
 
   option :dashboard
+  option :label, optional: true
 
   def parsed_dashboard
     dashboard_by_id || dashboard_by_name
@@ -14,4 +15,8 @@ class Avo::Menu::Dashboard < Avo::Menu::BaseItem
   def dashboard_by_id
     Avo::App.get_dashboard_by_id dashboard.to_s
   end
+
+  def entity_label
+    parsed_dashboard.navigation_label
+  end
 end

data/lib/avo/menu/resource.rb

@@ -2,8 +2,13 @@ class Avo::Menu::Resource < Avo::Menu::BaseItem
   extend Dry::Initializer
 
   option :resource
+  option :label, optional: true
 
   def parsed_resource
     Avo::App.guess_resource resource.to_s
   end
+
+  def entity_label
+    parsed_resource.navigation_label
+  end
 end

data/lib/avo/version.rb

@@ -1,3 +1,3 @@
 module Avo
-  VERSION = "2.7.0" unless const_defined?(:VERSION)
+  VERSION = "2.9.0" unless const_defined?(:VERSION)
 end