org.mabb.gfxassert.graphics.GraphicsMatcher Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of GfxAssert Show documentation

GfxAssert is a library for image and geometric asserts in test code and provides hamcrest matchers for doing so.

The newest version!

/*
 * Copyright (C) Matthew Abboud 2016
 *
 * GfxAssert is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * GfxAssert is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with GfxAssert. If not, see .
 */

package org.mabb.gfxassert.graphics;

import org.hamcrest.Description;
import org.mabb.gfxassert.MultiTypeSafeMatcher;
import org.mabb.gfxassert.geom.ShapeSubset;

import java.awt.Color;
import java.awt.image.BufferedImage;
import java.util.List;

import static org.mabb.gfxassert.geom.ShapeSubset.all;

public abstract class GraphicsMatcher extends MultiTypeSafeMatcher {
    protected ShapeSubset searchArea;
    protected GfxAssertImage graphics;

    protected boolean exclude = false;

    protected GraphicsMatcher() {
        searchArea = all();
    }

    public GraphicsMatcher in(ShapeSubset searchBox) {
        this.searchArea = searchBox;
        return this;
    }

    public GraphicsMatcher notIn(ShapeSubset searchBox) {
        exclude = true;
        return in(searchBox);
    }

    protected void describeItemMismatch(Object item, Description description) {
        List colors = graphics.findAllColors(searchArea);

        description.appendText("colors in image search area were, ").appendValue(formatColors(colors));
    }

    protected BufferedImage convertToMainType(Object item) {
        throw new RuntimeException("Could not convert type");
    }

    protected Class[] expectedTypes() {
        return new Class[0];
    }

    protected String formatColor(Color color) {
        String alpha = "";
        if (color.getAlpha() != 255)
            alpha = ",a=" + color.getAlpha();

        return String.format("[r=%d,g=%d,b=%d%s]", color.getRed(), color.getGreen(), color.getBlue(), alpha);

    }

    protected String formatColors(List colors) {
        String formatedColors = "";
        boolean first = true;

        for (Color colorOn : colors) {
            if (!first)
                formatedColors += ", ";
            formatedColors += formatColor(colorOn);

            first = false;
        }

        return formatedColors;
    }
}