Skip to content

Commit 03d2de9

Browse files
mwatsonmwatson
committed
Added unit tests, fixed lack of 'Qu' tile
1 parent 459d623 commit 03d2de9

File tree

7 files changed

+231
-29
lines changed

7 files changed

+231
-29
lines changed

‎.gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
coverage/*
2+
vendor/*
3+
composer.lock

‎composer.json

+3
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@
55
"require": {
66
"php": ">=5.3.0"
77
},
8+
"require-dev": {
9+
"phpunit/phpunit": "~4.0"
10+
},
811
"autoload": {
912
"psr-4": {
1013
"BoggleSolver\\": "src/"

‎examples/example02.php

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
<?php
2+
header('Content-Type: text/plain; charset=utf-8');
3+
4+
// if you just use composer:
5+
//include(__DIR__ . '/../vendor/autoload.php');
6+
7+
// if you don't have an autoloader for some reason
8+
include(__DIR__ . '/../src/BoggleTile.php');
9+
include(__DIR__ . '/../src/BoggleException.php');
10+
include(__DIR__ . '/../src/BoggleSolver.php');
11+
12+
// testing a board with a Qu tile
13+
$boggleBoard = "IZLEERCVADJQuITDI";
14+
15+
$boggle = new \BoggleSolver\BoggleSolver();
16+
17+
try {
18+
$boggle->loadBoard($boggleBoard);
19+
} catch (\BoggleSolver\BoggleException $e) {
20+
die("exiting on error: " . $e->getMessage());
21+
}
22+
23+
$words = $boggle->findWords();
24+
25+
26+
echo "Boggle Board:\n\n";
27+
echo $boggle->displayBoard();
28+
29+
echo "\n";
30+
31+
foreach ($words as $word) {
32+
echo $word . "\n";
33+
}
34+
35+
echo "\n";

‎makefile

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
PHPUNIT=vendor/phpunit/phpunit/phpunit
2+
3+
tests: tests/* src/* ; $(PHPUNIT) tests
4+
5+
coverage: tests/* src/* ; $(PHPUNIT) --coverage-html coverage tests
6+
7+
clean: ; rm -rf coverage

‎src/BoggleSolver.php

+18-29
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ class BoggleSolver
1212

1313
public $lastSolveTime;
1414

15-
// for now, 3 - 12 letter words only
15+
// for now, 3 - 11 letter words only
1616
public static $minLen = 3;
1717
public static $maxLen = 11;
1818

@@ -28,7 +28,7 @@ public function __construct()
2828

2929
public function getWords()
3030
{
31-
return explode("\r\n", file_get_contents(__DIR__ . static::$dictFile));
31+
return explode("\r\n", static::getDictFileContents());
3232
}
3333

3434
public function loadDict()
@@ -65,6 +65,10 @@ public function loadDict()
6565
}
6666

6767
$letter = $word[$i];
68+
if ($letter == 'Q' && $word[$i + 1] == 'U') {
69+
$letter = 'Qu';
70+
$i++;
71+
}
6872
if (!isset($ptr[$letter])) {
6973
$ptr[$letter] = array();
7074
}
@@ -78,10 +82,14 @@ public function loadDict()
7882
public function loadBoard($board)
7983
{
8084
// the board can be any string, non alpha chars will be stripped
81-
$board = preg_replace("|[^A-Za-z]|", '', $board);
85+
$board = strtoupper(preg_replace("|[^A-Za-z]|", '', $board));
8286

8387
$this->size = 0;
8488

89+
if (strpos($board, 'QU') !== false) {
90+
$board = str_replace('QU', 'Q', $board);
91+
}
92+
8593
// currently only 3x3 and 4x4 are suported
8694
switch (strlen($board)) {
8795
case 9:
@@ -92,11 +100,11 @@ public function loadBoard($board)
92100
break;
93101
default:
94102
throw new BoggleException("Unknown board size of " . strlen($board));
95-
96103
}
97104

98105
for ($i = 0; $i < strlen($board); $i++) {
99-
$this->board[] = new BoggleTile($board[$i], $i);
106+
$letter = $board[$i] == 'Q' ? 'Qu' : $board[$i];
107+
$this->board[] = new BoggleTile($letter, $i);
100108
$this->boardLookup[$board[$i]] = true;
101109
}
102110

@@ -158,30 +166,6 @@ public function displayBoard($lineEnd = "\n")
158166
return $board;
159167
}
160168

161-
public function traverseBoard($callback)
162-
{
163-
$ptr = &$this->board[0];
164-
$dir = "e";
165-
166-
while (1) {
167-
168-
$callback($ptr);
169-
170-
if ($ptr->$dir === null && $ptr->s === null) {
171-
break;
172-
}
173-
174-
if ($ptr->$dir !== null) {
175-
$ptr = &$ptr->$dir;
176-
} else if ($ptr->s !== null) {
177-
$ptr = &$ptr->s;
178-
$dir = $dir == "e" ? "w" : "e";
179-
} else {
180-
break;
181-
}
182-
}
183-
}
184-
185169
public function findWords()
186170
{
187171
$start = microtime(true);
@@ -279,4 +263,9 @@ public function findWordsFromOneTile($boardPtr = null, $dictPtr = null, $words =
279263

280264
return $words;
281265
}
266+
267+
public static function getDictFileContents()
268+
{
269+
return file_get_contents(__DIR__ . static::$dictFile);
270+
}
282271
}

‎tests/BoggleSolver/BoggleSolverTest.php

+151
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,151 @@
1+
<?php
2+
3+
namespace BoggleSolver;
4+
5+
class BoggleSolverTest extends \PHPUnit_Framework_TestCase
6+
{
7+
public $lessWords = array(
8+
"ABCD", "ABC", "ABBA", "ABABA", "ABQU", "XYZ", "ABBBBBBBBBBBBBBBB", "AB"
9+
);
10+
11+
public function testLoadDictBuildsDictionary()
12+
{
13+
$solverMock = $this->getMockBuilder('\BoggleSolver\BoggleSolver')
14+
->setMethods(array('getWords'))
15+
->getMock();
16+
17+
$solverMock->expects($this->once())
18+
->method('getWords')
19+
->will($this->returnValue($this->lessWords));
20+
21+
$solverMock->boardLookup = array('A' => 1);
22+
$solverMock->size = 3;
23+
24+
$solverMock->loadDict();
25+
26+
$expectedDict = array(
27+
'A' => array(
28+
'B' => array(
29+
'C' => array(
30+
"ABC",
31+
'D' => array(
32+
"ABCD",
33+
),
34+
),
35+
'B' => array(
36+
'A' => array(
37+
"ABBA",
38+
),
39+
),
40+
'A' => array(
41+
'B' => array(
42+
'A' => array(
43+
"ABABA",
44+
),
45+
),
46+
),
47+
'Qu' => array(
48+
"ABQU"
49+
),
50+
),
51+
),
52+
);
53+
54+
$this->assertEquals($expectedDict, $solverMock->dict);
55+
}
56+
57+
public function testLoadBoardLoadsBoard()
58+
{
59+
$exampleBoard = "A B C\nX Y Z\nQu R S";
60+
61+
$solverMock = $this->getMockBuilder('\BoggleSolver\BoggleSolver')
62+
->setMethods(array('loadDict'))
63+
->getMock();
64+
65+
$solverMock->expects($this->once())
66+
->method('loadDict');
67+
68+
$solverMock->loadBoard($exampleBoard);
69+
70+
$expectedLookup = array(
71+
'A', 'B', 'C', 'X', 'Y', 'Z', 'Q', 'R', 'S'
72+
);
73+
74+
$this->assertEquals(3, $solverMock->size);
75+
76+
$this->assertEquals($expectedLookup, array_keys($solverMock->boardLookup));
77+
}
78+
79+
public function testLoadBoardLoadsBoardOfFourByFour()
80+
{
81+
$exampleBoard = "A B C D\nX Y Z A\nQu R S T\nO K A Y";
82+
83+
$solverMock = $this->getMockBuilder('\BoggleSolver\BoggleSolver')
84+
->setMethods(array('loadDict'))
85+
->getMock();
86+
87+
$solverMock->expects($this->once())
88+
->method('loadDict');
89+
90+
$solverMock->loadBoard($exampleBoard);
91+
92+
$this->assertEquals(4, $solverMock->size);
93+
94+
}
95+
96+
public function testLoadBoardThrowsExceptionOnUnknownBoardSize()
97+
{
98+
$exampleBoard = "A";
99+
100+
$this->setExpectedException('\BoggleSolver\BoggleException');
101+
102+
$solverMock = $this->getMockBuilder('\BoggleSolver\BoggleSolver')
103+
->setMethods(array('loadDict'))
104+
->getMock();
105+
106+
$solverMock->expects($this->never())
107+
->method('loadDict');
108+
109+
$solverMock->loadBoard($exampleBoard);
110+
}
111+
112+
public function testDisplayBoardReturnsBoard()
113+
{
114+
$solverMock = $this->getMockBuilder('\BoggleSolver\BoggleSolver')
115+
->setMethods(array('loadDict'))
116+
->getMock();
117+
118+
$solverMock->expects($this->once())
119+
->method('loadDict');
120+
121+
$solverMock->loadBoard("ABCDEFGHI");
122+
123+
$result = $solverMock->displayBoard();
124+
125+
$this->assertEquals("ABC\nDEF\nGHI\n", $result);
126+
}
127+
128+
public function testFindWords()
129+
{
130+
$solverMock = $this->getMockBuilder('\BoggleSolver\BoggleSolver')
131+
->setMethods(array('getWords'))
132+
->getMock();
133+
134+
$solverMock->expects($this->once())
135+
->method('getWords')
136+
->will($this->returnValue($this->lessWords));
137+
138+
$solverMock->boardLookup = array('A' => 1);
139+
$solverMock->size = 3;
140+
141+
$solverMock->loadBoard("ABCABDABA");
142+
143+
$result = $solverMock->findWords();
144+
145+
$expected = array(
146+
"ABC", "ABCD", "ABBA", "ABABA",
147+
);
148+
149+
$this->assertEquals($expected, $result);
150+
}
151+
}

‎tests/BoggleSolver/BoggleTileTest.php

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
<?php
2+
3+
namespace BoggleSolver;
4+
5+
class BoggleTileTest extends \PHPUnit_Framework_TestCase
6+
{
7+
public function testConstructor()
8+
{
9+
$tile = new BoggleTile('A', 0);
10+
11+
$this->assertEquals('A', $tile->letter);
12+
$this->assertEquals(0, $tile->id);
13+
}
14+
}

0 commit comments

Comments
 (0)