Server::setStartMultiLine() - Code Metrics - Inspection of "Reduce duplication in Server object" - JamesRezo/webhelper-parser - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 9082b5...73195f )

by James

created 2016-09-12 06:42 UTC

Server::setStartMultiLine() A

↳ Parent: Server

Complexity

Conditions	1
Paths	1

Size

Total Lines	11
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	11
ccs	6
cts	6
cp	1
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	7
nc	1
nop	1
crap	1

<?php

/**
 * This file is part of WebHelper Parser.
 *
 * (c) James <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace WebHelper\Parser\Server;

use InvalidArgumentException;
use Webmozart\Assert\Assert;
use Webmozart\PathUtil\Path;

/**
 * A web server instance.
 *
 * @author James <[email protected]>
 */
class Server implements ServerInterface
{
    /**
     * The filesystem path where the web server is installed.
     *
     * It has to be an absolute path.
     *
     * Apache httpd server does not accept a relative prefix path at compilation.
     * Nginx does, but this is a very risky practice...
     * So relative prefix path in nginx configuration will not be considered
     *
     * @var string
     */
    private $prefix = '';

    /**
     * The string to match as a starting multi-line directive.
     *
     * @var string
     */
    private $startMultiLine = '';

    /**
     * The string to match as an ending multi-line directive.
     *
     * @var string
     */
    private $endMultiLine = '';

    /**
     * The string to match a simple directive.
     *
     * @var string
     */
    private $simpleDirective = '';

    /**
     * Confirms if the server instance has valid parameters.
     *
     * @return bool true if all parameters are initialized, false otherwise
     */
    public function isValid()
    {
        $valid = $this->prefix != '';
        $valid = $valid && $this->startMultiLine != '';
        $valid = $valid && $this->endMultiLine != '';
        $valid = $valid && $this->simpleDirective != '';

        return $valid;
    }

    /**
     * Getter for the prefix.
     *
     * @return string the filesystem path where the web server is installed
     */
    public function getPrefix()
    {
        return $this->prefix;
    }

    /**
     * Sets the prefix of a server isntance.
     *
     * @throws ServerException if the prefix is invalid
     *
     * @param string $prefix the filesystem path where the web server is installed
     */
    public function setPrefix($prefix)
    {
        try {
            Assert::string($prefix);
        } catch (InvalidArgumentException $e) {
            throw ServerException::forInvalidPrefix($prefix, 'The path is expected to be a string. Got: %s');
        }

        if (!Path::isAbsolute($prefix)) {
            throw ServerException::forInvalidPrefix($prefix, 'The path is expected to be absolute. Got: %s');
        }

        if (!is_dir($prefix)) {
            throw ServerException::forInvalidPrefix(
                $prefix,
                'The path is expected to be an existing directory. Got: %s'
            );
        }

        $this->prefix = $prefix;

        return $this;
    }

    /**
     * Gets the regexp that will match the starting block directives.
     *
     * @return string the regexp that will match the starting block directives
     */
    public function getStartMultiLine()
    {
        return $this->startMultiLine;
    }

    /**
     * Sets the regexp that will match the starting block directives.
     *
     * @param string $startMultiLine the regexp that will match the starting block directives
     */
    public function setStartMultiLine($startMultiLine)
    {
        $this->startMultiLine = $this->checkString(
            $startMultiLine,
            'The starting block directive matcher is expected to be a string. Got: %s',
            'The starting block directive matcher is expected to be a regexp '.
            'containing named subpatterns "key" and "value". Got: %s'
        );

        return $this;
    }

    /**
     * Gets the regexp that will match the ending block directives.
     *
     * @return string the regexp that will match the ending block directives
     */
    public function getEndMultiLine()
    {
        return $this->endMultiLine;
    }

    /**
     * Sets the regexp that will match the ending block directives.
     *
     * @param string $endMultiLine the regexp that will match the ending block directives
     */
    public function setEndMultiLine($endMultiLine)
    {
        $this->endMultiLine = $this->checkString(
            $endMultiLine,
            'The endind block directive matcher is expected to be a string. Got: %s',
            'The ending block directive matcher is expected to be a regexp . Got: %s',
            false
        );

        return $this;
    }

    /**
     * Gets the regexp that will match the simple directives.
     *
     * @return string the regexp that will match the simple directives
     */
    public function getSimpleDirective()
    {
        return $this->simpleDirective;
    }

    /**
     * Sets the regexp that will match the simple directives.
     *
     * @param string $simpleDirective the regexp that will match the simple directives
     */
    public function setSimpleDirective($simpleDirective)
    {
        $this->simpleDirective = $this->checkString(
            $simpleDirective,
            'The simple directive matcher is expected to be a string. Got: %s',
            'The simple directive matcher is expected to be a regexp '.
            'containing named subpatterns "key" and "value". Got: %s'
        );

        return $this;
    }

    /**
     * Checks if the string matches some criterias.
     *
     * @param string $string     the string to check
     * @param string $message1   message if not a string
     * @param string $message2   message if not a regexp
     * @param bool   $subpattern confirms the presence of subpatterns "key" and "value"
     *
     * @throws ServerException if the string is invalid
     *
     * @return string the string
     */
    private function checkString($string, $message1, $message2, $subpattern = true)
    {
        try {
            Assert::string($string);
        } catch (InvalidArgumentException $e) {
            throw ServerException::forInvalidMatcher($string, $message1);
        }

        if (!$this->isValidRegex($string, $subpattern)) {
            throw ServerException::forInvalidMatcher($string, $message2);
        }

        return $string;
    }

    /**
     * Confirms if a matcher is a valid reguler expression.
     *
     * A directive matcher MUST contain a key and a value named subpattern.
     *
     * @param string $matcher    the matcher to validate
     * @param bool   $subpattern confirms the presence of subpatterns "key" and "value"
     *
     * @return bool true if the matcher is valid, false otherwise
     */
    private function isValidRegex($matcher, $subpattern = true)
    {
        if (false === @preg_match($matcher, 'tester')) {
            return false;
        }

        if ($subpattern && (false === strpos($matcher, '(?<key>') || false === strpos($matcher, '(?<value>'))) {
            return false;
        }

        return true;
    }
}


1		<?php
2
3		/**
4		* This file is part of WebHelper Parser.
5		*
6		* (c) James <[email protected]>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		namespace WebHelper\Parser\Server;
13
14		use InvalidArgumentException;
15		use Webmozart\Assert\Assert;
16		use Webmozart\PathUtil\Path;
17
18		/**
19		* A web server instance.
20		*
21		* @author James <[email protected]>
22		*/
23		class Server implements ServerInterface
24		{
25		/**
26		* The filesystem path where the web server is installed.
27		*
28		* It has to be an absolute path.
29		*
30		* Apache httpd server does not accept a relative prefix path at compilation.
31		* Nginx does, but this is a very risky practice...
32		* So relative prefix path in nginx configuration will not be considered
33		*
34		* @var string
35		*/
36		private $prefix = '';
37
38		/**
39		* The string to match as a starting multi-line directive.
40		*
41		* @var string
42		*/
43		private $startMultiLine = '';
44
45		/**
46		* The string to match as an ending multi-line directive.
47		*
48		* @var string
49		*/
50		private $endMultiLine = '';
51
52		/**
53		* The string to match a simple directive.
54		*
55		* @var string
56		*/
57		private $simpleDirective = '';
58
59		/**
60		* Confirms if the server instance has valid parameters.
61		*
62		* @return bool true if all parameters are initialized, false otherwise
63		*/
64	2	public function isValid()
65		{
66	2	$valid = $this->prefix != '';
67	2	$valid = $valid && $this->startMultiLine != '';
68	2	$valid = $valid && $this->endMultiLine != '';
69	2	$valid = $valid && $this->simpleDirective != '';
70
71	2	return $valid;
72		}
73
74		/**
75		* Getter for the prefix.
76		*
77		* @return string the filesystem path where the web server is installed
78		*/
79	2	public function getPrefix()
80		{
81	2	return $this->prefix;
82		}
83
84		/**
85		* Sets the prefix of a server isntance.
86		*
87		* @throws ServerException if the prefix is invalid
88		*
89		* @param string $prefix the filesystem path where the web server is installed
90		*/
91	11	public function setPrefix($prefix)
92		{
93		try {
94	11	Assert::string($prefix);
95	11	} catch (InvalidArgumentException $e) {
96	1	throw ServerException::forInvalidPrefix($prefix, 'The path is expected to be a string. Got: %s');
97		}
98
99	10	if (!Path::isAbsolute($prefix)) {
100	1	throw ServerException::forInvalidPrefix($prefix, 'The path is expected to be absolute. Got: %s');
101		}
102
103	9	if (!is_dir($prefix)) {
104	1	throw ServerException::forInvalidPrefix(
105	1	$prefix,
106		'The path is expected to be an existing directory. Got: %s'
107	1	);
108		}
109
110	8	$this->prefix = $prefix;
111
112	8	return $this;
113		}
114
115		/**
116		* Gets the regexp that will match the starting block directives.
117		*
118		* @return string the regexp that will match the starting block directives
119		*/
120	1	public function getStartMultiLine()
121		{
122	1	return $this->startMultiLine;
123		}
124
125		/**
126		* Sets the regexp that will match the starting block directives.
127		*
128		* @param string $startMultiLine the regexp that will match the starting block directives
129		*/
130	6	public function setStartMultiLine($startMultiLine)
131		{
132	6	$this->startMultiLine = $this->checkString(
133	6	$startMultiLine,
134	6	'The starting block directive matcher is expected to be a string. Got: %s',
135		'The starting block directive matcher is expected to be a regexp '.
136		'containing named subpatterns "key" and "value". Got: %s'
137	6	);
138
139	1	return $this;
140		}
141
142		/**
143		* Gets the regexp that will match the ending block directives.
144		*
145		* @return string the regexp that will match the ending block directives
146		*/
147	1	public function getEndMultiLine()
148		{
149	1	return $this->endMultiLine;
150		}
151
152		/**
153		* Sets the regexp that will match the ending block directives.
154		*
155		* @param string $endMultiLine the regexp that will match the ending block directives
156		*/
157	3	public function setEndMultiLine($endMultiLine)
158		{
159	3	$this->endMultiLine = $this->checkString(
160	3	$endMultiLine,
161	3	'The endind block directive matcher is expected to be a string. Got: %s',
162	3	'The ending block directive matcher is expected to be a regexp . Got: %s',
163		false
164	3	);
165
166	1	return $this;
167		}
168
169		/**
170		* Gets the regexp that will match the simple directives.
171		*
172		* @return string the regexp that will match the simple directives
173		*/
174	1	public function getSimpleDirective()
175		{
176	1	return $this->simpleDirective;
177		}
178
179		/**
180		* Sets the regexp that will match the simple directives.
181		*
182		* @param string $simpleDirective the regexp that will match the simple directives
183		*/
184	6	public function setSimpleDirective($simpleDirective)
185		{
186	6	$this->simpleDirective = $this->checkString(
187	6	$simpleDirective,
188	6	'The simple directive matcher is expected to be a string. Got: %s',
189		'The simple directive matcher is expected to be a regexp '.
190		'containing named subpatterns "key" and "value". Got: %s'
191	6	);
192
193	1	return $this;
194		}
195
196		/**
197		* Checks if the string matches some criterias.
198		*
199		* @param string $string the string to check
200		* @param string $message1 message if not a string
201		* @param string $message2 message if not a regexp
202		* @param bool $subpattern confirms the presence of subpatterns "key" and "value"
203		*
204		* @throws ServerException if the string is invalid
205		*
206		* @return string the string
207		*/
208	15	private function checkString($string, $message1, $message2, $subpattern = true)
209		{
210		try {
211	15	Assert::string($string);
212	15	} catch (InvalidArgumentException $e) {
213	3	throw ServerException::forInvalidMatcher($string, $message1);
214		}
215
216	12	if (!$this->isValidRegex($string, $subpattern)) {
217	9	throw ServerException::forInvalidMatcher($string, $message2);
218		}
219
220	3	return $string;
221		}
222
223		/**
224		* Confirms if a matcher is a valid reguler expression.
225		*
226		* A directive matcher MUST contain a key and a value named subpattern.
227		*
228		* @param string $matcher the matcher to validate
229		* @param bool $subpattern confirms the presence of subpatterns "key" and "value"
230		*
231		* @return bool true if the matcher is valid, false otherwise
232		*/
233	12	private function isValidRegex($matcher, $subpattern = true)
234		{
235	12	if (false === @preg_match($matcher, 'tester')) {
236	3	return false;
237		}
238
239	9	if ($subpattern && (false === strpos($matcher, '(?<key>') \|\| false === strpos($matcher, '(?<value>'))) {
240	6	return false;
241		}
242
243	3	return true;
244		}
245		}
246

JamesRezo / webhelper-parser

GitHub Access Token became invalid

Push — master ( 9082b5...73195f )

Server::setStartMultiLine() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like