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.

Fix: dashboard filters and sorts the API silently ignored

Damian Legawiec7020b134dbb4
diff --git a/spree/api/app/services/spree/api/v3/filter_predicates.rb b/spree/api/app/services/spree/api/v3/filter_predicates.rb
index c389d68f28..83ef6999d2 100644
--- a/spree/api/app/services/spree/api/v3/filter_predicates.rb
+++ b/spree/api/app/services/spree/api/v3/filter_predicates.rb
@@ -10,7 +10,7 @@ module Spree
RANGE = (EQUALITY + %w[lt lteq gt gteq] + NULLITY).freeze
BY_KIND = {
- 'text' => (EQUALITY + %w[cont not_cont start end] + NULLITY + %w[present blank]).freeze,
+ 'text' => (EQUALITY + %w[cont i_cont not_cont start end] + NULLITY + %w[present blank]).freeze,
'decimal' => RANGE,
'integer' => RANGE,
'date' => RANGE,
@@ -18,7 +18,7 @@ module Spree
'enum' => (EQUALITY + NULLITY).freeze,
'id' => (EQUALITY + NULLITY).freeze,
'type' => (EQUALITY + NULLITY).freeze,
- 'boolean' => %w[eq true false null].freeze
+ 'boolean' => (EQUALITY + %w[true false null]).freeze
}.freeze
KINDS = BY_KIND.keys.freeze
diff --git a/spree/api/app/services/spree/api/v3/filter_table.rb b/spree/api/app/services/spree/api/v3/filter_table.rb
index 30d63f7e7c..b391ae9bce 100644
--- a/spree/api/app/services/spree/api/v3/filter_table.rb
+++ b/spree/api/app/services/spree/api/v3/filter_table.rb
@@ -112,7 +112,8 @@ module Spree
# `{ 'list' => kind }` for any number of arguments
def scopes
@scopes ||= begin
- declared = (model.respond_to?(:ransackable_scope_types) ? model.ransackable_scope_types : {}).stringify_keys
+ declared = (model.respond_to?(:ransackable_scope_types) ? model.ransackable_scope_types : {}).
+ merge(Spree.ransack.custom_scope_types_for(model)).stringify_keys
model.ransackable_scopes(audience).map(&:to_s).sort.index_with do |scope|
normalize_scope_type(declared.fetch(scope) { inferred_scope_type(scope) })
end
@@ -159,6 +160,7 @@ module Spree
return 'id' if id_attribute?(attribute)
return 'type' if type_attribute?(attribute)
return { 'enum' => model.statuses } if attribute == 'status' && model.respond_to?(:statuses)
+ return { 'enum' => model.defined_enums[attribute].keys } if model.defined_enums.key?(attribute)
if (values = inclusion_values(attribute))
return { 'enum' => values }
end
diff --git a/spree/api/spec/controllers/spree/api/v3/admin/delivery_zones_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/admin/delivery_zones_controller_spec.rb
index 3571af5870..5772c1b356 100644
--- a/spree/api/spec/controllers/spree/api/v3/admin/delivery_zones_controller_spec.rb
+++ b/spree/api/spec/controllers/spree/api/v3/admin/delivery_zones_controller_spec.rb
@@ -18,6 +18,15 @@ RSpec.describe Spree::Api::V3::Admin::DeliveryZonesController, type: :controller
expect(response).to have_http_status(:ok)
expect(json_response['data'].map { |z| z['name'] }).to include('Domestic')
end
+
+ it 'filters by delivery profile' do
+ profile = create(:delivery_profile, store: store)
+ create(:delivery_zone, store: store, delivery_profile: profile, name: 'Profile zone')
+
+ get :index, params: { q: { delivery_profile_id_eq: profile.prefixed_id } }, as: :json
+
+ expect(json_response['data'].map { |z| z['name'] }).to eq(['Profile zone'])
+ end
end
describe 'POST #create' do
diff --git a/spree/api/spec/controllers/spree/api/v3/admin/payment_methods_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/admin/payment_methods_controller_spec.rb
index 8624ffb32d..08a8662bc2 100644
--- a/spree/api/spec/controllers/spree/api/v3/admin/payment_methods_controller_spec.rb
+++ b/spree/api/spec/controllers/spree/api/v3/admin/payment_methods_controller_spec.rb
@@ -18,6 +18,14 @@ RSpec.describe Spree::Api::V3::Admin::PaymentMethodsController, type: :controlle
expect(json_response['data'].map { |pm| pm['id'] }).to include(payment_method.prefixed_id)
end
+ it 'filters by whether a method is active' do
+ inactive = create(:check_payment_method, store: store, active: false)
+
+ get :index, params: { q: { active_eq: false } }, as: :json
+
+ expect(json_response['data'].pluck('id')).to eq([inactive.prefixed_id])
+ end
+
it 'returns payment methods in list order' do
create(:check_payment_method, store: store, name: 'Second method')
third = create(:check_payment_method, store: store, name: 'Third method')
diff --git a/spree/core/app/models/spree/allowed_origin.rb b/spree/core/app/models/spree/allowed_origin.rb
index a60f05ecc9..55eec27ab8 100644
--- a/spree/core/app/models/spree/allowed_origin.rb
+++ b/spree/core/app/models/spree/allowed_origin.rb
@@ -10,6 +10,8 @@ module Spree
include Spree::SingleStoreResource
+ self.whitelisted_ransackable_attributes = %w[origin]
+
validates :origin, presence: true
validates :origin, uniqueness: { scope: [:store_id, *spree_base_uniqueness_scope] }
diff --git a/spree/core/app/models/spree/custom_field_definition.rb b/spree/core/app/models/spree/custom_field_definition.rb
index 1d16b2df38..41f35f771e 100644
--- a/spree/core/app/models/spree/custom_field_definition.rb
+++ b/spree/core/app/models/spree/custom_field_definition.rb
@@ -52,7 +52,7 @@ module Spree
#
# Ransack
#
- self.whitelisted_ransackable_attributes = %w[key namespace label resource_type storefront_visible searchable sortable]
+ self.whitelisted_ransackable_attributes = %w[key namespace label resource_type field_type storefront_visible searchable sortable]
self.whitelisted_ransackable_scopes = %w[search]
# API-facing token for the STI subclass name stored in the `field_type`
diff --git a/spree/core/app/models/spree/delivery_zone.rb b/spree/core/app/models/spree/delivery_zone.rb
index 1064f21b82..521ec89576 100644
--- a/spree/core/app/models/spree/delivery_zone.rb
+++ b/spree/core/app/models/spree/delivery_zone.rb
@@ -33,7 +33,7 @@ module Spree
validate :origin_group_must_belong_to_profile,
if: -> { delivery_origin_group_id_changed? || delivery_profile_id_changed? }
- self.whitelisted_ransackable_attributes = %w[name]
+ self.whitelisted_ransackable_attributes = %w[name delivery_profile_id]
# @param address [Spree::Address, nil]
# @return [Boolean] whether any member of this zone matches the address
diff --git a/spree/core/app/models/spree/gift_card.rb b/spree/core/app/models/spree/gift_card.rb
index 85e7233864..af134eca5d 100644
--- a/spree/core/app/models/spree/gift_card.rb
+++ b/spree/core/app/models/spree/gift_card.rb
@@ -65,7 +65,7 @@ module Spree
# Ransack
#
ransack_alias :state, :status # @deprecated filter alias — removed in 6.1
- self.whitelisted_ransackable_attributes = %w[code customer_id status state gift_card_batch_id created_by_id]
+ self.whitelisted_ransackable_attributes = %w[code customer_id status state gift_card_batch_id created_by_id currency expires_at]
# `users` is the pre-6.0 name for `customers` — removed in 6.1.
self.whitelisted_ransackable_associations = %w[customers users orders batch]
self.whitelisted_ransackable_scopes = %w[active expired redeemed partially_redeemed]
diff --git a/spree/core/app/models/spree/market.rb b/spree/core/app/models/spree/market.rb
index cfaeee9660..966206dc76 100644
--- a/spree/core/app/models/spree/market.rb
+++ b/spree/core/app/models/spree/market.rb
@@ -8,6 +8,8 @@ module Spree
acts_as_paranoid
acts_as_list scope: :store_id
+ self.whitelisted_ransackable_attributes = %w[currency default_locale]
+
#
# Associations
#
diff --git a/spree/core/app/models/spree/option_type.rb b/spree/core/app/models/spree/option_type.rb
index 2f4108a8fe..5a25a38453 100644
--- a/spree/core/app/models/spree/option_type.rb
+++ b/spree/core/app/models/spree/option_type.rb
@@ -24,7 +24,7 @@ module Spree
self.whitelisted_ransackable_scopes = %w[search_by_name]
# `label` is what admin surfaces display, so it has to be filterable —
# matching Spree::OptionValue, which already allows it.
- self.whitelisted_ransackable_attributes = %w[label name]
+ self.whitelisted_ransackable_attributes = %w[label name kind]
normalizes :name, with: ->(value) { value&.to_s&.squish&.presence }
diff --git a/spree/core/app/models/spree/payment_method.rb b/spree/core/app/models/spree/payment_method.rb
index dd7d946388..d871ed4800 100644
--- a/spree/core/app/models/spree/payment_method.rb
+++ b/spree/core/app/models/spree/payment_method.rb
@@ -55,8 +55,8 @@ module Spree
scope :storefront_visible, -> { where(storefront_visible: true) }
scope :admin_only, -> { where(storefront_visible: false) }
- # Real column, so admin clients filter it directly — no ransacker needed.
- self.whitelisted_ransackable_attributes = %w[storefront_visible]
+ # Real columns, so admin clients filter them directly — no ransacker needed.
+ self.whitelisted_ransackable_attributes = %w[storefront_visible active type]
after_initialize :set_name, if: :new_record?
diff --git a/spree/core/app/models/spree/seller.rb b/spree/core/app/models/spree/seller.rb
index 77985cd834..a69c782559 100644
--- a/spree/core/app/models/spree/seller.rb
+++ b/spree/core/app/models/spree/seller.rb
@@ -41,6 +41,11 @@ module Spree
has_status :pending, :invited, :canceled, :onboarding, :ready_for_review,
:approved, :rejected, :suspended, default: :pending
+ # The storefront lists approved sellers only, and a seller's contact
+ # address is back-office data.
+ self.whitelisted_ransackable_attributes = %w[status contact_email]
+ self.private_ransackable_attributes = { store: %w[status contact_email] }
+
# Who remits consumer tax on this seller's sales. `seller` means they are
# merchant of record; `platform` is the marketplace-facilitator case, and
# only Enterprise decides a seller belongs there — core just reads it.
diff --git a/spree/core/lib/spree/core/ransack_configuration.rb b/spree/core/lib/spree/core/ransack_configuration.rb
index 37d1b453df..e07c080c93 100644
--- a/spree/core/lib/spree/core/ransack_configuration.rb
+++ b/spree/core/lib/spree/core/ransack_configuration.rb
@@ -6,7 +6,7 @@ module Spree
#
# @example Adding custom searchable fields
# Spree.ransack.add_attribute(Spree::Product, :seller_id)
- # Spree.ransack.add_scope(Spree::Product, :by_seller)
+ # Spree.ransack.add_scope(Spree::Product, :by_seller, type: 'id')
# Spree.ransack.add_association(Spree::Product, :seller)
#
class RansackConfiguration
@@ -14,6 +14,7 @@ module Spree
@custom_attributes = Hash.new { |h, k| h[k] = [] }
@custom_associations = Hash.new { |h, k| h[k] = [] }
@custom_scopes = Hash.new { |h, k| h[k] = [] }
+ @custom_scope_types = Hash.new { |h, k| h[k] = {} }
end
# Add a custom ransackable attribute to a model.
@@ -38,8 +39,11 @@ module Spree
#
# @param model [Class] the model class to configure (e.g., Spree::Product)
# @param scope [String, Symbol] the scope to add
+ # @param type [String, Array<String>, Hash, nil] the arguments it takes, as
+ # in `ransackable_scope_types` — `'boolean'` for a scope taking none
# @return [Array<String>] the updated list of custom scopes
- def add_scope(model, scope)
+ def add_scope(model, scope, type: nil)
+ @custom_scope_types[model.name.to_sym][scope.to_s] = type unless type.nil?
@custom_scopes[model.name.to_sym] |= [scope.to_s]
end
@@ -67,6 +71,12 @@ module Spree
@custom_scopes[model.name.to_sym]
end
+ # @param model [Class] the model class to query
+ # @return [Hash{String => Object}] argument types declared with {#add_scope}
+ def custom_scope_types_for(model)
+ @custom_scope_types[model.name.to_sym]
+ end
+
# Reset all custom configurations. Useful for testing.
#
# @return [void]
@@ -74,6 +84,7 @@ module Spree
@custom_attributes.clear
@custom_associations.clear
@custom_scopes.clear
+ @custom_scope_types.clear
end
end
end
diff --git a/spree/core/spec/lib/spree/core/ransack_configuration_spec.rb b/spree/core/spec/lib/spree/core/ransack_configuration_spec.rb
index 40f59f9571..b49078200f 100644
--- a/spree/core/spec/lib/spree/core/ransack_configuration_spec.rb
+++ b/spree/core/spec/lib/spree/core/ransack_configuration_spec.rb
@@ -73,6 +73,13 @@ RSpec.describe Spree::RansackConfiguration do
expect(config.custom_scopes_for(Spree::Product)).to contain_exactly('by_seller')
end
+
+ it 'records the argument types it is declared with' do
+ config.add_scope(Spree::Product, :by_seller, type: 'id')
+ config.add_scope(Spree::Product, :featured)
+
+ expect(config.custom_scope_types_for(Spree::Product)).to eq('by_seller' => 'id')
+ end
end
describe '#custom_attributes_for' do