TraceableNetwork - Code Metrics - Inspection of "Add example for logger, fix UnitTest" - phpflo/phpflo-flowtrace - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( f8db25...f08840 )

by Marc

created 2017-01-05 20:32 UTC

TraceableNetwork A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	105
Duplicated Lines	5.71 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

32.61%

Importance

Changes

Metric	Value
wmc	10
lcom	1
cbo	3
dl	6
loc	105
ccs	15
cts	46
cp	0.3261
rs	10
c	0
b	0
f	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	15	1
A	trace()	0	16	4
A	traceData()	3	19	3
A	traceAction()	3	14	2

How to fix Duplicated Code

<?php
/*
 * This file is part of the phpflo/phpflo-flowtrace package.
 *
 * (c) Marc Aschmann <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace PhpFlo;

use PhpFlo\Common\AbstractNetworkAdapter;
use PhpFlo\Common\HookableNetworkInterface;
use PhpFlo\Common\Network;
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php
use PhpFlo\Common\NetworkAdapterinterface;
use PhpFlo\Common\NetworkInterface;
use PhpFlo\Exception\FlowException;
use PhpFlo\Exception\InvalidDefinitionException;
use PhpFlo\Exception\InvalidTypeException;
use Psr\Log\LoggerInterface;

/**
 * Network for tracing events.
 *
 * @package PhpFlo
 * @author Marc Aschmann <[email protected]>
 */
class TraceableNetwork extends AbstractNetworkAdapter implements NetworkAdapterinterface
{
    const TYPE_DATA = 'data';
    const TYPE_CONNECT = 'connect';
    const TYPE_DISCONNECT = 'disconnect';
    const TYPE_BEGIN_GROUP = 'begin.group';
    const TYPE_END_GROUP = 'end.group';

    /**
     * @var array
     */
    private $actions;

    /**
     * @var LoggerInterface
     */
    private $logger;

    /**
     * TraceableNetwork constructor.
     *
     * @param NetworkInterface $network
     * @param LoggerInterface $logger
     */
    public function __construct(NetworkInterface $network, LoggerInterface $logger)
    {
        parent::__construct($network);

        $this->actions = [
            self::TYPE_DATA       => 'DATA',
            self::TYPE_CONNECT    => 'CONN',
            self::TYPE_DISCONNECT => 'DISC'
        ];

        $this->logger = $logger;
        $this->network->hook(self::TYPE_DATA, 'flowtrace', $this->trace(self::TYPE_DATA));
        $this->network->hook(self::TYPE_CONNECT, 'flowtrace', $this->trace(self::TYPE_CONNECT));
        $this->network->hook(self::TYPE_DISCONNECT, 'flowtrace', $this->trace(self::TYPE_DISCONNECT));
    }

    /**
     * Wrap the creation of the callback
     *
     * @return \Closure
     */
    private function trace($type)
    {
        $trace = function () use ($type) {
            switch ($type) {
                case TraceableNetwork::TYPE_DATA:
                    $this->traceData(func_get_args(), $type);
                    break;
                case TraceableNetwork::TYPE_CONNECT:
                case TraceableNetwork::TYPE_DISCONNECT:
                    $this->traceAction(func_get_args(), $type);
                    break;
            }
        };

        return $trace->bindTo($this);
    }

    /**
     * @param array $args
     * @param string $type
     */
    private function traceData(array $args, $type)
    {
        $data   = $args[0];
        $socket = $args[1];

        if (!is_string($data)) {
            $data = serialize($data);
        }

        $to      = $socket->to();
        $message = "-> {$to['port']} {$to['process']['id']} ";

        $from = $socket->from();
        if (isset($from['process'])) {

            $message = "{$from['process']['id']} {$from['port']} {$message}";
        }

        $this->logger->info("{$message} {$this->actions[$type]} {$data}");
    }

    /**
     * @param array $args
     * @param string $type
     */
    private function traceAction(array $args, $type)
    {
        $socket = $args[0];

        $to      = $socket->to();
        $message = "-> {$to['port']} {$to['process']['id']} ";

        $from = $socket->from();
        if (isset($from['process'])) {

            $message = "{$from['process']['id']} {$from['port']} {$message}";
        }

        $this->logger->debug("{$message} {$this->actions[$type]}");
    }
}


1			<?php
2			/*
3			* This file is part of the phpflo/phpflo-flowtrace package.
4			*
5			* (c) Marc Aschmann <[email protected]>
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			namespace PhpFlo;
12
13			use PhpFlo\Common\AbstractNetworkAdapter;
14			use PhpFlo\Common\HookableNetworkInterface;
15			use PhpFlo\Common\Network;
			0 ignored issues – show Bug introduced 2017-01-04 07:58 UTC by Report Bug Copy Issue Report This use statement conflicts with another class in this namespace, `PhpFlo\Network`. Let’s assume that you have a directory layout like this: . \|-- OtherDir \| \|-- Bar.php \| `-- Foo.php `-- SomeDir `-- Foo.php and let’s assume the following content of `Bar.php`: // Bar.php namespace OtherDir; use SomeDir\Foo; // This now conflicts the class OtherDir\Foo If both files `OtherDir/Foo.php` and `SomeDir/Foo.php` are loaded in the same runtime, you will see a PHP error such as the following: PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php However, as `OtherDir/Foo.php` does not necessarily have to be loaded and the error is only triggered if it is loaded before `OtherDir/Bar.php`, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: // Bar.php namespace OtherDir; use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore. Loading history...
16			use PhpFlo\Common\NetworkAdapterinterface;
17			use PhpFlo\Common\NetworkInterface;
18			use PhpFlo\Exception\FlowException;
19			use PhpFlo\Exception\InvalidDefinitionException;
20			use PhpFlo\Exception\InvalidTypeException;
21			use Psr\Log\LoggerInterface;
22
23			/**
24			* Network for tracing events.
25			*
26			* @package PhpFlo
27			* @author Marc Aschmann <[email protected]>
28			*/
29			class TraceableNetwork extends AbstractNetworkAdapter implements NetworkAdapterinterface
30			{
31			const TYPE_DATA = 'data';
32			const TYPE_CONNECT = 'connect';
33			const TYPE_DISCONNECT = 'disconnect';
34			const TYPE_BEGIN_GROUP = 'begin.group';
35			const TYPE_END_GROUP = 'end.group';
36
37			/**
38			* @var array
39			*/
40			private $actions;
41
42			/**
43			* @var LoggerInterface
44			*/
45			private $logger;
46
47			/**
48			* TraceableNetwork constructor.
49			*
50			* @param NetworkInterface $network
51			* @param LoggerInterface $logger
52			*/
53	2		public function __construct(NetworkInterface $network, LoggerInterface $logger)
54			{
55	2		parent::__construct($network);
56
57	2		$this->actions = [
58	2		self::TYPE_DATA => 'DATA',
59	2		self::TYPE_CONNECT => 'CONN',
60	2		self::TYPE_DISCONNECT => 'DISC'
61	2		];
62
63	2		$this->logger = $logger;
64	2		$this->network->hook(self::TYPE_DATA, 'flowtrace', $this->trace(self::TYPE_DATA));
65	2		$this->network->hook(self::TYPE_CONNECT, 'flowtrace', $this->trace(self::TYPE_CONNECT));
66	2		$this->network->hook(self::TYPE_DISCONNECT, 'flowtrace', $this->trace(self::TYPE_DISCONNECT));
67	2		}
68
69			/**
70			* Wrap the creation of the callback
71			*
72			* @return \Closure
73			*/
74			private function trace($type)
75			{
76	2		$trace = function () use ($type) {
77			switch ($type) {
78			case TraceableNetwork::TYPE_DATA:
79			$this->traceData(func_get_args(), $type);
80			break;
81			case TraceableNetwork::TYPE_CONNECT:
82			case TraceableNetwork::TYPE_DISCONNECT:
83			$this->traceAction(func_get_args(), $type);
84			break;
85			}
86	2		};
87
88	2		return $trace->bindTo($this);
89			}
90
91			/**
92			* @param array $args
93			* @param string $type
94			*/
95			private function traceData(array $args, $type)
96			{
97			$data = $args[0];
98			$socket = $args[1];
99
100			if (!is_string($data)) {
101			$data = serialize($data);
102			}
103
104			$to = $socket->to();
105			$message = "-> {$to['port']} {$to['process']['id']} ";
106
107			$from = $socket->from();
108		View Code Duplication	if (isset($from['process'])) {
			0 ignored issues – show Duplication introduced 2017-01-05 20:34 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...
109			$message = "{$from['process']['id']} {$from['port']} {$message}";
110			}
111
112			$this->logger->info("{$message} {$this->actions[$type]} {$data}");
113			}
114
115			/**
116			* @param array $args
117			* @param string $type
118			*/
119			private function traceAction(array $args, $type)
120			{
121			$socket = $args[0];
122
123			$to = $socket->to();
124			$message = "-> {$to['port']} {$to['process']['id']} ";
125
126			$from = $socket->from();
127		View Code Duplication	if (isset($from['process'])) {
			0 ignored issues – show Duplication introduced 2017-01-05 20:34 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...
128			$message = "{$from['process']['id']} {$from['port']} {$message}";
129			}
130
131			$this->logger->debug("{$message} {$this->actions[$type]}");
132			}
133			}
134

phpflo / phpflo-flowtrace

Push — master ( f8db25...f08840 )

TraceableNetwork A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

4 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like