Implementing smart loading of entity class for table

Cake/ORM/Error/MissingEntityException.php

@@ -0,0 +1,29 @@
+<?php
+/**
+ * MissingModelException class
+ *
+ * PHP 5
+ *
+ * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
+ * Copyright 2005-2013, Cake Software Foundation, Inc. (http://cakefoundation.org)
+ *
+ * Licensed under The MIT License
+ * Redistributions of files must retain the above copyright notice.
+ *
+ * @copyright     Copyright 2005-2013, Cake Software Foundation, Inc. (http://cakefoundation.org)
+ * @since         CakePHP(tm) v 3.0
+ * @license       MIT License (http://www.opensource.org/licenses/mit-license.php)
+ */
+namespace Cake\ORM\Error;
+
+use Cake\Error\Exception;
+
+/**
+ * Exception raised when an Entity  could not be found.
+ *
+ */
+class MissingEntityException extends Exception {
+
+	protected $_messageTemplate = 'Entity class %s could not be found.';
+
+}

Cake/ORM/Error/MissingTableClassException.php

@@ -10,8 +10,7 @@
  * Licensed under The MIT License
  * Redistributions of files must retain the above copyright notice.
  *
- * @copyright     Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
- * @link          http://book.cakephp.org/2.0/en/development/testing.html
+ * @copyright     Copyright 2005-2013, Cake Software Foundation, Inc. (http://cakefoundation.org)
  * @since         CakePHP(tm) v 3.0
  * @license       MIT License (http://www.opensource.org/licenses/mit-license.php)
  */
@@ -20,11 +19,11 @@
 use Cake\Error\Exception;
 
 /**
- * Exception raised when a Model could not be found.
+ * Exception raised when an Entity  could not be found.
  *
  */
-class MissingTableClassException extends Exception {
+class MissingEntityException extends Exception {
 
-	protected $_messageTemplate = 'Table class %s could not be found.';
+	protected $_messageTemplate = 'Entity class %s could not be found.';
 
 }

Cake/ORM/Table.php

@@ -125,8 +125,7 @@ class Table {
  *
  * @var string
  */
-	protected $_entityClass = '\Cake\ORM\Entity';
-
+	protected $_entityClass;
 
 /**
  * Initializes a new instance
@@ -388,12 +387,35 @@ public function displayField($key = null) {
  * a new one
  *
  * @param string $name the name of the class to use
+ * @throws \Cake\ORM\Error\MissingEntityException when the entity class cannot be found
  * @return string
  */
 	public function entityClass($name = null) {
+		if ($name === null && !$this->_entityClass) {
+			$default = '\Cake\ORM\Entity';
+			$self = get_called_class();
+			$parts = explode('\\', $self);
+
+			if ($self === __CLASS__ || count($parts) < 3) {
+				return $this->_entityClass = $default;
+			}
+
+			$alias = substr(array_pop($parts), 0, -5);
+			$name = implode('\\', array_slice($parts, 0, -1)) . '\Entity\\' . $alias;
+			if (!class_exists($name)) {
+				return $this->_entityClass = $default;
+			}
+		}
+
 		if ($name !== null) {
-			$this->_entityClass = $name;
+			$class = App::classname($name, 'Model\Entity');
+			$this->_entityClass = $class;
 		}
+
+		if (!$this->_entityClass) {
+			throw new Error\MissingEntityException([$name]);
+		}
+
 		return $this->_entityClass;
 	}
 

Cake/Test/TestApp/Model/Entity/Article.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace TestApp\Model\Entity;
+
+use Cake\ORM\Entity;
+
+/**
+ * Tests entity class used for asserting correct loading
+ *
+ */
+class Article extends Entity {
+
+}

Cake/Test/TestApp/Model/Repository/ArticleTable.php

@@ -0,0 +1,21 @@
+<?php
+/**
+ * CakePHP(tm) Tests <http://book.cakephp.org/2.0/en/development/testing.html>
+ * Copyright 2005-2013, Cake Software Foundation, Inc. (http://cakefoundation.org)
+ *
+ * Licensed under The MIT License
+ * Redistributions of files must retain the above copyright notice
+ *
+ * @since         CakePHP(tm) v 3.0
+ * @license       MIT License (http://www.opensource.org/licenses/mit-license.php)
+ */
+namespace TestApp\Model\Repository;
+
+use Cake\ORM\Table;
+
+/**
+ * Article class
+ *
+ */
+class ArticleTable extends Table {
+}

Cake/Test/TestCase/ORM/QueryTest.php

@@ -1261,7 +1261,7 @@ public function testHydrateCustomObject() {
 		$class = $this->getMockClass('\Cake\ORM\Entity', ['fakeMethod']);
 		$table = Table::build('article', [
 			'table' => 'articles',
-			'entityClass' => $class
+			'entityClass' => '\\' . $class
 		]);
 		$query = new Query($this->connection, $table);
 		$results = $query->select()->hydrate(true)->execute()->toArray();
@@ -1292,11 +1292,11 @@ public function testHydrateWithHasManyCustomEntity() {
 		$articleEntity = $this->getMockClass('\Cake\ORM\Entity', ['foo']);
 		$table = Table::build('author', [
 			'connection' => $this->connection,
-			'entityClass' => $authorEntity
+			'entityClass' => '\\' . $authorEntity
 		]);
 		Table::build('article', [
 			'connection' => $this->connection,
-			'entityClass' => $articleEntity
+			'entityClass' => '\\' . $articleEntity
 		]);
 		$table->hasMany('article', [
 			'property' => 'articles',
@@ -1337,7 +1337,7 @@ public function testHydrateBelongsToCustomEntity() {
 		$table = Table::build('article', ['table' => 'articles']);
 		Table::build('author', [
 			'connection' => $this->connection,
-			'entityClass' => $authorEntity
+			'entityClass' => '\\' . $authorEntity
 		]);
 		$table->belongsTo('author');
 

Cake/Test/TestCase/ORM/TableTest.php

@@ -783,4 +783,74 @@ public function testFindListHydrated() {
 		$this->assertSame($expected, $query->toArray());
 	}
 
+	public function testEntityClassDefault() {
+		$table = new Table();
+		$this->assertEquals('\Cake\ORM\Entity', $table->entityClass());
+	}
+
+/**
+ * Tests that using a simple string for entityClass will try to
+ * load the class from the App namespace
+ *
+ * @return void
+ */
+	public function testRepositoryClassInAPP() {
+		$class = $this->getMockClass('\Cake\ORM\Entity');
+		class_alias($class, 'App\Model\Entity\TestUser');
+		$table = new Table();
+		$this->assertEquals('App\Model\Entity\TestUser', $table->entityClass('TestUser'));
+	}
+
+/**
+ * Tests that using a simple string for entityClass will try to
+ * load the class from the Plugin namespace when using plugin notation
+ *
+ * @return void
+ */
+	public function testRepositoryClassInPlugin() {
+		$class = $this->getMockClass('\Cake\ORM\Entity');
+		class_alias($class, 'MyPlugin\Model\Entity\SuperUser');
+		$table = new Table();
+		$this->assertEquals(
+			'MyPlugin\Model\Entity\SuperUser',
+			$table->entityClass('MyPlugin.SuperUser')
+		);
+	}
+
+/**
+ * Tests that using a simple string for entityClass will throw an exception
+ * when the class does not exist in the namespace
+ *
+ * @expectedException Cake\ORM\Error\MissingEntityException
+ * @expectedExceptionMessage Entity class FooUser could not be found.
+ * @return void
+ */
+	public function testRepositoryClassNonExisting() {
+		$table = new Table;
+		$this->assertFalse($table->entityClass('FooUser'));
+	}
+
+/**
+ * Tests getting the entityClass based on conventions for the entity
+ * namespace
+ *
+ * @return void
+ */
+	public function testRepositoryClassConventionForAPP() {
+		$table = new \TestApp\Model\Repository\ArticleTable;
+		$this->assertEquals('TestApp\Model\Entity\Article', $table->entityClass());
+	}
+
+/**
+ * Tests setting a entity class object using the setter method
+ *
+ * @return void
+ */
+	public function testSetEntityClass() {
+		$table = new Table;
+		$class = '\\' . $this->getMockClass('\Cake\ORM\Entity');
+		$table->entityClass($class);
+		$this->assertEquals($class, $table->entityClass());
+	}
+
 }