BundleGenerator::exportCallback() - Code Metrics - Inspection of "Added support for custom header in generated PHP f..." - s9e/TextFormatter - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( e707f6...7dde98 )

by Josh

created 2019-11-17 15:50 UTC

BundleGenerator::exportCallback() A

↳ Parent: BundleGenerator

Complexity

Conditions	6
Paths	10

Size

Total Lines	26
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	10
CRAP Score	6

Importance

Changes

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

<?php

/**
* @package   s9e\TextFormatter
* @copyright Copyright (c) 2010-2019 The s9e Authors
* @license   http://www.opensource.org/licenses/mit-license.php The MIT License
*/
namespace s9e\TextFormatter\Configurator;

use s9e\TextFormatter\Configurator;
use s9e\TextFormatter\Configurator\RendererGenerators\PHP;

class BundleGenerator
{
	/**
	* @var Configurator Configurator this instance belongs to
	*/
	protected $configurator;

	/**
	* @var callback Callback used to serialize the objects
	*/
	public $serializer = 'serialize';

	/**
	* @var string Callback used to unserialize the serialized objects (must be a string)
	*/
	public $unserializer = 'unserialize';

	/**
	* Constructor
	*
	* @param  Configurator $configurator Configurator
	*/
	public function __construct(Configurator $configurator)
	{
		$this->configurator = $configurator;
	}

	/**
	* Create and return the source of a bundle based on given Configurator instance
	*
	* Options:
	*
	*  - autoInclude: automatically load the source of the PHP renderer (default: true)
	*
	* @param  string $className Name of the bundle class
	* @param  array  $options   Associative array of optional settings
	* @return string            PHP source for the bundle
	*/
	public function generate($className, array $options = [])
	{
		// Add default options
		$options += ['autoInclude' => true];

		// Copy the PHP files header if applicable
		if ($this->configurator->rendering->engine instanceof PHP)
		{
			$this->configurator->rendering->engine->phpHeader = $this->configurator->phpHeader;
		}

		// Get the parser and renderer
		$objects  = $this->configurator->finalize();
		$parser   = $objects['parser'];
		$renderer = $objects['renderer'];

		// Split the bundle's class name and its namespace
		$namespace = '';
		if (preg_match('#(.*)\\\\([^\\\\]+)$#', $className, $m))
		{
			$namespace = $m[1];
			$className = $m[2];
		}

		// Start with the standard header
		$php   = [];
		$php[] = $this->configurator->phpHeader;

		if ($namespace)
		{
			$php[] = 'namespace ' . $namespace . ';';
			$php[] = '';
		}

		// Generate and append the bundle class
		$php[] = 'abstract class ' . $className . ' extends \\s9e\\TextFormatter\\Bundle';
		$php[] = '{';
		$php[] = '	/**';
		$php[] = '	* @var s9e\\TextFormatter\\Parser Singleton instance used by parse()';
		$php[] = '	*/';
		$php[] = '	protected static $parser;';
		$php[] = '';
		$php[] = '	/**';
		$php[] = '	* @var s9e\\TextFormatter\\Renderer Singleton instance used by render()';
		$php[] = '	*/';
		$php[] = '	protected static $renderer;';
		$php[] = '';

		// Add the event callbacks if applicable
		$events = [
			'beforeParse'
				=> 'Callback executed before parse(), receives the original text as argument',
			'afterParse'
				=> 'Callback executed after parse(), receives the parsed text as argument',
			'beforeRender'
				=> 'Callback executed before render(), receives the parsed text as argument',
			'afterRender'
				=> 'Callback executed after render(), receives the output as argument',
			'beforeUnparse'
				=> 'Callback executed before unparse(), receives the parsed text as argument',
			'afterUnparse'
				=> 'Callback executed after unparse(), receives the original text as argument'
		];
		foreach ($events as $eventName => $eventDesc)
		{
			if (isset($options[$eventName]))
			{
				$php[] = '	/**';
				$php[] = '	* @var ' . $eventDesc;
				$php[] = '	*/';
				$php[] = '	public static $' . $eventName . ' = ' . var_export($options[$eventName], true) . ';';
				$php[] = '';
			}
		}

		if (isset($objects['js']))
		{
			$php[] = '	/**';
			$php[] = '	* {@inheritdoc}';
			$php[] = '	*/';
			$php[] = '	public static function getJS()';
			$php[] = '	{';
			$php[] = '		return ' . var_export($objects['js'], true) . ';';
			$php[] = '	}';
			$php[] = '';
		}

		$php[] = '	/**';
		$php[] = '	* {@inheritdoc}';
		$php[] = '	*/';
		$php[] = '	public static function getParser()';
		$php[] = '	{';

		if (isset($options['parserSetup']))
		{
			$php[] = '		$parser = ' . $this->exportObject($parser) . ';';
			$php[] = '		' . $this->exportCallback($namespace, $options['parserSetup'], '$parser') . ';';
			$php[] = '';
			$php[] = '		return $parser;';
		}
		else
		{
			$php[] = '		return ' . $this->exportObject($parser) . ';';
		}

		$php[] = '	}';
		$php[] = '';
		$php[] = '	/**';
		$php[] = '	* {@inheritdoc}';
		$php[] = '	*/';
		$php[] = '	public static function getRenderer()';
		$php[] = '	{';

		// If this is a PHP renderer and we know where it's saved, automatically load it as needed
		if (!empty($options['autoInclude'])
		 && $this->configurator->rendering->engine instanceof PHP
		 && isset($this->configurator->rendering->engine->lastFilepath))
		{
			$className = get_class($renderer);
			$filepath  = realpath($this->configurator->rendering->engine->lastFilepath);

			$php[] = '		if (!class_exists(' . var_export($className, true) . ', false)';
			$php[] = '		 && file_exists(' . var_export($filepath, true) . '))';
			$php[] = '		{';
			$php[] = '			include ' . var_export($filepath, true) . ';';
			$php[] = '		}';
			$php[] = '';
		}

		if (isset($options['rendererSetup']))
		{
			$php[] = '		$renderer = ' . $this->exportObject($renderer) . ';';
			$php[] = '		' . $this->exportCallback($namespace, $options['rendererSetup'], '$renderer') . ';';
			$php[] = '';
			$php[] = '		return $renderer;';
		}
		else
		{
			$php[] = '		return ' . $this->exportObject($renderer) . ';';
		}

		$php[] = '	}';
		$php[] = '}';

		return implode("\n", $php);
	}

	/**
	* Export a given callback as PHP code
	*
	* @param  string   $namespace Namespace in which the callback is execute
	* @param  callable $callback  Original callback
	* @param  string   $argument  Callback's argument (as PHP code)
	* @return string              PHP code
	*/
	protected function exportCallback($namespace, callable $callback, $argument)
	{
		if (is_array($callback) && is_string($callback[0]))
		{
			// Replace ['foo', 'bar'] with 'foo::bar'
			$callback = $callback[0] . '::' . $callback[1];
		}

		if (!is_string($callback))
		{
			return 'call_user_func(' . var_export($callback, true) . ', ' . $argument . ')';
		}

		// Ensure that the callback starts with a \
		if ($callback[0] !== '\\')
		{
			$callback = '\\' . $callback;
		}

		// Replace \foo\bar::baz() with bar::baz() if we're in namespace foo
		if (substr($callback, 0, 2 + strlen($namespace)) === '\\' . $namespace . '\\')
		{
			$callback = substr($callback, 2 + strlen($namespace));
		}

		return $callback . '(' . $argument . ')';
	}

	/**
	* Serialize and export a given object as PHP code
	*
	* @param  object $obj Original object
	* @return string      PHP code
	*/
	protected function exportObject($obj)
	{
		// Serialize the object
		$str = call_user_func($this->serializer, $obj);

		// Export the object's source
		$str = var_export($str, true);

		return $this->unserializer . '(' . $str . ')';
	}
}

1		<?php
2
3		/**
4		* @package s9e\TextFormatter
5		* @copyright Copyright (c) 2010-2019 The s9e Authors
6		* @license http://www.opensource.org/licenses/mit-license.php The MIT License
7		*/
8		namespace s9e\TextFormatter\Configurator;
9
10		use s9e\TextFormatter\Configurator;
11		use s9e\TextFormatter\Configurator\RendererGenerators\PHP;
12
13		class BundleGenerator
14		{
15		/**
16		* @var Configurator Configurator this instance belongs to
17		*/
18		protected $configurator;
19
20		/**
21		* @var callback Callback used to serialize the objects
22		*/
23		public $serializer = 'serialize';
24
25		/**
26		* @var string Callback used to unserialize the serialized objects (must be a string)
27		*/
28		public $unserializer = 'unserialize';
29
30		/**
31		* Constructor
32		*
33		* @param Configurator $configurator Configurator
34		*/
35	23	public function __construct(Configurator $configurator)
36		{
37	23	$this->configurator = $configurator;
38		}
39
40		/**
41		* Create and return the source of a bundle based on given Configurator instance
42		*
43		* Options:
44		*
45		* - autoInclude: automatically load the source of the PHP renderer (default: true)
46		*
47		* @param string $className Name of the bundle class
48		* @param array $options Associative array of optional settings
49		* @return string PHP source for the bundle
50		*/
51	12	public function generate($className, array $options = [])
52		{
53		// Add default options
54	12	$options += ['autoInclude' => true];
55
56		// Copy the PHP files header if applicable
57	12	if ($this->configurator->rendering->engine instanceof PHP)
58		{
59	2	$this->configurator->rendering->engine->phpHeader = $this->configurator->phpHeader;
60		}
61
62		// Get the parser and renderer
63	12	$objects = $this->configurator->finalize();
64	12	$parser = $objects['parser'];
65	12	$renderer = $objects['renderer'];
66
67		// Split the bundle's class name and its namespace
68	12	$namespace = '';
69	12	if (preg_match('#(.*)\\\\([^\\\\]+)$#', $className, $m))
70		{
71	1	$namespace = $m[1];
72	1	$className = $m[2];
73		}
74
75		// Start with the standard header
76	12	$php = [];
77	12	$php[] = $this->configurator->phpHeader;
78
79	12	if ($namespace)
80		{
81	1	$php[] = 'namespace ' . $namespace . ';';
82	1	$php[] = '';
83		}
84
85		// Generate and append the bundle class
86	12	$php[] = 'abstract class ' . $className . ' extends \\s9e\\TextFormatter\\Bundle';
87	12	$php[] = '{';
88	12	$php[] = ' /**';
89	12	$php[] = ' * @var s9e\\TextFormatter\\Parser Singleton instance used by parse()';
90	12	$php[] = ' */';
91	12	$php[] = ' protected static $parser;';
92	12	$php[] = '';
93	12	$php[] = ' /**';
94	12	$php[] = ' * @var s9e\\TextFormatter\\Renderer Singleton instance used by render()';
95	12	$php[] = ' */';
96	12	$php[] = ' protected static $renderer;';
97	12	$php[] = '';
98
99		// Add the event callbacks if applicable
100		$events = [
101		'beforeParse'
102	12	=> 'Callback executed before parse(), receives the original text as argument',
103		'afterParse'
104		=> 'Callback executed after parse(), receives the parsed text as argument',
105		'beforeRender'
106		=> 'Callback executed before render(), receives the parsed text as argument',
107		'afterRender'
108		=> 'Callback executed after render(), receives the output as argument',
109		'beforeUnparse'
110		=> 'Callback executed before unparse(), receives the parsed text as argument',
111		'afterUnparse'
112		=> 'Callback executed after unparse(), receives the original text as argument'
113		];
114	12	foreach ($events as $eventName => $eventDesc)
115		{
116	12	if (isset($options[$eventName]))
117		{
118	1	$php[] = ' /**';
119	1	$php[] = ' * @var ' . $eventDesc;
120	1	$php[] = ' */';
121	1	$php[] = ' public static $' . $eventName . ' = ' . var_export($options[$eventName], true) . ';';
122	1	$php[] = '';
123		}
124		}
125
126	12	if (isset($objects['js']))
127		{
128	1	$php[] = ' /**';
129	1	$php[] = ' * {@inheritdoc}';
130	1	$php[] = ' */';
131	1	$php[] = ' public static function getJS()';
132	1	$php[] = ' {';
133	1	$php[] = ' return ' . var_export($objects['js'], true) . ';';
134	1	$php[] = ' }';
135	1	$php[] = '';
136		}
137
138	12	$php[] = ' /**';
139	12	$php[] = ' * {@inheritdoc}';
140	12	$php[] = ' */';
141	12	$php[] = ' public static function getParser()';
142	12	$php[] = ' {';
143
144	12	if (isset($options['parserSetup']))
145		{
146	1	$php[] = ' $parser = ' . $this->exportObject($parser) . ';';
147	1	$php[] = ' ' . $this->exportCallback($namespace, $options['parserSetup'], '$parser') . ';';
148	1	$php[] = '';
149	1	$php[] = ' return $parser;';
150		}
151		else
152		{
153	11	$php[] = ' return ' . $this->exportObject($parser) . ';';
154		}
155
156	12	$php[] = ' }';
157	12	$php[] = '';
158	12	$php[] = ' /**';
159	12	$php[] = ' * {@inheritdoc}';
160	12	$php[] = ' */';
161	12	$php[] = ' public static function getRenderer()';
162	12	$php[] = ' {';
163
164		// If this is a PHP renderer and we know where it's saved, automatically load it as needed
165	12	if (!empty($options['autoInclude'])
166	12	&& $this->configurator->rendering->engine instanceof PHP
167	12	&& isset($this->configurator->rendering->engine->lastFilepath))
168		{
169	1	$className = get_class($renderer);
170	1	$filepath = realpath($this->configurator->rendering->engine->lastFilepath);
171
172	1	$php[] = ' if (!class_exists(' . var_export($className, true) . ', false)';
173	1	$php[] = ' && file_exists(' . var_export($filepath, true) . '))';
174	1	$php[] = ' {';
175	1	$php[] = ' include ' . var_export($filepath, true) . ';';
176	1	$php[] = ' }';
177	1	$php[] = '';
178		}
179
180	12	if (isset($options['rendererSetup']))
181		{
182	1	$php[] = ' $renderer = ' . $this->exportObject($renderer) . ';';
183	1	$php[] = ' ' . $this->exportCallback($namespace, $options['rendererSetup'], '$renderer') . ';';
184	1	$php[] = '';
185	1	$php[] = ' return $renderer;';
186		}
187		else
188		{
189	11	$php[] = ' return ' . $this->exportObject($renderer) . ';';
190		}
191
192	12	$php[] = ' }';
193	12	$php[] = '}';
194
195	12	return implode("\n", $php);
196		}
197
198		/**
199		* Export a given callback as PHP code
200		*
201		* @param string $namespace Namespace in which the callback is execute
202		* @param callable $callback Original callback
203		* @param string $argument Callback's argument (as PHP code)
204		* @return string PHP code
205		*/
206	11	protected function exportCallback($namespace, callable $callback, $argument)
207		{
208	11	if (is_array($callback) && is_string($callback[0]))
209		{
210		// Replace ['foo', 'bar'] with 'foo::bar'
211	1	$callback = $callback[0] . '::' . $callback[1];
212		}
213
214	11	if (!is_string($callback))
215		{
216	1	return 'call_user_func(' . var_export($callback, true) . ', ' . $argument . ')';
217		}
218
219		// Ensure that the callback starts with a \
220	10	if ($callback[0] !== '\\')
221		{
222	5	$callback = '\\' . $callback;
223		}
224
225		// Replace \foo\bar::baz() with bar::baz() if we're in namespace foo
226	10	if (substr($callback, 0, 2 + strlen($namespace)) === '\\' . $namespace . '\\')
227		{
228	4	$callback = substr($callback, 2 + strlen($namespace));
229		}
230
231	10	return $callback . '(' . $argument . ')';
232		}
233
234		/**
235		* Serialize and export a given object as PHP code
236		*
237		* @param object $obj Original object
238		* @return string PHP code
239		*/
240	14	protected function exportObject($obj)
241		{
242		// Serialize the object
243	14	$str = call_user_func($this->serializer, $obj);
244
245		// Export the object's source
246	14	$str = var_export($str, true);
247
248	14	return $this->unserializer . '(' . $str . ')';
249		}
250		}

s9e / TextFormatter

Push — master ( e707f6...7dde98 )

BundleGenerator::exportCallback() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like