ReplaceRegexpTask::setFile() - Code Metrics - Inspection of "[core] Added additional tests (#1592)" - phingofficial/phing - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — main ( f8c128...609b6a )

by Siad
created 2021-04-24 22:57 UTC
ReplaceRegexpTask::setFile() A

↳ Parent: ReplaceRegexpTask
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	2
CRAP Score	1
Importance

Changes
Metric	Value
eloc	1
dl	0
loc	3
ccs	2
cts	2
cp	1
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1
crap	1
<?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 Exception;
use Phing\Exception\BuildException;
use Phing\Filter\ReplaceRegexp;
use Phing\Io\File;
use Phing\Io\FileReader;
use Phing\Io\FileUtils;
use Phing\Io\FileWriter;
use Phing\Project;
use Phing\Task;
use Phing\Type\Element\FileSetAware;
use Phing\Type\FilterChain;
use Phing\Type\RegularExpression;

/**
 * ReplaceRegExp is a directory based task for replacing the occurrence of a
 * given regular expression with a substitution pattern in a selected file or
 * set of files.
 *
 * <code>
 * <replaceregexp file="${src}/build.properties"
 *                        match="OldProperty=(.*)"
 *                        replace="NewProperty=\1"
 *                        byline="true"/>
 * </code>
 *
 * @author Jonathan Bond-Caron <[email protected]>
 *
 * @see http://ant.apache.org/manual/OptionalTasks/replaceregexp.html
 */
class ReplaceRegexpTask extends Task
{
    use FileSetAware;

    /**
     * Single file to process.
     */
    private $file;

    /**
     * Regular expression.
     *
     * @var RegularExpression
     */
    private $regexp;

    /**
     * File to apply regexp on.
     */
    public function setFile(File $path)
    {
        $this->file = $path;
    }

    /**
     * Sets the regexp match pattern.
     *
     * @param string $regexp
     */
    public function setMatch($regexp)
    {
        $this->regexp->setPattern($regexp);
    }

    /**
     * @param string $regexp
     *
     * @see setMatch()
     */
    public function setPattern($regexp)
    {
        $this->setMatch($regexp);
    }

    /**
     * Sets the replacement string.
     *
     * @param string $string
     */
    public function setReplace($string)
    {
        $this->regexp->setReplace($string);
    }

    /**
     * Sets the regexp flags.
     *
     * @param string $flags
     */
    public function setFlags($flags)
    public function setFlags(/** @scrutinizer ignore-unused */ $flags)
    {
    }

    /**
     * Match only per line.
     *
     * @param bool $yesNo
     */
    public function setByline($yesNo)
    public function setByline(/** @scrutinizer ignore-unused */ $yesNo)
    {
        // TODO... $this->_regexp->
    }

    /**
     * {@inheritdoc}
     */
    public function init()
    {
        $this->regexp = new RegularExpression();
    }

    /**
     * {@inheritdoc}
     *
     * @throws BuildException
     */
    public function main()
    {
        if (null === $this->file && empty($this->filesets)) {
            throw new BuildException('You must specify a file or fileset(s) for the <ReplaceRegexp> task.');
        }

        // compile a list of all files to modify, both file attrib and fileset elements
        // can be used.
        $files = [];

        if (null !== $this->file) {
            $files[] = $this->file;
        }

        if (!empty($this->filesets)) {
            $filenames = [];

            foreach ($this->filesets as $fs) {
                try {
                    $ds = $fs->getDirectoryScanner($this->project);
                    $filenames = $ds->getIncludedFiles(); // get included filenames
                    $dir = $fs->getDir($this->project);
                    foreach ($filenames as $fname) {
                        $files[] = new File($dir, $fname);
                    }
                } catch (BuildException $be) {
                    $this->log($be->getMessage(), Project::MSG_WARN);
                }
            }
        }

        $this->log('Applying Regexp processing to ' . count($files) . ' files.');

        // These "slots" allow filters to retrieve information about the currently-being-process files
        $slot = $this->getRegisterSlot('currentFile');
        $basenameSlot = $this->getRegisterSlot('currentFile.basename');

        $filter = new FilterChain($this->project);

        $r = new ReplaceRegexp();
        $r->setRegexps([$this->regexp]);

        $filter->addReplaceRegexp($r);
        $filters = [$filter];

        foreach ($files as $file) {
            // set the register slots

            $slot->setValue($file->getPath());
            $basenameSlot->setValue($file->getName());

            // 1) read contents of file, pulling through any filters
            $in = null;

            $out = null;

            $contents = '';

            try {
                $in = FileUtils::getChainedReader(new FileReader($file), $filters, $this->project);
                while (-1 !== ($buffer = $in->read())) {
                    $contents .= $buffer;
                }
                $in->close();
            } catch (Exception $e) {
                if ($in) {
                    $in->close();
                }
                $this->log('Error reading file: ' . $e->getMessage(), Project::MSG_WARN);
            }

            try {
                // now create a FileWriter w/ the same file, and write to the file
                $out = new FileWriter($file);
                $out->write($contents);
                $out->close();
                $this->log('Applying regexp processing to ' . $file->getPath(), Project::MSG_VERBOSE);
            } catch (Exception $e) {
                if ($out) {
                    $out->close();
                }
                $this->log('Error writing file back: ' . $e->getMessage(), Project::MSG_WARN);
            }
        }
    }
}

phingofficial / phing

Push — main ( f8c128...609b6a )

ReplaceRegexpTask::setFile() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
