Add test resource.

Author: jblues

.idea/XcodeEditor.iml

@@ -9,12 +9,12 @@ An API for manipulating Xcode project files.
 
 ```objective-c
 XCProject* project = [[XCProject alloc] initWithFilePath:@"MyProject.xcodeproj"];
-XCGroup* group = [project groupWithPathFromRoot:@"Main"];
+XCGroup* _group = [project groupWithPathFromRoot:@"Main"];
 XCClassDefinition* classDefinition = [[XCClassDefinition alloc] initWithName:@"MyNewClass"];
 [classDefinition setHeader:@"<some-header-text>"];
 [classDefinition setSource:@"<some-impl-text>"];
 
-[group addClass:classDefinition];
+[_group addClass:classDefinition];
 [project save];
 ```
 
@@ -44,7 +44,7 @@ This time, we'll use a convenience method on XCGroup to specify the targets at t
 
 ```objective-c
 XCXibDefinition* xibDefinition = [[XCXibDefinition alloc] initWithName:@"MyXibFile" content:@"<xibXml>"];
-[group addXib:xibDefinition toTargets:[project targets]];
+[_group addXib:xibDefinition toTargets:[project targets]];
 [project save];
 ```
 
@@ -54,10 +54,10 @@ XCXibDefinition* xibDefinition = [[XCXibDefinition alloc] initWithName:@"MyXibFi
 ```objective-c
 XCFrameworkDefinition* frameworkDefinition =
     [[XCFrameworkDefinition alloc] initWithFilePath:@"<framework path>" copyToDestination:NO];
-[group addFramework:frameworkDefinition toTargets:[project targets]];
+[_group addFramework:frameworkDefinition toTargets:[project targets]];
 [project save];
 ```
-Setting copyToDestination to YES, will cause the framework to be first copied to the group's directory within the 
+Setting copyToDestination to YES, will cause the framework to be first copied to the _group's directory within the
 project, and subsequently linked from there. 
 
 ### Adding an Image Resource
@@ -68,7 +68,7 @@ XCSourceFileDefinition* sourceFileDefinition = [[XCSourceFileDefinition alloc]
     initWithName:@"MyImageFile.png" data:[NSData dataWithContentsOfFile:<your image file name>]
     type:ImageResourcePNG];
 
-[group addSourceFile:sourceFileDefinition];
+[_group addSourceFile:sourceFileDefinition];
 [project save];
 ```
 
@@ -78,7 +78,7 @@ XCSourceFileDefinition* sourceFileDefinition = [[XCSourceFileDefinition alloc]
 
 XCSourceFileDefinition* sourceFileDefinition = [XCSourceFileDefinition sourceDefinitionWithAssetCatalogName:<path to asset catalog>];
 
-[group addSourceFile:sourceFileDefinition];
+[_group addSourceFile:sourceFileDefinition];
 [project save];
 ```
 
@@ -88,20 +88,20 @@ XCSourceFileDefinition* sourceFileDefinition = [XCSourceFileDefinition sourceDef
 XCSourceFileDefinition* header = [[XCSourceFileDefinition alloc]
     initWithName:@"SomeHeader.h" text:<your header text> type:SourceCodeHeader];
 
-[group addSourceFile:header];
+[_group addSourceFile:header];
 [project save];
 ```
 
 ### Adding a sub-project
 
 ```objective-c
 subProjectDefinition = [XCSubProjectDefinition withName:@"mySubproject" projPath=@"/Path/To/Subproject" type:XcodeProject];
-[group addSubProject:subProjectDefinition toTargets:[project targets]];
+[_group addSubProject:subProjectDefinition toTargets:[project targets]];
 ```
 
 ### Removing a sub-project
 ```objective-c
-[group removeSubProject:subProjectDefinition];  //TODO: project should be able to remove itself from parent.
+[_group removeSubProject:subProjectDefinition];  //TODO: project should be able to remove itself from parent.
 ```
 
 ### Configuring targets

.idea/runConfigurations/Tests.xml

@@ -25,7 +25,7 @@
 
 
 /**
-* Represents a group container in an Xcode project. A group can contain members of type `XCSourceFile` or other
+* Represents a _group container in an Xcode project. A _group can contain members of type `XCSourceFile` or other
 * groups.
 */
 @interface XCGroup : NSObject <XcodeGroupMember>
@@ -48,21 +48,21 @@
 
 
 /**
- * The alias of the group, which can be used to give the group a name other than the last path component.
+ * The alias of the _group, which can be used to give the _group a name other than the last path component.
  *
  * See: [XcodeGroupMember displayName]
  */
 @property(nonatomic, strong, readonly) NSString* alias;
 
 /**
- * The path of the group relative to the group's parent.
+ * The path of the _group relative to the _group's parent.
  *
  * See: [XcodeGroupMember displayName]
 */
 @property(nonatomic, strong, readonly) NSString* pathRelativeToParent;
 
 /**
- * The group's unique key.
+ * The _group's unique key.
 */
 @property(nonatomic, strong, readonly) NSString* key;
 
@@ -78,7 +78,7 @@
 
 - (id)initWithProject:(XCProject*)project key:(NSString*)key alias:(NSString*)alias path:(NSString*)path children:(NSArray<id<XcodeGroupMember>>*)children;
 
-#pragma mark Parent group
+#pragma mark Parent _group
 
 - (void)removeFromParentGroup;
 
@@ -90,24 +90,24 @@
 
 #pragma mark Adding children
 /**
- * Adds a class to the group, as specified by the ClassDefinition. If the group already contains a class by the same
+ * Adds a class to the _group, as specified by the ClassDefinition. If the _group already contains a class by the same
  * name, the contents will be updated.
 */
 - (void)addClass:(XCClassDefinition*)classDefinition;
 
 /**
- * Adds a class to the group, making it a member of the specified [targets](XCTarget).
+ * Adds a class to the _group, making it a member of the specified [targets](XCTarget).
 */
 - (void)addClass:(XCClassDefinition*)classDefinition toTargets:(NSArray<XCTarget*>*)targets;
 
 /**
-* Adds a framework to the group. If the group already contains the framework, the contents will be updated if the
+* Adds a framework to the _group. If the _group already contains the framework, the contents will be updated if the
 * framework definition's copyToDestination flag is yes, otherwise it will be ignored.
 */
 - (void)addFramework:(XCFrameworkDefinition*)frameworkDefinition;
 
 /**
-* Adds a group with a path relative to this group.
+* Adds a _group with a path relative to this _group.
 */
 - (XCGroup*)addGroupWithPath:(NSString*)path;
 
@@ -117,7 +117,7 @@
 - (void)addFolderReference:(NSString*)sourceFolder;
 
 /**
-* Adds a framework to the group, making it a member of the specified targets.
+* Adds a framework to the _group, making it a member of the specified targets.
 */
 - (void)addFramework:(XCFrameworkDefinition*)framework toTargets:(NSArray<XCTarget*>*)targets;
 
@@ -128,25 +128,25 @@
 
 
 /**
- * Adds a xib file to the group. If the group already contains a class by the same name, the contents will be updated.
+ * Adds a xib file to the _group. If the _group already contains a class by the same name, the contents will be updated.
 */
 - (void)addXib:(XCXibDefinition*)xibDefinition;
 
 /**
- * Adds a xib to the group, making it a member of the specified [targets](XCTarget).
+ * Adds a xib to the _group, making it a member of the specified [targets](XCTarget).
 */
 - (void)addXib:(XCXibDefinition*)xibDefinition toTargets:(NSArray<XCTarget*>*)targets;
 
 /**
- * Adds a sub-project to the group. If the group already contains a sub-project by the same name, the contents will be
+ * Adds a sub-project to the _group. If the _group already contains a sub-project by the same name, the contents will be
  * updated.
  * Returns boolean success/fail; if method fails, caller should assume that project file is corrupt (or file format has
  * changed).
 */
 - (void)addSubProject:(XCSubProjectDefinition*)projectDefinition;
 
 /**
-* Adds a sub-project to the group, making it a member of the specified [targets](XCTarget).
+* Adds a sub-project to the _group, making it a member of the specified [targets](XCTarget).
 */
 - (void)addSubProject:(XCSubProjectDefinition*)projectDefinition toTargets:(NSArray<XCTarget*>*)targets;
 
@@ -162,12 +162,12 @@
 - (NSArray<id<XcodeGroupMember>>*)members;
 
 /**
-* Keys of members from this group and any child groups.
+* Keys of members from this _group and any child groups.
 */
 - (NSArray<NSString*>*)recursiveMembers;
 
 /**
- * Keys of members from this group
+ * Keys of members from this _group
  */
 - (NSArray<NSString*>*)buildFileKeys;
 

README.md

@@ -66,7 +66,7 @@ - (id)initWithProject:(XCProject *)project key:(NSString *)key alias:(NSString *
 #pragma mark - Interface Methods
 //-------------------------------------------------------------------------------------------
 
-#pragma mark Parent group
+#pragma mark Parent _group
 
 - (void)removeFromParentGroup
 {
@@ -246,10 +246,10 @@ - (void)addXib:(XCXibDefinition *)xibDefinition toTargets:(NSArray *)targets
 // adds an xcodeproj as a subproject of the current project.
 - (void)addSubProject:(XCSubProjectDefinition *)projectDefinition
 {
-    // set up path to the xcodeproj file as Xcode sees it - path to top level of project + group path if any
+    // set up path to the xcodeproj file as Xcode sees it - path to top level of project + _group path if any
     [projectDefinition initFullProjectPath:_project.filePath groupPath:[self pathRelativeToParent]];
 
-    // create PBXFileReference for xcodeproj file and add to PBXGroup for the current group
+    // create PBXFileReference for xcodeproj file and add to PBXGroup for the current _group
     // (will retrieve existing if already there)
     [self makeGroupMemberWithName:[projectDefinition projectFileName] path:[projectDefinition pathRelativeToProjectRoot]
                              type:XcodeProject fileOperationStyle:[projectDefinition fileOperationType]];
@@ -284,18 +284,18 @@ - (void)removeSubProject:(XCSubProjectDefinition *)projectDefinition
         return;
     }
 
-    // set up path to the xcodeproj file as Xcode sees it - path to top level of project + group path if any
+    // set up path to the xcodeproj file as Xcode sees it - path to top level of project + _group path if any
     [projectDefinition initFullProjectPath:_project.filePath groupPath:[self pathRelativeToParent]];
 
     NSString *xcodeprojKey = [projectDefinition projectKey];
 
-    // Remove from group and remove PBXFileReference
+    // Remove from _group and remove PBXFileReference
     [self removeGroupMemberWithKey:xcodeprojKey];
 
     // remove PBXContainerItemProxies and PBXReferenceProxies
     [_project removeProxies:xcodeprojKey];
 
-    // get the key for the Products group
+    // get the key for the Products _group
     NSString *productsGroupKey = [_project productsGroupKeyForKey:xcodeprojKey];
 
     // remove from the ProjectReferences array of PBXProject
@@ -304,7 +304,7 @@ - (void)removeSubProject:(XCSubProjectDefinition *)projectDefinition
     // remove PDXBuildFile entries
     [self removeProductsGroupFromProject:productsGroupKey];
 
-    // remove Products group
+    // remove Products _group
     [[_project objects] removeObjectForKey:productsGroupKey];
 
     // remove from all targets
@@ -317,7 +317,7 @@ - (void)removeSubProject:(XCSubProjectDefinition *)projectDefinition fromTargets
         return;
     }
 
-    // set up path to the xcodeproj file as Xcode sees it - path to top level of project + group path if any
+    // set up path to the xcodeproj file as Xcode sees it - path to top level of project + _group path if any
     [projectDefinition initFullProjectPath:_project.filePath groupPath:[self pathRelativeToParent]];
 
     NSString *xcodeprojKey = [projectDefinition projectKey];
@@ -527,7 +527,7 @@ - (void)makeGroupMemberWithName:(NSString *)name contents:(id)contents type:(Xco
 
 #pragma mark Xcodeproj methods
 
-// creates PBXFileReference and adds to group if not already there;  returns key for file reference.  Locates
+// creates PBXFileReference and adds to _group if not already there;  returns key for file reference.  Locates
 // member via path rather than name, because that is how subprojects are stored by Xcode
 - (void)makeGroupMemberWithName:(NSString *)name path:(NSString *)path type:(XcodeSourceFileType)type
              fileOperationStyle:(XCFileOperationType)fileOperationStyle
@@ -541,7 +541,7 @@ - (void)makeGroupMemberWithName:(NSString *)name path:(NSString *)path type:(Xco
     }
 }
 
-// makes a new group called Products and returns its key
+// makes a new _group called Products and returns its key
 - (NSString *)makeProductsGroup:(XCSubProjectDefinition *)xcodeprojDefinition
 {
     NSMutableArray *children = [NSMutableArray array];
@@ -557,7 +557,7 @@ - (NSString *)makeProductsGroup:(XCSubProjectDefinition *)xcodeprojDefinition
     return productKey;
 }
 
-// makes a new Products group (by calling the method above), makes a new projectReferences array for it and
+// makes a new Products _group (by calling the method above), makes a new projectReferences array for it and
 // then adds it to the PBXProject object
 - (void)addProductsGroupToProject:(XCSubProjectDefinition *)xcodeprojDefinition
 {
@@ -578,7 +578,7 @@ - (void)addProductsGroupToProject:(XCSubProjectDefinition *)xcodeprojDefinition
     PBXProjectDict[@"projectReferences"] = projectReferences;
 }
 
-// removes PBXFileReference from group and project
+// removes PBXFileReference from _group and project
 - (void)removeGroupMemberWithKey:(NSString *)key
 {
     NSMutableArray *children = [self valueForKey:@"children"];
@@ -611,7 +611,7 @@ - (void)removeBuildPhaseFileKey:(NSString *)key forType:(XcodeMemberType)memberT
 // removes entries from PBXBuildFiles, PBXFrameworksBuildPhase and PBXResourcesBuildPhase
 - (void)removeProductsGroupFromProject:(NSString *)key
 {
-    // remove product group's build products from PDXBuildFiles
+    // remove product _group's build products from PDXBuildFiles
     NSDictionary *productsGroup = _project.objects[key];
     for (NSString *childKey in [productsGroup valueForKey:@"children"]) {
         NSArray *buildFileKeys =
@@ -643,7 +643,7 @@ - (NSDictionary *)makeFileReferenceWithPath:(NSString *)path name:(NSString *)na
     if (path != nil) {
         reference[@"path"] = path;
     }
-    reference[@"sourceTree"] = @"<group>";
+    reference[@"sourceTree"] = @"<_group>";
     return reference;
 }
 
@@ -652,7 +652,7 @@ - (NSDictionary *)asDictionary
 {
     NSMutableDictionary *groupData = [NSMutableDictionary dictionary];
     groupData[@"isa"] = [NSString xce_stringFromMemberType:PBXGroupType];
-    groupData[@"sourceTree"] = @"<group>";
+    groupData[@"sourceTree"] = @"<_group>";
 
     if (_alias != nil) {
         groupData[@"name"] = _alias;

Source/XCGroup.h

@@ -311,7 +311,7 @@ - (void)removeProxies:(NSString *)xcodeprojKey
     }];
 }
 
-// returns the Products group key for the given PBXFileReference key, nil if not found.
+// returns the Products _group key for the given PBXFileReference key, nil if not found.
 - (NSString *)productsGroupKeyForKey:(NSString *)key
 {
     NSMutableArray *projectReferences = [[self PBXProjectDict] valueForKey:@"projectReferences"];

Source/XCGroup.m

@@ -104,7 +104,7 @@
 - (NSArray<XCGroup*>*)groups;
 
 /**
- * Returns the root (top-level) group.
+ * Returns the root (top-level) _group.
  */
 - (XCGroup*)rootGroup;
 
@@ -114,22 +114,22 @@
 - (NSArray<XCGroup*>*)rootGroups;
 
 /**
-* Returns the group with the given key, or nil.
+* Returns the _group with the given key, or nil.
 */
 - (XCGroup*)groupWithKey:(NSString*)key;
 
 /**
- * Returns the group with the specified display name path - the directory relative to the root group. Eg Source/Main
+ * Returns the _group with the specified display name path - the directory relative to the root _group. Eg Source/Main
  */
 - (XCGroup*)groupWithPathFromRoot:(NSString*)path;
 
 /**
-* Returns the parent group for the group or file with the given key;
+* Returns the parent _group for the _group or file with the given key;
 */
 - (XCGroup*)groupForGroupMemberWithKey:(NSString*)key;
 
 /**
- * Returns the parent group for the group or file with the source file
+ * Returns the parent _group for the _group or file with the source file
  */
 - (XCGroup*)groupWithSourceFile:(XCSourceFile*)sourceFile;