com.crawljax.plugins.crawloverview.BeanToReadableMap Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of crawloverview-plugin Show documentation
Generates an HTML report with a snapshot overview of what is crawled.
There is a newer version: 5.2.3
package com.crawljax.plugins.crawloverview;

import static org.apache.commons.lang.StringEscapeUtils.escapeHtml;

import java.lang.reflect.Method;
import java.util.Collection;
import java.util.Map.Entry;

import org.apache.commons.lang3.tuple.ImmutablePair;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.crawljax.browser.WebDriverBrowserBuilder;
import com.crawljax.core.configuration.BrowserConfiguration;
import com.crawljax.core.configuration.CrawlRules;
import com.crawljax.core.plugin.Plugin;
import com.crawljax.core.plugin.Plugins;
import com.crawljax.plugins.crawloverview.model.Serializer;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableMap.Builder;

/**
 * Parses a Java bean to a map containing the getter name as the key and the field value as the
 * value. All instances of {@link Collection} are converted to html lists.
 * 
 * The getter name is parsed from Camel case to a readable format. Both keys and values are HTML
 * escaped for safety.
 * 
 */
class BeanToReadableMap {

	private static final String CAMEL_REGEX = String.format("%s|%s|%s",
	        "(?<=[A-Z])(?=[A-Z][a-z])", "(?<=[^A-Z])(?=[A-Z])", "(?<=[A-Za-z])(?=[^A-Za-z])");

	private static final Logger LOG = LoggerFactory.getLogger(BeanToReadableMap.class);

	public static ImmutableMap toMap(Object o) {
		Builder builder = ImmutableMap.builder();
		for (Method method : o.getClass().getMethods()) {
			if (isGetter(method)) {
				builder.put(addMethodToMap(o, method));
			}
		}
		return builder.build();
	}

	private static boolean isGetter(Method method) {
		return method.getName().startsWith("get") && method.getParameterTypes().length == 0
		        && !"getClass".equals(method.getName());
	}

	private static Entry addMethodToMap(Object o, Method method) {
		try {
			Object[] noArgs = null;
			Object result = method.invoke(o, noArgs);
			return ImmutablePair.of(asName(method), toString(result));

		} catch (Exception e) {
			LOG.error("Could not parse bean {} because {}", o, e.getMessage(), e);
			return ImmutablePair.of(asName(method), "Unreadable entry");
		}
	}

	private static String toString(Object result) {
		if (result == null) {
			return "null";
		} else if (result instanceof Collection) {
			return asHtmlList((Collection) result);
		} else if (result instanceof Plugin) {
			return escapeHtml(result.getClass().getSimpleName());
		} else if (result instanceof CrawlRules) {
			return "" + escapeHtml(Serializer.toPrettyJson(result)) + "";
		} else if (result instanceof BrowserConfiguration) {
			BrowserConfiguration config = (BrowserConfiguration) result;
			StringBuilder configAsString =
			        new StringBuilder().append(config.getNumberOfBrowsers())
			                .append(" browsers of type ")
			                .append(config.getBrowsertype());
			if (!(config.getBrowserBuilder() instanceof WebDriverBrowserBuilder)) {
				configAsString.append(" using builder ").append(config.getBrowserBuilder());
			}
			return configAsString.toString();
		} else if (result instanceof Plugins) {
			return toString(((Plugins) result).pluginNames());
		} else if (result instanceof Number && ((Number) result).intValue() == 0) {
			return "∞";
		} else {
			return escapeHtml(result.toString());
		}
	}

	private static String asName(Method method) {
		final int getPrefix = "get".length();
		String name = method.getName().substring(getPrefix);
		return splitCamelCase(name);
	}

	private static String asHtmlList(Collection result) {
		if (result.isEmpty()) {
			return "";
		}
		StringBuilder sb = new StringBuilder("");
		for (Object object : result) {
			sb.append("").append(toString(object)).append("");
		}
		return sb.append("").toString();
	}

	private static String splitCamelCase(String s) {
		return s.replaceAll(CAMEL_REGEX, " ");
	}

	private BeanToReadableMap() {

	}
}