[WW-5016] Adds support for LocalDate and adjusts tests to use the new Java 8 API

core/src/main/java/com/opensymphony/xwork2/config/providers/StrutsDefaultConfigurationProvider.java

@@ -56,6 +56,9 @@
 import com.opensymphony.xwork2.conversion.impl.DefaultConversionAnnotationProcessor;
 import com.opensymphony.xwork2.conversion.impl.DefaultConversionFileProcessor;
 import com.opensymphony.xwork2.security.NotExcludedAcceptedPatternsChecker;
+import org.apache.struts2.components.date.DateFormatter;
+import org.apache.struts2.components.date.DateTimeFormatterAdapter;
+import org.apache.struts2.components.date.SimpleDateFormatAdapter;
 import org.apache.struts2.conversion.StrutsConversionPropertiesProcessor;
 import com.opensymphony.xwork2.conversion.impl.DefaultObjectTypeDeterminer;
 import org.apache.struts2.conversion.StrutsTypeConverterCreator;
@@ -218,6 +221,9 @@ public void register(ContainerBuilder builder, LocatableProperties props)
                         , Scope.SINGLETON)
 
                 .factory(ValueSubstitutor.class, EnvsValueSubstitutor.class, Scope.SINGLETON)
+
+                .factory(DateFormatter.class, "simpleDateFormatter", SimpleDateFormatAdapter.class, Scope.SINGLETON)
+                .factory(DateFormatter.class, "dateTimeFormatter", DateTimeFormatterAdapter.class, Scope.SINGLETON)
         ;
 
         props.setProperty(StrutsConstants.STRUTS_ENABLE_DYNAMIC_METHOD_INVOCATION, Boolean.FALSE.toString());

core/src/main/java/org/apache/struts2/StrutsConstants.java

@@ -18,6 +18,7 @@
  */
 package org.apache.struts2;
 
+import org.apache.struts2.components.date.DateFormatter;
 import org.apache.struts2.dispatcher.mapper.CompositeActionMapper;
 
 /**
@@ -384,4 +385,6 @@ public final class StrutsConstants {
     public static final String STRUTS_CHAINING_COPY_MESSAGES = "struts.chaining.copyMessages";
     public static final String STRUTS_OBJECT_FACTORY_CLASSLOADER = "struts.objectFactory.classloader";
 
+    /** See {@link org.apache.struts2.components.Date#setDateFormatter(DateFormatter)} */
+    public static final String STRUTS_DATE_FORMATTER = "struts.date.formatter";
 }

core/src/main/java/org/apache/struts2/components/Date.java

@@ -18,29 +18,29 @@
  */
 package org.apache.struts2.components;
 
-import com.opensymphony.xwork2.ActionContext;
 import com.opensymphony.xwork2.TextProvider;
+import com.opensymphony.xwork2.inject.Inject;
 import com.opensymphony.xwork2.util.ValueStack;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
+import org.apache.struts2.components.date.DateFormatter;
 import org.apache.struts2.views.annotations.StrutsTag;
 import org.apache.struts2.views.annotations.StrutsTagAttribute;
 
 import java.io.IOException;
 import java.io.Writer;
 import java.time.Instant;
+import java.time.LocalDate;
 import java.time.LocalDateTime;
 import java.time.ZoneId;
 import java.time.ZonedDateTime;
-import java.time.format.DateTimeFormatter;
-import java.time.format.FormatStyle;
 import java.util.ArrayList;
 import java.util.Calendar;
 import java.util.List;
 
 /**
  * <!-- START SNIPPET: javadoc -->
- *
+ * <p>
  * Format Date object in different ways.
  * <p>
  * The date tag will allow you to format a Date in a quick and easy way.
@@ -59,6 +59,12 @@
  * </p>
  *
  * <p>
+ * <b>Note</b>: Since Struts 2.6 a new Java 8 API has been used to format the Date, it's based on
+ * <a href="https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html">DateTimeFormatter</a>
+ * which uses a bit different patterns.
+ * </p>
+ *
+ * <p>
  * Configurable attributes are:
  * </p>
  *
@@ -130,8 +136,8 @@
  *      <td>if one is not found DateFormat.MEDIUM format will be used</td>
  *   </tr>
  * </table>
- *
- *
+ * <p>
+ * <p>
  * <!-- END SNIPPET: javadoc -->
  *
  * <p><b>Examples</b></p>
@@ -145,12 +151,12 @@
  * </pre>
  *
  * <code>Date</code>
- *
  */
-@StrutsTag(name="date", tldBodyContent="empty", tldTagClass="org.apache.struts2.views.jsp.DateTag", description="Render a formatted date.")
+@StrutsTag(name = "date", tldBodyContent = "empty", tldTagClass = "org.apache.struts2.views.jsp.DateTag", description = "Render a formatted date.")
 public class Date extends ContextBean {
 
     private static final Logger LOG = LogManager.getLogger(Date.class);
+
     /**
      * Property name to fall back when no format is specified
      */
@@ -202,17 +208,18 @@ public class Date extends ContextBean {
 
     private String timezone;
 
+    private DateFormatter dateFormatter;
+
     public Date(ValueStack stack) {
         super(stack);
     }
 
-    private TextProvider findProviderInStack() {
-        for (Object o : getStack().getRoot()) {
-            if (o instanceof TextProvider) {
-                return (TextProvider) o;
-            }
-        }
-        return null;
+    /**
+     * An instance of {@link DateFormatter}
+     */
+    @Inject
+    public void setDateFormatter(DateFormatter dateFormatter) {
+        this.dateFormatter = dateFormatter;
     }
 
     /**
@@ -280,6 +287,8 @@ public String formatTime(TextProvider tp, ZonedDateTime date) {
 
     @Override
     public boolean end(Writer writer, String body) {
+        TextProvider textProvider = findProviderInStack();
+
         ZonedDateTime date = null;
         final ZoneId tz = getTimeZone();
         // find the name on the valueStack
@@ -292,26 +301,27 @@ public boolean end(Writer writer, String body) {
             date = Instant.ofEpochMilli((long) dateObject).atZone(tz);
         } else if (dateObject instanceof LocalDateTime) {
             date = ((LocalDateTime) dateObject).atZone(tz);
+        } else if (dateObject instanceof LocalDate) {
+            date = ((LocalDate) dateObject).atStartOfDay(tz);
         } else if (dateObject instanceof Instant) {
             date = ((Instant) dateObject).atZone(tz);
         } else {
             if (devMode) {
-                TextProvider tp = findProviderInStack();
                 String developerNotification = "";
-                if (tp != null) {
-                    developerNotification = findProviderInStack().getText(
-                            "devmode.notification",
-                            "Developer Notification:\n{0}",
-                            new String[]{
-                                    "Expression [" + name + "] passed to <s:date/> tag which was evaluated to [" + dateObject + "]("
-                                            + (dateObject != null ? dateObject.getClass() : "null") + ") isn't supported!"
-                            }
+                if (textProvider != null) {
+                    developerNotification = textProvider.getText(
+                        "devmode.notification",
+                        "Developer Notification:\n{0}",
+                        new String[]{
+                            "Expression [" + name + "] passed to <s:date/> tag which was evaluated to [" + dateObject + "]("
+                                + (dateObject != null ? dateObject.getClass() : "null") + ") isn't supported!"
+                        }
                     );
                 }
                 LOG.warn(developerNotification);
             } else {
                 LOG.debug("Expression [{}] passed to <s:date/> tag which was evaluated to [{}]({}) isn't supported!",
-                        name, dateObject, (dateObject != null ? dateObject.getClass() : "null"));
+                    name, dateObject, (dateObject != null ? dateObject.getClass() : "null"));
             }
         }
 
@@ -321,33 +331,11 @@ public boolean end(Writer writer, String body) {
         }
         String msg;
         if (date != null) {
-            TextProvider tp = findProviderInStack();
-            if (tp != null) {
+            if (textProvider != null) {
                 if (nice) {
-                    msg = formatTime(tp, date);
+                    msg = formatTime(textProvider, date);
                 } else {
-                    DateTimeFormatter dtf;
-                    if (format == null) {
-                        String globalFormat = null;
-
-                        // if the format is not specified, fall back using the
-                        // defined property DATETAG_PROPERTY
-                        globalFormat = tp.getText(DATETAG_PROPERTY);
-
-                        // if tp.getText can not find the property then the
-                        // returned string is the same as input =
-                        // DATETAG_PROPERTY
-                        if (globalFormat != null
-                                && !DATETAG_PROPERTY.equals(globalFormat)) {
-                            dtf = DateTimeFormatter.ofPattern(globalFormat, ActionContext.getContext().getLocale());
-                        } else {
-                            dtf = DateTimeFormatter.ofLocalizedDateTime(FormatStyle.MEDIUM)
-                                    .withLocale(ActionContext.getContext().getLocale());
-                        }
-                    } else {
-                        dtf = DateTimeFormatter.ofPattern(format, ActionContext.getContext().getLocale());
-                    }
-                    msg = dtf.format(date);
+                    msg = formatDate(textProvider, date);
                 }
                 if (msg != null) {
                     try {
@@ -365,6 +353,20 @@ public boolean end(Writer writer, String body) {
         return super.end(writer, "");
     }
 
+    private String formatDate(TextProvider textProvider, ZonedDateTime date) {
+        String useFormat = format;
+        if (useFormat == null) {
+            // if the format is not specified, fall back using the defined property DATETAG_PROPERTY
+            useFormat = textProvider.getText(DATETAG_PROPERTY);
+            if (DATETAG_PROPERTY.equals(useFormat)) {
+                // if tp.getText can not find the property then the
+                // returned string is the same as input = DATETAG_PROPERTY
+                useFormat = null;
+            }
+        }
+        return dateFormatter.format(date, useFormat);
+    }
+
     private ZoneId getTimeZone() {
         ZoneId tz = ZoneId.systemDefault();
         if (timezone != null) {
@@ -378,17 +380,26 @@ private ZoneId getTimeZone() {
         return tz;
     }
 
-    @StrutsTagAttribute(description="Date or DateTime format pattern", rtexprvalue=false)
+    private TextProvider findProviderInStack() {
+        for (Object o : getStack().getRoot()) {
+            if (o instanceof TextProvider) {
+                return (TextProvider) o;
+            }
+        }
+        return null;
+    }
+
+    @StrutsTagAttribute(description = "Date or DateTime format pattern")
     public void setFormat(String format) {
         this.format = format;
     }
 
-    @StrutsTagAttribute(description="Whether to print out the date nicely", type="Boolean", defaultValue="false")
+    @StrutsTagAttribute(description = "Whether to print out the date nicely", type = "Boolean", defaultValue = "false")
     public void setNice(boolean nice) {
         this.nice = nice;
     }
 
-    @StrutsTagAttribute(description = "The specific timezone in which to format the date", required = false)
+    @StrutsTagAttribute(description = "The specific timezone in which to format the date")
     public void setTimezone(String timezone) {
         this.timezone = timezone;
     }
@@ -400,7 +411,7 @@ public String getName() {
         return name;
     }
 
-    @StrutsTagAttribute(description="The date value to format", required=true)
+    @StrutsTagAttribute(description = "The date value to format", required = true)
     public void setName(String name) {
         this.name = name;
     }

core/src/main/java/org/apache/struts2/components/date/DateFormatter.java

@@ -0,0 +1,40 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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.apache.struts2.components.date;
+
+import java.time.temporal.TemporalAccessor;
+
+/**
+ * Allows defines a wrapper around different formatting APIs, like old SimpleDateFormat
+ * and new DateTimeFormatter introduced in Java 8 Date/Time API
+ * <p>
+ * New instance will be injected using {@link org.apache.struts2.StrutsConstants#STRUTS_DATE_FORMATTER}
+ */
+public interface DateFormatter {
+
+    /**
+     * Formats provided temporal with the given format
+     *
+     * @param temporal Java 8 {@link TemporalAccessor}
+     * @param format   implementation specific format
+     * @return a string representation of the formatted `temporal`
+     */
+    String format(TemporalAccessor temporal, String format);
+
+}

core/src/main/java/org/apache/struts2/components/date/DateTimeFormatterAdapter.java

@@ -0,0 +1,43 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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.apache.struts2.components.date;
+
+import com.opensymphony.xwork2.ActionContext;
+
+import java.time.format.DateTimeFormatter;
+import java.time.format.FormatStyle;
+import java.time.temporal.TemporalAccessor;
+import java.util.Locale;
+
+public class DateTimeFormatterAdapter implements DateFormatter {
+
+    @Override
+    public String format(TemporalAccessor temporal, String format) {
+        DateTimeFormatter dtf;
+        Locale locale = ActionContext.getContext().getLocale();
+        if (format == null) {
+            dtf = DateTimeFormatter.ofLocalizedDateTime(FormatStyle.MEDIUM)
+                .withLocale(locale);
+        } else {
+            dtf = DateTimeFormatter.ofPattern(format, locale);
+        }
+        return dtf.format(temporal);
+    }
+
+}