Merge pull request #1779 from mkosiedowski/loggable-yaml-embedded

Loggable YAML support for embeddables

Author: l3pp4rd

lib/Gedmo/Loggable/Mapping/Driver/Yaml.php

@@ -100,6 +100,21 @@ public function readExtendedMetadata($meta, array &$config)
             }
         }
 
+        if (isset($mapping['embedded'])) {
+            foreach ($mapping['embedded'] as $field => $fieldMapping) {
+                if (isset($fieldMapping['gedmo'])) {
+                    if (in_array('versioned', $fieldMapping['gedmo'])) {
+                        if ($meta->isCollectionValuedAssociation($field)) {
+                            throw new InvalidMappingException("Cannot versioned [{$field}] as it is collection in object - {$meta->name}");
+                        }
+                        // fields cannot be overrided and throws mapping exception
+                        $mapping = $this->_getMapping($fieldMapping['class']);
+                        $this->inspectEmbeddedForVersioned($field, $mapping, $config);
+                    }
+                }
+            }
+        }
+
         if (!$meta->isMappedSuperclass && $config) {
             if (is_array($meta->identifier) && count($meta->identifier) > 1) {
                 throw new InvalidMappingException("Loggable does not support composite identifiers in class - {$meta->name}");
@@ -117,4 +132,18 @@ protected function _loadMappingFile($file)
     {
         return \Symfony\Component\Yaml\Yaml::parse(file_get_contents($file));
     }
+
+    /**
+     * @param string $field
+     * @param array $mapping
+     * @param array $config
+     */
+    private function inspectEmbeddedForVersioned($field, array $mapping, array &$config)
+    {
+        if (isset($mapping['fields'])) {
+            foreach ($mapping['fields'] as $property => $fieldMapping) {
+                $config['versioned'][] = $field . '.' . $property;
+            }
+        }
+    }
 }

tests/Gedmo/Mapping/Driver/Yaml/Mapping.Fixture.Yaml.Embedded.dcm.yml

@@ -0,0 +1,6 @@
+---
+Mapping\Fixture\Yaml\Embedded:
+  type: embeddable
+  fields:
+    subtitle:
+      type: string

tests/Gedmo/Mapping/Driver/Yaml/Mapping.Fixture.Yaml.LoggableWithEmbedded.dcm.yml

@@ -0,0 +1,22 @@
+---
+Mapping\Fixture\Yaml\LoggableWithEmbedded:
+  type: entity
+  table: loggable_with_embedded
+  gedmo:
+    loggable:
+      logEntryClass: Gedmo\Loggable\Entity\LogEntry
+  id:
+    id:
+      type: integer
+      generator:
+        strategy: AUTO
+  fields:
+    title:
+      type: string
+      gedmo:
+        - versioned
+  embedded:
+    embedded:
+      class: Mapping\Fixture\Yaml\Embedded
+      gedmo:
+        - versioned

tests/Gedmo/Mapping/Fixture/Yaml/Embedded.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Mapping\Fixture\Yaml;
+
+/**
+ * Class Embedded
+ * @package Mapping\Fixture\Yaml
+ * @author Fabian Sabau <[email protected]>
+ */
+class Embedded
+{
+    private $subtitle;
+}

tests/Gedmo/Mapping/Fixture/Yaml/LoggableWithEmbedded.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace Mapping\Fixture\Yaml;
+
+class LoggableWithEmbedded
+{
+    private $id;
+
+    private $title;
+
+    private $embedded;
+}

tests/Gedmo/Mapping/Yaml/LoggableMappingTest.php

@@ -0,0 +1,71 @@
+<?php
+
+namespace Gedmo\Mapping\Yaml;
+
+use Doctrine\Common\EventManager;
+use Doctrine\Common\Annotations\AnnotationReader;
+use Doctrine\ORM\Mapping\Driver\DriverChain;
+use Doctrine\ORM\Mapping\Driver\YamlDriver;
+use Doctrine\ORM\Mapping\Driver\AnnotationDriver;
+use Gedmo\Loggable\LoggableListener;
+use Tool\BaseTestCaseOM;
+
+/**
+ * These are mapping extension tests
+ *
+ * @author Gediminas Morkevicius <[email protected]>
+ * @link http://www.gediminasm.org
+ * @license MIT License (http://www.opensource.org/licenses/mit-license.php)
+ */
+class LoggableMappingTest extends BaseTestCaseOM
+{
+    /**
+     * @var Doctrine\ORM\EntityManager
+     */
+    private $em;
+
+    /**
+     * @var Gedmo\Loggable\LoggableListener
+     */
+    private $loggable;
+
+    public function setUp()
+    {
+        parent::setUp();
+
+        $reader = new AnnotationReader();
+        $annotationDriver = new AnnotationDriver($reader);
+
+        $yamlDriver = new YamlDriver(__DIR__.'/../Driver/Yaml');
+
+        $chain = new DriverChain();
+        $chain->addDriver($annotationDriver, 'Gedmo\Loggable');
+        $chain->addDriver($yamlDriver, 'Mapping\Fixture\Yaml');
+
+        $this->loggable = new LoggableListener();
+        $this->evm = new EventManager();
+        $this->evm->addEventSubscriber($this->loggable);
+
+        $this->em = $this->getMockSqliteEntityManager(array(
+            'Gedmo\Loggable\Entity\LogEntry',
+            'Mapping\Fixture\Yaml\LoggableWithEmbedded',
+            'Mapping\Fixture\Yaml\Embedded',
+        ), $chain);
+    }
+
+    public function testLoggableMetadataWithEmbedded()
+    {
+        $meta = $this->em->getClassMetadata('Mapping\Fixture\Yaml\LoggableWithEmbedded');
+        $config = $this->loggable->getConfiguration($this->em, $meta->name);
+
+        $this->assertArrayHasKey('logEntryClass', $config);
+        $this->assertEquals('Gedmo\Loggable\Entity\LogEntry', $config['logEntryClass']);
+        $this->assertArrayHasKey('loggable', $config);
+        $this->assertTrue($config['loggable']);
+
+        $this->assertArrayHasKey('versioned', $config);
+        $this->assertCount(2, $config['versioned']);
+        $this->assertContains('title', $config['versioned']);
+        $this->assertContains('embedded.subtitle', $config['versioned']);
+    }
+}