From 9401ab4a619d3561e3b64c7d3613c69930dbeb58 Mon Sep 17 00:00:00 2001 From: maximesinclair Date: Sat, 15 Feb 2014 19:04:30 +0100 Subject: [PATCH] [FEATURE] Checkstyle violations fail the Build --- pom.xml | 21 +++++++++++++++++++ src/main/config/checkstyle.xml | 3 ++- .../plantuml/servlet/DiagramResponse.java | 6 +++--- .../plantuml/servlet/OldProxyServlet.java | 4 ++-- .../plantuml/servlet/PlantUmlServlet.java | 12 +++++------ .../servlet/utility/UmlExtractor.java | 5 +++++ .../plantuml/servlet/ServerUtils.java | 2 +- .../plantuml/servlet/TestUtils.java | 4 ++++ 8 files changed, 44 insertions(+), 13 deletions(-) diff --git a/pom.xml b/pom.xml index 14d05a8..e8c388a 100644 --- a/pom.xml +++ b/pom.xml @@ -65,6 +65,27 @@ maven-site-plugin 3.0-beta-3 + + org.apache.maven.plugins + maven-checkstyle-plugin + 2.11 + + + validate + validate + + ${basedir}/src/main/config/checkstyle.xml + UTF-8 + true + true + false + + + check + + + + diff --git a/src/main/config/checkstyle.xml b/src/main/config/checkstyle.xml index 6161e07..99f9b61 100644 --- a/src/main/config/checkstyle.xml +++ b/src/main/config/checkstyle.xml @@ -9,7 +9,8 @@ Description: none --> - + + diff --git a/src/main/java/net/sourceforge/plantuml/servlet/DiagramResponse.java b/src/main/java/net/sourceforge/plantuml/servlet/DiagramResponse.java index 51de6e2..c69785b 100644 --- a/src/main/java/net/sourceforge/plantuml/servlet/DiagramResponse.java +++ b/src/main/java/net/sourceforge/plantuml/servlet/DiagramResponse.java @@ -44,13 +44,13 @@ import net.sourceforge.plantuml.servlet.utility.NullOutputStream; class DiagramResponse { private HttpServletResponse response; private FileFormat format; - private static final Map contentType; + private static final Map CONTENT_TYPE; static { Map map = new HashMap(); map.put(FileFormat.PNG, "image/png"); map.put(FileFormat.SVG, "image/svg+xml"); map.put(FileFormat.UTXT, "text/plain;charset=UTF-8"); - contentType = Collections.unmodifiableMap(map); + CONTENT_TYPE = Collections.unmodifiableMap(map); } DiagramResponse(HttpServletResponse r, FileFormat f) { @@ -92,7 +92,7 @@ class DiagramResponse { } private String getContentType() { - return contentType.get(format); + return CONTENT_TYPE.get(format); } } diff --git a/src/main/java/net/sourceforge/plantuml/servlet/OldProxyServlet.java b/src/main/java/net/sourceforge/plantuml/servlet/OldProxyServlet.java index 86e202f..2259c3b 100644 --- a/src/main/java/net/sourceforge/plantuml/servlet/OldProxyServlet.java +++ b/src/main/java/net/sourceforge/plantuml/servlet/OldProxyServlet.java @@ -52,7 +52,7 @@ import net.sourceforge.plantuml.SourceStringReader; @SuppressWarnings("serial") public class OldProxyServlet extends HttpServlet { - private static final Pattern proxyPattern = Pattern.compile("/\\w+/proxy/((\\d+)/)?((\\w+)/)?(http://.*)"); + private static final Pattern PROXY_PATTERN = Pattern.compile("/\\w+/proxy/((\\d+)/)?((\\w+)/)?(http://.*)"); private String format; @Override @@ -60,7 +60,7 @@ public class OldProxyServlet extends HttpServlet { final String uri = request.getRequestURI(); - Matcher proxyMatcher = proxyPattern.matcher(uri); + Matcher proxyMatcher = PROXY_PATTERN.matcher(uri); if (proxyMatcher.matches()) { String num = proxyMatcher.group(2); // Optional number of the diagram source format = proxyMatcher.group(4); // Expected format of the generated diagram diff --git a/src/main/java/net/sourceforge/plantuml/servlet/PlantUmlServlet.java b/src/main/java/net/sourceforge/plantuml/servlet/PlantUmlServlet.java index 6318d6c..9ac24d3 100644 --- a/src/main/java/net/sourceforge/plantuml/servlet/PlantUmlServlet.java +++ b/src/main/java/net/sourceforge/plantuml/servlet/PlantUmlServlet.java @@ -60,16 +60,16 @@ import net.sourceforge.plantuml.api.PlantumlUtils; @SuppressWarnings("serial") public class PlantUmlServlet extends HttpServlet { - private static final Pattern urlPattern = Pattern.compile(".*/(.*)"); // Last part of the URL - private static final Pattern encodedPattern = Pattern.compile("^[a-zA-Z0-9\\-\\_]+$"); // Format of a compressed + private static final Pattern URL_PATTERN = Pattern.compile(".*/(.*)"); // Last part of the URL + private static final Pattern ENCODED_PATTERN = Pattern.compile("^[a-zA-Z0-9\\-\\_]+$"); // Format of a compressed // diagram - private static final Pattern startumlPattern = Pattern.compile("/\\w+/start/(.*)"); + private static final Pattern START_PATTERN = Pattern.compile("/\\w+/start/(.*)"); @Override public void doGet(HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException { final String uri = request.getRequestURI(); - Matcher startumlMatcher = startumlPattern.matcher(uri); + Matcher startumlMatcher = START_PATTERN.matcher(uri); if (startumlMatcher.matches()) { System.out.println("PlantUML WARNING This syntax is deprecated."); String source = startumlMatcher.group(1); @@ -92,12 +92,12 @@ public class PlantUmlServlet extends HttpServlet { // the URL form has been submitted if (url != null && !url.trim().isEmpty()) { // Catch the last part of the URL if necessary - Matcher m1 = urlPattern.matcher(url); + Matcher m1 = URL_PATTERN.matcher(url); if (m1.find()) { url = m1.group(1); } // Check it's a valid compressed text - Matcher m2 = encodedPattern.matcher(url); + Matcher m2 = ENCODED_PATTERN.matcher(url); if (m2.find()) { url = m2.group(0); text = transcoder.decode(url); diff --git a/src/main/java/net/sourceforge/plantuml/servlet/utility/UmlExtractor.java b/src/main/java/net/sourceforge/plantuml/servlet/utility/UmlExtractor.java index 4b1916b..6b2b5e8 100644 --- a/src/main/java/net/sourceforge/plantuml/servlet/utility/UmlExtractor.java +++ b/src/main/java/net/sourceforge/plantuml/servlet/utility/UmlExtractor.java @@ -76,4 +76,9 @@ public class UmlExtractor { return uml; } + protected UmlExtractor() { + // prevents calls from subclass + throw new UnsupportedOperationException(); + } + } \ No newline at end of file diff --git a/src/test/java/net/sourceforge/plantuml/servlet/ServerUtils.java b/src/test/java/net/sourceforge/plantuml/servlet/ServerUtils.java index 8fae235..1f692ed 100644 --- a/src/test/java/net/sourceforge/plantuml/servlet/ServerUtils.java +++ b/src/test/java/net/sourceforge/plantuml/servlet/ServerUtils.java @@ -8,7 +8,7 @@ import org.eclipse.jetty.webapp.WebAppContext; public class ServerUtils { - Server server; + private Server server; public ServerUtils(boolean start) throws Exception { server = new Server(new InetSocketAddress("127.0.0.1", 0)); diff --git a/src/test/java/net/sourceforge/plantuml/servlet/TestUtils.java b/src/test/java/net/sourceforge/plantuml/servlet/TestUtils.java index 97262e9..168999a 100644 --- a/src/test/java/net/sourceforge/plantuml/servlet/TestUtils.java +++ b/src/test/java/net/sourceforge/plantuml/servlet/TestUtils.java @@ -20,4 +20,8 @@ public class TestUtils { */ public static final String SEQBOB = "SyfFKj2rKt3CoKnELR1Io4ZDoSa70000"; + protected TestUtils() { + // prevents calls from subclass + throw new UnsupportedOperationException(); + } }