ParseIpAddrOutput::from() - Code Metrics - Inspection of "New: added support for parsing the full output of..." - ganbarodigital/php-operating-system - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 8c914c...95d5bd )

by Stuart

created 2016-01-31 20:09 UTC

ParseIpAddrOutput::from() A

↳ Parent: ParseIpAddrOutput

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	5
rs	9.4285
cc	1
eloc	3
nc	1
nop	1

<?php

/**
 * Copyright (c) 2016-present Ganbaro Digital Ltd
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *
 *   * Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in
 *     the documentation and/or other materials provided with the
 *     distribution.
 *
 *   * Neither the names of the copyright holders nor the names of his
 *     contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * @category  Libraries
 * @package   OperatingSystem/NetInterface/Parsers
 * @author    Stuart Herbert <[email protected]>
 * @copyright 2016-present Ganbaro Digital Ltd www.ganbarodigital.com
 * @license   http://www.opensource.org/licenses/bsd-license.php  BSD License
 * @link      http://code.ganbarodigital.com/php-operating-system
 */

namespace GanbaroDigital\OperatingSystem\IpRoute\Parsers;

use GanbaroDigital\OperatingSystem\IpRoute\Classifiers\ClassifyIpAddrLine;
use GanbaroDigital\OperatingSystem\Exceptions\E4xx_CannotParseIpAddrOutput;
use GanbaroDigital\OperatingSystem\Exceptions\E4xx_OperatingSystemException;
use GanbaroDigital\OperatingSystem\Exceptions\E4xx_UnsupportedType;
use GanbaroDigital\OperatingSystem\Exceptions\E5xx_CannotParseIpAddrOutput;
use GanbaroDigital\OperatingSystem\Exceptions\E5xx_OperatingSystemException;
use GanbaroDigital\Reflection\Maps\MapTypeToMethod;
use GanbaroDigital\Reflection\ValueBuilders\SimpleType;

/**
 * parser for the output of the 'ip addr show' command
 */
class ParseIpAddrOutput
{
    /**
     * parse the output of the 'ip addr show' command
     *
     * @param  mixed $output
     *         the output to parse
     * @return array<NetInterface>
     *         a list of the network interfaces extracted from the given
     *         command output
     */
    public function __invoke($output)
    {
        return self::from($output);
    }

    /**
     * parse the output of the 'ip addr show' command
     *
     * @param  mixed $output
     *         the output to parse
     * @return array<NetInterface>
     *         a list of the network interfaces extracted from the given
     *         command output
     */
    public static function from($output)
    {
        $method = MapTypeToMethod::using($output, self::$dispatchMap);
        return self::$method($output);
    }

    /**
     * parse the output of the 'ip addr show' command
     *
     * @param  Traversable $output
     *         the output to parse
     * @return array<NetInterface>
     *         a list of the network interfaces extracted from the given
     *         command output
     */
     private static function fromTraversable($output)
     {
         // our return value
         $retval = [];

         try {
             // group the output into smaller chunks for parsing
             $groups = self::groupOutputIntoInterfaces($output);

             foreach($groups as $interfaceLines) {
                 $interface = ParseNetInterface::from($interfaceLines);
                 $retval[] = $interface;
             }
         }
         catch (E4xx_OperatingSystemException $e) {
             throw new E4xx_CannotParseIpAddrOutput($output, $e);
         }
         catch (E5xx_OperatingSystemException $e) {
             throw new E5xx_CannotParseIpAddrOutput($output, $e);
         }

         // all done
         return $retval;
     }

     /**
      * convert the output of the 'ip addr show' command into smaller groups
      * that are easier to parse
      *
      * @param  array|Traversable $lines
      *         the output to group
      * @return array
      *         the grouped output
      */
     private static function groupOutputIntoInterfaces($lines)
     {
         $interfaces=[];

         // what do we have?
         foreach ($lines as $line) {
             // skip empty lines
             if (trim($line) === '') {
                 continue;
             }

             // what do we have?
             $lineType = ClassifyIpAddrLine::from($line);
             switch ($lineType) {
                 case ClassifyIpAddrLine::LINK_START:
                     $interfaces[] = [ $line ];
                     break;
                 default:
                     $interfaces[count($interfaces) - 1][] = $line;
             }
         }

         // all done
         return $interfaces;
     }

    /**
     * parse the output of the 'ip addr show' command
     *
     * @param  string $output
     *         the output to parse
     * @return array<NetInterface>
     *         a list of the network interfaces extracted from the given
     *         command output
     */
    private static function fromString($output)
    {
        $lines = explode("\n", (string)$output);
        return self::fromTraversable($lines);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * called when we've been given a data type that we do not support
     *
     * @param  mixed $output
     *         the unsupported data
     * @return void
     * @throws E4xx_UnsupportedType
     */
    private static function nothingMatchesTheInputType($output)
    {
        throw new E4xx_UnsupportedType(SimpleType::from($output));
    }

    /**
     * a map of which method to use for which type of data we're asked to
     * process
     *
     * @var array
     */
    private static $dispatchMap = [
        'Traversable' => 'fromTraversable',
        'String' => 'fromString',
    ];
}


1			<?php
2
3			/**
4			* Copyright (c) 2016-present Ganbaro Digital Ltd
5			* All rights reserved.
6			*
7			* Redistribution and use in source and binary forms, with or without
8			* modification, are permitted provided that the following conditions
9			* are met:
10			*
11			* * Redistributions of source code must retain the above copyright
12			* notice, this list of conditions and the following disclaimer.
13			*
14			* * Redistributions in binary form must reproduce the above copyright
15			* notice, this list of conditions and the following disclaimer in
16			* the documentation and/or other materials provided with the
17			* distribution.
18			*
19			* * Neither the names of the copyright holders nor the names of his
20			* contributors may be used to endorse or promote products derived
21			* from this software without specific prior written permission.
22			*
23			* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24			* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25			* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
26			* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
27			* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
28			* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
29			* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
30			* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
31			* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32			* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
33			* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34			* POSSIBILITY OF SUCH DAMAGE.
35			*
36			* @category Libraries
37			* @package OperatingSystem/NetInterface/Parsers
38			* @author Stuart Herbert <[email protected]>
39			* @copyright 2016-present Ganbaro Digital Ltd www.ganbarodigital.com
40			* @license http://www.opensource.org/licenses/bsd-license.php BSD License
41			* @link http://code.ganbarodigital.com/php-operating-system
42			*/
43
44			namespace GanbaroDigital\OperatingSystem\IpRoute\Parsers;
45
46			use GanbaroDigital\OperatingSystem\IpRoute\Classifiers\ClassifyIpAddrLine;
47			use GanbaroDigital\OperatingSystem\Exceptions\E4xx_CannotParseIpAddrOutput;
48			use GanbaroDigital\OperatingSystem\Exceptions\E4xx_OperatingSystemException;
49			use GanbaroDigital\OperatingSystem\Exceptions\E4xx_UnsupportedType;
50			use GanbaroDigital\OperatingSystem\Exceptions\E5xx_CannotParseIpAddrOutput;
51			use GanbaroDigital\OperatingSystem\Exceptions\E5xx_OperatingSystemException;
52			use GanbaroDigital\Reflection\Maps\MapTypeToMethod;
53			use GanbaroDigital\Reflection\ValueBuilders\SimpleType;
54
55			/**
56			* parser for the output of the 'ip addr show' command
57			*/
58			class ParseIpAddrOutput
59			{
60			/**
61			* parse the output of the 'ip addr show' command
62			*
63			* @param mixed $output
64			* the output to parse
65			* @return array<NetInterface>
66			* a list of the network interfaces extracted from the given
67			* command output
68			*/
69			public function __invoke($output)
70			{
71			return self::from($output);
72			}
73
74			/**
75			* parse the output of the 'ip addr show' command
76			*
77			* @param mixed $output
78			* the output to parse
79			* @return array<NetInterface>
80			* a list of the network interfaces extracted from the given
81			* command output
82			*/
83			public static function from($output)
84			{
85			$method = MapTypeToMethod::using($output, self::$dispatchMap);
86			return self::$method($output);
87			}
88
89			/**
90			* parse the output of the 'ip addr show' command
91			*
92			* @param Traversable $output
93			* the output to parse
94			* @return array<NetInterface>
95			* a list of the network interfaces extracted from the given
96			* command output
97			*/
98			private static function fromTraversable($output)
99			{
100			// our return value
101			$retval = [];
102
103			try {
104			// group the output into smaller chunks for parsing
105			$groups = self::groupOutputIntoInterfaces($output);
106
107			foreach($groups as $interfaceLines) {
108			$interface = ParseNetInterface::from($interfaceLines);
109			$retval[] = $interface;
110			}
111			}
112			catch (E4xx_OperatingSystemException $e) {
113			throw new E4xx_CannotParseIpAddrOutput($output, $e);
114			}
115			catch (E5xx_OperatingSystemException $e) {
116			throw new E5xx_CannotParseIpAddrOutput($output, $e);
117			}
118
119			// all done
120			return $retval;
121			}
122
123			/**
124			* convert the output of the 'ip addr show' command into smaller groups
125			* that are easier to parse
126			*
127			* @param array\|Traversable $lines
128			* the output to group
129			* @return array
130			* the grouped output
131			*/
132			private static function groupOutputIntoInterfaces($lines)
133			{
134			$interfaces=[];
135
136			// what do we have?
137			foreach ($lines as $line) {
138			// skip empty lines
139			if (trim($line) === '') {
140			continue;
141			}
142
143			// what do we have?
144			$lineType = ClassifyIpAddrLine::from($line);
145			switch ($lineType) {
146			case ClassifyIpAddrLine::LINK_START:
147			$interfaces[] = [ $line ];
148			break;
149			default:
150			$interfaces[count($interfaces) - 1][] = $line;
151			}
152			}
153
154			// all done
155			return $interfaces;
156			}
157
158			/**
159			* parse the output of the 'ip addr show' command
160			*
161			* @param string $output
162			* the output to parse
163			* @return array<NetInterface>
164			* a list of the network interfaces extracted from the given
165			* command output
166			*/
167			private static function fromString($output)
168			{
169			$lines = explode("\n", (string)$output);
170			return self::fromTraversable($lines);
			0 ignored issues – show Documentation introduced 2016-01-31 20:11 UTC by Report Bug Copy Issue Report `$lines` is of type `array`, but the function expects a `object<GanbaroDigital\Op...te\Parsers\Traversable>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
171			}
172
173			/**
174			* called when we've been given a data type that we do not support
175			*
176			* @param mixed $output
177			* the unsupported data
178			* @return void
179			* @throws E4xx_UnsupportedType
180			*/
181			private static function nothingMatchesTheInputType($output)
182			{
183			throw new E4xx_UnsupportedType(SimpleType::from($output));
184			}
185
186			/**
187			* a map of which method to use for which type of data we're asked to
188			* process
189			*
190			* @var array
191			*/
192			private static $dispatchMap = [
193			'Traversable' => 'fromTraversable',
194			'String' => 'fromString',
195			];
196			}
197

ganbarodigital / php-operating-system

Push — develop ( 8c914c...95d5bd )

ParseIpAddrOutput::from() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like