Merge remote-tracking branch 'origin/4.1'

Author: Mark

ChangeLog

@@ -1,3 +1,11 @@
+v4.1.1 (2016-11-09)
+---------------------------
+* changed json parsing of VelocyPack types not known in json
+* fixed VelocyPack bug with non-ASCII characters
+* added missing replicationFactor in CollectionCreateOptions
+* added missing replicationFactor in CollectionPropertiesEntity
+* added option serializeNull in DocumentUpdateOptions
+
 v4.1.0 (2016-10-28)
 ---------------------------
 * changed VelocyStream communication (send protocol header)

pom.xml

@@ -4,7 +4,7 @@
 
 	<groupId>com.arangodb</groupId>
 	<artifactId>arangodb-java-driver</artifactId>
-	<version>4.1.1-SNAPSHOT</version>
+	<version>4.1.2-SNAPSHOT</version>
 	<inceptionYear>2016</inceptionYear>
 	<packaging>jar</packaging>
 
@@ -158,6 +158,7 @@
 				<artifactId>maven-surefire-plugin</artifactId>
 				<version>2.19.1</version>
 				<configuration>
+					<argLine>-Dfile.encoding=UTF-8</argLine>
 					<includes>
 						<include>**/*Test.java</include>
 						<include>**/*Example.java</include>

src/main/java/com/arangodb/entity/CollectionPropertiesEntity.java

@@ -37,6 +37,7 @@ public class CollectionPropertiesEntity extends CollectionEntity {
 	private Long count;
 	private Integer numberOfShards;
 	private Collection<String> shardKeys;
+	private Integer replicationFactor;
 
 	public CollectionPropertiesEntity() {
 		super();
@@ -105,4 +106,12 @@ public void setShardKeys(final Collection<String> shardKeys) {
 		this.shardKeys = shardKeys;
 	}
 
+	public Integer getReplicationFactor() {
+		return replicationFactor;
+	}
+
+	public void setReplicationFactor(final Integer replicationFactor) {
+		this.replicationFactor = replicationFactor;
+	}
+
 }

src/main/java/com/arangodb/internal/InternalArangoCollection.java

@@ -271,7 +271,7 @@ public <T> Request updateDocumentRequest(final String key, final T value, final
 		request.putQueryParam(ArangoDBConstants.RETURN_NEW, params.getReturnNew());
 		request.putQueryParam(ArangoDBConstants.RETURN_OLD, params.getReturnOld());
 		request.putHeaderParam(ArangoDBConstants.IF_MATCH, params.getIfMatch());
-		request.setBody(executor.serialize(value, true));
+		request.setBody(executor.serialize(value, params.getSerializeNull() == null || params.getSerializeNull()));
 		return request;
 	}
 

src/main/java/com/arangodb/model/CollectionCreateOptions.java

@@ -34,6 +34,7 @@ public class CollectionCreateOptions {
 
 	private String name;
 	private Long journalSize;
+	private Integer replicationFactor;
 	private KeyOptions keyOptions;
 	private Boolean waitForSync;
 	private Boolean doCompact;
@@ -76,6 +77,26 @@ public CollectionCreateOptions journalSize(final Long journalSize) {
 		return this;
 	}
 
+	public Integer getReplicationFactor() {
+		return replicationFactor;
+	}
+
+	/**
+	 * @param replicationFactor
+	 *            (The default is 1): in a cluster, this attribute determines how many copies of each shard are kept on
+	 *            different DBServers. The value 1 means that only one copy (no synchronous replication) is kept. A
+	 *            value of k means that k-1 replicas are kept. Any two copies reside on different DBServers. Replication
+	 *            between them is synchronous, that is, every write operation to the "leader" copy will be replicated to
+	 *            all "follower" replicas, before the write operation is reported successful. If a server fails, this is
+	 *            detected automatically and one of the servers holding copies take over, usually without an error being
+	 *            reported.
+	 * @return options
+	 */
+	public CollectionCreateOptions replicationFactor(final Integer replicationFactor) {
+		this.replicationFactor = replicationFactor;
+		return this;
+	}
+
 	public KeyOptions getKeyOptions() {
 		return keyOptions;
 	}

src/main/java/com/arangodb/model/DocumentUpdateOptions.java

@@ -35,6 +35,7 @@ public class DocumentUpdateOptions {
 	private String ifMatch;
 	private Boolean returnNew;
 	private Boolean returnOld;
+	private Boolean serializeNull;
 
 	public DocumentUpdateOptions() {
 		super();
@@ -146,4 +147,20 @@ public DocumentUpdateOptions returnOld(final Boolean returnOld) {
 		return this;
 	}
 
+	public Boolean getSerializeNull() {
+		return serializeNull;
+	}
+
+	/**
+	 * @param serializeNull
+	 *            By default, or if this is set to true, all fields of the document which have null values are
+	 *            serialized to VelocyPack otherwise they are excluded from serialization. Use this to update single
+	 *            fields from a stored document.
+	 * @return options
+	 */
+	public DocumentUpdateOptions serializeNull(final Boolean serializeNull) {
+		this.serializeNull = serializeNull;
+		return this;
+	}
+
 }

src/main/java/com/arangodb/velocypack/VPackBuilder.java

@@ -611,7 +611,7 @@ private void appendSQLTimestamp(final Timestamp value) {
 	}
 
 	private void appendString(final String value) throws VPackBuilderException {
-		final int length = value.length();
+		final int length = value.getBytes().length;
 		if (length <= 126) {
 			// short string
 			add((byte) (0x40 + length));

src/test/java/com/arangodb/ArangoCollectionTest.java

@@ -22,6 +22,7 @@
 
 import static org.hamcrest.Matchers.anyOf;
 import static org.hamcrest.Matchers.hasItem;
+import static org.hamcrest.Matchers.hasItems;
 import static org.hamcrest.Matchers.instanceOf;
 import static org.hamcrest.Matchers.is;
 import static org.hamcrest.Matchers.not;
@@ -364,6 +365,52 @@ public void updateDocumentKeepNullFalse() {
 		assertThat(readResult.getProperties().keySet(), not(hasItem("a")));
 	}
 
+	private static class TestUpdateEntity {
+		@SuppressWarnings("unused")
+		private String a, b;
+	}
+
+	@Test
+	public void updateDocumentSerializeNullTrue() {
+		final TestUpdateEntity doc = new TestUpdateEntity();
+		doc.a = "foo";
+		doc.b = "foo";
+		final DocumentCreateEntity<TestUpdateEntity> createResult = db.collection(COLLECTION_NAME).insertDocument(doc);
+		final TestUpdateEntity patchDoc = new TestUpdateEntity();
+		patchDoc.a = "bar";
+		final DocumentUpdateEntity<TestUpdateEntity> updateResult = db.collection(COLLECTION_NAME)
+				.updateDocument(createResult.getKey(), patchDoc);
+		assertThat(updateResult, is(notNullValue()));
+		assertThat(updateResult.getKey(), is(createResult.getKey()));
+
+		final BaseDocument readResult = db.collection(COLLECTION_NAME).getDocument(createResult.getKey(),
+			BaseDocument.class);
+		assertThat(readResult.getKey(), is(createResult.getKey()));
+		assertThat(readResult.getProperties().keySet(), hasItem("a"));
+		assertThat(readResult.getAttribute("a").toString(), is("bar"));
+	}
+
+	@Test
+	public void updateDocumentSerializeNullFalse() {
+		final TestUpdateEntity doc = new TestUpdateEntity();
+		doc.a = "foo";
+		doc.b = "foo";
+		final DocumentCreateEntity<TestUpdateEntity> createResult = db.collection(COLLECTION_NAME).insertDocument(doc);
+		final TestUpdateEntity patchDoc = new TestUpdateEntity();
+		patchDoc.a = "bar";
+		final DocumentUpdateEntity<TestUpdateEntity> updateResult = db.collection(COLLECTION_NAME)
+				.updateDocument(createResult.getKey(), patchDoc, new DocumentUpdateOptions().serializeNull(false));
+		assertThat(updateResult, is(notNullValue()));
+		assertThat(updateResult.getKey(), is(createResult.getKey()));
+
+		final BaseDocument readResult = db.collection(COLLECTION_NAME).getDocument(createResult.getKey(),
+			BaseDocument.class);
+		assertThat(readResult.getKey(), is(createResult.getKey()));
+		assertThat(readResult.getProperties().keySet(), hasItems("a", "b"));
+		assertThat(readResult.getAttribute("a").toString(), is("bar"));
+		assertThat(readResult.getAttribute("b").toString(), is("foo"));
+	}
+
 	@SuppressWarnings("unchecked")
 	@Test
 	public void updateDocumentMergeObjectsTrue() {

src/test/java/com/arangodb/DocumentTest.java

@@ -0,0 +1,122 @@
+/*
+ * DISCLAIMER
+ *
+ * Copyright 2016 ArangoDB GmbH, Cologne, Germany
+ *
+ * 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.
+ *
+ * Copyright holder is ArangoDB GmbH, Cologne, Germany
+ */
+
+package com.arangodb;
+
+import static org.hamcrest.Matchers.is;
+import static org.hamcrest.Matchers.notNullValue;
+import static org.junit.Assert.assertThat;
+
+import java.util.Map;
+
+import org.junit.Before;
+import org.junit.Test;
+
+import com.arangodb.entity.BaseDocument;
+import com.arangodb.entity.DocumentCreateEntity;
+
+/**
+ * @author Mark - mark at arangodb.com
+ *
+ */
+public class DocumentTest extends BaseTest {
+
+	private static final String COLLECTION_NAME = "collection_test";
+	private ArangoCollection collection;
+
+	@Before
+	public void setup() {
+		collection = db.collection(COLLECTION_NAME);
+		try {
+			collection.drop();
+		} catch (final ArangoDBException e) {
+		}
+		db.createCollection(COLLECTION_NAME);
+	}
+
+	@SuppressWarnings("unchecked")
+	@Test
+	public void insertAsJson() {
+		//@formatter:off
+		final String json = 
+				"{"
+				+ "\"article\": {"
+					+ "\"artist\": \"PREGARDIEN/RHEINISCHE KANTOREI/DAS\","
+					+ "\"releaseDate\": \"1970-01-01\","
+					+ "\"composer\": \"BACH\","
+					+ "\"format\": \"CD\","
+					+ "\"vat\": \"H\","
+					+ "\"carriers\": 1,"
+					+ "\"label\": \"CAPRICCIO\","
+					+ "\"title\": \"BACH ST MATTHEW PASSION BWV244\","
+					+ "\"barcode\": ["
+						+ "\"4006408600466\""
+					+ "],"
+					+ "\"conductor\": \"MAX, H.\""
+				+ "},"
+				+ "\"stock\": {"
+					+ "\"status\": \"RMV\","
+					+ "\"lastUpdate\": \"2016-11-01 00:00\""
+				+ "}"
+			+ "}";
+		//@formatter:on
+		final DocumentCreateEntity<String> createResult = collection.insertDocument(json);
+		final BaseDocument doc = collection.getDocument(createResult.getKey(), BaseDocument.class);
+		assertThat(doc, is(notNullValue()));
+		final Object article = doc.getAttribute("article");
+		assertThat(article, is(notNullValue()));
+		final Object artist = ((Map<String, Object>) article).get("artist");
+		assertThat(artist, is(notNullValue()));
+		assertThat(artist.toString(), is("PREGARDIEN/RHEINISCHE KANTOREI/DAS"));
+	}
+
+	@SuppressWarnings("unchecked")
+	@Test
+	public void insertAsBaseDocument() {
+		final BaseDocument document = new BaseDocument();
+		{
+			final BaseDocument article = new BaseDocument();
+			document.addAttribute("article", article);
+			article.addAttribute("artist", "PREGARDIEN/RHEINISCHE KANTOREI/DAS");
+			article.addAttribute("releaseDate", "1970-01-01");
+			article.addAttribute("composer", "BACH");
+			article.addAttribute("format", "CD");
+			article.addAttribute("vat", "H");
+			article.addAttribute("carriers", 1);
+			article.addAttribute("label", "CAPRICCIO");
+			article.addAttribute("title", "BACH ST MATTHEW PASSION BWV244");
+			article.addAttribute("barcode", new String[] { "4006408600466" });
+			article.addAttribute("conductor", "MAX, H.");
+			final BaseDocument stock = new BaseDocument();
+			document.addAttribute("stock", stock);
+			stock.addAttribute("status", "RMV");
+			stock.addAttribute("lastUpdate", "2016-11-01 00:00");
+		}
+		final DocumentCreateEntity<BaseDocument> createResult = collection.insertDocument(document);
+		final BaseDocument doc = collection.getDocument(createResult.getKey(), BaseDocument.class);
+		assertThat(doc, is(notNullValue()));
+		final Object article = doc.getAttribute("article");
+		assertThat(article, is(notNullValue()));
+		final Object artist = ((Map<String, Object>) article).get("artist");
+		assertThat(artist, is(notNullValue()));
+		assertThat(artist.toString(), is("PREGARDIEN/RHEINISCHE KANTOREI/DAS"));
+	}
+
+}

src/test/java/com/arangodb/velocypack/VPackBuilderTest.java

@@ -887,4 +887,12 @@ public void addVPackObjectInArray() throws VPackException {
 		}
 	}
 
+	@Test
+	public void nonASCII() {
+		final String s = "·ÃÂ";
+		final VPackSlice vpack = new VPackBuilder().add(s).slice();
+		assertThat(vpack.isString(), is(true));
+		assertThat(vpack.getAsString(), is(s));
+	}
+
 }