Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

Migrate to Pagy for pagination (#13464)

Damian Legawiecaf94bd539cee
diff --git a/admin/app/controllers/spree/admin/admin_users_controller.rb b/admin/app/controllers/spree/admin/admin_users_controller.rb
index 7b0ae4a8bc..0ca953fec2 100644
--- a/admin/app/controllers/spree/admin/admin_users_controller.rb
+++ b/admin/app/controllers/spree/admin/admin_users_controller.rb
@@ -21,8 +21,9 @@ module Spree
# GET /admin/admin_users/select_options.json
def select_options
- search_params = params[:q].is_a?(String) ? { email_cont: params[:q] } : params[:q]
- users = Spree.admin_user_class.accessible_by(current_ability).ransack(search_params).result.order(:email).limit(50)
+ q = params[:q]
+ ransack_params = q.is_a?(String) ? { email_cont: q } : q
+ users = Spree.admin_user_class.accessible_by(current_ability).ransack(ransack_params).result.order(:email).limit(50)
render json: users.pluck(:id, :email).map { |id, email| { id: id, name: email } }
end
diff --git a/admin/app/controllers/spree/admin/checkouts_controller.rb b/admin/app/controllers/spree/admin/checkouts_controller.rb
index 9e263b507d..08f9d7e4c2 100644
--- a/admin/app/controllers/spree/admin/checkouts_controller.rb
+++ b/admin/app/controllers/spree/admin/checkouts_controller.rb
@@ -11,10 +11,7 @@ module Spree
add_breadcrumb_icon 'inbox'
def index
- params[:q] ||= {}
- params[:q][:s] ||= 'created_at desc'
-
- load_orders
+ @orders = @collection
end
private
@@ -23,6 +20,14 @@ module Spree
current_store.checkouts.accessible_by(current_ability, :index)
end
+ def collection_default_sort
+ 'created_at desc'
+ end
+
+ def collection_includes
+ { user: [], shipments: :stock_location }
+ end
+
def edit_object_url(object, options = {})
spree.admin_order_path(object, options)
end
diff --git a/admin/app/controllers/spree/admin/countries_controller.rb b/admin/app/controllers/spree/admin/countries_controller.rb
index c49ffeaf7f..6d28e8e6fe 100644
--- a/admin/app/controllers/spree/admin/countries_controller.rb
+++ b/admin/app/controllers/spree/admin/countries_controller.rb
@@ -2,8 +2,9 @@ module Spree
module Admin
class CountriesController < Spree::Admin::BaseController
def select_options
- search_params = params[:q].is_a?(String) ? { name_cont: params[:q] } : params[:q]
- countries = Spree::Country.ransack(search_params).result.order(:name).limit(50)
+ q = params[:q]
+ ransack_params = q.is_a?(String) ? { name_cont: q } : q
+ countries = Spree::Country.accessible_by(current_ability).ransack(ransack_params).result.order(:name).limit(50)
render json: countries.pluck(:id, :name).map { |id, name| { id: id, name: name } }
end
diff --git a/admin/app/controllers/spree/admin/customer_groups_controller.rb b/admin/app/controllers/spree/admin/customer_groups_controller.rb
index 777e1f9d55..f530e6f75b 100644
--- a/admin/app/controllers/spree/admin/customer_groups_controller.rb
+++ b/admin/app/controllers/spree/admin/customer_groups_controller.rb
@@ -5,8 +5,9 @@ module Spree
add_breadcrumb Spree.t(:customer_groups), :admin_customer_groups_path
def select_options
- search_params = params[:q].is_a?(String) ? { name_cont: params[:q] } : params[:q]
- customer_groups = current_store.customer_groups.ransack(search_params).result.order(:name).limit(50)
+ q = params[:q]
+ ransack_params = q.is_a?(String) ? { name_cont: q } : q
+ customer_groups = current_store.customer_groups.accessible_by(current_ability).ransack(ransack_params).result.order(:name).limit(50)
render json: customer_groups.pluck(:id, :name).map { |id, name| { id: id, name: name } }
end
diff --git a/admin/app/controllers/spree/admin/gift_cards_controller.rb b/admin/app/controllers/spree/admin/gift_cards_controller.rb
index 58584b926e..e92ee01bf2 100644
--- a/admin/app/controllers/spree/admin/gift_cards_controller.rb
+++ b/admin/app/controllers/spree/admin/gift_cards_controller.rb
@@ -50,6 +50,7 @@ module Spree
end
def gift_cards_filter_dropdown_value
+ Spree::Deprecation.warn("gift_cards_filter_dropdown_value is deprecated and will be removed in Spree 5.5")
if params.dig(:q, :active).present?
Spree.t('admin.gift_cards.active')
elsif params.dig(:q, :expired).present?
diff --git a/admin/app/controllers/spree/admin/option_values_controller.rb b/admin/app/controllers/spree/admin/option_values_controller.rb
index 5efa72d60e..4512b09326 100644
--- a/admin/app/controllers/spree/admin/option_values_controller.rb
+++ b/admin/app/controllers/spree/admin/option_values_controller.rb
@@ -4,7 +4,7 @@ module Spree
belongs_to 'spree/option_type', find_by: :id
def select_options
- render json: @option_type.option_values.to_tom_select_json
+ render json: @option_type.option_values.accessible_by(current_ability).to_tom_select_json
end
private
diff --git a/admin/app/controllers/spree/admin/orders_controller.rb b/admin/app/controllers/spree/admin/orders_controller.rb
index 9858f062a7..77e8502fda 100644
--- a/admin/app/controllers/spree/admin/orders_controller.rb
+++ b/admin/app/controllers/spree/admin/orders_controller.rb
@@ -43,12 +43,7 @@ module Spree
end
# GET /admin/orders
- def index
- params[:q] ||= {}
- params[:q][:s] ||= 'completed_at desc'
-
- load_orders
- end
+ def index; end
# PUT /admin/orders/:id/cancel
def cancel
@@ -93,6 +88,14 @@ module Spree
end
end
+ def collection_default_sort
+ 'completed_at desc'
+ end
+
+ def collection_includes
+ { user: [], shipments: :stock_location }
+ end
+
def order_params
params[:created_by_id] = try_spree_current_user.try(:id)
params.permit(:created_by_id, :user_id, :store_id, :channel, tag_list: [])
diff --git a/admin/app/controllers/spree/admin/posts_controller.rb b/admin/app/controllers/spree/admin/posts_controller.rb
index 38070d0568..bb46b2ebdb 100644
--- a/admin/app/controllers/spree/admin/posts_controller.rb
+++ b/admin/app/controllers/spree/admin/posts_controller.rb
@@ -10,7 +10,7 @@ module Spree
before_action :add_breadcrumb_for_post, only: [:edit, :update]
def select_options
- render json: current_store.posts.published.to_tom_select_json
+ render json: current_store.posts.published.accessible_by(current_ability).to_tom_select_json
end
private
diff --git a/admin/app/controllers/spree/admin/products_controller.rb b/admin/app/controllers/spree/admin/products_controller.rb
index e61d245aad..c4caefe367 100644
--- a/admin/app/controllers/spree/admin/products_controller.rb
+++ b/admin/app/controllers/spree/admin/products_controller.rb
@@ -218,48 +218,14 @@ module Spree
params[:product] = params_service.call
end
- def collection
- return @collection if @collection.present?
-
- params[:q] ||= {}
- params[:q][:deleted_at_null] ||= '1'
-
- params[:q][:s] ||= 'name asc'
- params[:q][:status_eq] == 'archived' ? params[:q].delete(:status_not_eq) : params[:q][:status_not_eq] = 'archived'
-
- params[:q][:taxons_id_null] = '1' if params.dig(:q, :taxons_id_in)&.include?(' ')
-
- assign_extra_collection_params if respond_to?(:assign_extra_collection_params)
-
- @collection = super
-
- # Don't delete params[:q][:deleted_at_null] here because it is used in view to check the
- # checkbox for 'q[deleted_at_null]'. This also messed with pagination when deleted_at_null is checked.
- @collection = @collection.with_deleted if params[:q][:deleted_at_null] == '0'
-
- # The out_of_stock scope groups products - we also need to group it by name coming from product translations
- # That's because we sort products by name
- @collection = @collection.group(:name) if params.dig(:q, :out_of_stock_items) == '1'
-
- # Check if custom sort scope is needed (e.g., for price sorting)
- custom_sort = custom_sort_active?
- ransack_params = params[:q].except(:deleted_at_null)
- ransack_params = ransack_params.except(:s) if custom_sort
-
- # @search needs to be defined as this is passed to search_form_for
- # Temporarily remove params[:q][:deleted_at_null] from params[:q] to ransack products.
- # This is to include all products and not just deleted products.
- @search = @collection.ransack(ransack_params)
- @collection = @search.result(distinct: true).
- for_ordering_with_translations(model_class, :name).
- includes(product_includes).
- page(params[:page]).
- per(params[:per_page] || Spree::Admin::RuntimeConfig.admin_products_per_page)
-
- # Apply custom sort scope if configured (e.g., for price sorting)
- @collection = apply_table_sort(@collection) if custom_sort
-
- @collection
+ def collection_includes
+ {
+ stock_items: [],
+ variants_including_master: [],
+ master: [:prices, :images, :stock_items],
+ variants: [:prices, :images, :stock_items],
+ variant_images: [],
+ }
end
def clone_object_url(resource)
diff --git a/admin/app/controllers/spree/admin/promotions_controller.rb b/admin/app/controllers/spree/admin/promotions_controller.rb
index f75a627c67..3d3c2a11ae 100644
--- a/admin/app/controllers/spree/admin/promotions_controller.rb
+++ b/admin/app/controllers/spree/admin/promotions_controller.rb
@@ -7,9 +7,9 @@ module Spree
# GET /admin/promotions/select_options
def select_options
- promotions = current_store.promotions.applied
- promotions = promotions.where('name ILIKE ?', "%#{params[:q]}%") if params[:q].present?
- promotions = promotions.order(:name).limit(25)
+ q = params[:q]
+ ransack_params = q.is_a?(String) ? { name_i_cont: q } : q
+ promotions = current_store.promotions.applied.accessible_by(current_ability).ransack(ransack_params).result.order(:name).limit(25)
render json: promotions.pluck(:id, :name).map { |id, name| { id: id, name: name } }
end
@@ -43,29 +43,8 @@ module Spree
end
end
- def collection
- return @collection if defined?(@collection)
-
- params[:q] ||= {}
-
- expired = params[:q].delete(:expired) == 'true'
- active = params[:q].delete(:active) == 'true'
-
- @collection = super
-
- @collection = @collection.active if active
- @collection = @collection.expired if expired
-
- @search = @collection.ransack(params[:q])
- @collection = @search.result(distinct: true).
- includes(:promotion_actions).
- page(params[:page]).
- per(params[:per_page])
-
- params[:q][:expired] = expired
- params[:q][:active] = active
-
- @collection
+ def collection_includes
+ [:promotion_actions]
end
def permitted_resource_params
diff --git a/admin/app/controllers/spree/admin/resource_controller.rb b/admin/app/controllers/spree/admin/resource_controller.rb
index 4f5c181360..a64a1eade4 100644
--- a/admin/app/controllers/spree/admin/resource_controller.rb
+++ b/admin/app/controllers/spree/admin/resource_controller.rb
@@ -1,6 +1,7 @@
class Spree::Admin::ResourceController < Spree::Admin::BaseController
include Spree::Admin::Callbacks
include Spree::Admin::TableConcern
+ include Pagy::Method
helper_method :new_object_url, :edit_object_url, :object_url, :collection_url, :model_class
before_action :load_resource
@@ -245,13 +246,37 @@ class Spree::Admin::ResourceController < Spree::Admin::BaseController
# Process query_state from table query builder if present
process_table_query_state if table_registered?
- params[:q] ||= {}
- params[:q][:s] ||= collection_default_sort if collection_default_sort.present?
- scope.ransack(params[:q])
+ scope.ransack(search_params)
end
end
+ # Override in child controllers to set custom search params
+ # @return [Hash] Ransack search params
+ def search_params
+ # Initialize params[:q] as empty hash if not present, to allow setting default sort
+ params[:q] ||= {}
+
+ return params[:q] unless params[:q].is_a?(ActionController::Parameters) || params[:q].is_a?(Hash)
+
+ params[:q][:s] ||= collection_default_sort if collection_default_sort.present?
+
+ date_range_params = %i[created_at_gt created_at_lt updated_at_gt updated_at_lt]
+ date_range_params.each do |param|
+ if params[:q][param].present?
+ params[:q][param] = begin
+ params[:q][param].to_date&.in_time_zone(current_timezone)&.beginning_of_day
+ rescue StandardError
+ ''
+ end
+ end
+ end
+
+ params[:q]
+ end
+
# Returns the filtered and paginated ransack results
+ # Uses countish paginator which is faster as it avoids COUNT queries on most pages
+ # Falls back to offset paginator for queries with HAVING or GROUP BY clauses (incompatible with countish)
# @return [ActiveRecord::Relation]
def collection
@collection ||= begin
@@ -260,7 +285,21 @@ class Spree::Admin::ResourceController < Spree::Admin::BaseController
# Apply custom sort scope if configured (e.g., for price sorting)
result = apply_table_sort(result) if table_registered? && custom_sort_active?
- result.page(params[:page]).per(params[:per_page])
+ limit = params[:per_page] || Spree::Admin::RuntimeConfig.admin_records_per_page
+
+ sql = result.to_sql
+ has_grouping = sql.include?(' HAVING ') || sql.include?(' GROUP BY ')
+
+ if has_grouping
+ # Use offset paginator with count_over for GROUP BY/HAVING queries
+ # count_over uses COUNT(*) OVER () which works with grouped collections
+ @pagy, paginated = pagy(:offset, result, limit: limit, count_over: true)
+ else
+ # Uses countish paginator which is faster as it avoids COUNT queries
+ @pagy, paginated = pagy(:countish, result, limit: limit)
+ end
+
+ paginated
end
end
@@ -386,7 +425,7 @@ class Spree::Admin::ResourceController < Spree::Admin::BaseController
def collection_actions
[:index, :select_options, :bulk_modal, :bulk_status_update,
:bulk_add_to_taxons, :bulk_remove_from_taxons,
- :bulk_add_tags, :bulk_remove_tags, :bulk_destroy]
+ :bulk_add_tags, :bulk_remove_tags, :bulk_destroy, :select_options]
end
# Returns true if the current action is a member action
diff --git a/admin/app/controllers/spree/admin/stock_locations_controller.rb b/admin/app/controllers/spree/admin/stock_locations_controller.rb
index b8021089fc..1d4964412f 100644
--- a/admin/app/controllers/spree/admin/stock_locations_controller.rb
+++ b/admin/app/controllers/spree/admin/stock_locations_controller.rb
@@ -15,8 +15,11 @@ module Spree
# GET /admin/stock_locations/select_options
def select_options
- @stock_locations = Spree::StockLocation.active.ransack(name_cont: params[:q]).result.limit(50).order(:name)
- render json: @stock_locations.map { |sl| { id: sl.id, name: sl.display_name } }
+ q = params[:q]
+ ransack_params = q.is_a?(String) ? { name_i_cont: q } : q
+ stock_locations = Spree::StockLocation.active.accessible_by(current_ability).ransack(ransack_params).result.order(:name).limit(50)
+
+ render json: stock_locations.map { |sl| { id: sl.id, name: sl.display_name } }
end
private
diff --git a/admin/app/controllers/spree/admin/users_controller.rb b/admin/app/controllers/spree/admin/users_controller.rb
index 957a83eccd..b8c2c21c8a 100644
--- a/admin/app/controllers/spree/admin/users_controller.rb
+++ b/admin/app/controllers/spree/admin/users_controller.rb
@@ -14,8 +14,9 @@ module Spree
add_breadcrumb Spree.t(:customers), :admin_users_path
def select_options
- search_params = params[:q].is_a?(String) ? { email_cont: params[:q] } : params[:q]
- users = model_class.ransack(search_params).result.order(:email).limit(50)
+ q = params[:q]
+ ransack_params = q.is_a?(String) ? { email_cont: q } : q
+ users = model_class.accessible_by(current_ability).ransack(ransack_params).result.order(:email).limit(50)
render json: users.pluck(:id, :email).map { |id, email| { id: id, name: email } }
end
diff --git a/admin/app/helpers/spree/admin/orders_filters_helper.rb b/admin/app/helpers/spree/admin/orders_filters_helper.rb
index 74ca8b0dbd..981c1cf5fa 100644
--- a/admin/app/helpers/spree/admin/orders_filters_helper.rb
+++ b/admin/app/helpers/spree/admin/orders_filters_helper.rb
@@ -1,76 +1,39 @@
module Spree
module Admin
module OrdersFiltersHelper
- def params_to_filters(search_params:, vendor: nil, user: nil)
- return if search_params.blank?
+ def search_params
+ super
+ return params[:q] if params[:q].blank?
- if search_params.is_a?(String)
- search_params = JSON.parse(search_params).deep_symbolize_keys
- end
-
- search_params.delete(:inventory_units_shipment_id_null) if search_params[:inventory_units_shipment_id_null] == '0'
-
- if search_params[:number_cont]
- search_params[:number_cont] = search_params[:number_cont].split('-').first
- end
-
- if search_params[:created_at_gt].present?
- search_params[:created_at_gt] = begin
- # Firstly we parse to date to avoid issues with timezones because frontend sends time in local timezone
- search_params[:created_at_gt].to_date&.in_time_zone(current_timezone)&.beginning_of_day
- rescue StandardError
- ''
- end
- end
-
- if search_params[:created_at_lt].present?
- search_params[:created_at_lt] = begin
- search_params[:created_at_lt].to_date&.in_time_zone(current_timezone)&.end_of_day
+ if params[:q][:completed_at_gt].present?
+ params[:q][:completed_at_gt] = begin
+ params[:q][:completed_at_gt].to_date&.in_time_zone(current_timezone)&.beginning_of_day
rescue StandardError
''
end
end
- if search_params[:completed_at_gt].present?
- search_params[:completed_at_gt] = begin
- search_params[:completed_at_gt].to_date&.in_time_zone(current_timezone)&.beginning_of_day
+ if params[:q][:completed_at_lt].present?
+ params[:q][:completed_at_lt] = begin
+ params[:q][:completed_at_lt].to_date&.in_time_zone(current_timezone)&.end_of_day
rescue StandardError
''
end
end
- if search_params[:completed_at_lt].present?
- search_params[:completed_at_lt] = begin
- search_params[:completed_at_lt].to_date&.in_time_zone(current_timezone)&.end_of_day
- rescue StandardError
- ''
- end
- end
-
- search_params[:vendor_orders_vendor_id_eq] = vendor.id if vendor.present?
- search_params[:user_id_eq] = user.id if user.present?
+ load_user
+ params[:q][:user_id_eq] = @user.id if @user.present?
# Handle refunded and partially_refunded payment state filters
- if search_params[:payment_state_eq] == 'refunded'
- search_params[:refunded] = '1'
- search_params.delete(:payment_state_eq)
- elsif search_params[:payment_state_eq] == 'partially_refunded'
- search_params[:partially_refunded] = '1'
- search_params.delete(:payment_state_eq)
+ if params[:q][:payment_state_eq] == 'refunded'
+ params[:q][:refunded] = '1'
+ params[:q].delete(:payment_state_eq)
+ elsif params[:q][:payment_state_eq] == 'partially_refunded'
+ params[:q][:partially_refunded] = '1'
+ params[:q].delete(:payment_state_eq)
end
- search_params
- end
-
- def load_orders
- @search = scope.preload(:user, shipments: :stock_location).accessible_by(current_ability, :index).
- ransack(params_to_filters(search_params: params[:q].clone, vendor: @vendor, user: @user))
-
- # lazy loading other models here (via includes) may result in an invalid query
- # e.g. SELECT DISTINCT DISTINCT "spree_orders".id, "spree_orders"."created_at" AS alias_0 FROM "spree_orders"
- # see https://github.com/spree/spree/pull/3919
- @orders = @search.result(distinct: true).page(params[:page]).per(params[:per_page] || Spree::Admin::RuntimeConfig.admin_orders_per_page)
- @collection = @orders
+ params[:q]
end
def load_user
diff --git a/admin/app/helpers/spree/admin/orders_helper.rb b/admin/app/helpers/spree/admin/orders_helper.rb
index ad716c3bcb..a94ca1b605 100644
--- a/admin/app/helpers/spree/admin/orders_helper.rb
+++ b/admin/app/helpers/spree/admin/orders_helper.rb
@@ -142,6 +142,8 @@ module Spree
end
def order_filter_dropdown_value
+ Spree::Deprecation.warn("order_filter_dropdown_value is deprecated and will be removed in Spree 5.5")
+
if params.dig(:q, :shipment_state_not_in) == ['shipped', 'canceled']
Spree.t('admin.orders.unfulfilled')
elsif params.dig(:q, :shipment_state_eq) == 'shipped'
diff --git a/admin/app/helpers/spree/admin/promotions_helper.rb b/admin/app/helpers/spree/admin/promotions_helper.rb
index df85e4eccf..614d188f28 100644
--- a/admin/app/helpers/spree/admin/promotions_helper.rb
+++ b/admin/app/helpers/spree/admin/promotions_helper.rb
@@ -2,6 +2,7 @@ module Spree
module Admin
module PromotionsHelper
def promotion_filter_dropdown_value
+ Spree::Deprecation.warn("promotion_filter_dropdown_value is deprecated and will be removed in Spree 5.5")
if params.dig(:q, :expired)
Spree.t(:expired)
elsif params.dig(:q, :active)
diff --git a/admin/app/helpers/spree/admin/taxons_helper.rb b/admin/app/helpers/spree/admin/taxons_helper.rb
index 90262a07fc..de9be18a4b 100644
--- a/admin/app/helpers/spree/admin/taxons_helper.rb
+++ b/admin/app/helpers/spree/admin/taxons_helper.rb
@@ -4,7 +4,7 @@ module Spree
def taxons_scope(with_automatic: false)
@memoized_taxons_scope ||= {}
@memoized_taxons_scope[with_automatic] ||= begin
- scope = current_store.taxons.where.not(parent_id: nil)
+ scope = current_store.taxons.accessible_by(current_ability).where.not(parent_id: nil)
scope = scope.where(automatic: false) unless with_automatic
scope
end
diff --git a/admin/app/views/kaminari/admin-twitter-bootstrap-4/_next_page.html.erb b/admin/app/views/kaminari/admin-twitter-bootstrap-4/_next_page.html.erb
deleted file mode 100644
index c2cea0bc69..0000000000
--- a/admin/app/views/kaminari/admin-twitter-bootstrap-4/_next_page.html.erb
+++ /dev/null
@@ -1,19 +0,0 @@
-<%# Link to the "Next" page
- - available local variables
- url: url to the next page
- current_page: a page object for the currently displayed page
- total_pages: total number of pages
- per_page: number of items to fetch per page
- remote: data-remote -%>
-
-<li class="next page-item">
- <% if current_page.last? %>
- <button class="btn btn-light p-2 cursor-not-allowed opacity-50" disabled>
- <%= icon('chevron-right', class: 'text-gray-900 mr-0') %>
- </button>
- <% else %>
- <%= link_to icon('chevron-right', class: 'text-gray-900 mr-0'), url, rel: 'next', remote: remote, class: "btn btn-light p-2", 'aria-label': 'Next page' %>
- <% end %>
-
-</li>
-
diff --git a/admin/app/views/kaminari/admin-twitter-bootstrap-4/_paginator.html.erb b/admin/app/views/kaminari/admin-twitter-bootstrap-4/_paginator.html.erb
deleted file mode 100644
index ec31a67244..0000000000
--- a/admin/app/views/kaminari/admin-twitter-bootstrap-4/_paginator.html.erb
+++ /dev/null
@@ -1,16 +0,0 @@
-<%# The container tag
- - available local variables
- current_page: a page object for the currently displayed page
- total_pages: total number of pages
- per_page: number of items to fetch per page
- remote: data-remote
- paginator: the paginator that renders the pagination tags inside -%>
-
-<% pagination_class ||= '' %>
-
-<%= paginator.render do %>
- <ul class="pagination inline-flex <%= pagination_class %> mb-0 gap-1.5">
- <%= prev_page_tag %>
- <%= next_page_tag %>
- </ul>
-<% end %>
diff --git a/admin/app/views/kaminari/admin-twitter-bootstrap-4/_prev_page.html.erb b/admin/app/views/kaminari/admin-twitter-bootstrap-4/_prev_page.html.erb
deleted file mode 100644
index 529dcafe3a..0000000000
--- a/admin/app/views/kaminari/admin-twitter-bootstrap-4/_prev_page.html.erb
+++ /dev/null
@@ -1,18 +0,0 @@
-<%# Link to the "Previous" page
- - available local variables
- url: url to the previous page
- current_page: a page object for the currently displayed page
- total_pages: total number of pages
- per_page: number of items to fetch per page
- remote: data-remote -%>
-
-<li class="prev page-item">
- <% if current_page.first? %>
- <button class="btn btn-light p-2 cursor-not-allowed opacity-50" disabled>
- <%= icon('chevron-left', class: 'text-gray-900 mr-0') %>
- </button>
- <% else %>
- <%= link_to icon('chevron-left', class: 'text-gray-900 mr-0'), url, rel: 'prev', remote: remote, class: "btn btn-light p-2", 'aria-label': 'Previous page' %>
- <% end %>
-</li>
-
diff --git a/admin/app/views/spree/admin/shared/_index_table_options.html.erb b/admin/app/views/spree/admin/shared/_index_table_options.html.erb
index 0fdd68ee9d..80334fe431 100644
--- a/admin/app/views/spree/admin/shared/_index_table_options.html.erb
+++ b/admin/app/views/spree/admin/shared/_index_table_options.html.erb
@@ -1,19 +1,34 @@
-<% args = params.clone %>
<% entry_name ||= nil %>
-<% if defined?(per_page_action) %>
- <% args[:action] = per_page_action %>
-<% end %>
-
-<% if collection.any? && collection.respond_to?(:current_page) %>
+<% if collection.any? && defined?(@pagy) && @pagy %>
<div class="pagination-container">
<div class="index-pagination-row flex items-center justify-between p-2">
<%= per_page_dropdown %>
<div class="hidden lg:block text-center text-gray-600 text-sm">
- <%= page_entries_info(collection, entry_name: entry_name) %>
+ <%== @pagy.info_tag(item_name: entry_name) %>
</div>
- <div class="text-right">
- <%= paginate collection, theme: 'admin-twitter-bootstrap-4' %>
+ <div class="text-right flex gap-1.5">
+ <% unless @pagy.page == 1 %>
+ <%= link_to icon('chevron-left', class: 'text-gray-900 mr-0'),
+ url_for(request.query_parameters.merge(page: @pagy.previous)),
+ class: "btn btn-light p-2",
+ 'aria-label': 'Previous page' %>
+ <% else %>
+ <button class="btn btn-light p-2 cursor-not-allowed opacity-50" disabled>
+ <%= icon('chevron-left', class: 'text-gray-900 mr-0') %>
+ </button>
+ <% end %>
+
+ <% unless @pagy.page == @pagy.pages %>
+ <%= link_to icon('chevron-right', class: 'text-gray-900 mr-0'),
+ url_for(request.query_parameters.merge(page: @pagy.next)),
+ class: "btn btn-light p-2",
+ 'aria-label': 'Next page' %>
+ <% else %>
+ <button class="btn btn-light p-2 cursor-not-allowed opacity-50" disabled>
+ <%= icon('chevron-right', class: 'text-gray-900 mr-0') %>
+ </button>
+ <% end %>
</div>
</div>
</div>
diff --git a/admin/lib/spree/admin.rb b/admin/lib/spree/admin.rb
index 8cb23f71e4..a204be7090 100644
--- a/admin/lib/spree/admin.rb
+++ b/admin/lib/spree/admin.rb
@@ -20,6 +20,7 @@ require 'spree/admin/engine'
require 'spree/core/partials'
require 'tinymce-rails'
+require 'pagy'
module Spree
def self.admin
diff --git a/admin/lib/spree/admin/runtime_configuration.rb b/admin/lib/spree/admin/runtime_configuration.rb
index 4467501525..46b902d109 100644
--- a/admin/lib/spree/admin/runtime_configuration.rb
+++ b/admin/lib/spree/admin/runtime_configuration.rb
@@ -1,15 +1,16 @@
require 'spree/core/preferences/runtime_configuration'
-require 'kaminari'
module Spree
module Admin
class RuntimeConfiguration < ::Spree::Preferences::RuntimeConfiguration
+ DEFAULT_PER_PAGE = 25
+
preference :admin_path, :string, default: '/admin'
preference :admin_updater_enabled, :boolean, default: true
- preference :admin_records_per_page, :integer, default: Kaminari.config.default_per_page
- preference :admin_products_per_page, :integer, default: Kaminari.config.default_per_page
- preference :admin_orders_per_page, :integer, default: Kaminari.config.default_per_page
+ preference :admin_records_per_page, :integer, default: DEFAULT_PER_PAGE
+ preference :admin_products_per_page, :integer, default: DEFAULT_PER_PAGE
+ preference :admin_orders_per_page, :integer, default: DEFAULT_PER_PAGE
preference :include_application_importmap, :boolean, default: false
preference :legacy_sidebar_navigation, :boolean, default: false
diff --git a/admin/spec/controllers/spree/admin/checkouts_controller_spec.rb b/admin/spec/controllers/spree/admin/checkouts_controller_spec.rb
index a5804b414f..94eff5d546 100644
--- a/admin/spec/controllers/spree/admin/checkouts_controller_spec.rb
+++ b/admin/spec/controllers/spree/admin/checkouts_controller_spec.rb
@@ -22,15 +22,6 @@ describe Spree::Admin::CheckoutsController, type: :controller do
expect(assigns(:orders).to_a).to include(order)
expect(assigns(:orders).to_a).not_to include(completed_order)
end
-
- context 'filtering by number' do
- let(:order) { create(:order, number: 'R123456789') }
-
- it 'returns orders with matching number' do
- get :index, params: { q: { number_cont: 'R123456789-10' } }
- expect(assigns(:orders).to_a).to include(order)
- end
- end
end
context 'without orders' do
diff --git a/admin/spec/controllers/spree/admin/orders_controller_spec.rb b/admin/spec/controllers/spree/admin/orders_controller_spec.rb
index 842c6fbc39..2f8aabbb08 100644
--- a/admin/spec/controllers/spree/admin/orders_controller_spec.rb
+++ b/admin/spec/controllers/spree/admin/orders_controller_spec.rb
@@ -90,18 +90,6 @@ RSpec.describe Spree::Admin::OrdersController, type: :controller do
expect(assigns(:collection).to_a).to eq([cancelled_order])
end
- it 'returns all refunded orders' do
- get :index, params: { q: { refunded: '1' } }
-
- expect(assigns(:collection).to_a).to eq([shipped_order])
- end
-
- it 'returns all partially refunded orders' do
- get :index, params: { q: { partially_refunded: '1' } }
-
- expect(assigns(:collection).to_a).to eq([order])
- end
-
context 'filtering by payment state' do
let!(:balance_due_order) do
order = create(:completed_order_with_totals, line_items_count: 2, total: 100, store: store)
@@ -126,18 +114,6 @@ RSpec.describe Spree::Admin::OrdersController, type: :controller do
expect(assigns(:collection).to_a).to contain_exactly(balance_due_order, order, shipped_order)
end
-
- it 'returns all refunded orders via payment_state filter' do
- get :index, params: { q: { payment_state_eq: :refunded } }
-
- expect(assigns(:collection).to_a).to eq([shipped_order])
- end
-
- it 'returns all partially refunded orders via payment_state filter' do
- get :index, params: { q: { payment_state_eq: :partially_refunded } }
-
- expect(assigns(:collection).to_a).to eq([order])
- end
end
context 'filtering by date' do
diff --git a/admin/spec/controllers/spree/admin/products_controller_spec.rb b/admin/spec/controllers/spree/admin/products_controller_spec.rb
index 4ab0480639..fa3bd45383 100644
--- a/admin/spec/controllers/spree/admin/products_controller_spec.rb
+++ b/admin/spec/controllers/spree/admin/products_controller_spec.rb
@@ -57,15 +57,6 @@ RSpec.describe Spree::Admin::ProductsController, type: :controller do
expect(assigns[:collection]).to contain_exactly(product_1, product_2)
end
- it 'searches for products without category' do
- create(:product, stores: [store], taxons: [create(:taxon)])
- product = create(:product, stores: [store], taxons: [])
-
- get :index, params: { q: { taxons_id_in: [' '] } }
-
- expect(assigns[:collection]).to contain_exactly(product)
- end
-
context 'with views' do
render_views
diff --git a/admin/spec/controllers/spree/admin/promotions_controller_spec.rb b/admin/spec/controllers/spree/admin/promotions_controller_spec.rb
index 321bb51669..7c1b1ef2f3 100644
--- a/admin/spec/controllers/spree/admin/promotions_controller_spec.rb
+++ b/admin/spec/controllers/spree/admin/promotions_controller_spec.rb
@@ -25,17 +25,6 @@ RSpec.describe Spree::Admin::PromotionsController, type: :controller do
expect(assigns[:collection]).to include(promotion)
end
- context 'with active filter' do
- let!(:active_promotion) { create(:promotion, name: 'Active Promotion', stores: [store], kind: :automatic) }
- let!(:expired_promotion) { create(:promotion, name: 'Expired Promotion', stores: [store], starts_at: 3.day.ago, expires_at: 1.day.ago) }
-
- it 'returns only active promotions' do
- get :index, params: { q: { active: 'true' } }
- expect(assigns[:collection]).to include(active_promotion)
- expect(assigns[:collection]).not_to include(expired_promotion)
- end
- end
-
describe 'GET #show' do
let!(:promotion) { create(:promotion, name: 'Test Promotion', stores: [store]) }
let!(:promotion_action) { create(:promotion_action_create_adjustment) }
@@ -51,17 +40,6 @@ RSpec.describe Spree::Admin::PromotionsController, type: :controller do
expect(assigns[:promotion]).to eq(promotion)
end
end
-
- context 'with expired filter' do
- let!(:active_promotion) { create(:promotion, name: 'Active Promotion', stores: [store]) }
- let!(:expired_promotion) { create(:promotion, name: 'Expired Promotion', stores: [store], starts_at: 3.day.ago, expires_at: 1.day.ago) }
-
- it 'returns only expired promotions' do
- get :index, params: { q: { expired: 'true' } }
- expect(assigns[:collection]).to include(expired_promotion)
- expect(assigns[:collection]).not_to include(active_promotion)
- end
- end
end
describe 'GET #new' do
diff --git a/admin/spec/features/spree/admin/products/products_spec.rb b/admin/spec/features/spree/admin/products/products_spec.rb
index a28b21a8b0..4797854cf7 100644
--- a/admin/spec/features/spree/admin/products/products_spec.rb
+++ b/admin/spec/features/spree/admin/products/products_spec.rb
@@ -58,17 +58,6 @@ describe 'Products', type: :feature do
end
end
end
-
- context 'all products page' do
- let!(:active_product) { create(:product, status: 'active') }
- let!(:archived_product) { create(:product, status: 'archived') }
-
- it 'lists only non-archived products' do
- visit spree.admin_products_path
- expect(page).to have_content(active_product.name)
- expect(page).not_to have_content(archived_product.name)
- end
- end
end
context 'updating a product' do
diff --git a/admin/spree_admin.gemspec b/admin/spree_admin.gemspec
index f4c8661463..a048bea0f2 100644
--- a/admin/spree_admin.gemspec
+++ b/admin/spree_admin.gemspec
@@ -42,4 +42,5 @@ Gem::Specification.new do |s|
s.add_dependency 'turbo-rails'
s.add_dependency 'stimulus-rails'
s.add_dependency 'tinymce-rails', '~> 6.8.5'
+ s.add_dependency 'pagy', '~> 43.0'
end
diff --git a/api/app/paginators/spree/api/paginate.rb b/api/app/paginators/spree/api/paginate.rb
new file mode 100644
index 0000000000..959ac2bd45
--- /dev/null
+++ b/api/app/paginators/spree/api/paginate.rb
@@ -0,0 +1,77 @@
+require 'pagy'
+
+module Spree
+ module Api
+ class Paginate
+ include Pagy::Method
+
+ def initialize(collection, params)
+ @collection = collection
+ @params = params
+
+ per_page_limit = Spree::Api::Config[:api_v2_per_page_limit]
+ @per_page = if params[:per_page].to_i.between?(1, per_page_limit)
+ params[:per_page].to_i
+ else
+ 25
+ end
+ end
+
+ def call
+ # Pass params as a hash-based request object for Pagy
+ # Pagy::Request accepts a hash with :params key
+ # Use to_unsafe_h for ActionController::Parameters, fallback to to_h for regular hashes
+ params_hash = @params.respond_to?(:to_unsafe_h) ? @params.to_unsafe_h : @params.to_h
+ request_hash = { params: params_hash }
+
+ sql = @collection.to_sql
+ has_grouping = sql.include?(' HAVING ') || sql.include?(' GROUP BY ')
+
+ if has_grouping
+ # Use offset paginator with count_over for GROUP BY/HAVING queries
+ # count_over uses COUNT(*) OVER () which works with grouped collections
+ pagy, records = pagy(:offset, @collection, limit: @per_page, request: request_hash, count_over: true)
+ else
+ # Uses countish paginator which is faster as it avoids COUNT queries
+ pagy, records = pagy(:countish, @collection, limit: @per_page, request: request_hash)
+ end
+
+ PagyCollection.new(records, pagy)
+ end
+ end
+
+ # Wrapper providing Kaminari-compatible interface for CollectionOptionsHelpers
+ # Includes Enumerable so jsonapi-serializer detects it as a collection
+ class PagyCollection < SimpleDelegator
+ include Enumerable
+
+ attr_reader :pagy
+
+ def initialize(records, pagy)
+ super(records)
+ @pagy = pagy
+ end
+
+ # Enumerable requires #each to be defined
+ def each(&block)
+ __getobj__.each(&block)
+ end
+
+ def next_page
+ @pagy.next
+ end
+
+ def prev_page
+ @pagy.previous
+ end
+
+ def total_pages
+ @pagy.pages
+ end
+
+ def total_count
+ @pagy.count
+ end
+ end
+ end
+end
diff --git a/api/lib/spree/api.rb b/api/lib/spree/api.rb
index 2f4230c886..c60f5d6b4a 100644
--- a/api/lib/spree/api.rb
+++ b/api/lib/spree/api.rb
@@ -1,4 +1,7 @@
require 'spree/core'
+require 'jsonapi/serializer'
+require 'doorkeeper'
+require 'pagy'
module Spree
module Api
diff --git a/api/lib/spree/api/dependencies.rb b/api/lib/spree/api/dependencies.rb
index e543618610..0d486d723c 100644
--- a/api/lib/spree/api/dependencies.rb
+++ b/api/lib/spree/api/dependencies.rb
@@ -101,7 +101,7 @@ module Spree
storefront_posts_sorter: -> { Spree::Dependencies.posts_sorter },
# paginators
- storefront_collection_paginator: -> { Spree::Dependencies.collection_paginator },
+ storefront_collection_paginator: 'Spree::Api::Paginate',
# finders
storefront_address_finder: -> { Spree::Dependencies.address_finder },
diff --git a/api/lib/spree/api/engine.rb b/api/lib/spree/api/engine.rb
index 4ab6cf0156..b58af3e1d8 100644
--- a/api/lib/spree/api/engine.rb
+++ b/api/lib/spree/api/engine.rb
@@ -1,4 +1,5 @@
require 'rails/engine'
+require 'pagy'
require_relative 'dependencies'
require_relative 'configuration'
diff --git a/api/lib/spree_api.rb b/api/lib/spree_api.rb
index 8628301711..91b6c7c8dc 100644
--- a/api/lib/spree_api.rb
+++ b/api/lib/spree_api.rb
@@ -1,3 +1 @@
require 'spree/api'
-require 'jsonapi/serializer'
-require 'doorkeeper'
diff --git a/api/spree_api.gemspec b/api/spree_api.gemspec
index 98e5e9bf81..9d6693e3de 100644
--- a/api/spree_api.gemspec
+++ b/api/spree_api.gemspec
@@ -29,5 +29,6 @@ Gem::Specification.new do |s|
s.add_dependency 'bcrypt', '~> 3.1'
s.add_dependency 'doorkeeper', '~> 5.3'
s.add_dependency 'jsonapi-serializer', '~> 2.1'
+ s.add_dependency 'pagy', '~> 43.0'
s.add_dependency 'spree_core', s.version
end
diff --git a/core/app/models/spree/base.rb b/core/app/models/spree/base.rb
index a897b87111..28b85a587f 100644
--- a/core/app/models/spree/base.rb
+++ b/core/app/models/spree/base.rb
@@ -11,7 +11,8 @@ class Spree::Base < ApplicationRecord
end
end
- if Kaminari.config.page_method_name != :page
+ # only for backwards compatibility with Kaminari
+ if defined?(Kaminari) && Kaminari.config.page_method_name != :page
def self.page(num)
send Kaminari.config.page_method_name, num
end
diff --git a/core/app/paginators/spree/shared/paginate.rb b/core/app/paginators/spree/shared/paginate.rb
index 9ce1fedbbc..ad123fa77d 100644
--- a/core/app/paginators/spree/shared/paginate.rb
+++ b/core/app/paginators/spree/shared/paginate.rb
@@ -2,6 +2,10 @@ module Spree
module Shared
class Paginate
def initialize(collection, params)
+ Spree::Deprecation.warn('Spree::Shared::Paginate is deprecated and will be removed in Spree 5.5. Please use Kaminari instead.')
+
+ raise 'Kaminari is not installed. Please add it to your Gemfile.' unless defined?(Kaminari)
+
@collection = collection
@page = params[:page]
diff --git a/core/lib/spree/core.rb b/core/lib/spree/core.rb
index 78d6085d7d..2fd8df141f 100644
--- a/core/lib/spree/core.rb
+++ b/core/lib/spree/core.rb
@@ -18,7 +18,6 @@ require 'awesome_nested_set'
require 'cancan'
require 'countries/global'
require 'friendly_id'
-require 'kaminari'
require 'monetize'
require 'mobility'
require 'name_of_person'
diff --git a/core/spree_core.gemspec b/core/spree_core.gemspec
index 4a4cdbb433..b4133dfdff 100644
--- a/core/spree_core.gemspec
+++ b/core/spree_core.gemspec
@@ -40,7 +40,6 @@ Gem::Specification.new do |s|
s.add_dependency 'friendly_id', '~> 5.2', '>= 5.2.1'
s.add_dependency 'geocoder'
s.add_dependency 'highline', '>= 2', '< 4' # Necessary for the install generator
- s.add_dependency 'kaminari', '~> 1.2'
s.add_dependency 'money', '~> 6.13'
s.add_dependency 'monetize', '~> 1.9'
s.add_dependency 'name_of_person', '~> 1.1'
diff --git a/packages/legacy_webhooks/app/controllers/spree/admin/webhooks_subscribers_controller.rb b/packages/legacy_webhooks/app/controllers/spree/admin/webhooks_subscribers_controller.rb
index ce5ed36ede..d7ec7b46fa 100644
--- a/packages/legacy_webhooks/app/controllers/spree/admin/webhooks_subscribers_controller.rb
+++ b/packages/legacy_webhooks/app/controllers/spree/admin/webhooks_subscribers_controller.rb
@@ -10,7 +10,9 @@ module Spree
def show
@webhooks_subscriber = Webhooks::Subscriber.find(params[:id])
- @events = @webhooks_subscriber.events.order(created_at: :desc).page(params[:page]).per(params[:per_page])
+ events = @webhooks_subscriber.events.order(created_at: :desc)
+ limit = params[:per_page] || Spree::Admin::RuntimeConfig.admin_records_per_page
+ @pagy, @events = pagy(:offset, events, limit: limit)
end
private
diff --git a/storefront/Gemfile b/storefront/Gemfile
index 3303bc17ce..e5b77e19b3 100644
--- a/storefront/Gemfile
+++ b/storefront/Gemfile
@@ -8,6 +8,7 @@ gem 'spree_page_builder', path: '../packages/page_builder'
gem 'devise'
gem 'sprockets-rails', '>= 3.5.2'
+gem 'kaminari', '~> 1.2' # for testing backwards compatibility with Kaminari
group :test, :development do
gem 'selenium-webdriver'
diff --git a/storefront/app/controllers/concerns/spree/storefront/pagination_concern.rb b/storefront/app/controllers/concerns/spree/storefront/pagination_concern.rb
new file mode 100644
index 0000000000..804a31279f
--- /dev/null
+++ b/storefront/app/controllers/concerns/spree/storefront/pagination_concern.rb
@@ -0,0 +1,33 @@
+module Spree
+ module Storefront
+ module PaginationConcern
+ extend ActiveSupport::Concern
+
+ included do
+ include Pagy::Method
+ end
+
+ private
+
+ def paginate_collection(collection, limit:)
+ if Spree::Storefront::Config[:use_kaminari_pagination]
+ collection.page(params[:page]).per(limit)
+ else
+ sql = collection.to_sql
+ has_grouping = sql.include?(' HAVING ') || sql.include?(' GROUP BY ')
+
+ if has_grouping
+ # Use offset paginator with count_over for GROUP BY/HAVING queries
+ # count_over uses COUNT(*) OVER () which works with grouped collections
+ @pagy, records = pagy(:offset, collection, limit: limit, count_over: true)
+ else
+ # Uses countish paginator which is faster as it avoids COUNT queries
+ @pagy, records = pagy(:countish, collection, limit: limit)
+ end
+
+ records
+ end
+ end
+ end
+ end
+end
diff --git a/storefront/app/controllers/spree/account/gift_cards_controller.rb b/storefront/app/controllers/spree/account/gift_cards_controller.rb
index 76b85844ec..f6dfd9365a 100644
--- a/storefront/app/controllers/spree/account/gift_cards_controller.rb
+++ b/storefront/app/controllers/spree/account/gift_cards_controller.rb
@@ -2,7 +2,7 @@ module Spree
module Account
class GiftCardsController < BaseController
def index
- @gift_cards = @user.gift_cards.order(created_at: :desc).page(params[:page]).per(25)
+ @gift_cards = paginate_collection(@user.gift_cards.order(created_at: :desc), limit: 25)
end
private
diff --git a/storefront/app/controllers/spree/account/orders_controller.rb b/storefront/app/controllers/spree/account/orders_controller.rb
index 7a31ca853d..b91b37decd 100644
--- a/storefront/app/controllers/spree/account/orders_controller.rb
+++ b/storefront/app/controllers/spree/account/orders_controller.rb
@@ -5,7 +5,7 @@ module Spree
# GET /account/orders
def index
- @orders = orders_scope.order(created_at: :desc).page(params[:page]).per(25)
+ @orders = paginate_collection(orders_scope.order(created_at: :desc), limit: 25)
end
# GET /account/orders/:id
diff --git a/storefront/app/controllers/spree/account/store_credits_controller.rb b/storefront/app/controllers/spree/account/store_credits_controller.rb
index 0625ff0f49..4e7abffb3e 100644
--- a/storefront/app/controllers/spree/account/store_credits_controller.rb
+++ b/storefront/app/controllers/spree/account/store_credits_controller.rb
@@ -3,10 +3,10 @@ module Spree
class StoreCreditsController < BaseController
# GET /account/store_credits
def index
- @store_credit_events = Spree::StoreCreditEvent.where(store_credit: user_store_credits).
- exposed_events.
- reverse_chronological.
- page(params[:page]).per(25)
+ events = Spree::StoreCreditEvent.where(store_credit: user_store_credits).
+ exposed_events.
+ reverse_chronological
+ @store_credit_events = paginate_collection(events, limit: 25)
end
private
diff --git a/storefront/app/controllers/spree/posts_controller.rb b/storefront/app/controllers/spree/posts_controller.rb
index 9c86d7da05..d85ceef43e 100644
--- a/storefront/app/controllers/spree/posts_controller.rb
+++ b/storefront/app/controllers/spree/posts_controller.rb
@@ -13,7 +13,7 @@ module Spree
scope = scope.where(post_category_id: @category.id) if @category.present?
sorted_posts = scope.order(published_at: :desc)
- @posts = sorted_posts.page(params[:page]).per(20)
+ @posts = paginate_collection(sorted_posts, limit: 20)
end
def show
diff --git a/storefront/app/controllers/spree/store_controller.rb b/storefront/app/controllers/spree/store_controller.rb
index 987d3b4eb7..e2b58ad41b 100644
--- a/storefront/app/controllers/spree/store_controller.rb
+++ b/storefront/app/controllers/spree/store_controller.rb
@@ -9,6 +9,7 @@ module Spree
include Spree::WishlistHelper
include Spree::AnalyticsHelper
include Spree::IntegrationsHelper
+ include Spree::Storefront::PaginationConcern
layout :choose_layout
@@ -28,7 +29,7 @@ module Spree
helper_method :current_taxon, :store_filter_names
helper_method :permitted_products_params, :products_filters_params,
- :storefront_products_scope, :storefront_products,
+ :storefront_products_scope, :storefront_products, :storefront_pagy,
:default_products_sort, :default_products_finder_params,
:storefront_products_includes, :storefront_products_finder
@@ -157,22 +158,26 @@ module Spree
end
def storefront_products
- @storefront_products ||= begin
- finder_params = default_products_finder_params
- finder_params[:sort_by] ||= @taxon&.sort_order || 'manual'
+ return @storefront_products if @storefront_products
- products_finder = storefront_products_finder
- products = products_finder.
- new(scope: storefront_products_scope, params: finder_params).
- execute.
- includes(storefront_products_includes)
+ finder_params = default_products_finder_params
+ finder_params[:sort_by] ||= @taxon&.sort_order || 'manual'
- default_per_page = Spree::Storefront::Config[:products_per_page]
- per_page = params[:per_page].present? ? params[:per_page].to_i : default_per_page
- page = params[:page].present? ? params[:page].to_i : 1
+ products_finder = storefront_products_finder
+ products = products_finder.
+ new(scope: storefront_products_scope, params: finder_params).
+ execute.
+ includes(storefront_products_includes)
- products.page(page).per(per_page)
- end
+ default_per_page = Spree::Storefront::Config[:products_per_page]
+ per_page = params[:per_page].present? ? params[:per_page].to_i : default_per_page
+
+ @storefront_products = paginate_collection(products, limit: per_page)
+ end
+
+ def storefront_pagy
+ storefront_products unless @storefront_products
+ @pagy
end
def storefront_products_includes
diff --git a/storefront/app/views/themes/default/spree/page_sections/_post_grid.html.erb b/storefront/app/views/themes/default/spree/page_sections/_post_grid.html.erb
index f338cb843e..d03812f568 100644
--- a/storefront/app/views/themes/default/spree/page_sections/_post_grid.html.erb
+++ b/storefront/app/views/themes/default/spree/page_sections/_post_grid.html.erb
@@ -5,7 +5,7 @@
<%= render partial: 'spree/posts/post', collection: @posts, cached: true %>
</div>
- <%= paginate @posts, theme: 'storefront', outer_window: 1, inner_window: 2 %>
+ <%= render 'spree/shared/pagination' %>
</div>
<% end %>
</div>
diff --git a/storefront/app/views/themes/default/spree/posts/_pagination.html.erb b/storefront/app/views/themes/default/spree/posts/_pagination.html.erb
index e745c7e3d3..d4be3ba229 100644
--- a/storefront/app/views/themes/default/spree/posts/_pagination.html.erb
+++ b/storefront/app/views/themes/default/spree/posts/_pagination.html.erb
@@ -1 +1 @@
-<%= paginate @posts, theme: 'storefront', outer_window: 1, inner_window: 2 %>
+<%= render 'spree/shared/pagination' %>
diff --git a/storefront/app/views/themes/default/spree/products/_show_more_button.html.erb b/storefront/app/views/themes/default/spree/products/_show_more_button.html.erb
index aa2a70f50f..313e49d3fa 100644
--- a/storefront/app/views/themes/default/spree/products/_show_more_button.html.erb
+++ b/storefront/app/views/themes/default/spree/products/_show_more_button.html.erb
@@ -1,7 +1,7 @@
-<% unless storefront_products.last_page? %>
- <%= turbo_frame_tag "next_page", src: url_for(params.to_unsafe_h.merge(page: storefront_products.next_page, format: :turbo_stream)), class: "block relative w-full", data: { controller: "infinite-scroll", infinite_scroll_offset_value: "1350px" }, loading: "lazy" do %>
+<% if storefront_pagy&.next %>
+ <%= turbo_frame_tag "next_page", src: url_for(params.to_unsafe_h.merge(page: storefront_pagy.next, format: :turbo_stream)), class: "block relative w-full", data: { controller: "infinite-scroll", infinite_scroll_offset_value: "1350px" }, loading: "lazy" do %>
<span class="flex justify-center gap-2 items-center py-4 left-0 w-full h-full">
- <%= render 'spree/shared/icons/spinner' %>
+ <%= render 'spree/shared/icons/spinner' %>
<%= Spree.t(:loading) %>...
</span>
<% end %>
diff --git a/storefront/app/views/themes/default/spree/shared/_pagination.html.erb b/storefront/app/views/themes/default/spree/shared/_pagination.html.erb
new file mode 100644
index 0000000000..3bebec8b70
--- /dev/null
+++ b/storefront/app/views/themes/default/spree/shared/_pagination.html.erb
@@ -0,0 +1,7 @@
+<%# Renders pagination - supports both Pagy and Kaminari %>
+<% if Spree::Storefront::Config[:use_kaminari_pagination] %>
+ <%= paginate @posts || @orders || @gift_cards || @store_credit_events || @storefront_products,
+ theme: 'storefront', outer_window: 1, inner_window: 2 %>
+<% elsif @pagy && @pagy.pages > 1 %>
+ <%== @pagy.series_nav(aria_label: 'Pages') %>
+<% end %>
diff --git a/storefront/lib/generators/spree/storefront/install/templates/application.css b/storefront/lib/generators/spree/storefront/install/templates/application.css
index 92d585470b..63eaafea45 100644
--- a/storefront/lib/generators/spree/storefront/install/templates/application.css
+++ b/storefront/lib/generators/spree/storefront/install/templates/application.css
@@ -1850,3 +1850,47 @@ body:has(.currency-and-locale-modal:not(.hidden)) .page-contents {
aspect-ratio: 1.77;
}
}
+
+/* Pagy pagination styles */
+.pagy.series-nav {
+ display: flex;
+ align-items: center;
+ justify-content: center;
+ gap: 0.25rem;
+ margin-top: 4rem;
+}
+
+.pagy.series-nav a {
+ display: inline-flex;
+ justify-content: center;
+ align-items: center;
+ width: 2rem;
+ text-align: center;
+ padding: 0.25rem;
+ border-radius: 0.25rem;
+}
+
+.pagy.series-nav a[rel="prev"],
+.pagy.series-nav a[rel="next"] {
+ width: auto;
+ padding-left: 1rem;
+ padding-right: 1rem;
+}
+
+.pagy.series-nav a[aria-disabled="true"] {
+ opacity: 0.5;
+ cursor: default;
+}
+
+.pagy.series-nav a[aria-current="page"] {
+ font-weight: 600;
+ text-decoration: underline;
+}
+
+.pagy.series-nav a:not([aria-disabled="true"]):hover {
+ background-color: rgba(0, 0, 0, 0.05);
+}
+
+.pagy.series-nav a[role="separator"] {
+ width: 2rem;
+}
diff --git a/storefront/lib/spree/storefront.rb b/storefront/lib/spree/storefront.rb
index d50637e16f..439567c37d 100644
--- a/storefront/lib/spree/storefront.rb
+++ b/storefront/lib/spree/storefront.rb
@@ -10,6 +10,7 @@ require 'stimulus-rails'
require 'tailwindcss-rails'
require 'turbo-rails'
require 'inline_svg'
+require 'pagy'
require 'spree/storefront/engine'
require 'spree/core/partials'
diff --git a/storefront/lib/spree/storefront/configuration.rb b/storefront/lib/spree/storefront/configuration.rb
index a231d3747f..0e1e6c1bd3 100644
--- a/storefront/lib/spree/storefront/configuration.rb
+++ b/storefront/lib/spree/storefront/configuration.rb
@@ -9,6 +9,9 @@ module Spree
preference :products_per_page, :integer, default: 20
preference :search_min_query_length, :integer, default: 2
+
+ # Pagination preference - set to true to use legacy Kaminari pagination
+ preference :use_kaminari_pagination, :boolean, default: false
end
end
end
diff --git a/storefront/spec/controllers/spree/account/gift_cards_controller_spec.rb b/storefront/spec/controllers/spree/account/gift_cards_controller_spec.rb
index 0552b1f0db..4eee1fd966 100644
--- a/storefront/spec/controllers/spree/account/gift_cards_controller_spec.rb
+++ b/storefront/spec/controllers/spree/account/gift_cards_controller_spec.rb
@@ -42,6 +42,44 @@ describe Spree::Account::GiftCardsController, type: :controller do
expect(assigns(:gift_cards)).to eq([gift_card_2, gift_card])
end
end
+
+ describe 'pagination' do
+ let!(:gift_cards) { create_list(:gift_card, 30, user: user) }
+
+ context 'with Pagy (default)' do
+ before { Spree::Storefront::Config[:use_kaminari_pagination] = false }
+
+ it 'paginates gift cards with Pagy' do
+ subject
+ expect(assigns(:pagy)).to be_a(Pagy::Offset)
+ expect(assigns(:gift_cards).size).to eq(25)
+ end
+
+ it 'returns next page' do
+ get :index, params: { page: 2 }
+ expect(assigns(:pagy).page).to eq(2)
+ expect(assigns(:gift_cards).size).to eq(5)
+ end
+ end
+
+ context 'with Kaminari' do
+ before { Spree::Storefront::Config[:use_kaminari_pagination] = true }
+ after { Spree::Storefront::Config[:use_kaminari_pagination] = false }
+
+ it 'paginates gift cards with Kaminari' do
+ subject
+ expect(assigns(:pagy)).to be_nil
+ expect(assigns(:gift_cards)).to respond_to(:total_pages)
+ expect(assigns(:gift_cards).size).to eq(25)
+ end
+
+ it 'returns next page' do
+ get :index, params: { page: 2 }
+ expect(assigns(:gift_cards).current_page).to eq(2)
+ expect(assigns(:gift_cards).size).to eq(5)
+ end
+ end
+ end
end
context 'when user is not logged in' do
diff --git a/storefront/spec/controllers/spree/account/orders_controller_spec.rb b/storefront/spec/controllers/spree/account/orders_controller_spec.rb
index a2f18fd066..c891d48db4 100644
--- a/storefront/spec/controllers/spree/account/orders_controller_spec.rb
+++ b/storefront/spec/controllers/spree/account/orders_controller_spec.rb
@@ -28,15 +28,50 @@ describe Spree::Account::OrdersController, type: :controller do
expect(response).to have_http_status(:ok)
end
- it 'paginates orders' do
- subject
- expect(assigns(:orders)).to respond_to(:total_pages)
- end
-
it 'renders the index template' do
subject
expect(response).to render_template(:index)
end
+
+ describe 'pagination' do
+ before do
+ 30.times { create(:completed_order_with_totals, user: user, store: store) }
+ end
+
+ context 'with Pagy (default)' do
+ before { Spree::Storefront::Config[:use_kaminari_pagination] = false }
+
+ it 'paginates orders with Pagy' do
+ subject
+ expect(assigns(:pagy)).to be_a(Pagy::Offset)
+ expect(assigns(:orders).size).to eq(25)
+ end
+
+ it 'returns next page' do
+ get :index, params: { page: 2 }
+ expect(assigns(:pagy).page).to eq(2)
+ expect(assigns(:orders).size).to eq(5)
+ end
+ end
+
+ context 'with Kaminari' do
+ before { Spree::Storefront::Config[:use_kaminari_pagination] = true }
+ after { Spree::Storefront::Config[:use_kaminari_pagination] = false }
+
+ it 'paginates orders with Kaminari' do
+ subject
+ expect(assigns(:pagy)).to be_nil
+ expect(assigns(:orders)).to respond_to(:total_pages)
+ expect(assigns(:orders).size).to eq(25)
+ end
+
+ it 'returns next page' do
+ get :index, params: { page: 2 }
+ expect(assigns(:orders).current_page).to eq(2)
+ expect(assigns(:orders).size).to eq(5)
+ end
+ end
+ end
end
context 'when user is not logged in' do
diff --git a/storefront/spec/controllers/spree/account/store_credits_controller_spec.rb b/storefront/spec/controllers/spree/account/store_credits_controller_spec.rb
index 36569e5cdd..9a6fed5478 100644
--- a/storefront/spec/controllers/spree/account/store_credits_controller_spec.rb
+++ b/storefront/spec/controllers/spree/account/store_credits_controller_spec.rb
@@ -32,6 +32,47 @@ describe Spree::Account::StoreCreditsController, type: :controller do
subject
expect(response).to render_template(:index)
end
+
+ describe 'pagination' do
+ # Each store credit creates 1 event, we need 30 total for 2 pages (25 per page)
+ before do
+ 29.times { create(:store_credit, user: user) }
+ end
+
+ context 'with Pagy (default)' do
+ before { Spree::Storefront::Config[:use_kaminari_pagination] = false }
+
+ it 'paginates store credit events with Pagy' do
+ subject
+ expect(assigns(:pagy)).to be_a(Pagy::Offset)
+ expect(assigns(:store_credit_events).size).to eq(25)
+ end
+
+ it 'returns next page' do
+ get :index, params: { page: 2 }
+ expect(assigns(:pagy).page).to eq(2)
+ expect(assigns(:store_credit_events).size).to eq(5)
+ end
+ end
+
+ context 'with Kaminari' do
+ before { Spree::Storefront::Config[:use_kaminari_pagination] = true }
+ after { Spree::Storefront::Config[:use_kaminari_pagination] = false }
+
+ it 'paginates store credit events with Kaminari' do
+ subject
+ expect(assigns(:pagy)).to be_nil
+ expect(assigns(:store_credit_events)).to respond_to(:total_pages)
+ expect(assigns(:store_credit_events).size).to eq(25)
+ end
+
+ it 'returns next page' do
+ get :index, params: { page: 2 }
+ expect(assigns(:store_credit_events).current_page).to eq(2)
+ expect(assigns(:store_credit_events).size).to eq(5)
+ end
+ end
+ end
end
context 'when user is not logged in' do
diff --git a/storefront/spec/controllers/spree/posts_controller_spec.rb b/storefront/spec/controllers/spree/posts_controller_spec.rb
new file mode 100644
index 0000000000..8a1ad2c987
--- /dev/null
+++ b/storefront/spec/controllers/spree/posts_controller_spec.rb
@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe Spree::PostsController, type: :controller do
+ render_views
+
+ let(:store) { @default_store }
+
+ before do
+ allow(controller).to receive(:current_store).and_return(store)
+ end
+
+ describe '#index' do
+ subject { get :index }
+
+ it 'renders the index template' do
+ subject
+ expect(response).to render_template(:index)
+ expect(response).to have_http_status(:ok)
+ end
+
+ describe 'pagination' do
+ let!(:posts) { create_list(:post, 25, :published, store: store) }
+
+ context 'with Pagy (default)' do
+ before { Spree::Storefront::Config[:use_kaminari_pagination] = false }
+
+ it 'paginates posts with Pagy' do
+ subject
+ expect(assigns(:pagy)).to be_a(Pagy::Offset)
+ expect(assigns(:posts).size).to eq(20)
+ end
+
+ it 'returns next page' do
+ get :index, params: { page: 2 }
+ expect(assigns(:pagy).page).to eq(2)
+ expect(assigns(:posts).size).to eq(5)
+ end
+ end
+
+ context 'with Kaminari' do
+ before { Spree::Storefront::Config[:use_kaminari_pagination] = true }
+ after { Spree::Storefront::Config[:use_kaminari_pagination] = false }
+
+ it 'paginates posts with Kaminari' do
+ subject
+ expect(assigns(:pagy)).to be_nil
+ expect(assigns(:posts)).to respond_to(:total_pages)
+ expect(assigns(:posts).size).to eq(20)
+ end
+
+ it 'returns next page' do
+ get :index, params: { page: 2 }
+ expect(assigns(:posts).current_page).to eq(2)
+ expect(assigns(:posts).size).to eq(5)
+ end
+ end
+ end
+ end
+end
diff --git a/storefront/spec/controllers/spree/products_controller_spec.rb b/storefront/spec/controllers/spree/products_controller_spec.rb
index 6d3b0f8408..e82e140d46 100644
--- a/storefront/spec/controllers/spree/products_controller_spec.rb
+++ b/storefront/spec/controllers/spree/products_controller_spec.rb
@@ -17,6 +17,58 @@ describe Spree::ProductsController, type: :controller do
expect(assigns(:current_page)).to be_a(Spree::Pages::ShopAll)
end
+ describe 'pagination' do
+ let!(:products) { create_list(:product, 25, stores: [store]) }
+
+ context 'with Pagy (default)' do
+ before { Spree::Storefront::Config[:use_kaminari_pagination] = false }
+
+ it 'paginates products with Pagy' do
+ subject
+ expect(assigns(:pagy)).to be_a(Pagy::Offset)
+ expect(assigns(:storefront_products).size).to eq(20) # default per_page
+ end
+
+ it 'returns correct page info' do
+ subject
+ expect(assigns(:pagy).page).to eq(1)
+ expect(assigns(:pagy).pages).to eq(2)
+ expect(assigns(:pagy).count).to eq(25)
+ end
+
+ it 'returns next page' do
+ get :index, params: { page: 2 }
+ expect(assigns(:pagy).page).to eq(2)
+ expect(assigns(:storefront_products).size).to eq(5)
+ end
+ end
+
+ context 'with Kaminari' do
+ before { Spree::Storefront::Config[:use_kaminari_pagination] = true }
+ after { Spree::Storefront::Config[:use_kaminari_pagination] = false }
+
+ it 'paginates products with Kaminari' do
+ subject
+ expect(assigns(:pagy)).to be_nil
+ expect(assigns(:storefront_products)).to respond_to(:total_pages)
+ expect(assigns(:storefront_products).size).to eq(20)
+ end
+
+ it 'returns correct page info' do
+ subject
+ expect(assigns(:storefront_products).current_page).to eq(1)
+ expect(assigns(:storefront_products).total_pages).to eq(2)
+ expect(assigns(:storefront_products).total_count).to eq(25)
+ end
+
+ it 'returns next page' do
+ get :index, params: { page: 2 }
+ expect(assigns(:storefront_products).current_page).to eq(2)
+ expect(assigns(:storefront_products).size).to eq(5)
+ end
+ end
+ end
+
context 'when filtering' do
let(:taxon) { create(:taxon) }
diff --git a/storefront/spree_storefront.gemspec b/storefront/spree_storefront.gemspec
index 84240ce664..01c7c000f6 100644
--- a/storefront/spree_storefront.gemspec
+++ b/storefront/spree_storefront.gemspec
@@ -36,4 +36,5 @@ Gem::Specification.new do |s|
s.add_dependency 'tailwindcss-rails'
s.add_dependency 'tailwindcss-ruby'
s.add_dependency 'turbo-rails'
+ s.add_dependency 'pagy', '~> 43.0'
end