Partial::compileDynamic() - Code Metrics - Inspection of "fix for 1 more inline partial spec" - zordius/lightncandy - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — v0.89-develop ( 178f3d...f4df6d )

by Zordius

created 2015-12-04 09:22 UTC

Partial::compileDynamic() A

↳ Parent: Partial

Complexity

Conditions	2
Paths	2

Size

Total Lines	9
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	2

Importance

Changes	3
Bugs	1	Features	0

Metric	Value
c	3
b	1
f	0
dl	0
loc	9
ccs	6
cts	6
cp	1
rs	9.6667
cc	2
eloc	6
nc	2
nop	2
crap	2

<?php
/*

Copyrights for code authored by Yahoo! Inc. is licensed under the following terms:
MIT License
Copyright (c) 2013-2015 Yahoo! Inc. All Rights Reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Origin: https://github.com/zordius/lightncandy
*/

/**
 * file to keep LightnCandy partial methods
 *
 * @package    LightnCandy
 * @author     Zordius <[email protected]>
 */

namespace LightnCandy;

use \LightnCandy\Compiler;
use \LightnCandy\SafeString;
use \LightnCandy\Context;

/**
 * LightnCandy Partial handler
 */
class Partial
{
    public static $TMP_JS_FUNCTION_STR = "!!\aFuNcTiOn\a!!";                                            

    /**
     * Include all partials when using dynamic partials
     */
    public static function handleDynamicPartial(&$context) {
        if ($context['usedFeature']['dynpartial'] == 0) {
            return;
        }

        foreach ($context['partials'] as $name => $code) {
            static::readPartial($name, $context);
        }
    }

    /**
     * Read partial file content as string and store in context
     *
     * @param string $name partial name
     * @param array<string,array|string|integer> $context Current context of compiler progress.
     */
    public static function readPartial($name, &$context) {
        $context['usedFeature']['partial']++;

        if (isset($context['usedPartial'][$name])) {
            return;
        }

        if (isset($context['inlines'][$name])) {
            return;
        }

        $cnt = static::resolvePartial($name, $context);

        if ($cnt !== null) {
            $context['usedPartial'][$name] = SafeString::escapeTemplate($cnt);
            return static::compileDynamic($name, $context);
        }

        if (!$context['flags']['skippartial']) {
            $context['error'][] = "Can not find partial file for '$name', you should set correct basedir and fileext in options";
        }
    }

    /**
     * preprocess partial template before it be stored into context
     *
     * @param string $tmpl partial template
     * @param string $name partial name
     * @param array<string,array|string|integer> $context Current context of compiler progress.
     *
     * @return string|null $content processed partial template
     *
     * @expect 'hey' when input 'hey', 'haha', Array('prepartial' => false)
     * @expect 'haha-hoho' when input 'hoho', 'haha', Array('prepartial' => function ($tmpl, $name) {return "$name-$tmpl";})
     */
    protected static function prePartial($tmpl, &$name, &$context) {
        return $context['prepartial'] ? $context['prepartial']($tmpl, $name, $context) : $tmpl;
    }

    /**
     * locate partial file, return the file name
     *
     * @param string $name partial name
     * @param array<string,array|string|integer> $context Current context of compiler progress.
     *
     * @return string|null $content partial content
     */
    public static function resolvePartial(&$name, &$context) {
        if (isset($context['partials'][$name])) {
            return static::prePartial($context['partials'][$name], $name, $context);
        }

        foreach ($context['basedir'] as $dir) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            foreach ($context['fileext'] as $ext) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
                $fn = "$dir/$name$ext";
                if (file_exists($fn)) {
                    return static::prePartial(file_get_contents($fn), $name, $context);
                }
            }
        }
        return null;
    }

    /**
     * compile a partial to static embed PHP code
     *
     * @param array<string,array|string|integer> $context Current context of compiler progress.
     * @param string $name partial name
     *
     * @return string|null $code PHP code string
     */
    public static function compileStatic(&$context, $name) {
        // Check for recursive partial
        if (!$context['flags']['runpart']) {
            $context['partialStack'][] = $name;
            $diff = count($context['partialStack']) - count(array_unique($context['partialStack']));
            if ($diff) {
                $context['error'][] = 'I found recursive partial includes as the path: ' . implode(' -> ', $context['partialStack']) . '! You should fix your template or compile with LightnCandy::FLAG_RUNTIMEPARTIAL flag.';
            }
        }

        $code = Compiler::compileTemplate($context, preg_replace('/^/m', $context['tokens']['partialind'], $context['usedPartial'][$name]));

        if (!$context['flags']['runpart']) {
            array_pop($context['partialStack']);
        }

        return $code;
    }

    /**
     * compile partial file, stored in context
     *
     * @param string $name partial name
     * @param array<string,array|string|integer> $context Current context of compiler progress.
     *
     * @return string $code compiled PHP code

     */
    public static function compileDynamic($name, &$context) {
        if (!$context['flags']['runpart']) {
            return;
        }

        $func = static::compileLocal($context, $context['usedPartial'][$name]);
        $context['partialCode'] .= "'$name' => $func,";
        return $func;
    }

    /**
     * compile a template into a closure function
     *
     * @param array<string,array|string|integer> $context Current context of compiler progress.
     * @param string $template template string
     *
     * @return string $code compiled PHP code
     */
    public static function compileLocal(&$context, $template) {
        $tmpContext = $context;
        $tmpContext['inlinepartial'] = array();
        $tmpContext['partialblock'] = array();
        $code = Compiler::compileTemplate($tmpContext, str_replace('function', static::$TMP_JS_FUNCTION_STR, $template));
        Context::merge($context, $tmpContext);
        if (!$context['flags']['noind']) {
            $sp = ', $sp';
            $code = preg_replace('/^/m', "'{$context['ops']['seperator']}\$sp{$context['ops']['seperator']}'", $code);
            // callbacks inside partial should be aware of $sp
            $code = preg_replace('/\bfunction\s*\((.*?)\)\s*{/', 'function(\\1)use($sp){', $code);
        } else {
            $sp = '';
        }
        $code = str_replace(static::$TMP_JS_FUNCTION_STR, 'function', $code);
        return "function (\$cx, \$in{$sp}) {{$context['ops']['op_start']}'$code'{$context['ops']['op_end']}}";
    }
}



1		<?php
2		/*
3
4		Copyrights for code authored by Yahoo! Inc. is licensed under the following terms:
5		MIT License
6		Copyright (c) 2013-2015 Yahoo! Inc. All Rights Reserved.
7		Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
8		The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
9		THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
10
11		Origin: https://github.com/zordius/lightncandy
12		*/
13
14		/**
15		* file to keep LightnCandy partial methods
16		*
17		* @package LightnCandy
18		* @author Zordius <[email protected]>
19		*/
20
21		namespace LightnCandy;
22
23		use \LightnCandy\Compiler;
24		use \LightnCandy\SafeString;
25		use \LightnCandy\Context;
26
27		/**
28		* LightnCandy Partial handler
29		*/
30		class Partial
31		{
32		public static $TMP_JS_FUNCTION_STR = "!!\aFuNcTiOn\a!!";
33
34		/**
35		* Include all partials when using dynamic partials
36		*/
37	643	public static function handleDynamicPartial(&$context) {
38	643	if ($context['usedFeature']['dynpartial'] == 0) {
39	639	return;
40		}
41
42	4	foreach ($context['partials'] as $name => $code) {
43	4	static::readPartial($name, $context);
44		}
45	4	}
46
47		/**
48		* Read partial file content as string and store in context
49		*
50		* @param string $name partial name
51		* @param array<string,array\|string\|integer> $context Current context of compiler progress.
52		*/
53	84	public static function readPartial($name, &$context) {
54	84	$context['usedFeature']['partial']++;
55
56	84	if (isset($context['usedPartial'][$name])) {
57	23	return;
58		}
59
60	78	if (isset($context['inlines'][$name])) {
61		return;
62		}
63
64	78	$cnt = static::resolvePartial($name, $context);
65
66	78	if ($cnt !== null) {
67	72	$context['usedPartial'][$name] = SafeString::escapeTemplate($cnt);
68	72	return static::compileDynamic($name, $context);
69		}
70
71	6	if (!$context['flags']['skippartial']) {
72	5	$context['error'][] = "Can not find partial file for '$name', you should set correct basedir and fileext in options";
73		}
74	6	}
75
76		/**
77		* preprocess partial template before it be stored into context
78		*
79		* @param string $tmpl partial template
80		* @param string $name partial name
81		* @param array<string,array\|string\|integer> $context Current context of compiler progress.
82		*
83		* @return string\|null $content processed partial template
84		*
85		* @expect 'hey' when input 'hey', 'haha', Array('prepartial' => false)
86		* @expect 'haha-hoho' when input 'hoho', 'haha', Array('prepartial' => function ($tmpl, $name) {return "$name-$tmpl";})
87		*/
88	73	protected static function prePartial($tmpl, &$name, &$context) {
89	73	return $context['prepartial'] ? $context['prepartial']($tmpl, $name, $context) : $tmpl;
90		}
91
92		/**
93		* locate partial file, return the file name
94		*
95		* @param string $name partial name
96		* @param array<string,array\|string\|integer> $context Current context of compiler progress.
97		*
98		* @return string\|null $content partial content
99		*/
100	82	public static function resolvePartial(&$name, &$context) {
101	82	if (isset($context['partials'][$name])) {
102	65	return static::prePartial($context['partials'][$name], $name, $context);
103		}
104
105	17	foreach ($context['basedir'] as $dir) {
		1 ignored issue – show Bug introduced 2015-11-21 08:41 UTC by Report Bug Copy Issue Report The expression `$context['basedir']` of type `array\|string\|integer` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
106	15	foreach ($context['fileext'] as $ext) {
		1 ignored issue – show Bug introduced 2015-11-21 08:41 UTC by Report Bug Copy Issue Report The expression `$context['fileext']` of type `array\|string\|integer` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
107	15	$fn = "$dir/$name$ext";
108	15	if (file_exists($fn)) {
109	15	return static::prePartial(file_get_contents($fn), $name, $context);
110		}
111		}
112		}
113	10	return null;
114		}
115
116		/**
117		* compile a partial to static embed PHP code
118		*
119		* @param array<string,array\|string\|integer> $context Current context of compiler progress.
120		* @param string $name partial name
121		*
122		* @return string\|null $code PHP code string
123		*/
124	7	public static function compileStatic(&$context, $name) {
125		// Check for recursive partial
126	7	if (!$context['flags']['runpart']) {
127	7	$context['partialStack'][] = $name;
128	7	$diff = count($context['partialStack']) - count(array_unique($context['partialStack']));
129	7	if ($diff) {
130	1	$context['error'][] = 'I found recursive partial includes as the path: ' . implode(' -> ', $context['partialStack']) . '! You should fix your template or compile with LightnCandy::FLAG_RUNTIMEPARTIAL flag.';
131		}
132		}
133
134	7	$code = Compiler::compileTemplate($context, preg_replace('/^/m', $context['tokens']['partialind'], $context['usedPartial'][$name]));
135
136	7	if (!$context['flags']['runpart']) {
137	7	array_pop($context['partialStack']);
138		}
139
140	7	return $code;
141		}
142
143		/**
144		* compile partial file, stored in context
145		*
146		* @param string $name partial name
147		* @param array<string,array\|string\|integer> $context Current context of compiler progress.
148		*
149		* @return string $code compiled PHP code
		0 ignored issues – show Documentation introduced 2015-12-04 09:24 UTC by Report Bug Copy Issue Report Should the return type not be `null\|string`? 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...
150		*/
151	82	public static function compileDynamic($name, &$context) {
152	82	if (!$context['flags']['runpart']) {
153	8	return;
154		}
155
156	74	$func = static::compileLocal($context, $context['usedPartial'][$name]);
157	74	$context['partialCode'] .= "'$name' => $func,";
158	74	return $func;
159		}
160
161		/**
162		* compile a template into a closure function
163		*
164		* @param array<string,array\|string\|integer> $context Current context of compiler progress.
165		* @param string $template template string
166		*
167		* @return string $code compiled PHP code
168		*/
169	74	public static function compileLocal(&$context, $template) {
170	74	$tmpContext = $context;
171	74	$tmpContext['inlinepartial'] = array();
172	74	$tmpContext['partialblock'] = array();
173	74	$code = Compiler::compileTemplate($tmpContext, str_replace('function', static::$TMP_JS_FUNCTION_STR, $template));
174	74	Context::merge($context, $tmpContext);
175	74	if (!$context['flags']['noind']) {
176	69	$sp = ', $sp';
177	69	$code = preg_replace('/^/m', "'{$context['ops']['seperator']}\$sp{$context['ops']['seperator']}'", $code);
178		// callbacks inside partial should be aware of $sp
179	69	$code = preg_replace('/\bfunction\s\((.?)\)\s*{/', 'function(\\1)use($sp){', $code);
180		} else {
181	5	$sp = '';
182		}
183	74	$code = str_replace(static::$TMP_JS_FUNCTION_STR, 'function', $code);
184	74	return "function (\$cx, \$in{$sp}) {{$context['ops']['op_start']}'$code'{$context['ops']['op_end']}}";
185		}
186		}
187
188

zordius / lightncandy

GitHub Access Token became invalid

Push — v0.89-develop ( 178f3d...f4df6d )

Partial::compileDynamic() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like