nushell/crates/nu-command/src/commands/format/format_filesize.rs

use crate::prelude::*;
use nu_data::base::shape::InlineShape;
use nu_engine::WholeStreamCommand;
use nu_errors::ShellError;
use nu_protocol::{ColumnPath, Primitive::Filesize, Signature, SyntaxShape, UntaggedValue, Value};
use nu_source::Tagged;
use nu_value_ext::get_data_by_column_path;

pub struct FileSize;

impl WholeStreamCommand for FileSize {
    fn name(&self) -> &str {
        "format filesize"
    }

    fn signature(&self) -> Signature {
        Signature::build("format filesize")
            .required(
                "field",
                SyntaxShape::ColumnPath,
                "the name of the column to update",
            )
            .required(
                "format value",
                SyntaxShape::String,
                "the format into which convert the filesizes",
            )
    }

    fn usage(&self) -> &str {
        "Converts a column of filesizes to some specified format"
    }

    fn run(&self, args: CommandArgs) -> Result<OutputStream, ShellError> {
        filesize(args)
    }

    fn examples(&self) -> Vec<Example> {
        vec![
            Example {
                description: "Convert the size row to KB",
                example: "ls | format filesize size KB",
                result: None,
            },
            Example {
                description: "Convert the apparent row to B",
                example: "du | format filesize apparent B",
                result: None,
            },
        ]
    }
}

fn process_row(
    input: Value,
    format: Tagged<String>,
    field: Arc<ColumnPath>,
) -> Result<Value, ShellError> {
    let replace_for = get_data_by_column_path(&input, &field, move |_, _, error| error);
    match replace_for {
        Ok(s) => {
            if let Value {
                value: UntaggedValue::Primitive(Filesize(fs)),
                ..
            } = s
            {
                let byte_format = InlineShape::format_bytes(fs, Some(&format.item));
                let byte_value = Value::from(byte_format.1);
                Ok(input
                    .replace_data_at_column_path(&field, byte_value)
                    .expect(
                    "Given that the existence check was already done, this shouldn't trigger never",
                ))
            } else {
                Err(ShellError::labeled_error(
                    "the data in this row is not of the type filesize",
                    "invalid datatype in row",
                    input.tag(),
                ))
            }
        }
        Err(e) => Err(e),
    }
}

fn filesize(raw_args: CommandArgs) -> Result<OutputStream, ShellError> {
    let args = raw_args.evaluate_once()?;

    let field: ColumnPath = args.req(0)?;
    let format: Tagged<String> = args.req(1)?;
    let field = Arc::new(field);

    Ok(args
        .input
        .map(move |input| {
            let format = format.clone();
            let field = field.clone();

            match process_row(input, format, field) {
                Ok(s) => Ok(s),
                Err(e) => Err(e),
            }
        })
        .flatten()
        .map(Ok)
        .to_input_stream())
}

#[cfg(test)]
mod tests {
    use super::FileSize;
    use super::ShellError;

    #[test]
    fn examples_work_as_expected() -> Result<(), ShellError> {
        use crate::examples::test as test_examples;

        test_examples(FileSize {})
    }
}