From 6a72ba5f9788141d988e2e9b491a8287e9b86bbd Mon Sep 17 00:00:00 2001
From: Fabien Potencier <fabien@symfony.com>
Date: Thu, 13 Oct 2011 23:39:11 +0200
Subject: [PATCH] DDC-1418 - Add simplified XML and YAML drivers ported from
the Symfony project, thanks Fabien
---
.../Mapping/Driver/SimplifiedXmlDriver.php | 176 +++++++++++++++++
.../Mapping/Driver/SimplifiedYamlDriver.php | 182 ++++++++++++++++++
.../Mapping/Symfony/AbstractDriverTest.php | 113 +++++++++++
.../ORM/Mapping/Symfony/XmlDriverTest.php | 40 ++++
.../ORM/Mapping/Symfony/YamlDriverTest.php | 40 ++++
5 files changed, 551 insertions(+)
create mode 100644 lib/Doctrine/ORM/Mapping/Driver/SimplifiedXmlDriver.php
create mode 100644 lib/Doctrine/ORM/Mapping/Driver/SimplifiedYamlDriver.php
create mode 100644 tests/Doctrine/Tests/ORM/Mapping/Symfony/AbstractDriverTest.php
create mode 100644 tests/Doctrine/Tests/ORM/Mapping/Symfony/XmlDriverTest.php
create mode 100644 tests/Doctrine/Tests/ORM/Mapping/Symfony/YamlDriverTest.php
diff --git a/lib/Doctrine/ORM/Mapping/Driver/SimplifiedXmlDriver.php b/lib/Doctrine/ORM/Mapping/Driver/SimplifiedXmlDriver.php
new file mode 100644
index 000000000..e60eab779
--- /dev/null
+++ b/lib/Doctrine/ORM/Mapping/Driver/SimplifiedXmlDriver.php
@@ -0,0 +1,176 @@
+<?php
+/*
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * This software consists of voluntary contributions made by many individuals
+ * and is licensed under the LGPL. For more information, see
+ * <http://www.doctrine-project.org>.
+*/
+
+namespace Doctrine\ORM\Mapping\Driver;
+
+use Doctrine\ORM\Mapping\MappingException;
+
+/**
+ * XmlDriver that additionally looks for mapping information in a global file.
+ *
+ * @author Fabien Potencier <fabien@symfony.com>
+ * @author Benjamin Eberlei <kontakt@beberlei.de>
+ * @license MIT
+ */
+class SimplifiedXmlDriver extends XmlDriver
+{
+ protected $_prefixes = array();
+ protected $_globalBasename;
+ protected $_classCache;
+ protected $_fileExtension = '.orm.xml';
+
+ public function __construct($prefixes)
+ {
+ $this->addNamespacePrefixes($prefixes);
+ }
+
+ public function setGlobalBasename($file)
+ {
+ $this->_globalBasename = $file;
+ }
+
+ public function getGlobalBasename()
+ {
+ return $this->_globalBasename;
+ }
+
+ public function addNamespacePrefixes($prefixes)
+ {
+ $this->_prefixes = array_merge($this->_prefixes, $prefixes);
+ $this->addPaths(array_flip($prefixes));
+ }
+
+ public function getNamespacePrefixes()
+ {
+ return $this->_prefixes;
+ }
+
+ public function isTransient($className)
+ {
+ if (null === $this->_classCache) {
+ $this->initialize();
+ }
+
+ // The mapping is defined in the global mapping file
+ if (isset($this->_classCache[$className])) {
+ return false;
+ }
+
+ try {
+ $this->_findMappingFile($className);
+
+ return false;
+ } catch (MappingException $e) {
+ return true;
+ }
+ }
+
+ public function getAllClassNames()
+ {
+ if (null === $this->_classCache) {
+ $this->initialize();
+ }
+
+ $classes = array();
+
+ if ($this->_paths) {
+ foreach ((array) $this->_paths as $path) {
+ if (!is_dir($path)) {
+ throw MappingException::fileMappingDriversRequireConfiguredDirectoryPath($path);
+ }
+
+ $iterator = new \RecursiveIteratorIterator(
+ new \RecursiveDirectoryIterator($path),
+ \RecursiveIteratorIterator::LEAVES_ONLY
+ );
+
+ foreach ($iterator as $file) {
+ $fileName = $file->getBasename($this->_fileExtension);
+
+ if ($fileName == $file->getBasename() || $fileName == $this->_globalBasename) {
+ continue;
+ }
+
+ // NOTE: All files found here means classes are not transient!
+ if (isset($this->_prefixes[$path])) {
+ $classes[] = $this->_prefixes[$path].'\\'.str_replace('.', '\\', $fileName);
+ } else {
+ $classes[] = str_replace('.', '\\', $fileName);
+ }
+ }
+ }
+ }
+
+ return array_merge($classes, array_keys($this->_classCache));
+ }
+
+ public function getElement($className)
+ {
+ if (null === $this->_classCache) {
+ $this->initialize();
+ }
+
+ if (!isset($this->_classCache[$className])) {
+ $this->_classCache[$className] = parent::getElement($className);
+ }
+
+ return $this->_classCache[$className];
+ }
+
+ protected function initialize()
+ {
+ $this->_classCache = array();
+ if (null !== $this->_globalBasename) {
+ foreach ($this->_paths as $path) {
+ if (is_file($file = $path.'/'.$this->_globalBasename.$this->_fileExtension)) {
+ $this->_classCache = array_merge($this->_classCache, $this->_loadMappingFile($file));
+ }
+ }
+ }
+ }
+
+ protected function _findMappingFile($className)
+ {
+ $defaultFileName = str_replace('\\', '.', $className).$this->_fileExtension;
+ foreach ($this->_paths as $path) {
+ if (!isset($this->_prefixes[$path])) {
+ if (is_file($path.DIRECTORY_SEPARATOR.$defaultFileName)) {
+ return $path.DIRECTORY_SEPARATOR.$defaultFileName;
+ }
+
+ continue;
+ }
+
+ $prefix = $this->_prefixes[$path];
+
+ if (0 !== strpos($className, $prefix.'\\')) {
+ continue;
+ }
+
+ $filename = $path.'/'.strtr(substr($className, strlen($prefix)+1), '\\', '.').$this->_fileExtension;
+ if (is_file($filename)) {
+ return $filename;
+ }
+
+ throw MappingException::mappingFileNotFound($className, $filename);
+ }
+
+ throw MappingException::mappingFileNotFound($className, substr($className, strrpos($className, '\\') + 1).$this->_fileExtension);
+ }
+}
diff --git a/lib/Doctrine/ORM/Mapping/Driver/SimplifiedYamlDriver.php b/lib/Doctrine/ORM/Mapping/Driver/SimplifiedYamlDriver.php
new file mode 100644
index 000000000..679ee85cc
--- /dev/null
+++ b/lib/Doctrine/ORM/Mapping/Driver/SimplifiedYamlDriver.php
@@ -0,0 +1,182 @@
+<?php
+/*
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * This software consists of voluntary contributions made by many individuals
+ * and is licensed under the LGPL. For more information, see
+ * <http://www.doctrine-project.org>.
+*/
+
+namespace Doctrine\ORM\Mapping\Driver;
+
+use Doctrine\ORM\Mapping\MappingException;
+
+/**
+ * YamlDriver that additionally looks for mapping information in a global file.
+ *
+ * @author Fabien Potencier <fabien@symfony.com>
+ * @author Benjamin Eberlei <kontakt@beberlei.de>
+ * @license MIT
+ */
+class SimplifiedYamlDriver extends YamlDriver
+{
+ protected $_prefixes = array();
+ protected $_globalBasename;
+ protected $_classCache;
+ protected $_fileExtension = '.orm.yml';
+
+ public function __construct($prefixes)
+ {
+ $this->addNamespacePrefixes($prefixes);
+ }
+
+ public function setGlobalBasename($file)
+ {
+ $this->_globalBasename = $file;
+ }
+
+ public function getGlobalBasename()
+ {
+ return $this->_globalBasename;
+ }
+
+ public function addNamespacePrefixes($prefixes)
+ {
+ $this->_prefixes = array_merge($this->_prefixes, $prefixes);
+ $this->addPaths(array_flip($prefixes));
+ }
+
+ public function addNamespacePrefix($prefix, $path)
+ {
+ $this->_prefixes[$path] = $prefix;
+ }
+
+
+ public function getNamespacePrefixes()
+ {
+ return $this->_prefixes;
+ }
+
+ public function isTransient($className)
+ {
+ if (null === $this->_classCache) {
+ $this->initialize();
+ }
+
+ // The mapping is defined in the global mapping file
+ if (isset($this->_classCache[$className])) {
+ return false;
+ }
+
+ try {
+ $this->_findMappingFile($className);
+
+ return false;
+ } catch (MappingException $e) {
+ return true;
+ }
+ }
+
+ public function getAllClassNames()
+ {
+ if (null === $this->_classCache) {
+ $this->initialize();
+ }
+
+ $classes = array();
+
+ if ($this->_paths) {
+ foreach ((array) $this->_paths as $path) {
+ if (!is_dir($path)) {
+ throw MappingException::fileMappingDriversRequireConfiguredDirectoryPath($path);
+ }
+
+ $iterator = new \RecursiveIteratorIterator(
+ new \RecursiveDirectoryIterator($path),
+ \RecursiveIteratorIterator::LEAVES_ONLY
+ );
+
+ foreach ($iterator as $file) {
+ $fileName = $file->getBasename($this->_fileExtension);
+
+ if ($fileName == $file->getBasename() || $fileName == $this->_globalBasename) {
+ continue;
+ }
+
+ // NOTE: All files found here means classes are not transient!
+ if (isset($this->_prefixes[$path])) {
+ $classes[] = $this->_prefixes[$path].'\\'.str_replace('.', '\\', $fileName);
+ } else {
+ $classes[] = str_replace('.', '\\', $fileName);
+ }
+ }
+ }
+ }
+
+ return array_merge($classes, array_keys($this->_classCache));
+ }
+
+ public function getElement($className)
+ {
+ if (null === $this->_classCache) {
+ $this->initialize();
+ }
+
+ if (!isset($this->_classCache[$className])) {
+ $this->_classCache[$className] = parent::getElement($className);
+ }
+
+ return $this->_classCache[$className];
+ }
+
+ protected function initialize()
+ {
+ $this->_classCache = array();
+ if (null !== $this->_globalBasename) {
+ foreach ($this->_paths as $path) {
+ if (is_file($file = $path.'/'.$this->_globalBasename.$this->_fileExtension)) {
+ $this->_classCache = array_merge($this->_classCache, $this->_loadMappingFile($file));
+ }
+ }
+ }
+ }
+
+ protected function _findMappingFile($className)
+ {
+ $defaultFileName = str_replace('\\', '.', $className).$this->_fileExtension;
+ foreach ($this->_paths as $path) {
+ if (!isset($this->_prefixes[$path])) {
+ if (is_file($path.DIRECTORY_SEPARATOR.$defaultFileName)) {
+ return $path.DIRECTORY_SEPARATOR.$defaultFileName;
+ }
+
+ continue;
+ }
+
+ $prefix = $this->_prefixes[$path];
+
+ if (0 !== strpos($className, $prefix.'\\')) {
+ continue;
+ }
+
+ $filename = $path.'/'.strtr(substr($className, strlen($prefix)+1), '\\', '.').$this->_fileExtension;
+ if (is_file($filename)) {
+ return $filename;
+ }
+
+ throw MappingException::mappingFileNotFound($className, $filename);
+ }
+
+ throw MappingException::mappingFileNotFound($className, substr($className, strrpos($className, '\\') + 1).$this->_fileExtension);
+ }
+}
diff --git a/tests/Doctrine/Tests/ORM/Mapping/Symfony/AbstractDriverTest.php b/tests/Doctrine/Tests/ORM/Mapping/Symfony/AbstractDriverTest.php
new file mode 100644
index 000000000..d16db4fbb
--- /dev/null
+++ b/tests/Doctrine/Tests/ORM/Mapping/Symfony/AbstractDriverTest.php
@@ -0,0 +1,113 @@
+<?php
+/*
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * This software consists of voluntary contributions made by many individuals
+ * and is licensed under the LGPL. For more information, see
+ * <http://www.doctrine-project.org>.
+*/
+
+namespace Doctrine\Tests\ORM\Mapping\Symfony;
+
+/**
+ * @group DDC-1418
+ */
+abstract class AbstractDriverTest extends \PHPUnit_Framework_TestCase
+{
+ public function testFindMappingFile()
+ {
+ $driver = $this->getDriver(array(
+ 'MyNamespace\MySubnamespace\EntityFoo' => 'foo',
+ 'MyNamespace\MySubnamespace\Entity' => $this->dir,
+ ));
+
+ touch($filename = $this->dir.'/Foo'.$this->getFileExtension());
+ $this->assertEquals($filename, $this->invoke($driver, '_findMappingFile', array('MyNamespace\MySubnamespace\Entity\Foo')));
+ }
+
+ public function testFindMappingFileInSubnamespace()
+ {
+ $driver = $this->getDriver(array(
+ 'MyNamespace\MySubnamespace\Entity' => $this->dir,
+ ));
+
+ touch($filename = $this->dir.'/Foo.Bar'.$this->getFileExtension());
+ $this->assertEquals($filename, $this->invoke($driver, '_findMappingFile', array('MyNamespace\MySubnamespace\Entity\Foo\Bar')));
+ }
+
+ public function testFindMappingFileNamespacedFoundFileNotFound()
+ {
+ $this->setExpectedException(
+ 'Doctrine\ORM\Mapping\MappingException',
+ "No mapping file found named '".$this->dir."/Foo".$this->getFileExtension()."' for class 'MyNamespace\MySubnamespace\Entity\Foo'."
+ );
+
+ $driver = $this->getDriver(array(
+ 'MyNamespace\MySubnamespace\Entity' => $this->dir,
+ ));
+
+ $this->invoke($driver, '_findMappingFile', array('MyNamespace\MySubnamespace\Entity\Foo'));
+ }
+
+ public function testFindMappingNamespaceNotFound()
+ {
+ $this->setExpectedException(
+ 'Doctrine\ORM\Mapping\MappingException',
+ "No mapping file found named 'Foo".$this->getFileExtension()."' for class 'MyOtherNamespace\MySubnamespace\Entity\Foo'."
+ );
+
+ $driver = $this->getDriver(array(
+ 'MyNamespace\MySubnamespace\Entity' => $this->dir,
+ ));
+
+ $this->invoke($driver, '_findMappingFile', array('MyOtherNamespace\MySubnamespace\Entity\Foo'));
+ }
+
+ protected function setUp()
+ {
+ $this->dir = sys_get_temp_dir().'/abstract_driver_test';
+ @mkdir($this->dir, 0777, true);
+ }
+
+ protected function tearDown()
+ {
+ $iterator = new \RecursiveIteratorIterator(new \RecursiveDirectoryIterator($this->dir), \RecursiveIteratorIterator::CHILD_FIRST);
+
+ foreach ($iterator as $path) {
+ if ($path->isDir()) {
+ @rmdir($path);
+ } else {
+ @unlink($path);
+ }
+ }
+
+ @rmdir($this->dir);
+ }
+
+ abstract protected function getFileExtension();
+ abstract protected function getDriver(array $paths = array());
+
+ private function setField($obj, $field, $value)
+ {
+ $ref = new \ReflectionProperty($obj, $field);
+ $ref->setAccessible(true);
+ $ref->setValue($obj, $value);
+ }
+
+ private function invoke($obj, $method, array $args = array()) {
+ $ref = new \ReflectionMethod($obj, $method);
+ $ref->setAccessible(true);
+
+ return $ref->invokeArgs($obj, $args);
+ }
+}
diff --git a/tests/Doctrine/Tests/ORM/Mapping/Symfony/XmlDriverTest.php b/tests/Doctrine/Tests/ORM/Mapping/Symfony/XmlDriverTest.php
new file mode 100644
index 000000000..5908b674a
--- /dev/null
+++ b/tests/Doctrine/Tests/ORM/Mapping/Symfony/XmlDriverTest.php
@@ -0,0 +1,40 @@
+<?php
+/*
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * This software consists of voluntary contributions made by many individuals
+ * and is licensed under the LGPL. For more information, see
+ * <http://www.doctrine-project.org>.
+*/
+
+namespace Doctrine\Tests\ORM\Mapping\Symfony;
+
+use \Doctrine\ORM\Mapping\Driver\SimplifiedXmlDriver;
+
+/**
+ * @group DDC-1418
+ */
+class XmlDriverTest extends AbstractDriverTest
+{
+ protected function getFileExtension()
+ {
+ return '.orm.xml';
+ }
+
+ protected function getDriver(array $paths = array())
+ {
+ $driver = new SimplifiedXmlDriver(array_flip($paths));
+
+ return $driver;
+ }
+}
diff --git a/tests/Doctrine/Tests/ORM/Mapping/Symfony/YamlDriverTest.php b/tests/Doctrine/Tests/ORM/Mapping/Symfony/YamlDriverTest.php
new file mode 100644
index 000000000..c5d8d1cd1
--- /dev/null
+++ b/tests/Doctrine/Tests/ORM/Mapping/Symfony/YamlDriverTest.php
@@ -0,0 +1,40 @@
+<?php
+/*
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * This software consists of voluntary contributions made by many individuals
+ * and is licensed under the LGPL. For more information, see
+ * <http://www.doctrine-project.org>.
+*/
+
+namespace Doctrine\Tests\ORM\Mapping\Symfony;
+
+use \Doctrine\ORM\Mapping\Driver\SimplifiedYamlDriver;
+
+/**
+ * @group DDC-1418
+ */
+class YamlDriverTest extends AbstractDriverTest
+{
+ protected function getFileExtension()
+ {
+ return '.orm.yml';
+ }
+
+ protected function getDriver(array $paths = array())
+ {
+ $driver = new SimplifiedYamlDriver(array_flip($paths));
+
+ return $driver;
+ }
+}