Add support for ugrep closes debian bug #1002509

vlajos · Jan 12, 2022 · 6595833 · 6595833
1 parent 6801cb1
commit 6595833
Show file tree

Hide file tree

Showing 9 changed files with 33 additions and 13 deletions.
diff --git a/Dockerfile b/Dockerfile
@@ -1,7 +1,7 @@
-FROM alpine:3.8
+FROM alpine:3.15
 MAINTAINER Lajos Veres <vlajos@gmail.com>
 
-RUN apk --no-cache add bash grep sed findutils coreutils diffutils git
+RUN apk --no-cache add bash grep sed findutils coreutils diffutils git ugrep
 
 RUN mkdir /misspell-fixer
 

diff --git a/README.md b/README.md
@@ -202,6 +202,7 @@ A little more comprehensive list:
 * rm, cp, mv
 * xargs
 * git (for respecting .gitignore files)
+* ugrep (optional)
 
 ### Authors
 

diff --git a/debian/changelog b/debian/changelog
@@ -1,3 +1,10 @@
+misspell-fixer (0.5-1) unstable; urgency=medium
+
+  * Use ugrep if available. (#1002509)
+  * Update docs.
+
+ -- Lajos Veres <vlajos+debian@gmail.com>  Thu, 06 Jan 2022 19:49:32 +0000
+
 misspell-fixer (0.4-1) unstable; urgency=medium
 
   * Option to respect .gitignore

diff --git a/debian/control b/debian/control
@@ -13,7 +13,7 @@ Package: misspell-fixer
 Architecture: all
 Multi-Arch: foreign
 Depends: grep (>= 2.28), ${misc:Depends}
-Recommends: git
+Recommends: git, ugrep
 Description: Tool for fixing common misspellings, typos in source code
  Utility to fix common misspellings, typos in source code.
  There are lots of typical misspellings in program code.

diff --git a/doc/misspell-fixer.1 b/doc/misspell-fixer.1
@@ -1,6 +1,6 @@
 .\" generated with Ronn-NG/v0.9.1
 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
-.TH "misspell-fixer" "" "February 2021" "" "misspell-fixer"
+.TH "misspell-fixer" "" "January 2022" "" "misspell-fixer"
 .SH NAME
 misspell-fixer - misspell-fixer
 .P
@@ -246,6 +246,8 @@ rm, cp, mv
 xargs
 .IP "\[ci]" 4
 git (for respecting \.gitignore files)
+.IP "\[ci]" 4
+ugrep (optional)
 .IP "" 0
 .SS "Authors"
 .IP "\[ci]" 4

diff --git a/lib/initialisation_functions.sh b/lib/initialisation_functions.sh
@@ -79,9 +79,9 @@ function initialise_variables {
     echo '/// ///' >$tmpfile.git.ignore
     trap 'rm -f $tmpfile.git.ignore' EXIT
 
-    GREP=$(ggrep --version >/dev/null 2>&1 && \
-        echo 'ggrep' || \
-        echo 'grep')
+    GREP=$((ugrep --version >/dev/null 2>&1 && echo 'ugrep') \
+        || (ggrep --version >/dev/null 2>&1 && echo 'ggrep') \
+        || echo 'grep')
     export GREP
 }
 
@@ -278,7 +278,8 @@ function check_grep_version {
         warning "!! Your grep version is $current_version"\
             "which is less than the optimal: $required_version."\
             "This may degrade misspell fixer's performance"\
-            "significantly! (100x) !!"
+            "significantly! (100x) !! Alternatively install ugrep "\
+            "which is even quicker."
     fi
 }
 

diff --git a/lib/main_functions.sh b/lib/main_functions.sh
@@ -85,7 +85,8 @@ function execute_prefiltering {
     sort\
         -u\
         "$iteration_tmp_file.matches"\
-        "$iteration_tmp_file.matches.word_limited"\
+        "$iteration_tmp_file.matches.word_limited" |\
+    "$GREP" ':' \
         >"$iteration_tmp_file.matches.all"
 }
 

diff --git a/test/expected.debug.output b/test/expected.debug.output
@@ -46,7 +46,6 @@
 +++++ apply_whitelist_on_prefiltered_list .misspell-fixer.X.X
 +++++ check_grep_version
 +++++ check_sed_arguments
-+++++ current_version=X.X
 +++++ cut -d : -f X .misspell-fixer.X.X.matches.all
 +++++ echo 'misspell-fixer: Iteration X: done.'
 +++++ echo 'misspell-fixer: Iteration X: prefiltering.'
@@ -58,6 +57,7 @@
 +++++ grep -Fvx -f .misspell-fixer.X.git.ignore
 +++++ grep -q illegal
 +++++ grep -v '\\b' .misspell-fixer.X.prepared.sed.all_rules
++++++ grep :
 +++++ iterate_through_prefiltered_files X .misspell-fixer.X.X
 +++++ iterate_through_targets list_files_from_find X '' /dev/null
 +++++ list_files_from_find ''
@@ -76,7 +76,6 @@
 +++++ local required_version=X.X
 +++++ local retval=X
 +++++ prepare_rules_for_prefiltering
-+++++ printf '%s\n%s\n' X.X X.X
 +++++ printf '%s\X' work/D.txt
 +++++ printf '%s\X' work/g.txt
 +++++ printf '%s\X' work/R.txt

diff --git a/test/tests.sh b/test/tests.sh
@@ -41,8 +41,17 @@ runAndCompareOutput(){
     diff -ruwb $TEMP/expected/ $TEMP/work/
     assertTrue 'Expected output differs.' $?
 
-    sed -e 's/[0-9]\+/X/g' -e 's/X -X$/X +X/g' "$TEST_OUTPUT" |\
-    grep -v -e kcov -e 'grep -vh bin/sed' -e "Your grep version is" \
+    sed \
+        -e 's/[0-9]\+/X/g' \
+        -e 's/X -X$/X +X/g' \
+        -e 's/ugrep/grep/g' \
+        "$TEST_OUTPUT" |\
+    grep -v \
+        -e kcov \
+        -e 'grep -vh bin/sed' \
+        -e 'current_version=' \
+        -e 'Your grep version is' \
+        -e '%s\\n%s\\n' \
         >"$TEST_OUTPUT.standard"
     if [[ "$3" = "1" ]]; then
         sort -f "$TEST_OUTPUT.standard" >"$TEST_OUTPUT.standard.sorted"