Merge pull request #9 from machlit/tree

v1

Author: hitblast

.github/workflows/release.yml

@@ -10,7 +10,7 @@ env:
   CARGO_TERM_COLOR: always
 
 jobs:
-  build-arm64:
+  ci:
     runs-on: macos-latest
 
     env:
@@ -56,21 +56,20 @@ jobs:
           cp README.md release/
           cd release && zip -r ../${{ env.FILE_NAME }} bin man README.md LICENSE && cd ..
 
+      - name: Set release body
+        id: release_body
+        run: |
+          body=$(cat RELEASE.md)
+          echo "body<<EOF" >> $GITHUB_OUTPUT
+          echo "$body" >> $GITHUB_OUTPUT
+          echo "EOF" >> $GITHUB_OUTPUT
+
       - name: Release
         uses: softprops/action-gh-release@v2
         with:
+          body: ${{ steps.release_body.outputs.body }}
           files: ${{ env.FILE_NAME }}
 
-  publish:
-    needs: [build-arm64]
-    runs-on: macos-latest
-
-    env:
-      CRATES_TOKEN: ${{ secrets.CRATES_TOKEN }}
-
-    steps:
-      - uses: actions/checkout@v4
-
       - name: Prepare Crates.io README
         run: sed -i '' '/^>/d' README.md
 

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "defaults-rs"
-version = "0.7.1"
+version = "1.0.0"
 edition = "2024"
 authors = ["Machlit"]
 description = "Open-source interface to a user's defaults on macOS"

Cargo.toml

@@ -1,7 +1,4 @@
-## Bugs Fixed
+## ✨
 
-- This release attempts to fix one of the bugs associated with some type changes in Rust v1.91, which fails to build the `plist` crate. defaults-rs depends on this crate for the import and export functionalities. This fix downgrades the version used from `v1.8.0` to `v1.7.4` which seems to work, for now.
-
----
-
-The compressed binaries have been attached with the release.
+- This release stabilizes all of the internal APIs so that it's mature for a v1 release (yes, we're getting one right now!).
+- Removed the batch functions since more maturity in the concurrency part of the code is still needed. CoreFoundation bindings aren't by-default concurrent.

RELEASE.md

@@ -1,6 +1,6 @@
 .ie \n(.g .ds Aq \(aq
 .el .ds Aq '
-.TH defaults-rs 1  "defaults-rs 0.7.0" 
+.TH defaults-rs 1  "defaults-rs 1.0.0" 
 .SH NAME
 defaults\-rs \- Open\-source interface to a user\*(Aqs defaults on macOS
 .SH SYNOPSIS
@@ -46,4 +46,4 @@ Search all domains
 defaults\-rs\-help(1)
 Print this message or the help of the given subcommand(s)
 .SH VERSION
-v0.7.0
+v1.0.0

man/man1/drs.1

@@ -12,7 +12,7 @@ pub mod types;
 
 use anyhow::{Context, Result, bail};
 use std::{
-    collections::{BTreeMap, HashMap},
+    collections::BTreeMap,
     fs::{self, File},
     io::Cursor,
     path::PathBuf,
@@ -32,7 +32,7 @@ use crate::core::foundation;
 pub struct Preferences;
 
 impl Preferences {
-    /// List all available domains in ~/Library/Preferences.
+    /// List all available domains.
     pub fn list_domains() -> Result<Vec<Domain>> {
         let list = foundation::list_domains()?;
 
@@ -208,98 +208,4 @@ impl Preferences {
 
         Ok(())
     }
-
-    /// Batch-write multiple key–value pairs for domains concurrently.
-    ///
-    /// # Concurrency & Grouping
-    /// - The input is a vector of tuples `(Domain, String, PrefValue)`.
-    /// - All write requests are grouped by domain.
-    ///
-    /// # Behavior
-    /// - Only the designated keys are updated in each plist; the entire domain is not replaced.
-    /// - For CoreFoundation domains, each key is written individually.
-    ///
-    /// # Errors
-    /// - If any write fails, the operation returns an error.
-    pub fn write_batch(batch: Vec<(Domain, String, PrefValue)>) -> Result<()> {
-        let mut groups: HashMap<Domain, Vec<(String, PrefValue)>> = HashMap::new();
-
-        // Group write requests by domain.
-        for (domain, key, value) in batch {
-            groups.entry(domain).or_default().push((key, value));
-        }
-
-        for (domain, writes) in groups {
-            let cf_name = &domain.get_cf_name();
-
-            for (key, value) in writes {
-                foundation::write_pref(cf_name, &key, &value)?;
-            }
-        }
-
-        Ok(())
-    }
-
-    /// Batch-read multiple keys for domains concurrently.
-    ///
-    /// # Concurrency & Grouping
-    /// - The input is a vector of tuples `(Domain, String)`.
-    /// - Requests are grouped by domain.
-    ///
-    /// # Behavior
-    /// - The result is a vector of tuples `(Domain, String, ReadResult)`.
-    ///
-    /// # Errors
-    /// - If any read fails (e.g., key not found), the operation returns an error.
-    pub fn read_batch(batch: Vec<(Domain, String)>) -> Result<Vec<(Domain, String, PrefValue)>> {
-        let mut groups: HashMap<Domain, Vec<String>> = HashMap::new();
-
-        // group requests by domain
-        for (domain, key) in batch {
-            groups.entry(domain).or_default().push(key);
-        }
-
-        let mut results = Vec::new();
-
-        for (domain, keys) in groups {
-            let cf_name = &domain.get_cf_name();
-
-            for k in keys {
-                let pref_val = foundation::read_pref(cf_name, &k)?;
-                results.push((domain.clone(), k.clone(), pref_val));
-            }
-        }
-
-        Ok(results)
-    }
-
-    /// Batch-delete multiple keys for domains concurrently.
-    ///
-    /// # Concurrency & Grouping
-    /// - The input is a vector of tuples `(Domain, String)`.
-    /// - Requests are grouped by domain.
-    ///
-    /// # Behavior
-    /// - Only the specified keys are removed from the domain.
-    ///
-    /// # Errors
-    /// - If any deletion fails (e.g., key not found), the operation returns an error.
-    pub fn delete_batch(batch: Vec<(Domain, String)>) -> Result<()> {
-        let mut groups: HashMap<Domain, Vec<String>> = HashMap::new();
-
-        // group requests by domain
-        for (domain, key) in batch {
-            groups.entry(domain).or_default().push(key);
-        }
-
-        for (domain, keys) in groups {
-            let cf_name = &domain.get_cf_name();
-
-            for k in keys {
-                foundation::delete_key(cf_name, &k)?
-            }
-        }
-
-        Ok(())
-    }
 }

src/preferences/mod.rs

@@ -7,7 +7,7 @@ use crate::PrefValue;
 pub enum Domain {
     /// A user domain, e.g., "com.apple.finder"
     User(String),
-    /// The global preferences domain / NSGlobalDomain (".GlobalPreferences")
+    /// The global preferences domain / NSGlobalDomain / .GlobalPreferences
     Global,
 }