Skip to content

Commit 89c3316

Browse files
fabacinofabacino
committed
Use codesniffer to check coding standards
1 parent fb1da58 commit 89c3316

File tree

8 files changed

+116
-42
lines changed

8 files changed

+116
-42
lines changed

‎build.xml‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<?xml version="1.0" encoding="UTF-8"?>
22
<project name="Debug functions" default="all">
33

4-
<target name="all" depends="tests,analyse"/>
4+
<target name="all" depends="tests,analyse,cs"/>
55

66
<target name="tests">
77
<exec
@@ -26,4 +26,13 @@
2626
</exec>
2727
</target>
2828

29+
<target name="cs">
30+
<exec
31+
executable="vendor/bin/phpcs"
32+
logoutput="true"
33+
passthru="true"
34+
checkreturn="true"
35+
/>
36+
</target>
37+
2938
</project>

‎composer.json‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@
1818
"phpstan/phpstan": "^0.12",
1919
"phpstan/phpstan-deprecation-rules": "^0.12",
2020
"phpstan/phpstan-strict-rules": "^0.12",
21-
"phpunit/phpunit": "^8.0"
21+
"phpunit/phpunit": "^8.0",
22+
"squizlabs/php_codesniffer": "^3.5"
2223
},
2324
"autoload": {
2425
"psr-4": {

‎composer.lock‎

Lines changed: 52 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎phpcs.xml‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<?xml version="1.0"?>
2+
<ruleset name="Debug functions">
3+
<file>src</file>
4+
<file>tests</file>
5+
6+
<arg name="extensions" value="php"/>
7+
<arg name="encoding" value="utf-8"/>
8+
<arg name="parallel" value="75"/>
9+
<arg value="sp"/>
10+
11+
<rule ref="PSR12"/>
12+
<rule ref="Squiz.NamingConventions.ValidVariableName.NotCamelCaps"/>
13+
</ruleset>

‎src/Debug.php‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ class Debug
2222
/**
2323
* Available flags for tweaking the output.
2424
*/
25-
const USE_VARDUMP = 1;
26-
const USE_HTMLENTITIES = 2;
25+
public const USE_VARDUMP = 1;
26+
public const USE_HTMLENTITIES = 2;
2727

2828
/**
2929
* Default flags for tweaking the output.
@@ -37,27 +37,27 @@ class Debug
3737
*
3838
* @var LoggerInterface
3939
*/
40-
private $Logger;
40+
private $logger;
4141

4242
/**
4343
* Singleton instance.
4444
*
4545
* @var Debug
4646
*/
47-
private static $Instance;
47+
private static $instance;
4848

4949
/**
5050
* Constructor.
5151
*
5252
* @param int $defaultFlags Default flags for tweaking the output.
53-
* @param LoggerInterface $Logger The logger instance.
53+
* @param LoggerInterface $logger The logger instance.
5454
*
5555
* @return void
5656
*/
57-
final private function __construct(int $defaultFlags, LoggerInterface $Logger)
57+
final private function __construct(int $defaultFlags, LoggerInterface $logger)
5858
{
5959
$this->defaultFlags = $defaultFlags;
60-
$this->Logger = $Logger;
60+
$this->logger = $logger;
6161
}
6262

6363
/**
@@ -67,10 +67,10 @@ final private function __construct(int $defaultFlags, LoggerInterface $Logger)
6767
*/
6868
public static function getInstance(): Debug
6969
{
70-
if (self::$Instance === null) {
70+
if (self::$instance === null) {
7171
static::init();
7272
}
73-
return self::$Instance;
73+
return self::$instance;
7474
}
7575

7676
/**
@@ -103,17 +103,17 @@ public static function init(array $settings = [])
103103
}
104104

105105
if (isset($settings['logger']) && $settings['logger'] instanceof LoggerInterface) {
106-
$Logger = $settings['logger'];
106+
$logger = $settings['logger'];
107107
} else {
108108
if (isset($settings['log_file'])) {
109-
$Logger = new Logger($settings['log_file']);
109+
$logger = new Logger($settings['log_file']);
110110
} else {
111111
// We didn't get any file to log.
112-
$Logger = new Logger();
112+
$logger = new Logger();
113113
}
114114
}
115115

116-
self::$Instance = new static($defaultFlags, $Logger);
116+
self::$instance = new static($defaultFlags, $logger);
117117
}
118118

119119
/**
@@ -179,7 +179,7 @@ public function debugValue($var, int $flags = null)
179179
*/
180180
public function logValue($var, int $flags = null)
181181
{
182-
$this->Logger->debug(static::debugValue($var, $flags));
182+
$this->logger->debug(static::debugValue($var, $flags));
183183
}
184184

185185
/**

‎src/Logger.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ class Logger implements LoggerInterface
2222
/**
2323
* Default date format.
2424
*/
25-
const DATE_FORMAT = 'Y-m-d H:i:s.u';
25+
public const DATE_FORMAT = 'Y-m-d H:i:s.u';
2626

2727
/**
2828
* Logfile.

‎tests/DbgThrowTest.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,8 @@ private function captureException($var, int $flags = null)
5252
{
5353
try {
5454
dbgthrow($var, $flags);
55-
} catch (\Exception $Exception) {
56-
return $Exception->getMessage();
55+
} catch (\Exception $exception) {
56+
return $exception->getMessage();
5757
}
5858
return null;
5959
}

‎tests/LoggerTest.php‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ public function testReactionOnDebug()
2525

2626
$var = random_int(PHP_INT_MIN, PHP_INT_MAX);
2727

28-
$Logger = new Logger($logfile);
29-
$Logger->debug($var);
28+
$logger = new Logger($logfile);
29+
$logger->debug($var);
3030

3131
self::assertRegExp(
3232
TestHelper::makePattern($var),
@@ -40,8 +40,8 @@ public function testReactionOnLogWithDebugLevel()
4040

4141
$var = random_int(PHP_INT_MIN, PHP_INT_MAX);
4242

43-
$Logger = new Logger($logfile);
44-
$Logger->log(LogLevel::DEBUG, $var);
43+
$logger = new Logger($logfile);
44+
$logger->log(LogLevel::DEBUG, $var);
4545

4646
self::assertRegExp(
4747
TestHelper::makePattern($var),
@@ -55,14 +55,14 @@ public function testReactionOnNonDebug()
5555

5656
$var = random_int(PHP_INT_MIN, PHP_INT_MAX);
5757

58-
$Logger = new Logger($logfile);
59-
$Logger->emergency($var);
60-
$Logger->alert($var);
61-
$Logger->critical($var);
62-
$Logger->error($var);
63-
$Logger->warning($var);
64-
$Logger->notice($var);
65-
$Logger->info($var);
58+
$logger = new Logger($logfile);
59+
$logger->emergency($var);
60+
$logger->alert($var);
61+
$logger->critical($var);
62+
$logger->error($var);
63+
$logger->warning($var);
64+
$logger->notice($var);
65+
$logger->info($var);
6666

6767
self::assertEmpty(file_get_contents($logfile));
6868
}
@@ -73,14 +73,14 @@ public function testReactionOnLogWithNonDebugLevel()
7373

7474
$var = random_int(PHP_INT_MIN, PHP_INT_MAX);
7575

76-
$Logger = new Logger($logfile);
77-
$Logger->log(LogLevel::EMERGENCY, $var);
78-
$Logger->log(LogLevel::ALERT, $var);
79-
$Logger->log(LogLevel::CRITICAL, $var);
80-
$Logger->log(LogLevel::ERROR, $var);
81-
$Logger->log(LogLevel::WARNING, $var);
82-
$Logger->log(LogLevel::NOTICE, $var);
83-
$Logger->log(LogLevel::INFO, $var);
76+
$logger = new Logger($logfile);
77+
$logger->log(LogLevel::EMERGENCY, $var);
78+
$logger->log(LogLevel::ALERT, $var);
79+
$logger->log(LogLevel::CRITICAL, $var);
80+
$logger->log(LogLevel::ERROR, $var);
81+
$logger->log(LogLevel::WARNING, $var);
82+
$logger->log(LogLevel::NOTICE, $var);
83+
$logger->log(LogLevel::INFO, $var);
8484

8585
self::assertEmpty(file_get_contents($logfile));
8686
}
@@ -90,8 +90,8 @@ public function testWithNoLogFile()
9090
$logfile = TestHelper::createTempFile();
9191

9292
$var = random_int(PHP_INT_MIN, PHP_INT_MAX);
93-
$Logger = new Logger();
94-
$Logger->debug($var);
93+
$logger = new Logger();
94+
$logger->debug($var);
9595

9696
self::assertEmpty(file_get_contents($logfile));
9797
}

0 commit comments

Comments
 (0)