selector interface (#25)

* selector interface * update documentation
beyond-the-cloud-dev · May 15, 2023 · 22cd9d4 · 22cd9d4 · vercel · May 15, 2023
1 parent dc094e2
commit 22cd9d4
Show file tree

Hide file tree

Showing 18 changed files with 161 additions and 192 deletions.
diff --git a/force-app/main/default/classes/SOQL.cls b/force-app/main/default/classes/SOQL.cls
@@ -38,6 +38,10 @@ public inherited sharing class SOQL implements Queryable {
         }
     }
 
+    public interface Selector {
+        SOQL query();
+    }
+
     public interface Queryable {
         SOQL of(SObjectType ofObject);
 

diff --git a/force-app/main/default/classes/selector/AccountSelector.cls b/force-app/main/default/classes/selector/AccountSelector.cls
@@ -1,18 +1,16 @@
-public with sharing class AccountSelector {
-    public static SOQL query {
-        get {
-            return SOQL.of(Account.SObjectType)
-                .with(new List<SObjectField>{
-                    Account.Name,
-                    Account.AccountNumber
-                })
-                .systemMode()
-                .withoutSharing();
-        }
+public with sharing class AccountSelector implements SOQL.Selector {
+    public static SOQL query() {
+        return SOQL.of(Account.SObjectType)
+            .with(new List<SObjectField>{
+                 Account.Name,
+                 Account.AccountNumber
+            })
+            .systemMode()
+            .withoutSharing();
     }
 
     public static SOQL byRecordType(String rt) {
-        return query.with(new List<SObjectField>{
+        return query().with(new List<SObjectField>{
             Account.BillingCity,
             Account.BillingCountry
         }).whereAre(SOQL.Filter.recordType().equal(rt));

diff --git a/force-app/main/default/classes/selector/ExampleController.cls b/force-app/main/default/classes/selector/ExampleController.cls
@@ -1,7 +1,7 @@
 public with sharing class ExampleController {
 
     public static List<Account> getPartnerAccounts(String accountName) {
-        return AccountSelector.query
+        return AccountSelector.query()
             .with(Account.BillingCity)
             .with(Account.BillingCountry)
             .whereAre(SOQL.FilterGroup

diff --git a/website/docs/basic-features.md b/website/docs/basic-features.md
@@ -125,7 +125,7 @@ Mocked queries won't make any SOQL's and simply return data set in method defini
 public with sharing class ExampleController {
 
     public static List<Account> getPartnerAccounts(String accountName) {
-        return AccountSelector.query
+        return AccountSelector.query()
             .with(Account.BillingCity)
             .with(Account.BillingCountry)
             .whereAre(SOQL.FilterGroup
@@ -220,20 +220,19 @@ private class ExampleControllerTest {
 Generic SOQLs can be keep in selector class.
 
 ```apex
-public inherited sharing class AccountSelector {
+public inherited sharing class AccountSelector implements SOQL.Selector {
 
-    public static SOQL query {
-        get {
-            return SOQL.of(Account.SObjectType).with(new List<SObjectField>{
+    public static SOQL query() {
+        return SOQL.of(Account.SObjectType)
+            .with(new List<SObjectField>{
                 Account.Name,
                 Account.AccountNumber
             })
             .systemMode()
             .withoutSharing();
-        }
     }
 
-    public static SOQL getByRecordType(String rtDevName) {
+    public static SOQL byRecordType(String rtDevName) {
         return query.with(new List<SObjectField>{
             Account.BillingCity,
             Account.BillingCountry
@@ -247,16 +246,14 @@ public inherited sharing class AccountSelector {
 The selector class can provide default SOQL configuration like default fields, FLS settings, and sharing rules.
 
 ```apex
-public inherited sharing class AccountSelector {
-
-    public static SOQL query {
-        get {
-            return SOQL.of(Account.SObjectType)
-                .with(new List<SObjectField>{  // default fields
-                    Account.Id,
-                    Account.Name
-                }).systemMode(); // default FLS mode
-        }
+public inherited sharing class AccountSelector implements SOQL.Selector {
+
+    public static SOQL query() {
+        return SOQL.of(Account.SObjectType)
+            .with(new List<SObjectField>{  // default fields
+                Account.Id,
+                Account.Name
+            }).systemMode(); // default FLS mode
     }
 }
 ```
diff --git a/website/docs/examples/debug.md b/website/docs/examples/debug.md
@@ -7,23 +7,21 @@ sidebar_position: 14
 See query String in debug logs.
 
 ```apex
-public inherited sharing class AccountSelector {
-
-    public static SOQL query {
-        get {
-            return SOQL.of(Account.SObjectType)
-                .with(new List<SObjectField>{
-                    Account.Id,
-                    Account.Name
-                });
-        }
+public inherited sharing class AccountSelector implements SOQL.Selector {
+
+    public static SOQL query() {
+        return SOQL.of(Account.SObjectType)
+            .with(new List<SObjectField>{
+                Account.Id,
+                Account.Name
+            });
     }
 }
 
 public with sharing class MyController {
 
     public static List<Account> getAccounts() {
-        return AccountSelector.query
+        return AccountSelector.query()
             .with(new List<SObjectField>{
                 Account.BillingCity,
                 Account.BillingCountry,

diff --git a/website/docs/examples/fls.md b/website/docs/examples/fls.md
@@ -9,24 +9,22 @@ Enforce or bypass FLS.
 `USER_MODE` is a default option. You can set `SYSTEM_MODE` for all queries by adding `.systemMode()` to selector class.
 
 ```apex
-public inherited sharing class AccountSelector {
+public inherited sharing class AccountSelector implements SOQL.Selector {
 
-    public static SOQL query {
-        get {
-            return SOQL.of(Account.SObjectType)
-                .with(new List<SObjectField>{
-                    Account.Id,
-                    Account.Name
-                })
-                .systemMode(); //default FLS mode
-        }
+    public static SOQL query() {
+        return SOQL.of(Account.SObjectType)
+            .with(new List<SObjectField>{
+                Account.Id,
+                Account.Name
+            })
+            .systemMode(); //default FLS mode
     }
 }
 
 public with sharing class MyController {
 
     public static List<Account> getAccountInSystemMode() {
-        return AccountSelector.query
+        return AccountSelector.query()
             .userMode() //override selector FLS mode
             .toList();
     }

diff --git a/website/docs/examples/group-by.md b/website/docs/examples/group-by.md
@@ -12,19 +12,17 @@ FROM Lead
 GROUP BY LeadSource
 ```
 ```apex
-public inherited sharing class LeadSelector {
+public inherited sharing class LeadSelector implements SOQL.Selector {
 
-    public static SOQL query {
-        get {
-            return SOQL.of(Lead.SObjectType);
-        }
+    public static SOQL query() {
+        return SOQL.of(Lead.SObjectType);
     }
 }
 
 public with sharing class MyController {
 
     public static List<AggregateResult> getGroupedLeads() {
-        return LeadSelector.query
+        return LeadSelector.query()
                 .with(Lead.LeadSource)
                 .groupBy(Lead.LeadSource)
                 .toAggregated();

diff --git a/website/docs/examples/limit.md b/website/docs/examples/limit.md
@@ -12,23 +12,21 @@ FROM Account
 LIMIT 1000
 ```
 ```apex
-public inherited sharing class AccountSelector {
+public inherited sharing class AccountSelector implements SOQL.Selector {
 
-    public static SQOL query {
-        get {
-            return SQOL.of(Account.SObjectType)
-                .with(new List<SObjectField>{
-                    Account.Id,
-                    Account.Name
-                });
-        }
+    public static SQOL query() {
+        return SQOL.of(Account.SObjectType)
+            .with(new List<SObjectField>{
+                Account.Id,
+                Account.Name
+            });
     }
 }
 
 public with sharing class MyController {
 
     public static List<Account> getAccountsWithLimit() {
-        return AccountSelector.query
+        return AccountSelector.query()
             .setLimit(1000)
             .toList();
     }

diff --git a/website/docs/examples/mocking.md b/website/docs/examples/mocking.md
@@ -13,7 +13,7 @@ Set mocking ID in Query declaration.
 public with sharing class ExampleController {
 
     public static List<Account> getAccountByName(String accountName) {
-        return AccountSelector.query
+        return AccountSelector.query()
             .with(Account.BillingCity)
             .with(Account.BillingCountry)
             .whereAre(SOQL.FilterGroup
@@ -56,7 +56,7 @@ Set mocking ID in Query declaration.
 public with sharing class ExampleController {
 
     public static List<Account> getPartnerAccounts(String accountName) {
-        return AccountSelector.query
+        return AccountSelector.query()
             .with(Account.BillingCity)
             .with(Account.BillingCountry)
             .whereAre(SOQL.FilterGroup
@@ -102,7 +102,7 @@ Set mocking ID in Query declaration.
 public with sharing class ExampleController {
 
     public static List<Account> getPartnerAccountsCount(String accountName) {
-        return AccountSelector.query
+        return AccountSelector.query()
             .whereAre(SOQL.FilterGroup
                 .add(SOQL.Filter.with(Account.Name).contains(accountName))
                 .add(SOQL.Filter.recordType().equal('Partner'))
@@ -143,7 +143,7 @@ Set mocking ID in Query declaration.
 public with sharing class ExampleController {
 
     public static List<Account> getPartnerAccounts(String accountName) {
-        return AccountSelector.query
+        return AccountSelector.query()
             .with(Account.BillingCity)
             .with(Account.BillingCountry)
             .whereAre(SOQL.FilterGroup

diff --git a/website/docs/examples/offset.md b/website/docs/examples/offset.md
@@ -12,23 +12,21 @@ FROM Account
 OFFSET 1000
 ```
 ```apex
-public inherited sharing class AccountSelector {
+public inherited sharing class AccountSelector implements SOQL.Selector {
 
-    public static SOQL query {
-        get {
-            return SOQL.of(Account.SObjectType)
-                .with(new List<SObjectField>{
-                    Account.Id,
-                    Account.Name
-                });
-        }
+    public static SOQL query() {
+        return SOQL.of(Account.SObjectType)
+            .with(new List<SObjectField>{
+                Account.Id,
+                Account.Name
+            });
     }
 }
 
 public with sharing class MyController {
 
     public static List<Account> getAccountsWithOffset() {
-        return AccountSelector.query
+        return AccountSelector.query()
             .offset(1000)
             .toList();
     }

diff --git a/website/docs/examples/order-by.md b/website/docs/examples/order-by.md
@@ -12,24 +12,22 @@ FROM Account
 ORDER BY Industry DESC NULLS FIRST, Id ASC NULLS FIRST
 ```
 ```apex
-public inherited sharing class AccountSelector {
+public inherited sharing class AccountSelector implements SOQL.Selector {
 
-    public static SOQL query {
-        get {
-            return SOQL.of(Lead.SObjectType)
-                 .with(new List<SObjectField>{
-                    Account.Id,
-                    Account.Name,
-                    Account.Industry
-                });
-        }
+    public static SOQL query() {
+        return SOQL.of(Lead.SObjectType)
+                .with(new List<SObjectField>{
+                Account.Id,
+                Account.Name,
+                Account.Industry
+            });
     }
 }
 
 public with sharing class MyController {
 
     public static List<Account> getAccounts() {
-        return AccountSelector.query
+        return AccountSelector.query()
                 .orderBy(Account.Industry).sortDesc()
                 .orderBy(Account.Id)
                 .toList();

diff --git a/website/docs/examples/result.md b/website/docs/examples/result.md
@@ -7,52 +7,50 @@ sidebar_position: 15
 Execut SOQL and get results.
 
 ```apex
-public inherited sharing class AccountSelector {
+public inherited sharing class AccountSelector implements SOQL.Selector {
 
     public static SOQL query {
-        get {
-            return SOQL.of(Account.SObjectType)
-                .with(new List<SObjectField>{
-                    Account.Id,
-                    Account.Name
-                });
-        }
+        return SOQL.of(Account.SObjectType)
+            .with(new List<SObjectField>{
+                Account.Id,
+                Account.Name
+            });
     }
 }
 
 public with sharing class MyController {
 
     public static Account getAccountById(Id accountId) {
-        return (Account) AccountSelector.query
+        return (Account) AccountSelector.query()
             .whereAre(SOQL.Filter.id().equal(accountId))
             .toObject();
     }
 
     public static List<Account> getAccountsByIds(List<Id> accountIds) {
-        return AccountSelector.query
+        return AccountSelector.query()
             .whereAre(SOQL.Filter.id().isIn(accountIds))
             .toList();
     }
 
     public static List<AggregateResult> getUniqueAccountNameAmount() {
-        return AccountSelector.query
+        return AccountSelector.query()
             .count(Account.Name, 'names')
             .toAggregated();
     }
 
     public static Integer countAccounts() {
-        return AccountSelector.query
+        return AccountSelector.query()
             .count()
             .toInteger();
     }
 
     public static Map<Id, SObject> getAccountMap() {
-        return AccountSelector.query
+        return AccountSelector.query()
             .toMap();
     }
 
     public static Database.QueryLocator getAccountQueryLocator() {
-        return AccountSelector.query
+        return AccountSelector.query()
             .toQueryLocator();
     }
 }