Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update serialization mechanism #90

Merged
merged 4 commits into from
Apr 17, 2024
Merged

Update serialization mechanism #90

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
24bb1fc
Update serialization mechanism
gmazzap Apr 16, 2024
fe6b000
Fix QA
gmazzap Apr 16, 2024
e77a9e3
Update documentation for serialization-related sniffs
gmazzap Apr 17, 2024
7104de0
Improve DisableMagicSerializeSniff error message
gmazzap Apr 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 6 additions & 10 deletions Inpsyde/Sniffs/CodeQuality/DisableMagicSerializeSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,10 @@

class DisableMagicSerializeSniff implements Sniff
{
/** @var list<string> */
/** @var array<string, string> */
public array $disabledFunctions = [
'__serialize',
'__sleep',
'__unserialize',
'__wakeup',
'__sleep' => '__serialize',
'__wakeup' => '__unserialize',
];

/**
Expand All @@ -42,12 +40,10 @@ public function process(File $phpcsFile, $stackPtr): void
}

$name = FunctionDeclarations::getName($phpcsFile, $stackPtr);
if (in_array($name, $this->disabledFunctions, true)) {
$alternative = $this->disabledFunctions[$name] ?? null;
if ($alternative !== null) {
$phpcsFile->addError(
sprintf(
'The method "%s" is forbidden, please use Serializable interface.',
$name
),
"The method '{$name}' is deprecated, please use '{$alternative}' instead.",
$stackPtr,
'Found'
);
Expand Down
52 changes: 52 additions & 0 deletions Inpsyde/Sniffs/CodeQuality/DisableSerializeInterfaceSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
<?php

declare(strict_types=1);

namespace Inpsyde\Sniffs\CodeQuality;

use PHP_CodeSniffer\Files\File;
use PHP_CodeSniffer\Sniffs\Sniff;
use PHPCSUtils\Utils\ObjectDeclarations;

class DisableSerializeInterfaceSniff implements Sniff
{
/**
* @return list<int|string>
*/
public function register(): array
{
return [
\T_CLASS,
\T_ANON_CLASS,
\T_ENUM,
\T_INTERFACE,
];
}

/**
* @param File $phpcsFile
* @param int $stackPtr
* @return void
*
* phpcs:disable Inpsyde.CodeQuality.ArgumentTypeDeclaration
*/
public function process(File $phpcsFile, $stackPtr): void
{
// phpcs:enable Inpsyde.CodeQuality.ArgumentTypeDeclaration
$tokenCode = $phpcsFile->getTokens()[$stackPtr]['code'] ?? null;
$find = ($tokenCode === \T_INTERFACE)
? ObjectDeclarations::findExtendedInterfaceNames($phpcsFile, $stackPtr)
: ObjectDeclarations::findImplementedInterfaceNames($phpcsFile, $stackPtr);

if (($find === false) || !in_array('Serializable', $find, true)) {
return;
}

$phpcsFile->addError(
'The Serializable interface is deprecated, '
. 'please use __serialize and __unserialize instead.',
$stackPtr,
'Found'
);
}
}
49 changes: 25 additions & 24 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,30 +117,31 @@ Some rules are also included from PHP_CodeSniffer itself, as well as [PHPCSExtra

The following custom rules are in use:

| Sniff Name | Description | Has Config | Auto-Fixable |
|:---------------------------|:-----------------------------------------------------------------------------------------------|:----------:|:------------:|
| `ArgumentTypeDeclaration` | Enforce argument type declaration. | | |
| `DisableCallUserFunc` | Disable usage of `call_user_func`. | | |
| `DisableMagicSerialize` | Disable usage of `__serialize`, `__sleep`, `__unserialize`, `__wakeup`. | | |
| `DisallowShortOpenTag` | Disallow short open PHP tag (short echo tag allowed). | | |
| `ElementNameMinimalLength` | Use minimum 3 chars for names (with a few exclusions) | ✓ | |
| `EncodingComment` | Detect usage of opening `-*- coding: utf-8 -*-` | ✓ | ✓ |
| `ForbiddenPublicProperty` | No public class properties | | |
| `FunctionBodyStart` | Handle blank line at start of function body. | | ✓ |
| `FunctionLength` | Max 50 lines per function/method, excluding blank lines and comments-only lines. | ✓ | |
| `HookClosureReturn` | Ensure that actions callbacks do not return anything, while filter callbacks return something. | | |
| `HookPriority` | Report usage of `PHP_INT_MAX` and `PHP_INT_MIN` as hook priority. | | |
| `LineLength` | Max 100 chars per line | ✓ | |
| `NestingLevel` | Max indent level of 3 inside functions | ✓ | |
| `NoAccessors` | Discourage usage of getters and setters. | | |
| `NoElse` | Discourage usage of `else`. | | |
| `NoRootNamespaceFunctions` | Report usage of global functions in the root namespace. | | |
| `NoTopLevelDefine` | Discourage usage of `define` where `const` is preferable. | | |
| `PropertyPerClassLimit` | Discourage usage of more than 10 properties per class. | ✓ | |
| `Psr4` | Check PSR-4 compliance | ✓ | |
| `ReturnTypeDeclaration` | Enforce return type declaration | | |
| `StaticClosure` | Points closures that can be `static`. | | ✓ |
| `VariablesName` | Check variable (and properties) names | ✓ | |
| Sniff Name | Description | Has Config | Auto-Fixable |
|:----------------------------|:-----------------------------------------------------------------------------------------------|:----------:|:------------:|
| `ArgumentTypeDeclaration` | Enforce argument type declaration. | | |
| `DisableCallUserFunc` | Disable usage of `call_user_func`. | | |
| `DisableMagicSerialize` | Disable usage of `__sleep`, `__wakeup`. | | |
| `DisableSerializeInterface` | Disable usage of `Serializable` interface. | | |
| `DisallowShortOpenTag` | Disallow short open PHP tag (short echo tag allowed). | | |
| `ElementNameMinimalLength` | Use minimum 3 chars for names (with a few exclusions) | ✓ | |
| `EncodingComment` | Detect usage of opening `-*- coding: utf-8 -*-` | ✓ | ✓ |
| `ForbiddenPublicProperty` | No public class properties | | |
| `FunctionBodyStart` | Handle blank line at start of function body. | | ✓ |
| `FunctionLength` | Max 50 lines per function/method, excluding blank lines and comments-only lines. | ✓ | |
| `HookClosureReturn` | Ensure that actions callbacks do not return anything, while filter callbacks return something. | | |
| `HookPriority` | Report usage of `PHP_INT_MAX` and `PHP_INT_MIN` as hook priority. | | |
| `LineLength` | Max 100 chars per line | ✓ | |
| `NestingLevel` | Max indent level of 3 inside functions | ✓ | |
| `NoAccessors` | Discourage usage of getters and setters. | | |
| `NoElse` | Discourage usage of `else`. | | |
| `NoRootNamespaceFunctions` | Report usage of global functions in the root namespace. | | |
| `NoTopLevelDefine` | Discourage usage of `define` where `const` is preferable. | | |
| `PropertyPerClassLimit` | Discourage usage of more than 10 properties per class. | ✓ | |
| `Psr4` | Check PSR-4 compliance | ✓ | |
| `ReturnTypeDeclaration` | Enforce return type declaration | | |
| `StaticClosure` | Points closures that can be `static`. | | ✓ |
| `VariablesName` | Check variable (and properties) names | ✓ | |

For **notes and configuration**, refer to the [`inpsyde-custom-sniffs.md`](/inpsyde-custom-sniffs.md)
file in this repository.
Expand Down
2 changes: 0 additions & 2 deletions tests/unit/fixtures/disallow-magic-serialize.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@

class Foo {

// @phpcsErrorOnNextLine
public function __serialize(): array
{
return [];
Expand Down Expand Up @@ -37,7 +36,6 @@ public function wakeup(): array
return [];
}

// @phpcsErrorOnNextLine
public function __unserialize(): array
{
return [];
Expand Down
58 changes: 58 additions & 0 deletions tests/unit/fixtures/disallow-serialize-interface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
<?php

// @phpcsSniff Inpsyde.CodeQuality.DisableSerializeInterface

// @phpcsErrorOnNextLine
class One implements Serializable {

public function serialize()
{
return null;
}

public function unserialize($data)
{
}
}

// @phpcsErrorOnNextLine
$x = new class implements Serializable {

public function serialize()
{
return null;
}

public function unserialize($data)
{
}
};

class Three {

public function serialize()
{
return null;
}

public function unserialize($data)
{
}
}

// @phpcsErrorOnNextLine
interface Two extends Serializable {

}

class Four {

public function __serialize()
{
return null;
}

public function __unserialize($data)
{
}
}