Add support for a default file extension for view names (#204)

Author: dmaidaniuk

core/src/main/java/org/mvcspec/ozark/OzarkConfig.java

@@ -61,4 +61,12 @@ public CsrfTokenStrategy getCsrfTokenStrategy() {
 
     }
 
+    public String getDefaultViewFileExtension() {
+        Object value = config.getProperty(Properties.DEFAULT_VIEW_FILE_EXTENSION);
+        if (value instanceof String) {
+            return (String) value;
+        }
+        return null;
+    }
+
 }

core/src/main/java/org/mvcspec/ozark/Properties.java

@@ -35,4 +35,9 @@ public interface Properties {
      */
     String CSRF_TOKEN_STRATEGY = "org.mvcspec.ozark.csrfTokenStrategy";
 
+    /**
+     * Property for defining default file extension for usage in views
+     */
+    String DEFAULT_VIEW_FILE_EXTENSION = "org.mvcspec.ozark.defaultViewFileExtension";
+
 }

core/src/main/java/org/mvcspec/ozark/core/ViewResponseFilter.java

@@ -15,6 +15,7 @@
  */
 package org.mvcspec.ozark.core;
 
+import org.mvcspec.ozark.OzarkConfig;
 import org.mvcspec.ozark.event.AfterControllerEventImpl;
 import org.mvcspec.ozark.event.ControllerRedirectEventImpl;
 
@@ -96,6 +97,9 @@ public class ViewResponseFilter implements ContainerResponseFilter {
     @Inject
     private Messages messages;
 
+    @Inject
+    private OzarkConfig ozarkConfig;
+
     @Override
     public void filter(ContainerRequestContext requestContext,
                        ContainerResponseContext responseContext) throws IOException {
@@ -125,7 +129,7 @@ public void filter(ContainerRequestContext requestContext,
                 if (contentType == null) {
                     contentType = MediaType.TEXT_HTML_TYPE;     // default
                 }
-                responseContext.setEntity(new Viewable(an.value()), null, contentType);
+                responseContext.setEntity(new Viewable(appendExtensionIfRequired(an.value())), null, contentType);
                 // If the entity is null the status will be set to 204 by Jersey. For void methods we need to
                 // set the status to 200 unless no other status was set by e.g. throwing an Exception.
 
@@ -138,7 +142,7 @@ public void filter(ContainerRequestContext requestContext,
                 throw new ServerErrorException(messages.get("VoidControllerNoView", resourceInfo.getResourceMethod()), INTERNAL_SERVER_ERROR);
             }
         } else if (entityType != Viewable.class) {
-            final String view = entity.toString();
+            final String view = appendExtensionIfRequired(entity.toString());
             if (view == null) {
                 throw new ServerErrorException(messages.get("EntityToStringNull", resourceInfo.getResourceMethod()), INTERNAL_SERVER_ERROR);
             }
@@ -148,7 +152,7 @@ public void filter(ContainerRequestContext requestContext,
         // Redirect logic, entity must be a Viewable if not null
         entity = responseContext.getEntity();
         if (entity != null) {
-            final String view = ((Viewable) entity).getView();
+            final String view = appendExtensionIfRequired(((Viewable) entity).getView());
             final String uri = uriInfo.getBaseUri() + noStartingSlash(noPrefix(view, REDIRECT));
             if (view.startsWith(REDIRECT)) {
                 responseContext.setStatusInfo(SEE_OTHER);
@@ -173,6 +177,26 @@ public void filter(ContainerRequestContext requestContext,
         }
     }
 
+    private String appendExtensionIfRequired(String viewName) {
+        return appendExtensionIfRequired(viewName, ozarkConfig.getDefaultViewFileExtension());
+    }
+
+    /*
+     * Append to view name default extension if one available and applicable.
+     */
+    static String appendExtensionIfRequired(String viewName, String defaultExtension) {
+        if (viewName == null || viewName.startsWith(REDIRECT)
+            || defaultExtension == null || defaultExtension.length() == 0) {
+            return viewName;
+        }
+
+        String resultView = viewName;
+        if (!viewName.contains(".")) {
+            resultView += "." + defaultExtension;
+        }
+        return resultView;
+    }
+
     private static MediaType selectVariant(Request request, ResourceInfo resourceInfo) {
 
         Produces produces = resourceInfo.getResourceMethod().getAnnotation(Produces.class);

core/src/test/java/org/mvcspec/ozark/core/ViewResponseFilterTest.java

@@ -0,0 +1,69 @@
+/*
+ * Copyright © 2017 Ivar Grimstad ([email protected])
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.mvcspec.ozark.core;
+
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.junit.runners.Parameterized;
+import org.junit.runners.Parameterized.Parameters;
+
+import java.util.Arrays;
+import java.util.Collection;
+
+import static org.junit.Assert.assertEquals;
+
+/**
+ * Test for ViewResponseFilter
+ *
+ * @author Dmytro Maidaniuk
+ */
+@RunWith(value = Parameterized.class)
+public class ViewResponseFilterTest {
+
+    private String viewName;
+
+    private String defaultExtension;
+
+    private String expectedViewName;
+
+    public ViewResponseFilterTest(String viewName,
+                                  String defaultExtension,
+                                  String expectedViewName) {
+        this.viewName = viewName;
+        this.defaultExtension = defaultExtension;
+        this.expectedViewName = expectedViewName;
+    }
+
+    @Parameters
+    public static Collection<Object[]> data() {
+        return Arrays.asList(new Object[][] {
+            {"main.jsp", "jsp", "main.jsp"},
+            {"main", "jsp", "main.jsp"},
+            {"main", null, "main"},
+            {"main", "", "main"},
+            {"redirect:some.jsp", "jsp", "redirect:some.jsp"},
+            {"react:some", "jsp", "react:some.jsp"},
+            {"main.", "jsp", "main."}
+        });
+    }
+
+    @Test
+    public void testAppendExtensionIfRequired() {
+        String actualViewName = ViewResponseFilter.appendExtensionIfRequired(viewName, defaultExtension);
+        assertEquals(expectedViewName, actualViewName);
+    }
+
+}

test/def-ext/pom.xml

@@ -0,0 +1,39 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+
+    Copyright © 2017 Ivar Grimstad ([email protected])
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+        http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
+-->
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <parent>
+        <groupId>org.mvc-spec.ozark.test</groupId>
+        <artifactId>ozark-parent-test</artifactId>
+        <version>1.0.0-SNAPSHOT</version>
+    </parent>
+    <artifactId>def-ext</artifactId>
+    <packaging>war</packaging>
+    <name>Ozark Default Extension Tests</name>
+    <build>
+        <finalName>test-def-ext</finalName>
+    </build>
+    <dependencies>
+        <dependency>
+            <groupId>org.mvc-spec.ozark</groupId>
+            <artifactId>ozark-core</artifactId>
+            <version>1.0.0-SNAPSHOT</version>
+        </dependency>
+    </dependencies>
+</project>

test/def-ext/src/main/java/org/mvcspec/ozark/test/mvc/DefaultExtensionController.java

@@ -0,0 +1,35 @@
+/*
+ * Copyright © 2017 Ivar Grimstad ([email protected])
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.mvcspec.ozark.test.mvc;
+
+import javax.mvc.Controller;
+import javax.ws.rs.GET;
+import javax.ws.rs.Path;
+
+/**
+ * DefaultExtensionController test.
+ *
+ * @author Dmytro Maidaniuk
+ */
+@Path("def-ext")
+@Controller
+public class DefaultExtensionController {
+
+    @GET
+    public String get() {
+        return "extension";
+    }
+}

test/def-ext/src/main/java/org/mvcspec/ozark/test/mvc/MyApplication.java

@@ -0,0 +1,47 @@
+/*
+ * Copyright © 2017 Ivar Grimstad ([email protected])
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.mvcspec.ozark.test.mvc;
+
+import javax.ws.rs.ApplicationPath;
+import javax.ws.rs.core.Application;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.Map;
+import java.util.Set;
+
+/**
+ * Class MyApplication.
+ *
+ * @author Santiago Pericas-Geertsen
+ */
+@ApplicationPath("resources")
+public class MyApplication extends Application {
+
+    @Override
+    public Set<Class<?>> getClasses() {
+        final Set<Class<?>> set = new HashSet<>();
+        set.add(DefaultExtensionController.class);
+        return set;
+    }
+
+    @Override
+    public Map<String, Object> getProperties() {
+        final Map<String, Object> map = new HashMap<>();
+        map.put("myproperty", true);
+        map.put("org.mvcspec.ozark.defaultViewFileExtension", "jsp");
+        return map;
+    }
+}