NativeWriteStream - Code Metrics - Inspection of "all the types" - icewind1991/SMB - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 78b032...4251cd )

by Robin

created 2021-03-09 19:14 UTC

NativeWriteStream A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	92
Duplicated Lines	27.17 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

88.89%

Importance

Changes

Metric	Value
wmc	15
lcom	1
cbo	3
dl	25
loc	92
ccs	40
cts	45
cp	0.8889
rs	10
c	0
b	0
f	0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	stream_open()	0	3	1
A	wrap()	13	13	1
A	stream_seek()	12	12	3
A	flushWrite()	0	3	1
A	stream_write()	0	10	2
A	stream_close()	0	9	3
A	stream_tell()	0	3	1
A	stream_read()	0	3	1
A	stream_truncate()	0	5	1

How to fix Duplicated Code

<?php
/**
 * Copyright (c) 2014 Robin Appelman <[email protected]>
 * This file is licensed under the Licensed under the MIT license:
 * http://opensource.org/licenses/MIT
 */

namespace Icewind\SMB\Native;

use Icewind\SMB\StringBuffer;

/**
 * Stream optimized for write only usage
 */
class NativeWriteStream extends NativeStream {
	const CHUNK_SIZE = 1048576; // 1MB chunks

	/** @var StringBuffer */
	private $writeBuffer;

	/** @var int */
	private $pos = 0;

	public function __construct() {
		$this->writeBuffer = new StringBuffer();
	}

	public function stream_open($path, $mode, $options, &$opened_path): bool {
		return parent::stream_open($path, $mode, $options, $opened_path);
	}

	/**
	 * Wrap a stream from libsmbclient-php into a regular php stream
	 *
	 * @param NativeState $state
	 * @param resource $smbStream
	 * @param string $mode
	 * @param string $url
	 * @return resource
	 */
	public static function wrap($state, $smbStream, $mode, $url) {
		stream_wrapper_register('nativesmb', NativeWriteStream::class);
		$context = stream_context_create([
			'nativesmb' => [
				'state'  => $state,
				'handle' => $smbStream,
				'url'    => $url
			]
		]);
		$fh = fopen('nativesmb://', $mode, false, $context);
		stream_wrapper_unregister('nativesmb');
		return $fh;
	}

	public function stream_seek($offset, $whence = SEEK_SET) {

		$this->flushWrite();
		$result = parent::stream_seek($offset, $whence);
		if ($result) {
			$pos = parent::stream_tell();
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
			if ($pos === false) {
				return false;
			}
			$this->pos = $pos;
		}
		return $result;
	}

	private function flushWrite(): void {
		$this->state->write($this->handle, $this->writeBuffer->flush(), $this->url);
	}

	public function stream_write($data) {
		$written = $this->writeBuffer->push($data);
		$this->pos += $written;

		if ($this->writeBuffer->remaining() >= self::CHUNK_SIZE) {
			$this->flushWrite();
		}

		return $written;
	}

	public function stream_close() {
		try {
			$this->flushWrite();
			$flushResult = true;
		} catch (\Exception $e) {
			$flushResult = false;
		}
		return parent::stream_close() && $flushResult;
	}

	public function stream_tell() {
		return $this->pos;
	}

	public function stream_read($count) {
		return false;
	}

	public function stream_truncate($size) {
		$this->flushWrite();
		$this->pos = $size;
		return parent::stream_truncate($size);
	}
}


1			<?php
2			/**
3			* Copyright (c) 2014 Robin Appelman <[email protected]>
4			* This file is licensed under the Licensed under the MIT license:
5			* http://opensource.org/licenses/MIT
6			*/
7
8			namespace Icewind\SMB\Native;
9
10			use Icewind\SMB\StringBuffer;
11
12			/**
13			* Stream optimized for write only usage
14			*/
15			class NativeWriteStream extends NativeStream {
16			const CHUNK_SIZE = 1048576; // 1MB chunks
17
18			/** @var StringBuffer */
19			private $writeBuffer;
20
21			/** @var int */
22			private $pos = 0;
23
24	42		public function __construct() {
25	42		$this->writeBuffer = new StringBuffer();
26			}
27	42
28			public function stream_open($path, $mode, $options, &$opened_path): bool {
29			return parent::stream_open($path, $mode, $options, $opened_path);
30			}
31
32			/**
33			* Wrap a stream from libsmbclient-php into a regular php stream
34			*
35			* @param NativeState $state
36			* @param resource $smbStream
37			* @param string $mode
38			* @param string $url
39	42		* @return resource
40	42		*/
41	42	View Code Duplication	public static function wrap($state, $smbStream, $mode, $url) {
42			stream_wrapper_register('nativesmb', NativeWriteStream::class);
43	42		$context = stream_context_create([
44	42		'nativesmb' => [
45	42		'state' => $state,
46			'handle' => $smbStream,
47			'url' => $url
48	42		]
49	42		]);
50	42		$fh = fopen('nativesmb://', $mode, false, $context);
51			stream_wrapper_unregister('nativesmb');
52			return $fh;
53	2		}
54	2
55	2	View Code Duplication	public function stream_seek($offset, $whence = SEEK_SET) {
			0 ignored issues – show Duplication introduced 2021-03-09 19:16 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...
56	2		$this->flushWrite();
57	2		$result = parent::stream_seek($offset, $whence);
58			if ($result) {
59	2		$pos = parent::stream_tell();
			0 ignored issues – show Comprehensibility Bug introduced 2017-08-16 16:00 UTC by Report Bug Copy Issue Report It seems like you call parent on a different method (`stream_tell()` instead of `stream_seek()`). Are you sure this is correct? If so, you might want to change this to `$this->stream_tell()`. This check looks for a call to a parent method whose name is different than the method from which it is called. Consider the following code: class Daddy { protected function getFirstName() { return "Eidur"; } protected function getSurName() { return "Gudjohnsen"; } } class Son { public function getFirstName() { return parent::getSurname(); } } The `getFirstName()` method in the `Son` calls the wrong method in the parent class. Loading history...
60			if ($pos === false) {
61			return false;
62	42		}
63	42		$this->pos = $pos;
64	42		}
65	42		return $result;
66	42		}
67	42
68			private function flushWrite(): void {
69	38		$this->state->write($this->handle, $this->writeBuffer->flush(), $this->url);
70	38		}
71	38
72	38		public function stream_write($data) {
73			$written = $this->writeBuffer->push($data);
74	38		$this->pos += $written;
75
76			if ($this->writeBuffer->remaining() >= self::CHUNK_SIZE) {
77			$this->flushWrite();
78	38		}
79
80			return $written;
81	42		}
82
83	42		public function stream_close() {
84	42		try {
85			$this->flushWrite();
86			$flushResult = true;
87			} catch (\Exception $e) {
88	42		$flushResult = false;
89			}
90			return parent::stream_close() && $flushResult;
91	2		}
92	2
93			public function stream_tell() {
94			return $this->pos;
95			}
96
97			public function stream_read($count) {
98			return false;
99	2		}
100	2
101	2		public function stream_truncate($size) {
102	2		$this->flushWrite();
103			$this->pos = $size;
104			return parent::stream_truncate($size);
105			}
106			}
107

icewind1991 / SMB

Push — master ( 78b032...4251cd )

NativeWriteStream A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

10 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like