Merge pull request #43 from symfony-cmf/content_method-fixes

Improved and fixed ContentMethod::normalizePathElements

Author: wouterj

AutoRoute/PathProvider/ContentDateTimeProvider.php

@@ -54,17 +54,17 @@ public function providePath(RouteStack $routeStack)
             throw new \RuntimeException(sprintf('Method %s:%s must return an instance of DateTime.'));
         }
 
-        $dateString = $date->format($this->dateFormat);
-        $pathElements = $this->normalizePathElements($dateString);
+        $string = $date->format($this->dateFormat);
+        $pathElements = $this->normalizePathElements($string, $object);
 
         $routeStack->addPathElements($pathElements);
     }
 
     /**
      * {@inheritDoc}
      */
-    public function normalizePathElements($elements)
+    public function normalizePathElements($elements, $object)
     {
-        return parent::normalizePathElements(explode('/', $elements));
+        return parent::normalizePathElements(explode('/', $elements), $object);
     }
 }

AutoRoute/PathProvider/ContentMethodProvider.php

@@ -68,17 +68,30 @@ public function providePath(RouteStack $routeStack)
         }
 
         $pathElements = $object->$method();
-
-        $pathElements = $this->normalizePathElements($pathElements);
+        $pathElements = $this->normalizePathElements($pathElements, $object);
 
 
         // @todo: Validate the validator service.
         $routeStack->addPathElements($pathElements);
     }
 
-    protected function normalizePathElements($pathElements)
+    /**
+     * Normalize the given $pathElements variable to an array of path elements,
+     * accepting either an array or a string.
+     *
+     * A string will be converted to an array of elements delimiteed by the
+     * path separator.
+     *
+     * If slugify is enabled, each path element will be slugified.
+     *
+     * @param mixed  $pathElements  Either an array or a string
+     * @param object $object        Used in the case of an exception
+     *
+     * @return array
+     */
+    protected function normalizePathElements($pathElements, $object)
     {
-        if (is_string($pathElements)) {
+        if (is_string($pathElements) || (is_object($pathElements) && method_exists($pathElements, '__toString'))) {
             if (substr($pathElements, 0, 1) == '/') {
                 throw new \RuntimeException('Path must not be absolute.');
             }
@@ -88,9 +101,9 @@ protected function normalizePathElements($pathElements)
 
         if (!is_array($pathElements)) {
             throw new \RuntimeException(sprintf(
-                'FromObjectMethodProvider wants %s:%s to return an array of route names.. got "%s"',
+                'FromObjectMethodProvider wants %s::%s to return an array of route names or a string, got "%s"',
                 get_class($object),
-                $method,
+                $this->method,
                 gettype($pathElements)
             ));
         }

Tests/Unit/AutoRoute/PathProvider/ContentMethodProviderTest.php

@@ -115,6 +115,25 @@ public function testProvideMethodWithAbsolute()
         $this->provider->init(array('method' => 'getAbsoluteSlug'));
         $this->provider->providePath($this->routeStack);
     }
+
+    public function testProvideMethodObjectToString()
+    {
+        $this->setupTest();
+
+        $this->provider->init(array('method' => 'getStringObjectSlug'));
+        $this->provider->providePath($this->routeStack);
+    }
+
+    /**
+     * @expectedException \RunTimeException
+     */
+    public function testProvideMethodWrongType()
+    {
+        $this->setupTest();
+
+        $this->provider->init(array('method' => 'getWrongTypeSlug'));
+        $this->provider->providePath($this->routeStack);
+    }
 }
 
 class ContentMethodTestClass
@@ -134,4 +153,22 @@ public function getAbsoluteSlug()
         return '/this/is/absolute';
     }
 
+    public function getStringObjectSlug()
+    {
+        return new StringObject();
+    }
+
+    public function getWrongTypeSlug()
+    {
+        return new \StdClass();
+    }
+
+}
+
+class StringObject
+{
+    public function __toString()
+    {
+        return 'this/is/from/an/object';
+    }
 }