From 9bf74e7e8513e8561ae02012a02fca0ced9c551e Mon Sep 17 00:00:00 2001 From: Shamim Rezaie Date: Fri, 5 Mar 2021 23:37:23 +1100 Subject: [PATCH] MDL-71410 mod_lesson: implement activity_dates for the lesson module --- mod/lesson/classes/dates.php | 68 +++++++++++ mod/lesson/tests/dates_test.php | 175 +++++++++++++++++++++++++++++ mod/lesson/tests/generator/lib.php | 23 ++++ 3 files changed, 266 insertions(+) create mode 100644 mod/lesson/classes/dates.php create mode 100644 mod/lesson/tests/dates_test.php diff --git a/mod/lesson/classes/dates.php b/mod/lesson/classes/dates.php new file mode 100644 index 00000000000..cf18db24bd9 --- /dev/null +++ b/mod/lesson/classes/dates.php @@ -0,0 +1,68 @@ +. + +/** + * Contains the class for fetching the important dates in mod_lesson for a given module instance and a user. + * + * @package mod_lesson + * @copyright 2021 Shamim Rezaie + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ + +declare(strict_types=1); + +namespace mod_lesson; + +use core\activity_dates; + +/** + * Class for fetching the important dates in mod_lesson for a given module instance and a user. + * + * @copyright 2021 Shamim Rezaie + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ +class dates extends activity_dates { + + /** + * Returns a list of important dates in mod_lesson + * + * @return array + */ + protected function get_dates(): array { + $timeopen = $this->cm->customdata['available'] ?? null; + $timeclose = $this->cm->customdata['deadline'] ?? null; + $now = time(); + $dates = []; + + if ($timeopen) { + $openlabelid = $timeopen > $now ? 'activitydate:opens' : 'activitydate:opened'; + $dates[] = [ + 'label' => get_string($openlabelid, 'course'), + 'timestamp' => (int) $timeopen, + ]; + } + + if ($timeclose) { + $closelabelid = $timeclose > $now ? 'activitydate:closes' : 'activitydate:closed'; + $dates[] = [ + 'label' => get_string($closelabelid, 'course'), + 'timestamp' => (int) $timeclose, + ]; + } + + return $dates; + } +} diff --git a/mod/lesson/tests/dates_test.php b/mod/lesson/tests/dates_test.php new file mode 100644 index 00000000000..dbe906709cf --- /dev/null +++ b/mod/lesson/tests/dates_test.php @@ -0,0 +1,175 @@ +. + +/** + * Contains unit tests for mod_lesson\dates. + * + * @package mod_lesson + * @category test + * @copyright 2021 Shamim Rezaie + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ + +declare(strict_types=1); + +namespace mod_lesson; + +use advanced_testcase; +use cm_info; +use core\activity_dates; + +/** + * Class for unit testing mod_lesson\dates. + * + * @copyright 2021 Shamim Rezaie + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ +class dates_test extends advanced_testcase { + + /** + * Data provider for get_dates_for_module(). + * @return array[] + */ + public function get_dates_for_module_provider(): array { + $now = time(); + $before = $now - DAYSECS; + $earlier = $before - DAYSECS; + $after = $now + DAYSECS; + $later = $after + DAYSECS; + + return [ + 'without any dates' => [ + null, null, null, null, null, null, [] + ], + 'only with opening time' => [ + $after, null, null, null, null, null, [ + ['label' => get_string('activitydate:opens', 'course'), 'timestamp' => $after], + ] + ], + 'only with closing time' => [ + null, $after, null, null, null, null, [ + ['label' => get_string('activitydate:closes', 'course'), 'timestamp' => $after], + ] + ], + 'with both times' => [ + $after, $later, null, null, null, null, [ + ['label' => get_string('activitydate:opens', 'course'), 'timestamp' => $after], + ['label' => get_string('activitydate:closes', 'course'), 'timestamp' => $later], + ] + ], + 'between the dates' => [ + $before, $after, null, null, null, null, [ + ['label' => get_string('activitydate:opened', 'course'), 'timestamp' => $before], + ['label' => get_string('activitydate:closes', 'course'), 'timestamp' => $after], + ] + ], + 'dates are past' => [ + $earlier, $before, null, null, null, null, [ + ['label' => get_string('activitydate:opened', 'course'), 'timestamp' => $earlier], + ['label' => get_string('activitydate:closed', 'course'), 'timestamp' => $before], + ] + ], + 'with user override' => [ + $before, $after, $earlier, $later, null, null, [ + ['label' => get_string('activitydate:opened', 'course'), 'timestamp' => $earlier], + ['label' => get_string('activitydate:closes', 'course'), 'timestamp' => $later], + ] + ], + 'with group override' => [ + $before, $after, null, null, $earlier, $later, [ + ['label' => get_string('activitydate:opened', 'course'), 'timestamp' => $earlier], + ['label' => get_string('activitydate:closes', 'course'), 'timestamp' => $later], + ] + ], + 'with both user and group overrides' => [ + $before, $after, $earlier, $later, $earlier - DAYSECS, $later + DAYSECS, [ + ['label' => get_string('activitydate:opened', 'course'), 'timestamp' => $earlier], + ['label' => get_string('activitydate:closes', 'course'), 'timestamp' => $later], + ] + ], + ]; + } + + /** + * Test for get_dates_for_module(). + * + * @dataProvider get_dates_for_module_provider + * @param int|null $available The 'available from' value of the lesson. + * @param int|null $deadline The lesson's deadline. + * @param int|null $useravailable The user override for opening the lesson. + * @param int|null $userdeadline The user override for deadline of the lesson. + * @param int|null $groupavailable The group override for opening the lesson. + * @param int|null $groupuserdeadline The group override for deadline of the lesson. + * @param array $expected The expected value of calling get_dates_for_module() + */ + public function test_get_dates_for_module(?int $available, ?int $deadline, + ?int $useravailable, ?int $userdeadline, + ?int $groupavailable, ?int $groupuserdeadline, + array $expected) { + $this->resetAfterTest(); + $generator = $this->getDataGenerator(); + /** @var \mod_lesson_generator $lessongenerator */ + $lessongenerator = $generator->get_plugin_generator('mod_lesson'); + + $course = $generator->create_course(); + $user = $generator->create_user(); + $generator->enrol_user($user->id, $course->id); + + $data = ['course' => $course->id]; + if ($available) { + $data['available'] = $available; + } + if ($deadline) { + $data['deadline'] = $deadline; + } + $this->setAdminUser(); + $lesson = $lessongenerator->create_instance($data); + + if ($useravailable || $userdeadline || $groupavailable || $groupuserdeadline) { + $generator->enrol_user($user->id, $course->id); + $group = $generator->create_group(['courseid' => $course->id]); + $generator->create_group_member(['groupid' => $group->id, 'userid' => $user->id]); + + if ($useravailable || $userdeadline) { + $lessongenerator->create_override([ + 'lessonid' => $lesson->id, + 'userid' => $user->id, + 'available' => $useravailable, + 'deadline' => $userdeadline, + ]); + } + + if ($groupavailable || $groupuserdeadline) { + $lessongenerator->create_override([ + 'lessonid' => $lesson->id, + 'groupid' => $group->id, + 'available' => $groupavailable, + 'deadline' => $groupuserdeadline, + ]); + } + } + + $this->setUser($user); + + $cm = get_coursemodule_from_instance('lesson', $lesson->id); + // Make sure we're using a cm_info object. + $cm = cm_info::create($cm); + + $dates = activity_dates::get_dates_for_module($cm, (int) $user->id); + + $this->assertEquals($expected, $dates); + } +} diff --git a/mod/lesson/tests/generator/lib.php b/mod/lesson/tests/generator/lib.php index 777fdb2d362..53fcfa6a251 100644 --- a/mod/lesson/tests/generator/lib.php +++ b/mod/lesson/tests/generator/lib.php @@ -426,4 +426,27 @@ class mod_lesson_generator extends testing_module_generator { $page = lesson_page::create((object)$record, new lesson($lesson), $context, $CFG->maxbytes); return $DB->get_record('lesson_pages', array('id' => $page->id), '*', MUST_EXIST); } + + /** + * Create a lesson override (either user or group). + * + * @param array $data must specify lessonid, and one of userid or groupid. + */ + public function create_override(array $data): void { + global $DB; + + if (!isset($data['lessonid'])) { + throw new coding_exception('Must specify lessonid when creating a lesson override.'); + } + + if (!isset($data['userid']) && !isset($data['groupid'])) { + throw new coding_exception('Must specify one of userid or groupid when creating a lesson override.'); + } + + if (isset($data['userid']) && isset($data['groupid'])) { + throw new coding_exception('Cannot specify both userid and groupid when creating a lesson override.'); + } + + $DB->insert_record('lesson_overrides', (object) $data); + } }