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 spree roles (#12510)

Damian Kaczmarczyk5e51d81d3195
diff --git a/core/app/models/concerns/spree/user_roles.rb b/core/app/models/concerns/spree/user_roles.rb
index 2536e79e61..2cec07d2ed 100644
--- a/core/app/models/concerns/spree/user_roles.rb
+++ b/core/app/models/concerns/spree/user_roles.rb
@@ -3,7 +3,7 @@ module Spree
extend ActiveSupport::Concern
included do
- has_many :role_users, class_name: 'Spree::RoleUser', foreign_key: :user_id, dependent: :destroy
+ has_many :role_users, class_name: 'Spree::RoleUser', foreign_key: :user_id, as: :user, dependent: :destroy
has_many :spree_roles, through: :role_users, class_name: 'Spree::Role', source: :role
scope :spree_admin, -> { joins(:spree_roles).where(Spree::Role.table_name => { name: 'admin' }) }
diff --git a/core/app/models/spree/role.rb b/core/app/models/spree/role.rb
index 663039d153..9360f5caae 100644
--- a/core/app/models/spree/role.rb
+++ b/core/app/models/spree/role.rb
@@ -5,6 +5,7 @@ module Spree
ADMIN_ROLE = 'admin'
has_many :role_users, class_name: 'Spree::RoleUser', dependent: :destroy
- has_many :users, through: :role_users, class_name: "::#{Spree.user_class}"
+ has_many :users, through: :role_users, source: :user, source_type: Spree.user_class.to_s
+ has_many :admin_users, through: :role_users, source: :user, source_type: Spree.admin_user_class.to_s
end
end
diff --git a/core/app/models/spree/role_user.rb b/core/app/models/spree/role_user.rb
index 6654a90b07..e03f31866e 100644
--- a/core/app/models/spree/role_user.rb
+++ b/core/app/models/spree/role_user.rb
@@ -1,6 +1,6 @@
module Spree
class RoleUser < Spree.base_class
belongs_to :role, class_name: 'Spree::Role'
- belongs_to :user, class_name: Spree.admin_user_class.to_s
+ belongs_to :user, polymorphic: true
end
end
diff --git a/core/db/migrate/20250313104226_add_user_type_to_spree_role_users.rb b/core/db/migrate/20250313104226_add_user_type_to_spree_role_users.rb
new file mode 100644
index 0000000000..d5c38ff8d9
--- /dev/null
+++ b/core/db/migrate/20250313104226_add_user_type_to_spree_role_users.rb
@@ -0,0 +1,18 @@
+class AddUserTypeToSpreeRoleUsers < ActiveRecord::Migration[6.1]
+ def up
+ unless column_exists?(:spree_role_users, :user_type)
+ add_column :spree_role_users, :user_type, :string
+ add_index :spree_role_users, :user_type
+
+ user_class_name = Spree.admin_user_class.to_s
+ Spree::RoleUser.where(user_type: nil).update_all(user_type: user_class_name)
+
+ change_column_null :spree_role_users, :user_type, false
+ end
+ end
+
+ def down
+ remove_index :spree_role_users, :user_type, if_exists: true
+ remove_column :spree_role_users, :user_type, if_exists: true
+ end
+end
diff --git a/core/lib/spree/testing_support/factories/role_user_factory.rb b/core/lib/spree/testing_support/factories/role_user_factory.rb
new file mode 100644
index 0000000000..d65fd0c6c1
--- /dev/null
+++ b/core/lib/spree/testing_support/factories/role_user_factory.rb
@@ -0,0 +1,7 @@
+FactoryBot.define do
+ factory :role_user, class: 'Spree::RoleUser' do
+ association :role, factory: :role
+ association :user, factory: :user
+ user_type { user.class.to_s }
+ end
+end
diff --git a/core/spec/models/concerns/spree/user_roles_spec.rb b/core/spec/models/concerns/spree/user_roles_spec.rb
new file mode 100644
index 0000000000..a28845139c
--- /dev/null
+++ b/core/spec/models/concerns/spree/user_roles_spec.rb
@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+describe Spree::UserRoles do
+ let(:role) { create(:role, name: 'test_role') }
+ let(:admin_role) { create(:role, name: 'admin') }
+
+ describe 'instance methods' do
+ let(:user) { create(:user) }
+
+ describe '#has_spree_role?' do
+ it 'returns true if the user has the role' do
+ user.spree_roles << role
+ expect(user.has_spree_role?('test_role')).to be true
+ end
+
+ it 'returns false if the user does not have the role' do
+ expect(user.has_spree_role?('test_role')).to be false
+ end
+ end
+
+ describe '#spree_admin?' do
+ it 'returns true if the user has the admin role' do
+ user.spree_roles << admin_role
+ expect(user.spree_admin?).to be true
+ end
+
+ it 'returns false if the user does not have the admin role' do
+ expect(user.spree_admin?).to be false
+ end
+ end
+ end
+
+ describe 'class methods' do
+ describe '.spree_admin_created?' do
+ it 'returns true if an admin user exists' do
+ user = create(:user)
+ user.spree_roles << admin_role
+ expect(user.class.spree_admin_created?).to be true
+ end
+
+ it 'returns false if no admin user exists' do
+ Spree::RoleUser.where(role: Spree::Role.find_by(name: 'admin')).destroy_all
+ expect(Spree::LegacyUser.spree_admin_created?).to be false
+ end
+ end
+ end
+
+ describe 'with real users' do
+ let(:user) { create(:user) }
+
+ it 'can add roles to a user' do
+ user.spree_roles << role
+ expect(user.has_spree_role?('test_role')).to be true
+ end
+
+ it 'can check if a user is an admin' do
+ user.spree_roles << admin_role
+ expect(user.spree_admin?).to be true
+ end
+
+ it 'creates role_user records with the correct user_type' do
+ user.spree_roles << role
+ role_user = Spree::RoleUser.last
+ expect(role_user.user).to eq(user)
+ expect(role_user.user_type).to eq(user.class.to_s)
+ end
+ end
+end
diff --git a/core/spec/models/spree/role_spec.rb b/core/spec/models/spree/role_spec.rb
new file mode 100644
index 0000000000..9a4773ddbc
--- /dev/null
+++ b/core/spec/models/spree/role_spec.rb
@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Spree::Role do
+ let(:role) { create(:role) }
+ let(:user) { create(:user) }
+
+ describe 'with users' do
+ before do
+ user.spree_roles << role
+ end
+
+ it 'can access users through the polymorphic association' do
+ expect(role.users).to include(user)
+ end
+ end
+end
diff --git a/core/spec/models/spree/role_user_spec.rb b/core/spec/models/spree/role_user_spec.rb
new file mode 100644
index 0000000000..371f03e248
--- /dev/null
+++ b/core/spec/models/spree/role_user_spec.rb
@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+class AdminUser < Spree.base_class
+ self.table_name = 'spree_users'
+ include Spree::UserRoles
+end
+
+describe Spree::RoleUser do
+ describe 'with different user types' do
+ let(:role) { create(:role, name: 'test_role') }
+ let(:spree_user) { create(:user) }
+ let(:admin_user) { AdminUser.new(id: 99) }
+
+ it 'can associate with different user types' do
+ spree_role_user = described_class.create!(role: role, user: spree_user)
+ admin_role_user = described_class.create!(role: role, user: admin_user)
+
+ expect(spree_user).not_to eq(admin_user)
+
+ expect(spree_role_user.user).to eq(spree_user)
+ expect(spree_role_user.user_type).to eq(spree_user.class.to_s)
+
+ expect(admin_role_user.user).to eq(admin_user)
+ expect(admin_role_user.user_type).to eq('AdminUser')
+ end
+ end
+end