EmailsAssert.java

package fr.sii.ogham.assertion.email;

import static fr.sii.ogham.assertion.AssertionHelper.assertThat;

import java.util.List;

import javax.mail.Message;

import org.hamcrest.Matcher;

import fr.sii.ogham.assertion.HasParent;

public class EmailsAssert<P> extends HasParent<P> {
	/**
	 * The list of messages that will be used for assertions
	 */
	private final List<? extends Message> actual;

	public EmailsAssert(List<? extends Message> actual, P parent) {
		super(parent);
		this.actual = actual;
	}

	/**
	 * Assertion on the number of received messages:
	 * 
	 * <pre>
	 * .count(is(1))
	 * </pre>
	 * 
	 * @param matcher
	 *            the assertion applied on the number of received messages
	 * @return the fluent API for chaining assertions on received messages
	 */
	public EmailsAssert<P> count(Matcher<Integer> matcher) {
		assertThat(actual.size(), matcher);
		return this;
	}

	/**
	 * Access a particular message to write assertions for it:
	 * 
	 * <pre>
	 * .message(0).subject(is("foobar"))
	 * </pre>
	 * 
	 * You can use this method to chain several assertions on different
	 * messages:
	 * 
	 * <pre>
	 * .message(0).subject(is("foobar"))
	 * .and()
	 * .message(1).subject(is("toto"))
	 * </pre>
	 * 
	 * 
	 * @param index
	 *            the index of the message in the received list
	 * @return the fluent API for chaining assertions on received messages
	 */
	public EmailAssert<EmailsAssert<P>> message(int index) {
		return new EmailAssert<>(actual.get(index), this);
	}

	/**
	 * Fluent API to write assertions on every received messages. Any defined
	 * assertion will be applied on every message:
	 * 
	 * <pre>
	 * .receivedMessages().forEach().subject(is("foobar"))
	 * </pre>
	 * 
	 * Will check that subject of every message is "foobar".
	 * 
	 * <p>
	 * You can use this method to factorize several assertions on a message and
	 * then make dedicated assertions on some messages:
	 * 
	 * <pre>
	 * .receivedMessages().forEach().subject(is("foobar"))
	 *                    .and()
	 *                    .message(0).body().contentAsString(is("toto"))
	 * </pre>
	 * 
	 * Will check that subject of every message is "foobar" and that body of
	 * first received message is "toto".
	 * 
	 * @return the fluent API for chaining assertions on received messages
	 */
	public EmailAssert<EmailsAssert<P>> forEach() {
		return new EmailAssert<>(actual, this);
	}

}