DATAMONGO-1721 - Fixed package dependencies.

Added a Degraph based tests to identify package cycles and violations in layering.

Moved Collation to the core.query package, fixing dependency cycles. Moved IndexOperations and IndexOperationsProvider to the core.index package. fixing dependency cycles. Moved GeoJsonConfiguration to config package. Replaced the original version of these interfaces/classes with a deprecated version extending the new one, in order to not break the existing API.

Removed all references to Part.Type, except for those to maintain the existing API. API using Part.Type is marked as deprecated. It violates the layering, because nothing but "config" should access "repository". Tests added to MongoRegexCreator in order to facilitate the removal of Part.Type dependencies. Using the moved/new ExampleMatcherAccessor.

Related Tickets: DATACMNS-1097.
Original pull request: #470.

Author: schauder

.gitignore

@@ -15,3 +15,4 @@ src/ant/.ant-targets-upload-dist.xml
 atlassian-ide-plugin.xml
 /.gradle/
 /.idea/
+*.graphml

spring-data-mongodb/pom.xml

@@ -232,6 +232,13 @@
 			<scope>test</scope>
 		</dependency>
 
+		<dependency>
+			<groupId>de.schauderhaft.degraph</groupId>
+			<artifactId>degraph-check</artifactId>
+			<version>0.1.4</version>
+			<scope>test</scope>
+		</dependency>
+		
 		<!-- Kotlin extension -->
 		<dependency>
 			<groupId>org.jetbrains.kotlin</groupId>

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/config/GeoJsonConfiguration.java

@@ -0,0 +1,34 @@
+/*
+ * Copyright 2015-2017 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.mongodb.config;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.data.mongodb.core.geo.GeoJsonModule;
+import org.springframework.data.web.config.SpringDataJacksonModules;
+
+/**
+ * Configuration class to expose {@link GeoJsonModule} as a Spring bean.
+ * 
+ * @author Oliver Gierke
+ * @author Jens Schauder
+ */
+public class GeoJsonConfiguration implements SpringDataJacksonModules {
+
+	@Bean
+	public GeoJsonModule geoJsonModule() {
+		return new GeoJsonModule();
+	}
+}

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/CollectionOptions.java

@@ -17,6 +17,7 @@
 
 import java.util.Optional;
 
+import org.springframework.data.mongodb.core.query.Collation;
 import org.springframework.util.Assert;
 
 /**

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/DefaultBulkOperations.java

@@ -31,6 +31,7 @@
 import org.springframework.data.mongodb.core.convert.QueryMapper;
 import org.springframework.data.mongodb.core.convert.UpdateMapper;
 import org.springframework.data.mongodb.core.mapping.MongoPersistentEntity;
+import org.springframework.data.mongodb.core.query.Collation;
 import org.springframework.data.mongodb.core.query.Query;
 import org.springframework.data.mongodb.core.query.Update;
 import org.springframework.data.util.Pair;

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/DefaultIndexOperations.java

@@ -27,6 +27,7 @@
 import org.springframework.data.mongodb.MongoDbFactory;
 import org.springframework.data.mongodb.core.index.IndexDefinition;
 import org.springframework.data.mongodb.core.index.IndexInfo;
+import org.springframework.data.mongodb.core.index.IndexOperations;
 import org.springframework.data.mongodb.core.mapping.MongoPersistentEntity;
 import org.springframework.util.Assert;
 
@@ -89,7 +90,7 @@ public DefaultIndexOperations(MongoDbFactory mongoDbFactory, String collectionNa
 
 	/*
 	 * (non-Javadoc)
-	 * @see org.springframework.data.mongodb.core.IndexOperations#ensureIndex(org.springframework.data.mongodb.core.index.IndexDefinition)
+	 * @see org.springframework.data.mongodb.core.index.IndexOperations#ensureIndex(org.springframework.data.mongodb.core.index.IndexDefinition)
 	 */
 	public String ensureIndex(final IndexDefinition indexDefinition) {
 
@@ -136,7 +137,7 @@ private MongoPersistentEntity<?> lookupPersistentEntity(Class<?> entityType, Str
 
 	/*
 	 * (non-Javadoc)
-	 * @see org.springframework.data.mongodb.core.IndexOperations#dropIndex(java.lang.String)
+	 * @see org.springframework.data.mongodb.core.index.IndexOperations#dropIndex(java.lang.String)
 	 */
 	public void dropIndex(final String name) {
 
@@ -149,15 +150,15 @@ public void dropIndex(final String name) {
 
 	/*
 	 * (non-Javadoc)
-	 * @see org.springframework.data.mongodb.core.IndexOperations#dropAllIndexes()
+	 * @see org.springframework.data.mongodb.core.index.IndexOperations#dropAllIndexes()
 	 */
 	public void dropAllIndexes() {
 		dropIndex("*");
 	}
 
 	/*
 	 * (non-Javadoc)
-	 * @see org.springframework.data.mongodb.core.IndexOperations#getIndexInfo()
+	 * @see org.springframework.data.mongodb.core.index.IndexOperations#getIndexInfo()
 	 */
 	public List<IndexInfo> getIndexInfo() {
 

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/DefaultIndexOperationsProvider.java

@@ -17,6 +17,8 @@
 
 import org.springframework.data.mongodb.MongoDbFactory;
 import org.springframework.data.mongodb.core.convert.QueryMapper;
+import org.springframework.data.mongodb.core.index.IndexOperations;
+import org.springframework.data.mongodb.core.index.IndexOperationsProvider;
 
 /**
  * {@link IndexOperationsProvider} to obtain {@link IndexOperations} from a given {@link MongoDbFactory}. TODO: Review
@@ -38,7 +40,7 @@ class DefaultIndexOperationsProvider implements IndexOperationsProvider {
 	}
 
 	/* (non-Javadoc)
-	 * @see org.springframework.data.mongodb.core.IndexOperationsProvider#reactiveIndexOps(java.lang.String)
+	 * @see org.springframework.data.mongodb.core.index.IndexOperationsProvider#reactiveIndexOps(java.lang.String)
 	 */
 	@Override
 	public IndexOperations indexOps(String collectionName) {

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/DefaultReactiveIndexOperations.java

@@ -18,6 +18,7 @@
 import org.bson.Document;
 import org.springframework.data.mongodb.core.index.IndexDefinition;
 import org.springframework.data.mongodb.core.index.IndexInfo;
+import org.springframework.data.mongodb.core.index.IndexOperations;
 import org.springframework.util.Assert;
 
 import com.mongodb.reactivestreams.client.ListIndexesPublisher;

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/FindAndModifyOptions.java

@@ -17,6 +17,8 @@
 
 import java.util.Optional;
 
+import org.springframework.data.mongodb.core.query.Collation;
+
 /**
  * @author Mark Pollak
  * @author Oliver Gierke

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/GeoJsonConfiguration.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2015-2016 the original author or authors.
+ * Copyright 2017 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.
@@ -15,19 +15,17 @@
  */
 package org.springframework.data.mongodb.core;
 
-import org.springframework.context.annotation.Bean;
 import org.springframework.data.mongodb.core.geo.GeoJsonModule;
-import org.springframework.data.web.config.SpringDataJacksonModules;
 
 /**
  * Configuration class to expose {@link GeoJsonModule} as a Spring bean.
- * 
+ *
  * @author Oliver Gierke
+ * @author Jens Schauder
+ *
+ * @deprecated Use {@link org.springframework.data.mongodb.config.GeoJsonConfiguration} instead.
  */
-public class GeoJsonConfiguration implements SpringDataJacksonModules {
+@Deprecated
+public class GeoJsonConfiguration extends org.springframework.data.mongodb.config.GeoJsonConfiguration {
 
-	@Bean
-	public GeoJsonModule geoJsonModule() {
-		return new GeoJsonModule();
-	}
 }

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/IndexConverters.java

@@ -125,7 +125,7 @@ public static Collation fromDocument(Document source) {
 			return null;
 		}
 
-		return org.springframework.data.mongodb.core.Collation.from(source).toMongoCollation();
+		return org.springframework.data.mongodb.core.query.Collation.from(source).toMongoCollation();
 	}
 
 	private static Converter<Document, IndexInfo> getDocumentIndexInfoConverter() {

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/IndexOperations.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2011-2016 the original author or authors.
+ * Copyright 2017 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.
@@ -15,44 +15,17 @@
  */
 package org.springframework.data.mongodb.core;
 
-import java.util.List;
-
-import org.springframework.data.mongodb.core.index.IndexDefinition;
-import org.springframework.data.mongodb.core.index.IndexInfo;
-
 /**
  * Index operations on a collection.
- * 
+ *
  * @author Mark Pollack
  * @author Oliver Gierke
  * @author Christoph Strobl
+ * @author Jens Schauder
+ *
+ * @deprecated Use {@link org.springframework.data.mongodb.core.index.IndexOperations} instead.
  */
-public interface IndexOperations {
-
-	/**
-	 * Ensure that an index for the provided {@link IndexDefinition} exists for the collection indicated by the entity
-	 * class. If not it will be created.
-	 * 
-	 * @param indexDefinition must not be {@literal null}.
-	 */
-	String ensureIndex(IndexDefinition indexDefinition);
-
-	/**
-	 * Drops an index from this collection.
-	 * 
-	 * @param name name of index to drop
-	 */
-	void dropIndex(String name);
-
-	/**
-	 * Drops all indices from this collection.
-	 */
-	void dropAllIndexes();
+@Deprecated
+public interface IndexOperations extends org.springframework.data.mongodb.core.index.IndexOperations {
 
-	/**
-	 * Returns the index information on the collection.
-	 * 
-	 * @return index information on the collection
-	 */
-	List<IndexInfo> getIndexInfo();
 }

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/IndexOperationsAdapter.java

@@ -20,6 +20,7 @@
 
 import org.springframework.data.mongodb.core.index.IndexDefinition;
 import org.springframework.data.mongodb.core.index.IndexInfo;
+import org.springframework.data.mongodb.core.index.IndexOperations;
 import org.springframework.util.Assert;
 
 /**

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/IndexOperationsProvider.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016 the original author or authors.
+ * Copyright 2017 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.
@@ -13,22 +13,16 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
 package org.springframework.data.mongodb.core;
 
-import org.springframework.data.mongodb.core.convert.QueryMapper;
-
 /**
- * TODO: Revisit for a better pattern.
  * @author Mark Paluch
+ * @author Jens Schauder
  * @since 2.0
+ *
+ * @deprecated Use {@link org.springframework.data.mongodb.core.index.IndexOperationsProvider} instead.
  */
-public interface IndexOperationsProvider {
+@Deprecated
+public interface IndexOperationsProvider extends org.springframework.data.mongodb.core.index.IndexOperationsProvider {
 
-	/**
-	 * Returns the operations that can be performed on indexes
-	 *
-	 * @return index operations on the named collection
-	 */
-	IndexOperations indexOps(String collectionName);
 }

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/MongoOperations.java

@@ -27,6 +27,7 @@
 import org.springframework.data.mongodb.core.aggregation.AggregationResults;
 import org.springframework.data.mongodb.core.aggregation.TypedAggregation;
 import org.springframework.data.mongodb.core.convert.MongoConverter;
+import org.springframework.data.mongodb.core.index.IndexOperations;
 import org.springframework.data.mongodb.core.mapreduce.GroupBy;
 import org.springframework.data.mongodb.core.mapreduce.GroupByResults;
 import org.springframework.data.mongodb.core.mapreduce.MapReduceOptions;

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/MongoTemplate.java

@@ -84,6 +84,8 @@
 import org.springframework.data.mongodb.core.convert.MongoWriter;
 import org.springframework.data.mongodb.core.convert.QueryMapper;
 import org.springframework.data.mongodb.core.convert.UpdateMapper;
+import org.springframework.data.mongodb.core.index.IndexOperations;
+import org.springframework.data.mongodb.core.index.IndexOperationsProvider;
 import org.springframework.data.mongodb.core.index.MongoMappingEventPublisher;
 import org.springframework.data.mongodb.core.index.MongoPersistentEntityIndexCreator;
 import org.springframework.data.mongodb.core.mapping.MongoMappingContext;
@@ -102,6 +104,7 @@
 import org.springframework.data.mongodb.core.mapreduce.GroupByResults;
 import org.springframework.data.mongodb.core.mapreduce.MapReduceOptions;
 import org.springframework.data.mongodb.core.mapreduce.MapReduceResults;
+import org.springframework.data.mongodb.core.query.Collation;
 import org.springframework.data.mongodb.core.query.Criteria;
 import org.springframework.data.mongodb.core.query.Meta;
 import org.springframework.data.mongodb.core.query.NearQuery;
@@ -612,8 +615,8 @@ public boolean exists(Query query, Class<?> entityClass, String collectionName)
 
 		Document mappedQuery = queryMapper.getMappedObject(query.getQueryObject(), getPersistentEntity(entityClass));
 
-		return execute(collectionName, new ExistsCallback(mappedQuery,
-				query.getCollation().map(org.springframework.data.mongodb.core.Collation::toMongoCollation).orElse(null)));
+		return execute(collectionName,
+				new ExistsCallback(mappedQuery, query.getCollation().map(Collation::toMongoCollation).orElse(null)));
 	}
 
 	// Find methods that take a Query to express the query and that return a List of objects.

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/ReactiveMongoTemplate.java

@@ -56,6 +56,7 @@
 import org.springframework.data.mapping.model.ConvertingPropertyAccessor;
 import org.springframework.data.mongodb.MongoDbFactory;
 import org.springframework.data.mongodb.ReactiveMongoDatabaseFactory;
+import org.springframework.data.mongodb.core.query.Collation;
 import org.springframework.data.mongodb.core.convert.DbRefProxyHandler;
 import org.springframework.data.mongodb.core.convert.DbRefResolver;
 import org.springframework.data.mongodb.core.convert.DbRefResolverCallback;

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/AggregationOptions.java

@@ -18,7 +18,7 @@
 import java.util.Optional;
 
 import org.bson.Document;
-import org.springframework.data.mongodb.core.Collation;
+import org.springframework.data.mongodb.core.query.Collation;
 import org.springframework.util.Assert;
 
 import com.mongodb.DBObject;