Queries can now be cached with cacheResults() (#76)

* Queries generated by a query builder class can now be cached w/ cacheResults()

* Deleted some demo code in QueryBuilder.cls

* Added caching to AggregateResultQueryBuilder.cls

* Added a caching test to AggregateResultQueryBuilder_Tests.cls

* Stupid missing

line break

* Added some additional query builder tests

* Reverted a method name change

* Added exclude_paths to .codeclimate.yml so test classes aren't checked

* Updated the code climate exclude_paths value

Author: jongpie

.codeclimate.yml

@@ -3,7 +3,8 @@ engines:
         enabled: true
         config:
             rulesets: "./tools/codeclimate/apex/apexunit.xml,./tools/codeclimate/apex/complexity.xml,./tools/codeclimate/apex/performance.xml,./tools/codeclimate/apex/security.xml,./tools/codeclimate/apex/style.xml"
-        enabled: true
+        exclude_paths:
+            - "**Tests.cls"
 ratings:
     paths:
         - "**.cls"

src/classes/AggregateResultQueryBuilder.cls

@@ -23,6 +23,11 @@ public class AggregateResultQueryBuilder extends QueryBuilder implements IAggreg
         this.groupByList           = new List<String>();
     }
 
+    public IAggregateResultQueryBuilder cacheResults() {
+        super.doCacheResults();
+        return this;
+    }
+
     public IAggregateResultQueryBuilder groupBy(IQueryField groupByQueryField) {
         return this.groupBy(new List<IQueryField>{groupByQueryField});
     }

src/classes/AggregateResultQueryBuilder_Tests.cls

@@ -5,6 +5,36 @@
 @isTest
 private class AggregateResultQueryBuilder_Tests {
 
+
+    @isTest
+    static void it_should_be_usable_after_construction() {
+        // Query builders should be usable as soon as it's constructed - it should be able to execute a query with some default values
+        IAggregateResultQueryBuilder aggregateQueryBuilder = new AggregateResultQueryBuilder(Schema.Opportunity.SObjectType);
+
+        Test.startTest();
+
+        List<AggregateResult> results = (List<AggregateResult>)aggregateQueryBuilder.getQueryResults();
+
+        Test.stopTest();
+    }
+
+    @isTest
+    static void it_should_cache_results() {
+        IAggregateResultQueryBuilder aggregateResultQueryBuilder = new AggregateResultQueryBuilder(Schema.Opportunity.SObjectType);
+        aggregateResultQueryBuilder.cacheResults();
+
+        Test.startTest();
+
+        System.assertEquals(0, Limits.getQueries());
+        for(Integer i = 0; i < 10; i++) {
+            System.debug(aggregateResultQueryBuilder.getQueryResults());
+        }
+
+        System.assertEquals(1, Limits.getQueries());
+
+        Test.stopTest();
+    }
+
     @isTest
     static void it_should_build_a_ridiculous_query_string() {
         String expectedString = 'SELECT Type,\nAVG(Amount) AVG__Amount, COUNT(AccountId) COUNT__AccountId, '

src/classes/IAggregateResultQueryBuilder.cls

@@ -12,6 +12,8 @@
 */
 public interface IAggregateResultQueryBuilder {
 
+    IAggregateResultQueryBuilder cacheResults();
+
     // Group By methods
     IAggregateResultQueryBuilder groupBy(IQueryField groupByQueryField);
     IAggregateResultQueryBuilder groupBy(List<IQueryField> groupByQueryFields);

src/classes/ISObjectQueryBuilder.cls

@@ -12,6 +12,8 @@
 */
 public interface ISObjectQueryBuilder {
 
+    ISObjectQueryBuilder cacheResults();
+
     // Field methods
     ISObjectQueryBuilder addAllFields();
     ISObjectQueryBuilder addAllStandardFields();

src/classes/ISearchQueryBuilder.cls

@@ -1,5 +1,7 @@
 public interface ISearchQueryBuilder {
 
+    ISearchQueryBuilder cacheResults();
+
     ISearchQueryBuilder setQuerySearchGroup(QuerySearchGroup searchGroup);
 
     String getQuery();

src/classes/QueryBuilder.cls

@@ -12,18 +12,28 @@
 */
 public abstract class QueryBuilder extends NebulaCore {
 
+    private static Map<Integer, List<SObject>> cachedQueryResultsByHashCode        = new Map<Integer, List<SObject>>();
+    private static Map<Integer, List<List<SObject>>> cachedSearchResultsByHashCode = new Map<Integer, List<List<SObject>>>();
+
     protected List<String> whereClauseList;
     protected List<String> orderByList;
     protected Integer limitCount;
 
     protected SObjectType sobjectType;
     protected Map<String, Schema.SObjectField> sobjectTypeFieldMap;
 
+    private Boolean cacheResults;
+
     public QueryBuilder() {
         this.currentModule = NebulaCore.Module.QUERY_BUILDER;
 
-        this.whereClauseList          = new List<String>();
-        this.orderByList              = new List<String>();
+        this.whereClauseList = new List<String>();
+        this.orderByList     = new List<String>();
+        this.cacheResults    = false;
+    }
+
+    protected void doCacheResults() {
+        this.cacheResults = true;
     }
 
     protected void doFilterBy(IQueryFilter queryFilter) {
@@ -83,19 +93,13 @@ public abstract class QueryBuilder extends NebulaCore {
     }
 
     protected List<SObject> doGetQueryResults(String query) {
-        List<SObject> results = Database.query(query);
-
-        this.logResults(query, results);
-
-        return results;
+        if(this.cacheResults) return this.getCachedQuery(query);
+        else return this.executeQuery(query);
     }
 
     protected List<List<SObject>> doGetSearchResults(String query) {
-        List<List<SObject>> results = Search.query(query);
-
-        this.logResults(query, results);
-
-        return results;
+        if(this.cacheResults) return this.getCachedSearch(query);
+        else return this.executeSearch(query);
     }
 
     private void filterByWithSeparator(List<IQueryFilter> queryFilters, String separator) {
@@ -108,6 +112,41 @@ public abstract class QueryBuilder extends NebulaCore {
         this.whereClauseList.add(orStatement);
     }
 
+    private List<SObject> getCachedQuery(String query) {
+        Integer hashCode = query.hashCode();
+
+        Boolean isCached = cachedQueryResultsByHashCode.containsKey(hashCode);
+        if(!isCached) cachedQueryResultsByHashCode.put(hashCode, this.executeQuery(query));
+
+        // Always return a deep clone so the original cached version is never modified
+        return cachedQueryResultsByHashCode.get(hashCode).deepClone(true, true, true);
+    }
+
+    private List<SObject> executeQuery(String query) {
+        List<SObject> results = Database.query(query);
+        this.logResults(query, results);
+        return results;
+    }
+
+    private List<List<SObject>> getCachedSearch(String query) {
+        Integer hashCode = query.hashCode();
+
+        Boolean isCached = cachedSearchResultsByHashCode.containsKey(hashCode);
+        if(!isCached) cachedSearchResultsByHashCode.put(hashCode, this.executeSearch(query));
+
+        // Always return a deep clone so the original cached version is never modified
+        List<List<SObject>> cachedResults = cachedSearchResultsByHashCode.get(hashCode);
+        List<List<SObject>> deepClonedResults = new List<List<SObject>>();
+        for(List<SObject> cachedListOfResults : cachedResults) deepClonedResults.add(cachedListOfResults.deepClone(true, true, true));
+        return deepClonedResults;
+    }
+
+    private List<List<SObject>> executeSearch(String query) {
+        List<List<SObject>> results = Search.query(query);
+        this.logResults(query, results);
+        return results;
+    }
+
     private void logResults(String query, List<Object> results) {
         String logEntry = 'Query:\n' + query + '\n\nResults:\n' + JSON.serializePretty(results);
         Logger.addEntry(this, logEntry);

src/classes/SObjectQueryBuilder.cls

@@ -30,6 +30,11 @@ public class SObjectQueryBuilder extends QueryBuilder implements ISObjectQueryBu
         this.addCommonQueryFields();
     }
 
+    public ISObjectQueryBuilder cacheResults() {
+        super.doCacheResults();
+        return this;
+    }
+
     public ISObjectQueryBuilder addFields(List<IQueryField> queryFields) {
         for(IQueryField queryField : queryFields) this.addField(queryField);
         return this;

src/classes/SObjectQueryBuilder_Tests.cls

@@ -59,6 +59,35 @@ private class SObjectQueryBuilder_Tests {
         return queryFields;
     }
 
+    @isTest
+    static void it_should_be_usable_after_construction() {
+        // Query builders should be usable as soon as it's constructed - it should be able to execute a query with some default values
+        ISObjectQueryBuilder opportunityQueryBuilder = new SObjectQueryBuilder(Schema.Opportunity.SObjectType);
+
+        Test.startTest();
+
+        List<Opportunity> results = (List<Opportunity>)opportunityQueryBuilder.getQueryResults();
+
+        Test.stopTest();
+    }
+
+    @isTest
+    static void it_should_cache_results() {
+        ISObjectQueryBuilder opportunityQueryBuilder = new SObjectQueryBuilder(Schema.Opportunity.SObjectType);
+        opportunityQueryBuilder.cacheResults();
+
+        Test.startTest();
+
+        System.assertEquals(0, Limits.getQueries());
+        for(Integer i = 0; i < 10; i++) {
+            System.debug(opportunityQueryBuilder.getQueryResults());
+        }
+
+        System.assertEquals(1, Limits.getQueries());
+
+        Test.stopTest();
+    }
+
     @isTest
     static void it_should_add_a_list_of_fields() {
         NebulaSettings.SObjectQueryBuilderSettings.IncludeCommonFields__c = false;

src/classes/SObjectRecordTypes.cls

@@ -12,24 +12,18 @@
 */
 public abstract class SObjectRecordTypes extends NebulaCore implements ISObjectRecordTypes {
 
-    private static Map<String, List<RecordType>> cachedRecordTypesBySObjectMap = new Map<String, List<RecordType>>();
-
     private String sobjectName;
 
     public SObjectRecordTypes() {
         this.currentModule = NebulaCore.Module.RECORD_TYPES;
 
         this.sobjectName = this.getSObjectType().getDescribe().getName();
-
-        Logger.addEntry(this, 'Getting record types for ' + this.sobjectName);
-
-        this.populateCache();
     }
 
     public abstract Schema.SObjectType getSObjectType();
 
     public Map<Id, RecordType> getAllById() {
-        return new Map<Id, RecordType>(cachedRecordTypesBySObjectMap.get(this.sobjectName));
+        return new Map<Id, RecordType>(getRecordTypes());
     }
 
     public Map<String, RecordType> getAllByDeveloperName() {
@@ -43,14 +37,9 @@ public abstract class SObjectRecordTypes extends NebulaCore implements ISObjectR
         return allRecordTypesByDeveloperName;
     }
 
-    // TODO clean up all this mess for cache, getRecordTypes, getAllRecordTypesByDeveloperName, etc
-    // Too many similarly named methods going on
-    private void populateCache() {
-        if(cachedRecordTypesBySObjectMap.containsKey(this.sobjectName)) return;
-
-        // Trying to call Schema.RecordType.SObjectType confuses Apex, so we have to get it through an extra describe call
+    private List<RecordType> getRecordTypes() {
         Schema.SObjectType recordTypeSObjectType = Schema.SObjectType.RecordType.getSObjectType();
-        ISObjectQueryBuilder query = new SObjectQueryBuilder(recordTypeSObjectType);
+        ISObjectQueryBuilder query = new SObjectQueryBuilder(recordTypeSObjectType).orderBy(new QueryField(Schema.RecordType.DeveloperName));
 
         // If we don't have the SObject cached, then we need to query
         if(NebulaSettings.RecordTypesSettings.LazyLoad__c) {
@@ -63,15 +52,9 @@ public abstract class SObjectRecordTypes extends NebulaCore implements ISObjectR
             query.filterBy(new QueryFilter().filterByField(new QueryField(Schema.RecordType.NamespacePrefix), QueryOperator.EQUALS, null));
         }
 
-        query.orderBy(new QueryField(Schema.RecordType.DeveloperName));
-
         Logger.addEntry(this, 'Loading SObjectRecordTypes for=' + this.getSObjectType());
 
-        if(!cachedRecordTypesBySObjectMap.containsKey(this.sobjectName)) cachedRecordTypesBySObjectMap.put(this.sobjectName, new List<RecordType>());
-        List<RecordType> recordTypeList = (List<RecordType>)query.getQueryResults();
-        for(RecordType recordType : recordTypeList) cachedRecordTypesBySObjectMap.get(this.sobjectName).add(recordType);
-
-        Logger.addEntry(this, 'cachedRecordTypesBySObjectMap=' + cachedRecordTypesBySObjectMap);
+        return (List<RecordType>)query.cacheResults().getQueryResults();
     }
 
 }