GH-335 - Moments now implements Now.

Author: odrotbohm

spring-modulith-moments/src/main/java/org/springframework/modulith/moments/support/Moments.java

@@ -43,7 +43,7 @@
  *
  * @author Oliver Drotbohm
  */
-public class Moments {
+public class Moments implements Now {
 
 	private static final MonthDay DEC_31ST = MonthDay.of(Month.DECEMBER, 31);
 
@@ -123,13 +123,27 @@ Moments shiftBy(Duration duration) {
 		return this;
 	}
 
-	LocalDateTime now() {
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.modulith.moments.support.Now#now()
+	 */
+	@Override
+	public LocalDateTime now() {
 
 		Instant instant = clock.instant().plus(shift);
 
 		return LocalDateTime.ofInstant(instant, properties.getZoneId());
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.modulith.moments.support.Now#today()
+	 */
+	@Override
+	public LocalDate today() {
+		return now().toLocalDate();
+	}
+
 	private void emitEventsFor(LocalDateTime time) {
 		events.publishEvent(HourHasPassed.of(time.truncatedTo(ChronoUnit.HOURS)));
 	}

spring-modulith-moments/src/main/java/org/springframework/modulith/moments/support/Now.java

@@ -0,0 +1,44 @@
+/*
+ * Copyright 2023 the original author or authors.
+ *
+ * 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
+ *
+ *      https://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.springframework.modulith.moments.support;
+
+import java.time.LocalDate;
+import java.time.LocalDateTime;
+
+/**
+ * An abstraction of the current point in time and today. Useful if application code needs to look them up, but you need
+ * a mechanism to shift the time for testing local development purposes.
+ *
+ * @author Oliver Drotbohm
+ * @since 1.1
+ * @see TimeMachine
+ */
+public interface Now {
+
+	/**
+	 * Returns the current point in time.
+	 *
+	 * @return will never be {@literal null}.
+	 */
+	LocalDateTime now();
+
+	/**
+	 * Returns the current date.
+	 *
+	 * @return will never be {@literal null}.
+	 */
+	LocalDate today();
+}