feat(pbxproj): auto set fs_reference parent

Author: kkharji

src/pbxproj/object/collection.rs

@@ -58,7 +58,7 @@ impl PBXObjectCollection {
             .collect()
     }
 
-    fn fs_references<'a>(
+    pub(crate) fn get_fs_references<'a>(
         &'a self,
         predict: fn(Ref<PBXFSReference>) -> bool,
     ) -> Vec<(String, Rc<RefCell<PBXFSReference>>)> {
@@ -74,9 +74,16 @@ impl PBXObjectCollection {
             .collect()
     }
 
+    pub(crate) fn fs_references<'a>(&'a self) -> Vec<(String, Rc<RefCell<PBXFSReference>>)> {
+        self.iter()
+            .map(|(k, o)| Some((k.clone(), o.as_pbxfs_reference()?.clone())))
+            .flatten()
+            .collect()
+    }
+
     /// Get all PBXGroup
     pub fn groups<'a>(&'a self) -> Vec<(String, Rc<RefCell<PBXFSReference>>)> {
-        self.fs_references(|fs_reference| fs_reference.is_group())
+        self.get_fs_references(|fs_reference| fs_reference.is_group())
     }
 
     /// Get all PBXProject
@@ -89,7 +96,7 @@ impl PBXObjectCollection {
 
     /// Get all files
     pub fn files<'a>(&'a self) -> Vec<(String, Rc<RefCell<PBXFSReference>>)> {
-        self.fs_references(|fs_reference| fs_reference.is_file())
+        self.get_fs_references(|fs_reference| fs_reference.is_file())
     }
 
     /// Get all PBXBuildFile

src/pbxproj/object/fs/mod.rs

@@ -2,8 +2,13 @@ mod kind;
 mod obj;
 mod setget;
 mod source_tree;
+
 use super::*;
-use std::{cell::RefCell, collections::HashSet, rc::Rc};
+use std::{
+    cell::RefCell,
+    collections::HashSet,
+    rc::{Rc, Weak},
+};
 
 pub use kind::*;
 pub use source_tree::*;
@@ -50,22 +55,11 @@ pub struct PBXFSReference {
     /// Version group type. (only relevant for XCVersionGroup)
     version_group_type: Option<String>,
 
-    pub(crate) parent_reference: Option<String>,
+    parent: Weak<RefCell<Self>>,
     pub(crate) objects: WeakPBXObjectCollection,
 }
 
 impl PBXFSReference {
-    /// Get a reference to the pbxfile element's parent reference.
-    #[must_use]
-    pub fn parent(&self) -> Option<Rc<RefCell<PBXFSReference>>> {
-        self.objects
-            .upgrade()?
-            .borrow()
-            .get(self.parent_reference.as_ref()?)?
-            .as_pbxfs_reference()
-            .map(|r| r.clone())
-    }
-
     /// Get Group children.
     /// WARN: This will return empty if self is of type file
     pub fn children(&self) -> Vec<Rc<RefCell<PBXFSReference>>> {
@@ -105,6 +99,27 @@ impl PBXFSReference {
                 }
             })
     }
+
+    pub(crate) fn assign_parent_to_children(&self, this: Weak<RefCell<Self>>) {
+        if self.is_group() {
+            self.children().into_iter().for_each(|o| {
+                let mut fs_reference = o.borrow_mut();
+                fs_reference.parent = this.clone();
+                fs_reference.assign_parent_to_children(Rc::downgrade(&o))
+            });
+        }
+    }
+
+    /// Set the pbxfsreference's parent.
+    pub fn set_parent(&mut self, parent: Weak<RefCell<Self>>) {
+        self.parent = parent;
+    }
+
+    /// Get a reference to the pbxfsreference's parent.
+    #[must_use]
+    pub fn parent(&self) -> Option<Rc<RefCell<Self>>> {
+        self.parent.upgrade()
+    }
 }
 
 impl Eq for PBXFSReference {}
@@ -114,7 +129,6 @@ impl PartialEq for PBXFSReference {
             && self.source_tree == other.source_tree
             && self.path == other.path
             && self.name == other.name
-            && self.parent_reference == other.parent_reference
             && self.children_references == other.children_references
             && self.current_version_reference == other.current_version_reference
             && self.version_group_type == other.version_group_type
@@ -134,3 +148,29 @@ impl PartialEq for PBXFSReference {
                 == other.plist_structure_definition_identifier
     }
 }
+
+#[test]
+fn test_parent() {
+    use crate::pbxproj::test_demo_file;
+    let project = test_demo_file!(demo1);
+    let main_group = project
+        .objects()
+        .projects()
+        .first()
+        .unwrap()
+        .1
+        .borrow()
+        .main_group();
+
+    let main_group = main_group.borrow();
+
+    let source_group = main_group.get_subgroup("Source").unwrap();
+    let source_group = source_group.borrow();
+    let parent = source_group.parent();
+    println!("{:#?}", main_group);
+
+    assert_eq!(
+        parent.unwrap().borrow().children_references(),
+        main_group.children_references()
+    )
+}

src/pbxproj/object/fs/obj.rs

@@ -26,7 +26,7 @@ impl PBXObjectExt for PBXFSReference {
                 .remove_vec("children")
                 .map(|v| v.try_into_vec_strings().ok().map(|v| HashSet::from_iter(v)))
                 .flatten(),
-            parent_reference: None,
+            parent: Weak::new(),
             file_encoding: value.remove_number("fileEncoding"),
             explicit_file_type: value.remove_string("explicitFileType"),
             last_known_file_type: value.remove_string("lastKnownFileType"),

src/pbxproj/rep.rs

@@ -84,6 +84,14 @@ impl TryFrom<PBXHashMap> for PBXRootObject {
             .collect::<HashMap<_, _>>();
 
         refcell.borrow_mut().set_inner(objects);
+        refcell
+            .borrow()
+            .groups()
+            .into_iter()
+            .for_each(|(_, group)| {
+                let fs_reference = group.borrow_mut();
+                fs_reference.assign_parent_to_children(Rc::downgrade(&group))
+            });
 
         Ok(Self {
             archive_version,
@@ -138,27 +146,28 @@ fn test_parse() {
 }
 
 #[cfg(test)]
-macro_rules! test_file {
-    ($path:expr) => {{
-        use super::*;
-
-        let file = PBXRootObject::try_from(PathBuf::from($path));
+macro_rules! test_demo_file {
+    ($name:expr) => {{
+        let (root, name) = (env!("CARGO_MANIFEST_DIR"), stringify!($name));
+        let path = format!("{root}/tests/samples/{name}.pbxproj");
+        let file = crate::pbxproj::PBXRootObject::try_from(std::path::PathBuf::from(path));
         if file.is_err() {
             println!("Error: {:#?}", file.as_ref().unwrap_err())
         }
         assert!(file.is_ok());
         file.unwrap()
     }};
 }
+#[cfg(test)]
+pub(crate) use test_demo_file;
 
 #[cfg(test)]
 mod create_tests {
     macro_rules! test_samples {
         ($($name:ident),*) => {
             $(#[test]
                 fn $name() {
-                    let (root, name) = (env!("CARGO_MANIFEST_DIR"), stringify!($name));
-                    test_file!(format!("{root}/tests/samples/{name}.pbxproj"));
+                    test_demo_file!($name);
                 })*
         };
     }