Model for user roles in the context of a space

Author: fbacall

app/models/space.rb

@@ -9,6 +9,8 @@ class Space < ApplicationRecord
   has_many :collections, dependent: :nullify
   has_many :learning_paths, dependent: :nullify
   has_many :learning_path_topics, dependent: :nullify
+  has_many :space_roles, dependent: :destroy
+  has_many :space_role_users, through: :space_roles, source: :user, class_name: 'User'
 
   has_image(placeholder: TeSS::Config.placeholder['content_provider'])
 
@@ -35,4 +37,8 @@ def url
   def default?
     false
   end
+
+  def with_space_role?(role)
+    space_role_users.joins(:space_roles).where(space_roles: { key: role })
+  end
 end

app/models/space_role.rb

@@ -0,0 +1,7 @@
+class SpaceRole < ApplicationRecord
+  ROLES = ['admin'].freeze
+  belongs_to :user
+  belongs_to :space
+
+  validates :key, inclusion: { in: ROLES }
+end

app/models/user.rb

@@ -52,6 +52,7 @@ class User < ApplicationRecord
   has_and_belongs_to_many :editables, class_name: "ContentProvider"
 
   has_many :collaborations, dependent: :destroy
+  has_many :space_roles, dependent: :destroy
 
   before_create :set_default_role, :set_default_profile
   before_create :skip_email_confirmation_for_non_production
@@ -374,6 +375,10 @@ def purge
     end
   end
 
+  def has_space_role?(space, role)
+    space_roles.where(key: role, space: space).any?
+  end
+
   protected
 
   def reassign_resources(new_owner = User.get_default_user)

config/data/space_roles.yml

@@ -0,0 +1,4 @@
+space_admin:
+  title: Administrator
+space_curator:
+  title: Curator

db/migrate/20250304161944_create_space_roles.rb

@@ -0,0 +1,10 @@
+class CreateSpaceRoles < ActiveRecord::Migration[7.2]
+  def change
+    create_table :space_roles do |t|
+      t.string :key
+      t.references :user, foreign_key: true, index: true
+      t.references :space, foreign_key: true, index: true
+      t.timestamps
+    end
+  end
+end

db/schema.rb

@@ -10,7 +10,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema[7.2].define(version: 2025_02_10_093412) do
+ActiveRecord::Schema[7.2].define(version: 2025_03_04_161944) do
   # These are extensions that must be enabled in order to support this database
   enable_extension "plpgsql"
 
@@ -483,6 +483,16 @@
     t.index ["user_id"], name: "index_sources_on_user_id"
   end
 
+  create_table "space_roles", force: :cascade do |t|
+    t.string "key"
+    t.bigint "user_id"
+    t.bigint "space_id"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.index ["space_id"], name: "index_space_roles_on_space_id"
+    t.index ["user_id"], name: "index_space_roles_on_user_id"
+  end
+
   create_table "spaces", force: :cascade do |t|
     t.string "title"
     t.text "description"
@@ -654,6 +664,8 @@
   add_foreign_key "nodes", "users"
   add_foreign_key "sources", "content_providers"
   add_foreign_key "sources", "users"
+  add_foreign_key "space_roles", "spaces"
+  add_foreign_key "space_roles", "users"
   add_foreign_key "spaces", "users"
   add_foreign_key "staff_members", "nodes"
   add_foreign_key "stars", "users"

test/models/space_role_test.rb

@@ -0,0 +1,44 @@
+require 'test_helper'
+
+class SpaceRoleTest < ActiveSupport::TestCase
+  setup do
+    @space = spaces(:plants)
+  end
+
+  test 'validates role key' do
+    invalid_key = @space.space_roles.build(user: users(:regular_user), key: :yes)
+    refute invalid_key.valid?
+    assert invalid_key.errors.added?(:key, :inclusion, value: 'yes')
+
+    valid_key = @space.space_roles.build(user: users(:regular_user), key: :admin)
+    assert valid_key.valid?
+  end
+
+  test 'can retrieve list of users with a given role in a space' do
+    user = users(:regular_user)
+    another_user = users(:another_regular_user)
+    @space.space_roles.create!(user: user, key: :admin)
+    @space.space_roles.create!(user: another_user, key: :admin)
+
+    admins = @space.with_space_role?(:admin)
+    assert_equal 2, admins.length
+    assert_includes admins, user
+    assert_includes admins, another_user
+
+    assert_equal 2, @space.with_space_role?('admin').length
+
+    assert_empty @space.with_space_role?(:badmin)
+  end
+
+  test 'can check if a user has a given role in a space' do
+    user = users(:regular_user)
+    another_user = users(:another_regular_user)
+    @space.space_roles.create!(user: user, key: :admin)
+
+    assert user.has_space_role?(@space, :admin)
+    assert user.has_space_role?(@space, 'admin')
+    refute user.has_space_role?(spaces(:astro), :admin)
+    refute user.has_space_role?(@space, :overlord)
+    refute another_user.has_space_role?(@space, :admin)
+  end
+end