Merge pull request #20 from DannyBen/add/sanitize-history

Add `cd -p` to prune all gone dirs

Author: DannyBen

README.md

@@ -68,6 +68,7 @@ You are encouraged to inspect the [setup script](setup) before running.
     cd -l        list history with fzf
     cd -e        edit history file
     cd -s        show history file
+    cd -p        prune non-existent directories from history
     cd -d [DIR]  delete current or specified directory from history
     cd -c        show completions function [usage: eval "$(cd -c)"]
     cd -v        show version

fuzzycd

@@ -1,7 +1,7 @@
 #!/usr/bin/env bash
 
 fuzzycd_run() {
-  local version="0.2.4"
+  local version="0.2.5"
   local histfile=${FUZZYCD_HISTORY_FILE:-"$HOME/.fuzzycd-history"}
 
   _fzcd_is_dirname() {
@@ -89,6 +89,24 @@ fuzzycd_run() {
     echo "fuzzycd $version"
   }
 
+  _fzcd_prune_history() {
+    local dir tmpfile removed
+    tmpfile=$(mktemp "${histfile}.XXXXXX") || return 1
+    removed=0
+
+    while IFS= read -r dir; do
+      if [[ -d "$dir" ]]; then
+        echo "$dir" >>"$tmpfile"
+      else
+        echo "pruned $dir"
+        removed=1
+      fi
+    done <"$histfile"
+
+    mv "$tmpfile" "$histfile"
+    [[ $removed -eq 0 ]] && echo "nothing to prune"
+  }
+
   _fzcd_delete_dir() {
     dir="${1:-$PWD}"
     grep -Fxv "$dir" "$histfile" >"$HOME/.fuzzycd-history.tmp"
@@ -106,6 +124,7 @@ fuzzycd_run() {
     echo "  cd -l        list history with fzf"
     echo "  cd -e        edit history file"
     echo "  cd -s        show history file"
+    echo "  cd -p        prune non-existent directories from history"
     echo "  cd -d [DIR]  delete current or specified directory from history"
     echo "  cd -c        show completions function [usage: eval \"\$(cd -c)\"]"
     echo "  cd -v        show version"
@@ -161,6 +180,7 @@ fuzzycd_run() {
       "-v") _fzcd_show_version ;;
       "-e") _fzcd_edit_histfile ;;
       "-s") _fzcd_show_histfile ;;
+      "-p") _fzcd_prune_history ;;
       "-c") _fzcd_show_completions ;;
       "-d")
         shift

test/approvals/cat_histfile

@@ -1 +1,3 @@
 /usr/local/bin
+/another/gone/dir
+/and/another/gone/dir

test/approvals/cat_histfile_pruned

@@ -0,0 +1 @@
+/usr/local/bin

test/approvals/cd_h

@@ -1,11 +1,12 @@
-fuzzycd 0.2.4
+fuzzycd 0.2.5
 
 Usage:
   cd DIR       change working directory
   cd SEARCH    change working directory or show selection menu
   cd -l        list history with fzf
   cd -e        edit history file
   cd -s        show history file
+  cd -p        prune non-existent directories from history
   cd -d [DIR]  delete current or specified directory from history
   cd -c        show completions function [usage: eval "$(cd -c)"]
   cd -v        show version

test/approvals/cd_p

@@ -0,0 +1,2 @@
+pruned /another/gone/dir
+pruned /and/another/gone/dir

test/approvals/cd_p_nothing_pruned

@@ -0,0 +1 @@
+nothing to prune

test/approvals/cd_v

@@ -1 +1 @@
-fuzzycd 0.2.4
+fuzzycd 0.2.5

test/approve

@@ -75,13 +75,22 @@ context "when the history file contains some entries"
 context "when the history file contains gone directories"
   echo /usr/local/bin > "$FUZZYCD_HISTORY_FILE"
   echo /no/such/dir >> "$FUZZYCD_HISTORY_FILE"
+  echo /another/gone/dir >> "$FUZZYCD_HISTORY_FILE"
+  echo /and/another/gone/dir >> "$FUZZYCD_HISTORY_FILE"
 
   describe "cd DIR"
     it "deletes the gone directory"
       approve "cd suchdir" || true
       expect_exit_code 1
       approve "cat $FUZZYCD_HISTORY_FILE" "cat_histfile"
 
+  describe "cd -p"
+    it "removes all gone directories"
+      approve "cd -p"
+      approve "cat $FUZZYCD_HISTORY_FILE" "cat_histfile_pruned"
+
+    it "states that nothing was pruned if there is nothing to do"
+      approve "cd -p" "cd_p_nothing_pruned"
 
 context "when CDPATH contains entries"
   echo /usr/local/bin > "$FUZZYCD_HISTORY_FILE"