LocalStream - Code Metrics - Inspection of "Move Local adapter into his own namespace" - KnpLabs/Gaufrette - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#433)

by Albin

created 2016-11-16 21:30 UTC

LocalStream A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	176
Duplicated Lines	100 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

Metric	Value
wmc	32
lcom	1
cbo	2
dl	176
loc	176
rs	9.6
c	0
b	0
f	0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	4	4	1
B	open()	21	21	5
A	read()	12	12	3
A	write()	12	12	3
A	close()	15	15	3
A	flush()	8	8	2
A	seek()	8	8	2
A	tell()	8	8	2
A	eof()	8	8	2
A	stat()	10	10	4
A	cast()	8	8	2
A	unlink()	8	8	3

How to fix Duplicated Code

<?php

namespace Gaufrette\Adapter\Local;

use Gaufrette\Stream;
use Gaufrette\StreamMode;

/**
 * Local stream.
 *
 * @author Antoine Hérault <[email protected]>
 */
class LocalStream implements Stream

{
    private $path;
    private $mode;
    private $fileHandle;

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

    /**
     * {@inheritdoc}
     */
    public function open(StreamMode $mode)
    {
        $baseDirPath = \Gaufrette\Util\Path::dirname($this->path);
        if ($mode->allowsWrite() && !is_dir($baseDirPath)) {
            @mkdir($baseDirPath, 0755, true);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
        }
        try {
            $fileHandle = @fopen($this->path, $mode->getMode());
        } catch (\Exception $e) {
            $fileHandle = false;
        }

        if (false === $fileHandle) {
            throw new \RuntimeException(sprintf('File "%s" cannot be opened', $this->path));
        }

        $this->mode = $mode;
        $this->fileHandle = $fileHandle;

        return true;
    }

    /**
     * {@inheritdoc}
     */
    public function read($count)
    {
        if (!$this->fileHandle) {
            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());
}
        }

        if (false === $this->mode->allowsRead()) {
            throw new \LogicException('The stream does not allow read.');
        }

        return fread($this->fileHandle, $count);
    }

    /**
     * {@inheritdoc}
     */
    public function write($data)
    {
        if (!$this->fileHandle) {
            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());
}
        }

        if (false === $this->mode->allowsWrite()) {
            throw new \LogicException('The stream does not allow write.');
        }

        return fwrite($this->fileHandle, $data);
    }

    /**
     * {@inheritdoc}
     */
    public function close()
    {
        if (!$this->fileHandle) {
            return false;
        }

        $closed = fclose($this->fileHandle);

        if ($closed) {
            $this->mode = null;
            $this->fileHandle = null;
        }

        return $closed;
    }

    /**
     * {@inheritdoc}
     */
    public function flush()
    {
        if ($this->fileHandle) {
            return fflush($this->fileHandle);
        }

        return false;
    }

    /**
     * {@inheritdoc}
     */
    public function seek($offset, $whence = SEEK_SET)
    {
        if ($this->fileHandle) {
            return 0 === fseek($this->fileHandle, $offset, $whence);
        }

        return false;
    }

    /**
     * {@inheritdoc}
     */
    public function tell()
    {
        if ($this->fileHandle) {
            return ftell($this->fileHandle);
        }

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

    /**
     * {@inheritdoc}
     */
    public function eof()
    {
        if ($this->fileHandle) {
            return feof($this->fileHandle);
        }

        return true;
    }

    /**
     * {@inheritdoc}
     */
    public function stat()
    {
        if ($this->fileHandle) {
            return fstat($this->fileHandle);
        } elseif (!is_resource($this->fileHandle) && is_dir($this->path)) {
            return stat($this->path);
        }

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

    /**
     * {@inheritdoc}
     */
    public function cast($castAs)
    {
        if ($this->fileHandle) {
            return $this->fileHandle;
        }

        return false;
    }

    /**
     * {@inheritdoc}
     */
    public function unlink()
    {
        if ($this->mode && $this->mode->impliesExistingContentDeletion()) {
            return @unlink($this->path);
        }

        return false;
    }
}


1		<?php
2
3		namespace Gaufrette\Adapter\Local;
4
5		use Gaufrette\Stream;
6		use Gaufrette\StreamMode;
7
8		/**
9		* Local stream.
10		*
11		* @author Antoine Hérault <[email protected]>
12		*/
13	View Code Duplication	class LocalStream implements Stream
		0 ignored issues – show Duplication introduced 2016-11-16 21:41 UTC by Report Bug Copy Issue Report This class 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...
14		{
15		private $path;
16		private $mode;
17		private $fileHandle;
18
19		/**
20		* @param string $path
21		*/
22		public function __construct($path)
23		{
24		$this->path = $path;
25		}
26
27		/**
28		* {@inheritdoc}
29		*/
30		public function open(StreamMode $mode)
31		{
32		$baseDirPath = \Gaufrette\Util\Path::dirname($this->path);
33		if ($mode->allowsWrite() && !is_dir($baseDirPath)) {
34		@mkdir($baseDirPath, 0755, true);
		0 ignored issues – show Security Best Practice introduced 2016-11-16 21:41 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
35		}
36		try {
37		$fileHandle = @fopen($this->path, $mode->getMode());
38		} catch (\Exception $e) {
39		$fileHandle = false;
40		}
41
42		if (false === $fileHandle) {
43		throw new \RuntimeException(sprintf('File "%s" cannot be opened', $this->path));
44		}
45
46		$this->mode = $mode;
47		$this->fileHandle = $fileHandle;
48
49		return true;
50		}
51
52		/**
53		* {@inheritdoc}
54		*/
55		public function read($count)
56		{
57		if (!$this->fileHandle) {
58		return false;
		0 ignored issues – show Bug Best Practice introduced 2016-11-16 21:41 UTC by Report Bug Copy Issue Report The return type of `return false;` (`false`) is incompatible with the return type declared by the interface `Gaufrette\Stream::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...
59		}
60
61		if (false === $this->mode->allowsRead()) {
62		throw new \LogicException('The stream does not allow read.');
63		}
64
65		return fread($this->fileHandle, $count);
66		}
67
68		/**
69		* {@inheritdoc}
70		*/
71		public function write($data)
72		{
73		if (!$this->fileHandle) {
74		return false;
		0 ignored issues – show Bug Best Practice introduced 2016-11-16 21:41 UTC by Report Bug Copy Issue Report The return type of `return false;` (`false`) is incompatible with the return type declared by the interface `Gaufrette\Stream::write` 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...
75		}
76
77		if (false === $this->mode->allowsWrite()) {
78		throw new \LogicException('The stream does not allow write.');
79		}
80
81		return fwrite($this->fileHandle, $data);
82		}
83
84		/**
85		* {@inheritdoc}
86		*/
87		public function close()
88		{
89		if (!$this->fileHandle) {
90		return false;
91		}
92
93		$closed = fclose($this->fileHandle);
94
95		if ($closed) {
96		$this->mode = null;
97		$this->fileHandle = null;
98		}
99
100		return $closed;
101		}
102
103		/**
104		* {@inheritdoc}
105		*/
106		public function flush()
107		{
108		if ($this->fileHandle) {
109		return fflush($this->fileHandle);
110		}
111
112		return false;
113		}
114
115		/**
116		* {@inheritdoc}
117		*/
118		public function seek($offset, $whence = SEEK_SET)
119		{
120		if ($this->fileHandle) {
121		return 0 === fseek($this->fileHandle, $offset, $whence);
122		}
123
124		return false;
125		}
126
127		/**
128		* {@inheritdoc}
129		*/
130		public function tell()
131		{
132		if ($this->fileHandle) {
133		return ftell($this->fileHandle);
134		}
135
136		return false;
		0 ignored issues – show Bug Best Practice introduced 2016-11-16 21:41 UTC by Report Bug Copy Issue Report The return type of `return false;` (`false`) is incompatible with the return type declared by the interface `Gaufrette\Stream::tell` 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...
137		}
138
139		/**
140		* {@inheritdoc}
141		*/
142		public function eof()
143		{
144		if ($this->fileHandle) {
145		return feof($this->fileHandle);
146		}
147
148		return true;
149		}
150
151		/**
152		* {@inheritdoc}
153		*/
154		public function stat()
155		{
156		if ($this->fileHandle) {
157		return fstat($this->fileHandle);
158		} elseif (!is_resource($this->fileHandle) && is_dir($this->path)) {
159		return stat($this->path);
160		}
161
162		return false;
		0 ignored issues – show Bug Best Practice introduced 2016-11-16 21:41 UTC by Report Bug Copy Issue Report The return type of `return false;` (`false`) is incompatible with the return type declared by the interface `Gaufrette\Stream::stat` of type `array`. 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...
163		}
164
165		/**
166		* {@inheritdoc}
167		*/
168		public function cast($castAs)
169		{
170		if ($this->fileHandle) {
171		return $this->fileHandle;
172		}
173
174		return false;
175		}
176
177		/**
178		* {@inheritdoc}
179		*/
180		public function unlink()
181		{
182		if ($this->mode && $this->mode->impliesExistingContentDeletion()) {
183		return @unlink($this->path);
184		}
185
186		return false;
187		}
188		}
189

KnpLabs / Gaufrette

Pull Request — master (#433)

LocalStream A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

12 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like