Fix an issue where changing a table collation could cause an exception (fixes #2320)

This issue probably was introduced in f02fb787063caabe246a0ee420394f5676c55a9c

The empty item at the top of the collation list will now no longer have a selection mark, though.

3 files changed, 106 insertions, 7 deletions

diff --git a/Source/SPPopUpButtonCell.h b/Source/SPPopUpButtonCell.h
new file mode 100644
index 00000000..52c8a074
--- /dev/null
+++ b/Source/SPPopUpButtonCell.h
@@ -0,0 +1,48 @@
+//
+//  SPPopUpButtonCell.h
+//  sequel-pro
+//
+//  Created by Max Lohrmann on 10.11.15.
+//  Copyright (c) 2015 Max Lohrmann. All rights reserved.
+//
+//  Permission is hereby granted, free of charge, to any person
+//  obtaining a copy of this software and associated documentation
+//  files (the "Software"), to deal in the Software without
+//  restriction, including without limitation the rights to use,
+//  copy, modify, merge, publish, distribute, sublicense, and/or sell
+//  copies of the Software, and to permit persons to whom the
+//  Software is furnished to do so, subject to the following
+//  conditions:
+//
+//  The above copyright notice and this permission notice shall be
+//  included in all copies or substantial portions of the Software.
+//
+//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+//  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+//  OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+//  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+//  HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+//  WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+//  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+//  OTHER DEALINGS IN THE SOFTWARE.
+//
+//  More info at <https://github.com/sequelpro/sequelpro>
+
+#import <Cocoa/Cocoa.h>
+
+/**
+ * The only difference here is that objectValue/setObjectValue:
+ * will use the representedObject of the menu instead of the menu item's index
+ *
+ * nil will act the same as @(-1) would with the regular NSPopUpButtonCell.
+ *
+ * Note that in theory multiple menu items could have the same representedObject
+ * and identification is done via isEqual: so this class would only ever
+ * pick the first one.
+ */
+@interface SPPopUpButtonCell : NSPopUpButtonCell
+
+- (id)objectValue;
+- (void)setObjectValue:(id)objectValue;
+
+@end
diff --git a/Source/SPPopUpButtonCell.m b/Source/SPPopUpButtonCell.m
new file mode 100644
index 00000000..a20a2d92
--- /dev/null
+++ b/Source/SPPopUpButtonCell.m
@@ -0,0 +1,51 @@
+//
+//  SPPopUpButtonCell.m
+//  sequel-pro
+//
+//  Created by Max Lohrmann on 10.11.15.
+//  Copyright (c) 2015 Max Lohrmann. All rights reserved.
+//
+//  Permission is hereby granted, free of charge, to any person
+//  obtaining a copy of this software and associated documentation
+//  files (the "Software"), to deal in the Software without
+//  restriction, including without limitation the rights to use,
+//  copy, modify, merge, publish, distribute, sublicense, and/or sell
+//  copies of the Software, and to permit persons to whom the
+//  Software is furnished to do so, subject to the following
+//  conditions:
+//
+//  The above copyright notice and this permission notice shall be
+//  included in all copies or substantial portions of the Software.
+//
+//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+//  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+//  OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+//  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+//  HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+//  WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+//  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+//  OTHER DEALINGS IN THE SOFTWARE.
+//
+//  More info at <https://github.com/sequelpro/sequelpro>
+
+#import "SPPopUpButtonCell.h"
+
+@implementation SPPopUpButtonCell
+
+- (id)objectValue
+{
+	NSInteger n = [[super objectValue] integerValue];
+	
+	// this method can be called for invalid selections, which return -1, which fails with itemAtIndex:
+	if(n < 0 || n >= [self numberOfItems]) return nil;
+	
+	return [[self itemAtIndex:n] representedObject];
+}
+
+- (void)setObjectValue:(id)objectValue
+{
+	NSInteger n = [self indexOfItemWithRepresentedObject:objectValue];
+	[super setObjectValue:@(n)];
+}
+
+@end
diff --git a/Source/SPTableStructureDelegate.m b/Source/SPTableStructureDelegate.m
index da173271..a7fa9337 100644
--- a/Source/SPTableStructureDelegate.m
+++ b/Source/SPTableStructureDelegate.m
@@ -102,7 +102,7 @@ static void _BuildMenuWithPills(NSMenu *menu,struct _cmpMap *map,size_t mapEntri
 		[[collationCell lastItem] setTitle:@""];
 
 		//if this is not set the column either has no encoding (numeric etc.) or retrieval failed. Either way we can't provide collations
-		if(columnEncoding) {
+		if([columnEncoding length]) {
 			collations = [databaseDataInstance getDatabaseCollationsForEncoding:columnEncoding];
 
 			if ([collations count] > 0) {
@@ -129,19 +129,18 @@ static void _BuildMenuWithPills(NSMenu *menu,struct _cmpMap *map,size_t mapEntri
 					}
 				}
 
-				//look up the right item
-				NSInteger idx = [collationCell indexOfItemWithRepresentedObject:columnCollation];
-				if(idx > 0) return @(idx);
+				// the popup cell is subclassed to take the representedObject instead of the item index
+				return columnCollation;
 			}
 		}
 
-		return @0;
+		return nil;
 	}
 	else if ([[tableColumn identifier] isEqualToString:@"encoding"]) {
 		// the encoding menu was already configured during setTableDetails:
 		NSString *columnEncoding = [rowData objectForKey:@"encodingName"];
 
-		if(columnEncoding) {
+		if([columnEncoding length]) {
 			NSInteger idx = [encodingPopupCell indexOfItemWithRepresentedObject:columnEncoding];
 			if(idx > 0) return @(idx);
 		}
@@ -193,7 +192,8 @@ static void _BuildMenuWithPills(NSMenu *menu,struct _cmpMap *map,size_t mapEntri
 		return;
 	}
 	else if ([[aTableColumn identifier] isEqualToString:@"collation"]) {
-		NSString *newCollation = [[(NSPopUpButtonCell *)[aTableColumn dataCell] itemAtIndex:[anObject integerValue]] representedObject];
+		//the popup button is subclassed to return the representedObject instead of the item index
+		NSString *newCollation = anObject;
 
 		if(!newCollation)
 			[currentRow removeObjectForKey:@"collationName"];