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.

Bind delivery zones to their store

Damian Legawiec4b70b2255950
diff --git a/CLAUDE.md b/CLAUDE.md
index 8b900e2e00..ac0d71479c 100644
--- a/CLAUDE.md
+++ b/CLAUDE.md
@@ -152,6 +152,7 @@ Per-request context available in models, controllers, jobs, and services:
### Models
- ALWAYS Inherit from `Spree.base_class`
+- New models carrying store-specific data (configuration, catalog, commerce records) ALWAYS `belongs_to :store` via `Spree::SingleStoreResource` — only genuinely global reference data (countries, states, roles) goes unscoped; multi-store sharing lives in the `spree_multi_store` extension
- ALWAYS pass `class_name` and `dependent` on associations; use `dependent: :destroy_async` for high-fanout associations to offload deletion to a background job
- Include `Spree::Metafields` for custom fields support (see docs/plans/5.4-6.0-custom-fields-rename.md)
- Include `Spree::Metadata` for JSON metadata support
diff --git a/docs/plans/decisions.md b/docs/plans/decisions.md
index 434a59d628..ce641837eb 100644
--- a/docs/plans/decisions.md
+++ b/docs/plans/decisions.md
@@ -637,3 +637,23 @@ first, then take 6.0 — 5.6 remains the bridge release. CI: the MySQL
lanes were the designated old-Rails coverage (`RAILS_VERSION: 7.2.0`) and
could no longer bundle; they now run 8.1 like the rest — MySQL itself
stays fully supported.
+
+
+## 2026-07-29 — Every major model carries a store_id; DeliveryZone bound now, StockLocation next
+
+Ratifies the principle already stated in `6.0-delivery-rate-provider.md`
+(DeliveryMethod gets `store_id` there) as a standing convention: new
+models carrying store-specific data always `belongs_to :store` through
+`Spree::SingleStoreResource`; only genuinely global reference data stays
+unscoped. Store binding also closes cross-store lookup holes structurally
+— admin controllers scope `current_store.<resources>` instead of relying
+on ability scoping alone (see the Strix findings on delivery-method
+bindings, 2026-07-29).
+
+Applied immediately to **DeliveryZone** — an unreleased 6.0 table, so the
+creation migration gained `store_id NOT NULL` + per-store name uniqueness
+in place, with zero bridge cost. **StockLocation** is a released table
+and follows as its own work item using the 5.6 single-store pattern
+(nullable `store_id` + backfill task + shared-row deprecation,
+`null: false` in 6.1), paired with ConfigurationManagement now granting
+stock-location management.
diff --git a/spree/api/app/controllers/spree/api/v3/admin/delivery_methods_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/delivery_methods_controller.rb
index 1097a9b517..2a8c88d925 100644
--- a/spree/api/app/controllers/spree/api/v3/admin/delivery_methods_controller.rb
+++ b/spree/api/app/controllers/spree/api/v3/admin/delivery_methods_controller.rb
@@ -82,7 +82,7 @@ module Spree
attributes[:tax_category] = params[:tax_category_id].present? ? Spree::TaxCategory.accessible_by(current_ability, :show).find_by_prefix_id!(params[:tax_category_id]) : nil
end
if params.key?(:delivery_zone_ids)
- attributes[:delivery_zones] = Array(params[:delivery_zone_ids]).map { |id| Spree::DeliveryZone.accessible_by(current_ability, :show).find_by_prefix_id!(id) }
+ attributes[:delivery_zones] = Array(params[:delivery_zone_ids]).map { |id| current_store.delivery_zones.accessible_by(current_ability, :show).find_by_prefix_id!(id) }
end
if params.key?(:stock_location_ids)
attributes[:pickup_locations] = Array(params[:stock_location_ids]).map { |id| Spree::StockLocation.accessible_by(current_ability, :show).find_by_prefix_id!(id) }
diff --git a/spree/api/app/controllers/spree/api/v3/admin/delivery_zones_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/delivery_zones_controller.rb
index 2630957938..ec6b213a1e 100644
--- a/spree/api/app/controllers/spree/api/v3/admin/delivery_zones_controller.rb
+++ b/spree/api/app/controllers/spree/api/v3/admin/delivery_zones_controller.rb
@@ -50,7 +50,7 @@ module Spree
end
def scope
- Spree::DeliveryZone.accessible_by(current_ability, :show)
+ current_store.delivery_zones.accessible_by(current_ability, :show)
end
def permitted_params
diff --git a/spree/core/app/models/spree/delivery_zone.rb b/spree/core/app/models/spree/delivery_zone.rb
index 36b335a729..744ac75d0c 100644
--- a/spree/core/app/models/spree/delivery_zone.rb
+++ b/spree/core/app/models/spree/delivery_zone.rb
@@ -1,16 +1,21 @@
module Spree
class DeliveryZone < Spree.base_class
+ include Spree::SingleStoreResource
+
has_prefix_id :dz
# Single consolidated metadata JSON column (docs/plans/decisions.md
# 2026-03-16 "Consolidate metadata") — write-only developer escape hatch.
attribute :metadata, default: -> { {} }
+ belongs_to :store, class_name: 'Spree::Store'
+
has_many :members, class_name: 'Spree::DeliveryZoneMember', dependent: :destroy, inverse_of: :delivery_zone
has_many :delivery_method_zones, class_name: 'Spree::DeliveryMethodZone', dependent: :destroy, inverse_of: :delivery_zone
has_many :delivery_methods, through: :delivery_method_zones, class_name: 'Spree::DeliveryMethod'
- validates :name, presence: true, uniqueness: { scope: spree_base_uniqueness_scope }
+ validates :name, presence: true, uniqueness: { scope: [:store_id, *spree_base_uniqueness_scope] }
+ validates :store, presence: true, unless: -> { Spree::Config[:disable_store_presence_validation] }
self.whitelisted_ransackable_attributes = %w[name]
diff --git a/spree/core/app/models/spree/store.rb b/spree/core/app/models/spree/store.rb
index 8e7e6eca18..64c6931aea 100644
--- a/spree/core/app/models/spree/store.rb
+++ b/spree/core/app/models/spree/store.rb
@@ -117,6 +117,7 @@ module Spree
self.categories = value
end
+ has_many :delivery_zones, class_name: 'Spree::DeliveryZone', dependent: :destroy
has_many :promotions, class_name: 'Spree::Promotion', dependent: :nullify
has_many :wishlists, class_name: 'Spree::Wishlist'
diff --git a/spree/core/db/migrate/20260728000002_create_spree_delivery_zones.rb b/spree/core/db/migrate/20260728000002_create_spree_delivery_zones.rb
index da9b1b4d7f..5bab44e35b 100644
--- a/spree/core/db/migrate/20260728000002_create_spree_delivery_zones.rb
+++ b/spree/core/db/migrate/20260728000002_create_spree_delivery_zones.rb
@@ -1,6 +1,7 @@
class CreateSpreeDeliveryZones < ActiveRecord::Migration[7.2]
def change
create_table :spree_delivery_zones do |t|
+ t.references :store, null: false
t.string :name, null: false
t.string :description
if t.respond_to?(:jsonb)
@@ -11,7 +12,7 @@ class CreateSpreeDeliveryZones < ActiveRecord::Migration[7.2]
t.timestamps
end
- add_index :spree_delivery_zones, :name, unique: true
+ add_index :spree_delivery_zones, [:store_id, :name], unique: true
create_table :spree_delivery_zone_members do |t|
t.references :delivery_zone, null: false
diff --git a/spree/core/db/sample_data/shipping_methods.rb b/spree/core/db/sample_data/shipping_methods.rb
index c3d2d561f6..0311fe52ae 100644
--- a/spree/core/db/sample_data/shipping_methods.rb
+++ b/spree/core/db/sample_data/shipping_methods.rb
@@ -3,7 +3,7 @@
def delivery_zone_from(zone)
return nil if zone.nil?
- delivery_zone = Spree::DeliveryZone.find_or_create_by!(name: zone.name) do |dz|
+ delivery_zone = Spree::DeliveryZone.find_or_create_by!(name: zone.name, store: Spree::Store.default) do |dz|
dz.description = zone.description
end
zone.countries.each { |country| delivery_zone.members.find_or_create_by!(member_type: 'country', country: country) }
diff --git a/spree/core/lib/spree/testing_support/factories/delivery_zone_factory.rb b/spree/core/lib/spree/testing_support/factories/delivery_zone_factory.rb
index 89b78f1a06..3b37555942 100644
--- a/spree/core/lib/spree/testing_support/factories/delivery_zone_factory.rb
+++ b/spree/core/lib/spree/testing_support/factories/delivery_zone_factory.rb
@@ -1,6 +1,7 @@
FactoryBot.define do
factory :delivery_zone, class: Spree::DeliveryZone do
sequence(:name) { |n| "Delivery Zone ##{n}" }
+ store { Spree::Store.find_by(default: true) || association(:store) }
description { generate(:random_string) }
factory :delivery_zone_with_country do