spree_admin 5.2.0.rc2 → 5.2.0

data/app/models/spree/admin/form_builder.rb

@@ -24,13 +24,18 @@ module Spree
       #   - :required [Boolean] whether field is required
       #   - :help [String] help text to display below the field
       #   - :help_bubble [String] help bubble text
+      #   - :prepend [String] text to prepend before the input field
+      #   - :append [String] text to append after the input field
       # @return [String] HTML string containing the complete form group
       def spree_text_field(method, options = {})
         options[:class] ||= 'form-control'
+        prepend = options.delete(:prepend)
+        append = options.delete(:append)
+
         @template.content_tag(:div, class: 'form-group') do
           @template.label(@object_name, method, get_label(method, options)) +
-            @template.text_field(@object_name, method, objectify_options(options)) +
-            @template.error_message_on(@object_name, method) + field_help(method, options)
+            wrap_with_input_group(@template.text_field(@object_name, method, objectify_options(options)), prepend, append) +
+            @template.error_message_on(@object_name, method) + spree_field_help(method, options.merge(class: 'form-text mt-2'))
         end
       end
 
@@ -41,10 +46,13 @@ module Spree
       # @return [String] HTML string containing the complete form group
       def spree_number_field(method, options = {})
         options[:class] ||= 'form-control'
+        prepend = options.delete(:prepend)
+        append = options.delete(:append)
+
         @template.content_tag(:div, class: 'form-group') do
           @template.label(@object_name, method, get_label(method, options)) +
-            @template.number_field(@object_name, method, objectify_options(options)) +
-            @template.error_message_on(@object_name, method) + field_help(method, options)
+            wrap_with_input_group(@template.number_field(@object_name, method, objectify_options(options)), prepend, append) +
+            @template.error_message_on(@object_name, method) + spree_field_help(method, options.merge(class: 'form-text mt-2'))
         end
       end
 
@@ -58,7 +66,7 @@ module Spree
         @template.content_tag(:div, class: 'form-group') do
           @template.label(@object_name, method, get_label(method, options)) +
             @template.email_field(@object_name, method, objectify_options(options)) +
-            @template.error_message_on(@object_name, method) + field_help(method, options)
+            @template.error_message_on(@object_name, method) + spree_field_help(method, options.merge(class: 'form-text mt-2'))
         end
       end
 
@@ -72,7 +80,7 @@ module Spree
         @template.content_tag(:div, class: 'form-group') do
           @template.label(@object_name, method, get_label(method, options)) +
             @template.date_field(@object_name, method, objectify_options(options)) +
-            @template.error_message_on(@object_name, method) + field_help(method, options)
+            @template.error_message_on(@object_name, method) + spree_field_help(method, options.merge(class: 'form-text mt-2'))
         end
       end
 
@@ -86,7 +94,7 @@ module Spree
         @template.content_tag(:div, class: 'form-group') do
           @template.label(@object_name, method, get_label(method, options)) +
             @template.datetime_field(@object_name, method, objectify_options(options)) +
-            @template.error_message_on(@object_name, method) + field_help(method, options)
+            @template.error_message_on(@object_name, method) + spree_field_help(method, options.merge(class: 'form-text mt-2'))
         end
       end
 
@@ -107,7 +115,7 @@ module Spree
 
           @template.label(@object_name, method, get_label(method, options)) +
             @template.text_area(@object_name, method, objectify_options(options)) +
-            @template.error_message_on(@object_name, method) + field_help(method, options)
+            @template.error_message_on(@object_name, method) + spree_field_help(method, options.merge(class: 'form-text mt-2'))
         end
       end
 
@@ -122,7 +130,7 @@ module Spree
             @template.content_tag(:div, class: 'trix-container') do
               @template.rich_text_area(@object_name, method, objectify_options(options))
             end +
-            @template.error_message_on(@object_name, method) + field_help(method, options)
+            @template.error_message_on(@object_name, method) + spree_field_help(method, options.merge(class: 'form-text mt-2'))
         end
       end
 
@@ -147,7 +155,7 @@ module Spree
         @template.content_tag(:div, class: 'form-group') do
           @template.label(@object_name, method, get_label(method, options)) +
             @template.select(@object_name, method, choices, objectify_options(options), html_options, &block) +
-            @template.error_message_on(@object_name, method) + field_help(method, options)
+            @template.error_message_on(@object_name, method) + spree_field_help(method, options.merge(class: 'form-text mt-2'))
         end
       end
 
@@ -173,7 +181,7 @@ module Spree
         @template.content_tag(:div, class: 'form-group') do
           @template.label(@object_name, method, get_label(method, options)) +
             @template.collection_select(@object_name, method, collection, value_method, text_method, objectify_options(options), html_options) +
-            @template.error_message_on(@object_name, method) + field_help(method, options)
+            @template.error_message_on(@object_name, method) + spree_field_help(method, options.merge(class: 'form-text mt-2'))
         end
       end
 
@@ -187,7 +195,7 @@ module Spree
           @template.content_tag(:div, class: 'custom-control custom-checkbox') do
             @template.check_box(@object_name, method, objectify_options(options.merge(class: 'custom-control-input'))) +
             @template.label(@object_name, method, get_label(method, options), class: 'custom-control-label')
-          end + @template.error_message_on(@object_name, method) + field_help(method, options)
+          end + @template.error_message_on(@object_name, method) + spree_field_help(method, options.merge!(class: 'form-text mt-2 ml-4'))
         end
       end
 
@@ -204,22 +212,43 @@ module Spree
           @template.content_tag(:div, class: 'custom-control custom-radio') do
             @template.radio_button(@object_name, method, tag_value, objectify_options(options.merge(class: 'custom-control-input'))) +
               @template.label(@object_name, method, get_label(method, options), class: 'custom-control-label', for: options[:id])
-          end + @template.error_message_on(@object_name, method) + field_help(method, options)
+          end + @template.error_message_on(@object_name, method) + spree_field_help(method, options.merge(class: 'form-text mt-2'))
         end
       end
 
+      # Create a direct file upload field with Spree form styling
+      #
+      # @param method [Symbol] the field name
+      # @param options [Hash] field options
+      # @option options [Boolean] :crop whether to crop the image
+      # @option options [Boolean] :auto_submit whether to auto-submit the form when the file is uploaded
+      # @option options [Boolean] :can_delete whether to show the delete button
+      # @option options [Boolean] :inline whether to display the uploader inline
+      # @option options [Integer] :height the height of the uploader
+      # @option options [Integer] :width the width of the uploader
+      # @option options [Array] :allowed_file_types the allowed file types, defaults to image types
+      # @return [String] HTML string containing the complete form group with direct file upload field
+      def spree_file_field(method, options = {})
+        @template.content_tag(:div, class: 'form-group') do
+          @template.label(@object_name, method, get_label(method, options)) +
+          @template.render('active_storage/upload_form', form: self, field_name: method, **options) +
+          @template.error_message_on(@object_name, method) + spree_field_help(method, options.merge(class: 'form-text mt-2'))
+        end
+      end
+
+      private
+
       # Generate help text for a field
       #
       # @param _method [Symbol] the field name (unused but kept for consistency)
       # @param options [Hash] field options
       # @option options [String] :help help text to display
       # @return [String] HTML string containing the help text or empty string
-      def field_help(_method, options = {})
-        @template.content_tag(:span, options[:help], class: 'form-text mt-2')
+      def spree_field_help(_method, options = {})
+        options[:class] ||= 'form-text mt-2'
+        @template.content_tag(:span, options[:help], class: options[:class])
       end
 
-      private
-
       # Generate the label for a field with required indicator and help bubble
       #
       # @param method [Symbol] the field name
@@ -245,6 +274,36 @@ module Spree
 
         @template.raw(translated_label + required_label + help_bubble)
       end
+
+      # Wrap a field with an input group if prepend or append is specified
+      #
+      # @param field_html [String] the HTML for the field
+      # @param prepend [String, nil] text to prepend before the input field
+      # @param append [String, nil] text to append after the input field
+      # @return [String] HTML string with input group wrapper or the original field
+      def wrap_with_input_group(field_html, prepend = nil, append = nil)
+        return field_html if prepend.nil? && append.nil?
+
+        @template.content_tag(:div, class: 'input-group') do
+          prepend_html = if prepend.present?
+                           @template.content_tag(:div, class: 'input-group-prepend') do
+                             @template.content_tag(:span, prepend, class: 'input-group-text')
+                           end
+                         else
+                           ''.html_safe
+                         end
+
+          append_html = if append.present?
+                          @template.content_tag(:div, class: 'input-group-append') do
+                            @template.content_tag(:span, append, class: 'input-group-text')
+                          end
+                        else
+                          ''.html_safe
+                        end
+
+          prepend_html + field_html + append_html
+        end
+      end
     end
   end
 end

data/app/models/spree/admin/navigation/builder.rb

@@ -0,0 +1,82 @@
+module Spree
+  module Admin
+    class Navigation
+      class Builder
+        attr_reader :registry, :parent_item
+
+        def initialize(registry, parent_item = nil)
+          @registry = registry
+          @parent_item = parent_item
+        end
+
+        # Add a navigation item
+        # If parent_item is set, the item becomes a child
+        def add(key, **options, &block)
+          # If we have a parent item, set it in the options
+          if parent_item
+            options[:parent] = parent_item.key
+            # Adjust position to be relative to parent
+            options[:position] ||= parent_item.children.size * 10
+          end
+
+          item = registry.add(key, **options, &block)
+          item
+        end
+
+        # Add a section (group of items)
+        def section(key, label: nil, &block)
+          section_item = add(key, section_label: label || key.to_s.humanize)
+
+          if block_given?
+            builder = self.class.new(registry, section_item)
+            # Support both block styles: |nav| nav.add or just add
+            if block.arity > 0
+              # Block expects parameter: do |nav| nav.add ... end
+              block.call(builder)
+            else
+              # Block uses implicit self: do add ... end
+              builder.instance_eval(&block)
+            end
+          end
+
+          section_item
+        end
+
+        # Remove an item
+        def remove(key)
+          registry.remove(key)
+        end
+
+        # Update an item
+        def update(key, **options)
+          registry.update(key, **options)
+        end
+
+        # Insert before another item
+        def insert_before(target_key, new_key, **options)
+          registry.insert_before(target_key, new_key, **options)
+        end
+
+        # Insert after another item
+        def insert_after(target_key, new_key, **options)
+          registry.insert_after(target_key, new_key, **options)
+        end
+
+        # Move an item
+        def move(key, **position_options)
+          registry.move(key, **position_options)
+        end
+
+        # Replace an item
+        def replace(key, **options, &block)
+          registry.replace(key, **options, &block)
+        end
+
+        # Reorder items with a block
+        def reorder(&block)
+          instance_eval(&block) if block_given?
+        end
+      end
+    end
+  end
+end

data/app/models/spree/admin/navigation/item.rb

@@ -0,0 +1,177 @@
+module Spree
+  module Admin
+    class Navigation
+      class Item
+        attr_accessor :key, :label, :url, :icon, :position, :parent_key,
+                      :condition, :badge, :badge_class, :tooltip, :target, :data_attributes, :children, :section_label, :active_condition
+
+        def initialize(key, **options)
+          @key = key.to_sym
+          @label = options[:label]
+          @url = options[:url]
+          @icon = options[:icon]
+          @position = options[:position] || 999
+          @parent_key = options[:parent]
+          @active_condition = options[:active]
+          @condition = options.key?(:if) ? options[:if] : options[:condition]
+          @badge = options[:badge]
+          @badge_class = options[:badge_class]
+          @tooltip = options[:tooltip]
+          @target = options[:target]
+          @data_attributes = options[:data_attributes] || {}
+          @section_label = options[:section_label]
+          @children = []
+        end
+
+        # Check if this item should be visible for the given user/context
+        # @param user_or_context [Object] Either a user object or a view context
+        def visible?(user_or_context = nil)
+          return true if condition.nil?
+
+          if condition.respond_to?(:call)
+            # If we have a view context with instance_exec, use it to evaluate the condition
+            # This allows access to can? and other helper methods
+            if user_or_context.respond_to?(:instance_exec)
+              user_or_context.instance_exec(&condition)
+            else
+              # Otherwise, call with the user object
+              condition.call(user_or_context)
+            end
+          else
+            condition
+          end
+        end
+
+        # Check if this item is active based on current path
+        # @param current_path [String] The current request path
+        # @param context [Object] View context with access to route helpers
+        def active?(current_path, context = nil)
+          # Use custom active condition if provided (most flexible)
+          if active_condition.respond_to?(:call)
+            if context&.respond_to?(:instance_exec)
+              return context.instance_exec(&active_condition)
+            else
+              return active_condition.call
+            end
+          end
+
+          # Match exact path
+          item_url = resolve_url(context)
+          return true if item_url && current_path == item_url
+
+          # Check if any child item is active
+          return true if children.any? { |child| child.active?(current_path, context) }
+
+          # Default: match if path starts with url (handled by active_link_to)
+          if item_url
+            current_path.start_with?(item_url)
+          else
+            false
+          end
+        end
+
+        # Resolve URL (handles symbols, procs, and strings)
+        # @param context [Object] View context with access to route helpers
+        def resolve_url(context = nil)
+          case url
+          when Symbol
+            # Try to call the route helper on the context (which has spree routes)
+            if context&.respond_to?(url)
+              context.send(url)
+            elsif context&.respond_to?(:spree)
+              context.spree.send(url) rescue url.to_s
+            else
+              url.to_s
+            end
+          when Proc
+            # Evaluate proc in the context where route helpers are available
+            if context&.respond_to?(:instance_exec)
+              context.instance_exec(&url)
+            else
+              url.call
+            end
+          else
+            url
+          end
+        end
+
+        # Resolve label (handles i18n keys)
+        def resolve_label
+          return label unless label.is_a?(String) || label.is_a?(Symbol)
+
+          # Use Spree.t for translation which handles the spree namespace
+          Spree.t(label, default: label.to_s.humanize)
+        end
+
+        # Compute badge value
+        # @param view_context [Object] View context with access to helper methods
+        def badge_value(view_context = nil)
+          return nil unless badge
+
+          if badge.respond_to?(:call)
+            # Evaluate badge in view context if available (for access to helpers)
+            if view_context&.respond_to?(:instance_exec)
+              view_context.instance_exec(&badge)
+            else
+              badge.call
+            end
+          else
+            badge
+          end
+        end
+
+        # Check if this is a section header
+        def section?
+          section_label.present?
+        end
+
+        # Add a child item
+        def add_child(item)
+          children << item
+          item.parent_key = key
+          sort_children!
+        end
+
+        # Remove a child item
+        def remove_child(key)
+          children.reject! { |child| child.key == key }
+        end
+
+        # Sort children by position
+        def sort_children!
+          children.sort_by! { |child| [child.position, child.key.to_s] }
+        end
+
+        # Deep clone for modifications
+        def deep_clone
+          cloned = self.class.new(key, to_h)
+          cloned.children = children.map(&:deep_clone)
+          cloned
+        end
+
+        # Convert to hash
+        def to_h
+          {
+            label: label,
+            url: url,
+            icon: icon,
+            position: position,
+            parent: parent_key,
+            active: active_condition,
+            condition: condition,
+            badge: badge,
+            badge_class: badge_class,
+            tooltip: tooltip,
+            target: target,
+            data_attributes: data_attributes,
+            section_label: section_label
+          }
+        end
+
+        def inspect
+          "#<Spree::Admin::Navigation::Item key=#{key} label=#{label} children=#{children.size}>"
+        end
+      end
+    end
+  end
+end

data/app/models/spree/admin/navigation.rb

@@ -0,0 +1,193 @@
+module Spree
+  module Admin
+    class Navigation
+      attr_reader :items, :context
+
+      def initialize(context)
+        @context = context
+        @items = {}
+      end
+
+      # Add a navigation item
+      def add(key, **options, &block)
+        key = key.to_sym
+        item = Item.new(key, **options)
+
+        @items[key] = item
+
+        # If block provided, it's for children
+        if block_given?
+          builder = Builder.new(self, item)
+          # Support both block styles: |nav| nav.add or just add
+          if block.arity > 0
+            # Block expects parameter: do |nav| nav.add ... end
+            block.call(builder)
+          else
+            # Block uses implicit self: do add ... end
+            builder.instance_eval(&block)
+          end
+        end
+
+        sort_items!
+        item
+      end
+
+      # Remove a navigation item
+      def remove(key)
+        key = key.to_sym
+        removed = @items.delete(key)
+
+        # Also remove from any parent's children
+        @items.each_value do |item|
+          item.remove_child(key)
+        end
+
+        removed
+      end
+
+      # Update an existing navigation item
+      def update(key, **options)
+        key = key.to_sym
+        item = @items[key]
+
+        return nil unless item
+
+        options.each do |attr, value|
+          item.send("#{attr}=", value) if item.respond_to?("#{attr}=")
+        end
+
+        sort_items!
+        item
+      end
+
+      # Find a navigation item
+      def find(key)
+        @items[key.to_sym]
+      end
+
+      # Check if item exists
+      def exists?(key)
+        @items.key?(key.to_sym)
+      end
+
+      # Insert item before another item
+      def insert_before(target_key, new_key, **options)
+        target = find(target_key)
+        return nil unless target
+
+        new_position = target.position - 1
+        add(new_key, **options.merge(position: new_position))
+      end
+
+      # Insert item after another item
+      def insert_after(target_key, new_key, **options)
+        target = find(target_key)
+        return nil unless target
+
+        new_position = target.position + 1
+        add(new_key, **options.merge(position: new_position))
+      end
+
+      # Move item to a new position
+      def move(key, position: nil, before: nil, after: nil)
+        item = find(key)
+        return nil unless item
+
+        if before
+          target = find(before)
+          item.position = target.position - 1 if target
+        elsif after
+          target = find(after)
+          item.position = target.position + 1 if target
+        elsif position == :first
+          item.position = -999
+        elsif position == :last
+          item.position = 999
+        elsif position.is_a?(Integer)
+          item.position = position
+        end
+
+        sort_items!
+        item
+      end
+
+      # Replace an item
+      def replace(key, **options, &block)
+        remove(key)
+        add(key, **options, &block)
+      end
+
+      # Get all root items (items without a parent)
+      def root_items
+        @items.values.select { |item| item.parent_key.nil? }.sort_by { |item| [item.position, item.key.to_s] }
+      end
+
+      # Get all items that are visible to the user
+      def visible_items(user = nil, parent_key = nil)
+        items_to_filter = if parent_key
+                            find(parent_key)&.children || []
+                          else
+                            root_items
+                          end
+
+        items_to_filter.select { |item| item.visible?(user) }
+      end
+
+      # Build tree structure
+      def build_tree
+        # First, clear all children
+        @items.each_value { |item| item.children.clear }
+
+        # Then rebuild the tree
+        @items.each_value do |item|
+          if item.parent_key && (parent = @items[item.parent_key])
+            parent.add_child(item)
+          end
+        end
+
+        root_items
+      end
+
+      # Clear all items
+      def clear
+        @items.clear
+      end
+
+      # Get all registered paths (for settings_area? detection)
+      def registered_paths(context = nil)
+        @items.values.map { |item| item.resolve_url(context) }.compact
+      end
+
+      # Add a section
+      def section(key, label: nil, &block)
+        # Create a section header item
+        section_item = add(key, section_label: label || key.to_s.humanize, position: @items.size * 100)
+
+        if block_given?
+          builder = Builder.new(self, section_item)
+          builder.instance_eval(&block)
+        end
+
+        section_item
+      end
+
+      # Deep clone the registry
+      def deep_clone
+        cloned = self.class.new(context)
+        @items.each do |key, item|
+          cloned.items[key] = item.deep_clone
+        end
+        cloned.build_tree
+        cloned
+      end
+
+      private
+
+      def sort_items!
+        # Sort items by position, then rebuild tree
+        @items = @items.sort_by { |_key, item| [item.position, item.key.to_s] }.to_h
+        build_tree
+      end
+    end
+  end
+end

data/app/views/layouts/spree/admin.html.erb

@@ -6,7 +6,7 @@
   </head>
 
   <body class="admin min-vh-100 <%= controller_name %> <%= action_name %>"
-    data-controller="admin"
+    data-controller="admin sidebar"
     data-action="keydown.ctrl+s->admin#save keydown.meta+s->admin#save"
   >
     <%= render_admin_partials(:body_start_partials) %>

data/app/views/spree/admin/assets/edit.html.erb

@@ -2,7 +2,7 @@
   <%= dialog_header(Spree.t(:edit) + ' ' + Spree.t(:image)) %>
   <%= form_with model: @asset, url: spree.admin_asset_path(@asset), method: :put, scope: :asset do |f| %>
     <div class="dialog-body pb-0" data-turbo-permanent id="asset-<%= @asset.key.parameterize %>">
-      <%= render 'active_storage/upload_form', form: f, field_name: :attachment, width: 200, height: 200, can_delete: false %>
+      <%= f.spree_file_field :attachment, width: 200, height: 200, can_delete: false, label: Spree.t(:image) %>
     </div>
     <div class="dialog-body" style="min-height: 200px">
       <%= f.spree_text_area :alt, label: Spree.t(:alt_text), rows: 4 %>

data/app/views/spree/admin/custom_domains/_custom_domains.html.erb

@@ -3,7 +3,7 @@
     <table class="table">
       <thead>
         <tr>
-          <th scope="col"><%= sort_link search_collection, :name, Spree.t(:name) %></th>
+          <th scope="col"><%= sort_link @search, :name, Spree.t(:name) %></th>
           <th scope="col"><%= Spree.t(:active) %>?</th>
           <th scope="col"><%= Spree.t(:default) %>?</th>
           <th scope="col"></th>