Configurator::addHTML5Rules() - Code Metrics - Inspection of "Configurator: removed addHTML5Rules() and integrat..." - s9e/TextFormatter - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 76c01d...227978 )

by Josh

created 2017-07-28 21:45 UTC

Configurator::addHTML5Rules() A

↳ Parent: Configurator::asConfig()

Complexity

Conditions	3
Paths	4

Size

Total Lines	23
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	11
CRAP Score	3

Importance

Changes

Metric	Value
dl	0
loc	23
ccs	11
cts	11
cp	1
rs	9.0856
c	0
b	0
f	0
cc	3
eloc	8
nc	4
nop	0
crap	3

<?php

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

use InvalidArgumentException;
use RuntimeException;
use s9e\TextFormatter\Configurator\BundleGenerator;
use s9e\TextFormatter\Configurator\Collections\AttributeFilterCollection;
use s9e\TextFormatter\Configurator\Collections\PluginCollection;
use s9e\TextFormatter\Configurator\Collections\Ruleset;
use s9e\TextFormatter\Configurator\Collections\TagCollection;
use s9e\TextFormatter\Configurator\ConfigProvider;
use s9e\TextFormatter\Configurator\Helpers\ConfigHelper;
use s9e\TextFormatter\Configurator\Helpers\RulesHelper;
use s9e\TextFormatter\Configurator\JavaScript;
use s9e\TextFormatter\Configurator\JavaScript\Dictionary;
use s9e\TextFormatter\Configurator\Rendering;
use s9e\TextFormatter\Configurator\RulesGenerator;
use s9e\TextFormatter\Configurator\TemplateChecker;
use s9e\TextFormatter\Configurator\TemplateNormalizer;
use s9e\TextFormatter\Configurator\UrlConfig;

/**
* @property Plugins\Autoemail\Configurator $Autoemail Autoemail plugin's configurator
* @property Plugins\Autoimage\Configurator $Autolink Autoimage plugin's configurator
* @property Plugins\Autolink\Configurator $Autolink Autolink plugin's configurator
* @property Plugins\Autovideo\Configurator $Autovideo Autovideo plugin's configurator
* @property Plugins\BBCodes\Configurator $BBCodes BBCodes plugin's configurator
* @property Plugins\Censor\Configurator $Censor Censor plugin's configurator
* @property Plugins\Emoji\Configurator $Emoji Emoji plugin's configurator
* @property Plugins\Emoticons\Configurator $Emoticons Emoticons plugin's configurator
* @property Plugins\Escaper\Configurator $Escaper Escaper plugin's configurator
* @property Plugins\FancyPants\Configurator $FancyPants FancyPants plugin's configurator
* @property Plugins\HTMLComments\Configurator $HTMLComments HTMLComments plugin's configurator
* @property Plugins\HTMLElements\Configurator $HTMLElements HTMLElements plugin's configurator
* @property Plugins\HTMLEntities\Configurator $HTMLEntities HTMLEntities plugin's configurator
* @property Plugins\Keywords\Configurator $Keywords Keywords plugin's configurator
* @property Plugins\Litedown\Configurator $Litedown Litedown plugin's configurator
* @property Plugins\MediaEmbed\Configurator $MediaEmbed MediaEmbed plugin's configurator
* @property Plugins\PipeTables\Configurator $PipeTables PipeTables plugin's configurator
* @property Plugins\Preg\Configurator $Preg Preg plugin's configurator
* @property UrlConfig $urlConfig Default URL config
*/
class Configurator implements ConfigProvider
{
	/**
	* @var AttributeFilterCollection Dynamically-populated collection of AttributeFilter instances
	*/
	public $attributeFilters;

	/**
	* @var BundleGenerator Default bundle generator
	*/
	public $bundleGenerator;

	/**
	* @var JavaScript JavaScript manipulation object
	*/
	public $javascript;

	/**
	* @var PluginCollection Loaded plugins
	*/
	public $plugins;

	/**
	* @var array Array of variables that are available to the filters during parsing
	*/
	public $registeredVars;

	/**
	* @var Rendering Rendering configuration
	*/
	public $rendering;

	/**
	* @var Ruleset Rules that apply at the root of the text
	*/
	public $rootRules;

	/**
	* @var RulesGenerator Generator used by $this->getRenderer()
	*/
	public $rulesGenerator;

	/**
	* @var TagCollection Tags repository
	*/
	public $tags;

	/**
	* @var TemplateChecker Default template checker
	*/
	public $templateChecker;

	/**
	* @var TemplateNormalizer Default template normalizer
	*/
	public $templateNormalizer;

	/**
	* Constructor
	*
	* Prepares the collections that hold tags and filters, the UrlConfig object as well as the
	* various helpers required to generate a full config.
	*/
	public function __construct()
	{
		$this->attributeFilters   = new AttributeFilterCollection;
		$this->bundleGenerator    = new BundleGenerator($this);
		$this->plugins            = new PluginCollection($this);
		$this->registeredVars     = ['urlConfig' => new UrlConfig];
		$this->rendering          = new Rendering($this);
		$this->rootRules          = new Ruleset;
		$this->rulesGenerator     = new RulesGenerator;
		$this->tags               = new TagCollection;
		$this->templateChecker    = new TemplateChecker;
		$this->templateNormalizer = new TemplateNormalizer;
	}

	//==========================================================================
	// Magic methods
	//==========================================================================

	/**
	* Magic __get automatically loads plugins, returns registered vars
	*
	* @param  string $k Property name
	* @return mixed
	*/
	public function __get($k)
	{
		if (preg_match('#^[A-Z][A-Za-z_0-9]+$#D', $k))
		{
			return (isset($this->plugins[$k]))
			     ? $this->plugins[$k]
			     : $this->plugins->load($k);
		}

		if (isset($this->registeredVars[$k]))
		{
			return $this->registeredVars[$k];
		}

		throw new RuntimeException("Undefined property '" . __CLASS__ . '::$' . $k . "'");
	}

	/**
	* Magic __isset checks existence in the plugins collection and registered vars
	*
	* @param  string $k Property name
	* @return bool
	*/
	public function __isset($k)
	{
		if (preg_match('#^[A-Z][A-Za-z_0-9]+$#D', $k))
		{
			return isset($this->plugins[$k]);
		}

		return isset($this->registeredVars[$k]);
	}

	/**
	* Magic __set adds to the plugins collection, registers vars
	*
	* @param  string $k Property name
	* @param  mixed  $v Property value
	* @return mixed
	*/
	public function __set($k, $v)
	{
		if (preg_match('#^[A-Z][A-Za-z_0-9]+$#D', $k))
		{
			$this->plugins[$k] = $v;
		}
		else
		{
			$this->registeredVars[$k] = $v;
		}
	}

	/**
	* Magic __set removes plugins from the plugins collection, unregisters vars
	*
	* @param  string $k Property name
	* @return mixed
	*/
	public function __unset($k)
	{
		if (preg_match('#^[A-Z][A-Za-z_0-9]+$#D', $k))
		{
			unset($this->plugins[$k]);
		}
		else
		{
			unset($this->registeredVars[$k]);
		}
	}

	//==========================================================================
	// API
	//==========================================================================

	/**
	* Enable the creation of a JavaScript parser
	*
	* @return void
	*/
	public function enableJavaScript()
	{
		if (!isset($this->javascript))
		{
			$this->javascript = new JavaScript($this);
		}
	}

	/**
	* Finalize this configuration and return all the relevant objects
	*
	* @return array One "parser" element and one "renderer" element unless specified otherwise
	*/
	public function finalize()
	{
		$return = [];

		// Finalize the plugins' config
		$this->plugins->finalize();

		// Normalize the tags' templates
		foreach ($this->tags as $tag)
		{
			$this->templateNormalizer->normalizeTag($tag);
		}

		// Create a renderer
		$return['renderer'] = $this->rendering->getRenderer();

		// Add the generated tag rules
		$this->addTagRules();

		// Prepare the parser config
		$config = $this->asConfig();
		if (isset($this->javascript))
		{
			$return['js'] = $this->javascript->getParser(ConfigHelper::filterConfig($config, 'JS'));
		}

		// Remove JS-specific data from the config
		$config = ConfigHelper::filterConfig($config, 'PHP');
		ConfigHelper::optimizeArray($config);

		// Create a parser
		$return['parser'] = new Parser($config);

		return $return;
	}

	/**
	* Load a bundle into this configuration
	*
	* @param  string $bundleName Name of the bundle
	* @return void
	*/
	public function loadBundle($bundleName)
	{
		if (!preg_match('#^[A-Z][A-Za-z0-9]+$#D', $bundleName))
		{
			throw new InvalidArgumentException("Invalid bundle name '" . $bundleName . "'");
		}

		$className = __CLASS__ . '\\Bundles\\' . $bundleName;

		$bundle = new $className;
		$bundle->configure($this);
	}

	/**
	* Create and save a bundle based on this configuration
	*
	* @param  string $className Name of the bundle class
	* @param  string $filepath  Path where to save the bundle file
	* @param  array  $options   Options passed to the bundle generator
	* @return bool              Whether the write succeeded
	*/
	public function saveBundle($className, $filepath, array $options = [])
	{
		$file = "<?php\n\n" . $this->bundleGenerator->generate($className, $options);

		return (file_put_contents($filepath, $file) !== false);
	}

	/**
	* Generate and return the complete config array
	*
	* @return array
	*/
	public function asConfig()
	{
		// Finalize the plugins' config
		$this->plugins->finalize();

		// Remove properties that shouldn't be turned into config arrays
		$properties = get_object_vars($this);
		unset($properties['attributeFilters']);
		unset($properties['bundleGenerator']);
		unset($properties['javascript']);
		unset($properties['rendering']);
		unset($properties['rulesGenerator']);
		unset($properties['registeredVars']);
		unset($properties['templateChecker']);
		unset($properties['templateNormalizer']);
		unset($properties['stylesheet']);

		// Create the config array
		$config    = ConfigHelper::toArray($properties);
		$bitfields = RulesHelper::getBitfields($this->tags, $this->rootRules);

		// Save the root context
		$config['rootContext'] = $bitfields['root'];
		$config['rootContext']['flags'] = $config['rootRules']['flags'];

		// Save the registered vars (including the empty ones)
		$config['registeredVars'] = ConfigHelper::toArray($this->registeredVars, true);

		// Make sure those keys exist even if they're empty
		$config += [
			'plugins' => [],
			'tags'    => []
		];

		// Remove unused tags
		$config['tags'] = array_intersect_key($config['tags'], $bitfields['tags']);

		// Add the bitfield information to each tag
		foreach ($bitfields['tags'] as $tagName => $tagBitfields)
		{
			$config['tags'][$tagName] += $tagBitfields;
		}

		// Remove unused entries
		unset($config['rootRules']);

		return $config;
	}

	/**
	* Add the rules generated by $this->rulesGenerator
	*
	* @return void
	*/
	protected function addTagRules()
	{
		// Get the rules
		$rules = $this->rulesGenerator->getRules($this->tags);

		// Add the rules pertaining to the root
		$this->rootRules->merge($rules['root'], false);

		// Add the rules pertaining to each tag
		foreach ($rules['tags'] as $tagName => $tagRules)
		{
			$this->tags[$tagName]->rules->merge($tagRules, false);
		}
	}
}

1		<?php
2
3		/**
4		* @package s9e\TextFormatter
5		* @copyright Copyright (c) 2010-2017 The s9e Authors
6		* @license http://www.opensource.org/licenses/mit-license.php The MIT License
7		*/
8		namespace s9e\TextFormatter;
9
10		use InvalidArgumentException;
11		use RuntimeException;
12		use s9e\TextFormatter\Configurator\BundleGenerator;
13		use s9e\TextFormatter\Configurator\Collections\AttributeFilterCollection;
14		use s9e\TextFormatter\Configurator\Collections\PluginCollection;
15		use s9e\TextFormatter\Configurator\Collections\Ruleset;
16		use s9e\TextFormatter\Configurator\Collections\TagCollection;
17		use s9e\TextFormatter\Configurator\ConfigProvider;
18		use s9e\TextFormatter\Configurator\Helpers\ConfigHelper;
19		use s9e\TextFormatter\Configurator\Helpers\RulesHelper;
20		use s9e\TextFormatter\Configurator\JavaScript;
21		use s9e\TextFormatter\Configurator\JavaScript\Dictionary;
22		use s9e\TextFormatter\Configurator\Rendering;
23		use s9e\TextFormatter\Configurator\RulesGenerator;
24		use s9e\TextFormatter\Configurator\TemplateChecker;
25		use s9e\TextFormatter\Configurator\TemplateNormalizer;
26		use s9e\TextFormatter\Configurator\UrlConfig;
27
28		/**
29		* @property Plugins\Autoemail\Configurator $Autoemail Autoemail plugin's configurator
30		* @property Plugins\Autoimage\Configurator $Autolink Autoimage plugin's configurator
31		* @property Plugins\Autolink\Configurator $Autolink Autolink plugin's configurator
32		* @property Plugins\Autovideo\Configurator $Autovideo Autovideo plugin's configurator
33		* @property Plugins\BBCodes\Configurator $BBCodes BBCodes plugin's configurator
34		* @property Plugins\Censor\Configurator $Censor Censor plugin's configurator
35		* @property Plugins\Emoji\Configurator $Emoji Emoji plugin's configurator
36		* @property Plugins\Emoticons\Configurator $Emoticons Emoticons plugin's configurator
37		* @property Plugins\Escaper\Configurator $Escaper Escaper plugin's configurator
38		* @property Plugins\FancyPants\Configurator $FancyPants FancyPants plugin's configurator
39		* @property Plugins\HTMLComments\Configurator $HTMLComments HTMLComments plugin's configurator
40		* @property Plugins\HTMLElements\Configurator $HTMLElements HTMLElements plugin's configurator
41		* @property Plugins\HTMLEntities\Configurator $HTMLEntities HTMLEntities plugin's configurator
42		* @property Plugins\Keywords\Configurator $Keywords Keywords plugin's configurator
43		* @property Plugins\Litedown\Configurator $Litedown Litedown plugin's configurator
44		* @property Plugins\MediaEmbed\Configurator $MediaEmbed MediaEmbed plugin's configurator
45		* @property Plugins\PipeTables\Configurator $PipeTables PipeTables plugin's configurator
46		* @property Plugins\Preg\Configurator $Preg Preg plugin's configurator
47		* @property UrlConfig $urlConfig Default URL config
48		*/
49		class Configurator implements ConfigProvider
50		{
51		/**
52		* @var AttributeFilterCollection Dynamically-populated collection of AttributeFilter instances
53		*/
54		public $attributeFilters;
55
56		/**
57		* @var BundleGenerator Default bundle generator
58		*/
59		public $bundleGenerator;
60
61		/**
62		* @var JavaScript JavaScript manipulation object
63		*/
64		public $javascript;
65
66		/**
67		* @var PluginCollection Loaded plugins
68		*/
69		public $plugins;
70
71		/**
72		* @var array Array of variables that are available to the filters during parsing
73		*/
74		public $registeredVars;
75
76		/**
77		* @var Rendering Rendering configuration
78		*/
79		public $rendering;
80
81		/**
82		* @var Ruleset Rules that apply at the root of the text
83		*/
84		public $rootRules;
85
86		/**
87		* @var RulesGenerator Generator used by $this->getRenderer()
88		*/
89		public $rulesGenerator;
90
91		/**
92		* @var TagCollection Tags repository
93		*/
94		public $tags;
95
96		/**
97		* @var TemplateChecker Default template checker
98		*/
99		public $templateChecker;
100
101		/**
102		* @var TemplateNormalizer Default template normalizer
103		*/
104		public $templateNormalizer;
105
106		/**
107		* Constructor
108		*
109		* Prepares the collections that hold tags and filters, the UrlConfig object as well as the
110		* various helpers required to generate a full config.
111		*/
112	45	public function __construct()
113		{
114	45	$this->attributeFilters = new AttributeFilterCollection;
115	45	$this->bundleGenerator = new BundleGenerator($this);
116	45	$this->plugins = new PluginCollection($this);
117	45	$this->registeredVars = ['urlConfig' => new UrlConfig];
118	45	$this->rendering = new Rendering($this);
119	45	$this->rootRules = new Ruleset;
120	45	$this->rulesGenerator = new RulesGenerator;
121	45	$this->tags = new TagCollection;
122	45	$this->templateChecker = new TemplateChecker;
123	45	$this->templateNormalizer = new TemplateNormalizer;
124	45	}
125
126		//==========================================================================
127		// Magic methods
128		//==========================================================================
129
130		/**
131		* Magic __get automatically loads plugins, returns registered vars
132		*
133		* @param string $k Property name
134		* @return mixed
135		*/
136	6	public function __get($k)
137		{
138	6	if (preg_match('#^[A-Z][A-Za-z_0-9]+$#D', $k))
139	6	{
140	4	return (isset($this->plugins[$k]))
141	4	? $this->plugins[$k]
142	4	: $this->plugins->load($k);
143		}
144
145	2	if (isset($this->registeredVars[$k]))
146	2	{
147	1	return $this->registeredVars[$k];
148		}
149
150	1	throw new RuntimeException("Undefined property '" . __CLASS__ . '::$' . $k . "'");
151		}
152
153		/**
154		* Magic __isset checks existence in the plugins collection and registered vars
155		*
156		* @param string $k Property name
157		* @return bool
158		*/
159	5	public function __isset($k)
160		{
161	5	if (preg_match('#^[A-Z][A-Za-z_0-9]+$#D', $k))
162	5	{
163	2	return isset($this->plugins[$k]);
164		}
165
166	3	return isset($this->registeredVars[$k]);
167		}
168
169		/**
170		* Magic __set adds to the plugins collection, registers vars
171		*
172		* @param string $k Property name
173		* @param mixed $v Property value
174		* @return mixed
175		*/
176	2	public function __set($k, $v)
177		{
178	2	if (preg_match('#^[A-Z][A-Za-z_0-9]+$#D', $k))
179	2	{
180	1	$this->plugins[$k] = $v;
181	1	}
182		else
183		{
184	1	$this->registeredVars[$k] = $v;
185		}
186	2	}
187
188		/**
189		* Magic __set removes plugins from the plugins collection, unregisters vars
190		*
191		* @param string $k Property name
192		* @return mixed
193		*/
194	2	public function __unset($k)
195		{
196	2	if (preg_match('#^[A-Z][A-Za-z_0-9]+$#D', $k))
197	2	{
198	1	unset($this->plugins[$k]);
199	1	}
200		else
201		{
202	1	unset($this->registeredVars[$k]);
203		}
204	2	}
205
206		//==========================================================================
207		// API
208		//==========================================================================
209
210		/**
211		* Enable the creation of a JavaScript parser
212		*
213		* @return void
214		*/
215	3	public function enableJavaScript()
216		{
217	3	if (!isset($this->javascript))
218	3	{
219	3	$this->javascript = new JavaScript($this);
220	3	}
221	3	}
222
223		/**
224		* Finalize this configuration and return all the relevant objects
225		*
226		* @return array One "parser" element and one "renderer" element unless specified otherwise
227		*/
228	11	public function finalize()
229		{
230	11	$return = [];
231
232		// Finalize the plugins' config
233	11	$this->plugins->finalize();
234
235		// Normalize the tags' templates
236	11	foreach ($this->tags as $tag)
237		{
238	5	$this->templateNormalizer->normalizeTag($tag);
239	11	}
240
241		// Create a renderer
242	11	$return['renderer'] = $this->rendering->getRenderer();
243
244		// Add the generated tag rules
245	11	$this->addTagRules();
246
247		// Prepare the parser config
248	11	$config = $this->asConfig();
249	11	if (isset($this->javascript))
250	11	{
251	1	$return['js'] = $this->javascript->getParser(ConfigHelper::filterConfig($config, 'JS'));
252	1	}
253
254		// Remove JS-specific data from the config
255	11	$config = ConfigHelper::filterConfig($config, 'PHP');
256	11	ConfigHelper::optimizeArray($config);
257
258		// Create a parser
259	11	$return['parser'] = new Parser($config);
260
261	11	return $return;
262		}
263
264		/**
265		* Load a bundle into this configuration
266		*
267		* @param string $bundleName Name of the bundle
268		* @return void
269		*/
270	2	public function loadBundle($bundleName)
271		{
272	2	if (!preg_match('#^[A-Z][A-Za-z0-9]+$#D', $bundleName))
273	2	{
274	1	throw new InvalidArgumentException("Invalid bundle name '" . $bundleName . "'");
275		}
276
277	1	$className = __CLASS__ . '\\Bundles\\' . $bundleName;
278
279	1	$bundle = new $className;
280	1	$bundle->configure($this);
281	1	}
282
283		/**
284		* Create and save a bundle based on this configuration
285		*
286		* @param string $className Name of the bundle class
287		* @param string $filepath Path where to save the bundle file
288		* @param array $options Options passed to the bundle generator
289		* @return bool Whether the write succeeded
290		*/
291	3	public function saveBundle($className, $filepath, array $options = [])
292		{
293	3	$file = "<?php\n\n" . $this->bundleGenerator->generate($className, $options);
294
295	3	return (file_put_contents($filepath, $file) !== false);
296		}
297
298		/**
299		* Generate and return the complete config array
300		*
301		* @return array
302		*/
303	20	public function asConfig()
304		{
305		// Finalize the plugins' config
306	20	$this->plugins->finalize();
307
308		// Remove properties that shouldn't be turned into config arrays
309	20	$properties = get_object_vars($this);
310	20	unset($properties['attributeFilters']);
311	20	unset($properties['bundleGenerator']);
312	20	unset($properties['javascript']);
313	20	unset($properties['rendering']);
314	20	unset($properties['rulesGenerator']);
315	20	unset($properties['registeredVars']);
316	20	unset($properties['templateChecker']);
317	20	unset($properties['templateNormalizer']);
318	20	unset($properties['stylesheet']);
319
320		// Create the config array
321	20	$config = ConfigHelper::toArray($properties);
322	20	$bitfields = RulesHelper::getBitfields($this->tags, $this->rootRules);
323
324		// Save the root context
325	20	$config['rootContext'] = $bitfields['root'];
326	20	$config['rootContext']['flags'] = $config['rootRules']['flags'];
327
328		// Save the registered vars (including the empty ones)
329	20	$config['registeredVars'] = ConfigHelper::toArray($this->registeredVars, true);
330
331		// Make sure those keys exist even if they're empty
332		$config += [
333	20	'plugins' => [],
334	20	'tags' => []
335	20	];
336
337		// Remove unused tags
338	20	$config['tags'] = array_intersect_key($config['tags'], $bitfields['tags']);
339
340		// Add the bitfield information to each tag
341	20	foreach ($bitfields['tags'] as $tagName => $tagBitfields)
342		{
343	6	$config['tags'][$tagName] += $tagBitfields;
344	20	}
345
346		// Remove unused entries
347	20	unset($config['rootRules']);
348
349	20	return $config;
350		}
351
352		/**
353		* Add the rules generated by $this->rulesGenerator
354		*
355		* @return void
356		*/
357	11	protected function addTagRules()
358		{
359		// Get the rules
360	11	$rules = $this->rulesGenerator->getRules($this->tags);
361
362		// Add the rules pertaining to the root
363	11	$this->rootRules->merge($rules['root'], false);
364
365		// Add the rules pertaining to each tag
366	11	foreach ($rules['tags'] as $tagName => $tagRules)
367		{
368	5	$this->tags[$tagName]->rules->merge($tagRules, false);
369	11	}
370		}
371		}

s9e / TextFormatter

Push — master ( 76c01d...227978 )

Configurator::addHTML5Rules() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like