TouchTask::touch() - Code Metrics - Inspection of "PSR-12 and other CS fixes" - phingofficial/phing - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — main ( 4889b2...808ce0 )

by Michiel

created 2021-02-11 12:34 UTC

TouchTask::touch() F

↳ Parent: TouchTask

Complexity

Conditions	16
Paths	961

Size

Total Lines	67
Code Lines	38

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	35
CRAP Score	16.0405

Importance

Changes

Metric	Value
eloc	38
dl	0
loc	67
ccs	35
cts	37
cp	0.9459
rs	1.4541
c	0
b	0
f	0
cc	16
nc	961
nop	0
crap	16.0405

How to fix Long Method Complexity

<?php
/**
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the LGPL. For more information please see
 * <http://phing.info>.
 */

namespace Phing\Task\System;

use Phing\Exception\BuildException;
use Phing\Io\File;
use Phing\Io\FileUtils;
use Phing\Io\IOException;
use Phing\Phing;
use Phing\Project;
use Phing\Task;
use Phing\Type\Element\FileListAware;
use Phing\Type\Element\FileSetAware;
use Phing\Type\Mapper;

/**
 * Touch a file and/or fileset(s); corresponds to the Unix touch command.
 *
 * If the file to touch doesn't exist, an empty one is created.
 *
 */
class TouchTask extends Task
{
    use FileListAware;
    use FileSetAware;

    /**
     * @var File $file
     */
    private $file;
    private $seconds = -1;
    private $dateTime;
    private $fileUtils;
    private $mkdirs = false;
    private $verbose = true;

    /** @var Mapper $mapperElement */
    private $mapperElement;

    /**
     *
     */
    public function __construct()
    {
        parent::__construct();
        $this->fileUtils = new FileUtils();
    }

    /**
     * Sets a single source file to touch.  If the file does not exist
     * an empty file will be created.
     *
     * @param  File $file
     * @return void
     */
    public function setFile(File $file)
    {
        $this->file = $file;
    }

    /**
     * The new modification time of the file in milliseconds since midnight
     * Jan 1 1970. Negative values are not accepted nor are values less than
     * 1000. Note that PHP is actually based on seconds so the value passed
     * in will be divided by 1000.
     *
     * Optional, default=now
     *
     * @param int $millis
     * @return void
     */
    public function setMillis($millis)
    {
        if ($millis >= 0) {
            if ($millis >= 1000) {
                $this->seconds = (int) $millis / 1000;
            } else {
                throw new BuildException("Millis less than 1000 would be treated as 0");
            }
        } else {
            throw new BuildException("Millis attribute cannot be negative");
        }
    }

    /**
     * the new modification time of the file
     * in seconds since midnight Jan 1 1970.
     * Optional, default=now
     *
     * @param int $seconds
     * @return void
     */
    public function setSeconds($seconds)
    {
        if ($seconds >= 0) {
            $this->seconds = (int) $seconds;
        } else {
            throw new BuildException("Seconds attribute cannot be negative");
        }
    }

    /**
     * the new modification time of the file
     * in the format MM/DD/YYYY HH:MM AM or PM;
     * Optional, default=now
     *
     * @param string $dateTime
     * @return void
     */
    public function setDatetime($dateTime)
    {
        $timestmap = strtotime($dateTime);
        if (false !== $timestmap) {
            $this->dateTime = (string) $dateTime;
            $this->setSeconds($timestmap);
        } else {
            throw new BuildException("Date of ${dateTime} cannot be parsed correctly. It should be in a format parsable by PHP's strtotime() function." . PHP_EOL);
        }
    }

    /**
     * Set whether nonexistent parent directories should be created
     * when touching new files.
     *
     * @param boolean $mkdirs whether to create parent directories.
     */
    public function setMkdirs($mkdirs)
    {
        $this->mkdirs = $mkdirs;
    }

    /**
     * Set whether the touch task will report every file it creates;
     * defaults to <code>true</code>.
     *
     * @param boolean $verbose flag.
     */
    public function setVerbose($verbose)
    {
        $this->verbose = $verbose;
    }

    /**
     * Execute the touch operation.
     *
     * @throws BuildException
     * @throws IOException
     */
    public function createMapper()
    {
        if ($this->mapperElement !== null) {
            throw new BuildException("Cannot define more than one mapper", $this->getLocation());
        }
        $this->mapperElement = new Mapper($this->project);

        return $this->mapperElement;
    }

    protected function checkConfiguration()
    {
        $savedSeconds = $this->seconds;

        if ($this->file === null && count($this->filesets) === 0 && count($this->filelists) === 0) {
            throw new BuildException("Specify at least one source - a file, a fileset or a filelist.");
        }

        if ($this->file !== null && $this->file->exists() && $this->file->isDirectory()) {
            throw new BuildException("Use a fileset to touch directories.");
        }

        $this->log(
            "Setting seconds to " . $savedSeconds . " from datetime attribute",
            ($this->seconds < 0 ? Project::MSG_DEBUG : Project::MSG_VERBOSE)
        );

        $this->seconds = $savedSeconds;
    }

    /**
     * Execute the touch operation.
     * @throws BuildException
     */
    public function main()
    {
        $this->checkConfiguration();
        $this->touch();
    }

    /**
     * Does the actual work.
     */
    private function touch()
    {
        if ($this->file !== null) {
            if (!$this->file->exists()) {
                $this->log(
                    "Creating " . $this->file,
                    $this->verbose ? Project::MSG_INFO : Project::MSG_VERBOSE
                );
                try { // try to create file
                    $this->file->createNewFile($this->mkdirs);
                } catch (IOException  $ioe) {
                    throw new BuildException(
                        "Error creating new file " . $this->file,
                        $ioe,
                        $this->getLocation()
                    );
                }
            }
        }

        $resetSeconds = false;
        if ($this->seconds < 0) {
            $resetSeconds = true;
            // Note: this function actually returns seconds, not milliseconds (e.g. 1606505920.2657)
            $this->seconds = Phing::currentTimeMillis();
        }

        if ($this->file !== null) {
            $this->touchFile($this->file);
        }

        $project = $this->getProject();
        foreach ($this->filesets as $fs) {
            $ds = $fs->getDirectoryScanner($project);
            $fromDir = $fs->getDir($project);

            $srcFiles = $ds->getIncludedFiles();
            $srcDirs = $ds->getIncludedDirectories();

            for ($j = 0, $_j = count($srcFiles); $j < $_j; $j++) {
                foreach ($this->getMappedFileNames((string) $srcFiles[$j]) as $fileName) {
                    $this->touchFile(new File($fromDir, $fileName));
                }
            }

            for ($j = 0, $_j = count($srcDirs); $j < $_j; $j++) {
                foreach ($this->getMappedFileNames((string) $srcDirs[$j]) as $fileName) {
                    $this->touchFile(new File($fromDir, $fileName));
                }
            }
        }

        // deal with the filelists
        foreach ($this->filelists as $fl) {
            $fromDir = $fl->getDir($this->getProject());

            $srcFiles = $fl->getFiles($this->getProject());

            for ($j = 0, $_j = count($srcFiles); $j < $_j; $j++) {
                foreach ($this->getMappedFileNames((string) $srcFiles[$j]) as $fileName) {
                    $this->touchFile(new File($fromDir, $fileName));
                }
            }
        }

        if ($resetSeconds) {
            $this->seconds = -1;
        }
    }

    private function getMappedFileNames($file)
    {
        if ($this->mapperElement !== null) {
            $mapper = $this->mapperElement->getImplementation();
            $results = $mapper->main($file);
            if ($results === null) {

                return '';
            }
            $fileNames = $results;
        } else {
            $fileNames = [$file];
        }

        return $fileNames;
    }

    /**
     * @param File $file
     * @throws BuildException
     */
    private function touchFile(File $file)
    {
        if (!$file->canWrite()) {
            throw new BuildException("Can not change modification date of read-only file " . (string) $file);
        }
        $file->setLastModified($this->seconds);
    }
}


1		<?php
2		/**
3		* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
4		* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
5		* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
6		* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
7		* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
8		* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
9		* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
10		* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
11		* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
12		* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
13		* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
14		*
15		* This software consists of voluntary contributions made by many individuals
16		* and is licensed under the LGPL. For more information please see
17		* <http://phing.info>.
18		*/
19
20		namespace Phing\Task\System;
21
22		use Phing\Exception\BuildException;
23		use Phing\Io\File;
24		use Phing\Io\FileUtils;
25		use Phing\Io\IOException;
26		use Phing\Phing;
27		use Phing\Project;
28		use Phing\Task;
29		use Phing\Type\Element\FileListAware;
30		use Phing\Type\Element\FileSetAware;
31		use Phing\Type\Mapper;
32
33		/**
34		* Touch a file and/or fileset(s); corresponds to the Unix touch command.
35		*
36		* If the file to touch doesn't exist, an empty one is created.
37		*
38		*/
39		class TouchTask extends Task
40		{
41		use FileListAware;
42		use FileSetAware;
43
44		/**
45		* @var File $file
46		*/
47		private $file;
48		private $seconds = -1;
49		private $dateTime;
50		private $fileUtils;
51		private $mkdirs = false;
52		private $verbose = true;
53
54		/** @var Mapper $mapperElement */
55		private $mapperElement;
56
57		/**
58		*
59		*/
60	85	public function __construct()
61		{
62	85	parent::__construct();
63	85	$this->fileUtils = new FileUtils();
64	85	}
65
66		/**
67		* Sets a single source file to touch. If the file does not exist
68		* an empty file will be created.
69		*
70		* @param File $file
71		* @return void
72		*/
73	76	public function setFile(File $file)
74		{
75	76	$this->file = $file;
76	76	}
77
78		/**
79		* The new modification time of the file in milliseconds since midnight
80		* Jan 1 1970. Negative values are not accepted nor are values less than
81		* 1000. Note that PHP is actually based on seconds so the value passed
82		* in will be divided by 1000.
83		*
84		* Optional, default=now
85		*
86		* @param int $millis
87		* @return void
88		*/
89	6	public function setMillis($millis)
90		{
91	6	if ($millis >= 0) {
92	4	if ($millis >= 1000) {
93	3	$this->seconds = (int) $millis / 1000;
94		} else {
95	4	throw new BuildException("Millis less than 1000 would be treated as 0");
96		}
97		} else {
98	2	throw new BuildException("Millis attribute cannot be negative");
99		}
100	3	}
101
102		/**
103		* the new modification time of the file
104		* in seconds since midnight Jan 1 1970.
105		* Optional, default=now
106		*
107		* @param int $seconds
108		* @return void
109		*/
110	9	public function setSeconds($seconds)
111		{
112	9	if ($seconds >= 0) {
113	8	$this->seconds = (int) $seconds;
114		} else {
115	1	throw new BuildException("Seconds attribute cannot be negative");
116		}
117	8	}
118
119		/**
120		* the new modification time of the file
121		* in the format MM/DD/YYYY HH:MM AM or PM;
122		* Optional, default=now
123		*
124		* @param string $dateTime
125		* @return void
126		*/
127	9	public function setDatetime($dateTime)
128		{
129	9	$timestmap = strtotime($dateTime);
130	9	if (false !== $timestmap) {
131	8	$this->dateTime = (string) $dateTime;
132	8	$this->setSeconds($timestmap);
133		} else {
134	1	throw new BuildException("Date of ${dateTime} cannot be parsed correctly. It should be in a format parsable by PHP's strtotime() function." . PHP_EOL);
135		}
136	7	}
137
138		/**
139		* Set whether nonexistent parent directories should be created
140		* when touching new files.
141		*
142		* @param boolean $mkdirs whether to create parent directories.
143		*/
144	11	public function setMkdirs($mkdirs)
145		{
146	11	$this->mkdirs = $mkdirs;
147	11	}
148
149		/**
150		* Set whether the touch task will report every file it creates;
151		* defaults to <code>true</code>.
152		*
153		* @param boolean $verbose flag.
154		*/
155		public function setVerbose($verbose)
156		{
157		$this->verbose = $verbose;
158		}
159
160		/**
161		* Execute the touch operation.
162		*
163		* @throws BuildException
164		* @throws IOException
165		*/
166	2	public function createMapper()
167		{
168	2	if ($this->mapperElement !== null) {
169		throw new BuildException("Cannot define more than one mapper", $this->getLocation());
170		}
171	2	$this->mapperElement = new Mapper($this->project);
172
173	2	return $this->mapperElement;
174		}
175
176	80	protected function checkConfiguration()
177		{
178	80	$savedSeconds = $this->seconds;
179
180	80	if ($this->file === null && count($this->filesets) === 0 && count($this->filelists) === 0) {
181	1	throw new BuildException("Specify at least one source - a file, a fileset or a filelist.");
182		}
183
184	79	if ($this->file !== null && $this->file->exists() && $this->file->isDirectory()) {
185	1	throw new BuildException("Use a fileset to touch directories.");
186		}
187
188	78	$this->log(
189	78	"Setting seconds to " . $savedSeconds . " from datetime attribute",
190	78	($this->seconds < 0 ? Project::MSG_DEBUG : Project::MSG_VERBOSE)
191		);
192
193	78	$this->seconds = $savedSeconds;
194	78	}
195
196		/**
197		* Execute the touch operation.
198		* @throws BuildException
199		*/
200	80	public function main()
201		{
202	80	$this->checkConfiguration();
203	78	$this->touch();
204	76	}
205
206		/**
207		* Does the actual work.
208		*/
209	78	private function touch()
210		{
211	78	if ($this->file !== null) {
212	70	if (!$this->file->exists()) {
213	59	$this->log(
214	59	"Creating " . $this->file,
215	59	$this->verbose ? Project::MSG_INFO : Project::MSG_VERBOSE
216		);
217		try { // try to create file
218	59	$this->file->createNewFile($this->mkdirs);
219	1	} catch (IOException $ioe) {
220	1	throw new BuildException(
221	1	"Error creating new file " . $this->file,
222		$ioe,
223	1	$this->getLocation()
224		);
225		}
226		}
227		}
228
229	77	$resetSeconds = false;
230	77	if ($this->seconds < 0) {
231	68	$resetSeconds = true;
232		// Note: this function actually returns seconds, not milliseconds (e.g. 1606505920.2657)
233	68	$this->seconds = Phing::currentTimeMillis();
234		}
235
236	77	if ($this->file !== null) {
237	69	$this->touchFile($this->file);
238		}
239
240	76	$project = $this->getProject();
241	76	foreach ($this->filesets as $fs) {
242	2	$ds = $fs->getDirectoryScanner($project);
243	2	$fromDir = $fs->getDir($project);
244
245	2	$srcFiles = $ds->getIncludedFiles();
246	2	$srcDirs = $ds->getIncludedDirectories();
247
248	2	for ($j = 0, $_j = count($srcFiles); $j < $_j; $j++) {
249	2	foreach ($this->getMappedFileNames((string) $srcFiles[$j]) as $fileName) {
250	2	$this->touchFile(new File($fromDir, $fileName));
251		}
252		}
253
254	2	for ($j = 0, $_j = count($srcDirs); $j < $_j; $j++) {
255		foreach ($this->getMappedFileNames((string) $srcDirs[$j]) as $fileName) {
256		$this->touchFile(new File($fromDir, $fileName));
257		}
258		}
259		}
260
261		// deal with the filelists
262	76	foreach ($this->filelists as $fl) {
263	8	$fromDir = $fl->getDir($this->getProject());
264
265	8	$srcFiles = $fl->getFiles($this->getProject());
266
267	8	for ($j = 0, $_j = count($srcFiles); $j < $_j; $j++) {
268	8	foreach ($this->getMappedFileNames((string) $srcFiles[$j]) as $fileName) {
269	8	$this->touchFile(new File($fromDir, $fileName));
270		}
271		}
272		}
273
274	76	if ($resetSeconds) {
275	67	$this->seconds = -1;
276		}
277	76	}
278
279	10	private function getMappedFileNames($file)
280		{
281	10	if ($this->mapperElement !== null) {
282	2	$mapper = $this->mapperElement->getImplementation();
283	2	$results = $mapper->main($file);
284	2	if ($results === null) {
		0 ignored issues – show introduced 2020-02-09 14:40 UTC by Report Bug Copy Issue Report The condition `$results === null` is always `false`. Loading history...
285		return '';
286		}
287	2	$fileNames = $results;
288		} else {
289	8	$fileNames = [$file];
290		}
291
292	10	return $fileNames;
293		}
294
295		/**
296		* @param File $file
297		* @throws BuildException
298		*/
299	77	private function touchFile(File $file)
300		{
301	77	if (!$file->canWrite()) {
302	1	throw new BuildException("Can not change modification date of read-only file " . (string) $file);
303		}
304	76	$file->setLastModified($this->seconds);
305	76	}
306		}
307

phingofficial / phing

Push — main ( 4889b2...808ce0 )

TouchTask::touch() F

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like