Fix file loading pathing from the Swift Package Manager bundles. Previous bundle logic will not work the same from Cocoapods.

Author: paulsolt-ofsw

.gitignore

@@ -5,3 +5,4 @@ Pods
 xcuserdata/
 *.swp
 Carthage/
+.build/

Package.resolved

@@ -2,6 +2,9 @@
 
 import PackageDescription
 
+/// Swift Package Conversion Notes:
+/// * Added all the same resources and updated multiple call sites to load from NSBundle to SWIFTPM_MODULE_BUNDLE
+/// * Tests require UIKit and take a long time to run
 let package = Package(
     name: "GeoPackage",
     defaultLocalization: "en",
@@ -83,7 +86,6 @@ let package = Package(
                 .copy("tractor.png"),
                 .copy("webMercator.png"),
                 .copy("point.png"),
-                
             ],
             cSettings: [
                 .headerSearchPath(""),

Package.swift

@@ -23,28 +23,10 @@ +(NSString *) propertyListPathWithName: (NSString *) name{
 }
 
 +(NSString *) resourcePathWithName: (NSString *) name andType: (NSString *) type{
-    
-    NSString *resource = [NSString stringWithFormat:@"%@/%@", GPKG_BUNDLE_NAME, name];
-    NSString *resourcePath = [[NSBundle mainBundle] pathForResource:resource ofType:type];
-    
-    // FIXME: Paul cleanup if SPM is only way to load
-    if (resourcePath == nil) {
-        resourcePath = [SWIFTPM_MODULE_BUNDLE pathForResource:name ofType:type];
-    }
-    
-    if(resourcePath == nil){
-        resourcePath = [[NSBundle bundleForClass:[self class]] pathForResource:resource ofType:type];
-        if(resourcePath == nil){
-            resourcePath = [[NSBundle bundleForClass:[self class]] pathForResource:name ofType:type];
-            if(resourcePath == nil){
-                resourcePath = [[NSBundle mainBundle] pathForResource:name ofType:type];
-            }
-        }
-    }
+    NSString *resourcePath = [SWIFTPM_MODULE_BUNDLE pathForResource:name ofType:type];
     if(resourcePath == nil){
         [NSException raise:@"Resource Not Found" format:@"Failed to find resource '%@' of type '%@'", name, type];
     }
-    
     return resourcePath;
 }
 

geopackage-ios/io/GPKGIOUtils.m

@@ -0,0 +1,23 @@
+//
+//  GPKGBundleHelper.h
+//  GeoPackage
+//
+//  Created by Paul Solt on 5/9/25.
+//
+
+#import <Foundation/Foundation.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+/// Helper for loading resources from Bundles to make resource loading compatible with SPM
+/// and previous bundle loading logic. Checks SPM bundle, then main bundle, then bundle for class.
+@interface GPKGBundleHelper : NSObject
+
+/// Loads a resource from a bundle (i.e., myFile.txt)
++ (NSString *)pathForResource:(NSString *)resource;
+
++ (NSString *)resourcePath;
+
+@end
+
+NS_ASSUME_NONNULL_END

geopackage-iosTests/GPKGBundleHelper.h

@@ -0,0 +1,27 @@
+//
+//  GPKGBundleHelper.m
+//  GeoPackage
+//
+//  Created by Paul Solt on 5/9/25.
+//
+
+#import "GPKGBundleHelper.h"
+
+@implementation GPKGBundleHelper
+
++ (NSString *)pathForResource:(NSString *)resource {
+    NSString *filename = [resource stringByDeletingPathExtension];
+    NSString *extension = [resource pathExtension];
+    NSString *path = [SWIFTPM_MODULE_BUNDLE pathForResource:filename ofType:extension];
+
+    if (!path) {
+        NSLog(@"Error: Unable to find file in bundle: %@", resource);
+    }
+    return path;
+}
+
++ (NSString *)resourcePath {
+    return [SWIFTPM_MODULE_BUNDLE resourcePath];
+}
+
+@end

geopackage-iosTests/GPKGBundleHelper.m

@@ -8,9 +8,8 @@
 
 #import "GPKGGeoPackageExample.h"
 #import "GPKGTestUtils.h"
-
 #import "GPKGRelatedTablesUtils.h"
-
+#import "GPKGBundleHelper.h"
 
 @import Projections;
 @import GeoPackage;
@@ -700,7 +699,7 @@ +(void) createTilesWithGeoPackage: (GPKGGeoPackage *) geoPackage andName: (NSStr
 
     GPKGTileMatrixDao *tileMatrixDao = [geoPackage tileMatrixDao];
 
-    NSString *resourcePath  = [[NSBundle bundleForClass:[GPKGGeoPackageExample class]] resourcePath];
+    NSString *resourcePath  = [GPKGBundleHelper resourcePath];
 
     GPKGTileGrid *tileGrid = totalTileGrid;
 
@@ -1428,7 +1427,7 @@ +(void) insertRelatedTablesMediaExtensionRowsWithGeoPackage: (GPKGGeoPackage *)
     GPKGUserMappingDao *userMappingDao = [relatedTables mappingDaoForRelation:relation];
 
     GPKGMediaRow *mediaRow = [mediaDao newRow];
-    NSString *mediaPath  = [[[NSBundle bundleForClass:[GPKGGeoPackageExample class]] resourcePath] stringByAppendingPathComponent:file];
+    NSString *mediaPath = [GPKGBundleHelper pathForResource:file];
     NSData *mediaData = [[NSFileManager defaultManager] contentsAtPath:mediaPath];
     [mediaRow setData:mediaData];
     [mediaRow setContentType:contentType];
@@ -1738,7 +1737,7 @@ +(void) createFeatureStyleExtensionWithGeoPackage: (GPKGGeoPackage *) geoPackage
 
     NSMutableArray<GPKGIconRow *> *icons = [NSMutableArray array];
 
-    NSString *buildingPath  = [[[NSBundle bundleForClass:[GPKGGeoPackageExample class]] resourcePath] stringByAppendingPathComponent:@"building.png"];
+    NSString *buildingPath = [GPKGBundleHelper pathForResource:@"building.png"];
     GPKGIconRow *icon1 = [[GPKGIconRow alloc] init];
     [icon1 setName:@"Building"];
     [icon1 setDescription:@"Building Icon"];
@@ -1749,7 +1748,7 @@ +(void) createFeatureStyleExtensionWithGeoPackage: (GPKGGeoPackage *) geoPackage
     [icon1 setAnchorVValue:1.0];
     [icons addObject:icon1];
 
-    NSString *collegePath  = [[[NSBundle bundleForClass:[GPKGGeoPackageExample class]] resourcePath] stringByAppendingPathComponent:@"college.png"];
+    NSString *collegePath = [GPKGBundleHelper pathForResource:@"college.png"];
     GPKGIconRow *icon2 = [[GPKGIconRow alloc] init];
     [icon2 setName:@"College"];
     [icon2 setDescription:@"College Icon"];
@@ -1759,7 +1758,7 @@ +(void) createFeatureStyleExtensionWithGeoPackage: (GPKGGeoPackage *) geoPackage
     [icon2 setHeightValue:44.0];
     [icons addObject:icon2];
 
-    NSString *tractorPath  = [[[NSBundle bundleForClass:[GPKGGeoPackageExample class]] resourcePath] stringByAppendingPathComponent:@"tractor.png"];
+    NSString *tractorPath = [GPKGBundleHelper pathForResource:@"tractor.png"];
     GPKGIconRow *icon3 = [[GPKGIconRow alloc] init];
     [icon3 setName:@"Tractor"];
     [icon3 setDescription:@"Tractor Icon"];

geopackage-iosTests/GPKGGeoPackageExample.m

@@ -8,6 +8,7 @@
 
 #import "GPKGImportCoverageDataGeoPackageTestCase.h"
 #import "GPKGTestConstants.h"
+#import "GPKGBundleHelper.h"
 
 @import GeoPackage;
 
@@ -20,7 +21,7 @@ -(GPKGGeoPackage *) createGeoPackage{
     // Delete
     [manager delete:GPKG_TEST_IMPORT_COVERAGE_DATA_DB_NAME];
 
-    NSString *filePath  = [[[NSBundle bundleForClass:[GPKGImportCoverageDataGeoPackageTestCase class]] resourcePath] stringByAppendingPathComponent:GPKG_TEST_IMPORT_COVERAGE_DATA_DB_FILE_NAME];
+    NSString *filePath = [GPKGBundleHelper pathForResource:GPKG_TEST_IMPORT_COVERAGE_DATA_DB_FILE_NAME];
 
     // Import
     [manager importGeoPackageFromPath:filePath withName:GPKG_TEST_IMPORT_COVERAGE_DATA_DB_NAME];

geopackage-iosTests/GPKGImportCoverageDataGeoPackageTestCase.m

@@ -8,6 +8,7 @@
 
 #import "GPKGImportCoverageDataTiffGeoPackageTestCase.h"
 #import "GPKGTestConstants.h"
+#import "GPKGBundleHelper.h"
 
 @import GeoPackage;
 
@@ -20,7 +21,7 @@ -(GPKGGeoPackage *) createGeoPackage{
     // Delete
     [manager delete:GPKG_TEST_IMPORT_COVERAGE_DATA_TIFF_DB_NAME];
 
-    NSString *filePath  = [[[NSBundle bundleForClass:[GPKGImportCoverageDataTiffGeoPackageTestCase class]] resourcePath] stringByAppendingPathComponent:GPKG_TEST_IMPORT_COVERAGE_DATA_TIFF_DB_FILE_NAME];
+    NSString *filePath = [GPKGBundleHelper pathForResource:GPKG_TEST_IMPORT_COVERAGE_DATA_TIFF_DB_FILE_NAME];
 
     // Import
     [manager importGeoPackageFromPath:filePath withName:GPKG_TEST_IMPORT_COVERAGE_DATA_TIFF_DB_NAME];

geopackage-iosTests/GPKGImportCoverageDataTiffGeoPackageTestCase.m

@@ -7,6 +7,7 @@
 //
 
 #import "GPKGLoadGeoPackageTestCase.h"
+#import "GPKGBundleHelper.h"
 
 @import GeoPackage;
 
@@ -27,7 +28,7 @@ -(GPKGGeoPackage *) createGeoPackage{
     // Delete
     [manager delete:self.dbName];
 
-    NSString *filePath  = [[[NSBundle bundleForClass:[GPKGLoadGeoPackageTestCase class]] resourcePath] stringByAppendingPathComponent:self.file];
+    NSString *filePath = [GPKGBundleHelper pathForResource:self.file];
 
     // Import
     [manager importGeoPackageFromPath:filePath withName:self.dbName];