Add new variables to the README

Check for compatibility with all version of Emacs since Emacs 25.1

Add Cask file for managing dependencies in CI

Add badge in README for CI

.github/workflows/workflow.yml

@@ -0,0 +1,46 @@
+name: CI
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  check-compatibility:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        emacs_version:
+          - 25.1
+          - 25.2
+          - 25.3
+          - 26.1
+          - 26.2
+          - 26.3
+          - 27.1
+          - 27.2
+          - 28.1
+          - snapshot
+    steps:
+      - uses: actions/checkout@v3
+      - uses: purcell/setup-emacs@master
+        with:
+          version: ${{ matrix.emacs_version }}
+      - uses: actions/cache@v2
+        id: cache-cask-packages
+        with:
+          path: .cask
+          key: cache-cask-packages-000
+      - uses: actions/cache@v2
+        id: cache-cask-executable
+        with:
+          path: ~/.cask
+          key: cache-cask-executable-000
+      - name: "Cask setup"
+        uses: cask/setup-cask@master
+        if: steps.cask-cache-executable.outputs.cache-hit != 'true'
+      - name: "Install Cask dependencies"
+        run: cask install
+        if: steps.cask-cache-executable.outputs.cache-hit != 'true'
+      - name: "Check version compatibility"
+        run: make all

Cask

@@ -0,0 +1,7 @@
+(source melpa)
+(source gnu)
+
+(package-file "eshell-info-banner.el")
+
+(development
+ (depends-on "s"))

Makefile

@@ -0,0 +1,11 @@
+# -*- indent-tabs-mode: t -*-
+
+export EMACS ?= $(shell which emacs)
+CASK ?= $(shell which cask)
+
+all: compile
+
+compile:
+	${CASK} exec ${EMACS} -Q --script bin/compile-package.el 2>&1 | grep -A 2 -E "([Ee]rror|[Ww]arning):" && exit 1 || exit 0
+
+.PHONY: all compile

README.org

@@ -3,6 +3,7 @@
 #+email: lucien@phundrak.com
 [[https://melpa.org/#/eshell-info-banner][file:https://melpa.org/packages/eshell-info-banner-badge.svg]]
 [[https://stable.melpa.org/#/eshell-info-banner][file:https://stable.melpa.org/packages/eshell-info-banner-badge.svg]]
+[[https://github.com/Phundrak/eshell-info-banner.el/actions/workflows/workflow.yml][file:https://github.com/Phundrak/eshell-info-banner.el/actions/workflows/workflow.yml/badge.svg]]
 
 * Introduction
 ~eshell-info-banner.el~ is a utility for creating an informative banner,
@@ -108,6 +109,15 @@ A couple of variables can be edited by the user in order to configure
   set its value to ~("/dev" "zroot")~.
 
   Default value: ~("/dev")~
+- ~eshell-info-banner-filter-duplicate-partitions~ :: Try to filter
+  out duplicate partitions. Two partitions are considered duplicate if
+  they have the same size and amount of space used.
+
+  Default value: ~nil~
+- ~eshell-info-banner-exclude-partitions~ :: List of pattens to exclude
+  from the partition list.
+
+  Default value: ~nil~
 - ~eshell-info-banner-shorten-path-from~ :: Maximum length of the mount
   path of a partition before it gets abbreviated. Set it to ridiculous
   numbers in order to disable it (something like ~1000~ should be more
@@ -189,10 +199,9 @@ line if you have one. If you don’t have a battery, the only difference
 is you will have one less line than laptop users.
 
 * Advice for Windows users
-Currently, the partitions detection is done only with the ~duf~
+Currently, ~eshell-info-banner~ can only look for your partitions with
-command-line utility. If you want a list of your partitions, I
+~duf~. If you want a list of your partitions, I strongly encourage you
-strongly encourage you to install it on your system. See
+to install it on your system. See [[https://github.com/muesli/duf#windows][muesli/duf]].
-[[https://github.com/muesli/duf#windows]].
 
 * Contributing
 See [[file:CONTRIBUTING.org]].

bin/compile-package.el

@@ -0,0 +1 @@
+(byte-recompile-directory "." 0 'force)

eshell-info-banner.el

@@ -2,7 +2,7 @@
 
 ;; Author: Lucien Cartier-Tilet <lucien@phundrak.com>
 ;; Maintainer: Lucien Cartier-Tilet <lucien@phundrak.com>
-;; Version: 0.8.6
+;; Version: 0.8.8
 ;; Package-Requires: ((emacs "25.1") (s "1"))
 ;; Homepage: https://github.com/Phundrak/eshell-info-banner.el
 
@@ -38,7 +38,7 @@
 ;;; Code:
 
 (require 'cl-lib)
-(require 'f)
+(require 's)
 (require 'em-banner)
 (require 'json)
 (require 'seq)
@@ -60,43 +60,34 @@
                                         ;              Constants              ;
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 
-(eval-when-compile
+(defconst eshell-info-banner-path-separator
-  (defconst eshell-info-banner-path-separator
+  (substring-no-properties (file-relative-name (expand-file-name "x" "y")) 1 2)
-    (substring-no-properties (file-relative-name (expand-file-name "x" "y")) 1 2)
+  "File separator used by the current operating system.")
-    "File separator used by the current operating system."))
 
 (defconst eshell-info-banner--min-length-left 8
   "Minimum length of text on the left hand side of the banner.")
 
 (eval-when-compile
   (defconst eshell-info-banner--macos-versions
-    '(("10.0"  . "Mac OS X Cheetah")
+    '(("^10\\.0\\."  . "Mac OS X Cheetah")
-      ("10.1"  . "Mac OS X Puma")
+      ("^10\\.1\\."  . "Mac OS X Puma")
-      ("10.2"  . "Mac OS X Jaguar")
+      ("^10\\.2\\."  . "Mac OS X Jaguar")
-      ("10.3"  . "Mac OS X Panther")
+      ("^10\\.3\\."  . "Mac OS X Panther")
-      ("10.4"  . "Mac OS X Tiger")
+      ("^10\\.4\\."  . "Mac OS X Tiger")
-      ("10.5"  . "Mac OS X Leopard")
+      ("^10\\.5\\."  . "Mac OS X Leopard")
-      ("10.6"  . "Mac OS X Snow Leopard")
+      ("^10\\.6\\."  . "Mac OS X Snow Leopard")
-      ("10.7"  . "Mac OS X Lion")
+      ("^10\\.7\\."  . "Mac OS X Lion")
-      ("10.8"  . "OS X Mountain Lion")
+      ("^10\\.8\\."  . "OS X Mountain Lion")
-      ("10.9"  . "OS X Mavericks")
+      ("^10\\.9\\."  . "OS X Mavericks")
-      ("10.10" . "OS X Yosemite")
+      ("^10\\.10\\." . "OS X Yosemite")
-      ("10.11" . "OS X El Capitan")
+      ("^10\\.11\\." . "OS X El Capitan")
-      ("10.12" . "macOS Sierra")
+      ("^10\\.12\\." . "macOS Sierra")
-      ("10.13" . "macOS High Sierra")
+      ("^10\\.13\\." . "macOS High Sierra")
-      ("10.14" . "macOS Mojave")
+      ("^10\\.14\\." . "macOS Mojave")
-      ("10.15" . "macOS Catalina")
+      ("^10\\.15\\." . "macOS Catalina")
-      ("10.16" . "macOS Big Sur")
+      ("^10\\.16\\." . "macOS Big Sur")
-      ("11.0"  . "macOS Big Sur")
+      ("^11\\."      . "macOS Big Sur")
-      ("11.1"  . "macOS Big Sur")
+      ("^12\\."      . "macOS Monterey"))
-      ("11.2"  . "macOS Big Sur")
-      ("11.3"  . "macOS Big Sur")
-      ("11.4"  . "macOS Big Sur")
-      ("11.5"  . "macOS Big Sur")
-      ("11.6"  . "macOS Big Sur")
-      ("12.0"  . "macOS Monterey")
-      ("12.1"  . "macOS Monterey")
-      ("12.2"  . "macOS Monterey"))
     "Versions of OSX and macOS and their name."))
 
 (defconst eshell-info-banner--posix-shells '("bash" "zsh" "sh")
@@ -111,69 +102,77 @@
   "Make `eshell-info-banner' TRAMP aware."
   :group 'eshell-info-banner
   :type 'boolean
-  :safe #'booleanp
+  :safe #'booleanp)
-  :version "0.3.0")
 
 (defcustom eshell-info-banner-shorten-path-from 7
   "From which length should a path be shortened?"
   :group 'eshell-info-banner
   :type 'integer
-  :safe #'integer-or-marker-p
+  :safe #'integer-or-marker-p)
-  :version "0.1.0")
 
 (defcustom eshell-info-banner-width 80
   "Width of the info banner to be shown in Eshell."
   :group 'eshell-info-banner
   :type 'integer
-  :safe #'integer-or-marker-p
+  :safe #'integer-or-marker-p)
-  :version "0.1.0")
 
 (defcustom eshell-info-banner-progress-bar-char "="
   "Character to fill the progress bars with."
   :group 'eshell-info-banner
   :type 'string
-  :safe #'stringp
+  :safe #'stringp)
-  :version "0.1.0")
 
 (defcustom eshell-info-banner-warning-percentage 75
   "When to warn about a percentage."
   :group 'eshell-info-banner
   :type 'float
-  :safe #'floatp
+  :safe #'floatp)
-  :version "0.1.0")
 
 (defcustom eshell-info-banner-critical-percentage 90
   "When a percentage becomes critical."
   :group 'eshell-info-banner
   :type 'float
-  :safe #'floatp
+  :safe #'floatp)
-  :version "0.1.0")
 
 (defcustom eshell-info-banner-partition-prefixes '("/dev")
   "List of prefixes for detecting which partitions to display."
   :group 'eshell-info-banner
-  :type 'list
+  :type 'list)
-  :version "0.3.0")
 
-(defun eshell-info-banner--executable-find (program)
+(defcustom eshell-info-banner-filter-duplicate-partitions nil
+  "Whether to filter duplicate partitions.
+
+Two partitions are considered duplicate if they have the same
+size and amount of space used."
+  :group 'eshell-info-banner
+  :type 'boolean)
+
+(defcustom eshell-info-banner-exclude-partitions nil
+  "List of patterns to exclude from the partition list.
+
+Patterns are matched against the partition name with
+`string-match-p'."
+  :group 'eshell-info-banner
+  :type '(repeat string))
+
+(defmacro eshell-info-banner--executable-find (program)
   "Find PROGRAM executable, possibly on a remote machine.
 This is a wrapper around `executable-find' in order to avoid
 issues with older versions of the functions only accepting one
 argument. `executable-find'’s remote argument has the value of
 `eshell-info-banner-tramp-aware'."
   (if (version< emacs-version "27.1")
-      (let ((default-directory (if eshell-info-banner-tramp-aware
+      `(let ((default-directory (if eshell-info-banner-tramp-aware
-                                   default-directory
+                                    default-directory
-                                 "~")))
+                                  "~")))
-        (executable-find program))
+         (executable-find ,program))
-    (executable-find program eshell-info-banner-tramp-aware)))
+    `(executable-find ,program eshell-info-banner-tramp-aware)))
 
 (defcustom eshell-info-banner-duf-executable "duf"
   "Path to the `duf' executable."
   :group 'eshell-info-banner
   :type 'string
-  :safe #'stringp
+  :safe #'stringp)
-  :version "0.5.0")
 
 (defcustom eshell-info-banner-use-duf
   (if (eshell-info-banner--executable-find eshell-info-banner-duf-executable)
@@ -182,16 +181,14 @@ argument. `executable-find'’s remote argument has the value of
   "If non-nil, use `duf' instead of `df'."
   :group 'eshell-info-banner
   :type 'boolean
-  :safe #'booleanp
+  :safe #'booleanp)
-  :version "0.5.0")
 
 (defcustom eshell-info-banner-file-size-flavor nil
   "Display sizes with IEC prefixes."
   :group 'eshell-info-banner
   :type '(radio (const :tag "Default" nil)
                 (const :tag "SI" si)
-                (const :tag "IEC" iec))
+                (const :tag "IEC" iec)))
-  :version "0.8.0")
 
 
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
@@ -235,8 +232,9 @@ Ensures the command is ran with LANG=C."
                             eshell-info-banner--posix-shells)
                   "sh")))
     (with-temp-buffer
-      (call-process shell nil t nil "-c" (concat "LANG=C " command))
+      (let ((default-directory (if eshell-info-banner-tramp-aware default-directory "~")))
-      (buffer-string))))
+        (process-file shell nil t nil "-c" (concat "LANG=C " command))
+        (buffer-string)))))
 
 (defun eshell-info-banner--progress-bar-without-prefix (bar-length used total &optional newline)
   "Display a progress bar without its prefix.
@@ -259,6 +257,14 @@ of the progress bar."
                      :inherit (eshell-info-banner--get-color-percentage percentage))
                     (if newline "\n" "")))))
 
+(defun eshell-info-banner--string-repeat (str times)
+  "Repeat STR for TIMES times."
+  (declare (pure t) (side-effect-free t))
+  (let (result)
+    (cl-dotimes (_ times)
+      (setq result (cons str result)))
+    (apply #'concat result)))
+
 
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
                                         ;          Internal functions         ;
@@ -376,15 +382,15 @@ Common function between
 otherwise differ solely on the position of the mount point in the
 partition list. Its position is given by the argument
 MOUNT-POSITION."
-  (let ((partitions (cdr (split-string (eshell-info-banner--shell-command-to-string "df -l")
+  (let ((partitions (cdr (split-string (eshell-info-banner--shell-command-to-string "df -l -k")
                                        (regexp-quote "\n")
                                        t))))
     (cl-remove-if #'null
                   (mapcar (lambda (partition)
                             (let* ((partition  (split-string partition " " t))
                                    (filesystem (nth 0 partition))
-                                   (size       (string-to-number (nth 1 partition)))
+                                   (size       (* (string-to-number (nth 1 partition)) 1024))
-                                   (used       (string-to-number (nth 2 partition)))
+                                   (used       (* (string-to-number (nth 2 partition)) 1024))
                                    (percent    (nth 4 partition))
                                    (mount      (nth mount-position partition)))
                               (when (seq-some (lambda (prefix)
@@ -397,7 +403,7 @@ MOUNT-POSITION."
                                  :size size
                                  :used used
                                  :percent (string-to-number
-                                           (string-trim-left percent (regexp-quote "%")))))))
+                                           (s-chop-suffix "%" percent))))))
                           partitions))))
 
 (defun eshell-info-banner--get-mounted-partitions-gnu ()
@@ -426,24 +432,52 @@ Return detected partitions as a list of structs.  See
 chosen.  Relies on the `df' command."
   (eshell-info-banner--get-mounted-partitions-df 8))
 
-(defun eshell-info-banner--get-mounted-partitions ()
+(defun eshell-info-banner--get-mounted-partitions-1 ()
   "Detect mounted partitions on the system.
 
 Return detected partitions as a list of structs."
   (if eshell-info-banner-use-duf
       (eshell-info-banner--get-mounted-partitions-duf)
     (pcase system-type
-       ((or 'gnu 'gnu/linux 'gnu/kfreebsd 'berkeley-unix)
+      ((or 'gnu 'gnu/linux 'gnu/kfreebsd 'berkeley-unix)
-        (eshell-info-banner--get-mounted-partitions-gnu))
+       (eshell-info-banner--get-mounted-partitions-gnu))
-       ((or 'ms-dos 'windows-nt 'cygwin)
+      ((or 'ms-dos 'windows-nt 'cygwin)
-        (eshell-info-banner--get-mounted-partitions-windows))
+       (eshell-info-banner--get-mounted-partitions-windows))
-       ('darwin
+      ('darwin
-        (eshell-info-banner--get-mounted-partitions-darwin))
+       (eshell-info-banner--get-mounted-partitions-darwin))
-       (other
+      (other
-        (progn
+       (progn
          (warn "Partition detection for %s not yet supported." other)
          nil)))))
 
+(defun eshell-info-banner--get-mounted-partitions ()
+  "Detect mounted partitions on the system.
+
+Take `eshell-info-banner-filter-duplicate-partitions' and
+`eshell-info-banner-exclude-partitions' into account."
+  (let ((partitions (eshell-info-banner--get-mounted-partitions-1)))
+    (when eshell-info-banner-filter-duplicate-partitions
+      (setq partitions
+            (cl-loop for partition in partitions
+                     with used = nil
+                     for signature =
+                     (format "%d-%d"
+                             (eshell-info-banner--mounted-partitions-size partition)
+                             (eshell-info-banner--mounted-partitions-used partition))
+                     unless (member signature used)
+                     collect partition and do (push signature used))))
+    (when eshell-info-banner-exclude-partitions
+      (setq partitions
+            (seq-filter (lambda (partition)
+                          (let ((path (eshell-info-banner--mounted-partitions-path
+                                       partition)))
+                            (not (seq-some
+                                  (lambda (pattern)
+                                    (string-match-p pattern path))
+                                  eshell-info-banner-exclude-partitions))))
+                        partitions)))
+    partitions))
+
 (defun eshell-info-banner--partition-to-string (partition text-padding bar-length)
   "Display a progress bar showing how full a PARTITION is.
 
@@ -652,10 +686,12 @@ critical levels close to 0 rather than 100."
                              percentage)))
     (concat
      (eshell-info-banner--with-face "[" :weight 'bold)
-     (eshell-info-banner--with-face (s-repeat length-filled eshell-info-banner-progress-bar-char)
+     (eshell-info-banner--with-face (eshell-info-banner--string-repeat eshell-info-banner-progress-bar-char
+                                                                       length-filled)
                                     :weight 'bold
                                     :inherit (eshell-info-banner--get-color-percentage percentage-level))
-     (eshell-info-banner--with-face (s-repeat length-empty eshell-info-banner-progress-bar-char)
+     (eshell-info-banner--with-face (eshell-info-banner--string-repeat eshell-info-banner-progress-bar-char
+                                                                       length-empty)
                                     :weight 'bold
                                     :inherit 'eshell-info-banner-background-face)
      (eshell-info-banner--with-face "]" :weight 'bold))))
@@ -690,7 +726,9 @@ the warning face with a battery level of 25% or less."
                 (eshell-info-banner--progress-bar bar-length
                                                   percentage
                                                   t)
-                (s-repeat (if (equal eshell-info-banner-file-size-flavor 'iec) 21 17) " ")
+                (eshell-info-banner--string-repeat
+                 " "
+                 (if (equal eshell-info-banner-file-size-flavor 'iec) 21 17))
                 (format "(%3s%%)\n"
                         (eshell-info-banner--with-face
                          (number-to-string percentage)
@@ -796,15 +834,17 @@ If RELEASE-FILE is nil, use '/etc/os-release'."
   "Get the name of the current macOS or OSX system based on its VERSION."
   `(cond
     ,@(mapcar (lambda (major)
-               `((string-match-p (regexp-quote ,(car major))
+                `((string-match-p ,(car major)
-                                 ,version)
+                                  ,version)
-                 ,(cdr major)))
+                  ,(cdr major)))
               eshell-info-banner--macos-versions)
     (t "unknown version")))
 
 (defun eshell-info-banner--get-os-information-darwin ()
   "See `eshell-info-banner--get-os-information'."
-  `(,(eshell-info-banner--get-macos-name (s-trim (eshell-info-banner--shell-command-to-string "sw_vers -productVersion")))
+  `(,(eshell-info-banner--get-macos-name
+      (s-trim
+       (eshell-info-banner--shell-command-to-string "sw_vers -productVersion")))
     .
     ,(s-trim (eshell-info-banner--shell-command-to-string "uname -rs"))))
 
@@ -855,7 +895,8 @@ build number)."
          (bar-length         (if (equal eshell-info-banner-file-size-flavor 'iec)
                                  (- bar-length 4)
                                bar-length)))
-    (concat (format "%s\n" (s-repeat tot-width eshell-info-banner-progress-bar-char))
+    (concat (format "%s\n" (eshell-info-banner--string-repeat eshell-info-banner-progress-bar-char
+                                                              tot-width))
             (format "%s: %s Kernel.: %s\n"
                     (s-pad-right left-padding
                                  "."
@@ -869,7 +910,8 @@ build number)."
             (eshell-info-banner--display-battery left-padding bar-length)
             (eshell-info-banner--display-memory left-padding bar-length)
             (eshell-info-banner--display-partitions left-padding bar-length)
-            (format "\n%s\n" (s-repeat tot-width eshell-info-banner-progress-bar-char)))))
+            (format "\n%s\n" (eshell-info-banner--string-repeat eshell-info-banner-progress-bar-char
+                                                                tot-width)))))
 
 ;;;###autoload
 (defun eshell-info-banner-update-banner ()