oop cop

Motivasi . Kami tidak memiliki alat seperti itu yang akan memvalidasi praktik OOP proyek kami, memberi tahu dengan tepat di mana kami melakukan kesalahan.

OOPCOP adalah alat analisis statis dan plugin Maven yang akan membantu Anda memodelkan objek, kelas, metode Anda dengan benar dengan menolak kode non-sempurna Anda. Hal -hal ini yang tidak kami toleransi:

• -Er nama kelas misalnya parser, validator, controller (mengapa?)
• Kelas utilitas (mengapa?)
• Objek yang bisa berubah (mengapa?)
• Getters (mengapa?)
• Objek tanpa keadaan (mengapa?)
• Nama Kelas Panjang

Cara menggunakan . Yang Anda butuhkan adalah ini (dapatkan versi terbaru di sini):

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 >

Jika Anda ingin menjalankan plugin secara langsung:

$ mvn ru.l3r8y:oop-cop:search

MutablestateCheck

Kelas -kelas ini valid:

 class Pet {
    private final String name ;

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

Kelas ini tidak valid:

 class Pet {
    private String name ;

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

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

Namun, Anda dapat menekan cek ini dengan menambahkan:

 @ SupressWarnings ( "OOP.MutableStateCheck" )

Ersuffixcheck

Contoh -contoh ini valid:

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

Sementara ini tidak valid:

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

Namun, Anda dapat menekan cek ini dengan menambahkan:

 @ SupressWarnings ( "OOP.ErSuffixCheck" )

Kelas utilitas

TBD ..

Getters

TBD ..

Objek tanpa negara

TBD ..

Nama Kelas Panjang

Contoh ini valid:

 class PgItem {
    ...
}

Saat ini rusak:

 class AbstractDatabaseConnection {
    ...
}

Untuk mengonfigurasi panjang yang masuk akal maksimal, pertimbangkan untuk menggunakan parameter berikut:

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

Bagaimana berkontribusi

Fork Repository, buat perubahan, kirimkan permintaan tarik kepada kami. Kami akan meninjau perubahan Anda dan menerapkannya ke cabang master segera, asalkan mereka tidak melanggar standar kualitas kami. Untuk menghindari frustrasi, sebelum mengirimi kami permintaan tarikan Anda, silakan jalankan Maven Build penuh:

$ mvn clean install -Pqulice

Anda akan membutuhkan Maven 3.8+ dan Java 8+.