nchursin / clean-code-apex-lib

Highly decomposed Apex library for clean code

Salesforce Clean Code

This library consists of several parts:

1. Trigger framework
2. Mock server
3. Logger

Each part is completely independent and can be extracted to use separately.

Trigger framework

Trigger Framework is located in app/main/triggerFramework folder.

To use the framework extend the ATrigger class. The following methods exists to be overriden:

1. protected override void initialize(List<sObject> records)
2. protected override void calculate(List<sObject> records)
3. protected override void validate(List<sObject> records)
4. protected override void preValidate(List<sObject> records)
5. protected override void afterInsert(List<sObject> records)
6. protected override void afterUpsert(List<sObject> records)
7. protected override void afterUpdate(List<sObject> records)
8. protected override void validateBeforeDelete(List<sObject> records)
9. protected override void afterDelete(List<sObject> records)
10. protected override void afterUndelete(List<sObject> records)

List<sObject> records parameter is a list of records in a trigger. These are new records for insert, update, and undelete triggers, and old records for delete triggers.

There is also a set of helper methods:

1. protected Boolean isFieldChanged(sObject record, Schema.SObjectField field);
2. protected Boolean isFieldChangedTo(sObject record, Schema.SObjectField field, Object checkValue);
3. protected Boolean isFieldChangedFrom(sObject record, Schema.SObjectField field, Object checkValue);
4. protected sObject getOldRecord(sObject record);
5. protected Object getOldFieldValue(sObject record, Schema.SObjectField field);

Finally the trigger framework supports partial trigger disablement.

1. public static void disable(Schema.SObjectType sobjType, TriggerOperation triggerOper);
2. public static void disableAll(Schema.SObjectType sobjType);
3. public static void disableAll();
4. public static void enableAll();

TriggerOperation here is a standard Salesforce TriggerOperation enum;

Example info

For usage examples take a look at the ATrigger test class.

Another word on tests: I used account object for testing, which may not suite you. In order to change this you need:

1. Create a trigger for object you want to use and paste the code from app/main/triggerFramework/triggers/TestTrigger.trigger to you newly created trigger.
2. Update the following variables in app/main/triggerFramework/tests/Test_ATrigger.cls if needed:

private static final sObject TEST_RECORD = new Account(Name = 'Test_ATrigger');
private static final String TEST_FIELD_NAME = 'Name';
private static final Object TEST_FIELD_CHANGED_VALUE = 'Changed Name';

Logger

Documenting in progress...