fxpio / composer-asset-plugin / 378

pending completion

Build # 378

Build Type

Pull #158

travis-ci

Committed by

nadar

Commit Message

<a href="https://github.com/fxpio/composer-asset-plugin/commit/<a class=hub.com/fxpio/composer-asset-plugin/commit/140a0183c912d9edff0d295d28d429721f235aac">140a0183c<a href="https://github.com/fxpio/composer-asset-plugin/commit/140a0183c912d9edff0d295d28d429721f235aac">&quot;&gt;fixed deprecated MultiConstraint class in VcsPackageFilter #157

removed composer test for version
</a><a class="double-link" href="https://github.com/fxpio/composer-asset-plugin/commit/<a class="double-link" href="https://github.com/fxpio/composer-asset-plugin/commit/42bfe9c56adb555cc08e9ce2d32f6763ff75ae5d">42bfe9c56</a>">42bfe9c56</a><a href="https://github.com/fxpio/composer-asset-plugin/commit/140a0183c912d9edff0d295d28d429721f235aac"> in travis file, removed bc
tests for above described composer version in phpunit tests.

Pull Request Pull Request #158: fixed deprecated MultiConstraint class in VcsPackageFilter #157

Run Details

1600 of 1602 relevant lines covered (99.88%)

97.7 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

97.4

/Repository/VcsPackageFilter.php

<?php

/*
 * This file is part of the Fxp Composer Asset Plugin package.
 *
 * (c) François Pluchino <francois.pluchino@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Fxp\Composer\AssetPlugin\Repository;

use Composer\Installer\InstallationManager;
use Composer\Package\Link;
use Composer\Package\Package;
use Composer\Package\PackageInterface;
use Composer\Package\RootPackageInterface;
use Composer\Package\Loader\ArrayLoader;
use Composer\Package\LinkConstraint\MultiConstraint as LinkMultiConstraint;
use Composer\Semver\Constraint\MultiConstraint;
use Composer\Repository\InstalledFilesystemRepository;
use Fxp\Composer\AssetPlugin\Package\Version\VersionParser;
use Fxp\Composer\AssetPlugin\Type\AssetTypeInterface;

/**
 * Filters the asset packages imported into VCS repository to optimize
 * performance when getting the informations of packages.
 *
 * @author François Pluchino <francois.pluchino@gmail.com>
 */
class VcsPackageFilter
{
    /**
     * @var RootPackageInterface
     */
    protected $package;

    /**
     * @var InstallationManager
     */
    protected $installationManager;

    /**
     * @var InstalledFilesystemRepository
     */
    protected $installedRepository;

    /**
     * @var VersionParser
     */
    protected $versionParser;

    /**
     * @var ArrayLoader
     */
    protected $arrayLoader;

    /**
     * @var bool
     */
    protected $enabled;

    /**
     * @var array
     */
    protected $requires;

    /**
     * Constructor.
     *
     * @param RootPackageInterface               $package             The root package
     * @param InstallationManager                $installationManager The installation manager
     * @param InstalledFilesystemRepository|null $installedRepository The installed repository
     */
    public function __construct(RootPackageInterface $package, InstallationManager $installationManager, InstalledFilesystemRepository $installedRepository = null)
    {
        $this->package = $package;
        $this->installationManager = $installationManager;
        $this->installedRepository = $installedRepository;
        $this->versionParser = new VersionParser();
        $this->arrayLoader = new ArrayLoader();
        $this->enabled = true;

        $this->initialize();
    }

    /**
     * @param bool $enabled
     *
     * @return self
     */
    public function setEnabled($enabled)
    {
        $this->enabled = (bool) $enabled;

        return $this;
    }

    /**
     * Check if the filter is enabled.
     *
     * @return bool
     */
    public function isEnabled()
    {
        return $this->enabled;
    }

    /**
     * Check if the version must be skipped.
     *
     * @param AssetTypeInterface $assetType The asset type
     * @param string             $name      The composer package name
     * @param string             $version   The version
     *
     * @return bool
     */
    public function skip(AssetTypeInterface $assetType, $name, $version)
    {
        try {
            $cVersion = $assetType->getVersionConverter()->convertVersion($version);
            $normalizedVersion = $this->versionParser->normalize($cVersion);
        } catch (\Exception $ex) {
            return true;
        }

        if (false !== $this->skipByPattern() && $this->forceSkipVersion($normalizedVersion)) {
            return true;
        }

        return $this->doSkip($name, $normalizedVersion);
    }

    /**
     * Do check if the version must be skipped.
     *
     * @param string $name              The composer package name
     * @param string $normalizedVersion The normalized version
     *
     * @return bool
     */
    protected function doSkip($name, $normalizedVersion)
    {
        if (!isset($this->requires[$name])) {
            return false;
        }

        /* @var Link $require */
        $require = $this->requires[$name];

        return !$this->satisfy($require, $normalizedVersion) && $this->isEnabled();
    }

    /**
     * Check if the require dependency has a satisfactory version and stability.
     *
     * @param Link   $require           The require link defined in root package
     * @param string $normalizedVersion The normalized version
     *
     * @return bool
     */
    protected function satisfy(Link $require, $normalizedVersion)
    {
        return $this->satisfyVersion($require, $normalizedVersion)
            && $this->satisfyStability($require, $normalizedVersion);
    }

    /**
     * Check if the filter must be skipped the version by pattern or not.
     *
     * @return string|false Return the pattern or FALSE for disable the feature
     */
    protected function skipByPattern()
    {
        $extra = $this->package->getExtra();

        if (!array_key_exists('asset-pattern-skip-version', $extra)) {
            $extra['asset-pattern-skip-version'] = '(-patch)';
        }

        if (is_string($extra['asset-pattern-skip-version'])) {
            return trim($extra['asset-pattern-skip-version'], '/');
        }

        return false;
    }

    /**
     * Check if the require package version must be skipped or not.
     *
     * @param string $normalizedVersion The normalized version
     *
     * @return bool
     */
    protected function forceSkipVersion($normalizedVersion)
    {
        return (bool) preg_match('/'.$this->skipByPattern().'/', $normalizedVersion);
    }

    /**
     * Check if the require dependency has a satisfactory version.
     *
     * @param Link   $require           The require link defined in root package
     * @param string $normalizedVersion The normalized version
     *
     * @return bool
     */
    protected function satisfyVersion(Link $require, $normalizedVersion)
    {
        $constraintSame = $this->versionParser->parseConstraints($normalizedVersion);
        $sameVersion = (bool) $require->getConstraint()->matches($constraintSame);

        $normalizedVersion = FilterUtil::getVersionConstraint($normalizedVersion, $this->versionParser);
        $constraint = FilterUtil::getVersionConstraint($normalizedVersion, $this->versionParser);

        return (bool) $require->getConstraint()->matches($constraint) || $sameVersion;
    }

    /**
     * Check if the require dependency has a satisfactory stability.
     *
     * @param Link   $require           The require link defined in root package
     * @param string $normalizedVersion The normalized version
     *
     * @return bool
     */
    protected function satisfyStability(Link $require, $normalizedVersion)
    {
        $requireStability = $this->getRequireStability($require);
        $stability = $this->versionParser->parseStability($normalizedVersion);

        return Package::$stabilities[$stability] <= Package::$stabilities[$requireStability];
    }

    /**
     * Get the minimum stability for the require dependency defined in root package.
     *
     * @param Link $require The require link defined in root package
     *
     * @return string The minimum stability
     */
    protected function getRequireStability(Link $require)
    {
        $prettyConstraint = $require->getPrettyConstraint();
        $stabilities = Package::$stabilities;

        if (preg_match_all('/@('.implode('|', array_keys($stabilities)).')/', $prettyConstraint, $matches)) {
            return FilterUtil::findInlineStabilities($matches[1], $this->versionParser);
        }

        return FilterUtil::getMinimumStabilityFlag($this->package, $require);
    }

    /**
     * Initialize.
     */
    protected function initialize()
    {
        $this->requires = array_merge(
            $this->package->getRequires(),
            $this->package->getDevRequires()
        );

        if (null !== $this->installedRepository
                && FilterUtil::checkExtraOption($this->package, 'asset-optimize-with-installed-packages')) {
            $this->initInstalledPackages();
        }
    }

    /**
     * Initialize the installed package.
     */
    private function initInstalledPackages()
    {
        /* @var PackageInterface $package */
        foreach ($this->installedRepository->getPackages() as $package) {
            $operator = $this->getFilterOperator($package);
            /* @var Link $link */
            if (method_exists($this->arrayLoader, 'parseLinks')) {
                $link = current($this->arrayLoader->parseLinks($this->package->getName(), $this->package->getVersion(), 'installed', array($package->getName() => $operator.$package->getPrettyVersion())));
            } else {
                $link = current($this->versionParser->parseLinks($this->package->getName(), $this->package->getVersion(), 'installed', array($package->getName() => $operator.$package->getPrettyVersion())));
            }
            $link = $this->includeRootConstraint($package, $link);

            $this->requires[$package->getName()] = $link;
        }
    }

    /**
     * Get current MultiConstraint class based on the composer version.
     *
     * @param array $constraints    Array list of constraints
     * @param bool  $useConjunctive
     *
     * @return \Composer\Semver\Constraint\MultiConstraint|\Composer\Package\LinkConstraint\MultiConstraint
     */
    private function getMultiConstraintInstance(array $constraints, $useConjunctive)
    {
        if (class_exists('\Composer\Semver\Constraint\MultiConstraint')) {
            return new MultiConstraint($constraints, $useConjunctive);
        }

        return new LinkMultiConstraint($constraints, $useConjunctive);
    }

    /**
     * Include the constraint of root dependency version in the constraint
     * of installed package.
     *
     * @param PackageInterface $package The installed package
     * @param Link             $link    The link contained installed constraint
     *
     * @return Link The link with root and installed version constraint
     */
    private function includeRootConstraint(PackageInterface $package, Link $link)
    {
        if (isset($this->requires[$package->getName()])) {
            /* @var Link $rLink */
            $rLink = $this->requires[$package->getName()];
            $useConjunctive = FilterUtil::checkExtraOption($this->package, 'asset-optimize-with-conjunctive');
            $constraint = $this->getMultiConstraintInstance(array($rLink->getConstraint(), $link->getConstraint()), $useConjunctive);
            $link = new Link($rLink->getSource(), $rLink->getTarget(), $constraint, 'installed', $constraint->getPrettyString());
        }

        return $link;
    }

    /**
     * Get the filter root constraint operator.
     *
     * @param PackageInterface $package
     *
     * @return string
     */
    private function getFilterOperator(PackageInterface $package)
    {
        return $this->installationManager->isPackageInstalled($this->installedRepository, $package)
            ? '>'
            : '>=';
    }
}

1	<?php
2
3	/*
4	* This file is part of the Fxp Composer Asset Plugin package.
5	*
6	* (c) François Pluchino <francois.pluchino@gmail.com>
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 Fxp\Composer\AssetPlugin\Repository;
13
14	use Composer\Installer\InstallationManager;
15	use Composer\Package\Link;
16	use Composer\Package\Package;
17	use Composer\Package\PackageInterface;
18	use Composer\Package\RootPackageInterface;
19	use Composer\Package\Loader\ArrayLoader;
20	use Composer\Package\LinkConstraint\MultiConstraint as LinkMultiConstraint;
21	use Composer\Semver\Constraint\MultiConstraint;
22	use Composer\Repository\InstalledFilesystemRepository;
23	use Fxp\Composer\AssetPlugin\Package\Version\VersionParser;
24	use Fxp\Composer\AssetPlugin\Type\AssetTypeInterface;
25
26	/**
27	* Filters the asset packages imported into VCS repository to optimize
28	* performance when getting the informations of packages.
29	*
30	* @author François Pluchino <francois.pluchino@gmail.com>
31	*/
32	class VcsPackageFilter
33	{
34	/**
35	* @var RootPackageInterface
36	*/
37	protected $package;
38
39	/**
40	* @var InstallationManager
41	*/
42	protected $installationManager;
43
44	/**
45	* @var InstalledFilesystemRepository
46	*/
47	protected $installedRepository;
48
49	/**
50	* @var VersionParser
51	*/
52	protected $versionParser;
53
54	/**
55	* @var ArrayLoader
56	*/
57	protected $arrayLoader;
58
59	/**
60	* @var bool
61	*/
62	protected $enabled;
63
64	/**
65	* @var array
66	*/
67	protected $requires;
68
69	/**
70	* Constructor.
71	*
72	* @param RootPackageInterface $package The root package
73	* @param InstallationManager $installationManager The installation manager
74	* @param InstalledFilesystemRepository\|null $installedRepository The installed repository
75	*/
76	public function __construct(RootPackageInterface $package, InstallationManager $installationManager, InstalledFilesystemRepository $installedRepository = null)
77	{
78	$this->package = $package;	1,380✔
79	$this->installationManager = $installationManager;	1,380✔
80	$this->installedRepository = $installedRepository;	1,380✔
81	$this->versionParser = new VersionParser();	1,380✔
82	$this->arrayLoader = new ArrayLoader();	1,380✔
83	$this->enabled = true;	1,380✔
84
85	$this->initialize();	1,380✔
86	}	1,380✔
87
88	/**
89	* @param bool $enabled
90	*
91	* @return self
92	*/
93	public function setEnabled($enabled)
94	{
95	$this->enabled = (bool) $enabled;	28✔
96
97	return $this;	28✔
98	}
99
100	/**
101	* Check if the filter is enabled.
102	*
103	* @return bool
104	*/
105	public function isEnabled()
106	{
107	return $this->enabled;	432✔
108	}
109
110	/**
111	* Check if the version must be skipped.
112	*
113	* @param AssetTypeInterface $assetType The asset type
114	* @param string $name The composer package name
115	* @param string $version The version
116	*
117	* @return bool
118	*/
119	public function skip(AssetTypeInterface $assetType, $name, $version)
120	{
121	try {
122	$cVersion = $assetType->getVersionConverter()->convertVersion($version);	1,304✔
123	$normalizedVersion = $this->versionParser->normalize($cVersion);	1,304✔
124	} catch (\Exception $ex) {	1,304✔
125	return true;	4✔
126	}
127
128	if (false !== $this->skipByPattern() && $this->forceSkipVersion($normalizedVersion)) {	1,300✔
129	return true;	184✔
130	}
131
132	return $this->doSkip($name, $normalizedVersion);	1,116✔
133	}
134
135	/**
136	* Do check if the version must be skipped.
137	*
138	* @param string $name The composer package name
139	* @param string $normalizedVersion The normalized version
140	*
141	* @return bool
142	*/
143	protected function doSkip($name, $normalizedVersion)
144	{
145	if (!isset($this->requires[$name])) {	1,116✔
146	return false;	48✔
147	}
148
149	/* @var Link $require */
150	$require = $this->requires[$name];	1,068✔
151
152	return !$this->satisfy($require, $normalizedVersion) && $this->isEnabled();	1,068✔
153	}
154
155	/**
156	* Check if the require dependency has a satisfactory version and stability.
157	*
158	* @param Link $require The require link defined in root package
159	* @param string $normalizedVersion The normalized version
160	*
161	* @return bool
162	*/
163	protected function satisfy(Link $require, $normalizedVersion)
164	{
165	return $this->satisfyVersion($require, $normalizedVersion)	1,068✔
166	&& $this->satisfyStability($require, $normalizedVersion);	1,068✔
167	}
168
169	/**
170	* Check if the filter must be skipped the version by pattern or not.
171	*
172	* @return string\|false Return the pattern or FALSE for disable the feature
173	*/
174	protected function skipByPattern()
175	{
176	$extra = $this->package->getExtra();	1,300✔
177
178	if (!array_key_exists('asset-pattern-skip-version', $extra)) {	1,300✔
179	$extra['asset-pattern-skip-version'] = '(-patch)';	1,120✔
180	}	1,120✔
181
182	if (is_string($extra['asset-pattern-skip-version'])) {	1,300✔
183	return trim($extra['asset-pattern-skip-version'], '/');	1,120✔
184	}
185
186	return false;	180✔
187	}
188
189	/**
190	* Check if the require package version must be skipped or not.
191	*
192	* @param string $normalizedVersion The normalized version
193	*
194	* @return bool
195	*/
196	protected function forceSkipVersion($normalizedVersion)
197	{
198	return (bool) preg_match('/'.$this->skipByPattern().'/', $normalizedVersion);	1,120✔
199	}
200
201	/**
202	* Check if the require dependency has a satisfactory version.
203	*
204	* @param Link $require The require link defined in root package
205	* @param string $normalizedVersion The normalized version
206	*
207	* @return bool
208	*/
209	protected function satisfyVersion(Link $require, $normalizedVersion)
210	{
211	$constraintSame = $this->versionParser->parseConstraints($normalizedVersion);	1,068✔
212	$sameVersion = (bool) $require->getConstraint()->matches($constraintSame);	1,068✔
213
214	$normalizedVersion = FilterUtil::getVersionConstraint($normalizedVersion, $this->versionParser);	1,068✔
215	$constraint = FilterUtil::getVersionConstraint($normalizedVersion, $this->versionParser);	1,068✔
216
217	return (bool) $require->getConstraint()->matches($constraint) \|\| $sameVersion;	1,068✔
218	}
219
220	/**
221	* Check if the require dependency has a satisfactory stability.
222	*
223	* @param Link $require The require link defined in root package
224	* @param string $normalizedVersion The normalized version
225	*
226	* @return bool
227	*/
228	protected function satisfyStability(Link $require, $normalizedVersion)
229	{
230	$requireStability = $this->getRequireStability($require);	1,012✔
231	$stability = $this->versionParser->parseStability($normalizedVersion);	1,012✔
232
233	return Package::$stabilities[$stability] <= Package::$stabilities[$requireStability];	1,012✔
234	}
235
236	/**
237	* Get the minimum stability for the require dependency defined in root package.
238	*
239	* @param Link $require The require link defined in root package
240	*
241	* @return string The minimum stability
242	*/
243	protected function getRequireStability(Link $require)
244	{
245	$prettyConstraint = $require->getPrettyConstraint();	1,012✔
246	$stabilities = Package::$stabilities;	1,012✔
247
248	if (preg_match_all('/@('.implode('\|', array_keys($stabilities)).')/', $prettyConstraint, $matches)) {	1,012✔
249	return FilterUtil::findInlineStabilities($matches[1], $this->versionParser);	700✔
250	}
251
252	return FilterUtil::getMinimumStabilityFlag($this->package, $require);	312✔
253	}
254
255	/**
256	* Initialize.
257	*/
258	protected function initialize()
259	{
260	$this->requires = array_merge(	1,380✔
261	$this->package->getRequires(),	1,380✔
262	$this->package->getDevRequires()	1,380✔
263	);	1,380✔
264
265	if (null !== $this->installedRepository	1,380✔
266	&& FilterUtil::checkExtraOption($this->package, 'asset-optimize-with-installed-packages')) {	1,380✔
267	$this->initInstalledPackages();	144✔
268	}	144✔
269	}	1,380✔
270
271	/**
272	* Initialize the installed package.
273	*/
274	private function initInstalledPackages()
275	{
276	/* @var PackageInterface $package */
277	foreach ($this->installedRepository->getPackages() as $package) {	144✔
278	$operator = $this->getFilterOperator($package);	72✔
279	/* @var Link $link */
280	if (method_exists($this->arrayLoader, 'parseLinks')) {	72✔
281	$link = current($this->arrayLoader->parseLinks($this->package->getName(), $this->package->getVersion(), 'installed', array($package->getName() => $operator.$package->getPrettyVersion())));	72✔
282	} else {	72✔
283	$link = current($this->versionParser->parseLinks($this->package->getName(), $this->package->getVersion(), 'installed', array($package->getName() => $operator.$package->getPrettyVersion())));	×
284	}
285	$link = $this->includeRootConstraint($package, $link);	72✔
286
287	$this->requires[$package->getName()] = $link;	72✔
288	}	144✔
289	}	144✔
290
291	/**
292	* Get current MultiConstraint class based on the composer version.
293	*
294	* @param array $constraints Array list of constraints
295	* @param bool $useConjunctive
296	*
297	* @return \Composer\Semver\Constraint\MultiConstraint\|\Composer\Package\LinkConstraint\MultiConstraint
298	*/
299	private function getMultiConstraintInstance(array $constraints, $useConjunctive)
300	{
301	if (class_exists('\Composer\Semver\Constraint\MultiConstraint')) {	48✔
302	return new MultiConstraint($constraints, $useConjunctive);	48✔
303	}
304
305	return new LinkMultiConstraint($constraints, $useConjunctive);	×
306	}
307
308	/**
309	* Include the constraint of root dependency version in the constraint
310	* of installed package.
311	*
312	* @param PackageInterface $package The installed package
313	* @param Link $link The link contained installed constraint
314	*
315	* @return Link The link with root and installed version constraint
316	*/
317	private function includeRootConstraint(PackageInterface $package, Link $link)
318	{
319	if (isset($this->requires[$package->getName()])) {	72✔
320	/* @var Link $rLink */
321	$rLink = $this->requires[$package->getName()];	48✔
322	$useConjunctive = FilterUtil::checkExtraOption($this->package, 'asset-optimize-with-conjunctive');	48✔
323	$constraint = $this->getMultiConstraintInstance(array($rLink->getConstraint(), $link->getConstraint()), $useConjunctive);	48✔
324	$link = new Link($rLink->getSource(), $rLink->getTarget(), $constraint, 'installed', $constraint->getPrettyString());	48✔
325	}	48✔
326
327	return $link;	72✔
328	}
329
330	/**
331	* Get the filter root constraint operator.
332	*
333	* @param PackageInterface $package
334	*
335	* @return string
336	*/
337	private function getFilterOperator(PackageInterface $package)
338	{
339	return $this->installationManager->isPackageInstalled($this->installedRepository, $package)	72✔
340	? '>'	72✔
341	: '>=';	72✔
342	}
343	}

fxpio / composer-asset-plugin / 378

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous