Merge feature/file-size-flavor into master

commit 31684ffc39217b55f775bc35b7409baf2d394bcc
Author: Lucien Cartier-Tilet <lucien@phundrak.com>
Date:   Sun Dec 19 17:15:39 2021 +0100

    Fix usage of wrong types

    Use numbers and not human-readable file sizes

commit 4627e491bff2257cf37136f00fcd2b0d2bae7279
Author: Lucien Cartier-Tilet <lucien@phundrak.com>
Date:   Sun Dec 19 17:11:10 2021 +0100

    Remove unused function

commit aea999276baad7112feb3e7868be4881af362240
Author: Lucien Cartier-Tilet <lucien@phundrak.com>
Date:   Sun Dec 19 17:11:00 2021 +0100

    Fix undefined function

commit 8afaabd33f1e7a7f0d991b72a1e4f8cb492c153b
Author: Lucien Cartier-Tilet <lucien@phundrak.com>
Date:   Sun Dec 19 16:53:16 2021 +0100

    Introduce `eshell-info-banner-file-size-flavor' custom option

    This custom variable can hold three different values:
    - nil
    - si
    - iec
    This value is passed to `file-size-human-readable', see its
    documentation for more information on the effect of this variable.

    Since the value `iec' introduces an additional character in the size
    displayed, some code is reorganized in order to keep the banner’s size
    by reducing the length of the progress bar.

    Some duplicate code is also merged in the new
    `eshell-info-banner--progress-bar-without-prefix' function.

    Update the README to reflect these changes.

    The `Customizing' heading is now separated in two:
    - one subheading for custom variables
    - one subheading for faces

README.org

@@ -1,12 +1,15 @@
 #+title: eshell-info-banner.el
 #+author: Lucien Cartier-Tilet
 #+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]]
+
 * Introduction
 ~eshell-info-banner.el~ is a utility for creating an informative banner,
 akin to ~fish_greeting~ but for Eshell. But an image is worth a thousand
 words, let’s see how it looks like:
 
-#+caption: Screenshot of the default Eshell information banner
+#+caption: Screenshot of the default Eshell information banner (using the nord theme from ~doom-themes~)
 [[file:img/screenshot.png]]
 
 This will be displayed every time you open a new Eshell instance, or
@@ -22,6 +25,8 @@ macOS. PR are welcome if you want to fix that!
   - [[#070][~0.7.0~]]
 - [[#installation][Installation]]
 - [[#customizing][Customizing]]
+  - [[#custom-variables][Custom Variables]]
+  - [[#faces][Faces]]
 - [[#my-computer-doesnt-have-a-battery-will-this-still-work][My computer doesn’t have a battery, will this still work?]]
 - [[#advice-for-windows-users][Advice for Windows users]]
 - [[#contributing][Contributing]]
@@ -60,12 +65,12 @@ your ~load-path~ and add the following to your ~.emacs~ or your ~init.el~:
   (add-hook 'eshell-banner-load-hook 'eshell-info-banner-update-banner)
 #+end_src
 
-If you use ~use-package~ only, you can then install it like so:
+If you use ~use-package~ only and install the package from MELPA, you
+can then install it like so:
 #+begin_src emacs-lisp
   (use-package eshell-info-banner
     :ensure t
     :defer t
-    :load-path "~/path/to/where/you/cloned/it/eshell-info-banner.el/"
     :hook (eshell-banner-load . eshell-info-banner-update-banner))
 #+end_src
 
@@ -74,24 +79,19 @@ In my case, I prefer using ~use-package~ with ~straight~:
   (use-package eshell-info-banner
     :ensure t
     :defer t
-    :straight (eshell-info-banner :type git
-                                  :host github
-                                  :repo "phundrak/eshell-info-banner.el")
+    :straight (:build t)
     :hook (eshell-banner-load . eshell-info-banner-update-banner))
 #+end_src
 
-I personally also added ~:build t~ in the straight recipe to ensure
-Emacs compiles my package, both to ~.elc~ and ~.eln~ files (I am on Emacs
-28.0, ~feature/native-comp~ got merged into ~master~!)
+You can just use ~:straight t~ if you do not want to ensure the package
+gets compiled by Emacs.
 
 There is probably a similar way to install it with pure ~straight.el~ or
 ~quelpa~, but I’m not knowledgable enough for that, feel free to create
 a PR to add some more installation instructions!
 
-There is currently no plans of making this package available on MELPA
-or non-gnu elpa.
-
 * Customizing
+** Custom Variables
 A couple of variables can be edited by the user in order to configure
 ~eshell-info-banner.el~:
 - ~eshell-info-banner-partition-prefixes~ :: Filter for which
@@ -146,7 +146,19 @@ A couple of variables can be edited by the user in order to configure
   this custom variable.
 
   Default value: ~duf~
+- ~eshell-info-banner-file-size-flavor~ :: This variable reflects the
+  possible values passed to the function ~file-size-human-readable~. It
+  can hold one of these three values:
+  - ~nil~
+  - ~si~
+  - ~iec~
+  Since the value ~iec~ generates longer file size prefixes, progress
+  bars become slightly shorter. For more details on this option, see
+  the documentation of ~file-size-human-readable~.
 
+  Default value: ~nil~
+
+** Faces
 Don’t like the colors used by the package? They should follow by
 default your theme, but you can customize the following faces:
 - ~eshell-info-banner-background-face~ :: Used for filling the empty
@@ -181,4 +193,4 @@ See [[file:CONTRIBUTING.org]].
 
 * License
 ~eshell-info-banner.el~ is available under the GNU GPL-3.0 license. You
-can find the full text in [[file:LICENSE.md][LICENSE.md]].
+can find the full text in the [[file:LICENSE][LICENSE]] file.

eshell-info-banner.el

@@ -2,9 +2,9 @@
 
 ;; Author: Lucien Cartier-Tilet <lucien@phundrak.com>
 ;; Maintainer: Lucien Cartier-Tilet <lucien@phundrak.com>
-;; Version: 0.7.1
+;; Version: 0.8.0
 ;; Package-Requires: ((emacs "25.1") (f "0.20") (s "1"))
-;; Homepage: https://labs.phundrak.com/phundrak/eshell-info-banner.el
+;; Homepage: https://github.com/Phundrak/eshell-info-banner.el
 
 ;; This file is not part of GNU Emacs
 
@@ -82,7 +82,9 @@
       ("11.1"  . "macOS Big Sur")
       ("11.2"  . "macOS Big Sur")
       ("11.3"  . "macOS Big Sur")
-      ("11.4"  . "macOS Big Sur"))
+      ("11.4"  . "macOS Big Sur")
+      ("11.5"  . "macOS Big Sur")
+      ("11.6"  . "macOS Big Sur"))
     "Versions of OSX and macOS and their name."))
 
 
@@ -138,6 +140,19 @@
   :type 'list
   :version "0.3.0")
 
+(defun eshell-info-banner--executable-find (program &optional remote)
+  "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."
+  (if (version< emacs-version "27.1")
+      (let ((default-directory (if (and eshell-info-banner-tramp-aware
+                                        remote)
+                                   default-directory
+                                 "~")))
+        (executable-find program))
+    (executable-find program remote)))
+
 (defcustom eshell-info-banner-duf-executable "duf"
   "Path to the `duf' executable."
   :group 'eshell-info-banner
@@ -145,15 +160,24 @@
   :safe #'stringp
   :version "0.5.0")
 
-(defcustom eshell-info-banner-use-duf (if (executable-find eshell-info-banner-duf-executable)
-                                          t
-                                        nil)
+(defcustom eshell-info-banner-use-duf
+  (if (eshell-info-banner--executable-find eshell-info-banner-duf-executable)
+      t
+    nil)
   "If non-nil, use `duf' instead of `df'."
   :group 'eshell-info-banner
   :type 'boolean
   :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))
+  :version "0.8.0")
+
 
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
                                         ;                Faces                ;
@@ -181,7 +205,7 @@
 
 
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
-                                        ;                Macros               ;
+                                        ;         Macros and Utilities        ;
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 
 (defmacro eshell-info-banner--with-face (str &rest properties)
@@ -193,6 +217,25 @@
 Ensures the command is ran with LANG=C."
   (shell-command-to-string (format "LANG=C %s" command)))
 
+(defun eshell-info-banner--progress-bar-without-prefix (bar-length used total &optional newline)
+  "Display a progress bar without its prefix.
+Display a progress bar of BAR-LENGTH length, followed by an
+indication of how full the memory is with a human readable USED
+and TOTAL size."
+  (let ((percentage (if (= used 0)
+                        0
+                      (/ (* 100 used) total))))
+    (concat (eshell-info-banner--progress-bar bar-length percentage)
+            (format (if (equal eshell-info-banner-file-size-flavor 'iec)
+                        " %8s / %-8s (%3s%%)%s"
+                      " %6s / %-6s (%3s%%)%s")
+                    (file-size-human-readable used eshell-info-banner-file-size-flavor)
+                    (file-size-human-readable total eshell-info-banner-file-size-flavor)
+                    (eshell-info-banner--with-face
+                     (number-to-string percentage)
+                     :inherit (eshell-info-banner--get-color-percentage percentage))
+                    (if newline "\n" "")))))
+
 
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
                                         ;          Internal functions         ;
@@ -204,11 +247,11 @@ Ensures the command is ran with LANG=C."
   "Get uptime of machine if `uptime' is available.
 
 If the executable `uptime' is not found, return nil."
-  (when (executable-find "uptime")
+  (when (eshell-info-banner--executable-find "uptime")
     (let ((uptime-str (eshell-info-banner--shell-command-to-string "uptime -p")))
       (if (not (seq-some (lambda (keyword)
                            (string-match-p keyword uptime-str))
-                         '("invalid" "illegal")))
+                         '("invalid" "illegal" "unknown")))
           (s-chop-prefix "up " (s-trim uptime-str))
         (let ((uptime-str (eshell-info-banner--shell-command-to-string "uptime")))
           (save-match-data
@@ -288,8 +331,8 @@ chosen. Relies on the `duf' command."
                    :path    (if (> (length mount-point) eshell-info-banner-shorten-path-from)
                                 (eshell-info-banner--abbr-path mount-point t)
                               mount-point)
-                   :size    (file-size-human-readable total)
-                   :used    (file-size-human-readable used)
+                   :size    total
+                   :used    used
                    :percent percent)))
               partitions)))
 
@@ -301,28 +344,29 @@ 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 (split-string (eshell-info-banner--shell-command-to-string "df -lH")
-                                  (regexp-quote "\n")
-                                  t)))
-    (seq-filter (lambda (partition)
-                  (let* ((partition  (split-string partition " " t))
-                         (filesystem (nth 0 partition))
-                         (size       (nth 1 partition))
-                         (used       (nth 2 partition))
-                         (percent    (nth 4 partition))
-                         (mount      (nth mount-position partition)))
-                    (unless (seq-some (lambda (prefix)
-                                        (string-prefix-p prefix filesystem t))
-                                      eshell-info-banner-partition-prefixes)
-                      (make-eshell-info-banner--mounted-partitions
-                       :path (if (> (length mount) eshell-info-banner-shorten-path-from)
-                                 (eshell-info-banner--abbr-path mount t)
-                               mount)
-                       :size size
-                       :used used
-                       :percent (string-to-number
-                                 (string-trim-left percent (regexp-quote "%")))))))
-           partitions)))
+  (let ((partitions (cdr (split-string (eshell-info-banner--shell-command-to-string "df -l")
+                                       (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)))
+                                   (used       (string-to-number (nth 2 partition)))
+                                   (percent    (nth 4 partition))
+                                   (mount      (nth mount-position partition)))
+                              (when (seq-some (lambda (prefix)
+                                                (string-prefix-p prefix filesystem t))
+                                              eshell-info-banner-partition-prefixes)
+                                (make-eshell-info-banner--mounted-partitions
+                                 :path (if (> (length mount) eshell-info-banner-shorten-path-from)
+                                           (eshell-info-banner--abbr-path mount t)
+                                         mount)
+                                 :size size
+                                 :used used
+                                 :percent (string-to-number
+                                           (string-trim-left percent (regexp-quote "%")))))))
+                          partitions))))
 
 (defun eshell-info-banner--get-mounted-partitions-gnu ()
   "Detect mounted partitions on a Linux system.
@@ -373,20 +417,16 @@ Return detected partitions as a list of structs."
 
 For TEXT-PADDING and BAR-LENGTH, see the documentation of
 `eshell-info-banner--display-memory'."
-  (let ((percentage (eshell-info-banner--mounted-partitions-percent partition)))
-    (concat (s-pad-right text-padding
-                         "."
-                         (eshell-info-banner--with-face
-                          (eshell-info-banner--mounted-partitions-path partition)
-                          :weight 'bold))
-            ": "
-            (eshell-info-banner--progress-bar bar-length percentage)
-            (format " %6s / %-6s (%3s%%)"
-                    (eshell-info-banner--mounted-partitions-used partition)
-                    (eshell-info-banner--mounted-partitions-size partition)
-                    (eshell-info-banner--with-face
-                     (number-to-string percentage)
-                     :inherit (eshell-info-banner--get-color-percentage percentage))))))
+  (concat (s-pad-right text-padding
+                       "."
+                       (eshell-info-banner--with-face
+                        (eshell-info-banner--mounted-partitions-path partition)
+                        :weight 'bold))
+          ": "
+          (eshell-info-banner--progress-bar-without-prefix
+           bar-length
+           (eshell-info-banner--mounted-partitions-used partition)
+           (eshell-info-banner--mounted-partitions-size partition))))
 
 (defun eshell-info-banner--display-partitions (text-padding bar-length)
   "Display the detected mounted partitions of the system.
@@ -402,7 +442,7 @@ For TEXT-PADDING and BAR-LENGTH, see the documentation of
                                         ; Memory ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 (defun eshell-info-banner--get-memory-gnu ()
   "Get memory usage for GNU/Linux and Hurd."
-  (seq-do (lambda (line)
+  (mapcar (lambda (line)
             (let* ((line (split-string line " " t)))
               (list (s-chop-suffix ":" (nth 0 line))   ; name
                     (string-to-number (nth 1 line))    ; total
@@ -462,18 +502,9 @@ be displayed on the far right.
 
 `BAR-LENGTH' determines the length of the progress bar to be
 displayed."
-  (let ((percentage (if (= used 0)
-                        0
-                      (/ (* 100 used) total))))
-    (concat (s-pad-right text-padding "." type)
-            ": "
-            (eshell-info-banner--progress-bar bar-length percentage)
-            (format " %6s / %-6s (%3s%%)\n"
-                    (file-size-human-readable used)
-                    (file-size-human-readable total)
-                    (eshell-info-banner--with-face
-                     (number-to-string percentage)
-                     :inherit (eshell-info-banner--get-color-percentage percentage))))))
+  (concat (s-pad-right text-padding "." type)
+          ": "
+          (eshell-info-banner--progress-bar-without-prefix bar-length used total t)))
 
 (defun eshell-info-banner--display-memory (text-padding bar-length)
   "Display memories detected on your system.
@@ -549,8 +580,9 @@ The usage of `eshell-info-banner-warning-percentage' and
 thought of as the “percentage of discharge” of the computer.
 Thus, setting the warning at 75% will be translated as showing
 the warning face with a battery level of 25% or less."
-  (let ((battery-level (battery)))
-    (if (or (string= battery-level "Battery status not available")
+  (let ((battery-level (when (file-readable-p "/sys/") (battery))))
+    (if (or (null battery-level)
+            (string= battery-level "Battery status not available")
             (string-match-p (regexp-quote "N/A") battery-level))
         ""
       (let ((percentage (save-match-data
@@ -563,7 +595,7 @@ the warning face with a battery level of 25% or less."
                 (eshell-info-banner--progress-bar bar-length
                                                   percentage
                                                   t)
-                (s-repeat 17 " ")
+                (s-repeat (if (equal eshell-info-banner-file-size-flavor 'iec) 21 17) " ")
                 (format "(%3s%%)\n"
                         (eshell-info-banner--with-face
                          (number-to-string percentage)
@@ -624,13 +656,27 @@ If RELEASE-FILE is nil, use '/etc/os-release'."
   "See `eshell-info-banner--get-os-information'."
   (let ((prefix (if eshell-info-banner-tramp-aware (file-remote-p default-directory) "")))
     `(,(cond
-        ((executable-find "hostnamectl" eshell-info-banner-tramp-aware)
+        ;; Bedrock Linux
+        ((file-exists-p (concat prefix "/bedrock/etc/bedrock-release"))
+         (s-trim (with-temp-buffer
+                   (insert-file-contents (concat prefix "/bedrock/etc/bedrock-release"))
+                   (buffer-string))))
+        ;; Proxmox
+        ((eshell-info-banner--executable-find "pveversion" eshell-info-banner-tramp-aware)
+         (let ((distro (eshell-info-banner--shell-command-to-string "pveversion")))
+           (save-match-data
+             (string-match "/\\([^/]+\\)/" distro)
+             (concat "Proxmox "
+                     (substring-no-properties distro
+                                              (match-beginning 1)
+                                              (match-end 1))))))
+        ((eshell-info-banner--executable-find "hostnamectl" eshell-info-banner-tramp-aware)
          (eshell-info-banner--get-os-information-from-hostnamectl))
-        ((executable-find "lsb_release" eshell-info-banner-tramp-aware)
+        ((eshell-info-banner--executable-find "lsb_release" eshell-info-banner-tramp-aware)
          (eshell-info-banner--get-os-information-from-lsb-release))
         ((file-exists-p (concat prefix "/etc/os-release"))
          (eshell-info-banner--get-os-information-from-release-file))
-        ((executable-find "shepherd")
+        ((eshell-info-banner--executable-find "shepherd")
          (let ((distro (car (s-lines (eshell-info-banner--shell-command-to-string "guix -V")))))
            (save-match-data
              (string-match "\\([0-9\\.]+\\)" distro)
@@ -643,6 +689,10 @@ If RELEASE-FILE is nil, use '/etc/os-release'."
            (s-trim (with-temp-buffer
                      (process-file "uname" nil t nil "-s")
                      (buffer-string)))))
+        ((and (file-exists-p (concat prefix "/system/app"))
+              (file-exists-p (concat prefix "/system/priv-app")))
+         (concat "Android "
+                 (s-trim (eshell-info-banner--shell-command-to-string "getprop ro.build.version.release"))))
         (t "Unknown"))
       .
       ,(s-trim (eshell-info-banner--shell-command-to-string "uname -rs")))))
@@ -687,26 +737,29 @@ build number)."
 (defun eshell-info-banner ()
   "Banner for Eshell displaying system information."
   (let* ((default-directory (if eshell-info-banner-tramp-aware default-directory "~"))
-         (system-info   (eshell-info-banner--get-os-information))
-         (os            (car system-info))
-         (kernel        (cdr system-info))
-         (hostname      (if  eshell-info-banner-tramp-aware
-                            (or (file-remote-p default-directory 'host) (system-name))
-                          (system-name)))
-         (uptime        (eshell-info-banner--get-uptime))
-         (partitions    (eshell-info-banner--get-mounted-partitions))
-         (left-padding  (eshell-info-banner--get-longest-path partitions))
-         (left-text     (max (length os)
-                             (length hostname)))
-         (left-length   (+ left-padding 2 left-text)) ; + ": "
-         (right-text    (+ (length "Kernel: ")
-                           (max (length uptime)
-                                (length kernel))))
-         (tot-width     (max (+ left-length right-text 3)
-                             eshell-info-banner-width))
-         (middle-padding (- tot-width right-text left-padding 4))
+         (system-info       (eshell-info-banner--get-os-information))
+         (os                (car system-info))
+         (kernel            (cdr system-info))
+         (hostname          (if  eshell-info-banner-tramp-aware
+                                (or (file-remote-p default-directory 'host) (system-name))
+                              (system-name)))
+         (uptime             (eshell-info-banner--get-uptime))
+         (partitions         (eshell-info-banner--get-mounted-partitions))
+         (left-padding       (eshell-info-banner--get-longest-path partitions))
+         (left-text          (max (length os)
+                                  (length hostname)))
+         (left-length        (+ left-padding 2 left-text)) ; + ": "
+         (right-text         (+ (length "Kernel: ")
+                                (max (length uptime)
+                                     (length kernel))))
+         (tot-width          (max (+ left-length right-text 3)
+                                  eshell-info-banner-width))
+         (middle-padding     (- tot-width right-text left-padding 4))
 
-         (bar-length    (- tot-width left-padding 4 23)))
+         (bar-length         (- tot-width left-padding 4 23))
+         (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))
             (format "%s: %s Kernel.: %s\n"
                     (s-pad-right left-padding