Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add pretty-printing for bytes #17

Merged
merged 3 commits into from
Apr 6, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions src/bytes.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
use std::cmp;

const UNITS: [&str; 4] = ["B", "kB", "MB", "GB"];

pub struct Bytes {
bytes: f64,
}

impl Bytes {
pub fn new(bytes: u64) -> Self {
Self {
bytes: bytes as f64,
}
}
}

impl std::fmt::Display for Bytes {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let num = self.bytes;
debug_assert!(num >= 0.0);
if num < 1_f64 {
return write!(f, "{} B", num);
}
let delimiter = 1000_f64;
let exponent = cmp::min((num.ln() / 6.90775).floor() as i32, 4);

write!(f, "{:.2} ", num / delimiter.powi(exponent))?;
write!(f, "{}", UNITS[exponent as usize])
}
}
5 changes: 3 additions & 2 deletions src/compressors/bzip.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ use colored::Colorize;
use super::{Compressor, Entry};
use crate::{
extension::CompressionFormat,
bytes::Bytes,
file::File,
utils::{check_for_multiple_files, ensure_exists},
};
Expand All @@ -22,10 +23,10 @@ impl BzipCompressor {
};

println!(
"{}: compressed {:?} into memory ({} bytes)",
"{}: compressed {:?} into memory ({})",
"info".yellow(),
&path,
contents.len()
Bytes::new(contents.len() as u64)
);

Ok(contents)
Expand Down
5 changes: 3 additions & 2 deletions src/compressors/gzip.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ use super::{Compressor, Entry};
use crate::{
extension::CompressionFormat,
file::File,
bytes::Bytes,
utils::{check_for_multiple_files, ensure_exists},
};

Expand All @@ -27,10 +28,10 @@ impl GzipCompressor {
};

println!(
"{}: compressed {:?} into memory ({} bytes)",
"{}: compressed {:?} into memory ({})",
"info".yellow(),
&path,
bytes.len()
Bytes::new(bytes.len() as u64)
);

Ok(bytes)
Expand Down
5 changes: 3 additions & 2 deletions src/compressors/lzma.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ use super::{Compressor, Entry};
use crate::{
extension::CompressionFormat,
file::File,
bytes::Bytes,
utils::{check_for_multiple_files, ensure_exists},
};

Expand All @@ -27,10 +28,10 @@ impl LzmaCompressor {
};

println!(
"{}: compressed {:?} into memory ({} bytes)",
"{}: compressed {:?} into memory ({})",
"info".yellow(),
&path,
bytes.len()
Bytes::new(bytes.len() as u64)
);

Ok(bytes)
Expand Down
6 changes: 3 additions & 3 deletions src/decompressors/tar.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ use colored::Colorize;
use tar::{self, Archive};

use super::decompressor::{DecompressionResult, Decompressor};
use crate::{dialogs::Confirmation, file::File, utils};
use crate::{dialogs::Confirmation, file::File, bytes::Bytes, utils};

#[derive(Debug)]
pub struct TarDecompressor {}
Expand Down Expand Up @@ -45,10 +45,10 @@ impl TarDecompressor {
file.unpack_in(into)?;

println!(
"{}: {:?} extracted. ({} bytes)",
"{}: {:?} extracted. ({})",
"info".yellow(),
into.join(file.path()?),
file.size()
Bytes::new(file.size())
);

let file_path = fs::canonicalize(file_path)?;
Expand Down
6 changes: 3 additions & 3 deletions src/decompressors/to_memory.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ use colored::Colorize;

use super::decompressor::{DecompressionResult, Decompressor};
use crate::utils;
// use niffler;
use crate::bytes::Bytes;
use crate::{extension::CompressionFormat, file::File};

struct DecompressorToMemory {}
Expand Down Expand Up @@ -37,10 +37,10 @@ impl DecompressorToMemory {
let bytes_read = reader.read_to_end(&mut buffer)?;

println!(
"{}: {:?} extracted into memory ({} bytes).",
"{}: {:?} extracted into memory ({}).",
"info".yellow(),
path,
bytes_read
Bytes::new(bytes_read as u64)
);

Ok(buffer)
Expand Down
6 changes: 3 additions & 3 deletions src/decompressors/zip.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ use colored::Colorize;
use zip::{self, read::ZipFile, ZipArchive};

use super::decompressor::{DecompressionResult, Decompressor};
use crate::{dialogs::Confirmation, file::File, utils};
use crate::{dialogs::Confirmation, file::File, bytes::Bytes, utils};

#[cfg(unix)]
fn __unix_set_permissions(file_path: &Path, file: &ZipFile) {
Expand Down Expand Up @@ -73,10 +73,10 @@ impl ZipDecompressor {
}
}
println!(
"{}: \"{}\" extracted. ({} bytes)",
"{}: \"{}\" extracted. ({})",
"info".yellow(),
file_path.display(),
file.size()
Bytes::new(file.size())
);

let mut output_file = fs::File::create(&file_path)?;
Expand Down
5 changes: 3 additions & 2 deletions src/evaluator.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ use std::{
use colored::Colorize;

use crate::{
bytes::Bytes,
cli::{VERSION, Command},
compressors::{
Entry, Compressor, BzipCompressor, GzipCompressor, LzmaCompressor, TarCompressor,
Expand Down Expand Up @@ -199,10 +200,10 @@ impl Evaluator {
};

println!(
"{}: writing to {:?}. ({} bytes)",
"{}: writing to {:?}. ({})",
"info".yellow(),
output_path,
bytes.len()
Bytes::new(bytes.len() as u64)
);
fs::write(output_path, bytes)?;

Expand Down
2 changes: 1 addition & 1 deletion src/extension.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ use std::{

use CompressionFormat::*;

use crate::{debug, utils::to_utf};
use crate::utils::to_utf;

/// Represents the extension of a file, but only really caring about
/// compression formats (and .tar).
Expand Down
1 change: 1 addition & 0 deletions src/main.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
mod bytes;
mod cli;
mod compressors;
mod decompressors;
Expand Down
73 changes: 72 additions & 1 deletion src/test.rs
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ where
}

#[cfg(test)]
mod tests {
mod argparsing {
use super::{make_dummy_files};
use crate::cli;
use crate::cli::Command;
Expand Down Expand Up @@ -103,6 +103,77 @@ mod tests {
}
}

#[cfg(test)]
mod byte_pretty_printing {
use crate::bytes::Bytes;
#[test]
fn bytes () {
assert_eq!(
&format!("{}", Bytes::new(234)),
"234.00 B"
);

assert_eq!(
&format!("{}", Bytes::new(999)),
"999.00 B"
);
}

#[test]
fn kilobytes () {
assert_eq!(
&format!("{}", Bytes::new(2234)),
"2.23 kB"
);

assert_eq!(
&format!("{}", Bytes::new(62500)),
"62.50 kB"
);

assert_eq!(
&format!("{}", Bytes::new(329990)),
"329.99 kB"
);
}

#[test]
fn megabytes () {
assert_eq!(
&format!("{}", Bytes::new(2750000)),
"2.75 MB"
);

assert_eq!(
&format!("{}", Bytes::new(55000000)),
"55.00 MB"
);

assert_eq!(
&format!("{}", Bytes::new(987654321)),
"987.65 MB"
);
}

#[test]
fn gigabytes () {
assert_eq!(
&format!("{}", Bytes::new(5280000000)),
"5.28 GB"
);

assert_eq!(
&format!("{}", Bytes::new(95200000000)),
"95.20 GB"
);

assert_eq!(
&format!("{}", Bytes::new(302000000000)),
"302.00 GB"
);
}
}

// #[cfg(test)]
// mod cli {
// use super::*;
Expand Down