Swift_CharacterStream_NgCharacterStream - Code Metrics - Inspection of "[!]: try to fix bug #644 | https://github.com/swif..." - voku/swiftmailer - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 5.x ( 546220...bd8586 )

by Lars

created 2016-05-28 10:09 UTC

Swift_CharacterStream_NgCharacterStream A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	271
Duplicated Lines	3.32 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

84.27%

Importance

Changes	8
Bugs	1	Features	0

Metric	Value
c	8
b	1
f	0
dl	9
loc	271
ccs	75
cts	89
cp	0.8427
rs	10
wmc	28
lcom	1
cbo	3

11 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	setCharacterSet()	0	10	2
A	setCharacterReaderFactory()	0	4	1
A	flushContents()	0	8	1
A	importByteStream()	9	10	2
A	importString()	0	5	1
C	read()	0	52	12
A	readBytes()	0	9	2
A	setPointer()	0	7	2
A	setCharReaderForCurrentCharset()	0	8	2
A	write()	0	19	2

How to fix Duplicated Code

<?php

/*
 * This file is part of SwiftMailer.
 * (c) 2004-2009 Chris Corbyn
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

/**
 * A CharacterStream implementation which stores characters in an internal array.
 *
 * @author Xavier De Cock <[email protected]>
 */
class Swift_CharacterStream_NgCharacterStream implements Swift_CharacterStream
namespace YourVendor;

class YourClass { }
{
    /**
     * The char reader (lazy-loaded) for the current charset.
     *
     * @var Swift_CharacterReader
     */
    private $_charReader;

    /**
     * A factory for creating CharacterReader instances.
     *
     * @var Swift_CharacterReaderFactory
     */
    private $_charReaderFactory;

    /**
     * The character set this stream is using.
     *
     * @var string
     */
    private $_charset;

    /**
     * The data's stored as-is.
     *
     * @var string
     */
    private $_datas = '';

    /**
     * Number of bytes in the stream.
     *
     * @var int
     */
    private $_datasSize = 0;

    /**
     * Map.
     *
     * @var mixed
     */
    private $_map;

    /**
     * Map Type.
     *
     * @var int
     */
    private $_mapType = 0;

    /**
     * Number of characters in the stream.
     *
     * @var int
     */
    private $_charCount = 0;

    /**
     * Position in the stream.
     *
     * @var int
     */
    private $_currentPos = 0;

    /**
     * Constructor.
     *
     * @param Swift_CharacterReaderFactory $factory
     * @param string                       $charset
     */
    public function __construct(Swift_CharacterReaderFactory $factory, $charset)
    {
        $this->setCharacterReaderFactory($factory);
        $this->setCharacterSet($charset);
    }

    /* -- Changing parameters of the stream -- */

    /**
     * Set the character set used in this CharacterStream.
     *
     * @param string $charset
     */
    public function setCharacterSet($charset)
    {
        if ($charset) {
            $this->_charset = $charset;
            $this->_charReader = null;
            $this->_mapType = 0;

            $this->setCharReaderForCurrentCharset();
        }
    }

    /**
     * Set the CharacterReaderFactory for multi charset support.
     *
     * @param Swift_CharacterReaderFactory $factory
     */
    public function setCharacterReaderFactory(Swift_CharacterReaderFactory $factory)
    {
        $this->_charReaderFactory = $factory;
    }

    /**
     * @see Swift_CharacterStream::flushContents()
     */
    public function flushContents()
    {
        $this->_datas = null;
        $this->_map = null;
        $this->_charCount = 0;
        $this->_currentPos = 0;
        $this->_datasSize = 0;
    }

    /**
     * @see Swift_CharacterStream::importByteStream()
     *
     * @param Swift_OutputByteStream $os
     */
    public function importByteStream(Swift_OutputByteStream $os)

    {
        $this->flushContents();
        $blocks = 512;
        $os->setReadPointer(0);
        
        while (false !== ($read = $os->read($blocks))) {
            $this->write($read);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
        }
    }

    /**
     * @see Swift_CharacterStream::importString()
     *
     * @param string $string
     */
    public function importString($string)
    {
        $this->flushContents();
        $this->write($string);
    }

    /**
     * @see Swift_CharacterStream::read()
     *
     * @param int $length
     *
     * @return string|false false on error
     */
    public function read($length)
    {
        if ($this->_currentPos >= $this->_charCount) {
            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());
}
        }

        $ret = false;

        $length = $this->_currentPos + $length > $this->_charCount ? $this->_charCount - $this->_currentPos : $length;
        switch ($this->_mapType) {
            case Swift_CharacterReader::MAP_TYPE_FIXED_LEN:
                $len = $length * $this->_map;
                $ret = substr($this->_datas, $this->_currentPos * $this->_map, $len);
                $this->_currentPos += $length;
                break;

            case Swift_CharacterReader::MAP_TYPE_INVALID:
                $ret = '';
                for (; $this->_currentPos < $length; ++$this->_currentPos) {
                    if (isset($this->_map[$this->_currentPos])) {
                        $ret .= '?';
                    } else {
                        $ret .= $this->_datas[$this->_currentPos];
                    }
                }
                break;

            case Swift_CharacterReader::MAP_TYPE_POSITIONS:
                $end = $this->_currentPos + $length;
                $end = $end > $this->_charCount ? $this->_charCount : $end;
                $ret = '';

                $start = 0;
                if ($this->_currentPos > 0) {
                    $start = $this->_map['p'][$this->_currentPos - 1];
                }

                $to = $start;
                for (; $this->_currentPos < $end; ++$this->_currentPos) {
                    if (isset($this->_map['i'], $this->_map['i'][$this->_currentPos])) {
                        $ret .= substr($this->_datas, $start, $to - $start) . '?';
                        $start = $this->_map['p'][$this->_currentPos];
                    } else {
                        $to = $this->_map['p'][$this->_currentPos];
                    }
                }

                $ret .= substr($this->_datas, $start, $to - $start);
                break;
        }

        return $ret;
    }

    /**
     * @see Swift_CharacterStream::readBytes()
     *
     * @param int $length
     *
     * @return int[]|false false on error
     */
    public function readBytes($length)
    {
        $read = $this->read($length);
        if ($read !== false) {
            return array_map('ord', str_split($read, 1));
        }

        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());
}
    }

    /**
     * @see Swift_CharacterStream::setPointer()
     *
     * @param int $charOffset
     */
    public function setPointer($charOffset)
    {
        if ($this->_charCount < $charOffset) {
            $charOffset = $this->_charCount;
        }
        $this->_currentPos = $charOffset;
    }

    /**
     * Set the char-reader for the current charset.
     */
    private function setCharReaderForCurrentCharset()
    {
        if (null === $this->_charReader) {
            $this->_charReader = $this->_charReaderFactory->getReaderFor($this->_charset);
            $this->_map = array();
            $this->_mapType = $this->_charReader->getMapType();
        }
    }

    /**
     * @see Swift_CharacterStream::write()
     *
     * @param string $chars
     */
    public function write($chars)
    {
        $this->setCharReaderForCurrentCharset();

        $ignored = '';
        $this->_datas .= $chars;
        $this->_charCount += $this->_charReader->getCharPositions(
            substr($this->_datas, $this->_datasSize),
            $this->_datasSize,
            $this->_map,
            $ignored
        );

        if ($ignored !== false) {
            $this->_datasSize = strlen($this->_datas) - strlen($ignored);
        } else {
            $this->_datasSize = strlen($this->_datas);
        }
    }
}


1			<?php
2
3			/*
4			* This file is part of SwiftMailer.
5			* (c) 2004-2009 Chris Corbyn
6			*
7			* For the full copyright and license information, please view the LICENSE
8			* file that was distributed with this source code.
9			*/
10
11			/**
12			* A CharacterStream implementation which stores characters in an internal array.
13			*
14			* @author Xavier De Cock <[email protected]>
15			*/
16			class Swift_CharacterStream_NgCharacterStream implements Swift_CharacterStream
			0 ignored issues – show Coding Style Compatibility introduced 2015-11-22 11:38 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
17			{
18			/**
19			* The char reader (lazy-loaded) for the current charset.
20			*
21			* @var Swift_CharacterReader
22			*/
23			private $_charReader;
24
25			/**
26			* A factory for creating CharacterReader instances.
27			*
28			* @var Swift_CharacterReaderFactory
29			*/
30			private $_charReaderFactory;
31
32			/**
33			* The character set this stream is using.
34			*
35			* @var string
36			*/
37			private $_charset;
38
39			/**
40			* The data's stored as-is.
41			*
42			* @var string
43			*/
44			private $_datas = '';
45
46			/**
47			* Number of bytes in the stream.
48			*
49			* @var int
50			*/
51			private $_datasSize = 0;
52
53			/**
54			* Map.
55			*
56			* @var mixed
57			*/
58			private $_map;
59
60			/**
61			* Map Type.
62			*
63			* @var int
64			*/
65			private $_mapType = 0;
66
67			/**
68			* Number of characters in the stream.
69			*
70			* @var int
71			*/
72			private $_charCount = 0;
73
74			/**
75			* Position in the stream.
76			*
77			* @var int
78			*/
79			private $_currentPos = 0;
80
81			/**
82			* Constructor.
83			*
84			* @param Swift_CharacterReaderFactory $factory
85			* @param string $charset
86			*/
87	3		public function __construct(Swift_CharacterReaderFactory $factory, $charset)
88			{
89	3		$this->setCharacterReaderFactory($factory);
90	3		$this->setCharacterSet($charset);
91	3		}
92
93			/* -- Changing parameters of the stream -- */
94
95			/**
96			* Set the character set used in this CharacterStream.
97			*
98			* @param string $charset
99			*/
100	3		public function setCharacterSet($charset)
101			{
102	3		if ($charset) {
103	3		$this->_charset = $charset;
104	3		$this->_charReader = null;
105	3		$this->_mapType = 0;
106
107			$this->setCharReaderForCurrentCharset();
108			}
109			}
110
111			/**
112	3		* Set the CharacterReaderFactory for multi charset support.
113			*
114	3		* @param Swift_CharacterReaderFactory $factory
115	3		*/
116			public function setCharacterReaderFactory(Swift_CharacterReaderFactory $factory)
117			{
118			$this->_charReaderFactory = $factory;
119			}
120	3
121			/**
122	3		* @see Swift_CharacterStream::flushContents()
123	3		*/
124	3		public function flushContents()
125	3		{
126	3		$this->_datas = null;
127	3		$this->_map = null;
128			$this->_charCount = 0;
129			$this->_currentPos = 0;
130			$this->_datasSize = 0;
131			}
132
133			/**
134	2		* @see Swift_CharacterStream::importByteStream()
135			*
136	2		* @param Swift_OutputByteStream $os
137	2		*/
138	2	View Code Duplication	public function importByteStream(Swift_OutputByteStream $os)
			0 ignored issues – show Duplication introduced 2015-11-22 11:38 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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	2		{
140	2		$this->flushContents();
141			$blocks = 512;
142	2		$os->setReadPointer(0);
143
144			while (false !== ($read = $os->read($blocks))) {
145			$this->write($read);
			0 ignored issues – show Bug introduced 2016-02-10 17:04 UTC by Report Bug Copy Issue Report It seems like `$read` defined by `$os->read($blocks)` on line `144` can also be of type `boolean`; however, `Swift_CharacterStream_NgCharacterStream::write()` does only seem to accept `string`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
146			}
147			}
148
149	1		/**
150			* @see Swift_CharacterStream::importString()
151	1		*
152	1		* @param string $string
153	1		*/
154			public function importString($string)
155			{
156			$this->flushContents();
157			$this->write($string);
158			}
159
160			/**
161			* @see Swift_CharacterStream::read()
162	3		*
163			* @param int $length
164	3		*
165	3		* @return string\|false false on error
166			*/
167			public function read($length)
168	3		{
169	3		if ($this->_currentPos >= $this->_charCount) {
170	3		return false;
			0 ignored issues – show Bug Best Practice introduced 2015-11-22 11:38 UTC by Report Bug Copy Issue Report The return type of `return false;` (`false`) is incompatible with the return type declared by the interface `Swift_CharacterStream::read` of type `string`. 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...
171	3		}
172	1
173	1		$ret = false;
			0 ignored issues – show Comprehensibility Best Practice introduced 2016-02-10 17:04 UTC by Report Bug Copy Issue Report The expression `false;` of type `false` adds `false` to the return on line 217 which is incompatible with the return type declared by the interface `Swift_CharacterStream::read` of type `string`. It seems like you forgot to handle an error condition. Loading history...
174	1		$length = $this->_currentPos + $length > $this->_charCount ? $this->_charCount - $this->_currentPos : $length;
175	1		switch ($this->_mapType) {
176			case Swift_CharacterReader::MAP_TYPE_FIXED_LEN:
177	3		$len = $length * $this->_map;
178			$ret = substr($this->_datas, $this->_currentPos * $this->_map, $len);
179			$this->_currentPos += $length;
180			break;
181
182			case Swift_CharacterReader::MAP_TYPE_INVALID:
183			$ret = '';
184			for (; $this->_currentPos < $length; ++$this->_currentPos) {
185			if (isset($this->_map[$this->_currentPos])) {
186			$ret .= '?';
187			} else {
188	3		$ret .= $this->_datas[$this->_currentPos];
189	3		}
190	3		}
191	3		break;
192
193	3		case Swift_CharacterReader::MAP_TYPE_POSITIONS:
194	3		$end = $this->_currentPos + $length;
195	3		$end = $end > $this->_charCount ? $this->_charCount : $end;
196			$ret = '';
197
198	3		$start = 0;
199	3		if ($this->_currentPos > 0) {
200	3		$start = $this->_map['p'][$this->_currentPos - 1];
201			}
202
203			$to = $start;
204	3		for (; $this->_currentPos < $end; ++$this->_currentPos) {
205			if (isset($this->_map['i'], $this->_map['i'][$this->_currentPos])) {
206			$ret .= substr($this->_datas, $start, $to - $start) . '?';
207			$start = $this->_map['p'][$this->_currentPos];
208	3		} else {
209	3		$to = $this->_map['p'][$this->_currentPos];
210			}
211			}
212	3
213			$ret .= substr($this->_datas, $start, $to - $start);
214			break;
215			}
216
217			return $ret;
218			}
219
220			/**
221			* @see Swift_CharacterStream::readBytes()
222	3		*
223			* @param int $length
224	3		*
225	3		* @return int[]\|false false on error
226	3		*/
227			public function readBytes($length)
228			{
229	3		$read = $this->read($length);
230			if ($read !== false) {
231			return array_map('ord', str_split($read, 1));
232			}
233
234			return false;
			0 ignored issues – show Bug Best Practice introduced 2015-11-22 11:38 UTC by Report Bug Copy Issue Report The return type of `return false;` (`false`) is incompatible with the return type declared by the interface `Swift_CharacterStream::readBytes` of type `integer[]`. 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...
235			}
236
237			/**
238			* @see Swift_CharacterStream::setPointer()
239			*
240			* @param int $charOffset
241			*/
242			public function setPointer($charOffset)
243			{
244			if ($this->_charCount < $charOffset) {
245			$charOffset = $this->_charCount;
246			}
247			$this->_currentPos = $charOffset;
248			}
249
250	3		/**
251			* Set the char-reader for the current charset.
252	3		*/
253	3		private function setCharReaderForCurrentCharset()
254	3		{
255	3		if (null === $this->_charReader) {
256			$this->_charReader = $this->_charReaderFactory->getReaderFor($this->_charset);
257			$this->_map = array();
258	3		$this->_mapType = $this->_charReader->getMapType();
259	3		}
260	3		}
261	3
262	3		/**
263	3		* @see Swift_CharacterStream::write()
264			*
265			* @param string $chars
266			*/
267	3		public function write($chars)
268	3		{
269			$this->setCharReaderForCurrentCharset();
270
271			$ignored = '';
272	3		$this->_datas .= $chars;
273			$this->_charCount += $this->_charReader->getCharPositions(
274			substr($this->_datas, $this->_datasSize),
275			$this->_datasSize,
276			$this->_map,
277			$ignored
278			);
279
280			if ($ignored !== false) {
281			$this->_datasSize = strlen($this->_datas) - strlen($ignored);
282			} else {
283			$this->_datasSize = strlen($this->_datas);
284			}
285			}
286			}
287

voku / swiftmailer

Push — 5.x ( 546220...bd8586 )

Swift_CharacterStream_NgCharacterStream A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

11 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like