Merge pull request #49 from KSXGitHub/bar-alignment

KSXGitHub · web-flow · commit 84cb3cd4a769 · 2021-07-26T18:22:38.000+07:00
Customize the alignment of the bars
diff --git a/exports/completion.bash b/exports/completion.bash
@@ -20,7 +20,7 @@ _pdu() {
 
     case "${cmd}" in
         pdu)
-            opts=" -h -V  --json-input --json-output --top-down --no-sort --silent-errors --progress --help --version --bytes-format --quantity --max-depth --total-width --column-width --min-ratio  <files>... "
+            opts=" -h -V  --json-input --json-output --top-down --align-left --no-sort --silent-errors --progress --help --version --bytes-format --quantity --max-depth --total-width --column-width --min-ratio  <files>... "
             if [[ ${cur} == -* || ${COMP_CWORD} -eq 1 ]] ; then
                 COMPREPLY=( $(compgen -W "${opts}" -- "${cur}") )
                 return 0
diff --git a/exports/completion.elv b/exports/completion.elv
@@ -24,6 +24,7 @@ edit:completion:arg-completer[pdu] = [@words]{
             cand --json-input 'Read JSON data from stdin'
             cand --json-output 'Print JSON data instead of an ASCII chart'
             cand --top-down 'Print the tree top-down instead of bottom-up'
+            cand --align-left 'Fill the bars from left to right'
             cand --no-sort 'Preserve order of entries'
             cand --silent-errors 'Prevent filesystem error messages from appearing in stderr'
             cand --progress 'Report progress being made at the expense of performance'
diff --git a/exports/completion.fish b/exports/completion.fish
@@ -7,6 +7,7 @@ complete -c pdu -n "__fish_use_subcommand" -l min-ratio -d 'Minimal size proport
 complete -c pdu -n "__fish_use_subcommand" -l json-input -d 'Read JSON data from stdin'
 complete -c pdu -n "__fish_use_subcommand" -l json-output -d 'Print JSON data instead of an ASCII chart'
 complete -c pdu -n "__fish_use_subcommand" -l top-down -d 'Print the tree top-down instead of bottom-up'
+complete -c pdu -n "__fish_use_subcommand" -l align-left -d 'Fill the bars from left to right'
 complete -c pdu -n "__fish_use_subcommand" -l no-sort -d 'Preserve order of entries'
 complete -c pdu -n "__fish_use_subcommand" -l silent-errors -d 'Prevent filesystem error messages from appearing in stderr'
 complete -c pdu -n "__fish_use_subcommand" -l progress -d 'Report progress being made at the expense of performance'
diff --git a/exports/completion.ps1 b/exports/completion.ps1
@@ -29,6 +29,7 @@ Register-ArgumentCompleter -Native -CommandName 'pdu' -ScriptBlock {
             [CompletionResult]::new('--json-input', 'json-input', [CompletionResultType]::ParameterName, 'Read JSON data from stdin')
             [CompletionResult]::new('--json-output', 'json-output', [CompletionResultType]::ParameterName, 'Print JSON data instead of an ASCII chart')
             [CompletionResult]::new('--top-down', 'top-down', [CompletionResultType]::ParameterName, 'Print the tree top-down instead of bottom-up')
+            [CompletionResult]::new('--align-left', 'align-left', [CompletionResultType]::ParameterName, 'Fill the bars from left to right')
             [CompletionResult]::new('--no-sort', 'no-sort', [CompletionResultType]::ParameterName, 'Preserve order of entries')
             [CompletionResult]::new('--silent-errors', 'silent-errors', [CompletionResultType]::ParameterName, 'Prevent filesystem error messages from appearing in stderr')
             [CompletionResult]::new('--progress', 'progress', [CompletionResultType]::ParameterName, 'Report progress being made at the expense of performance')
diff --git a/exports/completion.zsh b/exports/completion.zsh
@@ -24,6 +24,7 @@ _pdu() {
 '(--quantity)--json-input[Read JSON data from stdin]' \
 '--json-output[Print JSON data instead of an ASCII chart]' \
 '--top-down[Print the tree top-down instead of bottom-up]' \
+'--align-left[Fill the bars from left to right]' \
 '--no-sort[Preserve order of entries]' \
 '--silent-errors[Prevent filesystem error messages from appearing in stderr]' \
 '--progress[Report progress being made at the expense of performance]' \
diff --git a/src/app.rs b/src/app.rs
@@ -9,7 +9,7 @@ use crate::{
     runtime_error::RuntimeError,
     size::{Bytes, Size},
     size_getters::GET_APPARENT_SIZE,
-    visualizer::{Direction, Visualizer},
+    visualizer::{BarAlignment, Direction, Visualizer},
 };
 use pipe_trait::Pipe;
 use std::{io::stdin, time::Duration};
@@ -54,10 +54,12 @@ impl App {
             let Args {
                 bytes_format,
                 top_down,
+                align_left,
                 max_depth,
                 ..
             } = self.args;
             let direction = Direction::from_top_down(top_down);
+            let bar_alignment = BarAlignment::from_align_left(align_left);
 
             let unit_and_tree = stdin()
                 .pipe(serde_json::from_reader::<_, JsonData>)
@@ -74,6 +76,7 @@ impl App {
                         bytes_format: $bytes_format,
                         column_width_distribution,
                         direction,
+                        bar_alignment,
                         max_depth,
                     }
                     .to_string()
@@ -128,6 +131,7 @@ impl App {
                     json_output,
                     bytes_format,
                     top_down,
+                    align_left,
                     max_depth,
                     min_ratio,
                     no_sort,
@@ -136,6 +140,7 @@ impl App {
                 {
                     return Sub {
                         direction: Direction::from_top_down(top_down),
+                        bar_alignment: BarAlignment::from_align_left(align_left),
                         get_data: $get_data,
                         reporter: $create_reporter::<$data>(report_error),
                         bytes_format: $format(bytes_format),
diff --git a/src/app/sub.rs b/src/app/sub.rs
@@ -8,7 +8,7 @@ use crate::{
     runtime_error::RuntimeError,
     size::Size,
     status_board::GLOBAL_STATUS_BOARD,
-    visualizer::{ColumnWidthDistribution, Direction, Visualizer},
+    visualizer::{BarAlignment, ColumnWidthDistribution, Direction, Visualizer},
 };
 use serde::Serialize;
 use std::{fs::Metadata, io::stdout, iter::once, num::NonZeroUsize, path::PathBuf};
@@ -29,6 +29,8 @@ where
     pub bytes_format: Data::DisplayFormat,
     /// The direction of the visualization.
     pub direction: Direction,
+    /// The alignment of the bars.
+    pub bar_alignment: BarAlignment,
     /// Distribution and number of characters/blocks can be placed in a line.
     pub column_width_distribution: ColumnWidthDistribution,
     /// Maximum number of levels that should be visualized.
@@ -57,6 +59,7 @@ where
             json_output,
             bytes_format,
             direction,
+            bar_alignment,
             column_width_distribution,
             max_depth,
             get_data,
@@ -136,6 +139,7 @@ where
             data_tree: &data_tree,
             bytes_format,
             direction,
+            bar_alignment,
             column_width_distribution,
             max_depth,
         };
diff --git a/src/args.rs b/src/args.rs
@@ -77,6 +77,10 @@ pub struct Args {
     #[structopt(long)]
     pub top_down: bool,
 
+    /// Fill the bars from left to right.
+    #[structopt(long)]
+    pub align_left: bool,
+
     /// Aspect of the files/directories to be measured.
     #[structopt(long, possible_values = Quantity::VARIANTS, default_value = Quantity::default_value())]
     pub quantity: Quantity,
diff --git a/src/visualizer.rs b/src/visualizer.rs
@@ -1,10 +1,12 @@
+pub mod bar_alignment;
 pub mod child_position;
 pub mod column_width_distribution;
 pub mod direction;
 pub mod parenthood;
 pub mod proportion_bar;
 pub mod tree;
 
+pub use bar_alignment::BarAlignment;
 pub use child_position::ChildPosition;
 pub use column_width_distribution::ColumnWidthDistribution;
 pub use direction::Direction;
@@ -27,13 +29,14 @@ use std::{fmt::Display, num::NonZeroUsize};
 /// # use parallel_disk_usage::os_string_display::OsStringDisplay;
 /// # use parallel_disk_usage::size::Bytes;
 /// # use parallel_disk_usage::bytes_format::BytesFormat;
-/// # use parallel_disk_usage::visualizer::{Visualizer, Direction, ColumnWidthDistribution};
+/// # use parallel_disk_usage::visualizer::{Visualizer, Direction, BarAlignment, ColumnWidthDistribution};
 /// # fn _wrapper(create_data_tree: fn() -> DataTree<OsStringDisplay, Bytes>) {
 /// let data_tree: DataTree<OsStringDisplay, Bytes> = create_data_tree();
 /// let visualizer = Visualizer {
 ///     data_tree: &data_tree,
 ///     bytes_format: BytesFormat::MetricUnits,
 ///     direction: Direction::BottomUp,
+///     bar_alignment: BarAlignment::Right,
 ///     column_width_distribution: ColumnWidthDistribution::total(100),
 ///     max_depth: std::num::NonZeroUsize::new(10).unwrap(),
 /// };
@@ -52,6 +55,8 @@ where
     pub bytes_format: Data::DisplayFormat,
     /// The direction of the visualization of the tree.
     pub direction: Direction,
+    /// The alignment of the bars.
+    pub bar_alignment: BarAlignment,
     /// Distribution and total number of characters/blocks can be placed in a line.
     pub column_width_distribution: ColumnWidthDistribution,
     /// Maximum number of levels that should be visualized.
diff --git a/src/visualizer/bar_alignment.rs b/src/visualizer/bar_alignment.rs
@@ -0,0 +1,19 @@
+/// The alignment of the bars.
+#[derive(Debug, Clone, Copy, PartialEq, Eq)]
+pub enum BarAlignment {
+    /// Fill the bars from left to right.
+    Left,
+    /// Fill the bars from right to left.
+    Right,
+}
+
+impl BarAlignment {
+    #[cfg(feature = "cli")]
+    pub(crate) const fn from_align_left(align_left: bool) -> Self {
+        if align_left {
+            BarAlignment::Left
+        } else {
+            BarAlignment::Right
+        }
+    }
+}
diff --git a/src/visualizer/methods.rs b/src/visualizer/methods.rs
@@ -86,7 +86,7 @@ where
                     "{size} {tree}│{bar}│{ratio}",
                     size = align_right(&row.size, size_width),
                     tree = align_left(&row.tree_horizontal_slice, tree_width),
-                    bar = &row.proportion_bar,
+                    bar = row.proportion_bar.display(self.bar_alignment),
                     ratio = align_right(&row.percentage, PERCENTAGE_COLUMN_MAX_WIDTH),
                 )
             })
diff --git a/src/visualizer/proportion_bar.rs b/src/visualizer/proportion_bar.rs
@@ -1,3 +1,4 @@
+use super::BarAlignment;
 use derive_more::{AsRef, Deref, Display, From, Into};
 use fmt_iter::repeat;
 use std::fmt::{Display, Error, Formatter};
@@ -29,37 +30,58 @@ pub struct ProportionBar {
 }
 
 impl ProportionBar {
-    pub fn display_level0(self) -> impl Display {
+    fn display_level0(self) -> impl Display {
         repeat(LEVEL0_BLOCK, self.level0)
     }
 
-    pub fn display_level1(self) -> impl Display {
+    fn display_level1(self) -> impl Display {
         repeat(LEVEL1_BLOCK, self.level1)
     }
 
-    pub fn display_level2(self) -> impl Display {
+    fn display_level2(self) -> impl Display {
         repeat(LEVEL2_BLOCK, self.level2)
     }
 
-    pub fn display_level3(self) -> impl Display {
+    fn display_level3(self) -> impl Display {
         repeat(LEVEL3_BLOCK, self.level3)
     }
 
-    pub fn display_level4(self) -> impl Display {
+    fn display_level4(self) -> impl Display {
         repeat(LEVEL4_BLOCK, self.level4)
     }
+
+    /// Create a [displayable](Display) value.
+    pub fn display(self, align: BarAlignment) -> ProportionBarDisplay {
+        ProportionBarDisplay { bar: self, align }
+    }
+}
+
+/// Result of [`ProportionBar::display`].
+#[derive(Debug, Clone, Copy, PartialEq, Eq)]
+pub struct ProportionBarDisplay {
+    pub bar: ProportionBar,
+    pub align: BarAlignment,
 }
 
-impl Display for ProportionBar {
+impl Display for ProportionBarDisplay {
     fn fmt(&self, formatter: &mut Formatter<'_>) -> Result<(), Error> {
-        write!(
-            formatter,
-            "{level4}{level3}{level2}{level1}{level0}",
-            level4 = self.display_level4(),
-            level3 = self.display_level3(),
-            level2 = self.display_level2(),
-            level1 = self.display_level1(),
-            level0 = self.display_level0(),
-        )
+        let ProportionBarDisplay { bar, align } = self;
+        macro_rules! fmt {
+            ($pattern:literal) => {
+                write!(
+                    formatter,
+                    $pattern,
+                    level0 = bar.display_level0(),
+                    level1 = bar.display_level1(),
+                    level2 = bar.display_level2(),
+                    level3 = bar.display_level3(),
+                    level4 = bar.display_level4(),
+                );
+            };
+        }
+        match align {
+            BarAlignment::Left => fmt!("{level0}{level1}{level2}{level3}{level4}"),
+            BarAlignment::Right => fmt!("{level4}{level3}{level2}{level1}{level0}"),
+        }
     }
 }
diff --git a/tests/cli_errors.rs b/tests/cli_errors.rs
@@ -5,10 +5,20 @@ pub use _utils::*;
 
 use command_extra::CommandExtra;
 use maplit::btreeset;
+use parallel_disk_usage::{
+    bytes_format::BytesFormat,
+    data_tree::DataTree,
+    fs_tree_builder::FsTreeBuilder,
+    os_string_display::OsStringDisplay,
+    reporter::{ErrorOnlyReporter, ErrorReport},
+    size_getters::GET_APPARENT_SIZE,
+    visualizer::{BarAlignment, ColumnWidthDistribution, Direction, Visualizer},
+};
 use pipe_trait::Pipe;
 use pretty_assertions::assert_eq;
 use std::{
     collections::BTreeSet,
+    convert::TryInto,
     path::Path,
     process::{Command, Output, Stdio},
 };
@@ -88,18 +98,6 @@ fn max_depth_0() {
 #[cfg(unix)]
 #[test]
 fn fs_errors() {
-    use std::convert::TryInto;
-
-    use parallel_disk_usage::{
-        bytes_format::BytesFormat,
-        data_tree::DataTree,
-        fs_tree_builder::FsTreeBuilder,
-        os_string_display::OsStringDisplay,
-        reporter::{ErrorOnlyReporter, ErrorReport},
-        size_getters::GET_APPARENT_SIZE,
-        visualizer::{ColumnWidthDistribution, Direction, Visualizer},
-    };
-
     let workspace = SampleWorkspace::default();
     fs_permission(workspace.join("empty-dir"), "-r", false);
     fs_permission(workspace.join("nested").join("0"), "-r", false);
@@ -133,6 +131,7 @@ fn fs_errors() {
         data_tree: &data_tree,
         bytes_format: BytesFormat::MetricUnits,
         direction: Direction::BottomUp,
+        bar_alignment: BarAlignment::Right,
         column_width_distribution: ColumnWidthDistribution::total(100),
         max_depth: 10.try_into().unwrap(),
     };
@@ -141,10 +140,14 @@ fn fs_errors() {
 
     fs_permission(workspace.as_path(), "+rwx", true); // to allow SampleWorkspace destructor to clean itself
 
-    let actual_stderr_lines: BTreeSet<_> = stderr.trim_end().lines().collect();
+    let actual_stderr_lines: BTreeSet<_> = stderr
+        .trim_end()
+        .lines()
+        .map(|line| line.trim_start_matches('\r'))
+        .collect();
     let expected_stderr_lines = btreeset! {
-        "\r\r[error] read_dir \"./nested/0\": Permission denied (os error 13)",
-        "\r\r[error] read_dir \"./empty-dir\": Permission denied (os error 13)",
+        "[error] read_dir \"./nested/0\": Permission denied (os error 13)",
+        "[error] read_dir \"./empty-dir\": Permission denied (os error 13)",
     };
     assert_eq!(actual_stderr_lines, expected_stderr_lines);
 
diff --git a/tests/json.rs b/tests/json.rs
@@ -13,7 +13,7 @@ use parallel_disk_usage::{
     reporter::{ErrorOnlyReporter, ErrorReport},
     size::Bytes,
     size_getters::GET_APPARENT_SIZE,
-    visualizer::{ColumnWidthDistribution, Direction, Visualizer},
+    visualizer::{BarAlignment, ColumnWidthDistribution, Direction, Visualizer},
 };
 use pipe_trait::Pipe;
 use pretty_assertions::assert_eq;
@@ -131,6 +131,7 @@ fn json_input() {
         data_tree: &sample_tree(),
         bytes_format: BytesFormat::MetricUnits,
         direction: Direction::BottomUp,
+        bar_alignment: BarAlignment::Right,
         column_width_distribution: ColumnWidthDistribution::total(100),
         max_depth: 10.try_into().unwrap(),
     };
diff --git a/tests/usual_cli.rs b/tests/usual_cli.rs
diff --git a/tests/visualizer.rs b/tests/visualizer.rs

Original file line number	Diff line number	Diff line change
`@@ -86,7 +86,7 @@ where`
`86`	`86`	`"{size} {tree}│{bar}│{ratio}",`
`87`	`87`	`size = align_right(&row.size, size_width),`
`88`	`88`	`tree = align_left(&row.tree_horizontal_slice, tree_width),`
`89`		`- bar = &row.proportion_bar,`
	`89`	`+ bar = row.proportion_bar.display(self.bar_alignment),`
`90`	`90`	`ratio = align_right(&row.percentage, PERCENTAGE_COLUMN_MAX_WIDTH),`
`91`	`91`	`)`
`92`	`92`	`})`