make gix independent of the git2 feature

That way we can properly test `gix` by itself and get closer to
how users would build this crate.

Author: Byron

.github/workflows/check.yml

@@ -87,6 +87,11 @@ jobs:
         with:
           command: clippy
           args: --all-features --all --tests -- -D warnings
+      - name: Clippy with all features (gitoxide only)
+        uses: actions-rs/cargo@v1
+        with:
+          command: clippy
+          args: --features=gix --all --tests -- -D warnings
       - name: Clippy example_project
         uses: actions-rs/cargo@v1
         with:

Cargo.toml

@@ -10,9 +10,6 @@ readme = "README.md"
 keywords = ["cargo", "build"]
 edition = "2021"
 
-[features]
-gitoxide = ["gix", "git2"]
-
 [dependencies]
 cargo-lock = { version = "9.0", optional = true, default-features = false }
 semver = { version = "1.0", optional = true }

src/gix.rs

@@ -1,6 +1,5 @@
 use crate::git_shared::RepoInfo;
-use crate::{fmt_option_str, write_variable};
-use std::{fs, io, io::Write, path};
+use std::{fs, io, path};
 
 fn get_repo_info(manifest_location: &path::Path) -> Option<RepoInfo> {
     let repo = gix::discover(manifest_location).ok()?;
@@ -25,20 +24,9 @@ fn get_repo_info(manifest_location: &path::Path) -> Option<RepoInfo> {
     Some(repo_info)
 }
 
-// TODO: replace git2 with gitoxide once this functionality becomes available in git-repository.
-fn is_dirty(manifest_location: &path::Path) -> Option<bool> {
-    let mut options = git2::StatusOptions::new();
-    options.include_ignored(false);
-    options.include_untracked(false);
-
-    let dirty = git2::Repository::discover(manifest_location)
-        .ok()?
-        .statuses(Some(&mut options))
-        .ok()?
-        .iter()
-        .any(|status| !matches!(status.status(), git2::Status::CURRENT));
-
-    Some(dirty)
+// TODO: implement this with `gix`
+fn is_dirty(_manifest_location: &path::Path) -> Option<bool> {
+    None
 }
 
 pub(crate) fn write_git_version(
@@ -52,7 +40,9 @@ pub(crate) fn write_git_version(
 // NOTE: Copy-pasted test from `git2` with adaptation to `gix`
 
 #[cfg(test)]
+#[cfg(feature = "git2")]
 mod tests {
+    // TODO: unify tests
     #[test]
     fn parse_git_repo() {
         use std::fs;
@@ -109,7 +99,7 @@ mod tests {
         // The commit, the commit-id is something and the repo is not dirty
         let repo_info = super::get_repo_info(&project_root).unwrap();
         assert!(!repo_info.tag.unwrap().is_empty());
-        assert_eq!(repo_info.dirty, Some(false));
+        assert_eq!(repo_info.dirty, None, "Needs implementation");
 
         // Tag the commit, it should be retrieved
         repo.tag(
@@ -125,13 +115,13 @@ mod tests {
 
         let repo_info = super::get_repo_info(&project_root).unwrap();
         assert_eq!(repo_info.tag, Some(String::from("foobar")));
-        assert_eq!(repo_info.dirty, Some(false));
+        assert_eq!(repo_info.dirty, None, "needs implementation");
 
         // Make some dirt
         std::fs::write(cruft_file, "now dirty").unwrap();
         let repo_info = super::get_repo_info(&project_root).unwrap();
         assert_eq!(repo_info.tag, Some(String::from("foobar")));
-        assert_eq!(repo_info.dirty, Some(true));
+        assert_eq!(repo_info.dirty, None, "needs implementation");
 
         let branch_short_name = "baz";
         let branch_name = "refs/heads/baz";

src/lib.rs

@@ -213,11 +213,10 @@ mod dependencies;
 mod environment;
 #[cfg(feature = "git2")]
 mod git;
-#[cfg(feature = "gitoxide")]
-#[allow(dead_code, unused_imports, unused_variables)]
+#[cfg(feature = "gix")]
 mod gix;
 
-#[cfg(any(feature = "git2", feature = "gitoxide"))]
+#[cfg(any(feature = "git2", feature = "gix"))]
 mod git_shared;
 
 #[cfg(feature = "chrono")]
@@ -346,7 +345,7 @@ impl Options {
     /// result. `GIT_VERSION` and `GIT_DIRTY` will therefor always be `None` if
     /// a CI-platform is detected.
     ///
-    #[cfg(any(feature = "git2", feature = "gitoxide"))]
+    #[cfg(any(feature = "git2", feature = "gix"))]
     pub fn set_git(&mut self, enabled: bool) -> &mut Self {
         self.git = enabled;
         self
@@ -509,7 +508,8 @@ impl Options {
 /// `OUR_DIR`.
 pub fn write_built_file_with_opts(
     options: &Options,
-    #[cfg(any(feature = "cargo-lock", feature = "git2"))] manifest_location: &path::Path,
+    #[cfg(any(feature = "cargo-lock", feature = "git2", feature = "gix"))]
+    manifest_location: &path::Path,
     dst: &path::Path,
 ) -> io::Result<()> {
     let mut built_file = fs::File::create(dst)?;
@@ -539,7 +539,7 @@ pub fn write_built_file_with_opts(
         {
             o!(git, git::write_git_version(manifest_location, &built_file)?);
         }
-        #[cfg(feature = "gitoxide")]
+        #[cfg(feature = "gix")]
         {
             o!(
                 git,
@@ -578,7 +578,7 @@ pub fn write_built_file() -> io::Result<()> {
     let dst = path::Path::new(&env::var("OUT_DIR").unwrap()).join("built.rs");
     write_built_file_with_opts(
         &Options::default(),
-        #[cfg(any(feature = "cargo-lock", feature = "git2"))]
+        #[cfg(any(feature = "cargo-lock", feature = "git2", feature = "gix"))]
         env::var("CARGO_MANIFEST_DIR").unwrap().as_ref(),
         &dst,
     )?;