feat: add revision component behind a feature toggle.

Byron · Byron · commit c42064d8ca38 · 2023-09-07T22:18:59.000+02:00
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/gix/Cargo.toml b/gix/Cargo.toml
@@ -58,7 +58,7 @@ default = ["max-performance-safe", "comfort", "extras"]
 #! Bundles are for convenience only and bear no further meaning beyond the cargo manifest file.
 
 ## Various additional features and capabilities that are not necessarily part of what most users would need.
-extras = ["worktree-stream", "worktree-archive", "blob-diff"]
+extras = ["worktree-stream", "worktree-archive", "blob-diff", "revision"]
 
 ## Various progress-related features that improve the look of progress message units.
 comfort = ["gix-features/progress-unit-bytes", "gix-features/progress-unit-human-numbers"]
@@ -68,6 +68,9 @@ comfort = ["gix-features/progress-unit-bytes", "gix-features/progress-unit-human
 #! A component is a distinct feature which may be comprised of one or more methods around a particular topic.
 #! Providers of libraries should only activate
 
+## Make revspec parsing possible, as well describing revision.
+revision = ["gix-revision/describe"]
+
 ## Make it possible to diff blobs line by line. Note that this feature is integral for implementing tree-diffs as well due to the handling of rename-tracking,
 ## which relies on line-by-line diffs in some cases.
 blob-diff = ["gix-diff/blob"]
@@ -187,7 +190,8 @@ gix-hash = { version = "^0.12.0", path = "../gix-hash" }
 gix-object = { version = "^0.35.0", path = "../gix-object" }
 gix-actor = { version = "^0.25.0", path = "../gix-actor" }
 gix-pack = { version = "^0.41.0", path = "../gix-pack", default-features = false, features = ["object-cache-dynamic"] }
-gix-revision = { version = "^0.20.0", path = "../gix-revision" }
+gix-revision = { version = "^0.20.0", path = "../gix-revision", default-features = false }
+gix-revwalk = { version = "^0.6.0", path = "../gix-revwalk" }
 gix-negotiate = { version = "^0.6.0", path = "../gix-negotiate" }
 
 gix-path = { version = "^0.9.0", path = "../gix-path" }
diff --git a/gix/src/commit.rs b/gix/src/commit.rs
@@ -22,6 +22,7 @@ pub enum Error {
 }
 
 ///
+#[cfg(feature = "revision")]
 pub mod describe {
     use std::borrow::Cow;
 
@@ -197,7 +198,7 @@ pub mod describe {
         /// to save ~40% of time.
         pub fn try_resolve(&self) -> Result<Option<Resolution<'repo>>, Error> {
             // TODO: dirty suffix with respective dirty-detection
-            let mut graph = gix_revision::Graph::new(
+            let mut graph = gix_revwalk::Graph::new(
                 |id, buf| {
                     self.repo
                         .objects
diff --git a/gix/src/config/cache/init.rs b/gix/src/config/cache/init.rs
@@ -151,6 +151,7 @@ impl Cache {
             true,
             lenient_config,
         )?;
+        #[cfg(feature = "revision")]
         let object_kind_hint = util::disambiguate_hint(&config, lenient_config)?;
         let (static_pack_cache_limit_bytes, pack_cache_bytes, object_cache_bytes) =
             util::parse_object_caches(&config, lenient_config, filter_config_section)?;
@@ -159,6 +160,7 @@ impl Cache {
             resolved: config.into(),
             use_multi_pack_index,
             object_hash,
+            #[cfg(feature = "revision")]
             object_kind_hint,
             static_pack_cache_limit_bytes,
             pack_cache_bytes,
@@ -213,12 +215,16 @@ impl Cache {
             false,
             self.lenient_config,
         )?;
-        let object_kind_hint = util::disambiguate_hint(config, self.lenient_config)?;
+
+        #[cfg(feature = "revision")]
+        {
+            let object_kind_hint = util::disambiguate_hint(config, self.lenient_config)?;
+            self.object_kind_hint = object_kind_hint;
+        }
         let reflog = util::query_refupdates(config, self.lenient_config)?;
 
         self.hex_len = hex_len;
         self.ignore_case = ignore_case;
-        self.object_kind_hint = object_kind_hint;
         self.reflog = reflog;
 
         self.user_agent = Default::default();
diff --git a/gix/src/config/cache/util.rs b/gix/src/config/cache/util.rs
@@ -3,7 +3,6 @@ use super::Error;
 use crate::{
     config,
     config::tree::{gitoxide, Core},
-    revision::spec::parse::ObjectKindHint,
 };
 
 pub(crate) fn interpolate_context<'a>(
@@ -103,10 +102,11 @@ pub(crate) fn parse_core_abbrev(
         .flatten())
 }
 
+#[cfg(feature = "revision")]
 pub(crate) fn disambiguate_hint(
     config: &gix_config::File<'static>,
     lenient_config: bool,
-) -> Result<Option<ObjectKindHint>, config::key::GenericErrorWithValue> {
+) -> Result<Option<crate::revision::spec::parse::ObjectKindHint>, config::key::GenericErrorWithValue> {
     match config.string_by_key("core.disambiguate") {
         None => Ok(None),
         Some(value) => Core::DISAMBIGUATE
diff --git a/gix/src/config/mod.rs b/gix/src/config/mod.rs
@@ -1,7 +1,7 @@
 pub use gix_config::*;
 use gix_features::threading::OnceCell;
 
-use crate::{bstr::BString, repository::identity, revision::spec, Repository};
+use crate::{bstr::BString, repository::identity, Repository};
 
 pub(crate) mod cache;
 mod snapshot;
@@ -513,7 +513,8 @@ pub(crate) struct Cache {
     /// The config section filter from the options used to initialize this instance. Keep these in sync!
     filter_config_section: fn(&gix_config::file::Metadata) -> bool,
     /// The object kind to pick if a prefix is ambiguous.
-    pub object_kind_hint: Option<spec::parse::ObjectKindHint>,
+    #[cfg(feature = "revision")]
+    pub object_kind_hint: Option<crate::revision::spec::parse::ObjectKindHint>,
     /// If true, we are on a case-insensitive file system.
     pub ignore_case: bool,
     /// If true, we should default what's possible if something is misconfigured, on case by case basis, to be more resilient.
diff --git a/gix/src/config/tree/sections/core.rs b/gix/src/config/tree/sections/core.rs
@@ -270,6 +270,7 @@ mod autocrlf {
     }
 }
 
+#[cfg(feature = "revision")]
 mod disambiguate {
     use std::borrow::Cow;
 
@@ -425,7 +426,9 @@ mod validate {
 
     pub struct Disambiguate;
     impl keys::Validate for Disambiguate {
+        #[cfg_attr(not(feature = "revision"), allow(unused_variables))]
         fn validate(&self, value: &BStr) -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static>> {
+            #[cfg(feature = "revision")]
             super::Core::DISAMBIGUATE.try_into_object_kind_hint(value.into())?;
             Ok(())
         }
diff --git a/gix/src/ext/mod.rs b/gix/src/ext/mod.rs
@@ -1,9 +1,11 @@
 pub use object_id::ObjectIdExt;
 pub use reference::ReferenceExt;
+#[cfg(feature = "revision")]
 pub use rev_spec::RevSpecExt;
 pub use tree::{TreeEntryExt, TreeEntryRefExt, TreeIterExt};
 
 mod object_id;
 mod reference;
+#[cfg(feature = "revision")]
 mod rev_spec;
 mod tree;
diff --git a/gix/src/id.rs b/gix/src/id.rs
@@ -3,7 +3,7 @@ use std::ops::Deref;
 
 use gix_hash::{oid, ObjectId};
 
-use crate::{object::find, revision, Id, Object};
+use crate::{object::find, Id, Object};
 
 /// An [object id][ObjectId] infused with a [`Repository`][crate::Repository].
 impl<'repo> Id<'repo> {
@@ -103,9 +103,8 @@ impl<'repo> Id<'repo> {
 
 impl<'repo> Id<'repo> {
     /// Obtain a platform for traversing ancestors of this commit.
-    ///
-    pub fn ancestors(&self) -> revision::walk::Platform<'repo> {
-        revision::walk::Platform::new(Some(self.inner), self.repo)
+    pub fn ancestors(&self) -> crate::revision::walk::Platform<'repo> {
+        crate::revision::walk::Platform::new(Some(self.inner), self.repo)
     }
 }
 
diff --git a/gix/src/lib.rs b/gix/src/lib.rs
@@ -105,6 +105,7 @@ pub use gix_prompt as prompt;
 pub use gix_protocol as protocol;
 pub use gix_ref as refs;
 pub use gix_refspec as refspec;
+pub use gix_revwalk as revwalk;
 pub use gix_sec as sec;
 pub use gix_tempfile as tempfile;
 pub use gix_trace as trace;
diff --git a/gix/src/object/commit.rs b/gix/src/object/commit.rs
@@ -1,4 +1,4 @@
-use crate::{bstr, bstr::BStr, revision, Commit, ObjectDetached, Tree};
+use crate::{bstr, bstr::BStr, Commit, ObjectDetached, Tree};
 
 mod error {
     use crate::object;
@@ -131,12 +131,13 @@ impl<'repo> Commit<'repo> {
     }
 
     /// Obtain a platform for traversing ancestors of this commit.
-    pub fn ancestors(&self) -> revision::walk::Platform<'repo> {
+    pub fn ancestors(&self) -> crate::revision::walk::Platform<'repo> {
         self.id().ancestors()
     }
 
     /// Create a platform to further configure a `git describe` operation to find a name for this commit by looking
     /// at the closest annotated tags (by default) in its past.
+    #[cfg(feature = "revision")]
     pub fn describe(&self) -> crate::commit::describe::Platform<'repo> {
         crate::commit::describe::Platform {
             id: self.id,
diff --git a/gix/src/remote/connection/fetch/negotiate.rs b/gix/src/remote/connection/fetch/negotiate.rs
@@ -7,7 +7,7 @@ use gix_pack::Find;
 
 use crate::remote::{fetch, fetch::Shallow};
 
-type Queue = gix_revision::PriorityQueue<SecondsSinceUnixEpoch, gix_hash::ObjectId>;
+type Queue = gix_revwalk::PriorityQueue<SecondsSinceUnixEpoch, gix_hash::ObjectId>;
 
 /// The error returned during negotiation.
 #[derive(Debug, thiserror::Error)]
@@ -16,7 +16,7 @@ pub enum Error {
     #[error("We were unable to figure out what objects the server should send after {rounds} round(s)")]
     NegotiationFailed { rounds: usize },
     #[error(transparent)]
-    LookupCommitInGraph(#[from] gix_revision::graph::lookup::commit::Error),
+    LookupCommitInGraph(#[from] gix_revwalk::graph::lookup::commit::Error),
     #[error(transparent)]
     InitRefsIterator(#[from] crate::reference::iter::init::Error),
     #[error(transparent)]
diff --git a/gix/src/repository/graph.rs b/gix/src/repository/graph.rs
@@ -12,10 +12,10 @@ impl crate::Repository {
     ///
     /// ### Performance
     ///
-    /// Note that the [Graph][gix_revision::Graph] can be sensitive to various object database settings that may affect the performance
+    /// Note that the [Graph][gix_revwalk::Graph] can be sensitive to various object database settings that may affect the performance
     /// of the commit walk.
-    pub fn revision_graph<T>(&self) -> gix_revision::Graph<'_, T> {
-        gix_revision::Graph::new(
+    pub fn revision_graph<T>(&self) -> gix_revwalk::Graph<'_, T> {
+        gix_revwalk::Graph::new(
             |id, buf| {
                 self.objects
                     .try_find(id, buf)
diff --git a/gix/src/repository/mod.rs b/gix/src/repository/mod.rs
@@ -52,6 +52,7 @@ mod object;
 mod pathspec;
 mod reference;
 mod remote;
+#[cfg(feature = "revision")]
 mod revision;
 mod shallow;
 mod state;
diff --git a/gix/src/revision/mod.rs b/gix/src/revision/mod.rs
@@ -2,13 +2,15 @@
 //!
 //! This module provides utilities to walk graphs of revisions and specify revisions and ranges of revisions.
 
+#[cfg(feature = "revision")]
 pub use gix_revision as plumbing;
 
 ///
 pub mod walk;
 pub use walk::iter::Walk;
 
 ///
+#[cfg(feature = "revision")]
 pub mod spec;
 
 /// The specification of a revision as parsed from a revision specification like `HEAD@{1}` or `v1.2.3...main`.
@@ -17,6 +19,7 @@ pub mod spec;
 /// See the [official git documentation](https://git-scm.com/docs/git-rev-parse#_specifying_revisions) for reference on how
 /// to specify revisions and revision ranges.
 #[derive(Clone, Debug)]
+#[cfg(feature = "revision")]
 pub struct Spec<'repo> {
     pub(crate) inner: gix_revision::Spec,
     /// The first name of a reference as seen while parsing a `RevSpec`, for completeness.
diff --git a/gix/tests/commit/mod.rs b/gix/tests/commit/mod.rs
@@ -1,3 +1,4 @@
+#[cfg(feature = "revision")]
 mod describe {
     use gix::commit::describe::SelectRef::{AllRefs, AllTags, AnnotatedTags};
 
diff --git a/gix/tests/config/tree.rs b/gix/tests/config/tree.rs
@@ -272,10 +272,7 @@ mod diff {
 mod core {
     use std::time::Duration;
 
-    use gix::{
-        config::tree::{Core, Key},
-        revision::spec::parse::ObjectKindHint,
-    };
+    use gix::config::tree::{Core, Key};
     use gix_lock::acquire::Fail;
 
     use crate::config::tree::bcow;
@@ -313,7 +310,9 @@ mod core {
     }
 
     #[test]
+    #[cfg(feature = "revision")]
     fn disambiguate() -> crate::Result {
+        use gix::revision::spec::parse::ObjectKindHint;
         for (value, expected) in [
             ("none", None),
             ("commit", Some(ObjectKindHint::Commit)),
diff --git a/gix/tests/gix-with-regex.rs b/gix/tests/gix-with-regex.rs
@@ -11,5 +11,6 @@ mod object;
 mod reference;
 mod remote;
 mod repository;
+#[cfg(feature = "revision")]
 mod revision;
 mod submodule;
diff --git a/gix/tests/gix.rs b/gix/tests/gix.rs
@@ -24,6 +24,7 @@ mod remote;
 #[cfg(not(feature = "regex"))]
 mod repository;
 #[cfg(not(feature = "regex"))]
+#[cfg(feature = "revision")]
 mod revision;
 #[cfg(not(feature = "regex"))]
 mod submodule;
diff --git a/gix/tests/object/tree/mod.rs b/gix/tests/object/tree/mod.rs
@@ -1,6 +1,6 @@
 use crate::util::{named_repo, named_subrepo_opts};
 
-#[cfg(feature = "blob-diff")]
+#[cfg(all(feature = "blob-diff", feature = "revision"))]
 mod diff;
 
 #[test]
diff --git a/gix/tests/reference/mod.rs b/gix/tests/reference/mod.rs
@@ -1,5 +1,3 @@
-use crate::repo_rw;
-
 mod log {
 
     #[test]
@@ -86,7 +84,9 @@ mod find {
 }
 
 #[test]
+#[cfg(feature = "revision")]
 fn set_target_id() {
+    use crate::repo_rw;
     let (repo, _tmp) = repo_rw("make_basic_repo.sh").unwrap();
     let mut head_ref = repo.head_ref().unwrap().expect("present");
     let target_id = repo.rev_parse_single(":/c1").unwrap();
diff --git a/justfile b/justfile
@@ -115,6 +115,7 @@ check:
     cargo check -p gix --no-default-features --features max-performance-safe
     cargo check -p gix --no-default-features --features progress-tree
     cargo check -p gix --no-default-features --features blob-diff
+    cargo check -p gix --no-default-features --features revision
     cargo check -p gix --no-default-features
     cargo check -p gix-odb --features serde
     cargo check --no-default-features --features max-control

Original file line number	Diff line number	Diff line change
`@@ -270,6 +270,7 @@ mod autocrlf {`
`270`	`270`	`}`
`271`	`271`	`}`
`272`	`272`
	`273`	`+#[cfg(feature = "revision")]`
`273`	`274`	`mod disambiguate {`
`274`	`275`	`use std::borrow::Cow;`
`275`	`276`
`@@ -425,7 +426,9 @@ mod validate {`
`425`	`426`
`426`	`427`	`pub struct Disambiguate;`
`427`	`428`	`impl keys::Validate for Disambiguate {`
	`429`	`+ #[cfg_attr(not(feature = "revision"), allow(unused_variables))]`
`428`	`430`	`fn validate(&self, value: &BStr) -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static>> {`
	`431`	`+ #[cfg(feature = "revision")]`
`429`	`432`	`super::Core::DISAMBIGUATE.try_into_object_kind_hint(value.into())?;`
`430`	`433`	`Ok(())`
`431`	`434`	`}`