Add support for optionally customizing the cell accessory type

revolter · revolter · commit 544945a75f37 · 2023-03-16T17:29:15.000+02:00
diff --git a/Classes/GlobalStateExplorers/Globals/FLEXGlobalsEntry.h b/Classes/GlobalStateExplorers/Globals/FLEXGlobalsEntry.h
@@ -85,15 +85,20 @@ typedef void (^FLEXNestedGlobalEntriesHandler)(FLEXUserGlobalEntriesContainer *
 @interface FLEXGlobalsEntry : NSObject
 
 @property (nonatomic, readonly, nonnull)  FLEXGlobalsEntryNameFuture entryNameFuture;
+@property (nonatomic, readonly)           UITableViewCellAccessoryType cellAccessoryType;
 @property (nonatomic, readonly, nullable) FLEXGlobalsEntryViewControllerFuture viewControllerFuture;
 @property (nonatomic, readonly, nullable) FLEXGlobalsEntryRowAction rowAction;
 
-+ (instancetype)entryWithEntry:(Class<FLEXGlobalsEntry>)entry row:(FLEXGlobalsRow)row;
++ (instancetype)entryWithEntry:(Class<FLEXGlobalsEntry>)entry
+             cellAccessoryType:(UITableViewCellAccessoryType)cellAccessoryType
+                           row:(FLEXGlobalsRow)row;
 
 + (instancetype)entryWithNameFuture:(FLEXGlobalsEntryNameFuture)nameFuture
+                  cellAccessoryType:(UITableViewCellAccessoryType)cellAccessoryType
                viewControllerFuture:(FLEXGlobalsEntryViewControllerFuture)viewControllerFuture;
 
 + (instancetype)entryWithNameFuture:(FLEXGlobalsEntryNameFuture)nameFuture
+                  cellAccessoryType:(UITableViewCellAccessoryType)cellAccessoryType
                              action:(FLEXGlobalsEntryRowAction)rowSelectedAction;
 
 @end
diff --git a/Classes/GlobalStateExplorers/Globals/FLEXGlobalsEntry.m b/Classes/GlobalStateExplorers/Globals/FLEXGlobalsEntry.m
@@ -10,14 +10,17 @@
 
 @implementation FLEXGlobalsEntry
 
-+ (instancetype)entryWithEntry:(Class<FLEXGlobalsEntry>)cls row:(FLEXGlobalsRow)row {
++ (instancetype)entryWithEntry:(Class<FLEXGlobalsEntry>)cls
+             cellAccessoryType:(UITableViewCellAccessoryType)cellAccessoryType
+                           row:(FLEXGlobalsRow)row {
     BOOL providesVCs = [cls respondsToSelector:@selector(globalsEntryViewController:)];
     BOOL providesActions = [cls respondsToSelector:@selector(globalsEntryRowAction:)];
     NSParameterAssert(cls);
     NSParameterAssert(providesVCs || providesActions);
 
     FLEXGlobalsEntry *entry = [self new];
     entry->_entryNameFuture = ^{ return [cls globalsEntryTitle:row]; };
+    entry->_cellAccessoryType = cellAccessoryType;
 
     if (providesVCs) {
         id action = providesActions ? [cls globalsEntryRowAction:row] : nil;
@@ -34,24 +37,28 @@ + (instancetype)entryWithEntry:(Class<FLEXGlobalsEntry>)cls row:(FLEXGlobalsRow)
 }
 
 + (instancetype)entryWithNameFuture:(FLEXGlobalsEntryNameFuture)nameFuture
+                  cellAccessoryType:(UITableViewCellAccessoryType)cellAccessoryType
                viewControllerFuture:(FLEXGlobalsEntryViewControllerFuture)viewControllerFuture {
     NSParameterAssert(nameFuture);
     NSParameterAssert(viewControllerFuture);
 
     FLEXGlobalsEntry *entry = [self new];
     entry->_entryNameFuture = [nameFuture copy];
+    entry->_cellAccessoryType = cellAccessoryType;
     entry->_viewControllerFuture = [viewControllerFuture copy];
 
     return entry;
 }
 
 + (instancetype)entryWithNameFuture:(FLEXGlobalsEntryNameFuture)nameFuture
+                  cellAccessoryType:(UITableViewCellAccessoryType)cellAccessoryType
                              action:(FLEXGlobalsEntryRowAction)rowSelectedAction {
     NSParameterAssert(nameFuture);
     NSParameterAssert(rowSelectedAction);
 
     FLEXGlobalsEntry *entry = [self new];
     entry->_entryNameFuture = [nameFuture copy];
+    entry->_cellAccessoryType = cellAccessoryType;
     entry->_rowAction = [rowSelectedAction copy];
 
     return entry;
@@ -77,7 +84,10 @@ @implementation NSObject (FLEXGlobalsEntry)
 
 + (FLEXGlobalsEntry *)flex_concreteGlobalsEntry:(FLEXGlobalsRow)row {
     if ([self conformsToProtocol:@protocol(FLEXGlobalsEntry)]) {
-        return [FLEXGlobalsEntry entryWithEntry:self row:row];
+        return [FLEXGlobalsEntry entryWithEntry:self
+                              cellAccessoryType:UITableViewCellAccessoryDisclosureIndicator
+                                            row:row
+        ];
     }
 
     return nil;
diff --git a/Classes/GlobalStateExplorers/Globals/FLEXGlobalsSection.m b/Classes/GlobalStateExplorers/Globals/FLEXGlobalsSection.m
@@ -69,7 +69,7 @@ - (UIViewController *)viewControllerToPushForRow:(NSInteger)row {
 }
 
 - (void)configureCell:(__kindof UITableViewCell *)cell forRow:(NSInteger)row {
-    cell.accessoryType = UITableViewCellAccessoryDisclosureIndicator;
+    cell.accessoryType = self.rows[row].cellAccessoryType;
     cell.textLabel.font = UIFont.flex_defaultTableCellFont;
     cell.textLabel.text = self.rows[row].entryNameFuture();
 }
diff --git a/Classes/GlobalStateExplorers/Globals/FLEXUserGlobalEntriesContainer.h b/Classes/GlobalStateExplorers/Globals/FLEXUserGlobalEntriesContainer.h
@@ -26,6 +26,21 @@ NS_ASSUME_NONNULL_BEGIN
 /// you may want to use __weak references.
 - (void)registerGlobalEntryWithName:(NSString *)entryName objectFutureBlock:(id (^)(void))objectFutureBlock;
 
+/// Adds an entry at the top of the list of Global State items.
+/// Call this method before this view controller is displayed.
+/// @param entryName The string to be displayed in the cell.
+/// @param cellAccessoryType The accessory type to be used for the cell.
+/// @param objectFutureBlock When you tap on the row, information about the object returned
+/// by this block will be displayed. Passing a block that returns an object allows you to display
+/// information about an object whose actual pointer may change at runtime (e.g. +currentUser)
+/// @note This method must be called from the main thread.
+/// The objectFutureBlock will be invoked from the main thread and may return nil.
+/// @note The passed block will be copied and retain for the duration of the application,
+/// you may want to use __weak references.
+- (void)registerGlobalEntryWithName:(NSString *)entryName
+                  cellAccessoryType:(UITableViewCellAccessoryType)cellAccessoryType
+                  objectFutureBlock:(id (^)(void))objectFutureBlock;
+
 /// Adds an entry at the top of the list of Global State items.
 /// Call this method before this view controller is displayed.
 /// @param entryName The string to be displayed in the cell.
@@ -38,6 +53,20 @@ NS_ASSUME_NONNULL_BEGIN
 - (void)registerGlobalEntryWithName:(NSString *)entryName
           viewControllerFutureBlock:(UIViewController * (^)(void))viewControllerFutureBlock;
 
+/// Adds an entry at the top of the list of Global State items.
+/// Call this method before this view controller is displayed.
+/// @param entryName The string to be displayed in the cell.
+/// @param cellAccessoryType The accessory type to be used for the cell.
+/// @param viewControllerFutureBlock When you tap on the row, view controller returned
+/// by this block will be pushed on the navigation controller stack.
+/// @note This method must be called from the main thread.
+/// The viewControllerFutureBlock will be invoked from the main thread and may not return nil.
+/// @note The passed block will be copied and retain for the duration of the application,
+/// you may want to use __weak references as needed.
+- (void)registerGlobalEntryWithName:(NSString *)entryName
+                  cellAccessoryType:(UITableViewCellAccessoryType)cellAccessoryType
+          viewControllerFutureBlock:(UIViewController * (^)(void))viewControllerFutureBlock;
+
 /// Adds an entry at the top of the list of Global State items.
 /// @param entryName The string to be displayed in the cell.
 /// @param rowSelectedAction When you tap on the row, this block will be invoked
@@ -48,6 +77,19 @@ NS_ASSUME_NONNULL_BEGIN
 /// you may want to use __weak references as needed.
 - (void)registerGlobalEntryWithName:(NSString *)entryName action:(FLEXGlobalsEntryRowAction)rowSelectedAction;
 
+/// Adds an entry at the top of the list of Global State items.
+/// @param entryName The string to be displayed in the cell.
+/// @param cellAccessoryType The accessory type to be used for the cell.
+/// @param rowSelectedAction When you tap on the row, this block will be invoked
+/// with the host table view view controller. Use it to deselect the row or present an alert.
+/// @note This method must be called from the main thread.
+/// The rowSelectedAction will be invoked from the main thread.
+/// @note The passed block will be copied and retained for the duration of the application,
+/// you may want to use __weak references as needed.
+- (void)registerGlobalEntryWithName:(NSString *)entryName
+                  cellAccessoryType:(UITableViewCellAccessoryType)cellAccessoryType
+                             action:(FLEXGlobalsEntryRowAction)rowSelectedAction;
+
 /// Adds an entry at the top of the list of Global State items.
 /// @param entryName The string to be displayed in the cell.
 /// @param nestedEntriesHandler When you tap on the row, this block will be invoked
@@ -58,6 +100,19 @@ NS_ASSUME_NONNULL_BEGIN
 /// you may want to use __weak references as needed.
 - (void)registerNestedGlobalEntryWithName:(NSString *)entryName handler:(FLEXNestedGlobalEntriesHandler)nestedEntriesHandler;
 
+/// Adds an entry at the top of the list of Global State items.
+/// @param entryName The string to be displayed in the cell.
+/// @param cellAccessoryType The accessory type to be used for the cell.
+/// @param nestedEntriesHandler When you tap on the row, this block will be invoked
+/// with the container object. Use it to register nested entries.
+/// @note This method must be called from the main thread.
+/// The nestedEntriesHandler will be invoked from the main thread.
+/// @note The passed block will be copied and retained for the duration of the application,
+/// you may want to use __weak references as needed.
+- (void)registerNestedGlobalEntryWithName:(NSString *)entryName
+                        cellAccessoryType:(UITableViewCellAccessoryType)cellAccessoryType
+                                  handler:(FLEXNestedGlobalEntriesHandler)nestedEntriesHandler;
+
 /// Removes all registered global entries.
 - (void)clearGlobalEntries;
 
diff --git a/Classes/GlobalStateExplorers/Globals/FLEXUserGlobalEntriesContainer.m b/Classes/GlobalStateExplorers/Globals/FLEXUserGlobalEntriesContainer.m
@@ -28,29 +28,45 @@ - (instancetype)init {
 }
 
 - (void)registerGlobalEntryWithName:(NSString *)entryName objectFutureBlock:(id (^)(void))objectFutureBlock {
+    [self registerGlobalEntryWithName:entryName
+                    cellAccessoryType:UITableViewCellAccessoryDisclosureIndicator
+                    objectFutureBlock:objectFutureBlock
+    ];
+}
+
+- (void)registerGlobalEntryWithName:(NSString *)entryName cellAccessoryType:(UITableViewCellAccessoryType)cellAccessoryType objectFutureBlock:(id (^)(void))objectFutureBlock {
     NSParameterAssert(entryName);
     NSParameterAssert(objectFutureBlock);
     NSAssert(NSThread.isMainThread, @"This method must be called from the main thread.");
 
     entryName = entryName.copy;
     FLEXGlobalsEntry *entry = [FLEXGlobalsEntry entryWithNameFuture:^NSString *{
         return entryName;
-    } viewControllerFuture:^UIViewController *{
+    } cellAccessoryType:cellAccessoryType viewControllerFuture:^UIViewController *{
         return [FLEXObjectExplorerFactory explorerViewControllerForObject:objectFutureBlock()];
     }];
 
     [self.entries addObject:entry];
 }
 
 - (void)registerGlobalEntryWithName:(NSString *)entryName viewControllerFutureBlock:(UIViewController * (^)(void))viewControllerFutureBlock {
+    [self registerGlobalEntryWithName:entryName
+                    cellAccessoryType:UITableViewCellAccessoryDisclosureIndicator
+            viewControllerFutureBlock:viewControllerFutureBlock
+    ];
+}
+
+- (void)registerGlobalEntryWithName:(NSString *)entryName
+                  cellAccessoryType:(UITableViewCellAccessoryType)cellAccessoryType
+          viewControllerFutureBlock:(UIViewController * (^)(void))viewControllerFutureBlock {
     NSParameterAssert(entryName);
     NSParameterAssert(viewControllerFutureBlock);
     NSAssert(NSThread.isMainThread, @"This method must be called from the main thread.");
 
     entryName = entryName.copy;
     FLEXGlobalsEntry *entry = [FLEXGlobalsEntry entryWithNameFuture:^NSString *{
         return entryName;
-    } viewControllerFuture:^UIViewController *{
+    } cellAccessoryType:cellAccessoryType viewControllerFuture:^UIViewController *{
         UIViewController *viewController = viewControllerFutureBlock();
         NSCAssert(viewController, @"'%@' entry returned nil viewController. viewControllerFutureBlock should never return nil.", entryName);
         return viewController;
@@ -60,27 +76,45 @@ - (void)registerGlobalEntryWithName:(NSString *)entryName viewControllerFutureBl
 }
 
 - (void)registerGlobalEntryWithName:(NSString *)entryName action:(FLEXGlobalsEntryRowAction)rowSelectedAction {
+    [self registerGlobalEntryWithName:entryName
+                    cellAccessoryType:UITableViewCellAccessoryDisclosureIndicator
+                               action:rowSelectedAction
+    ];
+}
+
+- (void)registerGlobalEntryWithName:(NSString *)entryName
+                  cellAccessoryType:(UITableViewCellAccessoryType)cellAccessoryType
+                             action:(FLEXGlobalsEntryRowAction)rowSelectedAction {
     NSParameterAssert(entryName);
     NSParameterAssert(rowSelectedAction);
     NSAssert(NSThread.isMainThread, @"This method must be called from the main thread.");
 
     entryName = entryName.copy;
     FLEXGlobalsEntry *entry = [FLEXGlobalsEntry entryWithNameFuture:^NSString * _Nonnull{
         return entryName;
-    } action:rowSelectedAction];
+    } cellAccessoryType:cellAccessoryType action:rowSelectedAction];
 
     [self.entries addObject:entry];
 }
 
 - (void)registerNestedGlobalEntryWithName:(NSString *)entryName handler:(FLEXNestedGlobalEntriesHandler)nestedEntriesHandler {
+    [self registerNestedGlobalEntryWithName:entryName
+                          cellAccessoryType:UITableViewCellAccessoryDisclosureIndicator
+                                    handler:nestedEntriesHandler
+    ];
+}
+
+- (void)registerNestedGlobalEntryWithName:(NSString *)entryName
+                        cellAccessoryType:(UITableViewCellAccessoryType)cellAccessoryType
+                                  handler:(FLEXNestedGlobalEntriesHandler)nestedEntriesHandler {
     NSParameterAssert(entryName);
     NSParameterAssert(nestedEntriesHandler);
     NSAssert(NSThread.isMainThread, @"This method must be called from the main thread.");
 
     entryName = entryName.copy;
     FLEXGlobalsEntry *entry = [FLEXGlobalsEntry entryWithNameFuture:^NSString * _Nonnull{
         return entryName;
-    } viewControllerFuture:^UIViewController * _Nullable{
+    } cellAccessoryType:cellAccessoryType viewControllerFuture:^UIViewController * _Nullable{
         FLEXUserGlobalEntriesContainer *container = [FLEXUserGlobalEntriesContainer new];
         nestedEntriesHandler(container);
 
diff --git a/Example/FLEXample/AppDelegate.swift b/Example/FLEXample/AppDelegate.swift
@@ -28,11 +28,11 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
 
         // To show off the global entries, register one of each type
 
-        FLEXManager.shared.globalEntriesContainer.registerGlobalEntry(withName: "Level 1 - Object") {
+        FLEXManager.shared.globalEntriesContainer.registerGlobalEntry(withName: "Level 1 - Object", cellAccessoryType: .none) {
             return "Level 1 - Object"
         }
 
-        FLEXManager.shared.globalEntriesContainer.registerGlobalEntry(withName: "Level 1 - View controller") {
+        FLEXManager.shared.globalEntriesContainer.registerGlobalEntry(withName: "Level 1 - View controller", cellAccessoryType: .none) {
             let label = UILabel()
             label.text = "Level 1 - View controller"
             label.translatesAutoresizingMaskIntoConstraints = false
@@ -48,16 +48,16 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
             return controller
         }
 
-        FLEXManager.shared.globalEntriesContainer.registerGlobalEntry(withName: "Level 1 - Action") { host in
+        FLEXManager.shared.globalEntriesContainer.registerGlobalEntry(withName: "Level 1 - Action", cellAccessoryType: .none) { host in
             FLEXAlert.showQuickAlert("Level 1 - Action", from: host)
         }
 
         FLEXManager.shared.globalEntriesContainer.registerNestedGlobalEntry(withName: "Level 1 - Nested") { container in
-            container.registerGlobalEntry(withName: "Level 2 - Object") {
+            container.registerGlobalEntry(withName: "Level 2 - Object", cellAccessoryType: .none) {
                 return "Level 2 - Object"
             }
 
-            container.registerGlobalEntry(withName: "Level 2 - View controller") {
+            container.registerGlobalEntry(withName: "Level 2 - View controller", cellAccessoryType: .none) {
                 let label = UILabel()
                 label.text = "Level 2 - View controller"
                 label.translatesAutoresizingMaskIntoConstraints = false
@@ -73,12 +73,12 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
                 return controller
             }
 
-            container.registerGlobalEntry(withName: "Level 2 - Action") { host in
+            container.registerGlobalEntry(withName: "Level 2 - Action", cellAccessoryType: .none) { host in
                 FLEXAlert.showQuickAlert("Level 2 - Action", from: host)
             }
 
             container.registerNestedGlobalEntry(withName: "Level 2 - Nested") { level2Container in
-                level2Container.registerGlobalEntry(withName: "Level 3 - Action") { host in
+                level2Container.registerGlobalEntry(withName: "Level 3 - Action", cellAccessoryType: .none) { host in
                     FLEXAlert.showQuickAlert("Level 3 - Action", from: host)
                 }
             }

Original file line number	Diff line number	Diff line change
`@@ -69,7 +69,7 @@ - (UIViewController *)viewControllerToPushForRow:(NSInteger)row {`
`69`	`69`	`}`
`70`	`70`
`71`	`71`	`- (void)configureCell:(__kindof UITableViewCell *)cell forRow:(NSInteger)row {`
`72`		`- cell.accessoryType = UITableViewCellAccessoryDisclosureIndicator;`
	`72`	`+ cell.accessoryType = self.rows[row].cellAccessoryType;`
`73`	`73`	`cell.textLabel.font = UIFont.flex_defaultTableCellFont;`
`74`	`74`	`cell.textLabel.text = self.rows[row].entryNameFuture();`
`75`	`75`	`}`
Original file line number	Diff line number	Diff line change
`@@ -28,11 +28,11 @@ class AppDelegate: UIResponder, UIApplicationDelegate {`
`28`	`28`
`29`	`29`	`// To show off the global entries, register one of each type`
`30`	`30`
`31`		`- FLEXManager.shared.globalEntriesContainer.registerGlobalEntry(withName: "Level 1 - Object") {`
	`31`	`+ FLEXManager.shared.globalEntriesContainer.registerGlobalEntry(withName: "Level 1 - Object", cellAccessoryType: .none) {`
`32`	`32`	`return "Level 1 - Object"`
`33`	`33`	`}`
`34`	`34`
`35`		`- FLEXManager.shared.globalEntriesContainer.registerGlobalEntry(withName: "Level 1 - View controller") {`
	`35`	`+ FLEXManager.shared.globalEntriesContainer.registerGlobalEntry(withName: "Level 1 - View controller", cellAccessoryType: .none) {`
`36`	`36`	`let label = UILabel()`
`37`	`37`	`label.text = "Level 1 - View controller"`
`38`	`38`	`label.translatesAutoresizingMaskIntoConstraints = false`
`@@ -48,16 +48,16 @@ class AppDelegate: UIResponder, UIApplicationDelegate {`
`48`	`48`	`return controller`
`49`	`49`	`}`
`50`	`50`
`51`		`- FLEXManager.shared.globalEntriesContainer.registerGlobalEntry(withName: "Level 1 - Action") { host in`
	`51`	`+ FLEXManager.shared.globalEntriesContainer.registerGlobalEntry(withName: "Level 1 - Action", cellAccessoryType: .none) { host in`
`52`	`52`	`FLEXAlert.showQuickAlert("Level 1 - Action", from: host)`
`53`	`53`	`}`
`54`	`54`
`55`	`55`	`FLEXManager.shared.globalEntriesContainer.registerNestedGlobalEntry(withName: "Level 1 - Nested") { container in`
`56`		`- container.registerGlobalEntry(withName: "Level 2 - Object") {`
	`56`	`+ container.registerGlobalEntry(withName: "Level 2 - Object", cellAccessoryType: .none) {`
`57`	`57`	`return "Level 2 - Object"`
`58`	`58`	`}`
`59`	`59`
`60`		`- container.registerGlobalEntry(withName: "Level 2 - View controller") {`
	`60`	`+ container.registerGlobalEntry(withName: "Level 2 - View controller", cellAccessoryType: .none) {`
`61`	`61`	`let label = UILabel()`
`62`	`62`	`label.text = "Level 2 - View controller"`
`63`	`63`	`label.translatesAutoresizingMaskIntoConstraints = false`
`@@ -73,12 +73,12 @@ class AppDelegate: UIResponder, UIApplicationDelegate {`
`73`	`73`	`return controller`
`74`	`74`	`}`
`75`	`75`
`76`		`- container.registerGlobalEntry(withName: "Level 2 - Action") { host in`
	`76`	`+ container.registerGlobalEntry(withName: "Level 2 - Action", cellAccessoryType: .none) { host in`
`77`	`77`	`FLEXAlert.showQuickAlert("Level 2 - Action", from: host)`
`78`	`78`	`}`
`79`	`79`
`80`	`80`	`container.registerNestedGlobalEntry(withName: "Level 2 - Nested") { level2Container in`
`81`		`- level2Container.registerGlobalEntry(withName: "Level 3 - Action") { host in`
	`81`	`+ level2Container.registerGlobalEntry(withName: "Level 3 - Action", cellAccessoryType: .none) { host in`
`82`	`82`	`FLEXAlert.showQuickAlert("Level 3 - Action", from: host)`
`83`	`83`	`}`
`84`	`84`	`}`