Merge branch 'master' into master

Author: cdelfattore

README.md

@@ -15,6 +15,7 @@ Updates
 =======
 
 - **December 2022**, **IMPORTANT CHANGE** - Support for native Apex User Mode was added to the library (see [discussion](https://github.com/apex-enterprise-patterns/fflib-apex-common/discussions/419)). For new projects, the old `enforceCRUD` and `enforceFLS` flags on `fflib_SObjectSelector` should be considered deprecated and the constructors that take `dataAccess` arguments should be used instead. Additionally, the introduction of `fflib_SObjectUnitOfWork.UserModeDML` provides an `IDML` implementation that supports `USER_MODE` or `SYSTEM_MODE`. `fflib_SObjectUnitOfWork.SimpleDML` (the default `IDML` implementation) should be considered deprecated. There are measurable performance benefits to using `SYSTEM_MODE` and `USER_MODE` (Apex CPU usage reduction). Additionally, the use of explicit `USER_MODE` and `SYSTEM_MODE` overrides the `with sharing` and `without sharing` class declaration and makes the expected behavior of DML and SOQL easier to understand.
+- **April 2021**, **IMPORTANT CHANGE**, the fflib_SObjectDomain has been split into a domain (fflib_IDomain) and triggerhandler (fflib_ISObjectDomain). This change can impact existing projects, please review [this page](docs/202105-new-domain-structure.md) for more details.
 - **April 2020**, **IMPORTANT CHANGE**, the directory format of this project repo was converted to [Salesforce DX Source Format](https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_source_file_format.htm).  While the GIT commit history was maintained, it is not visible on GitHub.  If you need to see the history, either clone the repo and execute `git log --follow` from the command line or refer to this [tag](https://github.com/apex-enterprise-patterns/fflib-apex-common/tree/metadata-format-prior-to-dx-source-format-conversion) of the codebase prior to conversion.
 - **September 2014**, **IMPORTANT CHANGE**, changes applied to support Dreamforce 2014 advanced presentation, library now provides Application factories for major layers and support for ApexMocks. More details to follow! As a result [ApexMocks](https://github.com/apex-enterprise-patterns/fflib-apex-mocks) must be deployed to the org before deploying this library. The sample application [here](https://github.com/apex-enterprise-patterns/fflib-apex-common-samplecode) has also been updated to demonstrate the new features!
 - **July 2014**, **IMPORTANT CHANGE**, prior **23rd July 2014**, both the ``fflib_SObjectDomain.onValidate()`` and ``fflib_SObjectDomain.onValidate(Map<Id, SObject> existingRecords)`` methods where called during an on **after update** trigger event. From this point on the ``onValidate()`` method will only be called during on **after insert**. If you still require the orignal behaviour add the line ``Configuration.enableOldOnUpdateValidateBehaviour();`` into your constructor.

docs/202105-new-domain-structure.md

@@ -0,0 +1,57 @@
+# New domain structure
+The new domain structure allows more flexibility of the object type a domain can contain. 
+This allows for the creation of compound-domains and domains of data-classes. 
+
+It also splits the functionality into a Domain Model [as described by Martin Fowler](https://www.martinfowler.com/eaaCatalog/domainModel.html) and a separate trigger handler. 
+This helps to structure the code better and makes it more clear which Apex code should be in the domain and which in the trigger handler.
+
+
+
+## Previous interface and implementation structure
+| Interfaces | Implementation | Description |
+|:---|:---|:---|
+| fflib_ISObjectDomain | fflib_SObjectDomain | Used as Domain and trigger handler 
+
+
+## New interface and implementation structure
+| Interfaces | Implementation | Description |
+|:---|:---|:---|
+| fflib_IDomain | | Generic identifier for domains
+| fflib_IObjects | fflib_Objects | Domains constructed with Objects, e.g. data-classes 
+| fflib_ISObjects | fflib_SObjects | Domain containing SObjectTypes, e.g. Accounts, Contacts
+| fflib_ISObjectDomain | fflib_SObjectDomain | Used for trigger handlers and for legacy domains
+
+See [this PR](https://github.com/apex-enterprise-patterns/fflib-apex-common/pull/300) for a detailed overview 
+of all the code changes which were part of this change.
+
+The [fflib-apex-common-samplecode](https://github.com/apex-enterprise-patterns/fflib-apex-common-samplecode)
+also includes examples on how to structure the change into the 
+[new domain](https://github.com/apex-enterprise-patterns/fflib-apex-common-samplecode/blob/master/sfdx-source/apex-common-samplecode/main/classes/domains/Accounts.cls)
+and [trigger handler](https://github.com/apex-enterprise-patterns/fflib-apex-common-samplecode/blob/master/sfdx-source/apex-common-samplecode/main/classes/triggerHandlers/OpportunitiesTriggerHandler.cls)
+
+## Known issues and how to resolve them
+
+
+### _Issue:_ Ambiguous method signature: void setMock(MyDomainClass)
+This happens when you try to mock an old domain class which is extended from fflib_SObjectDomain. 
+```apex
+Application.Domain.setMock(mockAssetsDomain);   // <<== generates Ambiguous method signature: void setMock
+```
+The issue can be resolved by casting the mock implementation to fflib_ISObjectDomain:
+> Application.Domain.setMock( **(fflib_ISObjectDomain)** mockAssetsDomain);  
+
+[See this issue report for more information](https://github.com/apex-enterprise-patterns/fflib-apex-common/issues/347)
+
+
+### _Issue:_ Illegal assignment from fflib_Domain to fflib_ISObjectDomain
+The `newInstance` method signature of the Application Domain Factory (fflib_Application.DomainFactory) has changed into:
+>public **fflib_IDomain** newInstance(***);
+
+If you have:
+```apex
+fflib_ISObjectDomain domain =  Application.Domain.newInstance(sObjIds);	
+```
+You need to change that into:
+> fflib_ISObjectDomain domain = **(fflib_ISObjectDomain)** Application.Domain.newInstance(sObjIds);	
+
+[See this issue report for more information](https://github.com/apex-enterprise-patterns/fflib-apex-common/issues/346)

sfdx-source/apex-common/main/classes/fflib_Application.cls

@@ -86,7 +86,7 @@ public virtual class fflib_Application
 		 *   if set via the setMock method
 		 *
 		 * @remark If mock is set, the list of SObjectType in the mock could be different
-		 *         then the list of SObjectType specified in this method call
+		 *         than the list of SObjectType specified in this method call
 		 **/
 		public virtual fflib_ISObjectUnitOfWork newInstance(List<SObjectType> objectTypes)
 		{
@@ -102,7 +102,7 @@ public virtual class fflib_Application
 		 *   if set via the setMock method
 		 *
 		 * @remark If mock is set, the list of SObjectType in the mock could be different
-		 *         then the list of SObjectType specified in this method call
+		 *         than the list of SObjectType specified in this method call
 		 **/
 		public virtual fflib_ISObjectUnitOfWork newInstance(List<SObjectType> objectTypes, fflib_SObjectUnitOfWork.IDML dml)
 		{
@@ -139,7 +139,7 @@ public virtual class fflib_Application
 		 *   Note that this will not check the Apex Classes given actually implement the interfaces
 		 *     as this information is not presently available via the Apex runtime
 		 *
-		 * @param serviceInterfaceTypeByServiceImplType Map ofi interfaces to classes
+		 * @param serviceInterfaceTypeByServiceImplType Map of interfaces to classes
 		 **/
 		public ServiceFactory(Map<Type, Type> serviceInterfaceTypeByServiceImplType)
 		{
@@ -189,11 +189,11 @@ public virtual class fflib_Application
 		public SelectorFactory() { }
 
 		/**
-		 * Consturcts a Selector Factory linking SObjectType's with Apex Classes implement the fflib_ISObjectSelector interface
+		 * Constructs a Selector Factory linking SObjectType's with Apex Classes implement the fflib_ISObjectSelector interface
 		 *   Note that the factory does not check the given Apex Classes implement the interface
 		 *     currently this is not possible in Apex.
 		 *
-		 * @Param sObjectBySelectorType Map of SObjectType's to Selector Apex Classes
+		 * @param sObjectBySelectorType Map of SObjectType's to Selector Apex Classes
 		 **/
 		public SelectorFactory(Map<SObjectType, Type> sObjectBySelectorType)
 		{

sfdx-source/apex-common/main/classes/fflib_ISObjectUnitOfWork.cls

@@ -215,7 +215,7 @@ public interface fflib_ISObjectUnitOfWork
      **/
     void commitWork();
     /**
-     * Register a generic peace of work to be invoked during the commitWork phase
+     * Register a generic piece of work to be invoked during the commitWork phase
      *
      * @param work Work to be registered
      **/

sfdx-source/apex-common/main/classes/fflib_StringBuilder.cls

@@ -27,7 +27,7 @@
 /**
  * Helper class, roughly based on the Java version, but subclassed to assist in a number of use cases in this library
  * 
- * NOTE: Aspects of this where developed before recent improvements to String handling, as such could likely be enhanced at this stage.
+ * NOTE: Aspects of this were developed before recent improvements to String handling, as such could likely be enhanced at this stage.
  **/
 public virtual class fflib_StringBuilder
 {

sfdx-source/apex-common/test/classes/fflib_SObjectSelectorTest.cls

@@ -709,27 +709,27 @@ private with sharing class fflib_SObjectSelectorTest
 	static void toSOQL_When_PolymorphicSelect_Expect_RelatedType() {
 		//Given		
 
-		CampaignMemberSelector cmSelector = new CampaignMemberSelector(fflib_SObjectSelector.DataAccess.LEGACY);
-		fflib_QueryFactory qf = cmSelector.newQueryFactory();
-		new LeadSelector().configureQueryFactoryFields(qf, 'Lead');
-		new UserSelector().configureQueryFactoryFields(qf, 'Lead.Owner');
+		CaseCommentSelector ccSelector = new CaseCommentSelector(fflib_SObjectSelector.DataAccess.LEGACY);
+		fflib_QueryFactory qf = ccSelector.newQueryFactory();
+		new CaseSelector().configureQueryFactoryFields(qf, 'Parent');
+		new UserSelector().configureQueryFactoryFields(qf, 'Parent.Owner');
 
 
 		Set<String> expectedSelectFields = new Set<String>{
-				'Id', 'Status', 'Lead.Id', 'Lead.OwnerId', 'Lead.Owner.Id', 'Lead.Owner.UserRoleId'
+				'Id', 'CommentBody', 'Parent.Id', 'Parent.OwnerId', 'Parent.Owner.Id', 'Parent.Owner.UserRoleId'
 		};
 		if (UserInfo.isMultiCurrencyOrganization()) {
 			expectedSelectFields.add('CurrencyIsoCode');
-			expectedSelectFields.add('Lead.CurrencyIsoCode');
-			expectedSelectFields.add('Lead.Owner.CurrencyIsoCode');  // Because the Selector is for User; Group would not have
+			expectedSelectFields.add('Parent.CurrencyIsoCode');
+			expectedSelectFields.add('Parent.Owner.CurrencyIsoCode');  // Because the Selector is for User; Group would not have
 		}
 
 		//When
 		String soql = qf.toSOQL();
 
 		//Then
-		Pattern soqlPattern = Pattern.compile(String.format('SELECT (.*) FROM CampaignMember ORDER BY {0} ASC NULLS FIRST ',
-		new List<String>{cmSelector.getOrderBy()}));
+		Pattern soqlPattern = Pattern.compile(String.format('SELECT (.*) FROM CaseComment ORDER BY {0} ASC NULLS FIRST ',
+		new List<String>{ccSelector.getOrderBy()}));
 		Matcher soqlMatcher = soqlPattern.matcher(soql);
 		soqlMatcher.matches();
 
@@ -741,29 +741,29 @@ private with sharing class fflib_SObjectSelectorTest
 	static void toSOQL_When_PolymorphicSelectInMulticurrency_Expect_RelatedType() {
 		//Given
 
-		CampaignMemberSelector cmSelector = new CampaignMemberSelector(fflib_SObjectSelector.DataAccess.LEGACY);
-		fflib_QueryFactory qf = cmSelector.newQueryFactory();
-		new LeadSelector().configureQueryFactoryFields(qf, 'Lead');
-		new GroupSelector().configureQueryFactoryFields(qf, 'Lead.Owner');
+		CaseCommentSelector ccSelector = new CaseCommentSelector(fflib_SObjectSelector.DataAccess.LEGACY);
+		fflib_QueryFactory qf = ccSelector.newQueryFactory();
+		new CaseSelector().configureQueryFactoryFields(qf, 'Parent');
+		new GroupSelector().configureQueryFactoryFields(qf, 'Parent.Owner');
 
 
 		Set<String> expectedSelectFields = new Set<String>{
-			'Id', 'Status', 'Lead.Id', 'Lead.OwnerId', 'Lead.Owner.Id'
+			'Id', 'CommentBody', 'Parent.Id', 'Parent.OwnerId', 'Parent.Owner.Id'
 		};
 		Set<String> unexpectedSelectFields = new Set<String>();
 		if (UserInfo.isMultiCurrencyOrganization()) {
 			expectedSelectFields.add('CurrencyIsoCode');
-			expectedSelectFields.add('Lead.CurrencyIsoCode');
+			expectedSelectFields.add('Parent.CurrencyIsoCode');
 
-			unexpectedSelectFields.add('Lead.Owner.CurrencyIsoCode'); // Because Group does NOT have CurrencyIsoCode
+			unexpectedSelectFields.add('Parent.Owner.CurrencyIsoCode'); // Because Group does NOT have CurrencyIsoCode
 		}
 
 		//When
 		String soql = qf.toSOQL();
 		System.debug(soql);
 
 		//Then
-		Pattern soqlPattern = Pattern.compile('SELECT (.*) FROM CampaignMember ORDER BY CreatedDate ASC NULLS FIRST ');
+		Pattern soqlPattern = Pattern.compile('SELECT (.*) FROM CaseComment ORDER BY CreatedDate ASC NULLS FIRST ');
 		Matcher soqlMatcher = soqlPattern.matcher(soql);
 		soqlMatcher.matches();
 
@@ -780,30 +780,30 @@ private with sharing class fflib_SObjectSelectorTest
 
 	@IsTest
 	static void toSOQL_When_SystemModePolymorphicSelect_Expect_RelatedType() {
-		CampaignMemberSelector cmSelector = new CampaignMemberSelector(fflib_SObjectSelector.DataAccess.SYSTEM_MODE);
-		fflib_QueryFactory qf = cmSelector.newQueryFactory();
-		new LeadSelector().configureQueryFactoryFields(qf, 'Lead');
-		new UserSelector().configureQueryFactoryFields(qf, 'Lead.Owner');
+		CaseCommentSelector ccSelector = new CaseCommentSelector(fflib_SObjectSelector.DataAccess.SYSTEM_MODE);
+		fflib_QueryFactory qf = ccSelector.newQueryFactory();
+		new CaseSelector().configureQueryFactoryFields(qf, 'Parent');
+		new UserSelector().configureQueryFactoryFields(qf, 'Parent.Owner');
 
 		List<String> expectedSelectFields = new List<String>();
 		expectedSelectFields.add('id');
-		expectedSelectFields.add('status');
+		expectedSelectFields.add('commentbody');
 		if (UserInfo.isMultiCurrencyOrganization()) {
 			expectedSelectFields.add('currencyisocode');
 		}
-		expectedSelectFields.add('lead.ownerid');
-		expectedSelectFields.add('lead.id');
+		expectedSelectFields.add('parent.ownerid');
+		expectedSelectFields.add('parent.id');
 		if (UserInfo.isMultiCurrencyOrganization()) {
-			expectedSelectFields.add('lead.currencyisocode');
+			expectedSelectFields.add('parent.currencyisocode');
 		}
-		expectedSelectFields.add('lead.owner.userroleid');
-		expectedSelectFields.add('lead.owner.id');
+		expectedSelectFields.add('parent.owner.userroleid');
+		expectedSelectFields.add('parent.owner.id');
 		if (UserInfo.isMultiCurrencyOrganization()) {
-			expectedSelectFields.add('lead.owner.currencyisocode');
+			expectedSelectFields.add('parent.owner.currencyisocode');
 		}
 
-		String expectedSOQL = String.format('SELECT ' + String.join(expectedSelectFields,', ') + ' FROM CampaignMember WITH SYSTEM_MODE ORDER BY {0} ASC NULLS FIRST ',
-			new List<String>{cmSelector.getOrderBy()});
+		String expectedSOQL = String.format('SELECT ' + String.join(expectedSelectFields,', ') + ' FROM CaseComment WITH SYSTEM_MODE ORDER BY {0} ASC NULLS FIRST ',
+			new List<String>{ccSelector.getOrderBy()});
 
 		//When
 		String actualSOQL = qf.toSOQL();
@@ -843,70 +843,70 @@ private with sharing class fflib_SObjectSelectorTest
 		Assert.areEqual(expected,aQF.toSOQL());
 	}
 
-	private class CampaignMemberSelector extends fflib_SObjectSelector {
-		public CampaignMemberSelector(DataAccess access) {
+	private class CaseCommentSelector extends fflib_SObjectSelector {
+		public CaseCommentSelector(DataAccess access) {
 			super(false, access);
 		}
 
 		public List<Schema.SObjectField> getSObjectFieldList() {
 			return new List<Schema.SObjectField>{
-					CampaignMember.Id,
-					CampaignMember.Status
+					CaseComment.Id,
+					CaseComment.CommentBody
 			};
 		}
 
 		public Schema.SObjectType getSObjectType() {
-			return CampaignMember.sObjectType;
+			return CaseComment.sObjectType;
 		}
 	}
 
-	private class UserSelector extends fflib_SObjectSelector {
-		public UserSelector() {
+	private class CaseSelector extends fflib_SObjectSelector {
+		public CaseSelector() {
 			super();
 		}
 
 		public List<Schema.SObjectField> getSObjectFieldList() {
 			return new List<Schema.SObjectField>{
-					User.UserRoleId,
-					User.Id
+					Case.OwnerId,
+					Case.Id
 			};
 		}
 
 		public Schema.SObjectType getSObjectType() {
-			return User.sObjectType;
+			return Case.sObjectType;
 		}
 	}
 
-	private class GroupSelector extends fflib_SObjectSelector {
-		public GroupSelector() {
+	private class UserSelector extends fflib_SObjectSelector {
+		public UserSelector() {
 			super();
 		}
 
 		public List<Schema.SObjectField> getSObjectFieldList() {
 			return new List<Schema.SObjectField>{
-				Group.Id
+					User.UserRoleId,
+					User.Id
 			};
 		}
 
 		public Schema.SObjectType getSObjectType() {
-			return Group.sObjectType;
+			return User.sObjectType;
 		}
 	}
 
-	private class LeadSelector extends fflib_SObjectSelector {
-		public LeadSelector() {
+	private class GroupSelector extends fflib_SObjectSelector {
+		public GroupSelector() {
 			super();
 		}
 
 		public List<Schema.SObjectField> getSObjectFieldList() {
 			return new List<Schema.SObjectField>{
-					Lead.OwnerId,
-					Lead.Id
+				Group.Id
 			};
 		}
 
 		public Schema.SObjectType getSObjectType() {
-			return Lead.sObjectType;
+			return Group.sObjectType;
 		}
 	}	
 }