feat: Added support for the CRediT Taxonomy for contributors

src/core/logic.py

@@ -455,7 +455,7 @@ def get_settings_to_edit(display_group, journal, user):
             'use_ga_four', 'display_login_page_notice', 'login_page_notice', 
             'display_register_page_notice', 'register_page_notice',
             'support_email', 'support_contact_message_for_staff',
-            'from_address', 'replyto_address',
+            'from_address', 'replyto_address', "use_credit"
         ]
 
         group_of_settings = process_setting_list(journal_settings, 'general', journal)

src/core/models.py

@@ -51,6 +51,7 @@
 from review import models as review_models
 from copyediting import models as copyediting_models
 from submission import models as submission_models
+from submission.models import CreditRecord
 from utils.logger import get_logger
 from utils import logic as utils_logic
 from utils.forms import plain_text_validator
@@ -565,6 +566,14 @@ def snapshot_self(self, article, force_update=True):
                 setattr(frozen_author, k, v)
             frozen_author.save()
 
+            # now update the CRediT records
+            credit_records = CreditRecord.objects.filter(article=article,
+                                                         author=self)
+
+            for credit_record in credit_records:
+                credit_record.frozen_author = frozen_author
+                credit_record.save()
+
         else:
             try:
                 order_object = article.articleauthororder_set.get(author=self)
@@ -576,12 +585,52 @@ def snapshot_self(self, article, force_update=True):
                     defaults={'order': order_integer}
                 )
 
-            submission_models.FrozenAuthor.objects.get_or_create(
+            fa, _ = submission_models.FrozenAuthor.objects.get_or_create(
                 author=self,
                 article=article,
                 defaults=dict(order=order_object.order, **frozen_dict)
             )
 
+            # now update the CRediT records
+            credit_records = CreditRecord.objects.filter(article=article,
+                                                         author=self)
+
+            for credit_record in credit_records:
+                credit_record.frozen_author = fa
+                credit_record.save()
+
+    def credits(self, article):
+        """
+        Returns the CRediT records for this user on a given article
+        """
+        return submission_models.CreditRecord.objects.filter(article=article,
+                                                             author=self)
+
+    def add_credit(self, credit_role_text, article):
+        """
+        Adds a CRediT role to the article for this user
+        """
+        record, _ = (
+            submission_models.CreditRecord.objects.get_or_create(
+                article=article, author=self, role=credit_role_text)
+        )
+
+        return record
+
+    def remove_credit(self, credit_role_text, article):
+        """
+        Removes a CRediT role from the article for this user
+        """
+        try:
+            record, _ = (
+                submission_models.CreditRecord.objects.get(
+                    article=article, author=self, role=credit_role_text)
+            )
+
+            record.delete()
+        except submission_models.CreditRecord.DoesNotExist:
+            pass
+
     def frozen_author(self, article):
         try:
             return submission_models.FrozenAuthor.objects.get(

src/journal/views.py

@@ -479,6 +479,25 @@ def article(request, identifier_type, identifier):
             file__mime_type='text/html',
         )
 
+    credit_roles = {}
+    show_credit = False
+
+    use_credit = setting_handler.get_setting(
+        "general", "use_credit",
+        journal=request.journal
+    )
+
+    if use_credit:
+        for frozen_author in article_object.frozen_authors():
+            credit_role_qs = submission_models.CreditRecord.objects.filter(
+                article=article_object, frozen_author=frozen_author
+            ).order_by("role")
+
+            credit_roles[frozen_author] = credit_role_qs
+
+            if len(credit_role_qs) > 0:
+                show_credit = True
+
     template = 'journal/article.html'
     context = {
         'article': article_object,
@@ -487,6 +506,8 @@ def article(request, identifier_type, identifier):
         'identifier': identifier,
         'article_content': content,
         'tables_in_galley': tables_in_galley,
+        'credit_roles': credit_roles,
+        'show_credit': show_credit,
     }
 
     return render(request, template, context)

src/submission/admin.py

@@ -109,6 +109,13 @@ class ArticleLogAdmin(admin_utils.ArticleFKModelAdmin):
     def _article(self, obj):
         return truncatewords_html(str(obj.article), 10) if obj else ''
 
+class CreditRecordAdmin(admin.ModelAdmin):
+    list_display = ('role', 'article', 'author', '_frozenauthor')
+    list_filter = ('article', 'author', 'role')
+    search_fields = ('role', 'article', 'author', '_frozenauthor')
+
+    def _frozenauthor(self, obj):
+        return truncatewords_html(str(obj.article), 10) if obj else ''
 
 class LicenseAdmin(admin.ModelAdmin):
     list_display = ('name', 'short_name', 'journal', 'url', '_text')
@@ -223,6 +230,7 @@ class ArticleAuthorOrderAdmin(admin_utils.ArticleFKModelAdmin):
     (models.Keyword, KeywordAdmin),
     (models.SubmissionConfiguration, SubmissionConfigAdmin),
     (models.ArticleAuthorOrder, ArticleAuthorOrderAdmin),
+    (models.CreditRecord, CreditRecordAdmin)
 ]
 
 [admin.site.register(*t) for t in admin_list]

src/submission/migrations/0085_alter_article_jats_article_type_override_and_more.py

@@ -0,0 +1,44 @@
+# Generated by Django 4.2.16 on 2024-12-04 15:55
+
+import core.model_utils
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+        ('repository', '0045_historicalrepository_display_public_metrics_and_more'),
+        ('submission', '0084_remove_article_jats_article_type_and_more'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='article',
+            name='jats_article_type_override',
+            field=core.model_utils.DynamicChoiceField(blank=True, choices=[], default=None, help_text='The type of article as per the JATS standard. This field allows you to override the default for the section.', max_length=255, null=True),
+        ),
+        migrations.AlterField(
+            model_name='section',
+            name='jats_article_type',
+            field=core.model_utils.DynamicChoiceField(blank=True, choices=[], help_text='The default JATS article type for articles in this section. This can be overridden on a per-article basis.', max_length=255, null=True, verbose_name='JATS default article type'),
+        ),
+        migrations.CreateModel(
+            name='CreditRecord',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('last_modified', models.DateTimeField(auto_now=True)),
+                ('role', models.CharField(blank=True, choices=[('Conceptualization', 'Conceptualization'), ('Data Curation', 'Data Curation'), ('Formal Analysis', 'Formal Analysis'), ('Funding Acquisition', 'Funding Acquisition'), ('Investigation', 'Investigation'), ('Methodology', 'Methodology'), ('Project Administration', 'Project Administration'), ('Resources', 'Resources'), ('Software', 'Software'), ('Supervision', 'Supervision'), ('Validation', 'Validation'), ('Visualization', 'Visualization'), ('Writing - Original Draft', 'Writing - Original Draft'), ('Writing - Review & Editing', 'Writing - Review & Editing')], max_length=100, null=True)),
+                ('article', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, to='submission.article')),
+                ('author', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, to=settings.AUTH_USER_MODEL)),
+                ('frozen_author', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, to='submission.frozenauthor')),
+                ('preprint_author', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, to='repository.preprintauthor')),
+            ],
+            options={
+                'verbose_name': 'CRediT record',
+                'verbose_name_plural': 'CRediT records',
+            },
+        ),
+    ]