Merge tag '25.05.4' into develop

New collection category

Author: brianjgeiger

admin/collection_providers/forms.py

@@ -17,6 +17,7 @@ class CollectionProviderForm(forms.ModelForm):
     study_design_choices = forms.CharField(widget=forms.HiddenInput(), required=False)
     data_type_choices = forms.CharField(widget=forms.HiddenInput(), required=False)
     disease_choices = forms.CharField(widget=forms.HiddenInput(), required=False)
+    grade_levels_choices = forms.CharField(widget=forms.HiddenInput(), required=False)
     _id = forms.SlugField(
         required=True,
         help_text='URL Slug',
@@ -330,3 +331,33 @@ def clean_data_type_choices(self):
             if choices:
                 added_choices = json.loads(choices)
         return {'added': added_choices, 'removed': removed_choices}
+
+    def clean_grade_levels_choices(self):
+        if not self.data.get('grade_levels_choices'):
+            return {'added': [], 'removed': []}
+
+        collection_provider = self.instance
+        primary_collection = collection_provider.primary_collection
+        if primary_collection:  # Modifying an existing CollectionProvider
+            old_choices = {c.strip(' ') for c in primary_collection.grade_levels_choices}
+            updated_choices = {c.strip(' ') for c in json.loads(self.data.get('grade_levels_choices'))}
+            added_choices = updated_choices - old_choices
+            removed_choices = old_choices - updated_choices
+
+            active_removed_choices = set(
+                primary_collection.collectionsubmission_set.filter(
+                    data_type__in=removed_choices
+                ).values_list('grade_levels', flat=True)
+            )
+            if active_removed_choices:
+                raise forms.ValidationError(
+                    'Cannot remove the following choices for "grade_levels", as they are '
+                    f'currently in use: {active_removed_choices}'
+                )
+        else:  # Creating a new CollectionProvider
+            added_choices = set()
+            removed_choices = set()
+            choices = self.data.get('grade_levels_choices')
+            if choices:
+                added_choices = json.loads(choices)
+        return {'added': added_choices, 'removed': removed_choices}

admin/collection_providers/views.py

@@ -62,6 +62,8 @@ def form_valid(self, form):
             self.object.primary_collection.data_type_choices.append(item)
         for item in form.cleaned_data['disease_choices']['added']:
             self.object.primary_collection.disease_choices.append(item)
+        for item in form.cleaned_data['grade_levels_choices']['added']:
+            self.object.primary_collection.grade_levels_choices.append(item)
         self.object.primary_collection.save()
         return super().form_valid(form)
 
@@ -188,6 +190,11 @@ def get_context_data(self, *args, **kwargs):
         ))
         kwargs['data_type_choices'] = data_type_choices_html
 
+        grade_levels_choices_html = '<ul>{choices}</ul>'.format(choices=''.join(
+            f'<li>{choice}</li>' for choice in primary_collection.grade_levels_choices
+        ))
+        kwargs['grade_levels_choices'] = grade_levels_choices_html
+
         # get a dict of model fields so that we can set the initial value for the update form
         fields = model_to_dict(collection_provider)
         fields['collected_type_choices'] = json.dumps(primary_collection.collected_type_choices)
@@ -202,6 +209,7 @@ def get_context_data(self, *args, **kwargs):
         fields['study_design_choices'] = json.dumps(primary_collection.study_design_choices)
         fields['data_type_choices'] = json.dumps(primary_collection.data_type_choices)
         fields['disease_choices'] = json.dumps(primary_collection.disease_choices)
+        fields['grade_levels_choices'] = json.dumps(primary_collection.grade_levels_choices)
 
         # compile html list of collected_type_choices
         if collection_provider.primary_collection:
@@ -262,7 +270,7 @@ class CollectionProviderChangeForm(PermissionRequiredMixin, UpdateView):
 
     def form_valid(self, form):
         if self.object.primary_collection:
-            for choices_name in ['collected_type', 'status', 'issue', 'volume', 'program_area', 'school_type', 'study_design', 'data_type', 'disease']:
+            for choices_name in ['collected_type', 'status', 'issue', 'volume', 'program_area', 'school_type', 'study_design', 'data_type', 'disease', 'grade_levels']:
                 _process_collection_choices(self.object, choices_name, form)
         self.object.primary_collection.save()
         return super().form_valid(form)
@@ -402,6 +410,7 @@ def create_or_update_provider(self, provider_data):
             provider.primary_collection.study_design_choices = primary_collection['fields']['study_design_choices']
             provider.primary_collection.disease_choices = primary_collection['fields']['disease_choices']
             provider.primary_collection.data_type_choices = primary_collection['fields']['data_type_choices']
+            provider.primary_collection.data_type_choices = primary_collection['fields']['grade_levels_choices']
             provider.primary_collection.save()
         if licenses:
             provider.licenses_acceptable.set(licenses)

admin/static/js/pages/collection-provider-page.js

@@ -73,6 +73,14 @@ $('#tags-input-disease').on('itemRemoved', function(event) {
     $('#id_disease_choices').val(JSON.stringify($('#tags-input-disease').tagsinput('items')));
 });
 
+$('#tags-input-grade-levels').on('itemAdded', function(event) {
+    $('#id_grade_levels_choices').val(JSON.stringify($('#tags-input-grade-levels').tagsinput('items')));
+});
+
+$('#tags-input-grade-levels').on('itemRemoved', function(event) {
+    $('#id_grade_levels_choices').val(JSON.stringify($('#tags-input-grade-levels').tagsinput('items')));
+});
+
 
 $(document).ready(function() {
    var collectedTypeItems = JSON.parse($('#id_collected_type_choices').val());
@@ -119,4 +127,9 @@ $(document).ready(function() {
    dataTypeItems.forEach(function(element){
        $('#tags-input-data-type').tagsinput('add', element)
    });
+
+   var dataTypeItems = JSON.parse($('#id_grade_levels_choices').val());
+   dataTypeItems.forEach(function(element){
+       $('#tags-input-grade-levels').tagsinput('add', element)
+   });
 });

admin/templates/collection_providers/detail.html

@@ -74,6 +74,10 @@ <h2>{{ collection_provider.name }}</h2>
 						<th>data_type_choices</th>
 						<td>{{ data_type_choices | safe}}</td>
 					</tr>
+                    <tr>
+						<th>grade_levels_choices</th>
+						<td>{{ grade_levels_choices | safe}}</td>
+					</tr>
                 </table>
             </div>
         </div>

admin/templates/collection_providers/update_collection_provider_form.html

@@ -110,6 +110,12 @@
 					<input id="tags-input-data-type" type="text" data-role="tagsinput"/>
 				</div>
 			</div>
+			<div>
+				<label>Grade Levels choices:</label>
+				<div class=#bootstrap-tagsinput">
+					<input id="tags-input-grade-levels" type="text" data-role="tagsinput"/>
+				</div>
+			</div>
             <input class="form-button" type="submit" value="Save" />
         </form>
     </div>

api/collections/serializers.py

@@ -76,6 +76,10 @@ class CollectionSerializer(JSONAPISerializer):
         child=ser.CharField(max_length=127),
         default=list(),
     )
+    grade_levels_choices = ser.ListField(
+        child=ser.CharField(max_length=127),
+        default=list(),
+    )
 
     links = LinksField({})
 
@@ -251,6 +255,7 @@ def subjects_view_kwargs(self):
     study_design = ser.CharField(required=False)
     data_type = ser.CharField(required=False)
     disease = ser.CharField(required=False)
+    grade_levels = ser.CharField(required=False)
 
     def get_absolute_url(self, obj):
         return absolute_reverse(
@@ -286,6 +291,8 @@ def update(self, obj, validated_data):
             obj.data_type = validated_data.pop('data_type')
         if 'disease' in validated_data:
             obj.disease = validated_data.pop('disease')
+        if 'grade_levels' in validated_data:
+            obj.grade_levels = validated_data.pop('grade_levels')
 
         obj.save()
         return obj
@@ -353,6 +360,7 @@ def subjects_view_kwargs(self):
     study_design = ser.CharField(required=False)
     date_type = ser.CharField(required=False)
     disease = ser.CharField(required=False)
+    grade_levels = ser.CharField(required=False)
 
     def get_absolute_url(self, obj):
         return absolute_reverse(
@@ -388,6 +396,8 @@ def update(self, obj, validated_data):
             obj.data_type = validated_data.pop('data_type')
         if 'disease' in validated_data:
             obj.disease = validated_data.pop('disease')
+        if 'grade_levels' in validated_data:
+            obj.grade_levels = validated_data.pop('grade_levels')
 
         obj.save()
         return obj

api_tests/search/views/test_views.py

@@ -51,7 +51,7 @@ def collection_public(self, user):
                                  status_choices=['', 'asdf', 'lkjh'], collected_type_choices=['', 'asdf', 'lkjh'],
                                  issue_choices=['', '0', '1', '2'], volume_choices=['', '0', '1', '2'],
                                  disease_choices=['illness'], data_type_choices=['realness'],
-                                 program_area_choices=['', 'asdf', 'lkjh'])
+                                 program_area_choices=['', 'asdf', 'lkjh'], grade_levels_choices=['super', 'cool'])
 
     @pytest.fixture()
     def registration_collection(self, user):
@@ -908,7 +908,7 @@ def test_POST_search_collections(
             registration_two, registration_private, reg_with_abstract):
         collection_public.collect_object(node_one, user, status='asdf', issue='0', volume='1', program_area='asdf')
         collection_public.collect_object(node_two, user, collected_type='asdf', status='lkjh')
-        collection_public.collect_object(node_with_abstract, user, status='asdf')
+        collection_public.collect_object(node_with_abstract, user, status='asdf', grade_levels='super')
         collection_public.collect_object(node_private, user, status='asdf', collected_type='asdf')
 
         registration_collection.collect_object(registration_one, user, status='asdf')
@@ -984,6 +984,11 @@ def test_POST_search_collections(
         actual_ids = self.get_ids(res.json['data'])
         assert node_one._id in actual_ids
 
+        payload = self.post_payload(gradeLevels='super')
+        res = app.post_json_api(url_collection_search, payload)
+        assert res.status_code == 200
+        assert res.json['links']['meta']['total'] == 1
+
         # test_search_abstract_keyword_and_filter
         payload = self.post_payload(q='Khadja', status='asdf')
         res = app.post_json_api(url_collection_search, payload)

osf/migrations/0028_collection_grade_levels_choices_and_more.py

@@ -0,0 +1,24 @@
+# Generated by Django 4.2.15 on 2025-03-27 11:54
+
+import django.contrib.postgres.fields
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('osf', '0027_alter_guidversionsthrough_object_id'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='collection',
+            name='grade_levels_choices',
+            field=django.contrib.postgres.fields.ArrayField(base_field=models.CharField(max_length=127), blank=True, default=list, size=None),
+        ),
+        migrations.AddField(
+            model_name='collectionsubmission',
+            name='grade_levels',
+            field=models.CharField(blank=True, max_length=127),
+        ),
+    ]

osf/models/collection.py

@@ -57,6 +57,7 @@ class Meta:
     study_design_choices = ArrayField(models.CharField(max_length=127), blank=True, default=list)
     disease_choices = ArrayField(models.CharField(max_length=127), blank=True, default=list)
     data_type_choices = ArrayField(models.CharField(max_length=127), blank=True, default=list)
+    grade_levels_choices = ArrayField(models.CharField(max_length=127), blank=True, default=list)
     is_public = models.BooleanField(default=False, db_index=True)
     is_promoted = models.BooleanField(default=False, db_index=True)
     is_bookmark_collection = models.BooleanField(default=False, db_index=True)
@@ -161,8 +162,9 @@ def has_permission(self, user, perm):
         return user.has_perms(self.groups[perm], self)
 
     def collect_object(
-            self, obj, collector, collected_type=None, status=None, volume=None, issue=None,
-            program_area=None, school_type=None, study_design=None, data_type=None, disease=None):
+            self, obj, collector, collected_type=None, status=None, volume=None,
+            issue=None, program_area=None, school_type=None, study_design=None,
+            data_type=None, disease=None, grade_levels=None):
         """ Adds object to collection, creates CollectionSubmission reference
             Performs type / metadata validation. User permissions checked in view.
 
@@ -181,6 +183,7 @@ def collect_object(
         study_design = study_design or ''
         data_type = data_type or ''
         disease = disease or ''
+        grade_levels = grade_levels or ''
 
         if not self.collected_type_choices and collected_type:
             raise ValidationError('May not specify "type" for this collection')
@@ -236,6 +239,12 @@ def collect_object(
             elif data_type not in self.data_type_choices:
                 raise ValidationError(f'"{data_type}" is not an acceptable "data_type" for this collection')
 
+        if grade_levels:
+            if not self.grade_levels_choices:
+                raise ValidationError('May not specify "grade_levels" for this collection')
+            elif grade_levels not in self.grade_levels_choices:
+                raise ValidationError(f'"{grade_levels}" is not an acceptable "grade_levels" for this collection')
+
         if not any([isinstance(obj, t.model_class()) for t in self.collected_types.all()]):
             # Not all objects have a content_type_pk, have to look the other way.
             # Ideally, all objects would, and we could do:
@@ -266,6 +275,7 @@ def collect_object(
             collection_submission.study_design = study_design
             collection_submission.data_type = data_type
             collection_submission.disease = disease
+            collection_submission.grade_levels = grade_levels
             collection_submission.save()
 
             return collection_submission

osf/models/collection_submission.py

@@ -48,6 +48,7 @@ class Meta:
         blank=True,
         max_length=127
     )
+    grade_levels = models.CharField(blank=True, max_length=127)
     machine_state = models.IntegerField(
         choices=CollectionSubmissionStates.int_field_choices(),
         default=CollectionSubmissionStates.IN_PROGRESS,

website/project/views/node.py

@@ -956,6 +956,7 @@ def serialize_collections(collection_submissions, auth):
         'program_area': collection_submission.program_area,
         'disease': collection_submission.disease,
         'data_type': collection_submission.data_type,
+        'grade_levels': collection_submission.grade_levels,
         'state': collection_submission.state.db_name,
         'subjects': list(collection_submission.subjects.values_list('text', flat=True)),
         'is_public': collection_submission.collection.is_public,

website/search/elastic_search.py

@@ -602,6 +602,7 @@ def serialize_collection_submission(collection_submission):
         'studyDesign': collection_submission.study_design,
         'disease': collection_submission.disease,
         'dataType': collection_submission.data_type,
+        'gradeLevels': collection_submission.grade_levels,
         'subjects': list(collection_submission.subjects.values_list('text', flat=True)),
         'title': getattr(obj, 'title', ''),
         'url': getattr(obj, 'url', ''),

website/templates/project/project.mako

@@ -415,6 +415,11 @@
                                     </div>
                                 % endif
                                 <hr>
+                                % if collection['grade_levels']:
+                                    <div  style="padding-left: 30px;">
+                                        Grade Levels: <i>${collection['grade_levels']}</i>
+                                    </div>
+                                % endif
                             % elif collection['state'] == 'pending' and user['is_contributor_or_group_member']:
                                 % if user['is_admin']:
                                     <a class="fa fa-close collections-cancel-icon pull-right" collection_id=${collection['collection_id']} node_id=${collection['node_id']} aria-label="Cancel Submission Request Button"></a>
@@ -475,6 +480,11 @@
                                         Data Type: <i>${collection['data_type']}</i>
                                     </div>
                                 % endif
+                                % if collection['grade_levels']:
+                                    <div  style="padding-left: 30px;">
+                                        Grade Levels: <i>${collection['grade_levels']}</i>
+                                    </div>
+                                % endif
                                 <hr>
                             % elif collection['state'] == 'rejected' and user['is_contributor_or_group_member']:
                                 % if user['is_admin']: