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.

Fixed sorting of Posts in Storefront API (#13053)

Damian Legawiecab837e097965
diff --git a/api/app/controllers/spree/api/v2/storefront/posts_controller.rb b/api/app/controllers/spree/api/v2/storefront/posts_controller.rb
index fe569c17f9..df58c24e96 100644
--- a/api/app/controllers/spree/api/v2/storefront/posts_controller.rb
+++ b/api/app/controllers/spree/api/v2/storefront/posts_controller.rb
@@ -5,6 +5,10 @@ module Spree
class PostsController < ::Spree::Api::V2::ResourceController
protected
+ def sorted_collection
+ collection_sorter.new(collection, params, allowed_sort_attributes).call
+ end
+
def collection
@collection ||= collection_finder.new(scope: scope, params: finder_params).execute
end
@@ -17,6 +21,10 @@ module Spree
Spree::Api::Dependencies.storefront_posts_finder.constantize
end
+ def collection_sorter
+ Spree::Api::Dependencies.storefront_posts_sorter.constantize
+ end
+
def collection_serializer
Spree::V2::Storefront::PostSerializer
end
@@ -34,7 +42,7 @@ module Spree
end
def allowed_sort_attributes
- super << :published_at
+ super << :published_at << :title
end
end
end
diff --git a/api/app/serializers/spree/v2/storefront/post_serializer.rb b/api/app/serializers/spree/v2/storefront/post_serializer.rb
index d3b6ee0825..ff43778d1b 100644
--- a/api/app/serializers/spree/v2/storefront/post_serializer.rb
+++ b/api/app/serializers/spree/v2/storefront/post_serializer.rb
@@ -14,6 +14,10 @@ module Spree
post.content.to_plain_text if post.content.present?
end
+ attribute :content_html do |post|
+ post.content.to_s if post.content.present?
+ end
+
attribute :description do |post|
post.description
end
diff --git a/api/lib/spree/api/dependencies.rb b/api/lib/spree/api/dependencies.rb
index 043eca8a63..0c4adbd59d 100644
--- a/api/lib/spree/api/dependencies.rb
+++ b/api/lib/spree/api/dependencies.rb
@@ -74,6 +74,7 @@ module Spree
storefront_order_sorter: -> { Spree::Dependencies.collection_sorter },
storefront_products_sorter: -> { Spree::Dependencies.products_sorter },
platform_products_sorter: -> { Spree::Dependencies.products_sorter },
+ storefront_posts_sorter: -> { Spree::Dependencies.posts_sorter },
# paginators
storefront_collection_paginator: -> { Spree::Dependencies.collection_paginator },
diff --git a/api/spec/requests/spree/api/v2/storefront/posts_spec.rb b/api/spec/requests/spree/api/v2/storefront/posts_spec.rb
index 4d515cbf75..2744befeb9 100644
--- a/api/spec/requests/spree/api/v2/storefront/posts_spec.rb
+++ b/api/spec/requests/spree/api/v2/storefront/posts_spec.rb
@@ -66,19 +66,48 @@ describe 'API V2 Storefront Posts Spec', type: :request do
end
context 'with sorting' do
- before do
- published_posts.first.update(published_at: 1.day.ago)
- published_posts.last.update(published_at: 1.hour.ago)
+ let!(:oldest_post) { create(:post, :published, title: 'Oldest Post', published_at: 3.days.ago, store: store, author: admin_user, post_category: post_category) }
+ let!(:newest_post) { create(:post, :published, title: 'Newest Post', published_at: 1.hour.ago, store: store, author: admin_user, post_category: post_category) }
+ let!(:middle_post) { create(:post, :published, title: 'Middle Post', published_at: 1.day.ago, store: store, author: admin_user, post_category: post_category) }
+
+ context 'sorting by published_at ascending' do
+ before { get '/api/v2/storefront/posts?sort=published_at' }
+
+ it 'returns posts sorted by published date ascending' do
+ expect(response.status).to eq(200)
+ published_dates = json_response['data'].map { |post| DateTime.parse(post['attributes']['published_at']) }
+ expect(published_dates).to eq(published_dates.sort)
+ end
end
- before { get '/api/v2/storefront/posts?sort_by=published-newest' }
+ context 'sorting by published_at descending' do
+ before { get '/api/v2/storefront/posts?sort=-published_at' }
- it 'returns posts sorted by published date' do
- expect(response.status).to eq(200)
- expect(json_response['data'].count).to eq(3)
-
- published_dates = json_response['data'].map { |post| post['attributes']['published_at'] }
- expect(published_dates).to eq(published_dates.sort.reverse)
+ it 'returns posts sorted by published date descending' do
+ expect(response.status).to eq(200)
+ published_dates = json_response['data'].map { |post| DateTime.parse(post['attributes']['published_at']) }
+ expect(published_dates).to eq(published_dates.sort.reverse)
+ end
+ end
+
+ context 'sorting by title ascending' do
+ before { get '/api/v2/storefront/posts?sort=title' }
+
+ it 'returns posts sorted by title ascending' do
+ expect(response.status).to eq(200)
+ titles = json_response['data'].map { |post| post['attributes']['title'] }
+ expect(titles).to eq(titles.sort)
+ end
+ end
+
+ context 'sorting by title descending' do
+ before { get '/api/v2/storefront/posts?sort=-title' }
+
+ it 'returns posts sorted by title descending' do
+ expect(response.status).to eq(200)
+ titles = json_response['data'].map { |post| post['attributes']['title'] }
+ expect(titles).to eq(titles.sort.reverse)
+ end
end
end
diff --git a/core/app/sorters/spree/posts/sort.rb b/core/app/sorters/spree/posts/sort.rb
new file mode 100644
index 0000000000..040e2e5164
--- /dev/null
+++ b/core/app/sorters/spree/posts/sort.rb
@@ -0,0 +1,40 @@
+module Spree
+ module Posts
+ class Sort < ::Spree::BaseSorter
+ def initialize(scope, params = {}, allowed_sort_attributes = [])
+ super(scope, params, allowed_sort_attributes)
+ end
+
+ def call
+ posts = by_param_attributes(scope)
+ posts = select_translatable_fields(posts) if Spree.use_translations?
+
+ posts.distinct
+ end
+
+ private
+
+ attr_reader :sort, :scope, :allowed_sort_attributes
+
+ # Add translatable fields to SELECT statement to avoid InvalidColumnReference error (workaround for Mobility issue #596)
+ def select_translatable_fields(scope)
+ translatable_fields = translatable_sortable_fields
+ return scope if translatable_fields.empty?
+
+ scope.i18n.select("#{Post.table_name}.*").select(*translatable_fields)
+ end
+
+ def translatable_sortable_fields
+ fields = []
+ Post.translatable_fields.each do |field|
+ fields << field if sort_by?(field.to_s)
+ end
+ fields
+ end
+
+ def sort_by?(field)
+ sort.detect { |s| s[0] == field }
+ end
+ end
+ end
+end
\ No newline at end of file
diff --git a/core/lib/spree/core/dependencies.rb b/core/lib/spree/core/dependencies.rb
index a5e30d780b..43620ad928 100644
--- a/core/lib/spree/core/dependencies.rb
+++ b/core/lib/spree/core/dependencies.rb
@@ -57,6 +57,7 @@ module Spree
collection_sorter: 'Spree::BaseSorter',
order_sorter: 'Spree::BaseSorter',
products_sorter: 'Spree::Products::Sort',
+ posts_sorter: 'Spree::Posts::Sort',
# paginator
collection_paginator: 'Spree::Shared::Paginate',