avo 3.30.4 → 4.0.0.beta.2

data/lib/avo/concerns/breadcrumbs.rb

@@ -12,85 +12,26 @@ module Avo
       extend ActiveSupport::Concern
 
       included do |base|
-        helper HelperMethods
-        extend ClassMethods
         helper_method :add_breadcrumb, :avo_breadcrumbs
       end
 
-      Crumb = Struct.new(:name, :path) unless defined?(Crumb)
+      Crumb = Data.define(:title, :path, :avatar, :initials, :icon) unless defined?(Crumb)
 
       class Builder
-        DEFAULT_SEPARATOR = " » ".freeze unless defined?(DEFAULT_SEPARATOR)
+        extend PropInitializer::Properties
+        prop :context, reader: :public
+        prop :options, reader: :public
 
-        attr_reader :context, :options
-
-        def initialize(context, options)
-          @context = context
-          @options = options
-        end
-
-        def render
-          separator = options.fetch(:separator, DEFAULT_SEPARATOR)
-          breadcrumbs.map(&method(:render_element)).join(separator)
-        end
-
-        private
-
-        def breadcrumbs
-          context.avo_breadcrumbs
-        end
-
-        def render_element(element)
-          content = element.path.nil? ? compute_name(element) : context.link_to_unless_current(compute_name(element), compute_path(element))
-          options[:tag] ? context.content_tag(options[:tag], content) : ERB::Util.h(content)
-        end
-
-        def compute_name(element)
-          case name = element.name
-          when Symbol
-            context.send(name)
-          when Proc
-            Avo::ExecutionContext.new(target: name, context: context).handle
-          else
-            name.to_s
-          end
-        end
-
-        def compute_path(element)
-          case path = element.path
-          when Symbol
-            context.send(path)
-          when Proc
-            Avo::ExecutionContext.new(target: path, context: context).handle
-          else
-            context.url_for(path)
-          end
-        end
-      end
-
-      module ClassMethods
-        def add_breadcrumb(name, path = nil)
-          before_action(filter_options) do |controller|
-            controller.send(:add_breadcrumb, name, path)
-          end
-        end
+        def breadcrumbs = context.avo_breadcrumbs
       end
 
-      def add_breadcrumb(name, path = nil)
-        avo_breadcrumbs << Crumb.new(name, path)
+      def add_breadcrumb(title: nil, path: nil, avatar: nil, initials: nil, icon: nil)
+        avo_breadcrumbs << Crumb.new(title:, path:, avatar:, initials:, icon:)
       end
 
       def avo_breadcrumbs
         @avo_breadcrumbs ||= []
       end
-
-      module HelperMethods
-        def render_avo_breadcrumbs(options = {}, &)
-          builder = Builder.new(self, options)
-          content = builder.render.html_safe
-          block_given? ? capture(content, &) : content
-        end
-      end
     end
   end
 end

data/lib/avo/concerns/form_builder.rb

@@ -0,0 +1,41 @@
+module Avo
+  module Concerns
+    module FormBuilder
+      def build_form(&block)
+        form_with model: @resource.record,
+          scope: @resource.form_scope,
+          url: form_url,
+          method: is_edit? ? :put : :post,
+          local: true,
+          html: {
+            novalidate: true,
+            data: {
+              controller: "form avo-reactive-fields",
+              action: "keydown.ctrl+enter->form#submit keydown.meta+enter->form#submit"
+            }
+          },
+          multipart: true, &block
+      end
+
+      def form_url
+        if is_edit?
+          helpers.resource_path(
+            record: @resource.record,
+            resource: @resource
+          )
+        else
+          helpers.resources_path(
+            resource: @resource,
+            via_relation_class: params[:via_relation_class],
+            via_relation: params[:via_relation],
+            via_record_id: params[:via_record_id]
+          )
+        end
+      end
+
+      def is_edit?
+        @view.in?(%w[edit update])
+      end
+    end
+  end
+end

data/lib/avo/concerns/{has_profile_photo.rb → has_avatar.rb}

@@ -1,17 +1,21 @@
 # Adds the ability to set the visibility of an item in the execution context.
 module Avo
   module Concerns
-    module HasProfilePhoto
+    module HasAvatar
       extend ActiveSupport::Concern
 
       class_methods do
         # Add class property to capture the settings
-        attr_accessor :profile_photo
+        attr_accessor :avatar
       end
 
       # Add instance property to compute the options
-      def profile_photo
-        ProfilePhoto.new resource: self
+      def avatar
+        Avatar.new resource: self
+      end
+
+      def initials
+        record_title.split(" ").map(&:first).join("").first(2).upcase
       end
     end
   end

data/lib/avo/concerns/{has_cover_photo.rb → has_cover.rb}

@@ -1,17 +1,17 @@
 # Adds the ability to set the visibility of an item in the execution context.
 module Avo
   module Concerns
-    module HasCoverPhoto
+    module HasCover
       extend ActiveSupport::Concern
 
       class_methods do
         # Add class property to capture the settings
-        attr_accessor :cover_photo
+        attr_accessor :cover
       end
 
       # Add instance property to compute the options
-      def cover_photo
-        Avo::CoverPhoto.new resource: self
+      def cover
+        Avo::Cover.new resource: self
       end
     end
   end

data/lib/avo/concerns/has_description.rb

@@ -6,6 +6,7 @@ module Avo
 
       class_methods do
         attr_accessor :description
+        attr_accessor :discreet_description
       end
 
       def description(additional_attributes = {})
@@ -16,6 +17,14 @@ module Avo
         ).handle
       end
 
+      def discreet_description(additional_attributes = {})
+        Avo::ExecutionContext.new(
+          target: @discreet_description || self.class.discreet_description,
+          **description_attributes,
+          **additional_attributes
+        ).handle
+      end
+
       private
 
       # Override this method to add custom attributes to the description execution context.

data/lib/avo/concerns/has_item_type.rb

@@ -14,8 +14,12 @@ module Avo
         self.class.ancestors.include?(Avo::Resources::Items::Panel)
       end
 
-      def is_main_panel?
-        self.class.ancestors.include?(Avo::Resources::Items::MainPanel)
+      def is_card?
+        self.class.ancestors.include?(Avo::Resources::Items::Card)
+      end
+
+      def is_header?
+        self.class.ancestors.include?(Avo::Resources::Items::Header)
       end
 
       def is_tool?

data/lib/avo/concerns/has_items.rb

@@ -3,52 +3,18 @@ module Avo
     module HasItems
       extend ActiveSupport::Concern
 
-      class_methods do
-        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 __method__, "fields"
-        end
-
-        def panel(name = nil, **args, &block)
-          deprecated_dsl_api __method__, "fields"
-        end
-
-        def row(**args, &block)
-          deprecated_dsl_api __method__, "fields"
-        end
-
-        def tabs(**args, &block)
-          deprecated_dsl_api __method__, "fields"
-        end
-
-        def tool(klass, **args)
-          deprecated_dsl_api __method__, "fields"
-        end
-
-        def sidebar(**args, &block)
-          deprecated_dsl_api __method__, "fields"
-        end
-        # END DSL methods
-      end
-
       attr_writer :items_holder
 
       delegate :invalid_fields, to: :items_holder
 
       delegate :field, to: :items_holder
       delegate :panel, to: :items_holder
-      delegate :row, to: :items_holder
-      delegate :cluster, to: :items_holder
+      delegate :card, to: :items_holder
       delegate :tabs, to: :items_holder
       delegate :tool, to: :items_holder
       delegate :heading, to: :items_holder
       delegate :sidebar, to: :items_holder
-      delegate :main_panel, to: :items_holder
+      delegate :header, to: :items_holder
       delegate :collaboration_timeline, to: :items_holder
 
       def items_holder
@@ -87,11 +53,11 @@ module Avo
           next if item.nil?
 
           if only_root
-            # When `item.is_main_panel? == true` then also `item.is_panel? == true`
-            # But when only_root == true we want to extract main_panel items
-            # In all other circumstances items will get extracted when checking for `item.is_panel?`
-            if item.is_main_panel?
-              fields << extract_fields(item)
+            # When only_root == true we want to extract the panel and card items
+            if item.is_panel? || item.is_card?
+              if item.visible_in_view?(view: view)
+                fields << extract_fields(item)
+              end
             end
           else
             # Dive into panels to fetch their fields
@@ -110,6 +76,10 @@ module Avo
             if item.is_sidebar?
               fields << extract_fields(item)
             end
+
+            if item.is_card?
+              fields << extract_fields(item)
+            end
           end
 
           if item.is_field?
@@ -207,25 +177,36 @@ module Avo
           # Slice when the item type changes from standalone to panel or vice-versa
           is_standalone?(prev) != is_standalone?(curr)
         end.to_a.map do |group|
-          { elements: group, is_standalone: is_standalone?(group.first) }
+          {elements: group, is_standalone: is_standalone?(group.first)}
         end
 
-        # Creates a main panel if it's missing and adds first standalone group of items if present
-        if items.none? { |item| item.is_main_panel? }
-          if (standalone_group = grouped_items.find { |group| group[:is_standalone] }).present?
-            calculated_main_panel = Avo::Resources::Items::MainPanel.new
-            hydrate_item calculated_main_panel
-            calculated_main_panel.items_holder.items = standalone_group[:elements]
-            grouped_items[grouped_items.index standalone_group] = { elements: [calculated_main_panel], is_standalone: false }
-          end
+        # Add the header automatically as first item if the user didn't define one
+        # This is to ensure that the header is always present
+        if items.none? { |item| item.is_header? }
+          header = Avo::Resources::Items::Header.new
+          hydrate_item header
+          grouped_items.unshift({elements: [header], is_standalone: false})
         end
 
-        # For each standalone group, wrap items in a panel
-        grouped_items.select { |group| group[:is_standalone] }.each do |group|
-          calculated_panel = Avo::Resources::Items::Panel.new
-          calculated_panel.items_holder.items = group[:elements]
-          hydrate_item calculated_panel
-          group[:elements] = calculated_panel
+        # For each standalone group, wrap items in a panel and card
+        # If the resource has at least one panel defined, we compute nothing, user took control of the panels
+        if items.none? { |item| item.is_panel? }
+          grouped_items.select { |group| group[:is_standalone] }.each do |group|
+            calculated_panel = Avo::Resources::Items::Panel.new
+            hydrate_item calculated_panel
+
+            # Create a card
+            card = Avo::Resources::Items::Card.new
+            hydrate_item card
+
+            # Add the items to the card
+            card.items_holder.items = group[:elements]
+
+            # Add the card to the main panel
+            calculated_panel.items_holder.items = [card]
+
+            group[:elements] = calculated_panel
+          end
         end
 
         grouped_items.flat_map { |group| group[:elements] }
@@ -281,11 +262,15 @@ module Avo
             next true if item.is_a?(Avo::Resources::Items::TabGroup) ||
               item.is_a?(Avo::Resources::Items::Tab) ||
               item.is_heading? ||
-              item.is_a?(Avo::Fields::LocationField)
+              item.is_a?(Avo::Fields::LocationField) ||
+              item.is_header?
 
             # Skip nested fields
             next true if item.try(:nested_on?, view)
 
+            # When the resource is a form, we want to show all items even if there is no setter method
+            next true if defined?(Avo::Forms::Core::Resources::FormResource) && try(:resource).is_a?(Avo::Forms::Core::Resources::FormResource)
+
             item.resource.record.respond_to?(:"#{item.try(:for_attribute) || item.id}=")
           end
           .select do |item|
@@ -329,7 +314,7 @@ module Avo
       # Extractable structures are panels, rows and sidebars
       # Sidebars are only extractable if they are not on the index view
       def extractable_structure?(structure)
-        structure.is_panel? || structure.is_row? || (structure.is_sidebar? && !view.index?)
+        structure.is_panel? || structure.is_row? || structure.is_card? || (structure.is_sidebar? && !view.index?)
       end
 
       # Standalone items are fields that don't have their own panel

data/lib/avo/concerns/pagination.rb

@@ -4,22 +4,14 @@ module Avo
       extend ActiveSupport::Concern
 
       included do
-        include Pagy::Backend
+        include Pagy::Method
 
         class_attribute :pagination, default: {}
 
-        unless defined? PAGINATION_METHOD
-          PAGINATION_METHOD = {
-            default: :pagy,
-            countless: :pagy_countless,
-            array: :pagy_array,
-          }
-        end
-
         unless defined? PAGINATION_DEFAULTS
           PAGINATION_DEFAULTS = {
             type: :default,
-            size: ::Pagy::VERSION >= ::Gem::Version.new("9.0") ? 9 : [1, 2, 2, 1],
+            slots: 9,
           }
         end
       end
@@ -38,10 +30,10 @@ module Avo
 
         data_turbo_frame = "data-turbo-frame=\"#{CGI.escapeHTML(params[:turbo_frame]) if params[:turbo_frame]}\""
 
-        # Perform pagination and fallback to first page on Pagy::OverflowError
+        # Perform pagination and fallback to first page on Pagy::RangeError.
         begin
           perform_pagination(index_params:, query:, data_turbo_frame:, extra_pagy_params:, **args)
-        rescue Pagy::OverflowError
+        rescue Pagy::RangeError
           index_params[:page] = 1
           perform_pagination(index_params:, query:, data_turbo_frame:, extra_pagy_params:, **args)
         end
@@ -50,16 +42,34 @@ module Avo
       private
 
       def perform_pagination(index_params:, query:, data_turbo_frame:, extra_pagy_params:, **args)
-        send PAGINATION_METHOD[pagination_type.to_sym],
+        pagy(
+          pagy_kind,
           query,
           **args,
           page: index_params[:page],
-          items: index_params[:per_page], # Add per page in pagy < 9
-          limit: index_params[:per_page], # Add per page in pagy >= 9
-          link_extra: data_turbo_frame, # Add extra arguments in pagy 7.
-          anchor_string: data_turbo_frame, # Add extra arguments in pagy 8.
-          params: extra_pagy_params,
-          size: pagination_hash[:size]
+          limit: index_params[:per_page],
+          anchor_string: data_turbo_frame,
+          querify: pagy_querify(extra_pagy_params),
+          slots: pagination_hash[:slots],
+          raise_range_error: true
+        )
+      end
+
+      def pagy_kind
+        case pagination_type.to_sym
+        when :countless
+          :countless
+        else
+          :offset
+        end
+      end
+
+      def pagy_querify(extra_pagy_params)
+        return nil if extra_pagy_params.blank?
+
+        lambda do |params_hash|
+          params_hash.merge!(extra_pagy_params.transform_keys(&:to_s))
+        end
       end
 
       def pagination_hash

data/lib/avo/concerns/row_controls_configuration.rb

@@ -26,21 +26,28 @@ module Avo
       end
 
       def row_controls_classes
-        classes = "text-right whitespace-nowrap px-3"
-
-        if render_row_controls_on_the_left?
-          classes += " w-px"
-        end
-
-        if row_controls_configurations[:show_on_hover]
-          classes += " opacity-0 group-hover:opacity-100"
-        end
-
-        if row_controls_configurations[:float]
-          classes += " floating-row-controls sticky group-hover:bg-gray-50 bg-white inset-auto right-0"
-        end
-
-        classes
+        float_classes = "bg-primary
+          group-hover:bg-table-row-hover
+
+          sticky inset-auto end-0
+
+          before:content-[''] before:absolute before:z-10 before:inset-auto before:start-0 before:top-0 before:mt-0 before:-translate-x-full before:w-3 before:h-full
+          before:bg-gradient-to-r
+          before:from-transparent before:to-primary
+          group-hover:before:from-transparent group-hover:before:to-table-row-hover
+        "
+
+        # TODO: add this to the css classes above
+        # &:has([data-toggle-target="panel"]:not(.hidden)) {
+        #   @apply z-30 opacity-100
+        # }
+
+        class_names(
+          "text-end whitespace-nowrap px-3",
+          "w-px": render_row_controls_on_the_left?,
+          "*:opacity-0 group-hover:*:opacity-100": row_controls_configurations[:show_on_hover],
+          "#{float_classes}": row_controls_configurations[:float]
+        )
       end
     end
   end

data/lib/avo/configuration/branding.rb

@@ -8,25 +8,25 @@ class Avo::Configuration::Branding
     @favicon = favicon
 
     @default_colors = {
-      :background => "#F6F6F7",
+      :background => "#FAFAFA",
       100 => "206 231 248",
       400 => "57 158 229",
       500 => "8 134 222",
       600 => "6 107 178"
     }
     @default_chart_colors = ["#0B8AE2", "#34C683", "#FFBE4F", "#FF7676", "#2AB1EE", "#34C6A8", "#EC8CFF", "#80FF91", "#FFFC38", "#1BDBE8"]
-    @default_logo = "/avo-assets/logo.png"
-    @default_logomark = "/avo-assets/logomark.png"
-    @default_placeholder = "/avo-assets/placeholder.svg"
-    @default_favicon = "/avo-assets/favicon.ico"
+    @default_logo = "avo/logo.png"
+    @default_logomark = "avo/logomark.png"
+    @default_placeholder = "avo/placeholder.svg"
+    @default_favicon = "avo/favicon.ico"
   end
 
   def css_colors
     rgb_colors.map do |color, value|
       if color == :background
-        "--color-application-#{color}: #{value};"
+        "--avo-color-application-background: #{value};"
       else
-        "--color-primary-#{color}: #{value};"
+        "--avo-color-primary-#{color}: #{value};"
       end
     end.join("\n")
   end