Aliases::getArray() - Code Metrics - Inspection of "Add method `Aliases::getArray()` that bulk transla..." - yiisoft/aliases - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#44)

by Alexander

created 2021-10-06 22:37 UTC

Aliases::getArray() A

↳ Parent: Aliases

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	3
c	1
b	0
f	0
nc	1
nop	1
dl	0
loc	5
ccs	3
cts	3
cp	1
crap	1
rs	10

<?php

declare(strict_types=1);

namespace Yiisoft\Aliases;

use InvalidArgumentException;

final class Aliases
{
    /**
     * @var array
     * @psalm-var array<string, string|array<string, string>>
     */
    private array $aliases = [];

    /**
     * @param array $config
     *
     * @psalm-param array<string, string> $config
     *
     * @throws InvalidArgumentException if $path is an invalid alias.
     *
     * @see set()
     * @see get()
     */
    public function __construct(array $config = [])
    {
        foreach ($config as $alias => $path) {
            $this->set($alias, $path);
        }
    }

    /**
     * Registers a path alias.
     *
     * A path alias is a short name representing a long path (a file path, a URL, etc.)
     *
     * For example, `@vendor` may store path to `vendor` directory.
     *
     * A path alias must start with the character '@' so that it can be easily differentiated
     * from non-alias paths.
     *
     * Note that this method does not check if the given path exists or not. All it does is
     * to associate the alias with the path.
     *
     * Any trailing '/' and '\' characters in the given path will be trimmed.
     *
     * @param string $alias the alias name (e.g. "@vendor"). It must start with a '@' character.
     * It may contain the forward slash '/' which serves as boundary character when performing
     * alias translation by {@see get()}.
     * @param string $path the path corresponding to the alias.
     * Trailing '/' and '\' characters will be trimmed. This can be
     *
     * - a directory or a file path (e.g. `/tmp`, `/tmp/main.txt`)
     * - a URL (e.g. `http://www.yiiframework.com`)
     * - a path alias (e.g. `@vendor/yiisoft`). It will be resolved on {@see get()} call.
     *
     * @see get()
     */
    public function set(string $alias, string $path): void
    {
        if (!$this->isAlias($alias)) {
            $alias = '@' . $alias;
        }
        $pos = strpos($alias, '/');
        /** @psalm-var string $root */
        $root = $pos === false ? $alias : substr($alias, 0, $pos);

        $path = rtrim($path, '\\/');
        if (!array_key_exists($root, $this->aliases)) {
            if ($pos === false) {
                $this->aliases[$root] = $path;
            } else {
                $this->aliases[$root] = [$alias => $path];
            }
        } elseif (\is_string($this->aliases[$root])) {
            if ($pos === false) {
                $this->aliases[$root] = $path;
            } else {
                $this->aliases[$root] = [
                    $alias => $path,
                    $root => $this->aliases[$root],
                ];
            }
        } else {
            $this->aliases[$root][$alias] = $path;
            krsort($this->aliases[$root]);
        }
    }

    /**
     * Remove alias.
     *
     * @param string $alias Alias to be removed.
     */
    public function remove(string $alias): void
    {
        if (!$this->isAlias($alias)) {
            $alias = '@' . $alias;
        }
        $pos = strpos($alias, '/');
        $root = $pos === false ? $alias : substr($alias, 0, $pos);

        if (array_key_exists($root, $this->aliases)) {
            if (\is_array($this->aliases[$root])) {
                unset($this->aliases[$root][$alias]);
            } elseif ($pos === false) {
                unset($this->aliases[$root]);
            }
        }
    }

    /**
     * Translates a path alias into an actual path.
     *
     * The translation is done according to the following procedure:
     *
     * 1. If the given alias does not start with '@', it is returned back without change;
     * 2. Otherwise, look for the longest registered alias that matches the beginning part
     *    of the given alias. If it exists, replace the matching part of the given alias with
     *    the corresponding registered path.
     * 3. Throw an exception if path alias cannot be resolved.
     *
     * For example, if '@vendor' is registered as the alias to the vendor directory,
     * say '/path/to/vendor'. The alias '@vendor/yiisoft' would then be translated into '/path/to/vendor/yiisoft'.
     *
     * If you have registered two aliases '@foo' and '@foo/bar'. Then translating '@foo/bar/config'
     * would replace the part '@foo/bar' (instead of '@foo') with the corresponding registered path.
     * This is because the longest alias takes precedence.
     *
     * However, if the alias to be translated is '@foo/barbar/config', then '@foo' will be replaced
     * instead of '@foo/bar', because '/' serves as the boundary character.
     *
     * Note, this method does not check if the returned path exists or not.
     *
     * @param string $alias the alias to be translated.
     *
     * @throws InvalidArgumentException if the root alias is not previously registered.
     *
     * @return string the path corresponding to the alias.
     *
     * @see setAlias()
     */
    public function get(string $alias): string
    {
        if (!$this->isAlias($alias)) {
            return $alias;
        }

        $foundAlias = $this->findAlias($alias);

        if ($foundAlias === null) {
            throw new InvalidArgumentException("Invalid path alias: $alias");
        }

        $foundSubAlias = $this->findAlias($foundAlias);
        if ($foundSubAlias === null) {
            return $foundAlias;
        }

        return $this->get($foundSubAlias);
    }

    /**
     * Bulk translates path aliases into actual paths.
     *
     * @param string[] $aliases Aliases to be translated.
     *
     * @throws InvalidArgumentException If the root alias was not previously registered.
     *
     * @return string[] The paths corresponding to the aliases.
     */
    public function getArray(array $aliases): array
    {
        return array_map(
            fn (string $alias) => $this->get($alias),
            $aliases,
        );
    }

    private function findAlias(string $alias): ?string
    {
        $pos = strpos($alias, '/');
        $root = $pos === false ? $alias : substr($alias, 0, $pos);

        if (array_key_exists($root, $this->aliases)) {
            if (\is_string($this->aliases[$root])) {
                return $pos === false ? $this->aliases[$root] : $this->aliases[$root] . substr($alias, $pos);
            }

            foreach ($this->aliases[$root] as $name => $path) {
                if (strpos($alias . '/', $name . '/') === 0) {
                    return $path . substr($alias, strlen($name));
                }
            }
        }

        return null;
    }

    /**
     * Returns all path aliases translated into an actual paths.
     *
     * @return array Actual paths indexed by alias name.
     */
    public function getAll(): array
    {
        $result = [];
        foreach ($this->aliases as $name => $path) {
            if (is_array($path)) {
                foreach ($path as $innerName => $innerPath) {
                    $result[$innerName] = $innerPath;
                }
            } else {
                $result[$name] = $this->get($path);
            }
        }

        return $result;
    }

    private function isAlias(string $alias): bool
    {
        return !strncmp($alias, '@', 1);
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Yiisoft\Aliases;
6
7		use InvalidArgumentException;
8
9		final class Aliases
10		{
11		/**
12		* @var array
13		* @psalm-var array<string, string\|array<string, string>>
14		*/
15		private array $aliases = [];
16
17		/**
18		* @param array $config
19		*
20		* @psalm-param array<string, string> $config
21		*
22		* @throws InvalidArgumentException if $path is an invalid alias.
23		*
24		* @see set()
25		* @see get()
26		*/
27	15	public function __construct(array $config = [])
28		{
29	15	foreach ($config as $alias => $path) {
30	10	$this->set($alias, $path);
31		}
32	15	}
33
34		/**
35		* Registers a path alias.
36		*
37		* A path alias is a short name representing a long path (a file path, a URL, etc.)
38		*
39		* For example, `@vendor` may store path to `vendor` directory.
40		*
41		* A path alias must start with the character '@' so that it can be easily differentiated
42		* from non-alias paths.
43		*
44		* Note that this method does not check if the given path exists or not. All it does is
45		* to associate the alias with the path.
46		*
47		* Any trailing '/' and '\' characters in the given path will be trimmed.
48		*
49		* @param string $alias the alias name (e.g. "@vendor"). It must start with a '@' character.
50		* It may contain the forward slash '/' which serves as boundary character when performing
51		* alias translation by {@see get()}.
52		* @param string $path the path corresponding to the alias.
53		* Trailing '/' and '\' characters will be trimmed. This can be
54		*
55		* - a directory or a file path (e.g. `/tmp`, `/tmp/main.txt`)
56		* - a URL (e.g. `http://www.yiiframework.com`)
57		* - a path alias (e.g. `@vendor/yiisoft`). It will be resolved on {@see get()} call.
58		*
59		* @see get()
60		*/
61	13	public function set(string $alias, string $path): void
62		{
63	13	if (!$this->isAlias($alias)) {
64		$alias = '@' . $alias;
65		}
66	13	$pos = strpos($alias, '/');
67		/** @psalm-var string $root */
68	13	$root = $pos === false ? $alias : substr($alias, 0, $pos);
69
70	13	$path = rtrim($path, '\\/');
71	13	if (!array_key_exists($root, $this->aliases)) {
72	13	if ($pos === false) {
73	12	$this->aliases[$root] = $path;
74		} else {
75	13	$this->aliases[$root] = [$alias => $path];
76		}
77	4	} elseif (\is_string($this->aliases[$root])) {
78	4	if ($pos === false) {
79	1	$this->aliases[$root] = $path;
80		} else {
81	3	$this->aliases[$root] = [
82	3	$alias => $path,
83	4	$root => $this->aliases[$root],
84		];
85		}
86		} else {
87	2	$this->aliases[$root][$alias] = $path;
88	2	krsort($this->aliases[$root]);
89		}
90	13	}
91
92		/**
93		* Remove alias.
94		*
95		* @param string $alias Alias to be removed.
96		*/
97	2	public function remove(string $alias): void
98		{
99	2	if (!$this->isAlias($alias)) {
100	1	$alias = '@' . $alias;
101		}
102	2	$pos = strpos($alias, '/');
103	2	$root = $pos === false ? $alias : substr($alias, 0, $pos);
104
105	2	if (array_key_exists($root, $this->aliases)) {
106	2	if (\is_array($this->aliases[$root])) {
107	1	unset($this->aliases[$root][$alias]);
108	1	} elseif ($pos === false) {
109	1	unset($this->aliases[$root]);
110		}
111		}
112	2	}
113
114		/**
115		* Translates a path alias into an actual path.
116		*
117		* The translation is done according to the following procedure:
118		*
119		* 1. If the given alias does not start with '@', it is returned back without change;
120		* 2. Otherwise, look for the longest registered alias that matches the beginning part
121		* of the given alias. If it exists, replace the matching part of the given alias with
122		* the corresponding registered path.
123		* 3. Throw an exception if path alias cannot be resolved.
124		*
125		* For example, if '@vendor' is registered as the alias to the vendor directory,
126		* say '/path/to/vendor'. The alias '@vendor/yiisoft' would then be translated into '/path/to/vendor/yiisoft'.
127		*
128		* If you have registered two aliases '@foo' and '@foo/bar'. Then translating '@foo/bar/config'
129		* would replace the part '@foo/bar' (instead of '@foo') with the corresponding registered path.
130		* This is because the longest alias takes precedence.
131		*
132		* However, if the alias to be translated is '@foo/barbar/config', then '@foo' will be replaced
133		* instead of '@foo/bar', because '/' serves as the boundary character.
134		*
135		* Note, this method does not check if the returned path exists or not.
136		*
137		* @param string $alias the alias to be translated.
138		*
139		* @throws InvalidArgumentException if the root alias is not previously registered.
140		*
141		* @return string the path corresponding to the alias.
142		*
143		* @see setAlias()
144		*/
145	14	public function get(string $alias): string
146		{
147	14	if (!$this->isAlias($alias)) {
148	5	return $alias;
149		}
150
151	13	$foundAlias = $this->findAlias($alias);
152
153	13	if ($foundAlias === null) {
154	2	throw new InvalidArgumentException("Invalid path alias: $alias");
155		}
156
157	11	$foundSubAlias = $this->findAlias($foundAlias);
158	11	if ($foundSubAlias === null) {
159	10	return $foundAlias;
160		}
161
162	3	return $this->get($foundSubAlias);
163		}
164
165		/**
166		* Bulk translates path aliases into actual paths.
167		*
168		* @param string[] $aliases Aliases to be translated.
169		*
170		* @throws InvalidArgumentException If the root alias was not previously registered.
171		*
172		* @return string[] The paths corresponding to the aliases.
173		*/
174	2	public function getArray(array $aliases): array
175		{
176	2	return array_map(
177	2	fn (string $alias) => $this->get($alias),
178		$aliases,
179		);
180		}
181
182	13	private function findAlias(string $alias): ?string
183		{
184	13	$pos = strpos($alias, '/');
185	13	$root = $pos === false ? $alias : substr($alias, 0, $pos);
186
187	13	if (array_key_exists($root, $this->aliases)) {
188	11	if (\is_string($this->aliases[$root])) {
189	8	return $pos === false ? $this->aliases[$root] : $this->aliases[$root] . substr($alias, $pos);
190		}
191
192	3	foreach ($this->aliases[$root] as $name => $path) {
193	3	if (strpos($alias . '/', $name . '/') === 0) {
194	3	return $path . substr($alias, strlen($name));
195		}
196		}
197		}
198
199	12	return null;
200		}
201
202		/**
203		* Returns all path aliases translated into an actual paths.
204		*
205		* @return array Actual paths indexed by alias name.
206		*/
207	1	public function getAll(): array
208		{
209	1	$result = [];
210	1	foreach ($this->aliases as $name => $path) {
211	1	if (is_array($path)) {
212	1	foreach ($path as $innerName => $innerPath) {
213	1	$result[$innerName] = $innerPath;
214		}
215		} else {
216	1	$result[$name] = $this->get($path);
217		}
218		}
219
220	1	return $result;
221		}
222
223	15	private function isAlias(string $alias): bool
224		{
225	15	return !strncmp($alias, '@', 1);
226		}
227		}
228

yiisoft / aliases

Pull Request — master (#44)

Aliases::getArray() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like