Code Coverage for /Users/ericduran/Sites/drupal/drupal/core/modules/simpletest/src/RandomGeneratorTrait.php

	Code Coverage
	Classes and Traits			Functions and Methods				Lines
Total	0.00% covered (danger)	0.00%	0 / 1	80.00% covered (warning)	80.00%	4 / 5	CRAP	93.33% covered (success)	93.33%	14 / 15
RandomGeneratorTrait	0.00% covered (danger)	0.00%	0 / 1	80.00% covered (warning)	80.00%	4 / 5	9.02	93.33% covered (success)	93.33%	14 / 15
randomString				100.00% covered (success)	100.00%	1 / 1	2	100.00% covered (success)	100.00%	5 / 5
randomStringValidate				100.00% covered (success)	100.00%	1 / 1	3	100.00% covered (success)	100.00%	5 / 5
randomMachineName				0.00% covered (danger)	0.00%	0 / 1	2	0.00% covered (danger)	0.00%	0 / 1
randomObject				100.00% covered (success)	100.00%	1 / 1	1	100.00% covered (success)	100.00%	1 / 1
getRandomGenerator				100.00% covered (success)	100.00%	1 / 1	2	100.00% covered (success)	100.00%	3 / 3

1	<?php
2
3	/**
4	* @file
5	* Contains \Drupal\simpletest\RandomGeneratorTrait.
6	*/
7
8	namespace Drupal\simpletest;
9
10	use Drupal\Component\Utility\Random;
11
12	/**
13	* Provides random generator utility methods.
14	*/
15	trait RandomGeneratorTrait {
16
17	/**
18	* The random generator.
19	*
20	* @var \Drupal\Component\Utility\Random
21	*/
22	protected $randomGenerator;
23
24	/**
25	* Generates a pseudo-random string of ASCII characters of codes 32 to 126.
26	*
27	* Do not use this method when special characters are not possible (e.g., in
28	* machine or file names that have already been validated); instead, use
29	* \Drupal\simpletest\TestBase::randomMachineName(). If $length is greater
30	* than 3 the random string will include at least one ampersand ('&') and
31	* at least one greater than ('>') character to ensure coverage for special
32	* characters and avoid the introduction of random test failures.
33	*
34	* @param int $length
35	* Length of random string to generate.
36	*
37	* @return string
38	* Pseudo-randomly generated unique string including special characters.
39	*
40	* @see \Drupal\Component\Utility\Random::string()
41	*/
42	public function randomString($length = 8) {
43	if ($length < 4) {
44	return $this->getRandomGenerator()->string($length, TRUE, array($this, 'randomStringValidate'));
45	}
46
47	// To prevent the introduction of random test failures, ensure that the
48	// returned string contains a character that needs to be escaped in HTML by
49	// injecting an ampersand into it.
50	$replacement_pos = floor($length / 2);
51	// Remove 2 from the length to account for the ampersand and greater than
52	// characters.
53	$string = $this->getRandomGenerator()->string($length - 2, TRUE, array($this, 'randomStringValidate'));
54	return substr_replace($string, '>&', $replacement_pos, 0);
55	}
56
57	/**
58	* Callback for random string validation.
59	*
60	* @see \Drupal\Component\Utility\Random::string()
61	*
62	* @param string $string
63	* The random string to validate.
64	*
65	* @return bool
66	* TRUE if the random string is valid, FALSE if not.
67	*/
68	public function randomStringValidate($string) {
69	// Consecutive spaces causes issues for
70	// \Drupal\simpletest\WebTestBase::assertLink().
71	if (preg_match('/\s{2,}/', $string)) {
72	return FALSE;
73	}
74
75	// Starting or ending with a space means that length might not be what is
76	// expected.
77	if (preg_match('/^\s\|\s$/', $string)) {
78	return FALSE;
79	}
80
81	return TRUE;
82	}
83
84	/**
85	* Generates a unique random string containing letters and numbers.
86	*
87	* Do not use this method when testing unvalidated user input. Instead, use
88	* \Drupal\simpletest\TestBase::randomString().
89	*
90	* @param int $length
91	* Length of random string to generate.
92	*
93	* @return string
94	* Randomly generated unique string.
95	*
96	* @see \Drupal\Component\Utility\Random::name()
97	*/
98	protected function randomMachineName($length = 8) {
99	return $this->getRandomGenerator()->name($length, TRUE);
100	}
101
102	/**
103	* Generates a random PHP object.
104	*
105	* @param int $size
106	* The number of random keys to add to the object.
107	*
108	* @return \stdClass
109	* The generated object, with the specified number of random keys. Each key
110	* has a random string value.
111	*
112	* @see \Drupal\Component\Utility\Random::object()
113	*/
114	public function randomObject($size = 4) {
115	return $this->getRandomGenerator()->object($size);
116	}
117
118	/**
119	* Gets the random generator for the utility methods.
120	*
121	* @return \Drupal\Component\Utility\Random
122	* The random generator.
123	*/
124	protected function getRandomGenerator() {
125	if (!is_object($this->randomGenerator)) {
126	$this->randomGenerator = new Random();
127	}
128	return $this->randomGenerator;
129	}
130
131	}