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.

Introduce `Spree::ResourceUser` (#12651)

Damian Legawiec3f13e96e337f
diff --git a/admin/app/controllers/spree/admin/admin_users_controller.rb b/admin/app/controllers/spree/admin/admin_users_controller.rb
index 7ef6721515..60b2c2999b 100644
--- a/admin/app/controllers/spree/admin/admin_users_controller.rb
+++ b/admin/app/controllers/spree/admin/admin_users_controller.rb
@@ -3,7 +3,7 @@ module Spree
class AdminUsersController < BaseController
skip_before_action :authorize_admin, only: [:new, :create]
- before_action :load_resource
+ before_action :load_resource, except: [:new, :create]
before_action :load_invitation, only: [:new, :create]
before_action :load_admin_user, only: [:edit, :update, :destroy]
@@ -32,10 +32,8 @@ module Spree
# this is a self signup flow for admin users from the invitation email
def create
@admin_user = Spree.admin_user_class.new(permitted_params)
- @admin_user.spree_role_ids = @invitation.role_ids
+ @invitation.invitee = @admin_user
if @admin_user.save && @invitation.accept!
- @invitation.update!(invitee: @admin_user)
-
# Automatically log in the user after successful signup
# if Devise is installed
if defined?(sign_in)
@@ -63,6 +61,15 @@ module Spree
end
end
+ # DELETE /admin/admin_users/:id
+ def destroy
+ authorize! :destroy, @admin_user
+
+ # we're actually removing the resource_user record, not the user itself
+ @resource.resource_users.find_by(user: @admin_user).destroy
+ redirect_to spree.admin_admin_users_path, status: :see_other, notice: flash_message_for(@admin_user, :successfully_deleted)
+ end
+
private
def permitted_params
@@ -82,7 +89,7 @@ module Spree
end
def scope
- @resource.admin_users.accessible_by(current_ability, :manage)
+ @resource.users.accessible_by(current_ability, :manage)
end
def choose_layout
diff --git a/admin/app/helpers/spree/admin/posts_helper.rb b/admin/app/helpers/spree/admin/posts_helper.rb
index f46cacd53f..d8e6c2b681 100644
--- a/admin/app/helpers/spree/admin/posts_helper.rb
+++ b/admin/app/helpers/spree/admin/posts_helper.rb
@@ -2,7 +2,7 @@ module Spree
module Admin
module PostsHelper
def post_authors_select_options
- current_store.admin_users.map { |user| [user.name, user.id] }
+ current_store.users.map { |user| [user.name, user.id] }
end
end
end
diff --git a/admin/spec/controllers/spree/admin/invitations_controller_spec.rb b/admin/spec/controllers/spree/admin/invitations_controller_spec.rb
index 865f64eb42..910d62356f 100644
--- a/admin/spec/controllers/spree/admin/invitations_controller_spec.rb
+++ b/admin/spec/controllers/spree/admin/invitations_controller_spec.rb
@@ -188,7 +188,7 @@ RSpec.describe Spree::Admin::InvitationsController, type: :controller do
end
context 'with already accepted invitation' do
- let(:invitation) { create(:invitation, inviter: admin_user, resource: store, status: 'accepted') }
+ let(:invitation) { create(:invitation, inviter: admin_user, resource: store, status: 'accepted', invitee: create(:admin_user, :no_resource_user)) }
it 'redirects to root path' do
expect(response).to redirect_to(spree.root_path)
diff --git a/core/app/models/concerns/spree/user_methods.rb b/core/app/models/concerns/spree/user_methods.rb
index 0f3c1b5b8d..9630323083 100644
--- a/core/app/models/concerns/spree/user_methods.rb
+++ b/core/app/models/concerns/spree/user_methods.rb
@@ -32,6 +32,8 @@ module Spree
has_many :wished_items, through: :wishlists, source: :wished_items
has_many :gateway_customers, class_name: 'Spree::GatewayCustomer', foreign_key: :user_id
has_many :invitations, class_name: 'Spree::Invitation', foreign_key: :invitee_id, dependent: :destroy
+ has_many :resource_users, class_name: 'Spree::ResourceUser', foreign_key: :user_id, dependent: :destroy, as: :user
+ has_many :resources, through: :resource_users, source: :resource
belongs_to :ship_address, class_name: 'Spree::Address', optional: true
belongs_to :bill_address, class_name: 'Spree::Address', optional: true
diff --git a/core/app/models/spree/invitation.rb b/core/app/models/spree/invitation.rb
index 6c09c8dbe1..1af73008bc 100644
--- a/core/app/models/spree/invitation.rb
+++ b/core/app/models/spree/invitation.rb
@@ -16,6 +16,7 @@ module Spree
belongs_to :invitee, polymorphic: true # User or AdminUser
has_many :invitation_roles, dependent: :destroy
has_many :roles, through: :invitation_roles
+ has_one :resource_user, dependent: :destroy
#
# Validations
@@ -37,10 +38,14 @@ module Spree
# State Machine
#
state_machine initial: :pending, attribute: :status do
+ state :accepted do
+ validates :invitee, presence: true
+ end
+
event :accept do
- transition :pending => :accepted
+ transition pending: :accepted
end
- after_transition to: :accepted, do: [:set_accepted_at, :send_acceptance_notification]
+ after_transition to: :accepted, do: [:create_resource_user, :set_accepted_at, :send_acceptance_notification]
end
#
@@ -98,9 +103,9 @@ module Spree
def invitee_already_exists
exists = if invitee.present?
- store.admin_users.include?(invitee)
+ resource.users.include?(invitee)
else
- store.admin_users.exists?(email: email)
+ resource.users.exists?(email: email)
end
if exists
@@ -111,5 +116,14 @@ module Spree
def set_accepted_at
update!(accepted_at: Time.current)
end
+
+ def create_resource_user
+ return if invitee.blank?
+
+ resource.resource_users.find_or_create_by!(user: invitee) do |resource_user|
+ resource_user.invitation = self
+ resource_user.user.spree_roles = roles
+ end
+ end
end
end
diff --git a/core/app/models/spree/resource_user.rb b/core/app/models/spree/resource_user.rb
new file mode 100644
index 0000000000..b007b8507f
--- /dev/null
+++ b/core/app/models/spree/resource_user.rb
@@ -0,0 +1,43 @@
+module Spree
+ class ResourceUser < Base
+ #
+ # Associations
+ #
+ belongs_to :resource, polymorphic: true # Store, Vendor, etc
+ belongs_to :user, polymorphic: true # Spree::User, Spree::AdminUser, etc
+ belongs_to :invitation, optional: true # Spree::Invitation, if the resource_user was created from an invitation
+ has_many :invitation_roles, through: :invitation, source: :roles
+
+ #
+ # Validations
+ #
+ validates :resource_id, uniqueness: { scope: [:resource_type, :user_id, :user_type] }
+
+ #
+ # Scopes
+ #
+ scope :by_resource, ->(resource) { where(resource: resource) }
+ scope :by_user, ->(user) { where(user: user) }
+
+ #
+ # Callbacks
+ #
+ after_create :set_roles
+ after_destroy :revoke_roles
+
+ private
+
+ def set_roles
+ return if invitation.blank?
+
+ user.spree_roles = invitation_roles
+ user.save!
+ end
+
+ def revoke_roles
+ return if invitation.blank?
+
+ user.spree_roles.where(id: invitation_role_ids).destroy_all
+ end
+ end
+end
diff --git a/core/app/models/spree/store.rb b/core/app/models/spree/store.rb
index 51d2aeb323..8b411c3b9b 100644
--- a/core/app/models/spree/store.rb
+++ b/core/app/models/spree/store.rb
@@ -103,6 +103,10 @@ module Spree
has_many :posts
has_many :post_categories
+ # Store Staff
+ has_many :resource_users, class_name: 'Spree::ResourceUser', as: :resource
+ has_many :users, through: :resource_users, source: :user, source_type: Spree.admin_user_class.to_s
+
#
# Page Builder associations
#
@@ -348,10 +352,10 @@ module Spree
end
def admin_users
- @admin_users ||= Spree.admin_user_class.joins(:spree_roles).where(spree_roles: { name: :admin })
- end
+ Spree::Deprecation.warn('Store#admin_users is deprecated and will be removed in Spree 6.0. Please use Store#users instead.')
- alias_method :users, :admin_users
+ users
+ end
def favicon
return unless favicon_image.attached? && favicon_image.variable?
diff --git a/core/app/services/spree/seeds/admin_user.rb b/core/app/services/spree/seeds/admin_user.rb
index fd9b2d1f47..4a6cffcf9f 100644
--- a/core/app/services/spree/seeds/admin_user.rb
+++ b/core/app/services/spree/seeds/admin_user.rb
@@ -15,6 +15,10 @@ module Spree
user.spree_roles << Spree::Role.find_or_create_by(name: :admin)
user.save!
+
+ Spree::Store.all.each do |store|
+ store.resource_users.find_or_create_by!(user: user)
+ end
end
end
end
diff --git a/core/db/migrate/20250414092155_create_spree_resource_users.rb b/core/db/migrate/20250414092155_create_spree_resource_users.rb
new file mode 100644
index 0000000000..9e2d92a4db
--- /dev/null
+++ b/core/db/migrate/20250414092155_create_spree_resource_users.rb
@@ -0,0 +1,13 @@
+class CreateSpreeResourceUsers < ActiveRecord::Migration[7.2]
+ def change
+ create_table :spree_resource_users do |t|
+ t.references :resource, null: false, polymorphic: true # Store, Vendor, etc
+ t.references :user, null: false, polymorphic: true # Spree::User, Spree::AdminUser, etc
+ t.references :invitation, null: true # Spree::Invitation, if the resource_user was created from an invitation
+
+ t.timestamps
+ end
+
+ add_index :spree_resource_users, [:resource_id, :resource_type, :user_id, :user_type], unique: true
+ end
+end
diff --git a/core/lib/spree/testing_support/factories/resource_user_factory.rb b/core/lib/spree/testing_support/factories/resource_user_factory.rb
new file mode 100644
index 0000000000..ce8644a8cf
--- /dev/null
+++ b/core/lib/spree/testing_support/factories/resource_user_factory.rb
@@ -0,0 +1,6 @@
+FactoryBot.define do
+ factory :resource_user, class: Spree::ResourceUser do
+ association :resource, factory: :store
+ association :user, factory: :admin_user
+ end
+end
diff --git a/core/lib/spree/testing_support/factories/user_factory.rb b/core/lib/spree/testing_support/factories/user_factory.rb
index 4a7bac5ce3..a7ede9f6e5 100644
--- a/core/lib/spree/testing_support/factories/user_factory.rb
+++ b/core/lib/spree/testing_support/factories/user_factory.rb
@@ -31,5 +31,22 @@ FactoryBot.define do
last_name { FFaker::Name.last_name }
spree_roles { [Spree::Role.find_by(name: 'admin') || create(:role, name: 'admin')] }
+
+ trait :no_resource_user do
+ transient do
+ skip_resource_user { true }
+ end
+ end
+
+ transient do
+ skip_resource_user { false }
+ end
+
+ after(:create) do |user, evaluator|
+ unless evaluator.skip_resource_user
+ resource = Spree::Store.default
+ resource.resource_users.find_by(user: user) || create(:resource_user, user: user, resource: resource)
+ end
+ end
end
end
diff --git a/core/lib/tasks/core.rake b/core/lib/tasks/core.rake
index 5c40dd5ccf..c5e9832309 100644
--- a/core/lib/tasks/core.rake
+++ b/core/lib/tasks/core.rake
@@ -184,6 +184,14 @@ use rake db:load_file[/absolute/path/to/sample/filename.rb]}
end
end
end
+
+ task migrate_admin_users_to_resource_users: :environment do |_t, _args|
+ Spree::AdminUser.all.each do |admin_user|
+ Spree::Store.all.each do |store|
+ store.resource_users.find_or_create_by!(user: admin_user)
+ end
+ end
+ end
end
namespace :core do
diff --git a/core/spec/models/spree/invitation_spec.rb b/core/spec/models/spree/invitation_spec.rb
index f157cabae1..c4496d0144 100644
--- a/core/spec/models/spree/invitation_spec.rb
+++ b/core/spec/models/spree/invitation_spec.rb
@@ -52,19 +52,32 @@ RSpec.describe Spree::Invitation, type: :model do
context 'when accepting an invitation' do
it 'changes status to accepted' do
+ invitation.invitee = create(:admin_user, :no_resource_user)
invitation.accept
expect(invitation.status).to eq('accepted')
end
it 'sets accepted_at timestamp' do
- expect { invitation.accept }.to change { invitation.accepted_at }.from(nil)
+ expect(invitation.accepted_at).to be_nil
+ invitation.invitee = create(:admin_user, :no_resource_user)
+ invitation.accept
+ expect(invitation.accepted_at).to be_present
end
it 'sends acceptance notification' do
- invitation
+ invitation.invitee = create(:admin_user, :no_resource_user)
clear_enqueued_jobs
expect { invitation.accept }.to have_enqueued_job(ActionMailer::MailDeliveryJob)
end
+
+ it 'creates a resource user' do
+ invitation.invitee = create(:admin_user, :no_resource_user)
+ expect { invitation.accept }.to change(invitation, :resource_user).from(nil).to(Spree::ResourceUser)
+ expect(invitation.resource_user.user).to eq(invitation.invitee)
+ expect(invitation.resource_user.resource).to eq(invitation.resource)
+ expect(invitation.resource_user.invitation).to eq(invitation)
+ expect(invitation.resource_user.user.spree_roles).to eq(invitation.roles)
+ end
end
end
@@ -94,6 +107,7 @@ RSpec.describe Spree::Invitation, type: :model do
end
it 'does not send invitation email if invitation is accepted' do
+ invitation.invitee = create(:admin_user, :no_resource_user)
invitation.accept
expect(invitation).not_to receive(:send_invitation_email)
invitation.resend!
diff --git a/core/spec/models/spree/resource_user_spec.rb b/core/spec/models/spree/resource_user_spec.rb
new file mode 100644
index 0000000000..7395de2b6a
--- /dev/null
+++ b/core/spec/models/spree/resource_user_spec.rb
@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+RSpec.describe Spree::ResourceUser, type: :model do
+ let(:resource_user) { create(:resource_user) }
+ let!(:admin_user) { create(:admin_user, :no_resource_user, spree_roles: []) }
+ let(:store) { @default_store }
+ let(:invitation) { create(:invitation, resource: store, roles: [create(:role)]) }
+
+ describe 'Callbacks' do
+ context 'after_create' do
+ it 'sets roles from invitation when invitation is present' do
+ role = create(:role)
+ invitation = create(:invitation, roles: [role])
+
+ resource_user = build(:resource_user,
+ invitation: invitation,
+ user: admin_user,
+ resource: invitation.resource)
+
+ expect { resource_user.save! }.to change { admin_user.reload.spree_roles.count }.by(1)
+ expect(admin_user.spree_roles).to include(role)
+ end
+
+ it 'does not set roles when invitation is not present' do
+ resource_user = build(:resource_user, user: admin_user)
+
+ expect { resource_user.save! }.not_to change { admin_user.reload.spree_roles.count }
+ end
+ end
+
+ context 'after_destroy' do
+ it 'revokes roles from invitation when invitation is present' do
+ role = create(:role)
+ invitation = create(:invitation, roles: [role])
+
+ resource_user = create(:resource_user,
+ invitation: invitation,
+ user: admin_user,
+ resource: invitation.resource)
+
+ expect(admin_user.reload.spree_roles).to include(role)
+ expect { resource_user.destroy }.to change { admin_user.reload.spree_roles.count }.by(-1)
+ end
+
+ it 'does not revoke roles when invitation is not present' do
+ role = create(:role)
+ admin_user.spree_roles << role
+ resource_user = create(:resource_user, user: admin_user)
+
+ expect { resource_user.destroy }.not_to change { admin_user.reload.spree_roles.count }
+ end
+ end
+ end
+end
diff --git a/core/spec/models/spree/store_spec.rb b/core/spec/models/spree/store_spec.rb
index 91b9c16595..d4550b7cb4 100644
--- a/core/spec/models/spree/store_spec.rb
+++ b/core/spec/models/spree/store_spec.rb
@@ -819,13 +819,4 @@ describe Spree::Store, type: :model, without_global_store: true do
it { expect(store.formatted_url_or_custom_domain).to eq('http://mystore.com:3000') }
end
end
-
- describe '#admin_users' do
- let(:store) { create(:store) }
- let(:admin_user) { create(:admin_user) }
-
- it 'returns the admin users' do
- expect(store.admin_users).to eq([admin_user])
- end
- end
end
diff --git a/sample/db/samples/posts.rb b/sample/db/samples/posts.rb
index 5abe9255cf..ac81c397b8 100644
--- a/sample/db/samples/posts.rb
+++ b/sample/db/samples/posts.rb
@@ -4,5 +4,5 @@ store.posts.create!(
title: 'Hello World',
content: 'This is a test post',
published_at: Time.current,
- author: store.admin_users.first,
+ author: store.users.first,
)