oop cop

Motivação . Não temos essa ferramenta que validará as práticas do projeto OOP, diz exatamente onde estamos fazendo errado.

OOPCOP é uma ferramenta de análise estática e um plug-in Maven que o ajudará a modelar seus objetos, classes e métodos corretamente rejeitando seu código não perfeito . Essas coisas que não toleramos:

• -Er nomes de classe, por exemplo, analisador, validador, controlador (por quê?)
• Aulas de utilidade (por quê?)
• Objetos mutáveis ​​(por quê?)
• Getters (por quê?)
• Objetos sem estado (por quê?)
• Nomes de classe longa

Como usar . Tudo que você precisa é esta (obtenha a versão mais recente aqui):

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 >

Se você deseja executar o plug -in diretamente:

$ mvn ru.l3r8y:oop-cop:search

MutablestateCheck

Essas classes são válidas:

 class Pet {
    private final String name ;

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

Esta aula é inválida:

 class Pet {
    private String name ;

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

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

No entanto, você pode suprimir essa verificação adicionando:

 @ SupressWarnings ( "OOP.MutableStateCheck" )

Ersuffixcheck

Esses exemplos são válidos:

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

Enquanto isso é inválido:

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

No entanto, você pode suprimir essa verificação adicionando:

 @ SupressWarnings ( "OOP.ErSuffixCheck" )

Classes de utilidade

TBD ..

Getters

TBD ..

Objetos sem estado

TBD ..

Nomes de classe longa

Este exemplo é válido:

 class PgItem {
    ...
}

Enquanto isso está quebrado:

 class AbstractDatabaseConnection {
    ...
}

Para configurar o comprimento razoável máximo, considere usar o seguinte parâmetro:

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

Como contribuir

Repositório de garfo, faça alterações, envie -nos uma solicitação de tração. Analisaremos suas alterações e as aplicaremos à filial master em breve, desde que não violem nossos padrões de qualidade. Para evitar a frustração, antes de nos enviar sua solicitação de tração, execute a compilação completa do Maven:

$ mvn clean install -Pqulice

Você precisará do Maven 3.8+ e Java 8+.