PharDataTask::createFileSet() - Code Metrics - Inspection of "Fix some more inspections" - phingofficial/phing - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( d52b96...e2f758 )

by Michiel

created 2019-08-06 11:49 UTC

PharDataTask::createFileSet() A

↳ Parent: PharDataTask

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	1

Importance

Changes

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

<?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>.
 */

require_once 'phing/tasks/system/MatchingTask.php';

/**
 * Data task for {@link http://php.net/manual/en/class.phardata.php PharData class}.
 *
 * @package phing.tasks.ext
 * @author  Siad Ardroumli <[email protected]>
 */
class PharDataTask extends MatchingTask
{
    /**
     * @var PhingFile
     */
    private $destinationFile;

    /**
     * @var int
     */
    private $compression = Phar::NONE;

    /**
     * Base directory, from where local package paths will be calculated.
     *
     * @var PhingFile
     */
    private $baseDirectory;

    /**
     * @var FileSet[]
     */
    private $filesets = [];

    /**
     * @return FileSet
     */
    public function createFileSet()
    {
        $this->fileset = new FileSet();
        $this->filesets[] = $this->fileset;
        return $this->fileset;
    }

    /**
     * Compression type (gzip, bzip2, none) to apply to the packed files.
     *
     * @param string $compression
     */
    public function setCompression($compression)
    {
        /**
         * If we don't support passed compression, leave old one.
         */
        switch ($compression) {
            case 'gzip':
                $this->compression = Phar::GZ;
                break;
            case 'bzip2':
                $this->compression = Phar::BZ2;
                break;
            default:
                break;
        }
    }

    /**
     * Destination (output) file.
     *
     * @param PhingFile $destinationFile
     */
    public function setDestFile(PhingFile $destinationFile)
    {
        $this->destinationFile = $destinationFile;
    }

    /**
     * Base directory, which will be deleted from each included file (from path).
     * Paths with deleted basedir part are local paths in archive.
     *
     * @param PhingFile $baseDirectory
     */
    public function setBaseDir(PhingFile $baseDirectory)
    {
        $this->baseDirectory = $baseDirectory;
    }

    /**
     * @throws BuildException
     */
    public function main()
    {
        $this->checkPreconditions();

        try {
            $this->log(
                'Building archive: ' . $this->destinationFile->__toString(),
                Project::MSG_INFO
            );

            /**
             * Delete old archive, if exists.
             */
            if ($this->destinationFile->exists()) {
                $isDeleted = $this->destinationFile->delete();
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
                if (!$isDeleted) {

                    $this->log("Could not delete destination file $this->destinationFile", Project::MSG_WARN);
                }
            }

            $pharData = new PharData($this->baseDirectory->getPath() . '/' . $this->destinationFile->getName());

            foreach ($this->filesets as $fileset) {
                $this->log(
                    'Adding specified files in ' . $fileset->getDir($this->project) . ' to archive',
                    Project::MSG_VERBOSE
                );

                $pharData->buildFromIterator($fileset->getIterator(), $fileset->getDir($this->project));
            }

            if ($this->compression !== PHAR::NONE && $pharData->canCompress($this->compression)) {
                try {
                    $pharData->compress($this->compression);
                } catch (UnexpectedValueException $uve) {
                    $pharData->compressFiles($this->compression);
                }

                unset($pharData);
            }
        } catch (Exception $e) {
            throw new BuildException(
                'Problem creating archive: ' . $e->getMessage(),
                $e,
                $this->getLocation()
            );
        }
    }

    /**
     * @throws BuildException
     */
    private function checkPreconditions()
    {
        if (!extension_loaded('phar')) {
            throw new BuildException(
                "PharDataTask require either PHP 5.3 or better or the PECL's Phar extension"
            );
        }

        if (null === $this->destinationFile) {
            throw new BuildException("destfile attribute must be set!", $this->getLocation());
        }

        if ($this->destinationFile->exists() && $this->destinationFile->isDirectory()) {
            throw new BuildException("destfile is a directory!", $this->getLocation());
        }

        if (!$this->destinationFile->canWrite()) {
            throw new BuildException("Can not write to the specified destfile!", $this->getLocation());
        }

        if (null === $this->baseDirectory) {
            throw new BuildException("basedir cattribute must be set", $this->getLocation());
        }

        if (!$this->baseDirectory->exists()) {
            throw new BuildException(
                "basedir '" . (string) $this->baseDirectory . "' does not exist!",
                $this->getLocation()
            );
        }
    }
}


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		require_once 'phing/tasks/system/MatchingTask.php';
21
22		/**
23		* Data task for {@link http://php.net/manual/en/class.phardata.php PharData class}.
24		*
25		* @package phing.tasks.ext
26		* @author Siad Ardroumli <[email protected]>
27		*/
28		class PharDataTask extends MatchingTask
29		{
30		/**
31		* @var PhingFile
32		*/
33		private $destinationFile;
34
35		/**
36		* @var int
37		*/
38		private $compression = Phar::NONE;
39
40		/**
41		* Base directory, from where local package paths will be calculated.
42		*
43		* @var PhingFile
44		*/
45		private $baseDirectory;
46
47		/**
48		* @var FileSet[]
49		*/
50		private $filesets = [];
51
52		/**
53		* @return FileSet
54		*/
55	7	public function createFileSet()
56		{
57	7	$this->fileset = new FileSet();
58	7	$this->filesets[] = $this->fileset;
59	7	return $this->fileset;
60		}
61
62		/**
63		* Compression type (gzip, bzip2, none) to apply to the packed files.
64		*
65		* @param string $compression
66		*/
67	4	public function setCompression($compression)
68		{
69		/**
70		* If we don't support passed compression, leave old one.
71		*/
72	4	switch ($compression) {
73	4	case 'gzip':
74	2	$this->compression = Phar::GZ;
75	2	break;
76	2	case 'bzip2':
77	2	$this->compression = Phar::BZ2;
78	2	break;
79		default:
80		break;
81		}
82	4	}
83
84		/**
85		* Destination (output) file.
86		*
87		* @param PhingFile $destinationFile
88		*/
89	7	public function setDestFile(PhingFile $destinationFile)
90		{
91	7	$this->destinationFile = $destinationFile;
92	7	}
93
94		/**
95		* Base directory, which will be deleted from each included file (from path).
96		* Paths with deleted basedir part are local paths in archive.
97		*
98		* @param PhingFile $baseDirectory
99		*/
100	6	public function setBaseDir(PhingFile $baseDirectory)
101		{
102	6	$this->baseDirectory = $baseDirectory;
103	6	}
104
105		/**
106		* @throws BuildException
107		*/
108	7	public function main()
109		{
110	7	$this->checkPreconditions();
111
112		try {
113	6	$this->log(
114	6	'Building archive: ' . $this->destinationFile->__toString(),
115	6	Project::MSG_INFO
116		);
117
118		/**
119		* Delete old archive, if exists.
120		*/
121	6	if ($this->destinationFile->exists()) {
122		$isDeleted = $this->destinationFile->delete();
		0 ignored issues – show Bug introduced 2019-07-31 09:36 UTC by Report Bug Copy Issue Report Are you sure the assignment to `$isDeleted` is correct as `$this->destinationFile->delete()` targeting `PhingFile::delete()` seems to always return null. This check looks for function or method calls that always return null and whose return value is assigned to a variable. class A { function getObject() { return null; } } $a = new A(); $object = $a->getObject(); The method `getObject()` can return nothing but null, so it makes no sense to assign that value to a variable. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
123		if (!$isDeleted) {
		0 ignored issues – show introduced 2019-07-31 09:36 UTC by Report Bug Copy Issue Report `$isDeleted` is defined implicitly as null, thus it is always evaluated to `false`. Loading history...
124		$this->log("Could not delete destination file $this->destinationFile", Project::MSG_WARN);
125		}
126		}
127
128	6	$pharData = new PharData($this->baseDirectory->getPath() . '/' . $this->destinationFile->getName());
129
130	6	foreach ($this->filesets as $fileset) {
131	6	$this->log(
132	6	'Adding specified files in ' . $fileset->getDir($this->project) . ' to archive',
133	6	Project::MSG_VERBOSE
134		);
135
136	6	$pharData->buildFromIterator($fileset->getIterator(), $fileset->getDir($this->project));
137		}
138
139	6	if ($this->compression !== PHAR::NONE && $pharData->canCompress($this->compression)) {
140		try {
141	4	$pharData->compress($this->compression);
142	2	} catch (UnexpectedValueException $uve) {
143	2	$pharData->compressFiles($this->compression);
144		}
145
146	6	unset($pharData);
147		}
148		} catch (Exception $e) {
149		throw new BuildException(
150		'Problem creating archive: ' . $e->getMessage(),
151		$e,
152		$this->getLocation()
153		);
154		}
155	6	}
156
157		/**
158		* @throws BuildException
159		*/
160	7	private function checkPreconditions()
161		{
162	7	if (!extension_loaded('phar')) {
163		throw new BuildException(
164		"PharDataTask require either PHP 5.3 or better or the PECL's Phar extension"
165		);
166		}
167
168	7	if (null === $this->destinationFile) {
169		throw new BuildException("destfile attribute must be set!", $this->getLocation());
170		}
171
172	7	if ($this->destinationFile->exists() && $this->destinationFile->isDirectory()) {
173		throw new BuildException("destfile is a directory!", $this->getLocation());
174		}
175
176	7	if (!$this->destinationFile->canWrite()) {
177		throw new BuildException("Can not write to the specified destfile!", $this->getLocation());
178		}
179
180	7	if (null === $this->baseDirectory) {
181	1	throw new BuildException("basedir cattribute must be set", $this->getLocation());
182		}
183
184	6	if (!$this->baseDirectory->exists()) {
185		throw new BuildException(
186		"basedir '" . (string) $this->baseDirectory . "' does not exist!",
187		$this->getLocation()
188		);
189		}
190	6	}
191		}
192

phingofficial / phing

Push — master ( d52b96...e2f758 )

PharDataTask::createFileSet() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like