Add --score flag to show score with query result

CHANGELOG.md

@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - `$_ZO_FZF_OPTS` to specify custom options for `fzf`
 - `zoxide query --list` to list all matches
+- `zoxide query --score` to show score along with result
 
 ### Changed
 

README.md

@@ -80,12 +80,6 @@ brew install zoxide
 nix-env -iA nixpkgs.zoxide
 ```
 
-#### On OpenBSD
-
-```sh
-pkg_add zoxide
-```
-
 #### Other (using Cargo) [![crates.io](https://img.shields.io/crates/v/zoxide)](https://crates.io/crates/zoxide)
 
 ```sh
@@ -197,6 +191,6 @@ eval "$(zoxide init zsh)"
 - `$_ZO_EXCLUDE_DIRS`: list of directories separated by platform-specific characters
   ("`:`" on Linux/macOS, "`;`" on Windows) to be excluded from the database
 - `$_ZO_FZF_OPTS`: custom flags to pass to `fzf`
-- `$_ZO_MAXAGE`: sets the maximum total rank after which entries start getting deleted
+- `$_ZO_MAXAGE`: sets the maximum total age after which entries start getting deleted
 
 [`dirs` documentation]: https://docs.rs/dirs/latest/dirs/fn.data_local_dir.html

src/db.rs

@@ -3,6 +3,7 @@ use float_ord::FloatOrd;
 use serde::{Deserialize, Serialize};
 use uuid::Uuid;
 
+use std::fmt::{self, Display, Formatter};
 use std::fs::{self, OpenOptions};
 use std::io::{self, Write};
 use std::path::{Path, PathBuf};
@@ -182,7 +183,7 @@ pub struct DbMatches<'a> {
 impl<'a> DbMatches<'a> {
     pub fn new(db: &'a mut Db, now: Epoch, keywords: &[String]) -> DbMatches<'a> {
         db.dirs
-            .sort_unstable_by_key(|dir| FloatOrd(dir.get_frecency(now)));
+            .sort_unstable_by_key(|dir| FloatOrd(dir.get_score(now)));
 
         let idxs = (0..db.dirs.len()).rev();
         let keywords = keywords
@@ -257,7 +258,7 @@ impl Dir {
         true
     }
 
-    pub fn get_frecency(&self, now: Epoch) -> Rank {
+    pub fn get_score(&self, now: Epoch) -> Rank {
         const HOUR: Epoch = 60 * 60;
         const DAY: Epoch = 24 * HOUR;
         const WEEK: Epoch = 7 * DAY;
@@ -273,4 +274,46 @@ impl Dir {
             self.rank * 0.25
         }
     }
+
+    pub fn display(&self) -> DirDisplay {
+        DirDisplay { dir: self }
+    }
+
+    pub fn display_score(&self, now: Epoch) -> DirScoreDisplay {
+        DirScoreDisplay { dir: self, now }
+    }
+}
+
+pub struct DirDisplay<'a> {
+    dir: &'a Dir,
+}
+
+impl Display for DirDisplay<'_> {
+    fn fmt(&self, f: &mut Formatter) -> fmt::Result {
+        write!(f, "{}", self.dir.path)
+    }
+}
+
+pub struct DirScoreDisplay<'a> {
+    dir: &'a Dir,
+    now: Epoch,
+}
+
+impl Display for DirScoreDisplay<'_> {
+    fn fmt(&self, f: &mut Formatter) -> fmt::Result {
+        const SCORE_MIN: Rank = 0.0;
+        const SCORE_MAX: Rank = 9999.0;
+
+        let score = self.dir.get_score(self.now);
+
+        let score_clamped = if score > SCORE_MAX {
+            SCORE_MAX
+        } else if score > SCORE_MIN {
+            score
+        } else {
+            SCORE_MIN
+        };
+
+        write!(f, "{:>4.0} {}", score_clamped, self.dir.path)
+    }
 }