Merge pull request #349 from madsmtm/remove-uuid-feature

Remove the optional `uuid` integration from `icrate`

Author: madsmtm

.github/workflows/ci.yml

@@ -49,7 +49,7 @@ env:
   #
   # Note: The `exception` feature is not enabled here, since it requires
   # compiling C code, even if just running a `check`/`clippy` build.
-  INTERESTING_FEATURES: malloc,block,verify,uuid,unstable-private
+  INTERESTING_FEATURES: malloc,block,verify,unstable-private
   UNSTABLE_FEATURES: unstable-autoreleasesafe,unstable-c-unwind
   # Required when we want to use a different runtime than the default `apple`
   OTHER_RUNTIME: --no-default-features --features=std

Cargo.lock

@@ -15,6 +15,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 * Updated the SDK version from XCode `14.0.1` to `14.2`.
   - See differences [here](https://sdk.news/macOS-13.0/).
 
+### Removed
+* **BREAKING**: The optional `uuid` integration, since one might want to use
+  `icrate` internally in that crate in the future, and that would break.
+
 
 ## icrate 0.0.1 - 2022-12-24
 

crates/icrate/CHANGELOG.md

@@ -23,12 +23,9 @@ license = "MIT"
 objc2 = { path = "../objc2", version = "=0.3.0-beta.4", default-features = false, optional = true }
 block2 = { path = "../block2", version = "=0.2.0-alpha.7", default-features = false, optional = true }
 
-# Provide methods to convert between `uuid::Uuid` and `icrate::Foundation::NSUUID`
-uuid = { version = "1.1.2", optional = true, default-features = false }
-
 [package.metadata.docs.rs]
 default-target = "x86_64-apple-darwin"
-features = ["block", "objective-c", "uuid", "unstable-frameworks-all", "unstable-private", "unstable-docsrs"]
+features = ["block", "objective-c", "unstable-frameworks-all", "unstable-private", "unstable-docsrs"]
 
 targets = [
     # MacOS

crates/icrate/Cargo.toml

@@ -20,6 +20,22 @@ impl NSUUID {
         Self::from_bytes([0; 16])
     }
 
+    /// Create a new `NSUUID` from the given bytes.
+    ///
+    ///
+    /// # Example
+    ///
+    /// Create a new `NSUUID` from the `uuid` crate.
+    ///
+    /// ```ignore
+    /// use uuid::Uuid;
+    /// use icrate::Foundation::NSUUID;
+    ///
+    /// let uuid: Uuid;
+    /// # uuid = todo!();
+    /// let obj = NSUUID::from_bytes(uuid.into_bytes());
+    /// assert_eq!(obj.as_bytes(), uuid.into_bytes());
+    /// ```
     pub fn from_bytes(bytes: [u8; 16]) -> Id<Self, Shared> {
         let bytes = UuidBytes(bytes);
         Self::initWithUUIDBytes(Self::alloc(), &bytes)
@@ -68,18 +84,6 @@ impl fmt::Debug for NSUUID {
 //     }
 // }
 
-/// Conversion methods to/from `uuid` crate.
-#[cfg(feature = "uuid")]
-impl NSUUID {
-    pub fn from_uuid(uuid: uuid::Uuid) -> Id<Self, Shared> {
-        Self::from_bytes(uuid.into_bytes())
-    }
-
-    pub fn as_uuid(&self) -> uuid::Uuid {
-        uuid::Uuid::from_bytes(self.as_bytes())
-    }
-}
-
 impl DefaultId for NSUUID {
     type Ownership = Shared;
     fn default_id() -> Id<Self, Self::Ownership> {

crates/icrate/src/Foundation/additions/uuid.rs

@@ -98,11 +98,6 @@
 //! | `NSEnumerator<T, Shared>` | `impl Iterator<Arc<T>>` |
 //! | `NSEnumerator<T, Owned>` | `impl Iterator<T>` |
 //! | `@protocol NSCopying` | `trait Clone` |
-//!
-//!
-//! # Feature flags
-//!
-//! `"uuid"` -> Enables conversion methods between `NSUUID` and `uuid::Uuid`.
 #![allow(unused_imports)]
 
 #[doc(hidden)]

crates/icrate/src/Foundation/mod.rs

@@ -29,12 +29,3 @@ fn display_debug() {
 //     let uuid2 = NSUUID::from_bytes([9; 16]);
 //     assert!(uuid1 > uuid2);
 // }
-
-#[cfg(feature = "uuid")]
-#[test]
-fn test_convert_roundtrip() {
-    let nsuuid1 = NSUUID::UUID();
-    let uuid = nsuuid1.as_uuid();
-    let nsuuid2 = NSUUID::from_uuid(uuid);
-    assert_eq!(nsuuid1, nsuuid2);
-}