phpcs calisthenics rulesダウンロードphpcs calisthenics rulesルールソースコードダウンロード

PHP_CODESNIFFERのオブジェクトの心臓病ルール

非推奨：PHP_CODESNIFFERは、スペースとCharの位置を処理するのに最適です。しかし、これらのルールはコードアーキテクチャと構造に関するものです。 2020年には、これに完全に適したツール-Phpstanがあります。

そうは言っても、オブジェクトの体操はsymplify/phpstan-rulesパッケージでphpstanルールとして実装されました。代わりにそれを使用しますか？

 includes:
    - vendor/symplify/phpstan-rules/packages/object-calisthenics/config/object-calisthenics-rules.neon
    - vendor/symplify/phpstan-rules/packages/object-calisthenics/config/object-calisthenics-services.neon

オブジェクトの体操は、オブジェクト指向のコードのルールのセットであり、保守性、読みやすさ、テスト可能性、および理解に焦点を当てています。私たちは最初に実用的です - それらはすべて一緒に、または1つずつ使いやすいです。

なぜあなたはあなたのプロジェクトでこれを使用する必要があるのですか？

William Durandによる投稿を読むか、 Guilherme Blancoによるプレゼンテーションをチェックしてください。

インストール

composer require object-calisthenics/phpcs-calisthenics-rules --dev

使用法

あなたが望むものを知っているなら、特定のルールにすぐにジャンプしてください：

1.メソッドごとのインデントのXレベルのみ
2。「else」キーワードを使用しないでください
5。ステートメントごとに1つのオブジェクト演算子（ - >）のみを使用します
6.略さないでください
7.クラスを小さく保ちます
9。ゲッターとセッターを使用しないでください

1つのルールをすばやく確認する方法は？

php_codesnifferで

vendor/bin/phpcs src tests -sp 
--standard=vendor/object-calisthenics/phpcs-calisthenics-rules/src/ObjectCalisthenics/ruleset.xml 
--sniffs=ObjectCalisthenics.Classes.ForbiddenPublicProperty

EasyCodingStandardで

 # ecs.yaml
services :
    ObjectCalisthenicsSniffsClassesForbiddenPublicPropertySniff : ~

それから

vendor/bin/ecs check src

実装されたルールスニフ

1.メソッドごとのインデントの`X`レベルのみ

 foreach ( $ sniffGroups as $ sniffGroup ) {
    foreach ( $ sniffGroup as $ sniffKey => $ sniffClass ) {
        if (! $ sniffClass instanceof Sniff) {
            throw new InvalidClassTypeException ;
        }
    }
}

？

 foreach ( $ sniffGroups as $ sniffGroup ) {
    $ this -> ensureIsAllInstanceOf ( $ sniffGroup , Sniff::class);
}

// ...
private function ensureIsAllInstanceOf ( array $ objects , string $ type )
{
    // ...
}

このルールのみを使用しますか？

php_codesniffer：

vendor/bin/phpcs ... --sniffs=ObjectCalisthenics.Metrics.MaxNestingLevel

ECS：

 # ecs.yaml
services :
    ObjectCalisthenicsSniffsMetricsMaxNestingLevelSniff : ~

？設定可能

php_codesniffer：

<? xml version = " 1.0 " ?>
< ruleset name = " my-project " >
    < rule ref = " ObjectCalisthenics.Metrics.MaxNestingLevel " >
        < properties >
            < property name = " maxNestingLevel " value = " 2 " />
        </ properties >
    </ rule >
</ ruleset >

ECS：

 services :
    ObjectCalisthenicsSniffsMetricsMaxNestingLevelSniff :
        maxNestingLevel : 2

2。「else」キーワードを使用しないでください

 if ( $ status === self :: DONE ) {
    $ this -> finish ();
} else {
    $ this -> advance ();
}

？

 if ( $ status === self :: DONE ) {
    $ this -> finish ();
    return ;
}

$ this -> advance ();

このルールのみを使用しますか？

php_codesniffer：

vendor/bin/phpcs ... --sniffs=ObjectCalisthenics.ControlStructures.NoElse

ECS：

 # ecs.yaml
services :
    ObjectCalisthenicsSniffsControlStructuresNoElseSniff : ~

5。ステートメントごとに1つのオブジェクト演算子（ `->` ）のみを使用します

 $ this -> container -> getBuilder ()-> addDefinition (SniffRunner::class);

？

 $ containerBuilder = $ this -> getContainerBuilder ();
$ containerBuilder -> addDefinition (SniffRunner::class);

このルールのみを使用しますか？

php_codesniffer：

vendor/bin/phpcs ... --sniffs=ObjectCalisthenics.CodeAnalysis.OneObjectOperatorPerLine

ECS：

 # ecs.yaml
services :
    ObjectCalisthenicsSniffsCodeAnalysisOneObjectOperatorPerLineSniff : ~

？設定可能

php_codesniffer：

<? xml version = " 1.0 " ?>
< ruleset name = " my-project " >
    < rule ref = " ObjectCalisthenics.CodeAnalysis.OneObjectOperatorPerLine " >
        < properties >
            < property name = " variablesHoldingAFluentInterface " type = " array " value = " $queryBuilder,$containerBuilder " />
            < property name = " methodsStartingAFluentInterface " type = " array " value = " createQueryBuilder " />
            < property name = " methodsEndingAFluentInterface " type = " array " value = " execute,getQuery " />
        </ properties >
    </ rule >
</ ruleset >

ECS：

 services :
    ObjectCalisthenicsSniffsCodeAnalysisOneObjectOperatorPerLineSniff :
        variablesHoldingAFluentInterface : ["$queryBuilder", "$containerBuilder"]
        methodsStartingAFluentInterface : ["createQueryBuilder"]
        methodsEndingAFluentInterface : ["execute", "getQuery"]

6.略さないでください

これは、クラス、特性、インターフェイス、定数、関数、変数名に関連しています。

 class EM
{
    // ...
}

？

 class EntityMailer
{
    // ...
}

このルールのみを使用しますか？

php_codesniffer：

vendor/bin/phpcs ... --sniffs=ObjectCalisthenics.NamingConventions.ElementNameMinimalLength

ECS：

 # ecs.yaml
services :
    ObjectCalisthenicsSniffsNamingConventionsElementNameMinimalLengthSniff : ~

？設定可能

php_codesniffer：

<? xml version = " 1.0 " ?>
< ruleset name = " my-project " >
    < rule ref = " ObjectCalisthenics.NamingConventions.ElementNameMinimalLength " >
        < properties >
            < property name = " minLength " value = " 3 " />
            < property name = " allowedShortNames " type = " array " value = " i,id,to,up " />
        </ properties >
    </ rule >
</ ruleset >

ECS：

 # ecs.yaml
services :
    ObjectCalisthenicsSniffsNamingConventionsElementNameMinimalLengthSniff :
        minLength : 3
        allowedShortNames : ["i", "id", "to", "up"]

7.クラスを小さく保ちます

 class SimpleStartupController
{
    // 300 lines of code
}

？

 class SimpleStartupController
{
    // 50 lines of code
}

 class SomeClass
{
    public function simpleLogic ()
    {
        // 30 lines of code
    }
}

？

 class SomeClass
{
    public function simpleLogic ()
    {
        // 10 lines of code
    }
}

 class SomeClass
{
    // 20 properties
}

？

 class SomeClass
{
    // 5 properties
}

 class SomeClass
{
    // 20 methods
}

？

 class SomeClass
{
    // 5 methods
}

このルールのみを使用しますか？

php_codesniffer：

vendor/bin/phpcs ... --sniffs=ObjectCalisthenics.Files.ClassTraitAndInterfaceLength,ObjectCalisthenics.Files.FunctionLength,ObjectCalisthenics.Metrics.MethodPerClassLimit,ObjectCalisthenics.Metrics.PropertyPerClassLimit

ECS：

 # ecs.yaml
services :
    ObjectCalisthenicsSniffsFilesClassTraitAndInterfaceLengthSniff : ~
    ObjectCalisthenicsSniffsFilesFunctionLengthSniff : ~
    ObjectCalisthenicsSniffsMetricsMethodPerClassLimitSniff : ~
    ObjectCalisthenicsSniffsMetricsPropertyPerClassLimitSniff : ~

？設定可能

php_codesniffer：

<? xml version = " 1.0 " ?>
< ruleset name = " my-project " >
    < rule ref = " ObjectCalisthenics.Files.ClassTraitAndInterfaceLength " >
        < properties >
            < property name = " maxLength " value = " 200 " />
        </ properties >
    </ rule >
    < rule ref = " ObjectCalisthenics.Files.FunctionLength " >
        < properties >
            < property name = " maxLength " value = " 20 " />
        </ properties >
    </ rule >
    < rule ref = " ObjectCalisthenics.Metrics.PropertyPerClassLimit " >
        < properties >
            < property name = " maxCount " value = " 10 " />
        </ properties >
    </ rule >
    < rule ref = " ObjectCalisthenics.Metrics.MethodPerClassLimit " >
        < properties >
            < property name = " maxCount " value = " 10 " />
        </ properties >
    </ rule >
</ ruleset >

ECS：

 # ecs.yaml
services :
    ObjectCalisthenicsSniffsFilesClassTraitAndInterfaceLengthSniff :
        maxLength : 200
    ObjectCalisthenicsSniffsFilesFunctionLengthSniff :
        maxLength : 20
    ObjectCalisthenicsSniffsMetricsPropertyPerClassLimitSniff :
        maxCount : 10
    ObjectCalisthenicsSniffsMetricsMethodPerClassLimitSniff :
        maxCount : 10

9。ゲッターとセッターを使用しないでください

このルールは、ドメイン駆動型の設計に部分的に関連しています。

クラスにはパブリックプロパティを含めるべきではありません。
メソッドは、設定値ではなく動作を表す必要があります。

 class ImmutableBankAccount
{
    public $ currency = ' USD ' ;

    private $ amount ;

    public function setAmount ( int $ amount )
    {
        $ this -> amount = $ amount ;
    }
}

？

 class ImmutableBankAccount
{
    private $ currency = ' USD ' ;

    private $ amount ;

    public function withdrawAmount ( int $ withdrawnAmount )
    {
        $ this -> amount -= $ withdrawnAmount ;
    }
}

このルールのみを使用しますか？

php_codesniffer：

vendor/bin/phpcs ... --sniffs=ObjectCalisthenics.Classes.ForbiddenPublicProperty,ObjectCalisthenics.NamingConventions.NoSetter

ECS：

 # ecs.yaml
services :
    ObjectCalisthenicsSniffsClassesForbiddenPublicPropertySniff : ~
    ObjectCalisthenicsSniffsNamingConventionsNoSetterSniff : ~

？設定可能

php_codesniffer：

<? xml version = " 1.0 " ?>
< ruleset name = " my-project " >
    < rule ref = " ObjectCalisthenics.NamingConventions.NoSetter " >
        < properties >
            < property name = " allowedClasses " type = " array " value = " *DataObject " />
        </ properties >
    </ rule >
</ ruleset >

ECS：

 # ecs.yaml
services :
    ObjectCalisthenicsSniffsNamingConventionsNoSetterSniff :
        allowedClasses : 
            - ' *DataObject '

実装されていないルール - 厳しすぎる、曖昧または迷惑

実際に使用している間、これらのルールは、よりクリーンでより実用的なコードの書き込みを支援するのではなく、あまりにも厳格すぎる、曖昧または迷惑でさえあることがわかりました。また、ドメイン駆動型のデザインと密接に関連しています。

3。プリミティブタイプと文字列- PHP 7以降、 define(strict_types=1)およびスカラータイプのヒントを使用できます。他の場合、たとえば電子メールでは、値オブジェクトを介してドメインでそれを扱うことができます。

4。ファーストクラスのコレクションを使用します- このルールは理にかなっていますが、実際には有用ではありません。私たちのコードでさえ、まったく渡されませんでした。

8. 3つ以上のインスタンス変数を持つクラスを使用しないでください。これは、各プロジェクトの個々のドメインに依存します。そのためのルールを作成することは意味がありません。

貢献するための3つのルール

PRごとに1つの機能
すべての新しい機能は、テストでカバーする必要があります
すべてのテストとスタイルチェックが合格する必要があります
```
composer complete-check
```

その場合、私たちはあなたの機能を融合させて喜んでいます。

拡大する

phpcs calisthenics rules

PHP_CODESNIFFERのオブジェクトの心臓病ルール

なぜあなたはあなたのプロジェクトでこれを使用する必要があるのですか？

インストール

使用法

1つのルールをすばやく確認する方法は？

実装されたルールスニフ

1.メソッドごとのインデントのXレベルのみ

このルールのみを使用しますか？

？設定可能

2。「else」キーワードを使用しないでください

このルールのみを使用しますか？

5。ステートメントごとに1つのオブジェクト演算子（ -> ）のみを使用します

このルールのみを使用しますか？

？設定可能

6.略さないでください

このルールのみを使用しますか？

？設定可能

7.クラスを小さく保ちます

このルールのみを使用しますか？

？設定可能

9。ゲッターとセッターを使用しないでください

このルールのみを使用しますか？

？設定可能

実装されていないルール - 厳しすぎる、曖昧または迷惑

貢献するための3つのルール

1.メソッドごとのインデントの`X`レベルのみ

5。ステートメントごとに1つのオブジェクト演算子（ `->` ）のみを使用します