oop cop

Motivation . Wir haben kein solches Tool, das unser Projekt oop -Praktiken validiert und genau sagt, wo wir falsch machen.

OOPCOP ist ein statisches Analysetool und ein Maven-Plugin, mit dem Sie Ihre Objekte, Klassen und Methoden ordnungsgemäß modellieren, indem Sie Ihren nicht perfekten Code ablehnen. Diese Dinge tolerieren wir nicht:

• -Er Klasse Namen zB Parser, Validator, Controller (warum?)
• Versorgungsklassen (warum?)
• Veränderliche Objekte (warum?)
• Getters (warum?)
• Objekte ohne Zustand (warum?)
• Lange Klassennamen

Wie man benutzt . Alles, was Sie brauchen, ist dies (erhalten Sie hier die neueste Version):

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 >

Wenn Sie Plugin direkt ausführen möchten:

$ mvn ru.l3r8y:oop-cop:search

Mutablestatecheck

Diese Klassen sind gültig:

 class Pet {
    private final String name ;

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

Diese Klasse ist ungültig:

 class Pet {
    private String name ;

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

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

Sie können diese Überprüfung jedoch unterdrücken, indem Sie hinzufügen:

 @ SupressWarnings ( "OOP.MutableStateCheck" )

Ersuffixcheck

Diese Beispiele sind gültig:

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

Während dies ungültig ist:

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

Sie können diese Überprüfung jedoch unterdrücken, indem Sie hinzufügen:

 @ SupressWarnings ( "OOP.ErSuffixCheck" )

Versorgungsklassen

TBD ..

Getters

TBD ..

Objekte ohne Zustand

TBD ..

Lange Klassennamen

Dieses Beispiel ist gültig:

 class PgItem {
    ...
}

Während das gebrochen ist:

 class AbstractDatabaseConnection {
    ...
}

So konfigurieren Sie die maximale angemessene Länge mit dem folgenden Parameter:

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

Wie man beiträgt

Fork -Repository, Änderungen vornehmen, uns eine Pull -Anfrage senden. Wir werden Ihre Änderungen überprüfen und sie in Kürze auf den master -Zweig anwenden, sofern sie nicht gegen unsere Qualitätsstandards verstoßen. Um Frustration zu vermeiden, führen Sie vor dem Senden Ihrer Pull -Anfrage bitte den vollständigen Maven -Build aus:

$ mvn clean install -Pqulice

Sie benötigen Maven 3.8+ und Java 8+.