MDL-63658 core_favourites: singularise the repository class types
authorJake Dallimore <jake@moodle.com>
Tue, 16 Oct 2018 09:46:26 +0000 (17:46 +0800)
committerJake Dallimore <jake@moodle.com>
Thu, 18 Oct 2018 00:22:07 +0000 (08:22 +0800)
Instead of favourites_repository we now have favourite_repository,
which is more in line with other implementations of this pattern.

favourites/classes/local/repository/favourite_repository.php [moved from favourites/classes/local/repository/favourites_repository.php with 98% similarity]
favourites/classes/local/repository/ifavourite_repository.php [moved from favourites/classes/local/repository/ifavourites_repository.php with 88% similarity]
favourites/classes/local/service/user_favourites_service.php
favourites/classes/services.php
favourites/tests/repository_test.php
favourites/tests/service_test.php

@@ -14,7 +14,7 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 /**
- * Contains the favourites_repository class, responsible for CRUD operations for favourites.
+ * Contains the favourite_repository class, responsible for CRUD operations for favourites.
  *
  * @package   core_favourites
  * @copyright 2018 Jake Dallimore <jrhdallimore@gmail.com>
@@ -26,14 +26,14 @@ use \core_favourites\local\entity\favourite;
 defined('MOODLE_INTERNAL') || die();
 
 /**
- * Class favourites_repository.
+ * Class favourite_repository.
  *
  * This class handles persistence of favourites. Favourites from all areas are supported by this repository.
  *
  * @copyright 2018 Jake Dallimore <jrhdallimore@gmail.com>
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-class favourites_repository implements ifavourites_repository {
+class favourite_repository implements ifavourite_repository {
 
     /**
      * @var string the name of the table which favourites are stored in.
@@ -14,7 +14,7 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 /**
- * Contains the favourites_repository interface.
+ * Contains the favourite_repository interface.
  *
  * @package   core_favourites
  * @copyright 2018 Jake Dallimore <jrhdallimore@gmail.com>
@@ -26,12 +26,12 @@ use \core_favourites\local\entity\favourite;
 defined('MOODLE_INTERNAL') || die();
 
 /**
- * The favourites_repository interface, defining additional operations useful to favourite type repositories.
+ * The favourite_repository interface, defining additional operations useful to favourite type repositories.
  *
  * @copyright 2018 Jake Dallimore <jrhdallimore@gmail.com>
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-interface ifavourites_repository extends crud_repository {
+interface ifavourite_repository extends crud_repository {
     /**
      * Find a single favourite, based on it's unique identifiers.
      *
index 9fa806f..485f119 100644 (file)
@@ -32,14 +32,14 @@ defined('MOODLE_INTERNAL') || die();
  * This class is responsible for exposing key operations (add, remove, find) and enforces any business logic necessary to validate
  * authorization/data integrity for these operations.
  *
- * All object persistence is delegated to the ifavourites_repository.
+ * All object persistence is delegated to the ifavourite_repository.
  *
  * @copyright 2018 Jake Dallimore <jrhdallimore@gmail.com>
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class user_favourites_service {
 
-    /** @var ifavourites_repository $repo the user favourites repository object. */
+    /** @var ifavourite_repository $repo the user favourites repository object. */
     protected $repo;
 
     /** @var int $userid the id of the user to which this favourites service is scoped. */
@@ -49,9 +49,9 @@ class user_favourites_service {
      * The user_favourites_service constructor.
      *
      * @param \context_user $usercontext The context of the user to which this service operations are scoped.
-     * @param \core_favourites\local\repository\ifavourites_repository $repository a user favourites repository.
+     * @param \core_favourites\local\repository\ifavourite_repository $repository a user favourites repository.
      */
-    public function __construct(\context_user $usercontext, \core_favourites\local\repository\ifavourites_repository $repository) {
+    public function __construct(\context_user $usercontext, \core_favourites\local\repository\ifavourite_repository $repository) {
         $this->repo = $repository;
         $this->userid = $usercontext->instanceid;
     }
index 88c54b4..4b4d356 100644 (file)
@@ -43,7 +43,7 @@ class services {
      * @return \core_favourites\local\service\user_favourites_service the service object.
      */
     public static function get_service_for_user_context(\context_user $context) : local\service\user_favourites_service {
-        return new local\service\user_favourites_service($context, new local\repository\favourites_repository());
+        return new local\service\user_favourites_service($context, new local\repository\favourite_repository());
     }
 }
 
index 951dfa4..60c8ed3 100644 (file)
 
 defined('MOODLE_INTERNAL') || die();
 
-use \core_favourites\local\repository\favourites_repository;
+use \core_favourites\local\repository\favourite_repository;
 use \core_favourites\local\entity\favourite;
 
 /**
- * Test class covering the favourites_repository.
+ * Test class covering the favourite_repository.
  *
  * @copyright  2018 Jake Dallimore <jrhdallimore@gmail.com>
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-class favourites_repository_testcase extends advanced_testcase {
+class favourite_repository_testcase extends advanced_testcase {
 
     public function setUp() {
         $this->resetAfterTest();
@@ -60,7 +60,7 @@ class favourites_repository_testcase extends advanced_testcase {
         list($user1context, $user2context, $course1context, $course2context) = $this->setup_users_and_courses();
 
         // Create a favourites repository and favourite a course.
-        $favouritesrepo = new favourites_repository($user1context);
+        $favouritesrepo = new favourite_repository($user1context);
 
         $favcourse = new favourite(
             'core_course',
@@ -95,7 +95,7 @@ class favourites_repository_testcase extends advanced_testcase {
         list($user1context, $user2context, $course1context, $course2context) = $this->setup_users_and_courses();
 
         // Create a favourites repository and favourite a course.
-        $favouritesrepo = new favourites_repository($user1context);
+        $favouritesrepo = new favourite_repository($user1context);
 
         $favcourse = new favourite(
             'core_course',
@@ -117,7 +117,7 @@ class favourites_repository_testcase extends advanced_testcase {
         list($user1context, $user2context, $course1context, $course2context) = $this->setup_users_and_courses();
 
         // Create a favourites repository and try to favourite a course.
-        $favouritesrepo = new favourites_repository($user1context);
+        $favouritesrepo = new favourite_repository($user1context);
 
         $favcourse = new favourite(
             'core_course',
@@ -136,7 +136,7 @@ class favourites_repository_testcase extends advanced_testcase {
         list($user1context, $user2context, $course1context, $course2context) = $this->setup_users_and_courses();
 
         // Create a favourites repository and favourite several courses.
-        $favouritesrepo = new favourites_repository($user1context);
+        $favouritesrepo = new favourite_repository($user1context);
         $favcourses = [];
 
         $favcourses[] = new favourite(
@@ -183,7 +183,7 @@ class favourites_repository_testcase extends advanced_testcase {
         list($user1context, $user2context, $course1context, $course2context) = $this->setup_users_and_courses();
 
         // Create a favourites repository and favourite a course.
-        $favouritesrepo = new favourites_repository($user1context);
+        $favouritesrepo = new favourite_repository($user1context);
         $favourite = new favourite(
             'core_course',
             'course',
@@ -210,7 +210,7 @@ class favourites_repository_testcase extends advanced_testcase {
     public function test_find_all() {
         list($user1context, $user2context, $course1context, $course2context) = $this->setup_users_and_courses();
 
-        $favouritesrepo = new favourites_repository($user1context);
+        $favouritesrepo = new favourite_repository($user1context);
 
         // Verify that for an empty repository, find_all returns an empty array.
         $this->assertEquals([], $favouritesrepo->find_all());
@@ -249,7 +249,7 @@ class favourites_repository_testcase extends advanced_testcase {
     public function test_find_all_pagination() {
         list($user1context, $user2context, $course1context, $course2context) = $this->setup_users_and_courses();
 
-        $favouritesrepo = new favourites_repository($user1context);
+        $favouritesrepo = new favourite_repository($user1context);
 
         // Verify that for an empty repository, find_all with any combination of page options returns an empty array.
         $this->assertEquals([], $favouritesrepo->find_all(0, 0));
@@ -292,7 +292,7 @@ class favourites_repository_testcase extends advanced_testcase {
         list($user1context, $user2context, $course1context, $course2context) = $this->setup_users_and_courses();
 
         // Create a favourites repository and favourite a course.
-        $favouritesrepo = new favourites_repository($user1context);
+        $favouritesrepo = new favourite_repository($user1context);
         $favourite = new favourite(
             'core_course',
             'course',
@@ -319,7 +319,7 @@ class favourites_repository_testcase extends advanced_testcase {
     public function test_find_by_pagination() {
         list($user1context, $user2context, $course1context, $course2context) = $this->setup_users_and_courses();
 
-        $favouritesrepo = new favourites_repository($user1context);
+        $favouritesrepo = new favourite_repository($user1context);
 
         // Verify that for an empty repository, find_all with any combination of page options returns an empty array.
         $this->assertEquals([], $favouritesrepo->find_by([], 0, 0));
@@ -366,7 +366,7 @@ class favourites_repository_testcase extends advanced_testcase {
         list($user1context, $user2context, $course1context, $course2context) = $this->setup_users_and_courses();
 
         // Create a favourites repository and add 2 favourites in different areas.
-        $favouritesrepo = new favourites_repository($user1context);
+        $favouritesrepo = new favourite_repository($user1context);
         $favourite = new favourite(
             'core_course',
             'course',
@@ -397,7 +397,7 @@ class favourites_repository_testcase extends advanced_testcase {
         list($user1context, $user2context, $course1context, $course2context) = $this->setup_users_and_courses();
 
         // Create a favourites repository and favourite a course.
-        $favouritesrepo = new favourites_repository($user1context);
+        $favouritesrepo = new favourite_repository($user1context);
         $favourite = new favourite(
             'core_course',
             'course',
@@ -418,7 +418,7 @@ class favourites_repository_testcase extends advanced_testcase {
         list($user1context, $user2context, $course1context, $course2context) = $this->setup_users_and_courses();
 
         // Create a favourites repository and favourite two courses, in different areas.
-        $favouritesrepo = new favourites_repository($user1context);
+        $favouritesrepo = new favourite_repository($user1context);
         $favourite = new favourite(
             'core_course',
             'course',
@@ -454,7 +454,7 @@ class favourites_repository_testcase extends advanced_testcase {
         list($user1context, $user2context, $course1context, $course2context) = $this->setup_users_and_courses();
 
         // Create a favourites repository and favourite a course.
-        $favouritesrepo = new favourites_repository($user1context);
+        $favouritesrepo = new favourite_repository($user1context);
         $favourite = new favourite(
             'core_course',
             'course',
@@ -476,7 +476,7 @@ class favourites_repository_testcase extends advanced_testcase {
         list($user1context, $user2context, $course1context, $course2context) = $this->setup_users_and_courses();
 
         // Create a favourites repository and favourite a course.
-        $favouritesrepo = new favourites_repository($user1context);
+        $favouritesrepo = new favourite_repository($user1context);
         $favourite = new favourite(
             'core_course',
             'course',
@@ -498,7 +498,7 @@ class favourites_repository_testcase extends advanced_testcase {
         list($user1context, $user2context, $course1context, $course2context) = $this->setup_users_and_courses();
 
         // Create a favourites repository and favourite two courses, in different areas.
-        $favouritesrepo = new favourites_repository($user1context);
+        $favouritesrepo = new favourite_repository($user1context);
         $favourite = new favourite(
             'core_course',
             'course',
index 7f0a094..b73398e 100644 (file)
@@ -58,7 +58,7 @@ class user_favourites_service_testcase extends advanced_testcase {
      */
     protected function get_mock_repository(array $mockstore) {
         // This mock will just store data in an array.
-        $mockrepo = $this->getMockBuilder(\core_favourites\local\repository\ifavourites_repository::class)
+        $mockrepo = $this->getMockBuilder(\core_favourites\local\repository\ifavourite_repository::class)
             ->setMethods([])
             ->getMock();
         $mockrepo->expects($this->any())