Support dynamic values/titles in radio groups

futuretap · futuretap · commit d52dbe42f471 · 2024-02-08T21:15:28.000+01:00
diff --git a/InAppSettingsKit.podspec b/InAppSettingsKit.podspec
@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
 	s.name                  = 'InAppSettingsKit'
-	s.version               = '3.6.2'
+	s.version               = '3.7'
 	s.summary               = 'This iPhone framework allows settings to be in-app in addition to being in the Settings app.'
 
   s.description      = <<-DESC
diff --git a/InAppSettingsKitSampleApp/Classes/MainViewController.swift b/InAppSettingsKitSampleApp/Classes/MainViewController.swift
@@ -193,14 +193,14 @@ extension MainViewController: IASKSettingsDelegate {
 	}
 	
 	func settingsViewController(_ settingsViewController: IASKAppSettingsViewController, valuesFor specifier: IASKSpecifier) -> [Any] {
-		return specifier.key == "countryCode" ? Locale.isoRegionCodes : []
+		return specifier.key == "countryCode" ? Locale.isoRegionCodes : ["Chicago", "Seattle", "Miami"]
 	}
 	
-	func settingsViewController(_ settingsViewController: IASKAppSettingsViewController, titlesFor specifier: IASKSpecifier) -> [Any] {
+	func settingsViewController(_ settingsViewController: IASKAppSettingsViewController, titlesFor specifier: IASKSpecifier) -> [String] {
 		if specifier.key == "countryCode" {
 			return Locale.isoRegionCodes.map{Locale.current.localizedString(forRegionCode: $0) ?? ""}
 		}
-		return []
+		return ["Chicago", "Seattle", "Miami"]
 	}
 	
 	func settingsViewController(_ settingsViewController: IASKAppSettingsViewController, childPaneIsValidFor specifier: IASKSpecifier, contentDictionary: NSMutableDictionary) -> Bool {
diff --git a/InAppSettingsKitSampleApp/Settings.bundle/Complete.plist b/InAppSettingsKitSampleApp/Settings.bundle/Complete.plist
@@ -794,6 +794,16 @@
 				<string>Three</string>
 			</array>
 		</dict>
+		<dict>
+			<key>Type</key>
+			<string>PSRadioGroupSpecifier</string>
+			<key>Title</key>
+			<string>Radio Group</string>
+			<key>Key</key>
+			<string>radiogroup2</string>
+			<key>DefaultValue</key>
+			<string>Seattle</string>
+		</dict>
 		<dict>
 			<key>Type</key>
 			<string>PSGroupSpecifier</string>
diff --git a/README.md b/README.md
@@ -353,10 +353,10 @@ The callback receives the `IASKTextField` which is a `UITextField` subclass to a
 
 
 ## Dynamic MultiValue Lists
-MultiValue lists (`PSMultiValueSpecifier`) can fetch their values and titles dynamically from the delegate instead of the static Plist. Implement these two methods in your `IASKSettingsDelegate`:
+MultiValue lists (`PSMultiValueSpecifier`) and radio groups (`PSRadioGroupSpecifier`) can fetch their values and titles dynamically from the delegate instead of the static Plist. Implement these two methods in your `IASKSettingsDelegate`:
 
     - (NSArray*)settingsViewController:(IASKAppSettingsViewController*)sender valuesForSpecifier:(IASKSpecifier*)specifier;
-    - (NSArray*)settingsViewController:(IASKAppSettingsViewController*)sender titlesForSpecifier:(IASKSpecifier*)specifier;
+    - (NSArray<NSString*>*)settingsViewController:(IASKAppSettingsViewController*)sender titlesForSpecifier:(IASKSpecifier*)specifier;
 
 The sample app returns a list of all country codes as values and the localized country names as titles.
 
diff --git a/Sources/InAppSettingsKit/Controllers/IASKAppSettingsViewController.m b/Sources/InAppSettingsKit/Controllers/IASKAppSettingsViewController.m
@@ -45,7 +45,7 @@
 
 CGRect IASKCGRectSwap(CGRect rect);
 
-@interface IASKAppSettingsViewController () <UITextViewDelegate>
+@interface IASKAppSettingsViewController () <IASKSettingsReaderDelegate, UITextViewDelegate>
 
 @property (nonatomic, weak) UIViewController *currentChildViewController;
 @property (nonatomic, strong) NSMutableDictionary *rowHeights;
@@ -71,7 +71,7 @@ @implementation IASKAppSettingsViewController
 - (IASKSettingsReader*)settingsReader {
 	if (!_settingsReader) {
 		NSBundle* bundle = _bundle == nil ? NSBundle.mainBundle : _bundle;
-		_settingsReader = [[IASKSettingsReader alloc] initWithFile:self.file bundle:bundle];
+		_settingsReader = [[IASKSettingsReader alloc] initWithFile:self.file bundle:bundle delegate:self];
 		if (self.neverShowPrivacySettings) {
 			_settingsReader.showPrivacySettings = NO;
 		}
@@ -111,14 +111,14 @@ - (void)setFile:(NSString *)file {
     self.tableView.contentOffset = CGPointMake(0, -self.tableView.contentInset.top);
     self.settingsReader = nil; // automatically initializes itself
     if (!_reloadDisabled) {
-		[self.tableView reloadData];
 		[self createSelections];
+		[self.tableView reloadData];
 	}
 }
 
 - (void)createSelections {
 	NSMutableArray *sectionSelection = [NSMutableArray new];
-	for (int section = 0; section < _settingsReader.numberOfSections; section++) {
+	for (int section = 0; section < self.settingsReader.numberOfSections; section++) {
 		IASKSpecifier *specifier = [self.settingsReader headerSpecifierForSection:section];
 		if ([specifier.type isEqualToString:kIASKPSRadioGroupSpecifier]) {
 			IASKMultipleValueSelection *selection = [[IASKMultipleValueSelection alloc] initWithSettingsStore:self.settingsStore tableView:self.tableView specifier:specifier section:section];
@@ -368,6 +368,7 @@ - (void)setHiddenKeys:(NSSet*)theHiddenKeys animated:(BOOL)animated {
 			}
 		} else {
 			self.settingsReader.hiddenKeys = theHiddenKeys;
+			[self createSelections];
 			if (!_reloadDisabled) [self.tableView reloadData];
 		}
 	}
@@ -600,7 +601,7 @@ - (UITableViewCell*)tableView:(UITableView *)tableView newCellForSpecifier:(IASK
 }
 
 - (UITableViewCell *)tableView:(UITableView *)tableView cellForRowAtIndexPath:(NSIndexPath *)indexPath {
-	IASKSpecifier *specifier  = [self.settingsReader specifierForIndexPath:indexPath];
+	IASKSpecifier *specifier = [self.settingsReader specifierForIndexPath:indexPath];
 	if ([specifier.type isEqualToString:kIASKCustomViewSpecifier] && [self.delegate respondsToSelector:@selector(settingsViewController:cellForSpecifier:)]) {
 		UITableViewCell* cell = [self.delegate settingsViewController:self cellForSpecifier:specifier];
 		assert(nil != cell && "delegate must return a UITableViewCell for custom cell types");
@@ -1090,6 +1091,31 @@ - (void)presentChildViewController:(UITableViewController<IASKViewController> *)
 	}
 }
 
+#pragma mark -
+#pragma mark IASKSettingsReaderDelegate
+- (nullable NSArray<NSString*>*)titlesForSpecifier:(IASKSpecifier*)specifier {
+	if ([self.delegate respondsToSelector:@selector(settingsViewController:titlesForSpecifier:)]) {
+		return [self.delegate settingsViewController:self titlesForSpecifier:specifier];
+	}
+	return nil;
+}
+
+- (NSArray*)valuesForSpecifier:(IASKSpecifier*)specifier {
+	if ([self.delegate respondsToSelector:@selector(settingsViewController:valuesForSpecifier:)]) {
+		return [self.delegate settingsViewController:self valuesForSpecifier:specifier];
+	}
+	return nil;
+}
+
+- (void)setMultiValuesFromDelegateIfNeeded:(IASKSpecifier *)specifier {
+	if (specifier.multipleValues.count == 0) {
+		NSArray *titles = [self titlesForSpecifier:specifier];
+		NSArray *values = [self valuesForSpecifier:specifier];
+		[specifier setMultipleValuesDictValues:values titles:titles];
+		[specifier sortIfNeeded];
+	}
+}
+
 #pragma mark -
 #pragma mark MFMailComposeViewControllerDelegate Function
 
@@ -1294,18 +1320,6 @@ - (void)reload {
 	[self.tableView performSelector:@selector(reloadData) withObject:nil afterDelay:0.5];
 }
 
-- (void)setMultiValuesFromDelegateIfNeeded:(IASKSpecifier *)specifier {
-	if (specifier.multipleValues.count == 0) {
-		if ([self.delegate respondsToSelector:@selector(settingsViewController:valuesForSpecifier:)] &&
-			[self.delegate respondsToSelector:@selector(settingsViewController:titlesForSpecifier:)])
-		{
-			[specifier setMultipleValuesDictValues:[self.delegate settingsViewController:self valuesForSpecifier:specifier]
-											titles:[self.delegate settingsViewController:self titlesForSpecifier:specifier]];
-		}
-		[specifier sortIfNeeded];
-	}
-}
-
 
 #pragma mark CGRect Utility function
 CGRect IASKCGRectSwap(CGRect rect) {
diff --git a/Sources/InAppSettingsKit/Models/IASKSettingsReader.m b/Sources/InAppSettingsKit/Models/IASKSettingsReader.m
@@ -15,6 +15,7 @@
 //
 
 #import "IASKSettingsReader.h"
+#import "IASKAppSettingsViewController.h"
 #import "IASKSpecifier.h"
 #import "IASKSettingsStore.h"
 
@@ -27,9 +28,10 @@ - (id)iaskObjectAtIndex:(NSUInteger)index;
 
 @implementation IASKSettingsReader
 
-- (nonnull id)initWithFile:(nonnull NSString*)file bundle:(nonnull NSBundle*)bundle {
+- (nonnull id)initWithFile:(nonnull NSString*)file bundle:(nonnull NSBundle*)bundle delegate:(nullable id<IASKSettingsReaderDelegate>)delegate {
     if ((self = [super init])) {
         _applicationBundle = bundle;
+		_delegate = delegate;
         
         NSString* plistFilePath = [self locateSettingsFile:file];
         NSDictionary *settingsDictionary = [NSDictionary dictionaryWithContentsOfFile:plistFilePath];
@@ -76,7 +78,7 @@ - (nonnull id)initWithFile:(nonnull NSString*)file bundle:(nonnull NSBundle*)bun
 }
 
 - (nonnull id)initWithFile:(nonnull NSString*)file {
-    return [self initWithFile:file bundle:[NSBundle mainBundle]];
+    return [self initWithFile:file bundle:NSBundle.mainBundle delegate:nil];
 }
 
 - (id)init {
@@ -169,19 +171,13 @@ - (void)_reinterpretBundle:(NSDictionary*)settingsBundle {
 			ignoreItemsInThisSection = NO;
 
 			///create a brand new array with the specifier above and an empty array
-            NSMutableArray *newArray = [NSMutableArray array];
-            [newArray addObject:newSpecifier];
-            [dataSource addObject:newArray];
 			
-            if ([newSpecifier.type isEqualToString:kIASKPSRadioGroupSpecifier]) {
-                for (NSString *value in newSpecifier.multipleValues) {
-                    IASKSpecifier *valueSpecifier =
-                        [[IASKSpecifier alloc] initWithSpecifier:specifierDictionary radioGroupValue:value];
-                    valueSpecifier.settingsReader = self;
-                    [valueSpecifier sortIfNeeded];
-                    [newArray addObject:valueSpecifier];
-                }
-            }
+			if ([newSpecifier.type isEqualToString:kIASKPSRadioGroupSpecifier] && newSpecifier.multipleValues.count == 0)	{
+				[newSpecifier setMultipleValuesDictValues:[self.delegate valuesForSpecifier:newSpecifier]
+												   titles:[self.delegate titlesForSpecifier:newSpecifier]];
+			}
+			[dataSource addObject:newSpecifier.multiValueChildSpecifiers];
+
 		} else {
 			if (ignoreItemsInThisSection || (newSpecifier.key && [self.hiddenKeys containsObject:(id)newSpecifier.key])) {
 				continue;
@@ -231,6 +227,8 @@ - (NSInteger)numberOfRowsInSection:(NSInteger)section {
 			numberOfRows++;
 		}
 		return numberOfRows;
+	} else if ([headerSpecifier.type isEqualToString:kIASKPSRadioGroupSpecifier]) {
+		return headerSpecifier.multipleValuesCount;
 	}
 
 	return ((NSArray*)[self.dataSource iaskObjectAtIndex:section]).count - headingCorrection;
@@ -333,7 +331,7 @@ - (void)gatherDefaultsInDictionary:(NSMutableDictionary*)dictionary limitedToEdi
 				[dictionary setObject:(id)specifier.defaultValue forKey:(id)specifier.key];
 			}
 			if ([specifier.type isEqualToString:kIASKPSChildPaneSpecifier] && specifier.file) {
-				IASKSettingsReader *childReader = [[IASKSettingsReader alloc] initWithFile:(id)specifier.file bundle:_applicationBundle];
+				IASKSettingsReader *childReader = [[IASKSettingsReader alloc] initWithFile:(id)specifier.file bundle:_applicationBundle delegate:self.delegate];
 				childReader.settingsStore = self.settingsStore;
 				[childReader gatherDefaultsInDictionary:dictionary limitedToEditableFields:limitedToEditableFields apply:apply];
 			}
diff --git a/Sources/InAppSettingsKit/Models/IASKSpecifier.m b/Sources/InAppSettingsKit/Models/IASKSpecifier.m
@@ -67,11 +67,8 @@ - (void)setMultipleValuesDictValues:(NSArray*)values titles:(NSArray*)titles {
     NSArray *iconNames = [_specifierDict objectForKey:kIASKIconNames];
     NSMutableDictionary *multipleValuesDict = [NSMutableDictionary new];
    
-    if (values) {
+    if (values && titles) {
         [multipleValuesDict setObject:values forKey:kIASKValues];
-    }
-	
-    if (titles) {
         [multipleValuesDict setObject:titles forKey:kIASKTitles];
     }
 
@@ -497,6 +494,23 @@ - (NSTextAlignment)textAlignment {
 	return NSTextAlignmentNatural;
 }
 
+- (NSArray<IASKSpecifier*>*)multiValueChildSpecifiers {
+	NSMutableArray *result = @[self].mutableCopy;
+	if (!self.multipleValues) return result;
+	
+	if ([self.type isEqualToString:kIASKPSRadioGroupSpecifier]) {
+		for (NSString *value in self.multipleValues) {
+			IASKSpecifier *specifier =
+			[[IASKSpecifier alloc] initWithSpecifier:self.specifierDict radioGroupValue:value];
+			specifier.settingsReader = self.settingsReader;
+			specifier.multipleValuesDict = self.multipleValuesDict;
+			[specifier sortIfNeeded];
+			[result addObject:specifier];
+		}
+	}
+	return result;
+}
+
 - (NSArray *)userInterfaceIdioms {
     NSMutableDictionary *idiomMap = [NSMutableDictionary dictionaryWithDictionary:
                                      @{
diff --git a/Sources/InAppSettingsKit/include/IASKAppSettingsViewController.h b/Sources/InAppSettingsKit/include/IASKAppSettingsViewController.h
@@ -162,9 +162,9 @@ shouldPresentMailComposeViewController:(MFMailComposeViewController*)mailCompose
  @param specifier the specifier containing the key of the selected element
  @return an array of titles
  @discussion the returned array overrides any titles specified in the static schema plist
-*/
-- (NSArray*)settingsViewController:(IASKAppSettingsViewController*)settingsViewController
-				titlesForSpecifier:(IASKSpecifier*)specifier;
+ */
+- (NSArray<NSString*>*)settingsViewController:(IASKAppSettingsViewController*)settingsViewController
+						   titlesForSpecifier:(IASKSpecifier*)specifier;
 
 #pragma mark - Button
 /** Tells the delegate that the specified button (`IASKButton`) element is now selected.
diff --git a/Sources/InAppSettingsKit/include/IASKSettingsReader.h b/Sources/InAppSettingsKit/include/IASKSettingsReader.h
@@ -175,6 +175,11 @@ extern NSString * const IASKSettingChangedNotification;
 @class IASKSpecifier;
 @protocol IASKSettingsStore;
 
+@protocol IASKSettingsReaderDelegate <NSObject>
+- (nullable NSArray<NSString*>*)titlesForSpecifier:(IASKSpecifier*)specifier;
+- (nullable NSArray*)valuesForSpecifier:(IASKSpecifier*)specifier;
+@end
+
 /** settings reader transform iOS's settings plist files
  to the IASKSpecifier model objects.
  Besides that, it also hides the complexity of finding
@@ -188,7 +193,7 @@ extern NSString * const IASKSettingChangedNotification;
  @param file   settings file name without the ".plist" suffix
  @param bundle bundle that contains a plist with the specified file
   */
-- (id)initWithFile:(NSString*)file bundle:(NSBundle*)bundle;
+- (id)initWithFile:(NSString*)file bundle:(NSBundle*)bundle delegate:(nullable id<IASKSettingsReaderDelegate>)delegate;
 
 /** convenience initializer
  calls initWithFile where applicationBundle is set to NSBundle.mainBundle
@@ -197,6 +202,7 @@ extern NSString * const IASKSettingChangedNotification;
 - (id)initWithFile:(NSString*)file;
 
 @property (nonatomic, readonly) NSInteger numberOfSections;
+@property (nonatomic, nullable, weak) id<IASKSettingsReaderDelegate> delegate;
 - (NSInteger)numberOfRowsInSection:(NSInteger)section;
 - (nullable IASKSpecifier*)specifierForIndexPath:(NSIndexPath*)indexPath;
 - (nullable IASKSpecifier*)headerSpecifierForSection:(NSInteger)section;
diff --git a/Sources/InAppSettingsKit/include/IASKSpecifier.h b/Sources/InAppSettingsKit/include/IASKSpecifier.h
@@ -62,6 +62,7 @@ NS_ASSUME_NONNULL_BEGIN
 @property (nullable, nonatomic, strong, readonly) NSArray *userInterfaceIdioms;
 @property (nonatomic, readonly) BOOL adjustsFontSizeToFitWidth;
 @property (nonatomic, readonly) NSTextAlignment textAlignment;
+@property (nonatomic, readonly) NSArray<IASKSpecifier*>* multiValueChildSpecifiers;
 
 - (nullable NSString*)localizedObjectForKey:(NSString*)key;
 - (nullable NSString*)titleForCurrentValue:(nullable id)currentValue;
diff --git a/Tests/InAppSettingsKitTests/IASKSettingsReaderTests.m b/Tests/InAppSettingsKitTests/IASKSettingsReaderTests.m

Original file line number	Diff line number	Diff line change
`@@ -193,14 +193,14 @@ extension MainViewController: IASKSettingsDelegate {`
`193`	`193`	`}`
`194`	`194`
`195`	`195`	`func settingsViewController(_ settingsViewController: IASKAppSettingsViewController, valuesFor specifier: IASKSpecifier) -> [Any] {`
`196`		`- return specifier.key == "countryCode" ? Locale.isoRegionCodes : []`
	`196`	`+ return specifier.key == "countryCode" ? Locale.isoRegionCodes : ["Chicago", "Seattle", "Miami"]`
`197`	`197`	`}`
`198`	`198`
`199`		`- func settingsViewController(_ settingsViewController: IASKAppSettingsViewController, titlesFor specifier: IASKSpecifier) -> [Any] {`
	`199`	`+ func settingsViewController(_ settingsViewController: IASKAppSettingsViewController, titlesFor specifier: IASKSpecifier) -> [String] {`
`200`	`200`	`if specifier.key == "countryCode" {`
`201`	`201`	`return Locale.isoRegionCodes.map{Locale.current.localizedString(forRegionCode: $0) ?? ""}`
`202`	`202`	`}`
`203`		`- return []`
	`203`	`+ return ["Chicago", "Seattle", "Miami"]`
`204`	`204`	`}`
`205`	`205`
`206`	`206`	`func settingsViewController(_ settingsViewController: IASKAppSettingsViewController, childPaneIsValidFor specifier: IASKSpecifier, contentDictionary: NSMutableDictionary) -> Bool {`