From d8e2ca0aaebdea741c6da8f7800fe4baa8150f17 Mon Sep 17 00:00:00 2001 From: Simey Lameze Date: Tue, 2 Mar 2021 07:02:25 +0800 Subject: [PATCH] MDL-70820 mod_glossary: custom completion implementation --- .../classes/completion/custom_completion.php | 76 ++++++ mod/glossary/lang/en/glossary.php | 1 + mod/glossary/tests/custom_completion_test.php | 217 ++++++++++++++++++ 3 files changed, 294 insertions(+) create mode 100644 mod/glossary/classes/completion/custom_completion.php create mode 100644 mod/glossary/tests/custom_completion_test.php diff --git a/mod/glossary/classes/completion/custom_completion.php b/mod/glossary/classes/completion/custom_completion.php new file mode 100644 index 00000000000..60deecbea23 --- /dev/null +++ b/mod/glossary/classes/completion/custom_completion.php @@ -0,0 +1,76 @@ +. + +declare(strict_types=1); + +namespace mod_glossary\completion; + +use core_completion\activity_custom_completion; + +/** + * Activity custom completion subclass for the glossary activity. + * + * Class for defining mod_glossary's custom completion rules and fetching the completion statuses + * of the custom completion rules for a given glossary instance and a user. + * + * @package mod_glossary + * @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); + + $glossaryid = $this->cm->instance; + $userid = $this->userid; + + $userentries = $DB->count_records('glossary_entries', ['glossaryid' => $glossaryid, 'userid' => $userid, + 'approved' => 1]); + $completionentries = $this->cm->customdata['customcompletionrules']['completionentries']; + + return ($completionentries <= $userentries) ? 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 ['completionentries']; + } + + /** + * Returns an associative array of the descriptions of custom completion rules. + * + * @return array + */ + public function get_custom_rule_descriptions(): array { + $completionentries = $this->cm->customdata['customcompletionrules']['completionentries'] ?? 0; + return [ + 'completionentries' => get_string('completiondetail:entries', 'glossary', $completionentries), + ]; + } +} diff --git a/mod/glossary/lang/en/glossary.php b/mod/glossary/lang/en/glossary.php index 42ab670629f..0e64b561885 100644 --- a/mod/glossary/lang/en/glossary.php +++ b/mod/glossary/lang/en/glossary.php @@ -87,6 +87,7 @@ $string['commentdeleted'] = 'The comment has been deleted.'; $string['comments'] = 'Comments'; $string['commentson'] = 'Comments on'; $string['commentupdated'] = 'The comment has been updated.'; +$string['completiondetail:entries'] = 'Make entries: {$a}'; $string['completionentries'] = 'Student must create entries:'; $string['completionentriesdesc'] = 'Student must create at least {$a} entry/entries'; $string['completionentriesgroup'] = 'Require entries'; diff --git a/mod/glossary/tests/custom_completion_test.php b/mod/glossary/tests/custom_completion_test.php new file mode 100644 index 00000000000..c9af3d71cd7 --- /dev/null +++ b/mod/glossary/tests/custom_completion_test.php @@ -0,0 +1,217 @@ +. + +/** + * Contains unit tests for core_completion/activity_custom_completion. + * + * @package mod_glossary + * @copyright Simey Lameze + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ + +declare(strict_types=1); + +namespace mod_glossary; + +use advanced_testcase; +use cm_info; +use coding_exception; +use mod_glossary\completion\custom_completion; +use moodle_exception; + +defined('MOODLE_INTERNAL') || die(); + +global $CFG; +require_once($CFG->libdir . '/completionlib.php'); + +/** + * Class for unit testing mod_glossary/activity_custom_completion. + * + * @package mod_glossary + * @copyright Simey Lameze + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ +class custom_completion_test extends advanced_testcase { + + /** + * Data provider for get_state(). + * + * @return array[] + */ + public function get_state_provider(): array { + return [ + 'Undefined rule' => [ + 'somenonexistentrule', COMPLETION_DISABLED, 0, null, coding_exception::class + ], + 'Rule not available' => [ + 'completionentries', COMPLETION_DISABLED, 0, null, moodle_exception::class + ], + 'Rule available, user has not submitted' => [ + 'completionentries', COMPLETION_ENABLED, 0, COMPLETION_INCOMPLETE, null + ], + 'Rule available, user has submitted' => [ + 'completionentries', COMPLETION_ENABLED, 2, COMPLETION_COMPLETE, null + ], + ]; + } + + /** + * Test for get_state(). + * + * @dataProvider get_state_provider + * @param string $rule The custom completion rule. + * @param int $available Whether this rule is available. + * @param int $entries The number of entries. + * @param int|null $status Expected status. + * @param string|null $exception Expected exception. + */ + public function test_get_state(string $rule, int $available, int $entries, ?int $status, ?string $exception) { + global $DB; + + if (!is_null($exception)) { + $this->expectException($exception); + } + + // Custom completion rule data for cm_info::customdata. + $customdataval = [ + 'customcompletionrules' => [ + $rule => $available + ] + ]; + + // Build a mock cm_info instance. + $mockcminfo = $this->getMockBuilder(cm_info::class) + ->disableOriginalConstructor() + ->onlyMethods(['__get']) + ->getMock(); + + // Mock the return of the magic getter method when fetching the cm_info object's customdata and instance values. + $mockcminfo->expects($this->any()) + ->method('__get') + ->will($this->returnValueMap([ + ['customdata', $customdataval], + ['instance', 1], + ])); + + // Mock the DB calls. + $DB = $this->createMock(get_class($DB)); + $DB->expects($this->atMost(1)) + ->method('count_records') + ->willReturn($entries); + + $customcompletion = new custom_completion($mockcminfo, 2); + $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(1, $rules); + $this->assertEquals('completionentries', $rules[0]); + } + + /** + * 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('completionentries')); + + // 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 submit available' => [ + COMPLETION_ENABLED, ['completionentries'] + ], + 'Completion submit 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' => [ + 'completionentries' => $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()); + } +}