Code Coverage for D:\Apache2.4.33\htdocs\iaLib\inc_ia\DocumentIt\src\PerfilExample.php

	Code Coverage
	Classes and Traits			Functions and Methods				Lines
Total	0.00% covered (danger)	0.00%	0 / 1	0.00% covered (danger)	0.00%	0 / 18	CRAP	0.00% covered (danger)	0.00%	0 / 219
PerfilExample	0.00% covered (danger)	0.00%	0 / 1	0.00% covered (danger)	0.00%	0 / 18	7310.00	0.00% covered (danger)	0.00%	0 / 219
__construct				0.00% covered (danger)	0.00%	0 / 1	2.00	0.00% covered (danger)	0.00%	0 / 7
getFileSystemControllerPath				0.00% covered (danger)	0.00%	0 / 1	2.00	0.00% covered (danger)	0.00%	0 / 1
getFileSystemCodePath				0.00% covered (danger)	0.00%	0 / 1	2.00	0.00% covered (danger)	0.00%	0 / 1
getControllerURL				0.00% covered (danger)	0.00%	0 / 1	2.00	0.00% covered (danger)	0.00%	0 / 1
getCodeURL				0.00% covered (danger)	0.00%	0 / 1	2.00	0.00% covered (danger)	0.00%	0 / 1
makeExampleSubDir				0.00% covered (danger)	0.00%	0 / 1	56.00	0.00% covered (danger)	0.00%	0 / 7
directoryPath				0.00% covered (danger)	0.00%	0 / 1	2.00	0.00% covered (danger)	0.00%	0 / 3
getFileName				0.00% covered (danger)	0.00%	0 / 1	6.00	0.00% covered (danger)	0.00%	0 / 3
endingSlash				0.00% covered (danger)	0.00%	0 / 1	6.00	0.00% covered (danger)	0.00%	0 / 3
PerfilExample_class				0.00% covered (danger)	0.00%	0 / 1	992.00	0.00% covered (danger)	0.00%	0 / 91
callStrings				0.00% covered (danger)	0.00%	0 / 1	30.00	0.00% covered (danger)	0.00%	0 / 32
parametersCall				0.00% covered (danger)	0.00%	0 / 1	20.00	0.00% covered (danger)	0.00%	0 / 8
parameterValue				0.00% covered (danger)	0.00%	0 / 1	90.00	0.00% covered (danger)	0.00%	0 / 17
getControllerCode				0.00% covered (danger)	0.00%	0 / 1	6.00	0.00% covered (danger)	0.00%	0 / 5
saveFileIfNotExists				0.00% covered (danger)	0.00%	0 / 1	6.00	0.00% covered (danger)	0.00%	0 / 3
testTemplate				0.00% covered (danger)	0.00%	0 / 1	156.00	0.00% covered (danger)	0.00%	0 / 26
testMethodTemplate				0.00% covered (danger)	0.00%	0 / 1	6.00	0.00% covered (danger)	0.00%	0 / 8
testClassHeader				0.00% covered (danger)	0.00%	0 / 1	2.00	0.00% covered (danger)	0.00%	0 / 2

1	<?php
2	namespace ia\DocumentIt;
3	//@EXPAND pre-fill module, functions in file, may be file with no functions nor vars nor defines ie has a class, trait, interface
4	//@EXPAND a completa xxx_example_code.php nota ver <li id="method_name"> de no estar append it
5	//@MEJORA cuando un parámetro tiene un default usar el default o no ponerlo en la llamada
6
7	use ReflectionClass;
8	use ReflectionException;
9	use ReflectionFunction;
10	use ReflectionMethod;
11
12
13
14	class PerfilExample {
15	private $className;
16	private $classVariable;
17	private $examplesDir;
18	private $examplesHome;
19	private $exampleControllerFileName;
20	private $exampleCodeFileName;
21	private $shortName;
22
23	/**
24	* PerfilExample constructor.
25	* @param string $className
26	* @param string $exampleDir
27	* @param string $exampleHome
28	*/
29	public function __construct($className, $exampleDir, $exampleHome) {
30	$this->className = $className;
31	$this->examplesDir = $this->endingSlash($exampleDir);
32	$this->examplesHome = $this->endingSlash($exampleHome);
33	$this->exampleControllerFileName = $this->getFileName('', $className, '_example.php');
34	$this->exampleCodeFileName = $this->getFileName('code/', $className, '_example_code.php');
35	$this->makeExampleSubDir();
36	}
37
38	public function getFileSystemControllerPath() {
39	return $this->examplesDir . $this->exampleControllerFileName;
40	}
41
42	public function getFileSystemCodePath() {
43	return $this->examplesDir . $this->exampleCodeFileName;
44	}
45
46	private function getControllerURL() {
47	return $this->examplesHome . $this->exampleControllerFileName;
48	}
49
50	private function getCodeURL() {
51	return $this->examplesHome . $this->exampleCodeFileName;
52	}
53
54	private function makeExampleSubDir() {
55	$controllerSubDir = $this->directoryPath($this->getFileSystemControllerPath());
56	if($controllerSubDir !== '' && $controllerSubDir !== '/' && !file_exists($controllerSubDir)) {
57	mkdir($controllerSubDir, 0755, true);
58	}
59	$codeSubDir = $this->directoryPath($this->getFileSystemCodePath());
60	if($codeSubDir !== '' && $codeSubDir !== '/' && !file_exists($codeSubDir)) {
61	mkdir($codeSubDir, 0755, true);
62	}
63	}
64
65	public function directoryPath($fileName) {
66	$path = explode('/', $fileName);
67	array_pop($path);
68	return implode('/', $path);
69	}
70
71	private function getFileName($prefix, $className, $suffix) {
72	if(substr($className,0,1) === '/') {
73	$className = substr($className, 1);
74	}
75	return $prefix . str_replace('\\', '/', $className).$suffix;
76	}
77
78	/**
79	* Ensure path ends with /
80	* @param string $path
81	* @return string
82	*/
83	private function endingSlash($path) {
84	if(substr($path, -1) !== '/') {
85	$path .= '/';
86	}
87	return $path;
88	}
89
90	/**
91	* @return string
92	*/
93	public function PerfilExample_class() {
94
95	if(empty($this->className) \|\| $this->className[0] === '/' \|\| $this->className[0] === '\\') {
96	return "Invalid namespace\\className";
97	}
98	if(stripos($this->className, '/') \|\| stripos($this->className, '.\\')) {
99	return "Invalid namespace\\className / ./ and .\\ not allowed";
100	}
101	try {
102	$ref = new ReflectionClass($this->className);
103	} catch (ReflectionException $e) {
104	return "\Reflection error, invalid \$className = $this->className";
105	}
106	$this->shortName = $ref->getShortName();
107	$this->classVariable = lcFirst($ref->getShortName());
108
109	$namespace = $ref->getNamespaceName();
110	if(empty($namespace)) {
111	$namespace = '';
112	}
113
114	$controllerCode = $this->getControllerCode();
115	$this->saveFileIfNotExists($this->getFileSystemControllerPath(), $controllerCode);
116
117	$construct = [
118	'parametersList' => '',
119	'callPrototype' => '',
120	'callCommentOut' =>'',
121	'call' => '',
122	'callEcho' => '',
123	'returnType' => '',
124	'parametersPrototype' => '',
125	'parametersValues' => [],
126	'createNew' => true,
127	'docBlock' => '',
128	];
129	$ret = "\r\n";
130	$instantiateClass = false;
131	foreach ($ref->getMethods(ReflectionMethod::IS_PUBLIC) as $method) {
132	$functionDocBlock = $method->getDocComment();
133	$callers = $this->callStrings($method, $functionDocBlock);
134
135	if($method->getName() === '__construct') {
136	$construct = $callers;
137	$construct['docBlock'] = $functionDocBlock;
138	$instantiateClass = true;
139	continue;
140	}
141	if(!$method->isStatic()) {
142	$instantiateClass = true;
143	}
144
145	switch($callers['returnType']) {
146	case 'int':
147	case 'string':
148	case 'float':
149	case 'float\|string':
150	case 'string\|float':
151	case 'int\|string':
152	case 'string\|int':
153	case 'int\|float':
154	case 'float\|int':
155	case 'string\|bool':
156	case 'bool\|string':
157	$example = <<< METHODEXAMPLE
158
159	/// display ///
160	echo <<< DOCUMENT_EXAMPLE
161	<li>$callers[callEcho] ->
162	DOCUMENT_EXAMPLE;
163	/// run ///
164	$callers[callCommentOut] echo $callers[call];
165
166	METHODEXAMPLE;
167	break;
168
169	case 'bool':
170	$example = <<< METHODEXAMPLE
171
172
173	/// display ///
174	echo <<< DOCUMENT_EXAMPLE
175	<li>$callers[callEcho] ->
176	DOCUMENT_EXAMPLE;
177	///run ///
178	$callers[callCommentOut] echo ($callers[call] ? 'true' : 'false');
179
180
181	METHODEXAMPLE;
182	break;
183
184	case 'void':
185	$example = <<< METHODEXAMPLE
186
187
188	/// display ///
189	echo <<< DOCUMENT_EXAMPLE
190	<li>$callers[callEcho]"
191	DOCUMENT_EXAMPLE;
192	/// run ///
193	$callers[callCommentOut] echo $callers[call];
194
195
196	METHODEXAMPLE;
197	break;
198
199	case 'Generator':
200	case '\Generator':
201	$example = <<< METHODEXAMPLE
202
203
204	/// display ///
205	echo <<< DOCUMENT_EXAMPLE
206	<li>echo "<ul>";
207	foreach($callers[callEcho] as \\\$k => \\\$v)
208	echo "<li>\\\$k := ". print_r(\\\$v, true)."</li>";
209	echo "/<ul>";
210	DOCUMENT_EXAMPLE;
211	/// run ///
212	echo "<ul>"; foreach($callers[call] as \$k => \$v) echo "<li>\$k := ". print_r(\$v, true)."</li>"; echo "</ul>";
213
214
215	METHODEXAMPLE;
216
217	break;
218	default:
219	if(empty($callCommentOut)) {
220	$example = <<< METHODEXAMPLE
221
222
223	/// display ///
224	echo <<< DOCUMENT_EXAMPLE
225	<li>$callers[callEcho]
226	->  </b><br><pre>
227	DOCUMENT_EXAMPLE;
228	/// run ///
229	print_r(
230	$callers[call]
231	);
232	echo "</pre>";
233
234
235	METHODEXAMPLE;
236	} else {
237	$example = <<< METHODEXAMPLE
238
239	/// display ///
240	echo <<< DOCUMENT_EXAMPLE
241	<li>$callers[callEcho]"
242	->  </b><br><pre>
243	DOCUMENT_EXAMPLE;
244	/// run ///
245	// print_r($callers[call]);
246	echo "</pre>";
247
248	METHODEXAMPLE;
249	}
250	}
251
252
253	$prototype = <<< PROTOTYPEXAMPLE
254
255	///////// $callers[callEcho] //////////////////////////////////////////////////
256	echo <<< FUNCTIONDEF
257	<li id='u_$method->name'><b>$callers[callPrototype]</b>
258	FUNCTIONDEF;
259
260	echo "<pre class='docBlock'>".DocumentIt::methodDocBlockProtected("$this->className", "$method->name")."</pre>";
261
262	echo "<ol class='usage'>";
263
264	PROTOTYPEXAMPLE;
265	$ret .= "\r\n$prototype\r\n$example\r\n\techo '</ol>';\r\n";
266	}
267	$ret .= "\r\n\r\n/* PerfilExample adds new methods here */\r\n\r\necho '</ul>';";
268
269	$date = date('Y-m');
270	$header = "
271	/**
272	* Usage examples for $this->className
273	* @version 1.0
274	* @date $date
275	*/\r\n\r\nuse ia\\DocumentIt\\DocumentIt;\r\n";
276
277	$shortName = $ref->getShortName();
278
279
280
281	if(!empty($namespace)) {
282	$header = "use $namespace\\$shortName;\r\n";
283	}
284	$header .= "use ia\DocumentIt\DocumentIt;\r\n";
285
286	$header .= "\r\necho '<h3>Disclaimer: Auto generated file.
287	Please help us setting parameters to useful values and extending the examples.
288	</h3>';\r\n\r\ntry {\r\n\r\n";
289	if($instantiateClass) {
290	if (!empty($construct['createNew'])) {
291	$docBlock = str_replace('$', "\\$", $construct['docBlock']);
292	$proto = "\\$" . $this->classVariable . " = new $shortName($construct[parametersPrototype]);";
293	$parametersValues = empty($construct['parametersValues']) ? '' : implode(', ', $construct['parametersValues']);
294	$showCreate = "\\$" . $this->classVariable . " = new $shortName($parametersValues);";
295	$header .= <<< PROTOTYPE
296	echo <<< CONSTRUCTOR_PROTOTYPE
297	<pre>
298	$docBlock
299	/*
300	$proto
301	*/
302
303	$showCreate
304
305	</pre>
306	CONSTRUCTOR_PROTOTYPE;
307
308	PROTOTYPE;
309
310	$header .= "\r\n" . '$' . $this->classVariable . " = new $shortName($parametersValues);\r\n\r\n";
311	}
312	}
313	$header .= "\r\necho '<ul class=\"usage\">';\r\n";
314
315	$code = $header . $ret . "\r\n\r\n" .
316	'} catch(Exception $exception) { echo "<pre class=\'errorBlock\'>$exception</pre>"; }'."\r\n";
317
318	$this->saveFileIfNotExists($this->getFileSystemCodePath(), $code);
319
320
321	return
322	"<hr><h2 id='controler' class='fileName'>" . $this->getControllerURL() .
323	"</h2><hr><code style='margin:2em'>" . htmlentities("<?php\r\n".$controllerCode)."</code>" .
324	"<hr><h2 id='byFunction' class='fileName'>" . $this->getCodeURL() . "</h2><hr><code style='margin:2em'>".
325	htmlentities($code)."</code>";
326	}
327
328	/**
329	* @param ReflectionMethod\|ReflectionFunction $method
330	* @param string $functionDocBlock
331	* @return array
332	*/
333	private function callStrings($method, $functionDocBlock) {
334
335	$variables = [];
336	foreach($method->getParameters() as $p) {
337	$variables[] = '$'.$p->getName() ;
338	}
339	$parametersList = implode(', ', $variables);
340
341	$parameters = DocumentIt::parameters($method, $functionDocBlock);
342
343	$parametersPrototype = str_replace(['$'], ["\\$"], implode(', ', $parameters) );
344	$parametersValues = $this->parametersCall($method, $functionDocBlock);
345	$returnType = $method->hasReturnType() ? $method->getReturnType() :
346	DocumentIt::deduceReturnTypeFromDockBlock($functionDocBlock);
347
348	if($method->isStatic()) {
349	$callWithVariables = $call = $callPrototype = $callEcho = "$this->shortName::".$method->name;
350	$createNew = false;
351	} else {
352	$callWithVariables = $call = '$'.$this->classVariable . '->' . $method->name;
353	$callPrototype = $callEcho = str_replace('$', "\\$", $call);
354	$createNew = true;
355	}
356	$callPrototype .= "($parametersPrototype) <span>: $returnType</span>";
357	$call .= "(" . implode(', ', $parametersValues).')';
358	$callWithVariables .="($parametersList)";
359
360	$callEcho .= str_replace(['$'], ["\\$"], "(" . implode(', ', $parametersValues).');');
361	return [
362	'parameterCount' => count($variables),
363	'callWithVariables' => $callWithVariables,
364	'parametersList' => $parametersList,
365	'callPrototype' => $callPrototype,
366	'callCommentOut' => strpos($callPrototype, '&') === false ? '' : '// ',
367	'call' => $call,
368	'callEcho' => $callEcho,
369	'returnType' => $returnType,
370	'parametersPrototype' => $parametersPrototype,
371	'parametersValues' => $parametersValues,
372	'createNew' => $createNew,
373	'docBlock' => $functionDocBlock,
374	'parameters' => $parameters,
375	];
376	}
377
378	private function parametersCall($method, $functionDocBlock) {
379	$parametersCall = [];
380	try {
381	foreach (DocumentIt::parametersInfo($method, $functionDocBlock) as $p) {
382	if ($p['isOptional']) {
383	continue;
384	}
385	$parametersCall[] = $this->parameterValue($p['type']);
386	}
387	} catch (ReflectionException $e) {
388	$parametersCall[] = '<span class="error">Parameter ReflectionException</span>';
389	}
390	return $parametersCall;
391	}
392
393	private function parameterValue($p) {
394
395	if(stripos($p, 'array') !== false) {
396	return "['a' => '1', 'b' => '2', 'c' => 3]";
397	}
398	if(stripos($p, 'int') !== false) {
399	return 3;
400	}
401	if(stripos($p, 'float') !== false) {
402	return 2.7172;
403	}
404	if(stripos($p, 'string') !== false) {
405	return "'palabra'";
406	}
407	if(stripos($p, 'bool') !== false) {
408	return "true";
409	}
410	if(stripos($p, 'DateTimeImmutable') !== false) {
411	return "new DateTimeImmutable()";
412	}
413	if(stripos($p, 'DateTime') !== false) {
414	return "new DateTime()";
415	}
416	if(stripos($p, 'IaMysqli') !== false) {
417	return "\$gSqlClass";
418	}
419	return "null /* =$p= */";
420	}
421
422	private function getControllerCode() {
423	$slashes_number = count(explode('\\',$this->className));
424	$includePath = $slashes_number < 2 ? '' : str_repeat('../', $slashes_number - 1 );
425	return "
426	\$ia_example = [
427	'title' => '$this->className', // fully qualified className
428	'summary' => '', // class summary
429	'full_example' => '', // full usage example, relative path from ia_examples, blank '' not shown.
430	'example_file' => '$this->exampleCodeFileName', // method by method example, blank '' not shown.
431	];
432	include( __DIR__ . '/{$includePath}template/ia_example_class.php');
433	";
434	}
435
436
437	private function saveFileIfNotExists($filePath, $code) {
438	if(!file_exists($filePath)) {
439	file_put_contents($filePath, "<?php\r\n$code");
440	}
441	}
442
443
444	/** test file example */
445
446	public function testTemplate() {
447	if(empty($this->className) \|\| $this->className[0] === '/' \|\| $this->className[0] === '\\') {
448	return "Invalid namespace\\className";
449	}
450	if(stripos($this->className, '/') \|\| stripos($this->className, '.\\')) {
451	return "Invalid namespace\\className / ./ and .\\ not allowed";
452	}
453	try {
454	$ref = new ReflectionClass($this->className);
455	} catch (ReflectionException $e) {
456	return "\Reflection error, invalid \$className = $this->className";
457	}
458	$this->shortName = $ref->getShortName();
459	$this->classVariable = lcFirst($ref->getShortName());
460
461	$construct = [
462	'callWithVariables' => '',
463	'callPrototype' => '',
464	'callCommentOut' =>'',
465	'call' => '',
466	'callEcho' => '',
467	'returnType' => '',
468	'parametersPrototype' => '',
469	'parametersValues' => [],
470	'parameters' => [],
471	'parametersList' => '',
472	'createNew' => true,
473	'docBlock' => '',
474	];
475
476	foreach ($ref->getMethods(ReflectionMethod::IS_PUBLIC) as $method) {
477	$functionDocBlock = $method->getDocComment();
478	$callers = $this->callStrings($method, $functionDocBlock);
479
480	if($method->getName() === '__construct') {
481	/** @var array $construct */
482	$construct = $callers;
483	$construct['docBlock'] = $functionDocBlock;
484	continue;
485	}
486	}
487
488	$ret = "\r\n";
489	foreach ($ref->getMethods(ReflectionMethod::IS_PUBLIC) as $method) {
490	if($method->getName() === '__construct') {
491	continue;
492	}
493	$functionDocBlock = $method->getDocComment();
494	$callers = $this->callStrings($method, $functionDocBlock);
495	$instantiateClassStatement = $method->isStatic() ? '' : "\$$this->classVariable = new $this->shortName($construct[parametersList]);" ;
496	$ret .= $this->testMethodTemplate( $method->getName(), $callers, $instantiateClassStatement);
497	}
498	/*
499	if(empty($ref->getNamespaceName())) {
500	$classFqn = $this->className;
501	} else {
502	$classFqn = $ref->getNamespaceName() . '\\' . $this->className;
503	}
504	*/
505	return "<?php\r\n".$this->testClassHeader($this->className, $ref->getShortName()).$ret."\r\n}\r\n";
506	}
507
508	private function testMethodTemplate( $methodName, $callers, $instanciateClassStatement) {
509	$testValue = implode(', ', array_fill(0, $callers['parameterCount']+1, "''") );
510	$coma = empty($callers['parametersList']) ? '' : ',';
511	return <<< TESTMETHODTAG
512
513
514	/**
515	* @dataProvider {$methodName}_Provider
516	*
517	*/
518	public function test_{$methodName}($callers[parametersList] $coma \$expected) {
519	$instanciateClassStatement
520	\$this->assertEquals(\$expected, $callers[callWithVariables] );
521	}
522
523	function {$methodName}_Provider() {
524	return [
525	'test 1' => [ $testValue ],
526	];
527	}
528
529
530	TESTMETHODTAG;
531
532	}
533
534	private function testClassHeader($classFqn, $className) {
535	return <<< TESTCLASSSTART
536
537	use $classFqn;
538	use PHPUnit\Framework\TestCase;
539
540	class {$className}Test extends TestCase {
541
542	TESTCLASSSTART;
543
544	}
545	}