Descarga phpcs calisthenics rules - Descarga del código fuente de phpcs calisthenics rules

Reglas de calistenia de objetos para php_codesniffer

Deprecido: PHP_CODESNIFFER es ideal para manejar espacios y posiciones de carbón. Sin embargo, estas reglas son sobre la arquitectura y la estructura del código. En 2020, hay una herramienta que se adapta perfectamente a Phpstan .

Dicho eso, la calistenia de objetos se implementaron como reglas de Phpstan en un paquete symplify/phpstan-rules . Usarlo en su lugar?

 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

La calistenia de objetos se establece de reglas en el código orientado a objetos, que se centran en la mantenibilidad, la legibilidad, la prueba y la comprensibilidad . Primero somos pragmáticos : son fáciles de usar todos juntos o uno por uno.

¿Por qué debería usar esto en su proyecto?

Lea la publicación de William Durand o verifique la presentación de Guilherme Blanco .

Instalar

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

Uso

Si sabe lo que quiere, salta a la regla específica:

1. Solo x nivel de sangría por método
2. No use la palabra clave "más"
5. Use solo un operador de objeto (->) por declaración
6. No abreviar
7. Mantenga sus clases pequeñas
9. No use Getters y Setters

¿Cómo verificar rápidamente la regla 1?

En php_codesniffer

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

En EasyCoding Standard

 # ecs.yaml
services :
    ObjectCalisthenicsSniffsClassesForbiddenPublicPropertySniff : ~

entonces

vendor/bin/ecs check src

Sniffs de reglas implementadas

1. Solo `X` nivel de sangría por método

 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 )
{
    // ...
}

¿Usar solo esta regla?

En php_codesniffer:

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

En ECS:

 # ecs.yaml
services :
    ObjectCalisthenicsSniffsMetricsMaxNestingLevelSniff : ~

? Configurable

En php_codesniffer:

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

En ECS:

 services :
    ObjectCalisthenicsSniffsMetricsMaxNestingLevelSniff :
        maxNestingLevel : 2

2. No use la palabra clave "más"

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

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

$ this -> advance ();

¿Usar solo esta regla?

En php_codesniffer:

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

En ECS:

 # ecs.yaml
services :
    ObjectCalisthenicsSniffsControlStructuresNoElseSniff : ~

5. Use solo un operador de objeto ( `->` ) por declaración

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

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

¿Usar solo esta regla?

En php_codesniffer:

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

En ECS:

 # ecs.yaml
services :
    ObjectCalisthenicsSniffsCodeAnalysisOneObjectOperatorPerLineSniff : ~

? Configurable

En 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 >

En ECS:

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

6. No abreviar

Esto está relacionado con la clase, el rasgo, la interfaz, la constante, la función y los nombres de variables.

 class EM
{
    // ...
}

 class EntityMailer
{
    // ...
}

¿Usar solo esta regla?

En php_codesniffer:

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

En ECS:

 # ecs.yaml
services :
    ObjectCalisthenicsSniffsNamingConventionsElementNameMinimalLengthSniff : ~

? Configurable

En 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 >

En ECS:

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

7. Mantenga sus clases pequeñas

 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
}

¿Usar solo esta regla?

En php_codesniffer:

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

En ECS:

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

? Configurable

En 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 >

En ECS:

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

9. No use Getters y Setters

Estas reglas están parcialmente relacionadas con el diseño impulsado por el dominio.

Las clases no deben contener propiedades públicas.
El método debe representar el comportamiento, no los valores establecidos.

 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 ;
    }
}

¿Usar solo esta regla?

En php_codesniffer:

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

En ECS:

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

? Configurable

En 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 >

En ECS:

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

Reglas no implementadas: demasiado estricto, vago o molesto

Mientras usamos en la práctica, encontramos que estas reglas son demasiado estrictas, vagas o incluso molestas, en lugar de ayudar a escribir código más limpio y más pragmático. También están estrechamente relacionados con el diseño impulsado por el dominio.

3. Envuelva tipos y cadenas primitivas : ya que Php 7, puede usar sugerencias define(strict_types=1) y de tipo escalar. Para otros casos, por ejemplo, correo electrónico, puede lidiar con eso en su dominio a través de objetos de valor.

4. Use colecciones de primera clase : esta regla tiene sentido, pero es demasiado estricto para ser útil en la práctica. Incluso nuestro código no lo pasó en absoluto.

8. No use clases con más de dos variables de instancia : esto depende del dominio individual de cada proyecto. No tiene sentido hacer una regla para eso.

3 reglas para contribuir

1 característica por relaciones públicas
Cada nueva característica debe estar cubierta por pruebas
Todas las pruebas y controles de estilo deben pasar
```
composer complete-check
```

Estaremos encantados de fusionar su función entonces.

Expandir