toAggregatedMap with relationship (#213)

Author: pgajek2

force-app/main/default/classes/main/soql-evaluator/SOQLEvaluator.cls

@@ -37,6 +37,7 @@ public inherited sharing class SOQLEvaluator {
 		Map<String, List<SObject>> toAggregatedMap(SObjectField keyField);
 		Map<String, List<SObject>> toAggregatedMap(String relationshipName, SObjectField targetKeyField);
 		Map<String, List<String>> toAggregatedMap(SObjectField keyField, SObjectField valueField);
+		Map<String, List<String>> toAggregatedMap(SObjectField keyField, String relationshipName, SObjectField targetKeyField);
 	}
 
 	public interface Mockable {
@@ -171,6 +172,10 @@ public inherited sharing class SOQLEvaluator {
 		public Map<String, List<String>> toAggregatedMap(SObjectField keyField, SObjectField valueField) {
 			return this.converter.transform(this.toList()).toAggregatedMap(keyField, valueField);
 		}
+
+		public Map<String, List<String>> toAggregatedMap(SObjectField keyField, String relationshipName, SObjectField targetKeyField) {
+			return this.converter.transform(this.toList()).toAggregatedMap(keyField, relationshipName, targetKeyField);
+		}
 	}
 
 	public class SoqlMock implements Mockable {

force-app/main/default/classes/main/soql-evaluator/SOQLEvaluator_Test.cls

@@ -559,6 +559,42 @@ private class SOQLEvaluator_Test {
 		Assert.areEqual(0, nameToDescriptions.size(), 'The size of the returned map should be 0.');
 	}
 
+	@IsTest
+	static void sObjectsToAggregatedMapWithKeyAndRelationshipValueFields() {
+		// Setup
+		insertAccountsWithParents();
+
+		// Test
+		Map<String, List<String>> nameToDescriptions = SOQLEvaluator.of([SELECT Id, Name, Parent.Name FROM Account WHERE ParentId != NULL]).toAggregatedMap(Account.Name, 'Parent', Account.Name);
+
+		// Verify
+		Assert.areEqual(2, nameToDescriptions.size(), 'The size of the returned map should be 2.');
+	}
+
+	@IsTest
+	static void sObjectsToAggregatedMapWithKeyAndRelationshipValueFieldsWithMocking() {
+		// Setup
+		SOQLEvaluator.mock('mockingQuery').thenReturn(new List<Account>{
+			new Account(Name = 'Test 1', Parent = new Account(Name = 'Parent 1')),
+			new Account(Name = 'Test 2', Parent = new Account(Name = 'Parent 2'))
+		});
+
+		// Test
+		Map<String, List<String>> parentNameToAccountNames = SOQLEvaluator.of([SELECT Id, Parent.Name FROM Account WHERE ParentId != NULL]).mockId('mockingQuery').toAggregatedMap(Account.Name, 'Parent', Account.Name);
+
+		// Verify
+		Assert.areEqual(2, parentNameToAccountNames.size(), 'The size of the returned map should be 2.');
+	}
+
+	@IsTest
+	static void sObjectsToAggregatedMapWithKeyAndRelationshipValueFieldsWhenNoRecords() {
+		// Test
+		Map<String, List<String>> parentNameToAccountNames = SOQLEvaluator.of([SELECT Id, Parent.Name FROM Account WHERE ParentId != NULL]).toAggregatedMap(Account.Name, 'Parent', Account.Name);
+
+		// Verify
+		Assert.areEqual(0, parentNameToAccountNames.size(), 'The size of the returned map should be 0.');
+	}
+
 	@IsTest
 	static void sObjectsMockStack() {
 		// Setup

force-app/main/default/classes/main/standard-soql/SOQL.cls

@@ -156,7 +156,7 @@ public virtual inherited sharing class SOQL implements Queryable {
 		Id toId();
 		Set<Id> toIds();
 		Set<Id> toIdsOf(SObjectField field);
-		Set<Id> toIdsOf(String relationshipName, SObjectField field);
+		Set<Id> toIdsOf(String relationshipName, SObjectField targetKeyField);
 		Boolean doExist();
 		String toString();
 		Object toValueOf(SObjectField fieldToExtract);
@@ -174,6 +174,7 @@ public virtual inherited sharing class SOQL implements Queryable {
 		Map<String, List<SObject>> toAggregatedMap(SObjectField keyField);
 		Map<String, List<SObject>> toAggregatedMap(String relationshipName, SObjectField targetKeyField);
 		Map<String, List<String>> toAggregatedMap(SObjectField keyField, SObjectField valueField);
+		Map<String, List<String>> toAggregatedMap(SObjectField keyField, String relationshipName, SObjectField targetKeyField);
 		Database.QueryLocator toQueryLocator();
 	}
 
@@ -1037,6 +1038,13 @@ public virtual inherited sharing class SOQL implements Queryable {
 		return this.converter.transform(this.executor.toList()).toAggregatedMap(keyField, valueField);
 	}
 
+	public Map<String, List<String>> toAggregatedMap(SObjectField keyField, String relationshipName, SObjectField targetKeyField) {
+		this.builder.fields.clearAllFields(); // other fields not needed
+		this.with(keyField);
+		this.with(relationshipName + '.' + targetKeyField.toString());
+		return this.converter.transform(this.executor.toList()).toAggregatedMap(keyField, relationshipName, targetKeyField);
+	}
+
 	public Database.QueryLocator toQueryLocator() {
 		return this.executor.toQueryLocator();
 	}
@@ -2818,6 +2826,24 @@ public virtual inherited sharing class SOQL implements Queryable {
 			return customValuesPerCustomKey;
 		}
 
+		public Map<String, List<String>> toAggregatedMap(SObjectField keyField, String relationshipName, SObjectField targetKeyField) {
+			Map<String, List<String>> customValuesPerCustomKey = new Map<String, List<String>>();
+			List<String> relationshipPathFields = relationshipName.split('\\.');
+			
+			for (SObject record : this.recordsToTransform) {
+				String key = String.valueOf(record.get(keyField));
+				String value = extractNestedFieldValue(record, relationshipPathFields, targetKeyField);
+
+				if (!customValuesPerCustomKey.containsKey(key)) {
+					customValuesPerCustomKey.put(key, new List<String>());
+				}
+
+				customValuesPerCustomKey.get(key).add(value);
+			}
+
+			return customValuesPerCustomKey;
+		}
+
 		private String extractNestedFieldValue(SObject parentRecord, List<String> relationshipPath, SObjectField targetField) {
 			SObject currentRecord = parentRecord;
 

force-app/main/default/classes/main/standard-soql/SOQL_Test.cls

@@ -4507,6 +4507,18 @@ private class SOQL_Test {
 		Assert.isTrue(result.containsKey(null), 'The result map should have a null key for empty Industry.');
 	}
 
+	@IsTest
+	static void toAggregatedMapWithCustomKeyAndCustomRelationshipValue() {
+		// Setup
+		insertAccountsWithParents();
+
+		// Test
+		Map<String, List<String>> result = SOQL.of(Account.SObjectType).toAggregatedMap(Account.Name, 'Parent', Account.Id);
+
+		// Verify
+		Assert.areEqual(4, result.size(), 'The result map should have 4 keys for each account name.');
+	}
+
 	@IsTest
 	static void toQueryLocator() {
 		// Test