Skip to content

Commit f847cf5

Browse files
AntoLCAntoLC
committed
replace-commentator-by-commenter
1 parent 4947ac5 commit f847cf5

10 files changed

+136
-136
lines changed

‎src/backend/core/choices.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,15 +33,15 @@ class LinkRoleChoices(PriorityTextChoices):
3333
"""Defines the possible roles a link can offer on a document."""
3434

3535
READER = "reader", _("Reader") # Can read
36-
COMMENTATOR = "commentator", _("Commentator") # Can read and comment
36+
COMMENTER = "commenter", _("Commenter") # Can read and comment
3737
EDITOR = "editor", _("Editor") # Can read and edit
3838

3939

4040
class RoleChoices(PriorityTextChoices):
4141
"""Defines the possible roles a user can have in a resource."""
4242

4343
READER = "reader", _("Reader") # Can read
44-
COMMENTATOR = "commentator", _("Commentator") # Can read and comment
44+
COMMENTER = "commenter", _("Commenter") # Can read and comment
4545
EDITOR = "editor", _("Editor") # Can read and edit
4646
ADMIN = "administrator", _("Administrator") # Can read, edit, delete and share
4747
OWNER = "owner", _("Owner")

‎src/backend/core/migrations/0025_alter_document_link_role_alter_documentaccess_role_and_more.py‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ class Migration(migrations.Migration):
1919
field=models.CharField(
2020
choices=[
2121
("reader", "Reader"),
22-
("commentator", "Commentator"),
22+
("commenter", "Commenter"),
2323
("editor", "Editor"),
2424
],
2525
default="reader",
@@ -32,7 +32,7 @@ class Migration(migrations.Migration):
3232
field=models.CharField(
3333
choices=[
3434
("reader", "Reader"),
35-
("commentator", "Commentator"),
35+
("commenter", "Commenter"),
3636
("editor", "Editor"),
3737
("administrator", "Administrator"),
3838
("owner", "Owner"),
@@ -47,7 +47,7 @@ class Migration(migrations.Migration):
4747
field=models.CharField(
4848
choices=[
4949
("reader", "Reader"),
50-
("commentator", "Commentator"),
50+
("commenter", "Commenter"),
5151
("editor", "Editor"),
5252
("administrator", "Administrator"),
5353
("owner", "Owner"),
@@ -62,7 +62,7 @@ class Migration(migrations.Migration):
6262
field=models.CharField(
6363
choices=[
6464
("reader", "Reader"),
65-
("commentator", "Commentator"),
65+
("commenter", "Commenter"),
6666
("editor", "Editor"),
6767
("administrator", "Administrator"),
6868
("owner", "Owner"),
@@ -77,7 +77,7 @@ class Migration(migrations.Migration):
7777
field=models.CharField(
7878
choices=[
7979
("reader", "Reader"),
80-
("commentator", "Commentator"),
80+
("commenter", "Commenter"),
8181
("editor", "Editor"),
8282
("administrator", "Administrator"),
8383
("owner", "Owner"),

‎src/backend/core/models.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -753,7 +753,7 @@ def get_abilities(self, user):
753753
can_update = (
754754
is_owner_or_admin or role == RoleChoices.EDITOR
755755
) and not is_deleted
756-
can_comment = (can_update or role == RoleChoices.COMMENTATOR) and not is_deleted and user.is_authenticated
756+
can_comment = (can_update or role == RoleChoices.COMMENTER) and not is_deleted and user.is_authenticated
757757
can_create_children = can_update and user.is_authenticated
758758
can_destroy = (
759759
is_owner
@@ -1147,7 +1147,7 @@ def get_abilities(self, user):
11471147
set_role_to.extend(
11481148
[
11491149
RoleChoices.READER,
1150-
RoleChoices.COMMENTATOR,
1150+
RoleChoices.COMMENTER,
11511151
RoleChoices.EDITOR,
11521152
RoleChoices.ADMIN,
11531153
]

‎src/backend/core/tests/documents/test_api_document_accesses.py‎

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -293,7 +293,7 @@ def test_api_document_accesses_retrieve_set_role_to_child():
293293
}
294294
assert result_dict[str(document_access_other_user.id)] == [
295295
"reader",
296-
"commentator",
296+
"commenter",
297297
"editor",
298298
"administrator",
299299
"owner",
@@ -302,7 +302,7 @@ def test_api_document_accesses_retrieve_set_role_to_child():
302302

303303
# Add an access for the other user on the parent
304304
parent_access_other_user = factories.UserDocumentAccessFactory(
305-
document=parent, user=other_user, role="commentator"
305+
document=parent, user=other_user, role="commenter"
306306
)
307307

308308
response = client.get(f"/api/v1.0/documents/{document.id!s}/accesses/")
@@ -315,15 +315,15 @@ def test_api_document_accesses_retrieve_set_role_to_child():
315315
result["id"]: result["abilities"]["set_role_to"] for result in content
316316
}
317317
assert result_dict[str(document_access_other_user.id)] == [
318-
"commentator",
318+
"commenter",
319319
"editor",
320320
"administrator",
321321
"owner",
322322
]
323323
assert result_dict[str(parent_access.id)] == []
324324
assert result_dict[str(parent_access_other_user.id)] == [
325325
"reader",
326-
"commentator",
326+
"commenter",
327327
"editor",
328328
"administrator",
329329
"owner",
@@ -336,28 +336,28 @@ def test_api_document_accesses_retrieve_set_role_to_child():
336336
[
337337
["administrator", "reader", "reader", "reader"],
338338
[
339-
["reader", "commentator", "editor", "administrator"],
339+
["reader", "commenter", "editor", "administrator"],
340340
[],
341341
[],
342-
["reader", "commentator", "editor", "administrator"],
342+
["reader", "commenter", "editor", "administrator"],
343343
],
344344
],
345345
[
346346
["owner", "reader", "reader", "reader"],
347347
[
348-
["reader", "commentator", "editor", "administrator", "owner"],
348+
["reader", "commenter", "editor", "administrator", "owner"],
349349
[],
350350
[],
351-
["reader", "commentator", "editor", "administrator", "owner"],
351+
["reader", "commenter", "editor", "administrator", "owner"],
352352
],
353353
],
354354
[
355355
["owner", "reader", "reader", "owner"],
356356
[
357-
["reader", "commentator", "editor", "administrator", "owner"],
357+
["reader", "commenter", "editor", "administrator", "owner"],
358358
[],
359359
[],
360-
["reader", "commentator", "editor", "administrator", "owner"],
360+
["reader", "commenter", "editor", "administrator", "owner"],
361361
],
362362
],
363363
],
@@ -418,52 +418,52 @@ def test_api_document_accesses_list_authenticated_related_same_user(roles, resul
418418
[
419419
["administrator", "reader", "reader", "reader"],
420420
[
421-
["reader", "commentator", "editor", "administrator"],
421+
["reader", "commenter", "editor", "administrator"],
422422
[],
423423
[],
424-
["reader", "commentator", "editor", "administrator"],
424+
["reader", "commenter", "editor", "administrator"],
425425
],
426426
],
427427
[
428428
["owner", "reader", "reader", "reader"],
429429
[
430-
["reader", "commentator", "editor", "administrator", "owner"],
430+
["reader", "commenter", "editor", "administrator", "owner"],
431431
[],
432432
[],
433-
["reader", "commentator", "editor", "administrator", "owner"],
433+
["reader", "commenter", "editor", "administrator", "owner"],
434434
],
435435
],
436436
[
437437
["owner", "reader", "reader", "owner"],
438438
[
439-
["reader", "commentator", "editor", "administrator", "owner"],
439+
["reader", "commenter", "editor", "administrator", "owner"],
440440
[],
441441
[],
442-
["reader", "commentator", "editor", "administrator", "owner"],
442+
["reader", "commenter", "editor", "administrator", "owner"],
443443
],
444444
],
445445
[
446446
["reader", "reader", "reader", "owner"],
447447
[
448-
["reader", "commentator", "editor", "administrator", "owner"],
448+
["reader", "commenter", "editor", "administrator", "owner"],
449449
[],
450450
[],
451-
["reader", "commentator", "editor", "administrator", "owner"],
451+
["reader", "commenter", "editor", "administrator", "owner"],
452452
],
453453
],
454454
[
455455
["reader", "administrator", "reader", "editor"],
456456
[
457-
["reader", "commentator", "editor", "administrator"],
458-
["reader", "commentator", "editor", "administrator"],
457+
["reader", "commenter", "editor", "administrator"],
458+
["reader", "commenter", "editor", "administrator"],
459459
[],
460460
[],
461461
],
462462
],
463463
[
464464
["editor", "editor", "administrator", "editor"],
465465
[
466-
["reader", "commentator", "editor", "administrator"],
466+
["reader", "commenter", "editor", "administrator"],
467467
[],
468468
["editor", "administrator"],
469469
[],

‎src/backend/core/tests/documents/test_api_documents_comments.py‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
def test_list_comments_anonymous_user_public_document():
1818
"""Anonymous users should be allowed to list comments on a public document."""
1919
document = factories.DocumentFactory(
20-
link_reach="public", link_role=models.LinkRoleChoices.COMMENTATOR
20+
link_reach="public", link_role=models.LinkRoleChoices.COMMENTER
2121
)
2222
comment1, comment2 = factories.CommentFactory.create_batch(2, document=document)
2323
# other comments not linked to the document
@@ -62,7 +62,7 @@ def test_list_comments_anonymous_user_public_document():
6262
def test_list_comments_anonymous_user_non_public_document(link_reach):
6363
"""Anonymous users should not be allowed to list comments on a non-public document."""
6464
document = factories.DocumentFactory(
65-
link_reach=link_reach, link_role=models.LinkRoleChoices.COMMENTATOR
65+
link_reach=link_reach, link_role=models.LinkRoleChoices.COMMENTER
6666
)
6767
factories.CommentFactory(document=document)
6868
# other comments not linked to the document
@@ -76,7 +76,7 @@ def test_list_comments_authenticated_user_accessible_document():
7676
"""Authenticated users should be allowed to list comments on an accessible document."""
7777
user = factories.UserFactory()
7878
document = factories.DocumentFactory(
79-
link_reach="restricted", users=[(user, models.LinkRoleChoices.COMMENTATOR)]
79+
link_reach="restricted", users=[(user, models.LinkRoleChoices.COMMENTER)]
8080
)
8181
comment1 = factories.CommentFactory(document=document)
8282
comment2 = factories.CommentFactory(document=document, user=user)
@@ -162,7 +162,7 @@ def test_list_comments_authenticated_user_not_enough_access():
162162
def test_create_comment_anonymous_user_public_document():
163163
"""Anonymous users should not be allowed to create comments on a public document."""
164164
document = factories.DocumentFactory(
165-
link_reach="public", link_role=models.LinkRoleChoices.COMMENTATOR
165+
link_reach="public", link_role=models.LinkRoleChoices.COMMENTER
166166
)
167167
client = APIClient()
168168
response = client.post(
@@ -204,7 +204,7 @@ def test_create_comment_authenticated_user_accessible_document():
204204
"""Authenticated users should be allowed to create comments on an accessible document."""
205205
user = factories.UserFactory()
206206
document = factories.DocumentFactory(
207-
link_reach="restricted", users=[(user, models.LinkRoleChoices.COMMENTATOR)]
207+
link_reach="restricted", users=[(user, models.LinkRoleChoices.COMMENTER)]
208208
)
209209
client = APIClient()
210210
client.force_login(user)
@@ -255,7 +255,7 @@ def test_create_comment_authenticated_user_not_enough_access():
255255
def test_retrieve_comment_anonymous_user_public_document():
256256
"""Anonymous users should be allowed to retrieve comments on a public document."""
257257
document = factories.DocumentFactory(
258-
link_reach="public", link_role=models.LinkRoleChoices.COMMENTATOR
258+
link_reach="public", link_role=models.LinkRoleChoices.COMMENTER
259259
)
260260
comment = factories.CommentFactory(document=document)
261261
client = APIClient()
@@ -294,7 +294,7 @@ def test_retrieve_comment_authenticated_user_accessible_document():
294294
"""Authenticated users should be allowed to retrieve comments on an accessible document."""
295295
user = factories.UserFactory()
296296
document = factories.DocumentFactory(
297-
link_reach="restricted", users=[(user, models.LinkRoleChoices.COMMENTATOR)]
297+
link_reach="restricted", users=[(user, models.LinkRoleChoices.COMMENTER)]
298298
)
299299
comment = factories.CommentFactory(document=document)
300300
client = APIClient()
@@ -329,7 +329,7 @@ def test_retrieve_comment_authenticated_user_not_enough_access():
329329
def test_update_comment_anonymous_user_public_document():
330330
"""Anonymous users should not be allowed to update comments on a public document."""
331331
document = factories.DocumentFactory(
332-
link_reach="public", link_role=models.LinkRoleChoices.COMMENTATOR
332+
link_reach="public", link_role=models.LinkRoleChoices.COMMENTER
333333
)
334334
comment = factories.CommentFactory(document=document, content="test")
335335
client = APIClient()
@@ -363,7 +363,7 @@ def test_update_comment_authenticated_user_accessible_document():
363363
(
364364
user,
365365
random.choice(
366-
[models.LinkRoleChoices.COMMENTATOR, models.LinkRoleChoices.EDITOR]
366+
[models.LinkRoleChoices.COMMENTER, models.LinkRoleChoices.EDITOR]
367367
),
368368
)
369369
],
@@ -387,7 +387,7 @@ def test_update_comment_authenticated_user_own_comment():
387387
(
388388
user,
389389
random.choice(
390-
[models.LinkRoleChoices.COMMENTATOR, models.LinkRoleChoices.EDITOR]
390+
[models.LinkRoleChoices.COMMENTER, models.LinkRoleChoices.EDITOR]
391391
),
392392
)
393393
],
@@ -489,7 +489,7 @@ def test_update_comment_authenticated_admin_or_owner_can_update_own_comment(role
489489
def test_delete_comment_anonymous_user_public_document():
490490
"""Anonymous users should not be allowed to delete comments on a public document."""
491491
document = factories.DocumentFactory(
492-
link_reach="public", link_role=models.LinkRoleChoices.COMMENTATOR
492+
link_reach="public", link_role=models.LinkRoleChoices.COMMENTER
493493
)
494494
comment = factories.CommentFactory(document=document)
495495
client = APIClient()
@@ -516,7 +516,7 @@ def test_delete_comment_authenticated_user_accessible_document_own_comment():
516516
"""Authenticated users should be able to delete comments on an accessible document."""
517517
user = factories.UserFactory()
518518
document = factories.DocumentFactory(
519-
link_reach="restricted", users=[(user, models.LinkRoleChoices.COMMENTATOR)]
519+
link_reach="restricted", users=[(user, models.LinkRoleChoices.COMMENTER)]
520520
)
521521
comment = factories.CommentFactory(document=document, user=user)
522522
client = APIClient()
@@ -531,7 +531,7 @@ def test_delete_comment_authenticated_user_accessible_document_not_own_comment()
531531
"""Authenticated users should not be able to delete comments on an accessible document."""
532532
user = factories.UserFactory()
533533
document = factories.DocumentFactory(
534-
link_reach="restricted", users=[(user, models.LinkRoleChoices.COMMENTATOR)]
534+
link_reach="restricted", users=[(user, models.LinkRoleChoices.COMMENTER)]
535535
)
536536
comment = factories.CommentFactory(document=document)
537537
client = APIClient()

‎src/backend/core/tests/documents/test_api_documents_retrieve.py‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ def test_api_documents_retrieve_anonymous_public_standalone():
3636
"children_create": False,
3737
"children_list": True,
3838
"collaboration_auth": True,
39-
"comment": document.link_role in ["commentator", "editor"],
39+
"comment": document.link_role in ["commenter", "editor"],
4040
"cors_proxy": True,
4141
"content": True,
4242
"descendants": True,
@@ -47,8 +47,8 @@ def test_api_documents_retrieve_anonymous_public_standalone():
4747
"invite_owner": False,
4848
"link_configuration": False,
4949
"link_select_options": {
50-
"authenticated": ["reader", "commentator", "editor"],
51-
"public": ["reader", "commentator", "editor"],
50+
"authenticated": ["reader", "commenter", "editor"],
51+
"public": ["reader", "commenter", "editor"],
5252
"restricted": None,
5353
},
5454
"mask": False,
@@ -113,7 +113,7 @@ def test_api_documents_retrieve_anonymous_public_parent():
113113
"children_create": False,
114114
"children_list": True,
115115
"collaboration_auth": True,
116-
"comment": grand_parent.link_role in ["commentator", "editor"],
116+
"comment": grand_parent.link_role in ["commenter", "editor"],
117117
"descendants": True,
118118
"cors_proxy": True,
119119
"content": True,
@@ -220,7 +220,7 @@ def test_api_documents_retrieve_authenticated_unrelated_public_or_authenticated(
220220
"children_create": document.link_role == "editor",
221221
"children_list": True,
222222
"collaboration_auth": True,
223-
"comment": document.link_role in ["commentator", "editor"],
223+
"comment": document.link_role in ["commenter", "editor"],
224224
"descendants": True,
225225
"cors_proxy": True,
226226
"content": True,
@@ -230,8 +230,8 @@ def test_api_documents_retrieve_authenticated_unrelated_public_or_authenticated(
230230
"invite_owner": False,
231231
"link_configuration": False,
232232
"link_select_options": {
233-
"authenticated": ["reader", "commentator", "editor"],
234-
"public": ["reader", "commentator", "editor"],
233+
"authenticated": ["reader", "commenter", "editor"],
234+
"public": ["reader", "commenter", "editor"],
235235
"restricted": None,
236236
},
237237
"mask": True,
@@ -304,7 +304,7 @@ def test_api_documents_retrieve_authenticated_public_or_authenticated_parent(rea
304304
"children_create": grand_parent.link_role == "editor",
305305
"children_list": True,
306306
"collaboration_auth": True,
307-
"comment": grand_parent.link_role in ["commentator", "editor"],
307+
"comment": grand_parent.link_role in ["commenter", "editor"],
308308
"descendants": True,
309309
"cors_proxy": True,
310310
"content": True,
@@ -496,7 +496,7 @@ def test_api_documents_retrieve_authenticated_related_parent():
496496
"ai_transform": access.role != "reader",
497497
"ai_translate": access.role != "reader",
498498
"attachment_upload": access.role != "reader",
499-
"can_edit": access.role not in ["reader", "commentator"],
499+
"can_edit": access.role not in ["reader", "commenter"],
500500
"children_create": access.role != "reader",
501501
"children_list": True,
502502
"collaboration_auth": True,

0 commit comments

Comments
 (0)