From 7c7c1aafc8307ea261d0dc057b0731ceb9eac42a Mon Sep 17 00:00:00 2001 From: Simey Lameze Date: Tue, 2 Mar 2021 11:33:05 +0800 Subject: [PATCH] MDL-70820 mod_forum: custom completion implementation --- .../classes/completion/custom_completion.php | 102 +++++++ mod/forum/lang/en/forum.php | 3 + mod/forum/tests/custom_completion_test.php | 273 ++++++++++++++++++ 3 files changed, 378 insertions(+) create mode 100644 mod/forum/classes/completion/custom_completion.php create mode 100644 mod/forum/tests/custom_completion_test.php diff --git a/mod/forum/classes/completion/custom_completion.php b/mod/forum/classes/completion/custom_completion.php new file mode 100644 index 00000000000..b168abd44ad --- /dev/null +++ b/mod/forum/classes/completion/custom_completion.php @@ -0,0 +1,102 @@ +. + +declare(strict_types=1); + +namespace mod_forum\completion; + +use core_completion\activity_custom_completion; + +/** + * Activity custom completion subclass for the forum activity. + * + * Class for defining mod_forum's custom completion rules and fetching the completion statuses + * of the custom completion rules for a given forum instance and a user. + * + * @package mod_forum + * @copyright Simey Lameze + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ +class custom_completion extends activity_custom_completion { + + /** + * Fetches the completion state for a given completion rule. + * + * @param string $rule The completion rule. + * @return int The completion state. + */ + public function get_state(string $rule): int { + global $DB; + + $this->validate_rule($rule); + + $userid = $this->userid; + $forumid = $this->cm->instance; + + if (!$forum = $DB->get_record('forum', ['id' => $forumid])) { + throw new \moodle_exception('Unable to find forum with id ' . $forumid); + } + + $postcountparams = ['userid' => $userid, 'forumid' => $forumid]; + $postcountsql = "SELECT COUNT(*) + FROM {forum_posts} fp + JOIN {forum_discussions} fd ON fp.discussion = fd.id + WHERE fp.userid = :userid + AND fd.forum = :forumid"; + + if ($rule == 'completiondiscussions') { + $status = $forum->completiondiscussions <= + $DB->count_records('forum_discussions', ['forum' => $forumid, 'userid' => $userid]); + } else if ($rule == 'completionreplies') { + $status = $forum->completionreplies <= + $DB->get_field_sql($postcountsql . ' AND fp.parent <> 0', $postcountparams); + } else if ($rule == 'completionposts') { + $status = $forum->completionposts <= $DB->get_field_sql($postcountsql, $postcountparams); + } + + return $status ? COMPLETION_COMPLETE : COMPLETION_INCOMPLETE; + } + + /** + * Fetch the list of custom completion rules that this module defines. + * + * @return array + */ + public static function get_defined_custom_rules(): array { + return [ + 'completiondiscussions', + 'completionreplies', + 'completionposts', + ]; + } + + /** + * Returns an associative array of the descriptions of custom completion rules. + * + * @return array + */ + public function get_custom_rule_descriptions(): array { + $completiondiscussions = $this->cm->customdata['customcompletionrules']['completiondiscussions'] ?? 0; + $completionreplies = $this->cm->customdata['customcompletionrules']['completionreplies'] ?? 0; + $completionposts = $this->cm->customdata['customcompletionrules']['completionposts'] ?? 0; + + return [ + 'completiondiscussions' => get_string('completiondetail:discussions', 'forum', $completiondiscussions), + 'completionreplies' => get_string('completiondetail:replies', 'forum', $completionreplies), + 'completionposts' => get_string('completiondetail:posts', 'forum', $completionposts), + ]; + } +} diff --git a/mod/forum/lang/en/forum.php b/mod/forum/lang/en/forum.php index 29dcbf289b3..1e653903577 100644 --- a/mod/forum/lang/en/forum.php +++ b/mod/forum/lang/en/forum.php @@ -104,6 +104,9 @@ $string['clicktounfavourite'] = 'You have starred this discussion. Click to unst $string['clicktofavourite'] = 'You have not starred this discussion. Click to star.'; $string['close'] = 'Close'; $string['closegrader'] = 'Close grader'; +$string['completiondetail:discussions'] = 'Start discussions: {$a}'; +$string['completiondetail:replies'] = 'Post replies: {$a}'; +$string['completiondetail:posts'] = 'Make forum posts: {$a}'; $string['completiondiscussions'] = 'Student must create discussions:'; $string['completiondiscussionsdesc'] = 'Student must create at least {$a} discussion(s)'; $string['completiondiscussionsgroup'] = 'Require discussions'; diff --git a/mod/forum/tests/custom_completion_test.php b/mod/forum/tests/custom_completion_test.php new file mode 100644 index 00000000000..0f7fd080854 --- /dev/null +++ b/mod/forum/tests/custom_completion_test.php @@ -0,0 +1,273 @@ +. + +/** + * Contains unit tests for core_completion/activity_custom_completion. + * + * @package mod_forum + * @copyright Simey Lameze + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ + +declare(strict_types=1); + +namespace mod_forum; + +use advanced_testcase; +use cm_info; +use coding_exception; +use mod_forum\completion\custom_completion; +use moodle_exception; + +defined('MOODLE_INTERNAL') || die(); + +global $CFG; +require_once($CFG->libdir . '/completionlib.php'); +require_once($CFG->dirroot . '/mod/forum/tests/generator/lib.php'); +require_once($CFG->dirroot . '/mod/forum/tests/generator_trait.php'); + +/** + * Class for unit testing mod_forum/activity_custom_completion. + * + * @package mod_forum + * @copyright Simey Lameze + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ +class custom_completion_test extends advanced_testcase { + + use \mod_forum_tests_generator_trait; + + /** + * Data provider for get_state(). + * + * @return array[] + */ + public function get_state_provider(): array { + return [ + 'Undefined rule' => [ + 'somenonexistentrule', 0, COMPLETION_TRACKING_NONE, 0, 0, 0, null, coding_exception::class + ], + 'Completion discussions rule not available' => [ + 'completiondiscussions', 0, COMPLETION_TRACKING_NONE, 0, 0, 0, null, moodle_exception::class + ], + 'Completion discussions rule available, user has not created discussion' => [ + 'completiondiscussions', 0, COMPLETION_TRACKING_AUTOMATIC, 5, 0, 0, COMPLETION_INCOMPLETE, null + ], + 'Rule available, user has created discussions' => [ + 'completiondiscussions', 5, COMPLETION_TRACKING_AUTOMATIC, 5, 0, 0, COMPLETION_COMPLETE, null + ], + 'Completion replies rule not available' => [ + 'completionreplies', 0, COMPLETION_TRACKING_NONE, 0, 0, 0, null, moodle_exception::class + ], + 'Rule available, user has not replied' => [ + 'completionreplies', 0, COMPLETION_TRACKING_AUTOMATIC, 0, 5, 0, COMPLETION_INCOMPLETE, null + ], + 'Rule available, user has created replied' => [ + 'completionreplies', 5, COMPLETION_TRACKING_AUTOMATIC, 0, 5, 0, COMPLETION_COMPLETE, null + ], + 'Completion posts rule not available' => [ + 'completionposts', 0, COMPLETION_TRACKING_NONE, 0, 0, 0, null, moodle_exception::class + ], + 'Rule available, user has not posted' => [ + 'completionposts', 0, COMPLETION_TRACKING_AUTOMATIC, 0, 0, 5, COMPLETION_INCOMPLETE, null + ], + 'Rule available, user has posted' => [ + 'completionposts', 5, COMPLETION_TRACKING_AUTOMATIC, 0, 0, 5, COMPLETION_COMPLETE, null + ], + ]; + } + + /** + * Test for get_state(). + * + * @dataProvider get_state_provider + * @param string $rule The custom completion rule. + * @param int $rulecount Quantity of discussions, replies or posts to be created. + * @param int $available Whether this rule is available. + * @param int|null $discussions The number of discussions. + * @param int|null $replies The number of replies. + * @param int|null $posts The number of posts. + * @param int|null $status Expected status. + * @param string|null $exception Expected exception. + */ + public function test_get_state(string $rule, int $rulecount, int $available, ?int $discussions, ?int $replies, + ?int $posts, ?int $status, ?string $exception) { + + if (!is_null($exception)) { + $this->expectException($exception); + } + + $this->resetAfterTest(); + + $course = $this->getDataGenerator()->create_course(['enablecompletion' => COMPLETION_ENABLED]); + $student = $this->getDataGenerator()->create_and_enrol($course, 'student'); + + $forumgenerator = $this->getDataGenerator()->get_plugin_generator('mod_forum'); + + $params = [ + 'course' => $course->id, + 'completion' => $available, + 'completiondiscussions' => $discussions, + 'completionreplies' => $replies, + 'completionposts' => $posts + ]; + $forum = $this->getDataGenerator()->create_module('forum', $params); + + $cm = get_coursemodule_from_instance('forum', $forum->id); + + if ($rulecount > 0) { + if ($rule == 'completiondiscussions') { + // Create x number of discussions. + for ($i = 0; $i < $rulecount; $i++) { + $forumgenerator->create_discussion((object) [ + 'course' => $forum->course, + 'userid' => $student->id, + 'forum' => $forum->id, + ]); + } + } else if ($rule == 'completionreplies') { + [$discussion1, $post1] = $this->helper_post_to_forum($forum, $student); + for ($i = 0; $i < $rulecount; $i++) { + $this->helper_reply_to_post($post1, $student); + } + } else if ($rule == 'completionposts') { + for ($i = 0; $i < $rulecount; $i++) { + $this->helper_post_to_forum($forum, $student); + } + } + } + + // Make sure we're using a cm_info object. + $cm = cm_info::create($cm); + + $customcompletion = new custom_completion($cm, (int)$student->id); + $this->assertEquals($status, $customcompletion->get_state($rule)); + } + + /** + * Test for get_defined_custom_rules(). + */ + public function test_get_defined_custom_rules() { + $rules = custom_completion::get_defined_custom_rules(); + $this->assertCount(3, $rules); + $this->assertEquals('completiondiscussions', reset($rules)); + } + + /** + * Test for get_defined_custom_rule_descriptions(). + */ + public function test_get_custom_rule_descriptions() { + // Get defined custom rules. + $rules = custom_completion::get_defined_custom_rules(); + + // Build a mock cm_info instance. + $mockcminfo = $this->getMockBuilder(cm_info::class) + ->disableOriginalConstructor() + ->onlyMethods(['__get']) + ->getMock(); + // Instantiate a custom_completion object using the mocked cm_info. + $customcompletion = new custom_completion($mockcminfo, 1); + + // Get custom rule descriptions. + $ruledescriptions = $customcompletion->get_custom_rule_descriptions(); + + // Confirm that defined rules and rule descriptions are consistent with each other. + $this->assertEquals(count($rules), count($ruledescriptions)); + foreach ($rules as $rule) { + $this->assertArrayHasKey($rule, $ruledescriptions); + } + } + + /** + * Test for is_defined(). + */ + public function test_is_defined() { + // Build a mock cm_info instance. + $mockcminfo = $this->getMockBuilder(cm_info::class) + ->disableOriginalConstructor() + ->getMock(); + + $customcompletion = new custom_completion($mockcminfo, 1); + + // Rule is defined. + $this->assertTrue($customcompletion->is_defined('completiondiscussions')); + + // Undefined rule. + $this->assertFalse($customcompletion->is_defined('somerandomrule')); + } + + /** + * Data provider for test_get_available_custom_rules(). + * + * @return array[] + */ + public function get_available_custom_rules_provider(): array { + return [ + 'Completion discussions available' => [ + COMPLETION_ENABLED, ['completiondiscussions'] + ], + 'Completion discussions not available' => [ + COMPLETION_DISABLED, [] + ], + 'Completion replies available' => [ + COMPLETION_ENABLED, ['completionreplies'] + ], + 'Completion replies not available' => [ + COMPLETION_DISABLED, [] + ], + 'Completion posts available' => [ + COMPLETION_ENABLED, ['completionposts'] + ], + 'Completion posts not available' => [ + COMPLETION_DISABLED, [] + ], + ]; + } + + /** + * Test for get_available_custom_rules(). + * + * @dataProvider get_available_custom_rules_provider + * @param int $status + * @param array $expected + */ + public function test_get_available_custom_rules(int $status, array $expected) { + $customdataval = [ + 'customcompletionrules' => [] + ]; + if ($status == COMPLETION_ENABLED) { + $rule = $expected[0]; + $customdataval = [ + 'customcompletionrules' => [$rule => $status] + ]; + } + + // Build a mock cm_info instance. + $mockcminfo = $this->getMockBuilder(cm_info::class) + ->disableOriginalConstructor() + ->onlyMethods(['__get']) + ->getMock(); + + // Mock the return of magic getter for the customdata attribute. + $mockcminfo->expects($this->any()) + ->method('__get') + ->with('customdata') + ->willReturn($customdataval); + + $customcompletion = new custom_completion($mockcminfo, 1); + $this->assertEquals($expected, $customcompletion->get_available_custom_rules()); + } +}