AbstractPathMappingRepository::createFilesystemResource() - Code Metrics - Inspection of "Introduce ChangeStream and ResourceStack for resou..." - puli/repository - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — 1.0 (#58)

by Titouan

created 2015-12-29 15:52 UTC

createFilesystemResource() A

↳ Parent: AbstractPathMappingRepository

Complexity

Conditions	4
Paths	6

Size

Total Lines	21
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	9
CRAP Score	4

Importance

Changes	2
Bugs	1	Features	0

Metric	Value
c	2
b	1
f	0
dl	0
loc	21
ccs	9
cts	9
cp	1
rs	9.0534
cc	4
eloc	12
nc	6
nop	2
crap	4

<?php

/*
 * This file is part of the puli/repository package.
 *
 * (c) Bernhard Schussek <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Puli\Repository;

use Puli\Repository\Api\ChangeStream\ChangeStream;
use Puli\Repository\Api\Resource\FilesystemResource;
use Puli\Repository\Api\Resource\PuliResource;
use Puli\Repository\Api\ResourceCollection;
use Puli\Repository\Api\UnsupportedResourceException;
use Puli\Repository\Resource\DirectoryResource;
use Puli\Repository\Resource\FileResource;
use Puli\Repository\Resource\GenericResource;
use Puli\Repository\Resource\LinkResource;
use RuntimeException;
use Webmozart\KeyValueStore\Api\CountableStore;
use Webmozart\KeyValueStore\Api\KeyValueStore;
use Webmozart\KeyValueStore\Api\SortableStore;
use Webmozart\KeyValueStore\Decorator\CountableDecorator;
use Webmozart\KeyValueStore\Decorator\SortableDecorator;
use Webmozart\PathUtil\Path;

/**
 * Abstract base for Path mapping repositories.
 *
 * @since  1.0
 *
 * @author Bernhard Schussek <[email protected]>
 * @author Titouan Galopin <[email protected]>
 */
abstract class AbstractPathMappingRepository extends AbstractEditableRepository
{
    /**
     * @var KeyValueStore
     */
    protected $store;

    /**
     * @var string
     */
    protected $baseDirectory;

    /**
     * Creates a new repository.
     *
     * @param KeyValueStore     $store         The store of all the paths.
     * @param string            $baseDirectory The base directory of the resources of this repository.
     * @param ChangeStream|null $changeStream  If provided, the repository will log
     *                                         resources changes in this change stream.
     */
    public function __construct(KeyValueStore $store, $baseDirectory, ChangeStream $changeStream = null)
    {
        parent::__construct($changeStream);

        $this->store = $store;
        $this->baseDirectory = $baseDirectory;

        $this->createRoot();
    }

    /**
     * {@inheritdoc}
     */
    public function add($path, $resource)
    {
        $path = $this->sanitizePath($path);

        if ($resource instanceof ResourceCollection) {
            $this->ensureDirectoryExists($path);

            foreach ($resource as $child) {
                $this->addResource($path.'/'.$child->getName(), $child);
            }

            $this->sortStore();

            return;
        }

        $this->ensureDirectoryExists(Path::getDirectory($path));
        $this->addResource($path, $resource);
        $this->sortStore();
    }

    /**
     * Add the resource (internal method after checks of add()).
     *
     * @param string       $path
     * @param PuliResource $resource
     */
    private function addResource($path, $resource)
    {
        if (!($resource instanceof FilesystemResource || $resource instanceof LinkResource)) {
            throw new UnsupportedResourceException(sprintf(
                'PathMapping repositories only supports FilesystemResource and LinkedResource. Got: %s',
                is_object($resource) ? get_class($resource) : gettype($resource)
            ));
        }

        // Don't modify resources attached to other repositories
        if ($resource->isAttached()) {
            $resource = clone $resource;
        }

        if ($resource instanceof LinkResource) {
            $this->addLinkResource($path, $resource);
        } elseif (Path::isBasePath($this->baseDirectory, $resource->getFilesystemPath())) {
            $this->addFilesystemResource($path, $resource);
        } else {
            throw new UnsupportedResourceException(sprintf(
                'Can only add resources from %s. Tried to add %s.',
                $this->baseDirectory,
                $resource->getFilesystemPath()
            ));
        }

        $this->appendToChangeStream($resource);
    }

    /**
     * Add the filesystem resource.
     *
     * @param string             $path
     * @param FilesystemResource $resource
     */
    abstract protected function addFilesystemResource($path, FilesystemResource $resource);

    /**
     * Add the link resource.
     *
     * @param string       $path
     * @param LinkResource $resource
     */
    abstract protected function addLinkResource($path, LinkResource $resource);

    /**
     * {@inheritdoc}
     */
    public function clear()
    {
        // Subtract root
        $removed = $this->countStore() - 1;

        $this->store->clear();
        $this->createRoot();

        return $removed;
    }

    /**
     * Recursively creates a directory for a path.
     *
     * @param string $path A directory path.
     */
    protected function ensureDirectoryExists($path)
    {
        if ($this->store->exists($path)) {
            return;
        }

        // Recursively initialize parent directories
        if ('/' !== $path) {
            $this->ensureDirectoryExists(Path::getDirectory($path));
        }

        $this->store->set($path, null);
    }

    /**
     * Create the repository root.
     */
    protected function createRoot()
    {
        if ($this->store->exists('/')) {
            return;
        }

        $this->store->set('/', null);
    }

    /**
     * Count the number of elements in the store.
     *
     * @return int
     */
    protected function countStore()
    {
        if (!$this->store instanceof CountableStore) {
            $this->store = new CountableDecorator($this->store);
        }

        return $this->store->count();
    }

    /**
     * Sort the store by keys.
     */
    protected function sortStore()
    {
        if (!$this->store instanceof SortableStore) {
            $this->store = new SortableDecorator($this->store);
        }

        $this->store->sort();
    }

    /**
     * Create a filesystem or generic resource.
     *
     * @param string|null $filesystemPath
     *
     * @return DirectoryResource|FileResource|GenericResource
     */
    protected function createResource($filesystemPath, $path = null)
    {
        // Link resource
        if (0 === strpos($filesystemPath, 'l:')) {
            return $this->createLinkResource(substr($filesystemPath, 2), $path);
        }

        // Filesystem resource
        if (is_string($filesystemPath)) {
            $filesystemPath = $this->resolveRelativePath($filesystemPath);

            if (file_exists($filesystemPath)) {
                return $this->createFilesystemResource($filesystemPath, $path);
            }
        }

        return $this->createVirtualResource($path);
    }

    /**
     * Create a link resource to another resource of the repository.
     *
     * @param string      $targetPath The target path.
     * @param string|null $path       The repository path.
     *
     * @return LinkResource The link resource.
     *
     * @throws RuntimeException If the targeted resource does not exist.
     */
    protected function createLinkResource($targetPath, $path = null)
    {
        $resource = new LinkResource($targetPath);
        $resource->attachTo($this, $path);

        return $resource;
    }

    /**
     * Create a resource using its filesystem path.
     *
     * If the filesystem path is a directory, a DirectoryResource will be created.
     * If the filesystem path is a file, a FileResource will be created.
     * If the filesystem does not exists, a GenericResource will be created.
     *
     * @param string      $filesystemPath The filesystem path.
     * @param string|null $path           The repository path.
     *
     * @return DirectoryResource|FileResource The created resource.
     *
     * @throws RuntimeException If the file / directory does not exist.
     */
    protected function createFilesystemResource($filesystemPath, $path = null)
    {
        $resource = null;

        if (is_dir($filesystemPath)) {
            $resource = new DirectoryResource($filesystemPath);
        } elseif (is_file($filesystemPath)) {
            $resource = new FileResource($filesystemPath);
        }

        if ($resource) {
            $resource->attachTo($this, $path);

            return $resource;
        }

        throw new RuntimeException(sprintf(
            'Trying to create a FilesystemResource on a non-existing file or directory "%s"',
            $filesystemPath
        ));
    }

    /**
     * @param string|null $path
     *
     * @return GenericResource
     */
    protected function createVirtualResource($path = null)
    {
        $resource = new GenericResource();
        $resource->attachTo($this, $path);

        return $resource;
    }

    /**
     * Transform a relative path into an absolute path.
     *
     * @param string $relativePath
     *
     * @return string
     */
    protected function resolveRelativePath($relativePath)
    {
        if (0 === strpos($relativePath, 'l:')) {
            // Link
            return $relativePath;
        }

        return Path::makeAbsolute($relativePath, $this->baseDirectory);
    }

    /**
     * Transform a collection of relative paths into a collection of absolute paths.
     *
     * @param string[] $relativePaths
     *
     * @return string[]
     */
    protected function resolveRelativePaths($relativePaths)
    {
        foreach ($relativePaths as $key => $relativePath) {
            $relativePaths[$key] = $this->resolveRelativePath($relativePath);
        }

        return $relativePaths;
    }
}


1			<?php
2
3			/*
4			* This file is part of the puli/repository package.
5			*
6			* (c) Bernhard Schussek <[email protected]>
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace Puli\Repository;
13
14			use Puli\Repository\Api\ChangeStream\ChangeStream;
15			use Puli\Repository\Api\Resource\FilesystemResource;
16			use Puli\Repository\Api\Resource\PuliResource;
17			use Puli\Repository\Api\ResourceCollection;
18			use Puli\Repository\Api\UnsupportedResourceException;
19			use Puli\Repository\Resource\DirectoryResource;
20			use Puli\Repository\Resource\FileResource;
21			use Puli\Repository\Resource\GenericResource;
22			use Puli\Repository\Resource\LinkResource;
23			use RuntimeException;
24			use Webmozart\KeyValueStore\Api\CountableStore;
25			use Webmozart\KeyValueStore\Api\KeyValueStore;
26			use Webmozart\KeyValueStore\Api\SortableStore;
27			use Webmozart\KeyValueStore\Decorator\CountableDecorator;
28			use Webmozart\KeyValueStore\Decorator\SortableDecorator;
29			use Webmozart\PathUtil\Path;
30
31			/**
32			* Abstract base for Path mapping repositories.
33			*
34			* @since 1.0
35			*
36			* @author Bernhard Schussek <[email protected]>
37			* @author Titouan Galopin <[email protected]>
38			*/
39			abstract class AbstractPathMappingRepository extends AbstractEditableRepository
40			{
41			/**
42			* @var KeyValueStore
43			*/
44			protected $store;
45
46			/**
47			* @var string
48			*/
49			protected $baseDirectory;
50
51			/**
52			* Creates a new repository.
53			*
54			* @param KeyValueStore $store The store of all the paths.
55			* @param string $baseDirectory The base directory of the resources of this repository.
56			* @param ChangeStream\|null $changeStream If provided, the repository will log
57			* resources changes in this change stream.
58			*/
59	177		public function __construct(KeyValueStore $store, $baseDirectory, ChangeStream $changeStream = null)
60			{
61	177		parent::__construct($changeStream);
62
63	177		$this->store = $store;
64	177		$this->baseDirectory = $baseDirectory;
65
66	177		$this->createRoot();
67	177		}
68
69			/**
70			* {@inheritdoc}
71			*/
72	150		public function add($path, $resource)
73			{
74	150		$path = $this->sanitizePath($path);
75
76	144	View Code Duplication	if ($resource instanceof ResourceCollection) {
77	2		$this->ensureDirectoryExists($path);
78
79	2		foreach ($resource as $child) {
80	2		$this->addResource($path.'/'.$child->getName(), $child);
81			}
82
83	2		$this->sortStore();
84
85	2		return;
86			}
87
88	142		$this->ensureDirectoryExists(Path::getDirectory($path));
89	142		$this->addResource($path, $resource);
90	138		$this->sortStore();
91	138		}
92
93			/**
94			* Add the resource (internal method after checks of add()).
95			*
96			* @param string $path
97			* @param PuliResource $resource
98			*/
99	144		private function addResource($path, $resource)
100			{
101	144		if (!($resource instanceof FilesystemResource \|\| $resource instanceof LinkResource)) {
102	2		throw new UnsupportedResourceException(sprintf(
103	2		'PathMapping repositories only supports FilesystemResource and LinkedResource. Got: %s',
104	2		is_object($resource) ? get_class($resource) : gettype($resource)
105			));
106			}
107
108			// Don't modify resources attached to other repositories
109	142		if ($resource->isAttached()) {
110	4		$resource = clone $resource;
111			}
112
113	142		if ($resource instanceof LinkResource) {
114	4		$this->addLinkResource($path, $resource);
115	142		} elseif (Path::isBasePath($this->baseDirectory, $resource->getFilesystemPath())) {
116	140		$this->addFilesystemResource($path, $resource);
117			} else {
118	2		throw new UnsupportedResourceException(sprintf(
119	2		'Can only add resources from %s. Tried to add %s.',
120	2		$this->baseDirectory,
121	2		$resource->getFilesystemPath()
122			));
123			}
124
125	140		$this->appendToChangeStream($resource);
126	140		}
127
128			/**
129			* Add the filesystem resource.
130			*
131			* @param string $path
132			* @param FilesystemResource $resource
133			*/
134			abstract protected function addFilesystemResource($path, FilesystemResource $resource);
135
136			/**
137			* Add the link resource.
138			*
139			* @param string $path
140			* @param LinkResource $resource
141			*/
142			abstract protected function addLinkResource($path, LinkResource $resource);
143
144			/**
145			* {@inheritdoc}
146			*/
147	2		public function clear()
148			{
149			// Subtract root
150	2		$removed = $this->countStore() - 1;
151
152	2		$this->store->clear();
153	2		$this->createRoot();
154
155	2		return $removed;
156			}
157
158			/**
159			* Recursively creates a directory for a path.
160			*
161			* @param string $path A directory path.
162			*/
163	144		protected function ensureDirectoryExists($path)
164			{
165	144		if ($this->store->exists($path)) {
166	144		return;
167			}
168
169			// Recursively initialize parent directories
170	44		if ('/' !== $path) {
171	44		$this->ensureDirectoryExists(Path::getDirectory($path));
172			}
173
174	44		$this->store->set($path, null);
175	44		}
176
177			/**
178			* Create the repository root.
179			*/
180	177		protected function createRoot()
181			{
182	177		if ($this->store->exists('/')) {
183	6		return;
184			}
185
186	177		$this->store->set('/', null);
187	177		}
188
189			/**
190			* Count the number of elements in the store.
191			*
192			* @return int
193			*/
194	9		protected function countStore()
195			{
196	9		if (!$this->store instanceof CountableStore) {
197			$this->store = new CountableDecorator($this->store);
198			}
199
200	9		return $this->store->count();
201			}
202
203			/**
204			* Sort the store by keys.
205			*/
206	140		protected function sortStore()
207			{
208	140		if (!$this->store instanceof SortableStore) {
209			$this->store = new SortableDecorator($this->store);
210			}
211
212	140		$this->store->sort();
213	140		}
214
215			/**
216			* Create a filesystem or generic resource.
217			*
218			* @param string\|null $filesystemPath
219			*
220			* @return DirectoryResource\|FileResource\|GenericResource
221			*/
222	90		protected function createResource($filesystemPath, $path = null)
223			{
224			// Link resource
225	90		if (0 === strpos($filesystemPath, 'l:')) {
226	4		return $this->createLinkResource(substr($filesystemPath, 2), $path);
227			}
228
229			// Filesystem resource
230	90		if (is_string($filesystemPath)) {
231	88		$filesystemPath = $this->resolveRelativePath($filesystemPath);
232
233	88		if (file_exists($filesystemPath)) {
234	88		return $this->createFilesystemResource($filesystemPath, $path);
235			}
236			}
237
238	12		return $this->createVirtualResource($path);
239			}
240
241			/**
242			* Create a link resource to another resource of the repository.
243			*
244			* @param string $targetPath The target path.
245			* @param string\|null $path The repository path.
246			*
247			* @return LinkResource The link resource.
248			*
249			* @throws RuntimeException If the targeted resource does not exist.
250			*/
251	4		protected function createLinkResource($targetPath, $path = null)
252			{
253	4		$resource = new LinkResource($targetPath);
254	4		$resource->attachTo($this, $path);
255
256	4		return $resource;
257			}
258
259			/**
260			* Create a resource using its filesystem path.
261			*
262			* If the filesystem path is a directory, a DirectoryResource will be created.
263			* If the filesystem path is a file, a FileResource will be created.
264			* If the filesystem does not exists, a GenericResource will be created.
265			*
266			* @param string $filesystemPath The filesystem path.
267			* @param string\|null $path The repository path.
268			*
269			* @return DirectoryResource\|FileResource The created resource.
270			*
271			* @throws RuntimeException If the file / directory does not exist.
272			*/
273	88		protected function createFilesystemResource($filesystemPath, $path = null)
274			{
275	88		$resource = null;
276
277	88		if (is_dir($filesystemPath)) {
278	51		$resource = new DirectoryResource($filesystemPath);
279	63		} elseif (is_file($filesystemPath)) {
280	63		$resource = new FileResource($filesystemPath);
281			}
282
283	88		if ($resource) {
284	88		$resource->attachTo($this, $path);
285
286	88		return $resource;
287			}
288
289			throw new RuntimeException(sprintf(
290			'Trying to create a FilesystemResource on a non-existing file or directory "%s"',
291			$filesystemPath
292			));
293			}
294
295			/**
296			* @param string\|null $path
297			*
298			* @return GenericResource
299			*/
300	12		protected function createVirtualResource($path = null)
301			{
302	12		$resource = new GenericResource();
303	12		$resource->attachTo($this, $path);
304
305	12		return $resource;
306			}
307
308			/**
309			* Transform a relative path into an absolute path.
310			*
311			* @param string $relativePath
312			*
313			* @return string
314			*/
315	93		protected function resolveRelativePath($relativePath)
316			{
317	93		if (0 === strpos($relativePath, 'l:')) {
318			// Link
319	2		return $relativePath;
320			}
321
322	93		return Path::makeAbsolute($relativePath, $this->baseDirectory);
323			}
324
325			/**
326			* Transform a collection of relative paths into a collection of absolute paths.
327			*
328			* @param string[] $relativePaths
329			*
330			* @return string[]
331			*/
332	58		protected function resolveRelativePaths($relativePaths)
333			{
334	58		foreach ($relativePaths as $key => $relativePath) {
335	58		$relativePaths[$key] = $this->resolveRelativePath($relativePath);
336			}
337
338	58		return $relativePaths;
339			}
340			}
341

puli / repository

Pull Request — 1.0 (#58)

createFilesystemResource() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like