DATACOUCH-158 - Allow more explicit expiry unit

The Document annotation now also support explicitly giving a TimeUnit for the expiry, ensuring the framework will correctly convert that to the expected Couchbase format.

src/test/java/org/springframework/data/couchbase/core/mapping/BasicCouchbasePersistentEntityTests.java

@@ -0,0 +1,140 @@
+/*
+ * Copyright 2013 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
+ *
+ *      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.springframework.data.couchbase.core.mapping;
+
+import static org.junit.Assert.assertEquals;
+
+import java.util.Calendar;
+import java.util.Date;
+import java.util.TimeZone;
+import java.util.concurrent.TimeUnit;
+
+import org.junit.Test;
+
+import org.springframework.data.util.ClassTypeInformation;
+
+/**
+ * Verifies the correct behavior of annotation at the class level on persistable objects.
+ *
+ * @author Simon Baslé
+ */
+public class BasicCouchbasePersistentEntityTests {
+
+  @Test
+  public void testNoExpiryByDefault() {
+    CouchbasePersistentEntity<DefaultExpiry> entity = new BasicCouchbasePersistentEntity<DefaultExpiry>(
+        ClassTypeInformation.from(DefaultExpiry.class));
+
+    assertEquals(0, entity.getExpiry());
+  }
+
+  @Test
+  public void testDefaultExpiryUnitIsSeconds() {
+    CouchbasePersistentEntity<DefaultExpiryUnit> entity = new BasicCouchbasePersistentEntity<DefaultExpiryUnit>(
+        ClassTypeInformation.from(DefaultExpiryUnit.class));
+
+    assertEquals(78, entity.getExpiry());
+  }
+
+  @Test
+  public void testLargeExpiry30DaysStillInSeconds() {
+    CouchbasePersistentEntity<LimitDaysExpiry> entityUnder = new BasicCouchbasePersistentEntity<LimitDaysExpiry>(
+        ClassTypeInformation.from(LimitDaysExpiry.class));
+    assertEquals(30 * 24 * 60 * 60, entityUnder.getExpiry());
+  }
+
+  @Test
+  public void testLargeExpiry31DaysIsConvertedToUnixUtcTime() {
+    CouchbasePersistentEntity<OverLimitDaysExpiry> entityOver = new BasicCouchbasePersistentEntity<OverLimitDaysExpiry>(
+        ClassTypeInformation.from(OverLimitDaysExpiry.class));
+
+    int expiryOver = entityOver.getExpiry();
+    Calendar expected = Calendar.getInstance(TimeZone.getTimeZone("UTC"));
+    expected.add(Calendar.DAY_OF_YEAR, 31);
+
+    Date dateOver = new Date(expiryOver * 1000L);
+    System.out.println(entityOver + " => " + dateOver);
+
+    Calendar calendar = Calendar.getInstance(TimeZone.getTimeZone("UTC"));
+    calendar.clear();
+    calendar.add(Calendar.SECOND, expiryOver);
+    assertEquals(expected.get(Calendar.YEAR), calendar.get(Calendar.YEAR));
+    assertEquals(expected.get(Calendar.MONTH), calendar.get(Calendar.MONTH));
+    assertEquals(expected.get(Calendar.DAY_OF_MONTH), calendar.get(Calendar.DAY_OF_MONTH));
+    assertEquals(expected.get(Calendar.HOUR_OF_DAY), calendar.get(Calendar.HOUR_OF_DAY));
+    assertEquals(expected.get(Calendar.MINUTE), calendar.get(Calendar.MINUTE));
+    assertEquals(expected.get(Calendar.SECOND), calendar.get(Calendar.SECOND));
+  }
+
+  @Test
+  public void testLargeExpiry31DaysInSecondsIsConvertedToUnixUtcTime() {
+    CouchbasePersistentEntity<OverLimitSecondsExpiry> entityOver = new BasicCouchbasePersistentEntity<OverLimitSecondsExpiry>(
+        ClassTypeInformation.from(OverLimitSecondsExpiry.class));
+
+    int expiryOver = entityOver.getExpiry();
+    Calendar expected = Calendar.getInstance(TimeZone.getTimeZone("UTC"));
+    expected.add(Calendar.DAY_OF_YEAR, 31);
+
+    Date dateOver = new Date(expiryOver * 1000L);
+    System.out.println(entityOver + " => " + dateOver);
+
+    Calendar calendar = Calendar.getInstance(TimeZone.getTimeZone("UTC"));
+    calendar.clear();
+    calendar.add(Calendar.SECOND, expiryOver);
+    assertEquals(expected.get(Calendar.YEAR), calendar.get(Calendar.YEAR));
+    assertEquals(expected.get(Calendar.MONTH), calendar.get(Calendar.MONTH));
+    assertEquals(expected.get(Calendar.DAY_OF_MONTH), calendar.get(Calendar.DAY_OF_MONTH));
+    assertEquals(expected.get(Calendar.HOUR_OF_DAY), calendar.get(Calendar.HOUR_OF_DAY));
+    assertEquals(expected.get(Calendar.MINUTE), calendar.get(Calendar.MINUTE));
+    assertEquals(expected.get(Calendar.SECOND), calendar.get(Calendar.SECOND));
+  }
+
+  /**
+   * Simple POJO to test default expiry.
+   */
+  @Document
+  private class DefaultExpiry {
+  }
+
+  /**
+   * Simple POJO to test default expiry unit.
+   */
+  @Document(expiry = 78)
+  private class DefaultExpiryUnit {
+  }
+
+  /**
+   * Simple POJO to test limit expiry.
+   */
+  @Document(expiry = 30, expiryUnit = TimeUnit.DAYS)
+  private class LimitDaysExpiry {
+  }
+
+  /**
+   * Simple POJO to test larger than 30 days expiry.
+   */
+  @Document(expiry = 31, expiryUnit = TimeUnit.DAYS)
+  public class OverLimitDaysExpiry {
+  }
+
+  /**
+   * Simple POJO to test larger than 30 days expiry, when expressed in default time unit (SECONDS).
+   */
+  @Document(expiry = 31 * 24 * 60 * 60)
+  public class OverLimitSecondsExpiry {
+  }
+}