feat(pbxproj): add swift package

Author: kkharji

README.md

@@ -1,12 +1,17 @@
 # XcodeProj
 
-XcodeProj parser and data representation
+Work-in-progress XcodeProj reader and writer.
 
-## Features
+Currently optimized for reading and not garanted to be used to modify existing xcodeproj.
+
+## Milestones
 
 - [x] parse `*.xcodeproj` through [pest]
 - [x] parse [pest] ast to `PBXRootObject`, as an meaningful abstraction.
+- [ ] add helper methods to maniuplate and read pbxproj objects.
 - [ ] write `ProjectData` back to `*.xcodeproj` filetype.
+- [ ] preserve comments and reduce git conflicts.
+- [ ] support reading XCWorkspace and XCScheme
 
 
 [pest]: https://github.com/pest-parser/pest

src/pbxproj/object/build/phase/file.rs

@@ -1,3 +1,5 @@
+use std::{cell::RefCell, rc::Rc};
+
 use crate::pbxproj::*;
 
 /// [`PBXObject`] A File referenced by a build phase, unique to each build phase.
@@ -24,17 +26,14 @@ impl PBXBuildFile {
     }
 
     /// Create new [`PBXBuildFile`] from  product_reference only
-    pub fn new_from_product(
-        product_reference: String,
-        objects: Option<WeakPBXObjectCollection>,
-    ) -> Self {
+    pub fn new_from_swift_product(reference: String, objects: WeakPBXObjectCollection) -> Self {
         Self {
             settings: Default::default(),
             platform_filter: Default::default(),
             file_reference: Default::default(),
-            product_reference: Some(product_reference),
+            product_reference: Some(reference),
             build_phase_reference: Default::default(),
-            objects: objects.unwrap_or_default(),
+            objects,
         }
     }
 
@@ -44,9 +43,11 @@ impl PBXBuildFile {
     }
 
     /// Get Product using self.product_reference
-    pub fn get_product(&self, _data: &PBXRootObject) -> Option<XCSwiftPackageProductDependency> {
-        // productReference?.getObject()
-        todo!()
+    pub fn product(&self) -> Option<Rc<RefCell<XCSwiftPackageProductDependency>>> {
+        self.objects
+            .upgrade()?
+            .borrow()
+            .get_swift_package_product_dependency(self.product_reference.as_ref()?)
     }
 
     /// Set Product.

src/pbxproj/object/collection.rs

@@ -1,4 +1,4 @@
-use super::{PBXObject, PBXTarget, XCRemoteSwiftPackageReference};
+use super::*;
 use std::{
     cell::RefCell,
     collections::HashMap,
@@ -30,19 +30,75 @@ impl PBXObjectCollection {
         self.get(reference)?.as_pbx_target().map(|r| r.clone())
     }
 
-    /// Get XCRemoteSwiftPackageReference from a vec of references
-    pub fn get_packages_from_references<'a>(
+    /// Get PBXBuildPhase by reference
+    pub fn get_build_phase<'a>(&'a self, reference: &str) -> Option<Rc<RefCell<PBXBuildPhase>>> {
+        self.get(reference)?.as_pbx_build_phase().map(|r| r.clone())
+    }
+
+    /// Get PBXBuildFile by reference
+    pub fn get_build_file<'a>(&'a self, reference: &str) -> Option<Rc<RefCell<PBXBuildFile>>> {
+        self.get(reference)?.as_pbx_build_file().map(|r| r.clone())
+    }
+
+    /// Get all PBXBuildPhase
+    pub fn build_phases<'a>(&'a self) -> Vec<(String, Rc<RefCell<PBXBuildPhase>>)> {
+        self.iter()
+            .filter(|o| o.1.is_pbx_build_phase())
+            .map(|(k, o)| (k.clone(), o.as_pbx_build_phase().unwrap().clone()))
+            .collect()
+    }
+
+    /// Get all PBXBuildFile
+    pub fn build_files<'a>(&'a self) -> Vec<(String, Rc<RefCell<PBXBuildFile>>)> {
+        self.iter()
+            .filter(|o| o.1.is_pbx_build_file())
+            .map(|(k, o)| (k.clone(), o.as_pbx_build_file().unwrap().clone()))
+            .collect()
+    }
+
+    /// Get All XCSwiftPackageProductDependency Objects
+    pub fn swift_package_product_dependencies<'a>(
         &'a self,
-        references: &Vec<String>,
-    ) -> Vec<(String, Rc<RefCell<XCRemoteSwiftPackageReference>>)> {
-        references
-            .iter()
-            .map(|id| {
-                let package = self.get(id)?.as_xc_remote_swift_package_reference()?;
-                Some((id.clone(), package.clone()))
+    ) -> Vec<(String, Rc<RefCell<XCSwiftPackageProductDependency>>)> {
+        self.iter()
+            .map(|(k, v)| {
+                Some((
+                    k.clone(),
+                    v.as_xc_swift_package_product_dependency()?.clone(),
+                ))
             })
             .flatten()
-            .collect()
+            .collect::<Vec<_>>()
+    }
+
+    /// Get All XCRemoteSwiftPackageReference Objects
+    pub fn swift_package_references<'a>(
+        &'a self,
+    ) -> Vec<(String, Rc<RefCell<XCRemoteSwiftPackageReference>>)> {
+        self.iter()
+            .map(|(k, v)| Some((k.clone(), v.as_xc_remote_swift_package_reference()?.clone())))
+            .flatten()
+            .collect::<Vec<_>>()
+    }
+
+    /// Get XCSwiftPackageProductDependency by reference
+    pub fn get_swift_package_product_dependency<'a>(
+        &'a self,
+        object_reference: &str,
+    ) -> Option<Rc<RefCell<XCSwiftPackageProductDependency>>> {
+        self.get(object_reference)?
+            .as_xc_swift_package_product_dependency()
+            .map(|r| r.clone())
+    }
+
+    /// Get XCSwiftPackageProductDependency by reference
+    pub fn get_swift_package_reference<'a>(
+        &'a self,
+        object_reference: &str,
+    ) -> Option<Rc<RefCell<XCRemoteSwiftPackageReference>>> {
+        self.get(object_reference)?
+            .as_xc_remote_swift_package_reference()
+            .map(|r| r.clone())
     }
 
     /// Get PBXTarget from a vec of references
@@ -52,10 +108,7 @@ impl PBXObjectCollection {
     ) -> Vec<(String, Rc<RefCell<PBXTarget>>)> {
         references
             .iter()
-            .map(|id| {
-                let target = self.get_target(id)?;
-                Some((id.clone(), target.clone()))
-            })
+            .map(|id| Some((id.clone(), self.get_target(id)?)))
             .flatten()
             .collect()
     }
@@ -79,4 +132,48 @@ impl PBXObjectCollection {
             })
             .map(|(key, o)| (key.clone(), o.as_pbx_target().unwrap().clone()))
     }
+
+    /// Get XCRemoteSwiftPackageReference from a vec of references
+    pub fn get_swift_package_reference_from_references<'a>(
+        &'a self,
+        references: &Vec<String>,
+    ) -> Vec<(String, Rc<RefCell<XCRemoteSwiftPackageReference>>)> {
+        references
+            .iter()
+            .map(|reference| {
+                Some((
+                    reference.clone(),
+                    self.get_swift_package_reference(reference)?,
+                ))
+            })
+            .flatten()
+            .collect()
+    }
+
+    /// Get PBXBuildPhase from a vec of references
+    pub fn get_build_phases_from_reference<'a>(
+        &'a self,
+        references: &Vec<String>,
+    ) -> Vec<(String, Rc<RefCell<PBXBuildPhase>>)> {
+        references
+            .iter()
+            .map(|reference| Some((reference.clone(), self.get_build_phase(reference)?)))
+            .flatten()
+            .collect()
+    }
+
+    /// Get XCSwiftPackageProductDependency form a given target reference
+    pub fn get_product_dependency_from_target_reference<'a>(
+        &'a self,
+        target_reference: &str,
+    ) -> Option<(String, Rc<RefCell<XCSwiftPackageProductDependency>>)> {
+        self.swift_package_product_dependencies()
+            .into_iter()
+            .find(|(_, p)| {
+                p.borrow()
+                    .package_reference()
+                    .map(|v| v == target_reference)
+                    .unwrap_or_default()
+            })
+    }
 }

src/pbxproj/object/file/group.rs

@@ -27,6 +27,12 @@ impl PBXGroup {
     //         .flatten()
     //         .collect::<Vec<_>>()
     // }
+
+    /// Get a reference to the pbxgroup's children references.
+    #[must_use]
+    pub fn children_references(&self) -> &HashSet<String> {
+        &self.children_references
+    }
 }
 
 impl PBXObjectExt for PBXGroup {