[WIP] Support for move and remove

.travis.yml

@@ -1,7 +1,6 @@
 language: php
 
 php:
-  - 5.4
   - 5.5
   - 5.6
   - 7.0
@@ -12,7 +11,7 @@ sudo: false
 cache:
   directories:
     - $HOME/.composer/cache/files
-    
+
 matrix:
   fast_finish: true
 

Repository/AbstractPhpcrRepository.php

@@ -11,20 +11,21 @@
 
 namespace Symfony\Cmf\Component\Resource\Repository;
 
-use Puli\Repository\Api\ChangeStream\VersionList;
-use Puli\Repository\Api\NoVersionFoundException;
-use Puli\Repository\Api\ResourceNotFoundException;
+use DTL\Glob\FinderInterface;
 use Puli\Repository\Api\ResourceRepository;
+use Puli\Repository\Api\UnsupportedLanguageException;
+use Puli\Repository\Resource\Collection\ArrayResourceCollection;
 use Webmozart\PathUtil\Path;
-use Webmozart\Assert\Assert;
-use DTL\Glob\FinderInterface;
+use Puli\Repository\AbstractRepository;
+use Symfony\Cmf\Component\Resource\Repository\Api\EditableRepository;
+use DTL\Glob\GlobHelper;
 
 /**
  * Abstract repository for both PHPCR and PHPCR-ODM repositories.
  *
  * @author Daniel Leech <[email protected]>
  */
-abstract class AbstractPhpcrRepository implements ResourceRepository
+abstract class AbstractPhpcrRepository extends AbstractRepository implements ResourceRepository, EditableRepository
 {
     /**
      * Base path from which to serve nodes / nodes.
@@ -38,13 +39,19 @@ abstract class AbstractPhpcrRepository implements ResourceRepository
      */
     private $finder;
 
+    /**
+     * @var GlobHelper
+     */
+    private $globHelper;
+
     /**
      * @param string $basePath
      */
     public function __construct(FinderInterface $finder, $basePath = null)
     {
         $this->finder = $finder;
         $this->basePath = $basePath;
+        $this->globHelper = new GlobHelper();
     }
 
     /**
@@ -71,6 +78,74 @@ public function find($query, $language = 'glob')
         return $this->buildCollection($nodes);
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function remove($query, $language = 'glob')
+    {
+        $this->failUnlessGlob($language);
+        $nodes = $this->finder->find($this->resolvePath($query));
+
+        if (0 === count($nodes)) {
+            return 0;
+        }
+
+        try {
+            // delegate remove nodes to the implementation
+            $this->removeNodes($nodes);
+        } catch (\Exception $e) {
+            throw new \RuntimeException(sprintf(
+                'Error encountered when removing resource(s) using query "%s"',
+                $query
+            ), null, $e);
+        }
+
+        return count($nodes);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function move($query, $targetPath, $language = 'glob')
+    {
+        $this->failUnlessGlob($language);
+        $nodes = $this->finder->find($this->resolvePath($query));
+
+        if (0 === count($nodes)) {
+            return 0;
+        }
+
+        $targetPath = $this->resolvePath($targetPath);
+
+        try {
+            // delegate moving to the implementation
+            $this->moveNodes($nodes, $query, $targetPath);
+        } catch (\Exception $e) {
+            throw new \RuntimeException(sprintf(
+                'Error encountered when moving resource(s) using query "%s"',
+                $query
+            ), null, $e);
+        }
+
+        return count($nodes);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function clear()
+    {
+        throw new \BadMethodCallException('Clear not supported');
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function add($path, $resource)
+    {
+        throw new \BadMethodCallException('Add not supported');
+    }
+
     /**
      * Return the path with the basePath prefix
      * if it has been set.
@@ -81,8 +156,7 @@ public function find($query, $language = 'glob')
      */
     protected function resolvePath($path)
     {
-        Assert::stringNotEmpty($path, 'The path must be a non-empty string. Got: %s');
-        Assert::startsWith($path, '/', 'The path %s is not absolute.');
+        $path = $this->sanitizePath($path);
 
         if ($this->basePath) {
             $path = $this->basePath.$path;
@@ -107,6 +181,11 @@ protected function unresolvePath($path)
         return $path;
     }
 
+    protected function isGlobbed($string)
+    {
+        return $this->globHelper->isGlobbed($string);
+    }
+
     /**
      * Build a collection of PHPCR resources.
      *
@@ -115,14 +194,16 @@ protected function unresolvePath($path)
     abstract protected function buildCollection(array $nodes);
 
     /**
-     * {@inheritdoc}
+     * Rmeove the given nodes.
+     *
+     * @param NodeInterface[]
      */
-    public function getVersions($path)
-    {
-        try {
-            return new VersionList($path, [$this->get($path)]);
-        } catch (ResourceNotFoundException $e) {
-            throw NoVersionFoundException::forPath($path, $e);
-        }
-    }
+    abstract protected function removeNodes(array $nodes);
+
+    /**
+     * Move the given nodes.
+     *
+     * @param NodeInterface[]
+     */
+    abstract protected function moveNodes(array $nodes, $query, $targetPath);
 }

Repository/Api/EditableRepository.php

@@ -0,0 +1,42 @@
+<?php
+
+/*
+ * This file is part of the Symfony CMF package.
+ *
+ * (c) 2011-2015 Symfony CMF
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Cmf\Component\Resource\Repository\Api;
+
+use InvalidArgumentException;
+use Puli\Repository\Api\EditableRepository as PuliEditableRepository;
+use Puli\Repository\Api\UnsupportedLanguageException;
+
+/**
+ * Extends the Puli editable repository to implement the as-of-yet not
+ * implemented features.
+ *
+ * @author Maximilian Berghoff <[email protected]>
+ */
+interface EditableRepository extends PuliEditableRepository
+{
+    /**
+     * Move all resources and their subgraphs found by $sourceQuery to the
+     * target (parent) path and returns the number of nodes that have been
+     * *explicitly* moved (i.e. the number of resources found by the query, NOT
+     * the total number of nodes affected).
+     *
+     * @param string $sourceQuery
+     * @param string $targetPath
+     * @param string $language
+     *
+     * @return int
+     *
+     * @throws InvalidArgumentException     If the sourceQuery is invalid.
+     * @throws UnsupportedLanguageException If the language is not supported.
+     */
+    public function move($sourceQuery, $targetPath, $language = 'glob');
+}

Repository/PhpcrOdmRepository.php

@@ -12,11 +12,12 @@
 namespace Symfony\Cmf\Component\Resource\Repository;
 
 use Doctrine\Common\Persistence\ManagerRegistry;
+use Doctrine\ODM\PHPCR\DocumentManagerInterface;
 use DTL\Glob\Finder\PhpcrOdmTraversalFinder;
 use DTL\Glob\FinderInterface;
-use Symfony\Cmf\Component\Resource\Repository\Resource\PhpcrOdmResource;
-use Puli\Repository\Resource\Collection\ArrayResourceCollection;
 use Puli\Repository\Api\ResourceNotFoundException;
+use Puli\Repository\Resource\Collection\ArrayResourceCollection;
+use Symfony\Cmf\Component\Resource\Repository\Resource\PhpcrOdmResource;
 
 class PhpcrOdmRepository extends AbstractPhpcrRepository
 {
@@ -32,6 +33,9 @@ public function __construct(ManagerRegistry $managerRegistry, $basePath = null,
         $this->managerRegistry = $managerRegistry;
     }
 
+    /**
+     * @return DocumentManagerInterface
+     */
     protected function getManager()
     {
         return $this->managerRegistry->getManager();
@@ -82,7 +86,7 @@ public function contains($selector, $language = 'glob')
      */
     public function findByTag($tag)
     {
-        throw new \Exception('Get by tag not currently supported');
+        throw new \Exception('Find by tag not supported');
     }
 
     /**
@@ -116,4 +120,37 @@ protected function buildCollection(array $documents)
 
         return $collection;
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function removeNodes(array $documents)
+    {
+        foreach ($documents as $document) {
+            $this->getManager()->remove($document);
+        }
+
+        $this->getManager()->flush();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function moveNodes(array $documents, $sourceQuery, $targetPath)
+    {
+        $this->doMoveNodes($documents, $sourceQuery, $targetPath);
+        $this->getManager()->flush();
+    }
+
+    private function doMoveNodes(array $documents, $sourceQuery, $targetPath)
+    {
+        if (false === $this->isGlobbed($sourceQuery)) {
+            return $this->getManager()->move(current($documents), $targetPath);
+        }
+
+        foreach ($documents as $document) {
+            $node = $this->getManager()->getNodeForDocument($document);
+            $this->getManager()->move($document, $targetPath.'/'.$node->getName());
+        }
+    }
 }

Repository/PhpcrRepository.php

@@ -11,12 +11,12 @@
 
 namespace Symfony\Cmf\Component\Resource\Repository;
 
-use PHPCR\SessionInterface;
 use DTL\Glob\Finder\PhpcrTraversalFinder;
 use DTL\Glob\FinderInterface;
-use Symfony\Cmf\Component\Resource\Repository\Resource\PhpcrResource;
-use Puli\Repository\Resource\Collection\ArrayResourceCollection;
+use PHPCR\SessionInterface;
 use Puli\Repository\Api\ResourceNotFoundException;
+use Puli\Repository\Resource\Collection\ArrayResourceCollection;
+use Symfony\Cmf\Component\Resource\Repository\Resource\PhpcrResource;
 
 /**
  * Resource repository for PHPCR.
@@ -26,14 +26,14 @@
 class PhpcrRepository extends AbstractPhpcrRepository
 {
     /**
-     * @var ManagerRegistry
+     * @var SessionInterface
      */
     private $session;
 
     /**
      * @param SessionInterface $session
-     * @param FinderInterface  $finder
      * @param string           $basePath
+     * @param FinderInterface  $finder
      */
     public function __construct(SessionInterface $session, $basePath = null, FinderInterface $finder = null)
     {
@@ -68,6 +68,9 @@ public function get($path)
         return $resource;
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function listChildren($path)
     {
         $resource = $this->get($path);
@@ -119,4 +122,36 @@ protected function buildCollection(array $nodes)
 
         return $collection;
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function removeNodes(array $nodes)
+    {
+        foreach ($nodes as $node) {
+            $node->remove();
+        }
+
+        $this->session->save();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function moveNodes(array $nodes, $sourceQuery, $targetPath)
+    {
+        $this->doMoveNodes($nodes, $sourceQuery, $targetPath);
+        $this->session->save();
+    }
+
+    private function doMoveNodes(array $nodes, $sourceQuery, $targetPath)
+    {
+        if (false === $this->isGlobbed($sourceQuery)) {
+            return $this->session->move(current($nodes)->getPath(), $targetPath);
+        }
+
+        foreach ($nodes as $node) {
+            $this->session->move($node->getPath(), $targetPath.'/'.$node->getName());
+        }
+    }
 }