+ <%= form_for [:admin, @user_group] do |f| %>
+
+ <% end %>
+
diff --git a/backend/app/views/spree/admin/users/_form.html.erb b/backend/app/views/spree/admin/users/_form.html.erb
index 760d62a516c..9e29570363d 100644
--- a/backend/app/views/spree/admin/users/_form.html.erb
+++ b/backend/app/views/spree/admin/users/_form.html.erb
@@ -78,3 +78,16 @@
<% end %>
+
+<% if can?(:update, @user) && can?(:manage, :user_group) %>
+
+<% end %>
diff --git a/backend/config/routes.rb b/backend/config/routes.rb
index a0fc0fad00e..656d822c730 100644
--- a/backend/config/routes.rb
+++ b/backend/config/routes.rb
@@ -16,6 +16,7 @@
resources :zones
+ resources :user_groups
resources :tax_categories
resources :products do
diff --git a/backend/lib/spree/backend_configuration.rb b/backend/lib/spree/backend_configuration.rb
index 5621fb4641a..690baa26838 100644
--- a/backend/lib/spree/backend_configuration.rb
+++ b/backend/lib/spree/backend_configuration.rb
@@ -234,8 +234,24 @@ def menu_items
label: :users,
icon: admin_updated_navbar ? 'ri-user-line' : 'user',
match_path: %r{/(users|store_credits)},
+ data_hook: :admin_users_sub_tabs,
+ partial: 'spree/admin/shared/users_sub_menu',
condition: -> { Spree.user_class && can?(:admin, Spree.user_class) },
url: :admin_users_path,
+ children: [
+ MenuItem.new(
+ label: :users,
+ condition: -> { Spree.user_class && can?(:admin, Spree.user_class) },
+ url: :admin_users_path
+ ),
+ MenuItem.new(
+ label: :user_groups,
+ condition: -> {
+ can?(:admin, Spree::UserGroup)
+ },
+ url: :admin_user_groups_path
+ ),
+ ]
),
MenuItem.new(
label: :settings,
diff --git a/backend/spec/controllers/spree/admin/user_groups_controller_spec.rb b/backend/spec/controllers/spree/admin/user_groups_controller_spec.rb
new file mode 100644
index 00000000000..43eba84391c
--- /dev/null
+++ b/backend/spec/controllers/spree/admin/user_groups_controller_spec.rb
@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Spree::Admin::UserGroupsController, type: :controller do
+ stub_authorization!
+
+ let(:user_group) { create(:user_group) }
+
+ describe '#index' do
+ it 'retrieves all user groups and assigns them to the view' do
+ get :index
+
+ expect(assigns(:user_groups)).to eq([user_group])
+ end
+ end
+
+ describe '#new' do
+ it 'prepares a new user group for the form' do
+ get :new
+
+ expect(assigns(:user_group)).to be_a_new(Spree::UserGroup)
+ end
+ end
+
+ describe '#edit' do
+ it 'loads the specified user group for editing' do
+ get :edit, params: { id: user_group.id }
+
+ expect(assigns(:user_group)).to eq(user_group)
+ end
+ end
+
+ describe '#create' do
+ context 'with valid params' do
+ let(:valid_attributes) { { group_name: 'New User Group' } }
+
+ it 'saves a new user group to the database' do
+ expect {
+ post :create, params: { user_group: valid_attributes }
+ }.to change(Spree::UserGroup, :count).by(1)
+ end
+
+ it 'makes the newly created user group available to the view' do
+ post :create, params: { user_group: valid_attributes }
+
+ expect(assigns(:user_group)).to be_a(Spree::UserGroup)
+ expect(assigns(:user_group)).to be_persisted
+ end
+
+ it 'redirects to the user groups list page' do
+ post :create, params: { user_group: valid_attributes }
+
+ expect(response).to redirect_to(spree.admin_user_groups_path)
+ end
+ end
+
+ context 'with invalid params' do
+ let(:invalid_attributes) { { group_name: nil } }
+
+ it 'does not save the user group and prepares a new instance for the form' do
+ post :create, params: { user_group: invalid_attributes }
+
+ expect(assigns(:user_group)).to be_a_new(Spree::UserGroup)
+ end
+
+ it 'renders the "new" form again' do
+ post :create, params: { user_group: invalid_attributes }
+
+ expect(response).to render_template('new')
+ end
+ end
+ end
+
+ describe '#update' do
+ context 'with valid params' do
+ let(:new_attributes) { { group_name: 'Updated Group Name' } }
+
+ it 'updates the user group with the provided attributes' do
+ put :update, params: { id: user_group.id, user_group: new_attributes }
+
+ user_group.reload
+
+ expect(user_group.group_name).to eq('Updated Group Name')
+ end
+
+ it 'makes the updated user group available to the view' do
+ put :update, params: { id: user_group.id, user_group: new_attributes }
+
+ expect(assigns(:user_group)).to eq(user_group)
+ end
+
+ it 'redirects to the user groups list page' do
+ put :update, params: { id: user_group.id, user_group: new_attributes }
+
+ expect(response).to redirect_to(spree.admin_user_groups_path)
+ end
+ end
+
+ context 'with invalid params' do
+ let(:invalid_attributes) { { group_name: nil } }
+
+ it 'does not update the user group and keeps the original instance' do
+ put :update, params: { id: user_group.id, user_group: invalid_attributes }
+
+ expect(assigns(:user_group)).to eq(user_group)
+ end
+
+ it 'renders the "edit" form again' do
+ put :update, params: { id: user_group.id, user_group: invalid_attributes }
+
+ expect(response).to render_template('edit')
+ end
+ end
+ end
+
+ describe '#destroy' do
+ it 'removes the user group from the database' do
+ user_group = create(:user_group)
+ expect {
+ delete :destroy, params: { id: user_group.id }
+ }.to change(Spree::UserGroup, :count).by(-1)
+ end
+
+ it 'redirects to the user groups list page' do
+ delete :destroy, params: { id: user_group.id }
+
+ expect(response).to redirect_to(spree.admin_user_groups_path)
+ end
+ end
+end
diff --git a/backend/spec/controllers/spree/admin/users_controller_spec.rb b/backend/spec/controllers/spree/admin/users_controller_spec.rb
index c8ad0d41f61..9bb1d8b3eda 100644
--- a/backend/spec/controllers/spree/admin/users_controller_spec.rb
+++ b/backend/spec/controllers/spree/admin/users_controller_spec.rb
@@ -295,6 +295,37 @@ def user
expect(user.stock_locations).to eq([location1])
end
end
+
+ context "When the user can manage user group" do
+ stub_authorization! do |_user|
+ can :manage, Spree.user_class
+ can :manage, Spree::UserGroup
+ end
+
+ it "can create user with user group" do
+ user_group = Spree::UserGroup.create(group_name: "my_user_group")
+
+ post :create, params: { user: { user_group_id: user_group } }
+
+ expect(user.user_group).to eq(user_group)
+ end
+ end
+
+ context "when the user is created and store enforce user group on sign up" do
+ stub_authorization! do |_user|
+ can :manage, Spree.user_class
+ can :manage, Spree::UserGroup
+ end
+
+ it "can create user with user group" do
+ user_group = Spree::UserGroup.create(group_name: "my_user_group")
+ store = create(:store, default_cart_user_group: user_group, enforce_group_upon_signup: true)
+
+ post :create, params: { user: { email: 'new_user@exapmle.com' } }
+
+ expect(user.user_group).to eq(store.default_cart_user_group)
+ end
+ end
end
describe "#update" do
@@ -479,6 +510,21 @@ def user
expect(user.reload.stock_locations).to eq([location1])
end
end
+
+ context "When the user can manage user group" do
+ stub_authorization! do |_user|
+ can :manage, Spree.user_class
+ can :manage, Spree::UserGroup
+ end
+
+ it "can update user with user group" do
+ user_group = Spree::UserGroup.create(group_name: "my_user_group")
+
+ post :update, params: { id: user.id, user: { user_group_id: user_group } }
+
+ expect(user.reload.user_group).to eq(user_group)
+ end
+ end
end
describe "#destroy" do
diff --git a/backend/spec/features/admin/store_credits_spec.rb b/backend/spec/features/admin/store_credits_spec.rb
index aa05612a028..afdf85184d0 100644
--- a/backend/spec/features/admin/store_credits_spec.rb
+++ b/backend/spec/features/admin/store_credits_spec.rb
@@ -17,7 +17,7 @@
describe "visiting the store credits page" do
before do
visit spree.admin_path
- click_link "Users"
+ click_nav "Users"
end
it "should be on the store credits page" do
@@ -37,7 +37,7 @@
describe "creating store credit" do
before do
visit spree.admin_path
- click_link "Users"
+ click_nav "Users"
click_link store_credit.user.email
click_link "Store Credit"
allow_any_instance_of(Spree::Admin::StoreCreditsController).to receive_messages(spree_current_user: admin_user)
@@ -59,7 +59,7 @@
describe "displaying a store credit details page" do
before do
visit spree.admin_path
- click_link "Users"
+ click_nav "Users"
click_link store_credit.user.email
click_link "Store Credit"
page.find(".sc-table td.actions a.fa-edit").click
@@ -111,7 +111,7 @@
before do
visit spree.admin_path
- click_link "Users"
+ click_nav "Users"
click_link store_credit.user.email
click_link "Store Credit"
allow_any_instance_of(Spree::Admin::StoreCreditsController).to receive_messages(spree_current_user: admin_user)
diff --git a/backend/spec/features/admin/stores_spec.rb b/backend/spec/features/admin/stores_spec.rb
index 1ae571671b4..bdc8875d3af 100644
--- a/backend/spec/features/admin/stores_spec.rb
+++ b/backend/spec/features/admin/stores_spec.rb
@@ -5,6 +5,9 @@
describe 'Stores', type: :feature do
stub_authorization!
+ let!(:user_group) { create :user_group, group_name: 'Default Group' }
+ let!(:new_user_group) { create :user_group, group_name: 'New Group' }
+
context 'when adding a store' do
before { visit spree.new_admin_store_path }
@@ -22,10 +25,25 @@
expect(@store.default_currency).to eq 'EUR'
end
+
+ it 'admin should be able to set the default_cart_user_group' do
+ expect(find('#store_default_cart_user_group_id').value).to eq ''
+
+ fill_in 'store_name', with: 'Solidus Store'
+ fill_in 'store_code', with: 'solidus'
+ fill_in 'store_url', with: 'example.solidus.io'
+ fill_in 'store_mail_from_address', with: 'from@solidus.io'
+ select 'Default Group', from: 'store_default_cart_user_group_id'
+ click_button 'Create'
+
+ @store = Spree::Store.last
+
+ expect(@store.default_cart_user_group).to eq user_group
+ end
end
context 'when editing a store' do
- let(:store) { create :store, default_currency: 'AUD' }
+ let(:store) { create :store, default_currency: 'AUD', default_cart_user_group: user_group }
before { visit spree.edit_admin_store_path(store) }
it 'admin should be able to change the default_currency' do
@@ -33,5 +51,12 @@
click_button 'Update'
expect(store.reload.default_currency).to eq 'EUR'
end
+
+ it 'admin should be able to change the default_cart_user_group' do
+ select 'New Group', from: 'store_default_cart_user_group_id'
+ click_button 'Update'
+
+ expect(store.reload.default_cart_user_group).to eq new_user_group
+ end
end
end
diff --git a/backend/spec/features/admin/user_group_spec.rb b/backend/spec/features/admin/user_group_spec.rb
new file mode 100644
index 00000000000..962e2a490ce
--- /dev/null
+++ b/backend/spec/features/admin/user_group_spec.rb
@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'User Groups', type: :feature do
+ stub_authorization!
+
+ let!(:user_group) { create :user_group, group_name: 'Default Group' }
+
+ context 'when adding a user group' do
+ before { visit spree.new_admin_user_group_path }
+
+ it 'admin should be able to create a user group' do
+ fill_in 'user_group_group_name', with: 'VIP Group'
+ click_button 'Create'
+
+ @user_group = Spree::UserGroup.last
+
+ expect(@user_group.group_name).to eq 'VIP Group'
+ end
+ end
+
+ context 'when editing a user group' do
+ before { visit spree.edit_admin_user_group_path(user_group) }
+
+ it 'admin should be able to change the group name' do
+ fill_in 'user_group_group_name', with: 'Updated Group'
+ click_button 'Update'
+
+ expect(user_group.reload.group_name).to eq 'Updated Group'
+ end
+ end
+
+ context 'when deleting a user group' do
+ before { visit spree.admin_user_groups_path }
+
+ it 'admin should be able to delete a user group', js: true do
+ within("#spree_user_group_#{user_group.id}") do
+ accept_alert do
+ click_icon :trash
+ end
+ end
+
+ expect(page).not_to have_content(user_group.group_name)
+ expect(Spree::UserGroup.exists?(user_group.id)).to be_falsey
+ end
+ end
+end
diff --git a/backend/spec/features/admin/users_spec.rb b/backend/spec/features/admin/users_spec.rb
index 5fdcdbb568d..2e1ffd8ca0d 100644
--- a/backend/spec/features/admin/users_spec.rb
+++ b/backend/spec/features/admin/users_spec.rb
@@ -99,7 +99,7 @@
before do
visit spree.admin_path
- click_link 'Users'
+ click_nav 'Users'
end
context 'users index' do
@@ -357,7 +357,7 @@ def always_invalid_email
context 'if an user has placed orders' do
before do
visit spree.admin_path
- click_link 'Users'
+ click_nav 'Users'
end
it "can't be deleted" do
diff --git a/core/app/models/concerns/spree/user_methods.rb b/core/app/models/concerns/spree/user_methods.rb
index 9218e26cd7a..950cc3a35c6 100644
--- a/core/app/models/concerns/spree/user_methods.rb
+++ b/core/app/models/concerns/spree/user_methods.rb
@@ -26,6 +26,8 @@ module UserMethods
has_many :credit_cards, class_name: "Spree::CreditCard", foreign_key: :user_id
has_many :wallet_payment_sources, foreign_key: 'user_id', class_name: 'Spree::WalletPaymentSource', inverse_of: :user
+ belongs_to :user_group, class_name: 'Spree::UserGroup', optional: true
+
after_create :auto_generate_spree_api_key
before_destroy :check_for_deletion
diff --git a/core/app/models/spree/store.rb b/core/app/models/spree/store.rb
index fd5aef8289c..b0917bcbe0b 100644
--- a/core/app/models/spree/store.rb
+++ b/core/app/models/spree/store.rb
@@ -17,6 +17,8 @@ class Store < Spree::Base
has_many :orders, class_name: "Spree::Order"
+ belongs_to :default_cart_user_group, class_name: 'Spree::UserGroup', optional: true
+
validates :code, presence: true, uniqueness: { allow_blank: true, case_sensitive: true }
validates :name, presence: true
validates :url, presence: true
diff --git a/core/app/models/spree/user_group.rb b/core/app/models/spree/user_group.rb
new file mode 100644
index 00000000000..89e69250cb2
--- /dev/null
+++ b/core/app/models/spree/user_group.rb
@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Spree
+ class UserGroup < Spree::Base
+ has_many :users, class_name: Spree::UserClassHandle.new
+ has_one :store, class_name: 'Spree::Store', foreign_key: 'default_cart_user_group_id'
+
+ validates :group_name, presence: true
+ end
+end
diff --git a/core/config/locales/en.yml b/core/config/locales/en.yml
index 138ee452c9c..1864ac24615 100644
--- a/core/config/locales/en.yml
+++ b/core/config/locales/en.yml
@@ -359,6 +359,7 @@ en:
cart_tax_country_iso: Tax Country for Empty Carts
code: Slug
default: Default
+ default_cart_user_group_id: Default User Group
default_currency: Default Currency
mail_from_address: Mail From Address
meta_description: Meta Description
@@ -757,6 +758,9 @@ en:
spree/user:
one: User
other: Users
+ spree/user_group:
+ one: User Group
+ other: User Groups
spree/variant:
one: Variant
other: Variants
@@ -959,6 +963,7 @@ en:
taxes: Taxes
taxonomies: Taxonomies
taxons: Taxons
+ user_groups: User Groups
users: Users
zones: Zones
taxons:
@@ -972,6 +977,7 @@ en:
order_num: 'Order #'
orders: Orders
store_credit: Store Credit
+ user_group: User Group
user_information: User Information
users:
edit:
@@ -1528,6 +1534,7 @@ en:
enable_mail_delivery: Enable Mail Delivery
end: End
ending_in: Ending in
+ enforce_group_upon_signup: Add all new users to Group
error: error
error_user_destroy_with_orders: Cannot delete a user with orders
errors:
@@ -1808,6 +1815,7 @@ en:
new_taxonomy: New Taxonomy
new_tracker: New Analytics Tracker
new_user: New User
+ new_user_group: New User Group
new_variant: New Variant
new_zone: New Zone
next: Next
diff --git a/core/db/migrate/20250409082118_create_user_groups.rb b/core/db/migrate/20250409082118_create_user_groups.rb
new file mode 100644
index 00000000000..ba9b069a6a1
--- /dev/null
+++ b/core/db/migrate/20250409082118_create_user_groups.rb
@@ -0,0 +1,9 @@
+class CreateUserGroups < ActiveRecord::Migration[7.0]
+ def change
+ create_table :spree_user_groups do |t|
+ t.string :group_name
+
+ t.timestamps
+ end
+ end
+end
diff --git a/core/db/migrate/20250409082222_add_user_group_id_to_users.rb b/core/db/migrate/20250409082222_add_user_group_id_to_users.rb
new file mode 100644
index 00000000000..4ee363e3aa6
--- /dev/null
+++ b/core/db/migrate/20250409082222_add_user_group_id_to_users.rb
@@ -0,0 +1,7 @@
+class AddUserGroupIdToUsers < ActiveRecord::Migration[7.0]
+ def change
+ change_table Spree.user_class.table_name do |t|
+ t.references :user_group, type: :integer, foreign_key: { to_table: :spree_user_groups }
+ end
+ end
+end
diff --git a/core/db/migrate/20250409082257_add_default_user_group_to_stores.rb b/core/db/migrate/20250409082257_add_default_user_group_to_stores.rb
new file mode 100644
index 00000000000..90a1ceaafd7
--- /dev/null
+++ b/core/db/migrate/20250409082257_add_default_user_group_to_stores.rb
@@ -0,0 +1,8 @@
+class AddDefaultUserGroupToStores < ActiveRecord::Migration[7.0]
+ def change
+ change_table :spree_stores do |t|
+ t.references :default_cart_user_group, type: :integer, foreign_key: { to_table: :spree_user_groups }
+ t.boolean :enforce_group_upon_signup, default: false
+ end
+ end
+end
diff --git a/core/lib/spree/permitted_attributes.rb b/core/lib/spree/permitted_attributes.rb
index bb7220e280f..6039b85a7e6 100644
--- a/core/lib/spree/permitted_attributes.rb
+++ b/core/lib/spree/permitted_attributes.rb
@@ -137,7 +137,7 @@ module PermittedAttributes
# by changing a user with higher priveleges' email to one a lower-priveleged
# admin owns. Creating a user with an email is handled separate at the
# controller level.
- @@user_attributes = [:password, :password_confirmation, customer_metadata: {}]
+ @@user_attributes = [:password, :password_confirmation, :user_group_id, customer_metadata: {}]
@@variant_attributes = [
:name, :presentation, :cost_price, :lock_version,
diff --git a/core/lib/spree/testing_support/factories/user_group_factory.rb b/core/lib/spree/testing_support/factories/user_group_factory.rb
new file mode 100644
index 00000000000..224f841c407
--- /dev/null
+++ b/core/lib/spree/testing_support/factories/user_group_factory.rb
@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+ factory :user_group, class: 'Spree::UserGroup' do
+ group_name { "Default User Group" }
+ end
+end
diff --git a/core/spec/models/spree/store_spec.rb b/core/spec/models/spree/store_spec.rb
index 9bf552581d6..786e1f80f7e 100644
--- a/core/spec/models/spree/store_spec.rb
+++ b/core/spec/models/spree/store_spec.rb
@@ -50,6 +50,27 @@
end
end
+ describe '#default_cart_user_group' do
+ subject { described_class.new(default_cart_user_group_id:) }
+
+ context "when there is no default_cart_user_group set" do
+ let(:default_cart_user_group_id) { nil }
+
+ it "responds with an empty default_cart_user_group" do
+ expect(subject.default_cart_user_group).to be_nil
+ end
+ end
+
+ context "when there is a default_cart_user_group set" do
+ let(:user_group) { create(:user_group) }
+ let(:default_cart_user_group_id) { user_group.id }
+
+ it "responds with a default_cart_user_group with that user group" do
+ expect(subject.default_cart_user_group).to eq(user_group)
+ end
+ end
+ end
+
describe '#available_locales' do
let(:store) { described_class.new(available_locales: locales) }
subject { store.available_locales }
diff --git a/core/spec/models/spree/user_group_spec.rb b/core/spec/models/spree/user_group_spec.rb
new file mode 100644
index 00000000000..63029c7c34c
--- /dev/null
+++ b/core/spec/models/spree/user_group_spec.rb
@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe Spree::UserGroup, type: :model do
+ describe 'associations' do
+ it 'has many users' do
+ association = described_class.reflect_on_association(:users)
+
+ expect(association.macro).to eq :has_many
+ expect(association.class_name).to eq Spree::UserClassHandle.new.to_s
+ end
+
+ it 'has one store' do
+ association = described_class.reflect_on_association(:store)
+
+ expect(association.macro).to eq :has_one
+ expect(association.class_name).to eq 'Spree::Store'
+ expect(association.options[:foreign_key]).to eq 'default_cart_user_group_id'
+ end
+ end
+
+ describe 'validations' do
+ context 'when validating presence' do
+ it 'validates presence of group_name' do
+ user_group = Spree::UserGroup.new
+ user_group.valid?
+
+ expect(user_group.errors[:group_name]).to include("can't be blank")
+ end
+ end
+
+ context 'when creating a valid user group' do
+ it 'is valid with a group_name' do
+ user_group = Spree::UserGroup.new(group_name: 'Test Group')
+
+ expect(user_group).to be_valid
+ end
+ end
+ end
+
+ describe 'user group relations' do
+ let(:user_group) { create(:user_group) }
+
+ context '#users' do
+ let(:user) { create(:user) }
+
+ before do
+ user_group.users << user
+ end
+
+ it 'returns the associated users' do
+ expect(user_group.users).to include(user)
+ end
+ end
+
+ context '#store' do
+ let(:store) { create(:store, default_cart_user_group: user_group) }
+
+ it 'returns the associated store' do
+ store.reload
+ user_group.reload
+
+ expect(user_group.store).to eq(store)
+ end
+ end
+ end
+end
diff --git a/core/spec/models/spree/user_spec.rb b/core/spec/models/spree/user_spec.rb
index 3b8b7dc6496..5365497dc8c 100644
--- a/core/spec/models/spree/user_spec.rb
+++ b/core/spec/models/spree/user_spec.rb
@@ -157,5 +157,26 @@ def load_orders
expect(subject.display_average_order_value).to eq Spree::Money.new(value)
end
end
+
+ describe "user_group" do
+ subject { described_class.new(user_group_id:) }
+
+ context "when there is no user_group set" do
+ let(:user_group_id) { nil }
+
+ it "responds with an empty user_group" do
+ expect(subject.user_group).to be_nil
+ end
+ end
+
+ context "when there is a user_group set" do
+ let(:user_group) { create(:user_group) }
+ let(:user_group_id) { user_group.id }
+
+ it "responds with a default_cart_user_group with that user group" do
+ expect(subject.user_group).to eq(user_group)
+ end
+ end
+ end
end
end