com.jparams.test.tostring.ToStringTester Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of to-string-tester Show documentation
To String Tester
There is a newer version: 1.1.2
package com.jparams.test.tostring;

import java.util.HashMap;
import java.util.List;
import java.util.Map;

import com.jparams.object.builder.Build;
import com.jparams.object.builder.Configuration;
import com.jparams.object.builder.ObjectBuilder;
import com.jparams.test.tostring.subject.Subject;
import com.jparams.test.tostring.subject.SubjectFactory;
import com.jparams.test.tostring.template.Template;
import com.jparams.test.tostring.template.directory.TemplateDirectory;

public final class ToStringTester
{
    private final Subject subject;
    private final Map> properties;
    private Template template;

    private ToStringTester(final Object instance)
    {
        this.subject = SubjectFactory.createSubject(instance);
        this.properties = new HashMap<>();
    }

    /**
     * Specify a template for the toString(). A number of pre-made templates are available out of the box, see {@link
     * com.jparams.test.tostring.template.Templates}. You can also create your own custom template using {@link
     * com.jparams.test.tostring.template.TemplateBuilder}.
     *
     * If a template is not explicitly provided, an attempt will be made to discover the template using the {@link TemplateDirectory}
     *
     * @param template
     * @return this
     */
    public ToStringTester usingTemplate(final Template template)
    {
        this.template = template;
        return this;
    }

    /**
     * Contains the given field. This method can be called multiple times.
     *
     * @param fieldName
     * @return this
     */
    public ToStringTester containsField(final String fieldName)
    {
        if (!subject.getProperties().containsKey(fieldName))
        {
            throw new IllegalArgumentException("No field with name [" + fieldName + "] found on test subject");
        }

        properties.put(fieldName, subject.getProperties().get(fieldName));
        return this;
    }

    /**
     * Contains all subject defined on the class.
     *
     * @return
     */
    public ToStringTester containsAllFields()
    {
        properties.clear();
        properties.putAll(subject.getProperties());
        return this;
    }

    /**
     * Verify to string
     *
     * @throws VerificationError error is thrown if verification fails with reason for failure
     */
    public void verify() throws VerificationError
    {
        final Template templateToUse = template == null ? TemplateDirectory.findTemplate(subject.getInstance().toString()) : template;
        templateToUse.verify(new Subject(subject.getType(), properties, subject.getInstance()));
    }

    /**
     * Create a to string test for a given type. An instance of this object will be created automatically.
     *
     * @param clazz
     * @return tester
     */
    public static ToStringTester forClass(final Class clazz)
    {
        final Configuration configuration = new Configuration().withDefaultProviders().withFailOnError(true);
        final Build build = ObjectBuilder.withConfiguration(configuration).buildInstanceOf(clazz);
        return forInstance(build.get());
    }

    /**
     * Create a to string test for a given instance.
     *
     * @param instance
     * @return tester
     */
    public static ToStringTester forInstance(final Object instance)
    {
        return new ToStringTester(instance);
    }
}