v1.2.0 (#10)

* update test dependency versions
* add explicit plugin versions
* update javadoc plugin version, fix javadoc errors
* update readme, close #9 fix #8 fix #7

Author: destan

README.md

@@ -1,6 +1,8 @@
 # Servlet Url Mapper
 
-This small and non-invasive library is intended to be used in servlet-only environments where for some reasons developers are left without any frameworks like Spring MVC or Jax-RS.
+This small and non-invasive library is intended to be used in servlet-only environments where for some reasons developers are forced to use 
+Servlet API directly (like in Atlassian plugin SDK).
+
 In such servlet-only environments, this library helps to handle nested URL structures in one servlet.
 
 _Non-invasive_: You don't need to use `servlet url mapper` in every servlet, you can use only in some of them.
@@ -32,17 +34,39 @@ You can use different methods for different URLs in the same servlet. You can ev
 | /products              | POST   | ProductsServlet#create |
 
 
-## Usage
+## Quick start
 
-1. You need to extend your servlet from `MappingServlet`
+1. Add the dependency
+
+You should use [jitpack](https://jitpack.io) to add this library as a dependency for Maven or Gradle (or others).
+ 
+```xml
+<repositories>
+  <repository>
+      <id>jitpack.io</id>
+      <url>https://jitpack.io</url>
+  </repository>
+</repositories>
+```
+```xml
+<dependency>
+    <groupId>com.github.kodgemisi</groupId>
+    <artifactId>servlet-url-mapper</artifactId>
+    <version>1.2.0</version>
+</dependency>
+```
+
+See https://jitpack.io/#kodgemisi/servlet-url-mapper
+
+2. Extend your servlet from `MappingServlet`
 
 ```java
 public class MyServlet extends MappingServlet {
 	//...
 }
 ```
 
-2. Register your url mappings via `protected urlMappingRegistrar` field from `MappingServlet`. You can do this either in `constructor` or in `init` method.
+3. Register your url mappings via `protected urlMappingRegistrar` field from `MappingServlet`. You can do this either in `constructor` or in `init` method.
 
 ```java
 @WebServlet(urlPatterns = {"/products", "/products/"})
@@ -83,36 +107,13 @@ public class MyServlet extends MappingServlet {
 
 **Java 8 usage remainder**: Note that (assuming you have an `AddressHelper` class in your project) `AddressHelper::addAddress` usage implies that `addAddress` is a static method. You can use non-static methods by providing an object instead of Class name like `addressHelper::addAddress` assuming `addressHelper` is an object of `AddressHelper` class.
 
-
-## Dependency Management
-
-You can use [jitpack](https://jitpack.io) to add this library as a dependency for maven, gradle and others.
- 
-```
-<repositories>
-  <repository>
-      <id>jitpack.io</id>
-      <url>https://jitpack.io</url>
-  </repository>
-</repositories>
-```
-```
-<dependency>
-    <groupId>com.github.kodgemisi</groupId>
-    <artifactId>servlet-url-mapper</artifactId>
-    <version>1.0.0</version>
-</dependency>
-```
-
-See https://jitpack.io/#kodgemisi/servlet-url-mapper
-
 ## License and Copyright
 
-© Kod Gemisi Ltd.
+© 2017 - 2020 Kod Gemisi Ltd.
 
 All material in this library's repository is copyrighted by [Kod Gemisi Ltd](http://kodgemisi.com/) unless stated otherwise. 
 
-This library is is subject to the terms of the Mozilla Public License, v. 2.0.
+This library is subject to the terms of the Mozilla Public License, v. 2.0.
 You can find full license in `license.txt` file or at [http://mozilla.org/MPL/2.0/](http://mozilla.org/MPL/2.0/) adress.
 
 There is also an [easy to understand version](https://tldrlegal.com/license/mozilla-public-license-2.0-(mpl-2)) of the license.

pom.xml

@@ -4,12 +4,12 @@
 
     <groupId>com.github.kodgemisi</groupId>
     <artifactId>servlet-url-mapper</artifactId>
-    <version>1.1.0</version>
+    <version>1.2.0</version>
     <packaging>jar</packaging>
 
     <organization>
         <name>Kod Gemisi</name>
-        <url>http://kodgemisi.com/</url>
+        <url>https://kodgemisi.com</url>
     </organization>
 
     <name>Servlet Url Mapper</name>
@@ -36,20 +36,56 @@
             <scope>provided</scope>
         </dependency>
 
+        <dependency>
+            <groupId>org.jetbrains</groupId>
+            <artifactId>annotations</artifactId>
+            <version>19.0.0</version>
+            <optional>true</optional>
+        </dependency>
+
         <dependency>
             <groupId>org.junit.jupiter</groupId>
             <artifactId>junit-jupiter-engine</artifactId>
-            <version>5.3.1</version>
+            <version>5.6.2</version>
+            <scope>test</scope>
+        </dependency>
+
+        <dependency>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter-params</artifactId>
+            <version>5.6.2</version>
             <scope>test</scope>
         </dependency>
 
         <dependency>
             <groupId>org.mockito</groupId>
             <artifactId>mockito-core</artifactId>
-            <version>2.23.0</version>
+            <version>3.3.3</version>
             <scope>test</scope>
         </dependency>
 
+        <dependency>
+            <groupId>org.projectlombok</groupId>
+            <artifactId>lombok</artifactId>
+            <version>1.18.10</version>
+            <scope>test</scope>
+        </dependency>
+
+        <dependency>
+            <groupId>org.jodd</groupId>
+            <artifactId>jodd-json</artifactId>
+            <version>5.1.4</version>
+            <scope>test</scope>
+        </dependency>
+
+        <!--
+            Latest working version pairs:
+            logback-core & logback-classic 1.3.0-alpha4 version with
+            slf4j-api 1.8.0-beta4
+
+            As of logback 1.3.0-alpha5 it requires slf4j-api version 2.0.x
+            See http://logback.qos.ch/news.html (11th of October, 2019, Release of version 1.3.0-alpha5)
+        -->
         <dependency>
             <groupId>ch.qos.logback</groupId>
             <artifactId>logback-core</artifactId>
@@ -71,6 +107,7 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-source-plugin</artifactId>
+                <version>3.2.1</version>
                 <executions>
                     <execution>
                         <id>attach-sources</id>
@@ -83,6 +120,7 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-javadoc-plugin</artifactId>
+                <version>3.2.0</version>
                 <executions>
                     <execution>
                         <id>attach-javadocs</id>
@@ -95,7 +133,7 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-surefire-plugin</artifactId>
-                <version>2.22.1</version>
+                <version>3.0.0-M4</version>
             </plugin>
         </plugins>
     </build>

src/main/java/com/kodgemisi/servlet_url_mapping/ServletRequestHandler.java

@@ -12,8 +12,8 @@
 import java.io.IOException;
 
 /**
- * <p>Servlets extending {@link MappingServlet} provide methods matching {@link ServletRequestHandler#handleRequest} signature so that those methods
- * can be used as request handlers.</p> <p>See {@link ServletUrlPatternRegistrar} for examples.</p>
+ * <p>Servlets extending {@link MappingServlet} should provide methods matching {@link ServletRequestHandler#handleRequest} signature so that those methods
+ * can be used as request handlers.</p> <p>See {@link ServletUrlPattern} for examples.</p>
  *
  * @author destan
  */

src/main/java/com/kodgemisi/servlet_url_mapping/ServletUrl.java

@@ -6,13 +6,17 @@
 
 package com.kodgemisi.servlet_url_mapping;
 
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+import java.math.BigDecimal;
 import java.util.*;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
 /**
  * <p>
- * Used to represent a request parsing result.<br>
+ * This class represents a request URL parsing result.<br>
  * i.e {@code ServletUrl servletUrl = servletUrlPattern.parse(request)}<br>
  * i.e {@code ServletUrl servletUrl = servletUrlPatternRegistrar.parse(request)}
  * </p>
@@ -33,6 +37,8 @@ public class ServletUrl {
 
 	private static Pattern pathVariablePattern = Pattern.compile("\\{[A-Za-z_$]\\w*\\}");
 
+	static final Class<?> DEFAULT_PATH_VARIABLE_TYPE = String.class;
+
 	static {
 		NOT_FOUND = new ServletUrl(NOT_FOUND_404, "<not applicable>", new Class[0], null);
 	}
@@ -58,17 +64,19 @@ public class ServletUrl {
 	 * @param urlPattern
 	 * @param types
 	 */
-	ServletUrl(String name, String urlPattern, Class<?>[] types, ServletRequestHandler requestHandler) {
+	ServletUrl(@Nullable String name, @NotNull String urlPattern, @NotNull Class<?>[] types, ServletRequestHandler requestHandler) {
 		this.name = name;
 		this.variableTypes = Collections.unmodifiableList(Arrays.asList(types));
 		this.pathVariables = Collections.emptyMap();// prevent accidental use
 		this.requestHandler = requestHandler;
 
-		List<String> names = new ArrayList<String>();
+		final List<String> names = new ArrayList<>();
 		this.pattern = Pattern.compile(urlPatternToRegex(urlPattern, names, variableTypes));
 
-		this.hasTrailingSlash = urlPattern.length() > 0 && urlPattern.substring(urlPattern.length() - 1, urlPattern.length()).equals("/");
+		this.hasTrailingSlash = urlPattern.endsWith("/");
 		this.variableNames = Collections.unmodifiableList(names);
+
+		//TODO check if variableNames & variableTypes sizes are consistent (only if variableTypes is not empty)
 	}
 
 	ServletUrl(ServletUrl copy) {
@@ -79,40 +87,47 @@ public class ServletUrl {
 		this.variableNames = copy.variableNames;
 		this.pathVariables = new HashMap<>();
 		this.requestHandler = copy.requestHandler;
+		this.index = copy.index;
 	}
 
 	private static Object getObjectAs(Class<?> clazz, String value) {
 
 		if (String.class.equals(clazz)) {
 			return value;
 		}
-		else if (Number.class.isAssignableFrom(clazz)) {
+		if (Integer.class.isAssignableFrom(clazz) || int.class.isAssignableFrom(clazz)) {
 			return Integer.valueOf(value);
 		}
-		else if (Boolean.class.equals(clazz)) {
+		if (Long.class.isAssignableFrom(clazz) || long.class.isAssignableFrom(clazz)) {
+			return Long.valueOf(value);
+		}
+		if (BigDecimal.class.isAssignableFrom(clazz)) {
+			return new BigDecimal(value);
+		}
+		if (Boolean.class.equals(clazz) || boolean.class.equals(clazz)) {
 			return Boolean.valueOf(value);
 		}
 
 		throw new IllegalArgumentException("Unsupported Type " + clazz.getName());
 	}
 
 	/**
-	 * <strong>Caveat</strong> <p>Prefer primitive wrapper classes like Integer, Long etc. to avoid {@link NullPointerException} when the value is
-	 * null.</p> <p>Note that casting {@code null} to {@code int} throws {@link NullPointerException} however casting {@code null} to {@link Integer}
-	 * doesn't!</p>
+	 * <strong>Caveat</strong>
+	 * <p>Prefer primitive wrapper classes like Integer, Long etc. to avoid {@link NullPointerException} when the value might be null.</p>
+	 * <p>Note that casting {@code null} to {@code int} throws {@link NullPointerException} however casting {@code null} to {@link Integer} doesn't!</p>
 	 *
-	 * @param variable
-	 * @param <T>
-	 * @return
+	 * @param variable path variable name
+	 * @return T
 	 */
 	public <T> T variable(String variable) {
-		return (T) pathVariables.get(variable);
+		return (T) pathVariables.get(variable);//TODO return optional
 	}
 
 	void addVariable(String value) {
-		//TODO size validation
 
-		Class<?> clazz = index >= variableTypes.size() ? Integer.class : variableTypes.get(index);//default is Integer
+		// Cannot use simply variableTypes.isEmpty() because user may give only first parameter type out of total two
+		// E.g. servletUrlPattern.register("example", "/users/{id}/addresses/{addrId}", Long.class) here the second parameter is String (the default)
+		final Class<?> clazz = index >= variableTypes.size() ? DEFAULT_PATH_VARIABLE_TYPE : variableTypes.get(index);
 		pathVariables.put(variableNames.get(index++), getObjectAs(clazz, value));
 	}
 
@@ -131,22 +146,27 @@ private String urlPatternToRegex(final String urlPattern, List<String> names, Li
 			String variable = matcher.group();
 			names.add(variable.substring(1, variable.length() - 1));// get rid of {}
 
-			Class<?> clazz = names.size() > types.size() ? Integer.class : types.get(names.size() - 1);//default is Integer
+			final Class<?> clazz = names.size() > types.size() ? DEFAULT_PATH_VARIABLE_TYPE : types.get(names.size() - 1);
 			result = result.replace(variable, getRegexGroupByType(clazz));
 		}
 		return result;
 	}
 
 	private String getRegexGroupByType(Class<?> clazz) {
+
 		if (String.class.equals(clazz)) {
-			return "(\\w+)";
+			return "([^/]+)";
 		}
-		if (Number.class.isAssignableFrom(clazz)) {
+		if (Integer.class.isAssignableFrom(clazz) || int.class.isAssignableFrom(clazz) || Long.class.isAssignableFrom(clazz) || long.class.isAssignableFrom(clazz)) {
 			return "(\\d+)";
 		}
-		if (Boolean.class.equals(clazz)) {
+		if (BigDecimal.class.isAssignableFrom(clazz)) {
+			return "(\\d+\\.*\\d*)";
+		}
+		if (Boolean.class.equals(clazz) || boolean.class.equals(clazz)) {
 			return "(true|false|True|False|TRUE|FALSE)";
 		}
+
 		throw new IllegalArgumentException("Unsupported Type " + clazz.getName());
 	}