Replace::limit() - Code Metrics - Inspection of "Add a limit to replace via regexp (#946)" - consolidation/robo - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 5d5e6d...30e78d )

by Greg

created 2020-05-22 18:58 UTC

Replace::limit() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	5
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1

<?php

namespace Robo\Task\File;

use Robo\Result;
use Robo\Task\BaseTask;

/**
 * Performs search and replace inside a files.
 *
 * ``` php
 * <?php
 * $this->taskReplaceInFile('VERSION')
 *  ->from('0.2.0')
 *  ->to('0.3.0')
 *  ->run();
 *
 * $this->taskReplaceInFile('README.md')
 *  ->from(date('Y')-1)
 *  ->to(date('Y'))
 *  ->run();
 *
 * $this->taskReplaceInFile('config.yml')
 *  ->regex('~^service:~')
 *  ->to('services:')
 *  ->run();
 *
 * $this->taskReplaceInFile('box/robo.txt')
 *  ->from(array('##dbname##', '##dbhost##'))
 *  ->to(array('robo', 'localhost'))
 *  ->run();
 * ?>
 * ```
 */
class Replace extends BaseTask
{
    /**
     * @var string
     */
    protected $filename;

    /**
     * @var string|string[]
     */
    protected $from;

    /**
     * @var integer
     */
    protected $limit = -1;

    /**
     * @var string|string[]
     */
    protected $to;

    /**
     * @var string
     */
    protected $regex;

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

    /**
     * @param string $filename
     *
     * @return $this
     */
    public function filename($filename)
    {
        $this->filename = $filename;
        return $this;
    }

    /**
     * String(s) to be replaced.
     *
     * @param string|string[] $from
     *
     * @return $this
     */
    public function from($from)
    {
        $this->from = $from;
        return $this;
    }

    /**
     * Value(s) to be set as a replacement.
     *
     * @param string|string[] $to
     *
     * @return $this
     */
    public function to($to)
    {
        $this->to = $to;
        return $this;
    }

    /**
     * Regex to match string to be replaced.
     *
     * @param string $regex
     *
     * @return $this
     */
    public function regex($regex)
    {
        $this->regex = $regex;
        return $this;
    }

    /**
     * If used with $this->regexp() how many counts will be replaced
     *
     * @param int $limit
     *
     * @return $this
     */
    public function limit($limit)
    {
        $this->limit = $limit;
        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function run()
    {
        if (!file_exists($this->filename)) {

            $this->printTaskError('File {filename} does not exist', ['filename' => $this->filename]);
            return false;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
        }

        $text = file_get_contents($this->filename);
        if ($this->regex) {
            $text = preg_replace($this->regex, $this->to, $text, $this->limit, $count);
        } else {
            $text = str_replace($this->from, $this->to, $text, $count);
        }
        if ($count > 0) {
            $res = file_put_contents($this->filename, $text);
            if ($res === false) {
                return Result::error($this, "Error writing to file {filename}.", ['filename' => $this->filename]);
            }
            $this->printTaskSuccess("{filename} updated. {count} items replaced", ['filename' => $this->filename, 'count' => $count]);
        } else {
            $this->printTaskInfo("{filename} unchanged. {count} items replaced", ['filename' => $this->filename, 'count' => $count]);
        }
        return Result::success($this, '', ['replaced' => $count]);
    }
}


1		<?php
2
3		namespace Robo\Task\File;
4
5		use Robo\Result;
6		use Robo\Task\BaseTask;
7
8		/**
9		* Performs search and replace inside a files.
10		*
11		* ``` php
12		* <?php
13		* $this->taskReplaceInFile('VERSION')
14		* ->from('0.2.0')
15		* ->to('0.3.0')
16		* ->run();
17		*
18		* $this->taskReplaceInFile('README.md')
19		* ->from(date('Y')-1)
20		* ->to(date('Y'))
21		* ->run();
22		*
23		* $this->taskReplaceInFile('config.yml')
24		* ->regex('~^service:~')
25		* ->to('services:')
26		* ->run();
27		*
28		* $this->taskReplaceInFile('box/robo.txt')
29		* ->from(array('##dbname##', '##dbhost##'))
30		* ->to(array('robo', 'localhost'))
31		* ->run();
32		* ?>
33		* ```
34		*/
35		class Replace extends BaseTask
36		{
37		/**
38		* @var string
39		*/
40		protected $filename;
41
42		/**
43		* @var string\|string[]
44		*/
45		protected $from;
46
47		/**
48		* @var integer
49		*/
50		protected $limit = -1;
51
52		/**
53		* @var string\|string[]
54		*/
55		protected $to;
56
57		/**
58		* @var string
59		*/
60		protected $regex;
61
62		/**
63		* @param string $filename
64		*/
65		public function __construct($filename)
66		{
67		$this->filename = $filename;
68		}
69
70		/**
71		* @param string $filename
72		*
73		* @return $this
74		*/
75		public function filename($filename)
76		{
77		$this->filename = $filename;
78		return $this;
79		}
80
81		/**
82		* String(s) to be replaced.
83		*
84		* @param string\|string[] $from
85		*
86		* @return $this
87		*/
88		public function from($from)
89		{
90		$this->from = $from;
91		return $this;
92		}
93
94		/**
95		* Value(s) to be set as a replacement.
96		*
97		* @param string\|string[] $to
98		*
99		* @return $this
100		*/
101		public function to($to)
102		{
103		$this->to = $to;
104		return $this;
105		}
106
107		/**
108		* Regex to match string to be replaced.
109		*
110		* @param string $regex
111		*
112		* @return $this
113		*/
114		public function regex($regex)
115		{
116		$this->regex = $regex;
117		return $this;
118		}
119
120		/**
121		* If used with $this->regexp() how many counts will be replaced
122		*
123		* @param int $limit
124		*
125		* @return $this
126		*/
127		public function limit($limit)
128		{
129		$this->limit = $limit;
130		return $this;
131		}
132
133		/**
134		* {@inheritdoc}
135		*/
136		public function run()
137		{
138	View Code Duplication	if (!file_exists($this->filename)) {
		0 ignored issues – show Duplication introduced 2016-09-13 23:40 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
139		$this->printTaskError('File {filename} does not exist', ['filename' => $this->filename]);
140		return false;
		0 ignored issues – show Bug Best Practice introduced 2016-09-13 23:40 UTC by Report Bug Copy Issue Report The return type of `return false;` (`false`) is incompatible with the return type declared by the interface `Robo\Contract\TaskInterface::run` of type `Robo\Result`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
141		}
142
143		$text = file_get_contents($this->filename);
144		if ($this->regex) {
145		$text = preg_replace($this->regex, $this->to, $text, $this->limit, $count);
146		} else {
147		$text = str_replace($this->from, $this->to, $text, $count);
148		}
149		if ($count > 0) {
150		$res = file_put_contents($this->filename, $text);
151		if ($res === false) {
152		return Result::error($this, "Error writing to file {filename}.", ['filename' => $this->filename]);
153		}
154		$this->printTaskSuccess("{filename} updated. {count} items replaced", ['filename' => $this->filename, 'count' => $count]);
155		} else {
156		$this->printTaskInfo("{filename} unchanged. {count} items replaced", ['filename' => $this->filename, 'count' => $count]);
157		}
158		return Result::success($this, '', ['replaced' => $count]);
159		}
160		}
161

consolidation / robo

Push — master ( 5d5e6d...30e78d )

Replace::limit() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like