\+[0-9]{10,16})
--------------------------------------------------------------------------------
/tests/Helper/helper_templates/temp1.txt:
--------------------------------------------------------------------------------
1 | Simple Template 01 {%variable%}
2 |
3 | Multi Line
--------------------------------------------------------------------------------
/tests/Helper/helper_templates/temp2.txt:
--------------------------------------------------------------------------------
1 | Simple Template 01 {%variable%}
--------------------------------------------------------------------------------
/tests/Helper/helper_templates/temp3.txt:
--------------------------------------------------------------------------------
1 | Template with specified pattern {%variable:[0-9]+%}
--------------------------------------------------------------------------------
/tests/Helper/helper_templates/temp4.txt:
--------------------------------------------------------------------------------
1 | Template with specified pattern containing special escaped characters {%variable:\+[0-9]{10,16}%}
--------------------------------------------------------------------------------
/tests/ParseResultTest.php:
--------------------------------------------------------------------------------
1 | setParsedRawData(
19 | [
20 | 'resultsKey' => 'resultsValue ',
21 | 'foundKey' => 'parsedContent SometextInBold',
22 | 'date' => '2019-01-01',
23 | 'time' => ' 20:11',
24 | ]
25 | );
26 | }
27 |
28 | return $parseResult;
29 | }
30 |
31 | public function testGetParsedRawData()
32 | {
33 | $parseResult = $this->getNewParseResultObject();
34 |
35 | $this->assertIsArray($parseResult->getParsedRawData());
36 | $this->assertEmpty($parseResult->getParsedRawData());
37 | }
38 |
39 | public function testSetParsedRawData()
40 | {
41 | $parseResult = $this->getNewParseResultObject(true);
42 |
43 | $this->assertIsArray($parseResult->getParsedRawData());
44 | $this->assertNotEmpty($parseResult->getParsedRawData());
45 | $this->assertArrayHasKey('resultsKey', $parseResult->getParsedRawData());
46 | $this->assertArrayHasKey('foundKey', $parseResult->getParsedRawData());
47 | }
48 |
49 | public function testSetParsedRawDataCleansContent()
50 | {
51 | $parseResult = $this->getNewParseResultObject(true);
52 |
53 | $resultsArray = $parseResult->getParsedRawData();
54 |
55 | $this->assertEquals('resultsValue', $resultsArray['resultsKey']);
56 | $this->assertEquals('parsedContent SometextInBold', $resultsArray['foundKey']);
57 | $this->assertEquals('20:11', $resultsArray['time']);
58 | }
59 |
60 | public function testAppliedTemplateFileSetterAndGetter()
61 | {
62 | $parseResult = $this->getNewParseResultObject();
63 |
64 | $this->assertEmpty($parseResult->getAppliedTemplateFile());
65 |
66 | $matchedTemplatePath = 'path/to/matched/Template.txt';
67 | $parseResult->setAppliedTemplateFile($matchedTemplatePath);
68 |
69 | $this->assertNotEmpty($parseResult->getAppliedTemplateFile());
70 | $this->assertEquals($matchedTemplatePath, $parseResult->getAppliedTemplateFile());
71 | }
72 |
73 | public function testCountResults()
74 | {
75 | $parseResult = $this->getNewParseResultObject(true);
76 |
77 | $this->assertEquals(4, $parseResult->countResults());
78 | }
79 |
80 | public function testKeyExists()
81 | {
82 | $parseResult = $this->getNewParseResultObject(true);
83 |
84 | $this->assertTrue($parseResult->keyExists('foundKey'));
85 | $this->assertTrue($parseResult->keyExists('resultsKey'));
86 | $this->assertFalse($parseResult->keyExists('AKeyWeNeverFound'));
87 | }
88 |
89 | public function testGetResultKey()
90 | {
91 | $parseResult = $this->getNewParseResultObject(true);
92 | $this->assertEquals('resultsValue', $parseResult->get('resultsKey'));
93 | $this->assertEquals('parsedContent SometextInBold', $parseResult->get('foundKey'));
94 | $this->assertEquals('2019-01-01', $parseResult->get('date'));
95 | $this->assertEquals('20:11', $parseResult->get('time'));
96 | $this->assertNull($parseResult->get('AKeyWeNeverFound'));
97 | }
98 |
99 | public function testStrictGetResultKeyThrowsInvalidKeyException()
100 | {
101 | $parseResult = $this->getNewParseResultObject(true);
102 | $this->assertEquals('resultsValue', $parseResult->get('resultsKey', true));
103 |
104 |
105 | $this->expectException(InvalidParsedDataKeyException::class);
106 | $parseResult->get('AKeyWeNeverFound', true);
107 | }
108 | }
109 |
--------------------------------------------------------------------------------
/tests/TextParserTest.php:
--------------------------------------------------------------------------------
1 | expectException(InvalidTemplatesDirectoryException::class);
17 | new TextParser(__DIR__ . '/DirectoryThatDoesNotExist');
18 | }
19 |
20 | public function testTextParsingFailure()
21 | {
22 | $parser = $this->getTemplatesParser();
23 | $parser->parseText('Some Text that can not be matched against a template');
24 |
25 | $this->assertEmpty($parser->getParseResults()->getParsedRawData());
26 | }
27 |
28 | public function testTextParsingResetsPreviousMatch()
29 | {
30 | $parser = $this->getTemplatesParser();
31 | $parser->parseFileContent(__DIR__ . '/test_txt_files/t0TemplateMatch.txt');
32 | $this->assertEquals(13, $parser->getParseResults()->countResults());
33 |
34 | $parser->parseFileContent(__DIR__ . '/test_txt_files/noMatch.txt');
35 | $this->assertEmpty($parser->getParseResults()->getParsedRawData());
36 | }
37 |
38 | public function testTextParsingSuccess()
39 | {
40 | $parser = $this->getTemplatesParser();
41 | $parser->parseFileContent(__DIR__ . '/test_txt_files/t0TemplateMatch.txt');
42 | $this->assertEquals(13, $parser->getParseResults()->countResults());
43 | }
44 |
45 | public function testSimilarityCheckFalseSelectsFirstMatchTemplateRatherBestFit()
46 | {
47 | $parser = $this->getTemplatesParser();
48 | $parseResults = $parser->parseFileContent(__DIR__ . '/test_txt_files/webFeedback.html');
49 | $this->assertEquals(1, $parseResults->countResults());
50 | $this->assertTrue($parseResults->keyExists('theWholeMessageMatch'));
51 | }
52 |
53 | public function testSimilarityCheckTrueSelectsBestFitTemplateRatherThanFirstMatch()
54 | {
55 | $parser = $this->getTemplatesParser();
56 | $parseResults = $parser->parseFileContent(
57 | __DIR__ . '/test_txt_files/webFeedback.html',
58 | true
59 | );
60 | $this->assertEquals(10, $parseResults->countResults());
61 | $this->assertFalse($parseResults->keyExists('theWholeMessageMatch'));
62 | $this->assertEquals('Mozilla', $parseResults->get('browserCode'));
63 | }
64 |
65 | public function testTextParsingReturns()
66 | {
67 | $parser = $this->getTemplatesParser();
68 | $parseResults = $parser->parseFileContent(__DIR__ . '/test_txt_files/t0TemplateMatch.txt');
69 |
70 | //Make sure no html scripts are returned
71 | $this->assertEquals(
72 | $parseResults->get('country'),
73 | htmlspecialchars($parseResults->get('country'))
74 | );
75 | //Make sure data is trimmed on return
76 | $this->assertEquals('2', $parseResults->get('children'));
77 |
78 | //Make sure data format and whitespaces are preserved
79 | $this->assertEquals(
80 | '11 - 10 - 2014',
81 | $parseResults->get('arrival_date')
82 | );
83 | }
84 |
85 | public function testParseInvalidFileContentException()
86 | {
87 | $parser = $this->getTemplatesParser();
88 | $this->expectException(InvalidParseFileException::class);
89 | $parser->parseFileContent(__DIR__ . '/test_txt_files/unknown.txt');
90 | }
91 |
92 | private function getTemplatesParser(): TextParser
93 | {
94 | return new TextParser(__DIR__ . '/templates');
95 | }
96 | }
97 |
--------------------------------------------------------------------------------
/tests/templates/t1webFeedback.txt:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | {%theWholeMessageMatch%}
5 |
6 |
--------------------------------------------------------------------------------
/tests/templates/t2webFeedback.txt:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | New Web App Bug / Feedback Received
5 | Dear admin,
6 | Here below are the details we gathered from the user regarding this feedback:
7 | Browser Details:
8 | appCodeName: {%browserCode%}
9 | appName: {%browserName%}
10 | appVersion: {%browserVersion%}
11 | cookieEnabled: {%cookiesUsed%}
12 | platform: {%OS%}
13 | userAgent: {%agent%}
14 | {%agentLine2%}
15 | plugins: {%plugins%}
16 |
17 | Report / Feedback:
18 | URL: {%feedbackUrl%}/
19 | User Note:: {%userFeedbackMessage%}
20 |
21 |
22 | The Web App Team
23 | Note: This is an automatic notification. Don't reply to this message
24 |
25 |
--------------------------------------------------------------------------------
/tests/templates/t_0.txt:
--------------------------------------------------------------------------------
1 | Sent at {%created%}
2 |
3 |
4 |
5 | Hi {%name1%},
6 |
7 |
8 |
9 |
10 |
11 | Click here to view the booked tour: {%tour%}
E-mail address :{%mail1%}
Customer Name :{%myname%}
Country :{%country%}
Arrival Date : {%arrival_date%}
Departure Date : {%departure_date%}
Number of Adults : {%adults%}
Number of Children :{%children%}
Additional Requests :{%more_data%}
12 |
--------------------------------------------------------------------------------
/tests/templates/t_1.txt:
--------------------------------------------------------------------------------
1 | Sent to customer service from {%source%}
2 | ==========================================
3 | Ref No. : {%reference%}
4 | E-mail address :{%mail1%}
5 | Phone No. :{%phone%}
6 | Name :{%customer_name%}
7 | Country :{%country%}
8 | Comment :{%more_data%}
9 |
--------------------------------------------------------------------------------
/tests/test_txt_files/noMatch.txt:
--------------------------------------------------------------------------------
1 | A file that has no matching templates in there that should not return any data :S although it may contain a structure like
2 |
3 | Name: Test Name Goes Here
4 | Nationality: Test Nationality
5 | .....
6 | ....
7 | ...
8 | ...
9 | ..
10 | .
11 | Comments: some text - some text - some text - some text - some text - some text
12 |
--------------------------------------------------------------------------------
/tests/test_txt_files/t0TemplateMatch.txt:
--------------------------------------------------------------------------------
1 | Sent at Thursday 9th of October 2014 03:20:44 PM
2 |
3 |
4 |
5 | Hi Carlo ,
6 |
7 |
8 |
9 |
10 |
11 | Click here to view the booked tour: Tour Name
E-mail address : mymail@test.com
Customer Name : Hello World
Country : Egypt
Arrival Date : 11 - 10 - 2014
Departure Date : 11 - 10 - 2014
Number of Adults : 4
Number of Children : 2
Additional Requests : Some more information goes here
12 |
--------------------------------------------------------------------------------
/tests/test_txt_files/webFeedback.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | New Web App Bug / Feedback Received
5 | Dear admin,
6 | Here below are the details we gathered from the user regarding this feedback:
7 | Browser Details:
8 | appCodeName: Mozilla
9 | appName: Netscape
10 | appVersion: 5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/39.0.2171.95 Safari/537.36
11 | cookieEnabled: 1
12 | platform: Linux x86_64
13 | userAgent: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/39.0.2171.95
14 | Safari/537.36
15 | plugins: a:5:{i:0;s:15:"Shockwave Flash";i:1;s:28:"Chrome Remote Desktop Viewer";i:2;s:34:"Widevine Content
16 | Decryption Module";i:3;s:13:"Native Client";i:4;s:17:"Chrome PDF Viewer";}
17 |
18 | Report / Feedback:
19 | URL: http://example.org/user/dashboard/
20 | User Note:: The logging out message alerts is not working
21 |
22 |
23 | The Web App Team
24 | Note: This is an automatic notification. Don't reply to this message
25 |
26 |
--------------------------------------------------------------------------------
18 |