PluginState::forceUpdate() - Code Metrics - Inspection of "Fixes #142: Adding "skip" option for dependency re..." - wikimedia/composer-merge-plugin - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#143)

unknown

created 2017-04-17 14:02 UTC

PluginState::forceUpdate() A

↳ Parent: PluginState

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	1
CRAP Score	1

Importance

Changes

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

<?php
/**
 * This file is part of the Composer Merge plugin.
 *
 * Copyright (C) 2015 Bryan Davis, Wikimedia Foundation, and contributors
 *
 * This software may be modified and distributed under the terms of the MIT
 * license. See the LICENSE file for details.
 */

namespace Wikimedia\Composer\Merge;

use Composer\Composer;

/**
 * Mutable plugin state
 *
 * @author Bryan Davis <[email protected]>
 */
class PluginState
{
    /**
     * @var Composer $composer
     */
    protected $composer;

    /**
     * @var array $includes
     */
    protected $includes = array();

    /**
     * @var array $requires
     */
    protected $requires = array();

    /**
     * @var array $duplicateLinks
     */
    protected $duplicateLinks = array();

    /**
     * @var bool $devMode
     */
    protected $devMode = false;

    /**
     * @var bool $recurse
     */
    protected $recurse = true;

    /**
     * @var bool $replace
     */
    protected $replace = false;

    /**
     * @var bool $ignore
     */
    protected $ignore = false;

    /**
     * Whether to merge the -dev sections.
     * @var bool $mergeDev
     */
    protected $mergeDev = true;

    /**
     * Whether to merge the extra section.
     *
     * By default, the extra section is not merged and there will be many
     * cases where the merge of the extra section is performed too late
     * to be of use to other plugins. When enabled, merging uses one of
     * two strategies - either 'first wins' or 'last wins'. When enabled,
     * 'first wins' is the default behaviour. If Replace mode is activated
     * then 'last wins' is used.
     *
     * @var bool $mergeExtra
     */
    protected $mergeExtra = false;

    /**
     * Whether to merge the extra section in a deep / recursive way.
     *
     * By default the extra section is merged with array_merge() and duplicate
     * keys are ignored. When enabled this allows to merge the arrays recursively
     * using the following rule: Integer keys are merged, while array values are
     * replaced where the later values overwrite the former.
     *
     * This is useful especially for the extra section when plugins use larger
     * structures like a 'patches' key with the packages as sub-keys and the
     * patches as values.
     *
     * When 'replace' mode is activated the order of array merges is exchanged.
     *
     * @var bool $mergeExtraDeep
     */
    protected $mergeExtraDeep = false;

    /**
     * Whether to merge the scripts section.
     *
     * @var bool $mergeScripts
     */
    protected $mergeScripts = false;

    /**
     * @var bool $firstInstall
     */
    protected $firstInstall = false;

    /**
     * @var bool $locked
     */
    protected $locked = false;

    /**
     * @var bool $dumpAutoloader
     */
    protected $dumpAutoloader = false;

    /**
     * @var bool $optimizeAutoloader
     */
    protected $optimizeAutoloader = false;

    /**
     * @param Composer $composer
     */
    public function __construct(Composer $composer)
    {
        $this->composer = $composer;
    }

    /**
     * Load plugin settings
     */
    public function loadSettings()
    {
        $extra = $this->composer->getPackage()->getExtra();
        $config = array_merge(
            array(
                'include' => array(),
                'require' => array(),
                'recurse' => true,
                'replace' => false,
                'ignore-duplicates' => false,
                'merge-dev' => true,
                'merge-extra' => false,
                'merge-extra-deep' => false,
                'merge-scripts' => false,
            ),
            isset($extra['merge-plugin']) ? $extra['merge-plugin'] : array()
        );

        $this->includes = (is_array($config['include'])) ?
            $config['include'] : array($config['include']);
        $this->requires = (is_array($config['require'])) ?
            $config['require'] : array($config['require']);
        $this->recurse = (bool)$config['recurse'];
        $this->replace = (bool)$config['replace'];
        $this->ignore = (bool)$config['ignore-duplicates'];
        $this->mergeDev = (bool)$config['merge-dev'];
        $this->mergeExtra = (bool)$config['merge-extra'];
        $this->mergeExtraDeep = (bool)$config['merge-extra-deep'];
        $this->mergeScripts = (bool)$config['merge-scripts'];
    }

    /**
     * Get list of filenames and/or glob patterns to include
     *
     * @return array
     */
    public function getIncludes()
    {
        return $this->includes;
    }

    /**
     * Get list of filenames and/or glob patterns to require
     *
     * @return array
     */
    public function getRequires()
    {
        return $this->requires;
    }

    /**
     * Set the first install flag
     *
     * @param bool $flag
     */
    public function setFirstInstall($flag)
    {
        $this->firstInstall = (bool)$flag;
    }

    /**
     * Is this the first time that the plugin has been installed?
     *
     * @return bool
     */
    public function isFirstInstall()
    {
        return $this->firstInstall;
    }

    /**
     * Set the locked flag
     *
     * @param bool $flag
     */
    public function setLocked($flag)
    {
        $this->locked = (bool)$flag;
    }

    /**
     * Was a lockfile present when the plugin was installed?
     *
     * @return bool
     */
    public function isLocked()
    {
        return $this->locked;
    }

    /**
     * Should an update be forced?
     *
     * @return true If packages are not locked
     */
    public function forceUpdate()
    {
        return !$this->locked;
    }

    /**
     * Set the devMode flag
     *
     * @param bool $flag
     */
    public function setDevMode($flag)
    {
        $this->devMode = (bool)$flag;
    }

    /**
     * Should devMode settings be processed?
     *
     * @return bool
     */
    public function isDevMode()
    {
        return $this->shouldMergeDev() && $this->devMode;
    }

    /**
     * Should devMode settings be merged?
     *
     * @return bool
     */
    public function shouldMergeDev()
    {
        return $this->mergeDev;
    }

    /**
     * Set the dumpAutoloader flag
     *
     * @param bool $flag
     */
    public function setDumpAutoloader($flag)
    {
        $this->dumpAutoloader = (bool)$flag;
    }

    /**
     * Is the autoloader file supposed to be written out?
     *
     * @return bool
     */
    public function shouldDumpAutoloader()
    {
        return $this->dumpAutoloader;
    }

    /**
     * Set the optimizeAutoloader flag
     *
     * @param bool $flag
     */
    public function setOptimizeAutoloader($flag)
    {
        $this->optimizeAutoloader = (bool)$flag;
    }

    /**
     * Should the autoloader be optimized?
     *
     * @return bool
     */
    public function shouldOptimizeAutoloader()
    {
        return $this->optimizeAutoloader;
    }

    /**
     * Add duplicate packages
     *
     * @param string $type Package type
     * @param array $packages
     */
    public function addDuplicateLinks($type, array $packages)
    {
        if (!isset($this->duplicateLinks[$type])) {
            $this->duplicateLinks[$type] = array();
        }
        $this->duplicateLinks[$type] =
            array_merge($this->duplicateLinks[$type], $packages);
    }

    /**
     * Get duplicate packages
     *
     * @param string $type Package type
     * @return array
     */
    public function getDuplicateLinks($type)
    {
        return isset($this->duplicateLinks[$type]) ?
            $this->duplicateLinks[$type] : array();
    }

    /**
     * Should includes be recursively processed?
     *
     * @return bool
     */
    public function recurseIncludes()
    {
        return $this->recurse;
    }

    /**
     * Should duplicate links be replaced in a 'last definition wins' order?
     *
     * @return bool
     */
    public function replaceDuplicateLinks()
    {
        return $this->replace;
    }

    /**
     * Should duplicate links be ignored?
     *
     * @return bool
     */
    public function ignoreDuplicateLinks()
    {
        return $this->ignore;
    }

    /**
     * Should the extra section be merged?
     *
     * By default, the extra section is not merged and there will be many
     * cases where the merge of the extra section is performed too late
     * to be of use to other plugins. When enabled, merging uses one of
     * two strategies - either 'first wins' or 'last wins'. When enabled,
     * 'first wins' is the default behaviour. If Replace mode is activated
     * then 'last wins' is used.
     *
     * @return bool
     */
    public function shouldMergeExtra()
    {
        return $this->mergeExtra;
    }

    /**
     * Should the extra section be merged deep / recursively?
     *
     * By default the extra section is merged with array_merge() and duplicate
     * keys are ignored. When enabled this allows to merge the arrays recursively
     * using the following rule: Integer keys are merged, while array values are
     * replaced where the later values overwrite the former.
     *
     * This is useful especially for the extra section when plugins use larger
     * structures like a 'patches' key with the packages as sub-keys and the
     * patches as values.
     *
     * When 'replace' mode is activated the order of array merges is exchanged.
     *
     * @return bool
     */
    public function shouldMergeExtraDeep()
    {
        return $this->mergeExtraDeep;
    }


    /**
     * Should the scripts section be merged?
     *
     * By default, the scripts section is not merged.
     *
     * @return bool
     */
    public function shouldMergeScripts()
    {
        return $this->mergeScripts;
    }
}
// vim:sw=4:ts=4:sts=4:et:


1		<?php
2		/**
3		* This file is part of the Composer Merge plugin.
4		*
5		* Copyright (C) 2015 Bryan Davis, Wikimedia Foundation, and contributors
6		*
7		* This software may be modified and distributed under the terms of the MIT
8		* license. See the LICENSE file for details.
9		*/
10
11		namespace Wikimedia\Composer\Merge;
12
13		use Composer\Composer;
14
15		/**
16		* Mutable plugin state
17		*
18		* @author Bryan Davis <[email protected]>
19		*/
20		class PluginState
21		{
22		/**
23		* @var Composer $composer
24		*/
25		protected $composer;
26
27		/**
28		* @var array $includes
29		*/
30		protected $includes = array();
31
32		/**
33		* @var array $requires
34		*/
35		protected $requires = array();
36
37		/**
38		* @var array $duplicateLinks
39		*/
40		protected $duplicateLinks = array();
41
42		/**
43		* @var bool $devMode
44		*/
45		protected $devMode = false;
46
47		/**
48		* @var bool $recurse
49		*/
50		protected $recurse = true;
51
52		/**
53		* @var bool $replace
54		*/
55		protected $replace = false;
56
57		/**
58		* @var bool $ignore
59		*/
60		protected $ignore = false;
61
62		/**
63		* Whether to merge the -dev sections.
64		* @var bool $mergeDev
65		*/
66		protected $mergeDev = true;
67
68		/**
69		* Whether to merge the extra section.
70		*
71		* By default, the extra section is not merged and there will be many
72		* cases where the merge of the extra section is performed too late
73		* to be of use to other plugins. When enabled, merging uses one of
74		* two strategies - either 'first wins' or 'last wins'. When enabled,
75		* 'first wins' is the default behaviour. If Replace mode is activated
76		* then 'last wins' is used.
77		*
78		* @var bool $mergeExtra
79		*/
80		protected $mergeExtra = false;
81
82		/**
83		* Whether to merge the extra section in a deep / recursive way.
84		*
85		* By default the extra section is merged with array_merge() and duplicate
86		* keys are ignored. When enabled this allows to merge the arrays recursively
87		* using the following rule: Integer keys are merged, while array values are
88		* replaced where the later values overwrite the former.
89		*
90		* This is useful especially for the extra section when plugins use larger
91		* structures like a 'patches' key with the packages as sub-keys and the
92		* patches as values.
93		*
94		* When 'replace' mode is activated the order of array merges is exchanged.
95		*
96		* @var bool $mergeExtraDeep
97		*/
98		protected $mergeExtraDeep = false;
99
100		/**
101		* Whether to merge the scripts section.
102		*
103		* @var bool $mergeScripts
104		*/
105		protected $mergeScripts = false;
106
107		/**
108		* @var bool $firstInstall
109		*/
110		protected $firstInstall = false;
111
112		/**
113		* @var bool $locked
114		*/
115		protected $locked = false;
116
117		/**
118		* @var bool $dumpAutoloader
119		*/
120		protected $dumpAutoloader = false;
121
122		/**
123		* @var bool $optimizeAutoloader
124		*/
125	200	protected $optimizeAutoloader = false;
126
127	200	/**
128	200	* @param Composer $composer
129		*/
130		public function __construct(Composer $composer)
131		{
132		$this->composer = $composer;
133	165	}
134
135	165	/**
136	165	* Load plugin settings
137		*/
138	165	public function loadSettings()
139	165	{
140	165	$extra = $this->composer->getPackage()->getExtra();
141	165	$config = array_merge(
142	165	array(
143	165	'include' => array(),
144	165	'require' => array(),
145	165	'recurse' => true,
146	165	'replace' => false,
147	165	'ignore-duplicates' => false,
148	165	'merge-dev' => true,
149		'merge-extra' => false,
150	165	'merge-extra-deep' => false,
151	165	'merge-scripts' => false,
152	165	),
153	165	isset($extra['merge-plugin']) ? $extra['merge-plugin'] : array()
154	165	);
155	165
156	165	$this->includes = (is_array($config['include'])) ?
157	165	$config['include'] : array($config['include']);
158	165	$this->requires = (is_array($config['require'])) ?
159	165	$config['require'] : array($config['require']);
160	165	$this->recurse = (bool)$config['recurse'];
161		$this->replace = (bool)$config['replace'];
162		$this->ignore = (bool)$config['ignore-duplicates'];
163		$this->mergeDev = (bool)$config['merge-dev'];
164		$this->mergeExtra = (bool)$config['merge-extra'];
165		$this->mergeExtraDeep = (bool)$config['merge-extra-deep'];
166		$this->mergeScripts = (bool)$config['merge-scripts'];
167	165	}
168
169	165	/**
170		* Get list of filenames and/or glob patterns to include
171		*
172		* @return array
173		*/
174		public function getIncludes()
175		{
176		return $this->includes;
177	165	}
178
179	165	/**
180		* Get list of filenames and/or glob patterns to require
181		*
182		* @return array
183		*/
184		public function getRequires()
185		{
186		return $this->requires;
187	10	}
188
189	10	/**
190	10	* Set the first install flag
191		*
192		* @param bool $flag
193		*/
194		public function setFirstInstall($flag)
195		{
196		$this->firstInstall = (bool)$flag;
197	175	}
198
199	175	/**
200		* Is this the first time that the plugin has been installed?
201		*
202		* @return bool
203		*/
204		public function isFirstInstall()
205		{
206		return $this->firstInstall;
207	15	}
208
209	15	/**
210	15	* Set the locked flag
211		*
212		* @param bool $flag
213		*/
214		public function setLocked($flag)
215		{
216		$this->locked = (bool)$flag;
217	20	}
218
219	20	/**
220		* Was a lockfile present when the plugin was installed?
221		*
222		* @return bool
223		*/
224		public function isLocked()
225		{
226		return $this->locked;
227	5	}
228
229	5	/**
230		* Should an update be forced?
231		*
232		* @return true If packages are not locked
233		*/
234		public function forceUpdate()
235		{
236		return !$this->locked;
237	165	}
238
239	165	/**
240	165	* Set the devMode flag
241		*
242		* @param bool $flag
243		*/
244		public function setDevMode($flag)
245		{
246		$this->devMode = (bool)$flag;
247	160	}
248
249	160	/**
250		* Should devMode settings be processed?
251		*
252		* @return bool
253		*/
254		public function isDevMode()
255		{
256		return $this->shouldMergeDev() && $this->devMode;
257	160	}
258
259	160	/**
260		* Should devMode settings be merged?
261		*
262		* @return bool
263		*/
264		public function shouldMergeDev()
265		{
266		return $this->mergeDev;
267	165	}
268
269	165	/**
270	165	* Set the dumpAutoloader flag
271		*
272		* @param bool $flag
273		*/
274		public function setDumpAutoloader($flag)
275		{
276		$this->dumpAutoloader = (bool)$flag;
277	5	}
278
279	5	/**
280		* Is the autoloader file supposed to be written out?
281		*
282		* @return bool
283		*/
284		public function shouldDumpAutoloader()
285		{
286		return $this->dumpAutoloader;
287	165	}
288
289	165	/**
290	165	* Set the optimizeAutoloader flag
291		*
292		* @param bool $flag
293		*/
294		public function setOptimizeAutoloader($flag)
295		{
296		$this->optimizeAutoloader = (bool)$flag;
297	5	}
298
299	5	/**
300		* Should the autoloader be optimized?
301		*
302		* @return bool
303		*/
304		public function shouldOptimizeAutoloader()
305		{
306		return $this->optimizeAutoloader;
307		}
308	85
309		/**
310	85	* Add duplicate packages
311	85	*
312	85	* @param string $type Package type
313	85	* @param array $packages
314	85	*/
315	85	public function addDuplicateLinks($type, array $packages)
316		{
317		if (!isset($this->duplicateLinks[$type])) {
318		$this->duplicateLinks[$type] = array();
319		}
320		$this->duplicateLinks[$type] =
321		array_merge($this->duplicateLinks[$type], $packages);
322		}
323	160
324		/**
325	160	* Get duplicate packages
326	160	*
327		* @param string $type Package type
328		* @return array
329		*/
330		public function getDuplicateLinks($type)
331		{
332		return isset($this->duplicateLinks[$type]) ?
333		$this->duplicateLinks[$type] : array();
334	160	}
335
336	160	/**
337		* Should includes be recursively processed?
338		*
339		* @return bool
340		*/
341		public function recurseIncludes()
342		{
343		return $this->recurse;
344	85	}
345
346	85	/**
347		* Should duplicate links be replaced in a 'last definition wins' order?
348		*
349		* @return bool
350		*/
351		public function replaceDuplicateLinks()
352		{
353		return $this->replace;
354		}
355
356		/**
357		* Should duplicate links be ignored?
358		*
359		* @return bool
360		*/
361	160	public function ignoreDuplicateLinks()
362		{
363	160	return $this->ignore;
364		}
365
366		/**
367		* Should the extra section be merged?
368		*
369		* By default, the extra section is not merged and there will be many
370		* cases where the merge of the extra section is performed too late
371		* to be of use to other plugins. When enabled, merging uses one of
372		* two strategies - either 'first wins' or 'last wins'. When enabled,
373		* 'first wins' is the default behaviour. If Replace mode is activated
374		* then 'last wins' is used.
375		*
376		* @return bool
377		*/
378		public function shouldMergeExtra()
379		{
380		return $this->mergeExtra;
381		}
382	30
383		/**
384	30	* Should the extra section be merged deep / recursively?
385		*
386		* By default the extra section is merged with array_merge() and duplicate
387		* keys are ignored. When enabled this allows to merge the arrays recursively
388		* using the following rule: Integer keys are merged, while array values are
389		* replaced where the later values overwrite the former.
390		*
391		* This is useful especially for the extra section when plugins use larger
392		* structures like a 'patches' key with the packages as sub-keys and the
393		* patches as values.
394		*
395	160	* When 'replace' mode is activated the order of array merges is exchanged.
396		*
397	160	* @return bool
398		*/
399		public function shouldMergeExtraDeep()
400		{
401		return $this->mergeExtraDeep;
402		}
403
404
405		/**
406		* Should the scripts section be merged?
407		*
408		* By default, the scripts section is not merged.
409		*
410		* @return bool
411		*/
412		public function shouldMergeScripts()
413		{
414		return $this->mergeScripts;
415		}
416		}
417		// vim:sw=4:ts=4:sts=4:et:
418

wikimedia / composer-merge-plugin

Pull Request — master (#143)

PluginState::forceUpdate() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like