Display personal deadline extensions on a student’s points page

[Mikael-Lenander]

Description

What?

Displays deadline extensions in the points page with a tag in the module heading and a clock icon next to each exercise.

Why?

Students and staff members see deadline extensions more easily.

How?

Adds two custom template tags that check if an exercise/module has a personal deadline.

Fixes #1119

What type of test did you run?

• Accessibility test using the WAVE extension.
• Django unit tests.
• [] Selenium tests.
• Other test. (Add a description below)
• Manual testing.

The deadline deviations are only shown on the points page when the module is open and the student has time left to submit the exercise. Works for both module are exercise deviations. Both students and staff members see the deviations.

Did you test the changes in

• Chrome
• Firefox
• This pull request cannot be tested in the browser.

Translation

• Did you modify or add new strings in the user interface? (Read about how to create translation)

Programming style

• Did you follow our style guides?
• Did you use Python type hinting in all functions that you added or edited? (type hints for function parameters and return values)

Template blocks are not indented.

Have you updated the README or other relevant documentation?

• documents inside the doc directory.
• README.md.
• Aplus Manual.
• Other documentation (mention below which documentation).

Is it Done?

• Reviewer has finished the code review
• After the review, the developer has made changes accordingly
• Customer/Teacher has accepted the implementation of the feature

[ihalaij1]

Great, I have just one question.

Is using deepcopy really necessary? Does the code not work without it?

Also, the commit message should include Fixes #1119 on separate line, with an additional empty line above it.

[Mikael-Lenander]

Without deepcopy, the iterator returned by entry['flatted'] is exhausted. When this iterator is looped over again to display the entries in the results page, nothing shows up:

The only solution I came up with was to copy the iterator.

[ihalaij1]

Ready for merge!

[markkuriekkinen]

Nice! I will make minor changes myself to improve accessibility and then merge this.

[markkuriekkinen]

Decorative icons should have the aria-hidden="true" attribute so that they do not confuse screen readers.

Suggested change

	<span class="glyphicon glyphicon-time"></span>
	<span class="glyphicon glyphicon-time" aria-hidden="true"></span>

https://getbootstrap.com/docs/3.4/components/#glyphicons-how-to-use

[markkuriekkinen]

Concatenating the date manually after the translated string may break some languages. If some language requires that the date is written at the start or in the middle of the sentence, then it is not possible to move the date's position here. You would need to use blocktranslate so that you could embed the date variable within the translated string. Then, each language version may freely use the date variable in the correct position inside the sentence.

[markkuriekkinen]

This part is not following accessibility guidelines. Screen readers need text (in the DOM, not only in the tooltip) for reading out aloud. The screen reader version of the description can be hidden with the class sr-only.

[markkuriekkinen]

When all modules are rendered in the web page, this function and the deepcopy are called once for each module. It would be nice to avoid the deepcopy. The old cache class (CachedPoints, CachedContent etc.) looks tricky so modifying it or its iterators is maybe not recommended. I can't think of any other solution than to convert the iterator to a normal list when it is originally created in ContentMixin.flat_module(). I'm not sure if that is really a good idea.

a-plus/exercise/cache/hierarchy.py

Line 30 in eb8933a

class NextIterator(HierarchyIterator):

a-plus/exercise/cache/hierarchy.py

Lines 123 to 127 in eb8933a

	def flat_module(self, module, enclosed=True):
	modules = self.modules()
	idx = self._model_idx(module)
	tree = self._by_idx(modules, idx)
	return NextIterator(tree[0]['children'], enclosed=enclosed)

a-plus/exercise/cache/hierarchy.py

Lines 113 to 116 in eb8933a

	def modules_flatted(self):
	for module in self.data['modules']:
	module['flatted'] = self.flat_module(module)
	return self.data['modules']

a-plus/exercise/templatetags/exercise.py

Line 55 in eb8933a

'modules': points.modules_flatted(),

a-plus/exercise/templatetags/exercise.py

Lines 73 to 87 in eb8933a

	@register.inclusion_tag("exercise/_user_results.html", takes_context=True)
	def user_results(context: Context, student: Optional[User] = None) -> Dict[str, Any]:
	values = _get_toc(context, student)
	values['total_json'] = json.dumps(values['total'])
	if values['is_course_staff']:
	instance = context['instance']
	values['student_count'] = instance.students.count()
	counts = (instance.students
	.filter(submissions__exercise__course_module__course_instance=instance)
	.values('submissions__exercise_id')
	.annotate(count=models.Count('submissions__submitters', distinct=True))
	.order_by()
	)
	values['exercise_submitter_counts'] = {row['submissions__exercise_id']: row['count'] for row in counts}
	return values

[markkuriekkinen]

Should user-facing text be "deadline deviation" or "deadline extension"?