DocumentAssertion.java

/*
 * Carrot2 project.
 *
 * Copyright (C) 2002-2016, Dawid Weiss, Stanisław Osiński.
 * All rights reserved.
 *
 * Refer to the full license file "carrot2.LICENSE"
 * in the root folder of the repository checkout or at:
 * http://www.carrot2.org/carrot2.LICENSE
 */

package org.carrot2.core.test.assertions;

import static org.fest.assertions.Assertions.assertThat;

import java.util.Map;

import org.carrot2.core.Document;
import org.fest.assertions.GenericAssert;

/**
 * Assertions on {@link Document}s.
 */
public class DocumentAssertion extends GenericAssert<DocumentAssertion, Document>
{
    DocumentAssertion(Document actualDocument)
    {
        super(DocumentAssertion.class, actualDocument);
    }

    /**
     * Asserts that the document is equivalent to the provided document. Two documents are
     * equivalent if their {@link Document#getStringId()} and {@link Document#getFields()} are
     * equal.
     * 
     * @param expectedDocument the expected document
     * @return this assertion for convenience
     */
    public DocumentAssertion isEquivalentTo(Document expectedDocument)
    {
        assertThat((Object) actual.getStringId()).as(description() + ", id").isEqualTo(
            expectedDocument.getStringId());
        assertThat(actual.getFields()).as(description()).isEqualTo(
            expectedDocument.getFields());
        return this;
    }

    public void stringFieldsDoNotMatchPattern(String pattern)
    {
        final Map<String, Object> fields = actual.getFields();
        for (Map.Entry<String, Object> entry : fields.entrySet())
        {
            final Object field = entry.getValue();
            if (field instanceof String)
            {
                assertThat((String) field).as(
                    description() + "[field: " + entry.getKey() + "]").doesNotMatch(
                    pattern);
            }
        }
    }
}