forked from UnionOfRAD/phpca
/
FunctionsMustHaveDocBlockRuleTest.php
135 lines (113 loc) · 4.8 KB
/
FunctionsMustHaveDocBlockRuleTest.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
<?php
/**
* Copyright (c) 2009 Stefan Priebsch <stefan@priebsch.de>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
*
* * Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* * Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* * Neither the name of Stefan Priebsch nor the names of contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER ORCONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
* OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* @package PHPca
* @author Stefan Priebsch <stefan@priebsch.de>
* @copyright Stefan Priebsch <stefan@priebsch.de>. All rights reserved.
* @license BSD License
*/
namespace spriebsch\PHPca\Rule;
use spriebsch\PHPca\Loader;
use spriebsch\PHPca\Constants;
use spriebsch\PHPca\Tokenizer;
use spriebsch\PHPca\Result;
require_once __DIR__ . '/../../src/Rule/FunctionsMustHaveDocBlockRule.php';
/**
* Tests for the functions must have doc block rule.
*
* @author Stefan Priebsch <stefan@priebsch.de>
* @copyright Stefan Priebsch <stefan@priebsch.de>. All rights reserved.
*/
class FunctionsMustHaveDocBlockRuleTest extends AbstractRuleTest
{
/**
* @covers \spriebsch\PHPca\Rule\FunctionsMustHaveDocBlockRule
*/
public function testNoFunctionToken()
{
$this->init(__DIR__ . '/../_testdata/FunctionsMustHaveDocBlockRule/no_function.php');
$rule = new FunctionsMustHaveDocBlockRule();
$rule->check($this->file, $this->result);
$this->assertFalse($this->result->hasViolations());
}
/**
* One function and no docblock in the file.
*
* @covers \spriebsch\PHPca\Rule\FunctionsMustHaveDocBlockRule
*/
public function testReportsViolationWhenFileContainsNoDocBlock()
{
$this->init(__DIR__ . '/../_testdata/FunctionsMustHaveDocBlockRule/one_function.php');
$rule = new FunctionsMustHaveDocBlockRule();
$rule->check($this->file, $this->result);
$this->assertTrue($this->result->hasViolations());
}
/**
* @covers \spriebsch\PHPca\Rule\FunctionsMustHaveDocBlockRule
*/
public function testFunctionHasDocBlock()
{
$this->init(__DIR__ . '/../_testdata/FunctionsMustHaveDocBlockRule/docblock.php');
$rule = new FunctionsMustHaveDocBlockRule();
$rule->check($this->file, $this->result);
$this->assertFalse($this->result->hasViolations());
}
/**
* @covers \spriebsch\PHPca\Rule\FunctionsMustHaveDocBlockRule
*/
public function testFunctionHasNoDocBlock()
{
$this->init(__DIR__ . '/../_testdata/FunctionsMustHaveDocBlockRule/no_docblock.php');
$rule = new FunctionsMustHaveDocBlockRule();
$rule->check($this->file, $this->result);
$this->assertTrue($this->result->hasViolations());
$this->assertEquals(4, $this->result->getNumberOfViolations());
}
/**
* @covers \spriebsch\PHPca\Rule\FunctionsMustHaveDocBlockRule
*/
public function testBug0001()
{
$this->init(__DIR__ . '/../_testdata/FunctionsMustHaveDocBlockRule/bug0001.php');
$rule = new FunctionsMustHaveDocBlockRule();
$rule->check($this->file, $this->result);
$this->assertTrue($this->result->hasViolations());
$this->assertEquals(3, $this->result->getNumberOfViolations());
$violations = $this->result->getViolations('test.php');
$this->assertEquals(12, $violations[0]->getLine());
$this->assertEquals(19, $violations[0]->getColumn());
$this->assertEquals(16, $violations[1]->getLine());
$this->assertEquals(21, $violations[1]->getColumn());
$this->assertEquals(26, $violations[2]->getLine());
$this->assertEquals(1, $violations[2]->getColumn());
}
}
?>