spree_admin 5.2.0.rc1 → 5.2.0.rc3

data/app/controllers/spree/admin/resource_controller.rb

@@ -1,13 +1,16 @@
 class Spree::Admin::ResourceController < Spree::Admin::BaseController
   include Spree::Admin::Callbacks
 
-  helper_method :new_object_url, :edit_object_url, :object_url, :collection_url, :model_class, :search_collection, :paginated_collection
+  helper_method :new_object_url, :edit_object_url, :object_url, :collection_url, :model_class
   before_action :load_resource
   before_action :set_currency, :set_current_store, only: [:new, :create]
-  after_action :set_return_to, only: [:index]
 
   rescue_from ActiveRecord::RecordNotFound, with: :resource_not_found
 
+  def index
+    @collection = collection
+  end
+
   # GET /admin/<resource_name>/new
   def new
     invoke_callbacks(:new_action, :before)
@@ -218,7 +221,7 @@ class Spree::Admin::ResourceController < Spree::Admin::BaseController
 
   # Returns the collection of resources (as a scope)
   # @return [ActiveRecord::Relation]
-  def collection
+  def scope
     return parent.send(controller_name) if parent_data.present?
 
     base_scope = model_class.try(:for_store, current_store) || model_class
@@ -228,30 +231,36 @@ class Spree::Admin::ResourceController < Spree::Admin::BaseController
 
     if model_class.respond_to?(:accessible_by) &&
         !current_ability.has_block?(params[:action], model_class)
-      base_scope.accessible_by(current_ability, action)
+      base_scope.accessible_by(current_ability, action).includes(collection_includes)
     else
-      base_scope
+      base_scope.includes(collection_includes)
+    end
+  end
+
+  # keeping this as @search for backwards compatibility
+  # @return [Ransack::Search]
+  def search_collection
+    @search ||= begin
+      params[:q] ||= {}
+      params[:q][:s] ||= collection_default_sort if collection_default_sort.present?
+      scope.ransack(params[:q])
     end
   end
 
   # Returns the filtered and paginated ransack results
   # @return [ActiveRecord::Relation]
-  def paginated_collection
-    @paginated_collection ||= begin
-      # Check if collection is already a ransack collection and return it
-      return collection if collection.respond_to?(:current_page)
+  def collection
+    @collection ||= search_collection.result(distinct: true).page(params[:page]).per(params[:per_page])
+  end
 
-      search_collection.result(distinct: true).page(params[:page]).per(params[:per_page])
-    end
+  def collection_includes
+    []
   end
 
-  # Returns the ransack search collection
-  # @return [Ransack::Search]
-  def search_collection
-    @search_collection ||= begin
-      params[:q] ||= {}
-      collection.ransack(params[:q])
-    end
+  # Override in child controllers to set default sort order
+  # @return [String, nil] Ransack sort string (e.g., "name asc", "created_at desc")
+  def collection_default_sort
+    nil
   end
 
   # Returns the URL to redirect to after destroying a resource

data/app/controllers/spree/admin/return_authorizations_controller.rb

@@ -21,16 +21,6 @@ module Spree
       def location_after_destroy
         spree.edit_admin_order_path(@return_authorization.order)
       end
-
-      def collection
-        return @collection if @collection.present?
-
-        params[:q] ||= {}
-
-        # @search needs to be defined as this is passed to search_form_for
-        @search = current_store.return_authorizations.accessible_by(current_ability, :index).ransack(params[:q])
-        @collection = @search.result.order(created_at: :desc).page(params[:page]).per(params[:per_page])
-      end
     end
   end
 end

data/app/controllers/spree/admin/shipping_methods_controller.rb

@@ -8,6 +8,10 @@ module Spree
 
       private
 
+      def collection_includes
+        [:zones, :calculator]
+      end
+
       def set_default_values
         @shipping_method.display_on = 'both'
         @shipping_method.shipping_categories = [Spree::ShippingCategory.first]

data/app/controllers/spree/admin/stock_items_controller.rb

@@ -11,18 +11,15 @@ module Spree
         true
       end
 
-      def collection
-        params[:q] ||= {}
-        params[:q][:s] ||= 'created_at desc'
+      def scope
+        super.joins(:variant).where(spree_variants: { track_inventory: true }).merge(current_store.variants.eligible).reorder('')
+      end
 
-        @search = super.accessible_by(current_ability, :update).ransack(params[:q])
-        @stock_items = @search.result.
-                       joins(:variant).
-                       where(spree_variants: { track_inventory: true }).
-                       merge(current_store.variants.eligible).
-                       includes(:stock_location, [variant: [product: [variants: [:images], master: [:images]], images: []]]).
-                       page(params[:page]).
-                       per(params[:per_page])
+      def collection_includes
+        {
+          stock_location: [],
+          variant: [option_values: :option_type, product: [variant_images: [], variants: [:images], master: [:images]], images: []]
+        }
       end
 
       def add_breadcrumbs

data/app/controllers/spree/admin/stock_locations_controller.rb

@@ -15,7 +15,7 @@ module Spree
 
       private
 
-      def collection
+      def scope
         super.order_default
       end
 

data/app/controllers/spree/admin/stock_transfers_controller.rb

@@ -15,16 +15,6 @@ module Spree
         spree.admin_stock_transfer_path(@object)
       end
 
-      def collection
-        params[:q] ||= {}
-        params[:q][:s] ||= 'created_at desc'
-
-        @search = super.accessible_by(current_ability, :index).ransack(params[:q])
-        @stock_transfers = @search.result.
-                           page(params[:page]).
-                           per(params[:per_page])
-      end
-
       def permitted_resource_params
         params.require(:stock_transfer).permit(permitted_stock_transfer_attributes)
       end

data/app/controllers/spree/admin/store_credits_controller.rb

@@ -2,18 +2,10 @@ module Spree
   module Admin
     class StoreCreditError < StandardError; end
 
-    class StoreCreditsController < Spree::Admin::BaseController
-      before_action :load_user
-      before_action :load_store_credit, only: [:new, :edit, :update, :destroy]
+    class StoreCreditsController < Spree::Admin::ResourceController
+      before_action :set_breadcrumbs
+      before_action :set_user
       before_action :ensure_unused_store_credit, only: [:update]
-      helper_method :collection_url
-
-      def index
-        @store_credits = scope.includes(:created_by).order(created_at: :desc)
-        @store_credits = @store_credits.page(params[:page]).per(params[:per_page])
-
-        @collection = @store_credits
-      end
 
       def show
         @store_credit = scope.find(params[:id])
@@ -21,8 +13,8 @@ module Spree
       end
 
       def create
-        @store_credit = @user.store_credits.build(
-          permitted_store_credit_params.merge(
+        @store_credit = parent.store_credits.build(
+          permitted_resource_params.merge(
             created_by: try_spree_current_user,
             action_originator: try_spree_current_user,
             store: current_store
@@ -31,7 +23,7 @@ module Spree
 
         if @store_credit.save
           flash[:success] = flash_message_for(@store_credit, :successfully_created)
-          redirect_to spree.admin_user_path(@user)
+          redirect_to spree.admin_user_path(parent)
         else
           flash[:error] = Spree.t('store_credit.errors.unable_to_create')
           render :new, status: :unprocessable_entity
@@ -39,11 +31,11 @@ module Spree
       end
 
       def update
-        @store_credit.assign_attributes(permitted_store_credit_params)
+        @store_credit.assign_attributes(permitted_resource_params)
 
         if @store_credit.save
           flash[:success] = flash_message_for(@store_credit, :successfully_updated)
-          redirect_to spree.admin_user_store_credit_path(@user, @store_credit)
+          redirect_to spree.admin_user_store_credit_path(parent, @store_credit)
         else
           flash[:error] = Spree.t('store_credit.errors.unable_to_update')
           render :edit, status: :unprocessable_entity
@@ -59,37 +51,41 @@ module Spree
           flash[:error] = Spree.t('store_credit.errors.unable_to_delete')
         end
 
-        redirect_to spree.admin_user_path(@user)
+        redirect_to spree.admin_user_path(parent)
       end
 
       protected
 
-      def permitted_store_credit_params
-        params.require(:store_credit).permit(permitted_store_credit_attributes)
+      def parent
+        @parent ||= Spree.user_class.find_by(id: params[:user_id])
       end
 
-      private
+      def parent_data
+        {
+          model_name: 'spree/user',
+          model_class: Spree.user_class,
+          find_by: :id
+        }
+      end
 
-      def load_user
-        @user = Spree.user_class.find_by(id: params[:user_id])
+      def permitted_resource_params
+        params.require(:store_credit).permit(permitted_store_credit_attributes)
+      end
 
-        unless @user
-          flash[:error] = Spree.t(:user_not_found)
-          redirect_to spree.admin_path
-        end
+      private
 
-        @breadcrumb_icon = 'users'
-        add_breadcrumb Spree.t(:customers), :admin_users_path
-        add_breadcrumb @user.name, spree.admin_user_path(@user)
+      def set_user
+        @user = parent
       end
 
-      def load_store_credit
-        @store_credit = scope.find_by(id: params[:id]) || scope.new
-        @object = @store_credit
+      def object_url
+        spree.admin_user_store_credit_path(parent, @store_credit)
       end
 
-      def scope
-        current_store.store_credits.where(user: @user)
+      def set_breadcrumbs
+        @breadcrumb_icon = 'users'
+        add_breadcrumb Spree.t(:customers), :admin_users_path
+        add_breadcrumb parent.name, spree.admin_user_path(parent)
       end
 
       def ensure_unused_store_credit
@@ -99,7 +95,11 @@ module Spree
       end
 
       def collection_url
-        spree.admin_user_store_credits_path(@user)
+        spree.admin_user_store_credits_path(parent)
+      end
+
+      def update_turbo_stream_enabled?
+        true
       end
     end
   end

data/app/controllers/spree/admin/taxonomies_controller.rb

@@ -8,16 +8,6 @@ module Spree
 
       private
 
-      def collection
-        return @collection if @collection.present?
-
-        @collection = super
-
-        params[:q] ||= {}
-        @search = @collection.ransack(params[:q])
-        @collection = @search.result.all
-      end
-
       def location_after_save
         spree.admin_taxonomy_path(@taxonomy)
       end

data/app/controllers/spree/admin/themes_controller.rb

@@ -70,8 +70,12 @@ module Spree
         true
       end
 
-      def collection
-        super.without_previews.order(default: :desc).includes(screenshot_attachment: :blob)
+      def scope
+        super.without_previews.order(default: :desc)
+      end
+
+      def collection_includes
+        { screenshot_attachment: :blob }
       end
 
       def permitted_resource_params

data/app/controllers/spree/admin/users_controller.rb

@@ -50,23 +50,13 @@ module Spree
 
       protected
 
-      def collection
-        return @collection if @collection.present?
-
-        params[:q] ||= {}
-        params[:q][:s] ||= 'created_at desc'
-        params[:q][:created_at_not_null] ||= 1
-
-        @collection = model_class.accessible_by(current_ability, :index)
-        @search = @collection.ransack(params[:q])
-        @collection = @search.result(distinct: true).
-                      includes(
-                        addresses: [:country, :state],
-                        ship_address: [:country, :state],
-                        bill_address: [:country, :state],
-                        avatar_attachment: :blob
-                      ).
-                      page(params[:page]).per(params[:per_page])
+      def collection_includes
+        {
+          addresses: [:country, :state],
+          ship_address: [:country, :state],
+          bill_address: [:country, :state],
+          avatar_attachment: :blob
+        }
       end
 
       def find_resource

data/app/controllers/spree/admin/webhooks_subscribers_controller.rb

@@ -19,16 +19,6 @@ module Spree
         @resource ||= Spree::Admin::Resource.new 'spree/admin/webhooks/subscribers', 'subscribers', nil
       end
 
-      def collection
-        params[:q] ||= {}
-        params[:q][:s] ||= 'created_at desc'
-
-        @search = Webhooks::Subscriber.accessible_by(current_ability).ransack(params[:q])
-        @collection = @search.result.
-                      page(params[:page]).
-                      per(params[:per_page])
-      end
-
       def process_subscriptions
         return if params[:webhooks_subscriber].blank?
 

data/app/controllers/spree/admin/zones_controller.rb

@@ -14,13 +14,6 @@ module Spree
         edit_object_url(@object, states_country_id: @selected_country&.id)
       end
 
-      def collection
-        params[:q] ||= {}
-        params[:q][:s] ||= 'name asc'
-        @search = super.ransack(params[:q])
-        @zones = @search.result.page(params[:page]).per(params[:per_page])
-      end
-
       def load_data
         @selected_country = if params[:states_country_id]
           Spree::Country.find_by(id: params[:states_country_id])

data/app/helpers/spree/admin/dropdown_helper.rb

@@ -3,28 +3,42 @@ module Spree
     module DropdownHelper
       def dropdown(options = {}, &block)
         options[:class] = ['dropdown'] + Array(options[:class])
-        options[:data] = { controller: 'dropdown' }.merge(options[:data] || {})
+
+        # Extract direction option for backward compatibility and convert to Floating UI placement
+        placement = case options.delete(:direction)
+        when 'left'
+          'bottom-end'
+        when 'top'
+          'top-start'
+        when 'top-left'
+          'top-end'
+        else
+          options[:placement] || 'bottom-start'
+        end
+
+        options[:data] = {
+          controller: 'dropdown',
+          dropdown_placement_value: placement
+        }.merge(options[:data] || {})
         content_tag(:div, options, &block)
       end
 
       def dropdown_toggle(options = {}, &block)
         options[:type] = 'button'
         options[:class] = ['btn'] + Array(options[:class])
-        options[:data] = { action: 'dropdown#toggle click@window->dropdown#hide' }.merge(options[:data] || {})
+        options[:data] = {
+          action: 'dropdown#toggle click@window->dropdown#hide',
+          dropdown_target: 'toggle'
+        }.merge(options[:data] || {})
         button_tag(options, &block)
       end
 
       def dropdown_menu(options = {}, &block)
         options[:class] = ['dropdown-container hidden'] + Array(options[:class])
+        options[:data] = {
+          dropdown_target: 'menu'
+        }.merge(options[:data] || {})
 
-        if options[:direction] == 'left'
-          options[:class] << 'dropdown-container-left'
-        elsif options[:direction] == 'top'
-          options[:class] << 'dropdown-container-top'
-        elsif options[:direction] == 'top-left'
-          options[:class] << 'dropdown-container-top dropdown-container-left'
-        end
-        options[:data] = { dropdown_target: 'menu' }.merge(options[:data] || {})
         content_tag(:div, options, &block)
       end
     end

data/app/helpers/spree/admin/navigation_helper.rb

@@ -248,7 +248,7 @@ module Spree
         end
 
         link_to url, class: 'd-flex align-items-center text-decoration-none' do
-          content_tag(:span, icon('chevron-left', class: 'mr-0'), class: 'btn hover-gray px-2 d-flex align-items-center') +
+          content_tag(:span, icon('chevron-left', class: 'mr-0'), class: 'btn hover-gray shadow-none px-2 d-flex align-items-center shadow-none') +
             content_tag(:span, label, class: 'font-size-base text-black')
         end
       end

data/app/helpers/spree/admin/orders_filters_helper.rb

@@ -2,6 +2,8 @@ module Spree
   module Admin
     module OrdersFiltersHelper
       def params_to_filters(search_params:, vendor: nil, user: nil)
+        return if search_params.blank?
+
         if search_params.is_a?(String)
           search_params = JSON.parse(search_params).deep_symbolize_keys
         end

data/app/javascript/spree/admin/application.js

@@ -35,7 +35,6 @@ if (typeof Stimulus === 'undefined') {
 import AutoSubmit from '@stimulus-components/auto-submit'
 import CheckboxSelectAll from 'stimulus-checkbox-select-all'
 import Dialog from "@stimulus-components/dialog"
-import Dropdown from '@stimulus-components/dropdown'
 import TextareaAutogrow from 'stimulus-textarea-autogrow'
 import Notification from 'stimulus-notification'
 import PasswordVisibility from 'stimulus-password-visibility'
@@ -56,6 +55,7 @@ import Clipboard from 'spree/admin/controllers/clipboard_controller'
 import CodeMirrorController from 'spree/admin/controllers/codemirror_controller'
 import ColorPaletteController from 'spree/admin/controllers/color_palette_controller'
 import ColorPickerController from 'spree/admin/controllers/color_picker_controller'
+import DropdownController from 'spree/admin/controllers/dropdown_controller'
 import FiltersController from 'spree/admin/controllers/filters_controller'
 import FontPickerController from 'spree/admin/controllers/font_picker_controller'
 import HighlightController from 'spree/admin/controllers/highlight_controller'
@@ -114,7 +114,7 @@ application.register('color-picker', ColorPickerController)
 application.register('dialog', Dialog)
 application.register('drawer', Dialog)
 application.register('disable-submit-button', DisableSubmitButtonController)
-application.register('dropdown', Dropdown)
+application.register('dropdown', DropdownController)
 application.register('enable-button', EnableButtonController)
 application.register('export-dialog', Dialog)
 application.register('filters', FiltersController)

data/app/javascript/spree/admin/controllers/dropdown_controller.js

@@ -0,0 +1,154 @@
+import {
+  autoUpdate,
+  computePosition,
+  flip,
+  offset,
+  shift,
+  size,
+} from "@floating-ui/dom"
+import { Controller } from "@hotwired/stimulus"
+
+export default class extends Controller {
+  static targets = ["menu", "toggle"]
+  static values = {
+    placement: { type: String, default: "bottom-start" },
+    offset: { type: Number, default: 4 },
+  }
+
+  connect() {
+    this._cleanup = null
+    this.boundUpdate = this.update.bind(this)
+    this._isOpen = false
+    this._toggleElement = null
+  }
+
+  disconnect() {
+    this.stopAutoUpdate()
+  }
+
+  toggle(event) {
+    event.preventDefault()
+    event.stopPropagation()
+
+    // Store the toggle element that triggered this action
+    this._toggleElement = event.currentTarget
+
+    if (this._isOpen) {
+      this.close()
+    } else {
+      this.open()
+    }
+  }
+
+  open() {
+    if (this._isOpen) return
+
+    this.menuTarget.classList.remove("hidden")
+    this._isOpen = true
+
+    // Start automatic positioning
+    this.startAutoUpdate()
+
+    // Add event listener to close on outside click
+    this._outsideClickHandler = this.handleOutsideClick.bind(this)
+    document.addEventListener("click", this._outsideClickHandler)
+
+    // Add event listener to close on escape key
+    this._escapeHandler = this.handleEscape.bind(this)
+    document.addEventListener("keydown", this._escapeHandler)
+  }
+
+  close() {
+    if (!this._isOpen) return
+
+    this.menuTarget.classList.add("hidden")
+    this._isOpen = false
+
+    // Stop automatic positioning
+    this.stopAutoUpdate()
+
+    // Remove event listeners
+    if (this._outsideClickHandler) {
+      document.removeEventListener("click", this._outsideClickHandler)
+      this._outsideClickHandler = null
+    }
+
+    if (this._escapeHandler) {
+      document.removeEventListener("keydown", this._escapeHandler)
+      this._escapeHandler = null
+    }
+  }
+
+  hide(event) {
+    // This method is called from the action: click@window->dropdown#hide
+    // Only close if clicking outside the dropdown element
+    if (!this.element.contains(event.target)) {
+      this.close()
+    }
+  }
+
+  handleOutsideClick(event) {
+    // Close dropdown if clicking outside
+    if (!this.element.contains(event.target)) {
+      this.close()
+    }
+  }
+
+  handleEscape(event) {
+    if (event.key === "Escape") {
+      this.close()
+    }
+  }
+
+  startAutoUpdate() {
+    if (!this._cleanup) {
+      const referenceElement = this.hasToggleTarget ? this.toggleTarget : (this._toggleElement || this.element)
+      this._cleanup = autoUpdate(
+        referenceElement,
+        this.menuTarget,
+        this.boundUpdate,
+      )
+    }
+  }
+
+  stopAutoUpdate() {
+    if (this._cleanup) {
+      this._cleanup()
+      this._cleanup = null
+    }
+  }
+
+  update() {
+    // Use the toggle target if available, or the stored toggle element, or fall back to the controller element
+    const referenceElement = this.hasToggleTarget ? this.toggleTarget : (this._toggleElement || this.element)
+
+    computePosition(referenceElement, this.menuTarget, {
+      placement: this.placementValue,
+      middleware: [
+        offset(this.offsetValue),
+        flip({
+          fallbackAxisSideDirection: "start",
+          padding: 8,
+        }),
+        shift({ padding: 8 }),
+        size({
+          apply({ availableWidth, availableHeight, elements }) {
+            // Ensure dropdown doesn't exceed viewport
+            Object.assign(elements.floating.style, {
+              maxWidth: `${availableWidth}px`,
+              maxHeight: `${availableHeight}px`,
+              overflow: "auto",
+            })
+          },
+          padding: 8,
+        }),
+      ],
+    }).then(({ x, y }) => {
+      Object.assign(this.menuTarget.style, {
+        left: `${x}px`,
+        top: `${y}px`,
+        position: "absolute",
+      })
+    })
+  }
+}