Merge pull request apex-enterprise-patterns#74 from Autobat/master

apex-enterprise-patterns#18 - addition of afterUndelete within the fflib_SObjectDomain

Author: afawcett

fflib/src/classes/fflib_SObjectDomain.cls

@@ -138,6 +138,11 @@ public virtual with sharing class fflib_SObjectDomain
 	 **/    
     public virtual void onAfterDelete() { }	
 
+	/**
+	 * Override this to perform processing during the after undelete phase, this is called by the handleAfterDelete method
+	 **/    
+    public virtual void onAfterUndelete() { }	
+	
 	/**
 	 * Base handler for the Apex Trigger event Before Insert, calls the onApplyDefaults method, followed by onBeforeInsert
 	 **/
@@ -206,6 +211,19 @@ public virtual with sharing class fflib_SObjectDomain
     	onAfterDelete();
     }	
 
+    /**
+     * Base handler for the Apex Trigger event After Undelete, checks object security and calls the onAfterUndelete method
+     *
+     * @throws DomainException if the current user context is not able to delete records
+     **/
+    public void handleAfterUndelete() 
+    {
+    	if(Configuration.EnforcingTriggerCRUDSecurity && !SObjectDescribe.isCreateable())
+    	   throw new DomainException('Permission to create an ' + SObjectDescribe.getName() + ' denied.');
+    	   
+    	onAfterUndelete();
+    }	
+
     /**
      * Returns the SObjectType this Domain class represents
      **/
@@ -274,6 +292,7 @@ public virtual with sharing class fflib_SObjectDomain
 				Trigger.isInsert, 
 				Trigger.isUpdate, 
 				Trigger.isDelete, 
+				Trigger.isUnDelete,
 				Trigger.new, 
 				Trigger.oldMap);
 		}
@@ -282,7 +301,7 @@ public virtual with sharing class fflib_SObjectDomain
 	/**
 	 * Calls the applicable override methods such as beforeInsert, beforeUpdate etc. based on a Trigger context
 	 **/
-	private static void triggerHandler(Type domainClass, Boolean isBefore, Boolean isAfter, Boolean isInsert, Boolean isUpdate, Boolean isDelete, List<SObject> newRecords, Map<Id, SObject> oldRecordsMap)
+	private static void triggerHandler(Type domainClass, Boolean isBefore, Boolean isAfter, Boolean isInsert, Boolean isUpdate, Boolean isDelete, Boolean isUndelete, List<SObject> newRecords, Map<Id, SObject> oldRecordsMap)
 	{	
 		// After phase of trigger will reuse prior instance of domain class if ITriggerStateful implemented 
 		fflib_SObjectDomain domainObject = isBefore ? null : popTriggerInstance(domainClass, isDelete ? oldRecordsMap.values() : newRecords);
@@ -297,6 +316,7 @@ public virtual with sharing class fflib_SObjectDomain
 	        if(isInsert) domainObject = domainConstructor.construct(newRecords);
 	        else if(isUpdate) domainObject = domainConstructor.construct(newRecords);
 	        else if(isDelete) domainObject = domainConstructor.construct(oldRecordsMap.values());
+	        else if(isUndelete) domainObject = domainConstructor.construct(newRecords);
 
 	        // Should this instance be reused on the next trigger invocation?
 	        if(domainObject.Configuration.TriggerStateEnabled)
@@ -316,6 +336,7 @@ public virtual with sharing class fflib_SObjectDomain
 	        if(isInsert) domainObject.handleAfterInsert();
 	        else if(isUpdate) domainObject.handleAfterUpdate(oldRecordsMap);
 	        else if(isDelete) domainObject.handleAfterDelete();
+	        else if(isUndelete) domainObject.handleAfterUndelete();
 	    }				
 	}
 
@@ -560,6 +581,7 @@ public virtual with sharing class fflib_SObjectDomain
 		private Boolean isInsert = false;
 		private Boolean isUpdate = false;
 		private Boolean isDelete = false;
+		private Boolean isUndelete = false;
 		private List<SObject> records = new List<SObject>();
 		private Map<Id, SObject> oldRecords = new Map<Id, SObject>();
 
@@ -571,17 +593,18 @@ public virtual with sharing class fflib_SObjectDomain
 		private void testTriggerHandler(Type domainClass)
 		{
 			// Mock Before
-			triggerHandler(domainClass, true, false, isInsert, isUpdate, isDelete, records, oldRecords);
+			triggerHandler(domainClass, true, false, isInsert, isUpdate, isDelete, isUndelete, records, oldRecords);
 
 			// Mock After
-			triggerHandler(domainClass, false, true, isInsert, isUpdate, isDelete, records, oldRecords);
+			triggerHandler(domainClass, false, true, isInsert, isUpdate, isDelete, isUndelete, records, oldRecords);
 		}
 
 		public void onInsert(List<SObject> records)
 		{
 			this.isInsert = true;
 			this.isUpdate = false;
 			this.isDelete = false;
+			this.isUndelete = false;
 			this.records = records;
 		}
 
@@ -591,6 +614,7 @@ public virtual with sharing class fflib_SObjectDomain
 			this.isUpdate = true;
 			this.isDelete = false;
 			this.records = records;
+			this.isUndelete = false;
 			this.oldRecords = oldRecords;
 		}
 
@@ -599,9 +623,19 @@ public virtual with sharing class fflib_SObjectDomain
 			this.isInsert = false;
 			this.isUpdate = false;
 			this.isDelete = true;
+			this.isUndelete = false;
 			this.oldRecords = records;
 		}
 
+		public void onUndelete(List<SObject> records)
+		{
+			this.isInsert = false;
+			this.isUpdate = false;
+			this.isDelete = false;
+			this.isUndelete = true;
+			this.records = records;
+		}
+		
 		public Boolean hasRecords()
 		{
 			return records!=null && records.size()>0 || oldRecords!=null && oldRecords.size()>0;
@@ -676,6 +710,12 @@ public virtual with sharing class fflib_SObjectDomain
 			}			
 		}
 
+		public override void onAfterUndelete()
+		{
+			// Not required in production code
+			super.onAfterUndelete();
+		}
+		
 		public override void onBeforeInsert()
 		{
 			// Assert this variable is null in the after insert (since this domain class is stateless)

fflib/src/classes/fflib_SObjectDomainTest.cls

@@ -82,6 +82,18 @@ private with sharing class fflib_SObjectDomainTest
 		System.assertEquals('You cannot delete this Opportunity.', fflib_SObjectDomain.Errors.getAll()[0].message);
 	}
 
+	@IsTest
+	private static void testOnAfterUndeleteWithoutDML()
+	{
+		Opportunity opp = (Opportunity) Opportunity.sObjectType.newSObject('006E0000006mkRQ'); 
+		opp.Name = 'Test';
+		opp.Type = 'Existing Account';
+		System.assertEquals(false, fflib_SObjectDomain.Test.Database.hasRecords());		
+		fflib_SObjectDomain.Test.Database.onUndelete(new list<Opportunity> { opp } );		
+		System.assertEquals(true, fflib_SObjectDomain.Test.Database.hasRecords());				
+		fflib_SObjectDomain.triggerHandler(fflib_SObjectDomain.TestSObjectDomainConstructor.class);		
+	}
+	
 	@IsTest
 	private static void testObjectSecurity()
 	{