refactor

Author: Byron

gix/examples/raw-commit-demo.rs

@@ -6,7 +6,7 @@ use std::convert::Infallible;
 /// An empty array of a type usable with the `gix::easy` API to help declaring no parents should be used
 pub const NO_PARENT_IDS: [gix_hash::ObjectId; 0] = [];
 
-/// The error returned by [`commit(…)`][crate::Repository::commit()].
+/// The error returned by [`commit(…)`](crate::Repository::commit()).
 #[derive(Debug, thiserror::Error)]
 #[allow(missing_docs)]
 pub enum Error {

gix/src/commit.rs

@@ -86,7 +86,7 @@
     doc = ::document_features::document_features!()
 )]
 #![cfg_attr(all(doc, feature = "document-features"), feature(doc_cfg, doc_auto_cfg))]
-#![deny(missing_docs, rust_2018_idioms, unsafe_code)]
+#![deny(missing_docs, unsafe_code)]
 #![allow(clippy::result_large_err)]
 
 // Re-exports to make this a potential one-stop shop crate avoiding people from having to reference various crates themselves.

gix/src/lib.rs

@@ -63,6 +63,36 @@ mod submodule;
 mod thread_safe;
 mod worktree;
 
+///
+mod new_commit {
+    /// The error returned by [`new_commit(…)`](crate::Repository::new_commit()).
+    #[derive(Debug, thiserror::Error)]
+    #[allow(missing_docs)]
+    pub enum Error {
+        #[error(transparent)]
+        ParseTime(#[from] crate::config::time::Error),
+        #[error("Committer identity is not configured")]
+        CommitterMissing,
+        #[error("Author identity is not configured")]
+        AuthorMissing,
+        #[error(transparent)]
+        NewCommitAs(#[from] crate::repository::new_commit_as::Error),
+    }
+}
+
+///
+mod new_commit_as {
+    /// The error returned by [`new_commit_as(…)`](crate::Repository::new_commit_as()).
+    #[derive(Debug, thiserror::Error)]
+    #[allow(missing_docs)]
+    pub enum Error {
+        #[error(transparent)]
+        WriteObject(#[from] crate::object::write::Error),
+        #[error(transparent)]
+        FindCommit(#[from] crate::object::find::existing::Error),
+    }
+}
+
 ///
 #[cfg(feature = "blame")]
 pub mod blame_file {

gix/src/repository/mod.rs

@@ -10,6 +10,7 @@ use gix_ref::{
 };
 use smallvec::SmallVec;
 
+use crate::repository::{new_commit, new_commit_as};
 use crate::{commit, ext::ObjectIdExt, object, tag, Blob, Commit, Id, Object, Reference, Tag, Tree};
 
 /// Tree editing
@@ -264,7 +265,7 @@ impl crate::Repository {
     /// Create a tag reference named `name` (without `refs/tags/` prefix) pointing to a newly created tag object
     /// which in turn points to `target` and return the newly created reference.
     ///
-    /// It will be created with `constraint` which is most commonly to [only create it][PreviousValue::MustNotExist]
+    /// It will be created with `constraint` which is most commonly to [only create it](PreviousValue::MustNotExist)
     /// or to [force overwriting a possibly existing tag](PreviousValue::Any).
     pub fn tag(
         &self,
@@ -406,37 +407,36 @@ impl crate::Repository {
         self.commit_as(committer, author, reference, message, tree, parents)
     }
 
-    /// Create a raw commit object with `message` referring to `tree` with `parents`, without writing it to the object database
-    /// or updating any references. The commit object can later be written using [`Self::write_object()`].
-    /// 
+    /// Create a new commit object with `message` referring to `tree` with `parents`, and write it to the object database.
+    /// Do not, however, update any references.
+    ///
     /// The commit is created without message encoding field, which can be assumed to be UTF-8.
     /// `author` and `committer` fields are pre-set from the configuration, which can be altered
     /// [temporarily](crate::Repository::config_snapshot_mut()) before the call if required.
-    pub fn commit_raw(
+    pub fn new_commit(
         &self,
         message: impl AsRef<str>,
         tree: impl Into<ObjectId>,
         parents: impl IntoIterator<Item = impl Into<ObjectId>>,
-    ) -> Result<gix_object::Commit, commit::Error> {
-        let author = self.author().ok_or(commit::Error::AuthorMissing)??;
-        let committer = self.committer().ok_or(commit::Error::CommitterMissing)??;
-        self.commit_as_raw(committer, author, message, tree, parents)
+    ) -> Result<Commit<'_>, new_commit::Error> {
+        let author = self.author().ok_or(new_commit::Error::AuthorMissing)??;
+        let committer = self.committer().ok_or(new_commit::Error::CommitterMissing)??;
+        Ok(self.new_commit_as(committer, author, message, tree, parents)?)
     }
 
-    /// Create a raw commit object with `message` referring to `tree` with `parents`, using the specified
-    /// `committer` and `author`, without writing it to the object database or updating any references.
-    /// The commit object can later be written using [`Self::write_object()`].
+    /// Create a nwe commit object with `message` referring to `tree` with `parents`, using the specified
+    /// `committer` and `author`, and write it to the object database. Do not, however, update any references.
     ///
     /// This forces setting the commit time and author time by hand. Note that typically, committer and author are the same.
     /// The commit is created without message encoding field, which can be assumed to be UTF-8.
-    pub fn commit_as_raw<'a, 'c>(
+    pub fn new_commit_as<'a, 'c>(
         &self,
         committer: impl Into<gix_actor::SignatureRef<'c>>,
         author: impl Into<gix_actor::SignatureRef<'a>>,
         message: impl AsRef<str>,
         tree: impl Into<ObjectId>,
         parents: impl IntoIterator<Item = impl Into<ObjectId>>,
-    ) -> Result<gix_object::Commit, commit::Error> {
+    ) -> Result<Commit<'_>, new_commit_as::Error> {
         let commit = gix_object::Commit {
             message: message.as_ref().into(),
             tree: tree.into(),
@@ -446,7 +446,8 @@ impl crate::Repository {
             parents: parents.into_iter().map(Into::into).collect(),
             extra_headers: Default::default(),
         };
-        Ok(commit)
+        let id = self.write_object(commit)?;
+        Ok(id.object()?.into_commit())
     }
 
     /// Return an empty tree object, suitable for [getting changes](Tree::changes()).