Merge pull request #23 from KSXGitHub/json

JSON import/export

Author: KSXGitHub

Cargo.lock

@@ -43,7 +43,8 @@ required-features = ["cli-completions"]
 
 [features]
 default = ["cli"]
-cli = ["structopt", "structopt-utilities"]
+json = ["serde/derive", "serde_json"]
+cli = ["structopt", "structopt-utilities", "json"]
 cli-completions = ["cli"]
 
 [dependencies]
@@ -67,6 +68,14 @@ optional = true
 version = "^0.0.8"
 optional = true
 
+[dependencies.serde]
+version = "^1.0.126"
+optional = true
+
+[dependencies.serde_json]
+version = "^1.0.64"
+optional = true
+
 [dependencies.strum]
 version = "^0.20.0"
 features = ["derive"]

Cargo.toml

@@ -20,7 +20,7 @@ _pdu() {
 
     case "${cmd}" in
         pdu)
-            opts=" -h -V  --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 --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

exports/completion.bash

@@ -21,6 +21,8 @@ edit:completion:arg-completer[pdu] = [@words]{
             cand --total-width 'Width of the visualization'
             cand --column-width 'Maximum widths of the tree column and width of the bar column'
             cand --min-ratio 'Minimal size proportion required to appear'
+            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 --no-sort 'Preserve order of entries'
             cand --silent-errors 'Prevent filesystem error messages from appearing in stderr'

exports/completion.elv

@@ -4,6 +4,8 @@ complete -c pdu -n "__fish_use_subcommand" -l max-depth -d 'Maximum depth to dis
 complete -c pdu -n "__fish_use_subcommand" -l total-width -d 'Width of the visualization'
 complete -c pdu -n "__fish_use_subcommand" -l column-width -d 'Maximum widths of the tree column and width of the bar column'
 complete -c pdu -n "__fish_use_subcommand" -l min-ratio -d 'Minimal size proportion required to appear'
+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 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'

exports/completion.fish

@@ -26,6 +26,8 @@ Register-ArgumentCompleter -Native -CommandName 'pdu' -ScriptBlock {
             [CompletionResult]::new('--total-width', 'total-width', [CompletionResultType]::ParameterName, 'Width of the visualization')
             [CompletionResult]::new('--column-width', 'column-width', [CompletionResultType]::ParameterName, 'Maximum widths of the tree column and width of the bar column')
             [CompletionResult]::new('--min-ratio', 'min-ratio', [CompletionResultType]::ParameterName, 'Minimal size proportion required to appear')
+            [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('--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')

exports/completion.ps1

@@ -21,6 +21,8 @@ _pdu() {
 '(--column-width)--total-width=[Width of the visualization]' \
 '*--column-width=[Maximum widths of the tree column and width of the bar column]' \
 '--min-ratio=[Minimal size proportion required to appear]' \
+'(--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]' \
 '--no-sort[Preserve order of entries]' \
 '--silent-errors[Prevent filesystem error messages from appearing in stderr]' \

exports/completion.zsh

@@ -4,13 +4,15 @@ pub use sub::Sub;
 
 use crate::{
     args::{Args, Quantity},
+    json_data::JsonData,
     reporter::{ErrorOnlyReporter, ErrorReport, ProgressAndErrorReporter, ProgressReport},
     runtime_error::RuntimeError,
     size::{Bytes, Size},
     size_getters::GET_APPARENT_SIZE,
-    visualizer::Direction,
+    visualizer::{Direction, Visualizer},
 };
-use std::time::Duration;
+use pipe_trait::Pipe;
+use std::{io::stdin, time::Duration};
 use structopt_utilities::StructOptUtils;
 
 #[cfg(unix)]
@@ -44,6 +46,48 @@ impl App {
 
         let column_width_distribution = self.args.column_width_distribution();
 
+        if self.args.json_input {
+            if !self.args.files.is_empty() {
+                return Err(RuntimeError::JsonInputArgConflict);
+            }
+
+            let Args {
+                bytes_format,
+                top_down,
+                max_depth,
+                ..
+            } = self.args;
+            let direction = Direction::from_top_down(top_down);
+
+            let json_data = stdin()
+                .pipe(serde_json::from_reader::<_, JsonData>)
+                .map_err(RuntimeError::DeserializationFailure)?;
+
+            macro_rules! visualize {
+                ($reflection:expr, $bytes_format: expr) => {{
+                    let data_tree = $reflection
+                        .par_try_into_tree()
+                        .map_err(|error| RuntimeError::InvalidInputReflection(error.to_string()))?;
+                    Visualizer {
+                        data_tree: &data_tree,
+                        bytes_format: $bytes_format,
+                        column_width_distribution,
+                        direction,
+                        max_depth,
+                    }
+                    .to_string()
+                }};
+            }
+
+            let visualization = match json_data {
+                JsonData::Bytes(reflection) => visualize!(reflection, bytes_format),
+                JsonData::Blocks(reflection) => visualize!(reflection, ()),
+            };
+
+            print!("{}", visualization); // it already ends with "\n", println! isn't needed here.
+            return Ok(());
+        }
+
         let report_error = if self.args.silent_errors {
             ErrorReport::SILENT
         } else {
@@ -80,6 +124,7 @@ impl App {
                     quantity: Quantity::$quantity,
                     progress: $progress,
                     files,
+                    json_output,
                     bytes_format,
                     top_down,
                     max_depth,
@@ -94,6 +139,7 @@ impl App {
                         reporter: $create_reporter::<$data>(report_error),
                         bytes_format: $format(bytes_format),
                         files,
+                        json_output,
                         column_width_distribution,
                         max_depth,
                         min_ratio,

src/app.rs

@@ -1,25 +1,30 @@
 use crate::{
     args::Fraction,
-    data_tree::DataTree,
+    data_tree::{DataTree, DataTreeReflection},
     fs_tree_builder::FsTreeBuilder,
+    json_data::JsonData,
     os_string_display::OsStringDisplay,
     reporter::ParallelReporter,
     runtime_error::RuntimeError,
     size::Size,
     status_board::GLOBAL_STATUS_BOARD,
     visualizer::{ColumnWidthDistribution, Direction, Visualizer},
 };
-use std::{fs::Metadata, iter::once, num::NonZeroUsize, path::PathBuf};
+use serde::Serialize;
+use std::{fs::Metadata, io::stdout, iter::once, num::NonZeroUsize, path::PathBuf};
 
 /// The sub program of the main application.
 pub struct Sub<Data, GetData, Report>
 where
-    Data: Size + Into<u64> + Send + Sync,
+    Data: Size + Into<u64> + Serialize + Send + Sync,
     Report: ParallelReporter<Data> + Sync,
     GetData: Fn(&Metadata) -> Data + Copy + Sync,
+    DataTreeReflection<String, Data>: Into<JsonData>,
 {
     /// List of files and/or directories.
     pub files: Vec<PathBuf>,
+    /// Print JSON data instead of an ASCII chart.
+    pub json_output: bool,
     /// Format to be used to [`display`](Size::display) the data.
     pub bytes_format: Data::DisplayFormat,
     /// The direction of the visualization.
@@ -40,14 +45,16 @@ where
 
 impl<Data, GetData, Report> Sub<Data, GetData, Report>
 where
-    Data: Size + Into<u64> + Send + Sync,
+    Data: Size + Into<u64> + Serialize + Send + Sync,
     Report: ParallelReporter<Data> + Sync,
     GetData: Fn(&Metadata) -> Data + Copy + Sync,
+    DataTreeReflection<String, Data>: Into<JsonData>,
 {
     /// Run the sub program.
     pub fn run(self) -> Result<(), RuntimeError> {
         let Sub {
             files,
+            json_output,
             bytes_format,
             direction,
             column_width_distribution,
@@ -108,6 +115,16 @@ where
             data_tree
         };
 
+        if json_output {
+            let json_data: JsonData = data_tree
+                .into_reflection() // I really want to use std::mem::transmute here but can't.
+                .par_convert_names_to_utf8() // TODO: allow non-UTF8 somehow.
+                .expect("convert all names from raw string to UTF-8")
+                .into();
+            return serde_json::to_writer(stdout(), &json_data)
+                .map_err(RuntimeError::SerializationFailure);
+        }
+
         let visualizer = Visualizer {
             data_tree: &data_tree,
             bytes_format,

src/app/sub.rs

@@ -48,13 +48,27 @@ use text_block_macros::text_block;
         ""
         "    Only show disk usage chart of entries whose size is at least 5% of total"
         "    $ pdu --min-ratio=0.05"
+        ""
+        "    Show disk usage data as JSON instead of chart"
+        "    $ pdu --min-ratio=0 --json-output | jq"
+        ""
+        "    Visualize existing JSON representation of disk usage data"
+        "    $ pdu --min-ratio=0 < disk-usage.json"
     },
 )]
 pub struct Args {
     /// List of files and/or directories.
     #[structopt(name = "files")]
     pub files: Vec<PathBuf>,
 
+    /// Read JSON data from stdin.
+    #[structopt(long, conflicts_with = "quantity")]
+    pub json_input: bool,
+
+    /// Print JSON data instead of an ASCII chart.
+    #[structopt(long)]
+    pub json_output: bool,
+
     /// How to display the numbers of bytes.
     #[structopt(long, possible_values = BytesFormat::VARIANTS, default_value = BytesFormat::default_value())]
     pub bytes_format: BytesFormat,