oop cop

Motivación . No tenemos esa herramienta que valida nuestras prácticas de OOP de proyecto, le dice exactamente dónde estamos haciendo mal.

OOPCOP es una herramienta de análisis estático y un complemento Maven que lo ayudará a modelar sus objetos, clases y métodos correctamente al rechazar su código no perfecto . Estas cosas no toleramos:

• -Er nombres de clase, por ejemplo, analizador, validador, controlador (¿por qué?)
• Clases de utilidad (¿por qué?)
• Objetos mutables (¿por qué?)
• Getters (¿por qué?)
• Objetos sin estado (¿por qué?)
• Nombres de clase largas

Cómo usar . Todo lo que necesitas es esta (obtenga la última versión aquí):

Maven:

< build >
  < plugins >
    < plugin >
      < groupId >ru.l3r8y</ groupId >
      < artifactId >oop-cop</ artifactId >
      < version >0.2.8</ version >
      < executions >
        < execution >
          < goals >
            < goal >search</ goal >
          </ goals >
        </ execution >
      </ executions >
    </ plugin >
  </ plugins >
</ build >

Si desea ejecutar el complemento directamente:

$ mvn ru.l3r8y:oop-cop:search

MutablestateCheck

Estas clases son válidas:

 class Pet {
    private final String name ;

    public Pet ( final String n ) {
        this . name = n ;
    }
}

Esta clase no es válida:

 class Pet {
    private String name ;

    public Pet ( final String n ) {
        this . name = n ;
    }

    public void setName ( final String name ) {
        this . name = name ;
    }
}

Sin embargo, puede suprimir esta verificación agregando:

 @ SupressWarnings ( "OOP.MutableStateCheck" )

Ersuffixcheck

Estos ejemplos son válidos:

 class ParsedFile {
  ...
  public String asText () {
      ...
  }   
}

Si bien esto no es válido:

 class FileParser {
    ...
    public String parse () {
        ...
    }
}

Sin embargo, puede suprimir esta verificación agregando:

 @ SupressWarnings ( "OOP.ErSuffixCheck" )

Clases de servicios públicos

TBD ..

Getters

TBD ..

Objetos sin estado

TBD ..

Nombres de clase largas

Este ejemplo es válido:

 class PgItem {
    ...
}

Mientras esto está roto:

 class AbstractDatabaseConnection {
    ...
}

Para configurar la longitud razonable máxima, considere usar el siguiente parámetro:

< plugin >
  < groupId >ru.l3r8y</ groupId >
  < artifactId >oop-cop</ artifactId >
  ...
  < configuration >
    < maxClassNameLen >15</ maxClassNameLen >
    <!-- default is 13 -->
  </ configuration >
</ plugin >

Cómo contribuir

Repositorio de horquilla, haga cambios, envíenos una solicitud de extracción. Revisaremos sus cambios y los aplicaremos a la rama master en breve, siempre que no violen nuestros estándares de calidad. Para evitar la frustración, antes de enviarnos su solicitud de extracción, ejecute la compilación de Maven completa:

$ mvn clean install -Pqulice

Necesitará Maven 3.8+ y Java 8+.