Generator::genGames() - Code Metrics - Inspection of ":memo: API docs update" - Heroyt/tournament-generator - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a1420e...5c3586 )

by Tomáš

created 2021-05-22 20:37 UTC

Generator::genGames() A

↳ Parent: Generator

Complexity

Conditions	4
Paths	4

Size

Total Lines	13
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	9
CRAP Score	4

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	4
eloc	11
c	1
b	0
f	0
nc	4
nop	0
dl	0
loc	13
ccs	9
cts	9
cp	1
crap	4
rs	9.9

<?php

namespace TournamentGenerator\Helpers;

use Exception;
use TournamentGenerator\Constants;
use TournamentGenerator\Game;
use TournamentGenerator\Group;
use TournamentGenerator\Interfaces\WithGeneratorSetters;
use TournamentGenerator\Interfaces\WithSkipSetters;
use TournamentGenerator\Team;
use TournamentGenerator\Traits\WithSkipSetters as WithSkipSettersTrait;

/**
 * Generator class is responsible for generating all different games in rounds.
 *
 * @author  Tomáš Vojík <[email protected]>
 *
 * @package TournamentGenerator\Helpers
 *
 * @since   0.3
 */
class Generator implements WithGeneratorSetters, WithSkipSetters
{
	use WithSkipSettersTrait;

	/** @var Group Group object */
	private Group $group;
	/** @var string Type of a round to create */
	private string $type = Constants::ROUND_ROBIN;
	/** @var int Number of teams in one game - 2/3/4 */
	private int $inGame = 2;
	/** @var int Maximum size of group before split */
	private int $maxSize = 4;

	/**
	 * Generator constructor.
	 *
	 * @param Group $group Group object to generate the games from
	 */
	public function __construct(Group $group) {
		$this->group = $group;
	}

	/**
	 * Get round type
	 *
	 * @return string
	 */
	public function getType() : string {
		return $this->type;
	}

	/**
	 * Set round type
	 *
	 * @param string $type
	 *
	 * @return $this
	 * @throws Exception
	 */
	public function setType(string $type = Constants::ROUND_ROBIN) : Generator {
		if (in_array($type, Constants::GroupTypes, true)) {
			$this->type = $type;
		}
		else {
			throw new Exception('Unknown group type: '.$type);
		}
		return $this;
	}

	/**
	 * Get how many teams are playing in one game
	 *
	 * @return int
	 */
	public function getInGame() : int {
		return $this->inGame;
	}

	/**
	 * Set how many teams are playing in one game
	 *
	 * @param int $inGame
	 *
	 * @return $this
	 * @throws Exception
	 */
	public function setInGame(int $inGame) : Generator {
		if ($inGame < 2 || $inGame > 4) {
			throw new Exception('Expected 2,3 or 4 as inGame '.$inGame.' given');
		}
		$this->inGame = $inGame;
		return $this;
	}

	/**
	 * Get tha maximum group size
	 *
	 * @return int
	 */
	public function getMaxSize() : int {
		return $this->maxSize;
	}

	/**
	 * Set the maximum group size
	 *
	 * @param int $size
	 *
	 * @return $this
	 * @throws Exception
	 */
	public function setMaxSize(int $size) : Generator {
		if ($size < 2) {
			throw new Exception('Max group size has to be at least 2, '.$size.' given');
		}
		$this->maxSize = $size;
		return $this;
	}

	/**
	 * Generate games for a round
	 *
	 * @return Game[] List of generated games
	 * @throws Exception
	 */
	public function genGames() : array {
		switch ($this->type) {
			case Constants::ROUND_ROBIN:
				$this->group->addGame(...$this->r_rGames());
				break;
			case Constants::ROUND_TWO:
				$this->two_twoGames();
				break;
			case Constants::ROUND_SPLIT:
				$this->cond_splitGames();
				break;
		}
		return $this->group->getGames();
	}

	/**
	 * Generate round-robin games
	 *
	 * @param array $teams
	 *
	 * @return Game[]
	 * @throws Exception
	 */
	protected function r_rGames(array $teams = []) : array {
		$games = [];
		if (count($teams) === 0) {
			$teams = $this->group->getTeams();
		}
		switch ($this->inGame) {
			case 2:
				$games = self::circle_genGames2($this->group, $teams);
				break;
			case 3:
				$games = $this->r_r3Games($teams, $games);
				break;
			case 4:
				$games = $this->r_r4Games($teams, $games);
				break;
		}
		return $games;
	}

	/**
	 * Generate games for round robin and 2 teams in one game
	 *
	 * @param array $teams
	 * @param Group $group
	 *
	 * @return Game[]
	 * @throws Exception
	 */
	public static function circle_genGames2(Group $group, array $teams = []) : array {

		if (count($teams) % 2 !== 0) {
			$teams[] = Constants::DUMMY_TEAM;
		} // IF NOT EVEN NUMBER OF TEAMS, ADD DUMMY

		shuffle($teams); // SHUFFLE TEAMS FOR MORE RANDOMNESS

		$rounds = [];
		for ($i = 0; $i < count($teams) - 1; $i++) {
			$rounds[] = self::circle_saveBracket($teams, $group); // SAVE CURRENT ROUND

			$teams = self::circle_rotateBracket($teams); // ROTATE TEAMS IN BRACKET
		}

		return array_merge(...$rounds);
	}

	/**
	 * Get one generated round-robin round
	 *
	 * @param array $teams
	 * @param Group $group
	 *
	 * @return Game[]
	 * @throws Exception
	 */
	public static function circle_saveBracket(array $teams, Group $group) : array {

		$bracket = [];

		for ($i = 0; $i < count($teams) / 2; $i++) { // GO THROUGH HALF OF THE TEAMS

			$home = $teams[$i];
			$reverse = array_reverse($teams);
			$away = $reverse[$i];

			if ($home === Constants::DUMMY_TEAM || $away === Constants::DUMMY_TEAM) {
				continue;
			} // SKIP WHEN DUMMY_TEAM IS PRESENT

			$bracket[] = new Game([$home, $away], $group);

		}

		return $bracket;

	}

	/**
	 * Rotate array of teams
	 *
	 * @param array $teams
	 *
	 * @return array
	 */
	public static function circle_rotateBracket(array $teams) : array {

		$first = array_shift($teams); // THE FIRST TEAM REMAINS FIRST
		$last = array_shift($teams);  // THE SECOND TEAM MOVES TO LAST PLACE

		return array_merge([$first], $teams, [$last]); // MERGE BACK TOGETHER

	}

	/**
	 * Generate a round-robin for three teams in one game
	 *
	 * @param array     $teams
	 * @param array     $games
	 * @param Team|null $lockedTeam1
	 *
	 * @return array
	 * @throws Exception
	 */
	protected function r_r3Games(array $teams, array &$games, Team $lockedTeam1 = null) : array {
		$teamsB = $teams;
		$generatedGames = [];
		while (count($teamsB) >= 3) {
			$lockedTeam = array_shift($teamsB);
			$gamesTemp = self::circle_genGames2($this->group, $teamsB);
			foreach ($gamesTemp as $game) {
				if (isset($lockedTeam1)) {
					$game->addTeam($lockedTeam1);
				}
				$game->addTeam($lockedTeam);
			}
			$generatedGames[] = $gamesTemp;
		}
		$games = array_merge($games, ...$generatedGames);
		return $games;
	}

	/**
	 * Generate a round-robin for four teams in one game
	 *
	 * @param array $teams
	 * @param array $games
	 *
	 * @return array
	 * @throws Exception
	 */
	protected function r_r4Games(array $teams, array &$games) : array {
		$teamsB = $teams;
		$lockedTeam1 = array_shift($teamsB);
		while (count($teamsB) >= 4) {
			$this->r_r3Games($teamsB, $games, $lockedTeam1);
			$lockedTeam1 = array_shift($teamsB);
		}
		$games[] = new Game(array_merge([$lockedTeam1], $teamsB), $this->group);
		return $games;
	}

	/**
	 * Generates games for teams, where a team plays only against one other team
	 *
	 * @param array $teams
	 *
	 * @return Generator
	 * @throws Exception
	 */
	protected function two_twoGames(array $teams = []) : Generator {
		if (count($teams) === 0) {
			$teams = $this->group->getTeams();
		}
		shuffle($teams);
		$count = count($teams); // Store original count for exception

		$discard = array_splice($teams, 0, $count % $this->inGame);

		$teams = $this->saveTwoTwoGames($teams);


		if (!$this->allowSkip && count($discard) > 0) {
			throw new Exception('Couldn\'t make games with all teams. Expected k*'.$this->inGame.' teams '.$count.' teams given - discarting '.count($discard).' teams ('.implode(', ', $discard).') in group '.$this->group.' - allow skip '.($this->allowSkip ? 'True' : 'False'));
		}
		return $this;
	}


	/**
	 * Automatically split teams in a group
	 *
	 * @param array $teams
	 *
	 * @return Generator
	 * @throws Exception
	 */
	protected function cond_splitGames(array $teams = []) : Generator {
		if (count($teams) === 0) {
			$teams = $this->group->getTeams();
		}

		$count = count($teams);
		if ($count > $this->maxSize) {
			$games = [];

			// Split teams into chunks of maximum size
			$groups = array_chunk($teams, (int) ceil($count / ceil($count / $this->maxSize)));
			// Generate games for each chunk
			foreach ($groups as $group) {
				$games[] = $this->r_rGames($group);
			}

			$this->fillGamesFromChunks($games);

			return $this;
		}
		$this->group->addGame(...$this->r_rGames());

		return $this;
	}

	/**
	 * Sort games to minimize teams playing multiple games after one other
	 *
	 * @return array
	 * @throws Exception
	 */
	public function orderGames() : array {
		$sorter = new Sorter\GameSorter($this->group);

		return $sorter->sort($this->group->getGames());
	}

	/**
	 * Add games from chunks to groups
	 *
	 * Fills game in alternating order (chunk 1 - 1, chunk 2 - 1 , chunk 3 - 1, chunk 1 - 2, chunk 2 - 2...)
	 *
	 * @param Game[][] $games
	 */
	protected function fillGamesFromChunks(array $games) : void {
		$gameCount = Functions::nestedCount($games);
		while ($gameCount > 0) {
			foreach ($games as $key => $group) {
				$this->group->addGame(array_shift($games[$key]));
				if (count($games[$key]) === 0) {
					unset($games[$key]);
				}
				$gameCount--;
			}
		}
	}

	/**
	 * Create games from array of teams for a Two-Two game
	 *
	 * @param Team[] $teams
	 *
	 * @pre The input array must be divisible by the Generator::$inGame value
	 *
	 * @return array
	 * @throws Exception
	 */
	protected function saveTwoTwoGames(array $teams) : array {
		while (count($teams) > 0) {
			$tInGame = [];
			for ($i = 0; $i < $this->inGame; $i++) {
				$tInGame[] = array_shift($teams);
			}
			$this->group->game($tInGame);
		}
		return $teams;
	}

}


1		<?php
2
3		namespace TournamentGenerator\Helpers;
4
5		use Exception;
6		use TournamentGenerator\Constants;
7		use TournamentGenerator\Game;
8		use TournamentGenerator\Group;
9		use TournamentGenerator\Interfaces\WithGeneratorSetters;
10		use TournamentGenerator\Interfaces\WithSkipSetters;
11		use TournamentGenerator\Team;
12		use TournamentGenerator\Traits\WithSkipSetters as WithSkipSettersTrait;
13
14		/**
15		* Generator class is responsible for generating all different games in rounds.
16		*
17		* @author Tomáš Vojík <[email protected]>
18		*
19		* @package TournamentGenerator\Helpers
20		*
21		* @since 0.3
22		*/
23		class Generator implements WithGeneratorSetters, WithSkipSetters
24		{
25		use WithSkipSettersTrait;
26
27		/** @var Group Group object */
28		private Group $group;
29		/** @var string Type of a round to create */
30		private string $type = Constants::ROUND_ROBIN;
31		/** @var int Number of teams in one game - 2/3/4 */
32		private int $inGame = 2;
33		/** @var int Maximum size of group before split */
34		private int $maxSize = 4;
35
36		/**
37		* Generator constructor.
38		*
39		* @param Group $group Group object to generate the games from
40		*/
41	140	public function __construct(Group $group) {
42	140	$this->group = $group;
43	140	}
44
45		/**
46		* Get round type
47		*
48		* @return string
49		*/
50	1	public function getType() : string {
51	1	return $this->type;
52		}
53
54		/**
55		* Set round type
56		*
57		* @param string $type
58		*
59		* @return $this
60		* @throws Exception
61		*/
62	20	public function setType(string $type = Constants::ROUND_ROBIN) : Generator {
63	20	if (in_array($type, Constants::GroupTypes, true)) {
64	20	$this->type = $type;
65		}
66		else {
67	1	throw new Exception('Unknown group type: '.$type);
68		}
69	20	return $this;
70		}
71
72		/**
73		* Get how many teams are playing in one game
74		*
75		* @return int
76		*/
77	74	public function getInGame() : int {
78	74	return $this->inGame;
79		}
80
81		/**
82		* Set how many teams are playing in one game
83		*
84		* @param int $inGame
85		*
86		* @return $this
87		* @throws Exception
88		*/
89	53	public function setInGame(int $inGame) : Generator {
90	53	if ($inGame < 2 \|\| $inGame > 4) {
91	1	throw new Exception('Expected 2,3 or 4 as inGame '.$inGame.' given');
92		}
93	53	$this->inGame = $inGame;
94	53	return $this;
95		}
96
97		/**
98		* Get tha maximum group size
99		*
100		* @return int
101		*/
102	1	public function getMaxSize() : int {
103	1	return $this->maxSize;
104		}
105
106		/**
107		* Set the maximum group size
108		*
109		* @param int $size
110		*
111		* @return $this
112		* @throws Exception
113		*/
114	8	public function setMaxSize(int $size) : Generator {
115	8	if ($size < 2) {
116	1	throw new Exception('Max group size has to be at least 2, '.$size.' given');
117		}
118	7	$this->maxSize = $size;
119	7	return $this;
120		}
121
122		/**
123		* Generate games for a round
124		*
125		* @return Game[] List of generated games
126		* @throws Exception
127		*/
128	43	public function genGames() : array {
129	43	switch ($this->type) {
130		case Constants::ROUND_ROBIN:
131	33	$this->group->addGame(...$this->r_rGames());
132	33	break;
133		case Constants::ROUND_TWO:
134	9	$this->two_twoGames();
135	8	break;
136		case Constants::ROUND_SPLIT:
137	5	$this->cond_splitGames();
138	5	break;
139		}
140	42	return $this->group->getGames();
141		}
142
143		/**
144		* Generate round-robin games
145		*
146		* @param array $teams
147		*
148		* @return Game[]
149		* @throws Exception
150		*/
151	36	protected function r_rGames(array $teams = []) : array {
152	36	$games = [];
153	36	if (count($teams) === 0) {
154	34	$teams = $this->group->getTeams();
155		}
156	36	switch ($this->inGame) {
157	36	case 2:
158	31	$games = self::circle_genGames2($this->group, $teams);
159	31	break;
160	5	case 3:
161	2	$games = $this->r_r3Games($teams, $games);
162	2	break;
163	3	case 4:
164	3	$games = $this->r_r4Games($teams, $games);
165	3	break;
166		}
167	36	return $games;
168		}
169
170		/**
171		* Generate games for round robin and 2 teams in one game
172		*
173		* @param array $teams
174		* @param Group $group
175		*
176		* @return Game[]
177		* @throws Exception
178		*/
179	36	public static function circle_genGames2(Group $group, array $teams = []) : array {
180
181	36	if (count($teams) % 2 !== 0) {
182	8	$teams[] = Constants::DUMMY_TEAM;
183		} // IF NOT EVEN NUMBER OF TEAMS, ADD DUMMY
184
185	36	shuffle($teams); // SHUFFLE TEAMS FOR MORE RANDOMNESS
186
187	36	$rounds = [];
188	36	for ($i = 0; $i < count($teams) - 1; $i++) {
189	36	$rounds[] = self::circle_saveBracket($teams, $group); // SAVE CURRENT ROUND
190
191	36	$teams = self::circle_rotateBracket($teams); // ROTATE TEAMS IN BRACKET
192		}
193
194	36	return array_merge(...$rounds);
195		}
196
197		/**
198		* Get one generated round-robin round
199		*
200		* @param array $teams
201		* @param Group $group
202		*
203		* @return Game[]
204		* @throws Exception
205		*/
206	36	public static function circle_saveBracket(array $teams, Group $group) : array {
207
208	36	$bracket = [];
209
210	36	for ($i = 0; $i < count($teams) / 2; $i++) { // GO THROUGH HALF OF THE TEAMS
211
212	36	$home = $teams[$i];
213	36	$reverse = array_reverse($teams);
214	36	$away = $reverse[$i];
215
216	36	if ($home === Constants::DUMMY_TEAM \|\| $away === Constants::DUMMY_TEAM) {
217	8	continue;
218		} // SKIP WHEN DUMMY_TEAM IS PRESENT
219
220	36	$bracket[] = new Game([$home, $away], $group);
221
222		}
223
224	36	return $bracket;
225
226		}
227
228		/**
229		* Rotate array of teams
230		*
231		* @param array $teams
232		*
233		* @return array
234		*/
235	36	public static function circle_rotateBracket(array $teams) : array {
236
237	36	$first = array_shift($teams); // THE FIRST TEAM REMAINS FIRST
238	36	$last = array_shift($teams); // THE SECOND TEAM MOVES TO LAST PLACE
239
240	36	return array_merge([$first], $teams, [$last]); // MERGE BACK TOGETHER
241
242		}
243
244		/**
245		* Generate a round-robin for three teams in one game
246		*
247		* @param array $teams
248		* @param array $games
249		* @param Team\|null $lockedTeam1
250		*
251		* @return array
252		* @throws Exception
253		*/
254	5	protected function r_r3Games(array $teams, array &$games, Team $lockedTeam1 = null) : array {
255	5	$teamsB = $teams;
256	5	$generatedGames = [];
257	5	while (count($teamsB) >= 3) {
258	5	$lockedTeam = array_shift($teamsB);
259	5	$gamesTemp = self::circle_genGames2($this->group, $teamsB);
260	5	foreach ($gamesTemp as $game) {
261	5	if (isset($lockedTeam1)) {
262	3	$game->addTeam($lockedTeam1);
263		}
264	5	$game->addTeam($lockedTeam);
265		}
266	5	$generatedGames[] = $gamesTemp;
267		}
268	5	$games = array_merge($games, ...$generatedGames);
269	5	return $games;
270		}
271
272		/**
273		* Generate a round-robin for four teams in one game
274		*
275		* @param array $teams
276		* @param array $games
277		*
278		* @return array
279		* @throws Exception
280		*/
281	3	protected function r_r4Games(array $teams, array &$games) : array {
282	3	$teamsB = $teams;
283	3	$lockedTeam1 = array_shift($teamsB);
284	3	while (count($teamsB) >= 4) {
285	3	$this->r_r3Games($teamsB, $games, $lockedTeam1);
286	3	$lockedTeam1 = array_shift($teamsB);
287		}
288	3	$games[] = new Game(array_merge([$lockedTeam1], $teamsB), $this->group);
289	3	return $games;
290		}
291
292		/**
293		* Generates games for teams, where a team plays only against one other team
294		*
295		* @param array $teams
296		*
297		* @return Generator
298		* @throws Exception
299		*/
300	9	protected function two_twoGames(array $teams = []) : Generator {
301	9	if (count($teams) === 0) {
302	9	$teams = $this->group->getTeams();
303		}
304	9	shuffle($teams);
305	9	$count = count($teams); // Store original count for exception
306
307	9	$discard = array_splice($teams, 0, $count % $this->inGame);
308
309	9	$teams = $this->saveTwoTwoGames($teams);
		0 ignored issues – show Unused Code introduced 2021-05-22 20:39 UTC by Report Bug Copy Issue Report The assignment to `$teams` is dead and can be removed. Loading history...
310
311	9	if (!$this->allowSkip && count($discard) > 0) {
312	1	throw new Exception('Couldn\'t make games with all teams. Expected k*'.$this->inGame.' teams '.$count.' teams given - discarting '.count($discard).' teams ('.implode(', ', $discard).') in group '.$this->group.' - allow skip '.($this->allowSkip ? 'True' : 'False'));
313		}
314	8	return $this;
315		}
316
317
318		/**
319		* Automatically split teams in a group
320		*
321		* @param array $teams
322		*
323		* @return Generator
324		* @throws Exception
325		*/
326	5	protected function cond_splitGames(array $teams = []) : Generator {
327	5	if (count($teams) === 0) {
328	5	$teams = $this->group->getTeams();
329		}
330
331	5	$count = count($teams);
332	5	if ($count > $this->maxSize) {
333	4	$games = [];
334
335		// Split teams into chunks of maximum size
336	4	$groups = array_chunk($teams, (int) ceil($count / ceil($count / $this->maxSize)));
337		// Generate games for each chunk
338	4	foreach ($groups as $group) {
339	4	$games[] = $this->r_rGames($group);
340		}
341
342	4	$this->fillGamesFromChunks($games);
343
344	4	return $this;
345		}
346	1	$this->group->addGame(...$this->r_rGames());
347
348	1	return $this;
349		}
350
351		/**
352		* Sort games to minimize teams playing multiple games after one other
353		*
354		* @return array
355		* @throws Exception
356		*/
357	5	public function orderGames() : array {
358	5	$sorter = new Sorter\GameSorter($this->group);
359
360	5	return $sorter->sort($this->group->getGames());
361		}
362
363		/**
364		* Add games from chunks to groups
365		*
366		* Fills game in alternating order (chunk 1 - 1, chunk 2 - 1 , chunk 3 - 1, chunk 1 - 2, chunk 2 - 2...)
367		*
368		* @param Game[][] $games
369		*/
370	4	protected function fillGamesFromChunks(array $games) : void {
371	4	$gameCount = Functions::nestedCount($games);
372	4	while ($gameCount > 0) {
373	4	foreach ($games as $key => $group) {
374	4	$this->group->addGame(array_shift($games[$key]));
375	4	if (count($games[$key]) === 0) {
376	4	unset($games[$key]);
377		}
378	4	$gameCount--;
379		}
380		}
381	4	}
382
383		/**
384		* Create games from array of teams for a Two-Two game
385		*
386		* @param Team[] $teams
387		*
388		* @pre The input array must be divisible by the Generator::$inGame value
389		*
390		* @return array
391		* @throws Exception
392		*/
393	9	protected function saveTwoTwoGames(array $teams) : array {
394	9	while (count($teams) > 0) {
395	9	$tInGame = [];
396	9	for ($i = 0; $i < $this->inGame; $i++) {
397	9	$tInGame[] = array_shift($teams);
398		}
399	9	$this->group->game($tInGame);
400		}
401	9	return $teams;
402		}
403
404		}
405

Heroyt / tournament-generator

Push — master ( a1420e...5c3586 )

Generator::genGames() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like