ParseInet6Address::fromTraversable() - Code Metrics - Inspection of "New: support for parsing a single, complete net in..." - ganbarodigital/php-operating-system - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( a3c683...8c914c )

by Stuart

created 2016-01-31 15:53 UTC

ParseInet6Address::fromTraversable() B

↳ Parent: ParseInet6Address

Complexity

Conditions	2
Paths	2

Size

Total Lines	26
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	26
rs	8.8571
cc	2
eloc	13
nc	2
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-array-tools
 */

namespace GanbaroDigital\OperatingSystem\IpRoute\Parsers;

use GanbaroDigital\ArrayTools\Parsers\ConvertKeyValuePairsToArray;
use GanbaroDigital\ArrayTools\Filters\ExtractFirstItem;
use GanbaroDigital\ArrayTools\ValueBuilders\ConvertToArray;
use GanbaroDigital\OperatingSystem\Exceptions\E4xx_CannotParseInet6AddressLine;
use GanbaroDigital\OperatingSystem\Exceptions\E4xx_UnsupportedType;
use GanbaroDigital\OperatingSystem\NetInterfaces\Values\Inet6Address;
use GanbaroDigital\Reflection\Maps\MapTypeToMethod;
use GanbaroDigital\Reflection\ValueBuilders\SimpleType;

class ParseInet6Address
{
    /**
     * parse an inet6 (IPv6) address block from the output of 'ip addr show'
     *
     * @param  mixed $inet6Lines
     *         the line(s) to parse
     * @return Inet6Address
     *         the inet address defined in the output
     */
    public function __invoke($inet6Lines)
    {
        return self::from($inet6Lines);
    }

    public static function from($inet6Lines)

    {
        $method = MapTypeToMethod::using($inet6Lines, self::$dispatchMap);
        return self::$method($inet6Lines);
    }

    /**
     * a map of which types we support, and how to process them
     * @var array
     */
    private static $dispatchMap = [
        "String" => "fromString",
        "Traversable" => "fromTraversable",
    ];

    /**
     * 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));
    }

    /**
     * parse an inet6 (IPv6) address block from the output of 'ip addr show'
     *
     * @param  string $inet6Lines
     *         the line(s) to parse
     * @return InetAddress

     *         the inet address defined in the output
     */
    private static function fromString($inet6Lines)
    {
        $lines = explode("\n", $inet6Lines);

        return self::fromTraversable($lines);
    }

    /**
     * parse an inet6 (IPv6) address block from the output of 'ip addr show'
     *
     * @param  array|Traversable $inet6Lines
     *         the line(s) to parse
     * @return InetAddress

     *         the inet address defined in the output
     */
    private static function fromTraversable($inet6Lines)
    {
        // we want a real PHP array for this
        $inet6Lines = ConvertToArray::from($inet6Lines);

        // line 0 is the inet line itself
        $inet6Details = self::parseFirstLine(array_shift($inet6Lines));

        // if there is a line 1, it contains additional flags
        while (!empty($inet6Lines)) {
            $inet6Details['properties'] = array_merge(self::parseSecondLine(array_shift($inet6Lines)), $inet6Details['properties']);
        }

        // now to convert this into an InetAddress value
        $retval = new Inet6Address(
            $inet6Details['address'],
            $inet6Details['netmask'],
            $inet6Details['scope'],
            $inet6Details['addressLabel'],
            $inet6Details['linkDevice'],
            $inet6Details['properties']
        );

        // all done
        return $retval;
    }

    /**
     * extract data from the first line of the inet address definition
     *
     * @param  string $line
     *         the line to parse
     * @return array
     *         the extracted data
     */
    private static function parseFirstLine($line)
    {
        $regex = "~inet6 (?<addr>.+)(?<netmask>/[0-9]{1,5})( scope (?<scope>[a-z]+)){0,1}( (?<addressLabel>secondary|dynamic|deprecated|tentative)){0,1}( (?<linkDevice>.*)){0,1}$~";
        $matches = [];
        if (!preg_match_all($regex, $line, $matches)) {
            throw new E4xx_CannotParseInet6AddressLine($line);
        }

        return [
            'address' => $matches['addr'][0],
            'netmask' => $matches['netmask'][0],
            'scope' => ExtractFirstItem::from($matches['scope'], null),
            'addressLabel' => ExtractFirstItem::from($matches['addressLabel'], null),
            'linkDevice' => ExtractFirstItem::from($matches['linkDevice'], null),
            'properties' => [],
        ];
    }

    /**
     * extract data from the second line of the inet address definition
     *
     * @param  string $line
     *         the line to parse
     * @return array
     *         the extracted data, as key/value pairs
     */
    private static function parseSecondLine($line)
    {
        return ConvertKeyValuePairsToArray::from($line, ' ', ' ');
    }
}


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-array-tools
42			*/
43
44			namespace GanbaroDigital\OperatingSystem\IpRoute\Parsers;
45
46			use GanbaroDigital\ArrayTools\Parsers\ConvertKeyValuePairsToArray;
47			use GanbaroDigital\ArrayTools\Filters\ExtractFirstItem;
48			use GanbaroDigital\ArrayTools\ValueBuilders\ConvertToArray;
49			use GanbaroDigital\OperatingSystem\Exceptions\E4xx_CannotParseInet6AddressLine;
50			use GanbaroDigital\OperatingSystem\Exceptions\E4xx_UnsupportedType;
51			use GanbaroDigital\OperatingSystem\NetInterfaces\Values\Inet6Address;
52			use GanbaroDigital\Reflection\Maps\MapTypeToMethod;
53			use GanbaroDigital\Reflection\ValueBuilders\SimpleType;
54
55			class ParseInet6Address
56			{
57			/**
58			* parse an inet6 (IPv6) address block from the output of 'ip addr show'
59			*
60			* @param mixed $inet6Lines
61			* the line(s) to parse
62			* @return Inet6Address
63			* the inet address defined in the output
64			*/
65			public function __invoke($inet6Lines)
66			{
67			return self::from($inet6Lines);
68			}
69
70			public static function from($inet6Lines)
			0 ignored issues – show Documentation introduced 2016-01-31 15:55 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
71			{
72			$method = MapTypeToMethod::using($inet6Lines, self::$dispatchMap);
73			return self::$method($inet6Lines);
74			}
75
76			/**
77			* a map of which types we support, and how to process them
78			* @var array
79			*/
80			private static $dispatchMap = [
81			"String" => "fromString",
82			"Traversable" => "fromTraversable",
83			];
84
85			/**
86			* called when we've been given a data type that we do not support
87			*
88			* @param mixed $output
89			* the unsupported data
90			* @return void
91			* @throws E4xx_UnsupportedType
92			*/
93			private static function nothingMatchesTheInputType($output)
94			{
95			throw new E4xx_UnsupportedType(SimpleType::from($output));
96			}
97
98			/**
99			* parse an inet6 (IPv6) address block from the output of 'ip addr show'
100			*
101			* @param string $inet6Lines
102			* the line(s) to parse
103			* @return InetAddress
			0 ignored issues – show Documentation introduced 2016-01-31 15:55 UTC by Report Bug Copy Issue Report Should the return type not be `Inet6Address`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
104			* the inet address defined in the output
105			*/
106			private static function fromString($inet6Lines)
107			{
108			$lines = explode("\n", $inet6Lines);
109
110			return self::fromTraversable($lines);
111			}
112
113			/**
114			* parse an inet6 (IPv6) address block from the output of 'ip addr show'
115			*
116			* @param array\|Traversable $inet6Lines
117			* the line(s) to parse
118			* @return InetAddress
			0 ignored issues – show Documentation introduced 2016-01-31 15:55 UTC by Report Bug Copy Issue Report Should the return type not be `Inet6Address`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
119			* the inet address defined in the output
120			*/
121			private static function fromTraversable($inet6Lines)
122			{
123			// we want a real PHP array for this
124			$inet6Lines = ConvertToArray::from($inet6Lines);
125
126			// line 0 is the inet line itself
127			$inet6Details = self::parseFirstLine(array_shift($inet6Lines));
128
129			// if there is a line 1, it contains additional flags
130			while (!empty($inet6Lines)) {
131			$inet6Details['properties'] = array_merge(self::parseSecondLine(array_shift($inet6Lines)), $inet6Details['properties']);
132			}
133
134			// now to convert this into an InetAddress value
135			$retval = new Inet6Address(
136			$inet6Details['address'],
137			$inet6Details['netmask'],
138			$inet6Details['scope'],
139			$inet6Details['addressLabel'],
140			$inet6Details['linkDevice'],
141			$inet6Details['properties']
142			);
143
144			// all done
145			return $retval;
146			}
147
148			/**
149			* extract data from the first line of the inet address definition
150			*
151			* @param string $line
152			* the line to parse
153			* @return array
154			* the extracted data
155			*/
156			private static function parseFirstLine($line)
157			{
158			$regex = "~inet6 (?<addr>.+)(?<netmask>/[0-9]{1,5})( scope (?<scope>[a-z]+)){0,1}( (?<addressLabel>secondary\|dynamic\|deprecated\|tentative)){0,1}( (?<linkDevice>.*)){0,1}$~";
159			$matches = [];
160			if (!preg_match_all($regex, $line, $matches)) {
161			throw new E4xx_CannotParseInet6AddressLine($line);
162			}
163
164			return [
165			'address' => $matches['addr'][0],
166			'netmask' => $matches['netmask'][0],
167			'scope' => ExtractFirstItem::from($matches['scope'], null),
168			'addressLabel' => ExtractFirstItem::from($matches['addressLabel'], null),
169			'linkDevice' => ExtractFirstItem::from($matches['linkDevice'], null),
170			'properties' => [],
171			];
172			}
173
174			/**
175			* extract data from the second line of the inet address definition
176			*
177			* @param string $line
178			* the line to parse
179			* @return array
180			* the extracted data, as key/value pairs
181			*/
182			private static function parseSecondLine($line)
183			{
184			return ConvertKeyValuePairsToArray::from($line, ' ', ' ');
185			}
186			}
187

ganbarodigital / php-operating-system

Push — develop ( a3c683...8c914c )

ParseInet6Address::fromTraversable() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like