https://github.com/nicojs/boilerplate-verifiers

Java is a language filled with boilderplate code constructs. ToString implementations, Builders, Getters and Setters. This repo contains verifiers for this boilerplate code. Inspired by EqualsVerifier (https://github.com/jqno/equalsverifier)
https://github.com/nicojs/boilerplate-verifiers

Last synced: 29 days ago
JSON representation

Java is a language filled with boilderplate code constructs. ToString implementations, Builders, Getters and Setters. This repo contains verifiers for this boilerplate code. Inspired by EqualsVerifier (https://github.com/jqno/equalsverifier)

• Host: GitHub
• URL: https://github.com/nicojs/boilerplate-verifiers
• Owner: nicojs
• Created: 2015-08-15T14:49:01.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2015-10-13T05:15:34.000Z (about 9 years ago)
• Last Synced: 2024-04-14T06:39:03.115Z (7 months ago)
• Language: Java
• Size: 449 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/nicojs/boilerplate-verifiers.svg)](https://travis-ci.org/nicojs/boilerplate-verifiers)

Boilerplate verifiers for Java

==============================

*Unit test your boilerplate without more boilerplate*

**Boilerplate verifiers** can be used in Java unit tests to verify whether 

the **builder**, **toString**, **getters/setters** are correctly implemented.

Inspired by the awesome [**EqualsVerifier**](https://github.com/jqno/equalsverifier).

This is also the reason why equals and hashcode verifiers are notably absent.

Work in progress:

----------------

1. Implement BuilderVerifier

  1. ~~Support for POJOS~~

  2. ~~Support for inheritance in the classes to build~~

  3. ~~Verify that all attributes are being build.~~

  4. ~~Support for inheritance in the builder classes themselves~~

  5. ~~Verify that no attribute can be set after build.~~

  6. ~~Verify the builder constructor is not accessible from the outside.~~

  7. ~~Support for more scenarios using settings~~

    1. ~~Support for attribute blacklist~~

    2. ~~Support for builder class method blacklist~~

    3. ~~Force don't use getter's to verify attribute values~~

    4. ~~Support for custom value factories~~

    5. ~~Support for not buildable Super classes~~

    6. ~~Support for prefixed methods on builder class (i.e. "withAge()", "withName()", etc)~~

    7. ~~Support for ignoring verification of attribute accessibility.~~

2. Implement ToStringVerifier

  1. ~~Support for POJOS~~

  2. ~~Support for graphs (deep toString)~~

  3. ~~Support for loops in graphs~~

  4. ~~Support for inheritance (also uses toString of super class)~~

  5. Support for more scenarios using settings

    1. Configure the key-value template

    2. ~~Configure graph blacklist using the path.~~

    3. Configure inheritance behavior.

    4. Configure shallow toString behavior.

3. Implement GetterSetterVerifier

Builder

------

```java

    // Book.java

    public class Book {

    

        private final Person author;

        private final String title;

    

        Book(Person author, String title) {

            this.author = author;

            this.title = title;

        }

    

        public static BookBuilder builder() {

            return new BookBuilder();

        }

    

        public static class BookBuilder {

            // ...  boilerplate ...

        }

    }

    

    // BookTest.java

     @Test

    public void verifyBuilder() {

        BuilderVerifier.forClass(Book.class).verify();

    }

```

Highly configurable:

```java

    public void verifyBuilderWithAllPossibleSettings() {

        BuilderVerifier.forClass(Book.class)

                    .allAttributesShouldBeBuildExcept("author")

                    .allMethodsOnBuilderClassShouldBeUsedExcept("copyTo")

                    .usingBuilderMethod("buildBook")

                    .withoutBuildingSuperClasses()

                    .withoutUsingGettersForVerification()

                    .withoutVerifyingAttributeAccessibility()

                    .withPrefixForAllMethodsOnBuilder("with")

                    .withValueFactories(new MyCustomValueFactory())

                    .verify();

    }

```