Skip to content

Commit

Permalink
Merge pull request hamcrest#66 from josephw/use-qdox-2
Browse files Browse the repository at this point in the history 
Use QDox 2 to generate sugar class from a single pass of parsing source
  • Loading branch information
@npryce
npryce committed Nov 1, 2014
2 parents 6b5489e + 0b377c4 commit 49fdbb6
Show file tree
Hide file tree
Showing 23 changed files with 505 additions and 592 deletions.
8 changes: 4 additions & 4 deletions build.xml
View file
Expand Up @@ -23,7 +23,7 @@
</target>

<target name="generator" depends="api" description="Build code generator tool">
<path id="cp-hamcrest-generator-main" path="lib/generator/qdox-1.12.jar;build/hamcrest-api-${version}.jar"/>
<path id="cp-hamcrest-generator-main" path="lib/generator/qdox-2.0-M2.jar;build/hamcrest-api-${version}.jar"/>
<path id="cp-hamcrest-generator-test" path=""/>
<compile-module modulename="hamcrest-generator"/>
<jar-module modulename="hamcrest-generator"/>
Expand All @@ -34,7 +34,7 @@
<copy file="build/hamcrest-generator-${version}.jar" tofile="build/hamcrest-generator-${version}-nodep.jar"/>
<jarjar jarfile="build/hamcrest-generator-${version}.jar">
<zipfileset src="build/hamcrest-generator-${version}-nodep.jar"/>
<zipfileset src="lib/generator/qdox-1.12.jar"/>
<zipfileset src="lib/generator/qdox-2.0-M2.jar"/>
<rule pattern="com.thoughtworks.qdox.**" result="org.hamcrest.generator.qdox.@1"/>
</jarjar>
</target>
Expand Down Expand Up @@ -231,10 +231,10 @@
</macrodef>

<macrodef name="test-module" description="run unit tests.">
<attribute name="modulename" description="Name of the module to jar"/>
<attribute name="modulename" description="Name of the module to test"/>
<sequential>
<mkdir dir="build/temp/@{modulename}/test-wrk"/>
<junit printsummary="no" forkmode="once" tempdir="build/temp/@{modulename}/test-wrk" haltonfailure="${haltonfailure}">
<junit printsummary="no" forkmode="once" tempdir="build/temp/@{modulename}/test-wrk" haltonfailure="${haltonfailure}" dir="@{modulename}">
<formatter type="brief" usefile="no"/>
<classpath refid="cp-@{modulename}-test-complete"/>
<classpath path="build/@{modulename}-${version}-tests.jar"/>
Expand Down
4 changes: 2 additions & 2 deletions hamcrest-generator/src/main/java/org/hamcrest/generator/FactoryMethod.java
View file
Expand Up @@ -46,7 +46,7 @@ public String getMatcherClass() {
public String getReturnType() {
return returnType;
}

/**
* Original name of factory method.
*/
Expand Down Expand Up @@ -115,7 +115,7 @@ public void setJavaDoc(String javaDoc) {
public String getJavaDoc() {
return javaDoc;
}

// Generated in Eclipse...
// n.b. Doesn't include returnType
@Override
Expand Down
8 changes: 4 additions & 4 deletions hamcrest-generator/src/main/java/org/hamcrest/generator/QDox.java
View file
@@ -1,11 +1,11 @@
package org.hamcrest.generator;

import com.thoughtworks.qdox.JavaDocBuilder;
import com.thoughtworks.qdox.model.JavaClass;

import java.io.File;
import java.io.Reader;

import com.thoughtworks.qdox.JavaProjectBuilder;
import com.thoughtworks.qdox.model.JavaClass;

/**
* Wraps QDox library. This is because to ease distribution, QDox is bundled into
* hamcrest-generator.jar and has its package renamed to ensure there is no conflict
Expand All @@ -16,7 +16,7 @@
*/
public class QDox {

private final JavaDocBuilder javaDocBuilder = new JavaDocBuilder();
private final JavaProjectBuilder javaDocBuilder = new JavaProjectBuilder();

public void addSourceTree(File sourceDir) {
javaDocBuilder.addSourceTree(sourceDir);
Expand Down
139 changes: 82 additions & 57 deletions hamcrest-generator/src/main/java/org/hamcrest/generator/QDoxFactoryReader.java
View file
@@ -1,14 +1,20 @@
package org.hamcrest.generator;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
import java.util.Iterator;
import java.util.List;
import java.util.regex.Pattern;

import com.thoughtworks.qdox.model.DocletTag;
import com.thoughtworks.qdox.model.JavaAnnotation;
import com.thoughtworks.qdox.model.JavaClass;
import com.thoughtworks.qdox.model.JavaMethod;
import com.thoughtworks.qdox.model.JavaParameter;
import com.thoughtworks.qdox.model.Type;

import java.util.Iterator;
import java.util.List;
import java.util.regex.Pattern;
import com.thoughtworks.qdox.model.JavaType;
import com.thoughtworks.qdox.model.JavaTypeVariable;

/**
* Wraps an existing sequence of FactoryMethods, and attempts to pull in
Expand All @@ -20,86 +26,105 @@
*/
public class QDoxFactoryReader implements Iterable<FactoryMethod> {

private final Iterable<FactoryMethod> wrapped;
private final JavaClass classSource;

private static final Pattern GENERIC_REGEX = Pattern.compile("<.*>");
private static final Pattern VARARGS_REGEX = Pattern.compile("...", Pattern.LITERAL);
private JavaClass factoryAnnotation;

private static final Pattern GENERIC_REGEX = Pattern.compile("^<(.*)>$");

public QDoxFactoryReader(Iterable<FactoryMethod> wrapped, QDox qdox, String className) {
this.wrapped = wrapped;
public QDoxFactoryReader(QDox qdox, String className) {
this.classSource = qdox.getClassByName(className);
this.factoryAnnotation = qdox.getClassByName("org.hamcrest.Factory");
}

@Override
public Iterator<FactoryMethod> iterator() {
final Iterator<FactoryMethod> iterator = wrapped.iterator();
return new Iterator<FactoryMethod>() {
@Override
public boolean hasNext() {
return iterator.hasNext();
}
List<FactoryMethod> methods = new ArrayList<FactoryMethod>();

@Override
public FactoryMethod next() {
return enhance(iterator.next());
for (JavaMethod jm : classSource.getMethods()) {
if (!isFactoryMethod(jm)) {
continue;
}

@Override
public void remove() {
iterator.remove();
FactoryMethod fm = new FactoryMethod(typeToString(classSource), jm.getName(), typeToString(jm.getReturnType()));

for (JavaTypeVariable<?> tv : jm.getTypeParameters()) {
String decl = tv.getGenericFullyQualifiedName();
decl = GENERIC_REGEX.matcher(decl).replaceFirst("$1");
fm.addGenericTypeParameter(decl);
}
};
}

private FactoryMethod enhance(FactoryMethod factoryMethod) {
JavaMethod methodSource = findMethodInSource(factoryMethod);
if (methodSource != null) {
factoryMethod.setJavaDoc(createJavaDocComment(methodSource));
JavaParameter[] parametersFromSource
= methodSource.getParameters();
List<FactoryMethod.Parameter> parametersFromReflection
= factoryMethod.getParameters();

if (parametersFromReflection.size() == parametersFromSource.length) {
for (int i = 0; i < parametersFromSource.length; i++) {
parametersFromReflection.get(i).setName(
parametersFromSource[i].getName());
for (JavaParameter p : jm.getParameters()) {
String type = typeToString(p.getType());

// Special case for var args methods.... String[] -> String...
if (p.isVarArgs()) {
type += "...";
}

fm.addParameter(type, p.getName());
}

for (JavaType exception : jm.getExceptions()) {
fm.addException(typeToString(exception));
}

fm.setJavaDoc(createJavaDocComment(jm));

String generifiedType = GENERIC_REGEX.matcher(fm.getReturnType()).replaceFirst("$1");
if (!generifiedType.equals(fm.getReturnType())) {
fm.setGenerifiedType(generifiedType);
}

methods.add(fm);
}
return factoryMethod;

Collections.sort(methods, new Comparator<FactoryMethod>() {
@Override public int compare(FactoryMethod o1, FactoryMethod o2) {
return o1.getName().compareTo(o2.getName());
}
});

return methods.iterator();
}

/**
* Attempts to locate the source code for a specific method, by cross-referencing
* the signature returned by reflection with the list of methods parsed by QDox.
* Determine whether a particular method is classified as a matcher factory method.
* <p/>
* <p>The rules for determining this are:
* 1. The method must be public static.
* 2. It must have a return type of org.hamcrest.Matcher (or something that extends this).
* 3. It must be marked with the org.hamcrest.Factory annotation.
* <p/>
* <p>To use another set of rules, override this method.
*/
private JavaMethod findMethodInSource(FactoryMethod factoryMethod) {
// Note, this doesn't always work - it struggles with some kinds of generics.
// This seems to cover most cases though.
List<FactoryMethod.Parameter> params = factoryMethod.getParameters();
Type[] types = new Type[params.size()];
boolean varArgs = false;
for (int i = 0; i < types.length; i++) {
String type = params.get(i).getType();
varArgs = VARARGS_REGEX.matcher(type).find();
// QDox ignores varargs and generics, so we strip them out to help QDox.
type = GENERIC_REGEX.matcher(type).replaceAll("");
type = VARARGS_REGEX.matcher(type).replaceAll("");
types[i] = new Type(type);
protected boolean isFactoryMethod(JavaMethod javaMethod) {
return javaMethod.isStatic()
&& javaMethod.isPublic()
&& hasFactoryAnnotation(javaMethod)
&& !javaMethod.getReturnType().equals(JavaType.VOID);
}

private boolean hasFactoryAnnotation(JavaMethod javaMethod) {
for (JavaAnnotation a : javaMethod.getAnnotations()) {
if (a.getType().equals(factoryAnnotation)) {
return true;
}
}
JavaMethod[] methods = classSource.getMethodsBySignature(factoryMethod.getName(), types, false, varArgs);
return methods.length == 1 ? methods[0] : null;
return false;
}

private static String typeToString(JavaType type) {
return type.getGenericFullyQualifiedName().replace('$', '.');
}

/**
* Reconstructs the JavaDoc as a string for a particular method.
*/
private static String createJavaDocComment(JavaMethod methodSource) {
String comment = methodSource.getComment();
DocletTag[] tags = methodSource.getTags();
if ((comment == null || comment.trim().length() == 0) && tags.length == 0) {
List<DocletTag> tags = methodSource.getTags();
if ((comment == null || comment.trim().length() == 0) && tags.isEmpty()) {
return null;
}
StringBuilder result = new StringBuilder();
Expand Down

0 comments on commit 49fdbb6

Please sign in to comment.