feat: `gix status` auto-writes changed indices.

This prevents expensive operations to re-occour.

Sebastian Thiel committed 3 years ago

Commit 46e59191 parent b5b50f83 files · +59 −7Browse files

Unified · Split

3 files

gitoxide-core/src/repository/status.rs +54 −7
src/plumbing/main.rs +2 −0
src/plumbing/options/mod.rs +3 −0

gitoxide-core/src/repository/status.rs+54−7

     pub submodules: Submodules,
     pub thread_limit: Option<usize>,
     pub statistics: bool,
+    pub allow_write: bool,
 }
 pub fn show(
         // TODO: implement this
         submodules: _,
         thread_limit,
+        allow_write,
         statistics,
     }: Options,
 ) -> anyhow::Result<()> {
             _ => unreachable!("state must be attributes stack only"),
         },
     };
+    let mut printer = Printer {
+        out,
+        changes: Vec::new(),
+    };
     let outcome = gix_status::index_as_worktree(
         index,
         repo.work_dir()
             .context("This operation cannot be run on a bare repository")?,
-        &mut Printer(out),
+        &mut printer,
         FastEq,
         Submodule,
         {
         options,
     )?;
+    if outcome.entries_to_update != 0 && allow_write {
+        {
+            let entries = index.entries_mut();
+            for (entry_index, change) in printer.changes {
+                let entry = &mut entries[entry_index];
+                match change {
+                    ApplyChange::SetSizeToZero => {
+                        entry.stat.size = 0;
+                    }
+                    ApplyChange::NewStat(new_stat) => {
+                        entry.stat = new_stat;
+                    }
+                }
+            }
+        }
+        index.write(gix::index::write::Options {
+            extensions: Default::default(),
+            skip_hash: false, // TODO: make this based on configuration
+        })?;
+    }
     if statistics {
         writeln!(err, "{outcome:#?}").ok();
     }
     }
 }
-struct Printer<W>(W);
+struct Printer<W> {
+    out: W,
+    changes: Vec<(usize, ApplyChange)>,
+}
+enum ApplyChange {
+    SetSizeToZero,
+    NewStat(gix::index::entry::Stat),
+}
 impl<'index, W> gix_status::index_as_worktree::VisitEntry<'index> for Printer<W>
 where
         &mut self,
         _entries: &'index [Entry],
         _entry: &'index Entry,
-        _entry_index: usize,
+        entry_index: usize,
         rela_path: &'index BStr,
         status: EntryStatus<Self::ContentChange>,
     ) {
-        self.visit_inner(rela_path, status).ok();
+        self.visit_inner(entry_index, rela_path, status).ok();
     }
 }
 impl<W: std::io::Write> Printer<W> {
-    fn visit_inner(&mut self, rela_path: &BStr, status: EntryStatus<()>) -> std::io::Result<()> {
+    fn visit_inner(&mut self, entry_index: usize, rela_path: &BStr, status: EntryStatus<()>) -> std::io::Result<()> {
         let char_storage;
         let status = match status {
             EntryStatus::Conflict(conflict) => as_str(conflict),
             EntryStatus::Change(change) => {
+                if matches!(
+                    change,
+                    Change::Modification {
+                        set_entry_stat_size_zero: true,
+                        ..
+                    }
+                ) {
+                    self.changes.push((entry_index, ApplyChange::SetSizeToZero))
+                }
                 char_storage = change_to_char(&change);
                 std::str::from_utf8(std::slice::from_ref(&char_storage)).expect("valid ASCII")
             }
-            EntryStatus::NeedsUpdate(_) => return Ok(()),
+            EntryStatus::NeedsUpdate(stat) => {
+                self.changes.push((entry_index, ApplyChange::NewStat(stat)));
+                return Ok(());
+            }
             EntryStatus::IntentToAdd => "A",
         };
-        writeln!(&mut self.0, "{status: >3} {rela_path}")
+        writeln!(&mut self.out, "{status: >3} {rela_path}")
     }
 }

src/plumbing/main.rs+2−0

         Subcommands::Status(crate::plumbing::options::status::Platform {
             statistics,
             submodules,
+            no_write,
             pathspec,
         }) => prepare_and_run(
             "status",
                         format,
                         statistics,
                         thread_limit: thread_limit.or(cfg!(target_os = "macos").then_some(3)), // TODO: make this a configurable when in `gix`, this seems to be optimal on MacOS, linux scales though!
+                        allow_write: !no_write,
                         submodules: match submodules {
                             Submodules::All => core::repository::status::Submodules::All,
                             Submodules::RefChange => core::repository::status::Submodules::RefChange,

src/plumbing/options/mod.rs+3−0

         /// Print additional statistics to help understanding performance.
         #[clap(long, short = 's')]
         pub statistics: bool,
+        /// Don't write back a changed index, which forces this operation to always be idempotent.
+        #[clap(long)]
+        pub no_write: bool,
         /// The git path specifications to list attributes for, or unset to read from stdin one per line.
         #[clap(value_parser = CheckPathSpec)]
         pub pathspec: Vec<BString>,

feat: `gix status` auto-writes changed indices.

Keyboard shortcuts

General

Issues and pull requests

Issues, pull requests and Inbox

Repository code