prepare for release v3.0.1

Author: javaLux

CHANGELOG.md

@@ -4,6 +4,15 @@ All notable changes to this project will be documented in this file. The format
 
 ## [Released]
 
+## [3.0.1] - 2024-12-08
+
+### Changed
+- ``local`` subcommand
+  - option `--file` was renamed to `--path`
+  - now you use a path pointing to a file or a directory and calculate a hash sum
+- Refactoring
+<br>
+
 ## [3.0.0] - 2024-11-08
 
 ### Changed

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "hashguard"
-version = "3.0.0"
+version = "3.0.1"
 edition = "2021"
 description = "Command-Line tool for ensuring the integrity of files using hash sums"
 authors = ["javaLux"]
@@ -12,7 +12,6 @@ categories = ["command-line-utilities", "development-tools", "cryptography"]
 rust-version = "1.74.0"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]
 better-panic = "0.3.0"
 chksum = { version = "0.3.0", default-features = false, features = ["md5", "sha1", "sha2-224", "sha2-256", "sha2-384", "sha2-512"] }
@@ -36,7 +35,7 @@ url = "2.5.3"
 [profile.release]
 # compiler optimizations for binary size
 opt-level = "s"
-# link time optimizations
+# link optimizations -> causes a longer link time but produce better optimize code
 lto = true
 # strip either symbols or debuginfo from the final binary
 strip = true

Cargo.toml

@@ -32,17 +32,17 @@ HashGuard is a lean and efficient command-line tool designed to simplify the pro
       Because by enclosing the URL in double quotation marks, you tell the shell to treat the entire string as a single argument, even if it contains spaces or other special characters. This can prevent errors and unexpected behavior in your shell.
 
 * ### Local-Command
-  * Allows to hash local files or any byte-buffer (futhermore you can also compare with a specific hash sum)
+  * Allows to hash local files, directories or any byte-buffer (futhermore you can also compare with a specific hash sum)
   * **Options**
-    * _file_
-      * Calculate a hash sum from a file on your local system
+    * _path_
+      * Calculate a hash sum from a file/dir
     * _buffer_
       * Calculate a hash sum from any given byte buffer
       * What means byte buffer?
         * For example, you can calculate a hash sum from any text that is provided as a ``String``
         * As described in the download command, please enclose the text to be hashed in double quotation marks. This prevents unexpected behavior in your shell.
-    * _Notice_
-      * You can only use one option per call. So either ``file`` or ``buffer``
+  * _Notice_
+    * You can only use one option per call. So either ``path`` or ``buffer``
 
 
 * **Hash Verification:** Verify the authenticity of downloaded or local files by comparing their hash sum with a provided hash value.
@@ -122,17 +122,17 @@ cargo build --release
 **Local-Command**
   * Verify a local file with a hash sum using SHA-1:
     ````shell
-    hashguard local -f /path/to/local_file.txt a1b2c3d4e5f6 -a sha1
+    hashguard local -p /path/to/local_file.txt a1b2c3d4e5f6 -a sha1
     ````
 
   * Calculate a hash sum from a given ``String``:
     ````shell
     hashguard local -b "Hello young Padawan"
     ````
 
-  * Calculate a hash sum from a local file with the default hash algorithm:
+  * Calculate a hash sum from a local directory with the default hash algorithm:
     ````shell
-    hashguard local -f /path/to/local_file.txt
+    hashguard local -p /path/to/test_dir
     ````
 
 **Debug-Option**
@@ -141,7 +141,7 @@ cargo build --release
     hashguard -l debug download "https://example.com/file.zip" a1b2c3d4e5f6
     ````
     ````shell
-    hashguard -l debug local -f /path/to/local_file.txt
+    hashguard -l debug local -p /path/to/local_file.txt
     ````
     * In the event of an error, a full backtrace is displayed
     * In addition, all log outputs are saved in a log file in the application's data directory.

README.md

@@ -1,3 +1,5 @@
+use std::path::PathBuf;
+
 use clap::{Args, Parser, Subcommand};
 
 use crate::{
@@ -24,7 +26,7 @@ pub struct Cli {
 pub enum Commands {
     /// Download a file and calculate a hash sum
     Download(DownloadArgs),
-    /// Calculate a hash sum from a file or a byte buffer
+    /// Calculate a hash sum from a file/dir or a byte buffer
     Local(LocalArgs),
 }
 
@@ -51,7 +53,7 @@ pub struct DownloadArgs {
         help = "A custom path for the file to be saved (Default is the user download folder)",
         value_name = "DIR"
     )]
-    pub output: Option<String>,
+    pub output: Option<PathBuf>,
 
     #[arg(
         short,
@@ -68,15 +70,17 @@ pub struct LocalArgs {
         short,
         long,
         conflicts_with = "buffer",
-        help = "Path to the file for which the hash sum will be calculated"
+        help = "Path to a file/dir for which the hash sum will be calculated",
+        value_name = "PATH"
     )]
-    pub file: Option<String>,
+    pub path: Option<PathBuf>,
 
     #[arg(
         short,
         long,
-        conflicts_with = "file",
-        help = "Buffer (e.g. String) for which the hash sum will be calculated"
+        conflicts_with = "path",
+        help = "Buffer (e.g. String) for which the hash sum will be calculated",
+        value_name = "STRING"
     )]
     pub buffer: Option<String>,
 

src/cli.rs

@@ -8,32 +8,15 @@ pub const INFO_TEMPLATE: ColoredTemplate = ColoredTemplate {
     bg_color: Some(Color::Green),
     style: Style::Bold,
 };
-#[allow(dead_code)]
-pub const WARN_TEMPLATE: ColoredTemplate = ColoredTemplate {
-    ft_color: Color::White,
-    bg_color: Some(Color::Yellow),
-    style: Style::Bold,
-};
 pub const ERROR_TEMPLATE: ColoredTemplate = ColoredTemplate {
     ft_color: Color::White,
     bg_color: Some(Color::Red),
     style: Style::Bold,
 };
-#[allow(dead_code)]
-// These templates using no background color
-pub const INFO_TEMPLATE_NO_BG_COLOR: ColoredTemplate = ColoredTemplate {
-    ft_color: Color::Green,
-    bg_color: None,
-    style: Style::Bold,
-};
+
+// No background color used
 pub const WARN_TEMPLATE_NO_BG_COLOR: ColoredTemplate = ColoredTemplate {
     ft_color: Color::Yellow,
     bg_color: None,
     style: Style::Bold,
 };
-#[allow(dead_code)]
-pub const ERROR_TEMPLATE_NO_BG_COLOR: ColoredTemplate = ColoredTemplate {
-    ft_color: Color::Red,
-    bg_color: None,
-    style: Style::Bold,
-};

src/color_templates.rs

@@ -1,6 +1,6 @@
 use std::error::Error;
 use std::fmt;
-use std::path::{Path, PathBuf};
+use std::path::PathBuf;
 
 use color_eyre::eyre::Result;
 
@@ -14,6 +14,7 @@ use crate::verify::{self, Algorithm};
 #[derive(Debug)]
 pub struct CommandResult {
     pub file_location: Option<PathBuf>,
+    pub buffer_size: Option<usize>,
     pub used_algorithm: Algorithm,
     pub calculated_hash_sum: String,
     pub hash_compare_result: Option<HashCompareResult>,
@@ -27,7 +28,7 @@ pub struct HashCompareResult {
 
 #[derive(Debug, PartialEq, PartialOrd)]
 pub enum CommandError {
-    FileNotExist(String),
+    PathNotExist(String),
     InvalidUrl,
     OutputTargetInvalid(String),
     RenameOptionInvalid(String),
@@ -38,12 +39,12 @@ impl Error for CommandError {}
 impl fmt::Display for CommandError {
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
         match self {
-            CommandError::FileNotExist(file) => {
-                let msg = format!("The specified file '{}' does not exist", file);
+            CommandError::PathNotExist(path) => {
+                let msg = format!("The specified path '{}' does not exist", path);
                 write!(f, "{}", msg)
             }
             CommandError::InvalidUrl => {
-                write!(f, "The provided URL is invalid. Please ensure the URL is correctly formatted,\nincluding the scheme (e.g. 'http://', 'https://').\nFor example: https://www.example.com")
+                write!(f, "The provided URL is invalid. Please ensure the URL is correctly formatted,\nincluding the scheme (e.g. 'http://', 'https://').\nFor example: https://example.com")
             }
             CommandError::OutputTargetInvalid(target) => {
                 let msg = format!(
@@ -71,11 +72,11 @@ pub fn handle_download_cmd(args: DownloadArgs, os_type: os_specifics::OS) -> Res
     let output_target = match output_target {
         Some(output_target) => {
             // only a existing directory is valid as an output target
-            let p = Path::new(&output_target);
-            if p.is_dir() {
-                p.to_path_buf()
+            if output_target.is_dir() {
+                output_target
             } else {
-                let command_err = CommandError::OutputTargetInvalid(utils::get_absolute_path(p));
+                let command_err =
+                    CommandError::OutputTargetInvalid(utils::get_absolute_path(&output_target));
                 return Err(color_eyre::eyre::eyre!(command_err.to_string()));
             }
         }
@@ -119,65 +120,36 @@ pub fn handle_download_cmd(args: DownloadArgs, os_type: os_specifics::OS) -> Res
     // start the download
     let file_path = download::execute_download(download_properties)?;
 
-    // Reads the entire contents of the downloaded file into a bytes vector.
-    let data_to_hash = std::fs::read(&file_path)?;
-
-    let mut calculated_hash_sum =
-        verify::get_hash_sum_as_lower_hex(data_to_hash, Some(file_path.clone()), args.algorithm)?;
-
-    let cmd_result = if let Some(origin_hash_sum) = args.hash_sum {
-        if !verify::is_lower_hex(&origin_hash_sum) {
-            // convert the calculated hash sum to UpperHex
-            calculated_hash_sum = calculated_hash_sum
-                .chars()
-                .map(|c| c.to_uppercase().to_string())
-                .collect();
-        }
-
-        let is_file_modified = verify::is_hash_equal(&origin_hash_sum, &calculated_hash_sum);
-        CommandResult {
-            file_location: Some(file_path),
-            used_algorithm: args.algorithm,
-            calculated_hash_sum,
-            hash_compare_result: Some(HashCompareResult {
-                is_file_modified,
-                origin_hash_sum,
-            }),
-        }
-    } else {
-        CommandResult {
-            file_location: Some(file_path),
-            used_algorithm: args.algorithm,
-            calculated_hash_sum,
-            hash_compare_result: None,
-        }
+    let local_args = LocalArgs {
+        path: Some(file_path),
+        buffer: None,
+        hash_sum: args.hash_sum,
+        algorithm: args.algorithm,
     };
-    utils::processing_cmd_result(cmd_result);
-    Ok(())
+
+    handle_local_cmd(local_args)
 }
 
 // Handle the CLI subcommand 'local'
 pub fn handle_local_cmd(args: LocalArgs) -> Result<()> {
-    let (data_to_hash, file_path) = if let Some(file) = args.file {
-        // check if the given file path point to an existing file
-        let file_path = PathBuf::from(file);
-        if file_path.exists() {
-            let data_to_hash = std::fs::read(file_path.clone())?;
-            (data_to_hash, Some(file_path))
+    let (mut calculated_hash_sum, file_location, buffer_size) = if let Some(path) = args.path {
+        // check if the given path point to an existing file or directory
+        if path.exists() {
+            let calculated_hash_sum = verify::get_file_hash(path.clone(), args.algorithm)?;
+            (calculated_hash_sum, Some(path), None)
         } else {
-            let command_err = CommandError::FileNotExist(utils::get_absolute_path(&file_path));
+            let command_err = CommandError::PathNotExist(utils::get_absolute_path(&path));
             return Err(color_eyre::eyre::eyre!(command_err.to_string()));
         }
     } else if let Some(some_text) = args.buffer {
-        let data_to_hash = some_text.as_bytes().to_vec();
-        (data_to_hash, None)
+        let buffer = some_text.as_bytes().to_vec();
+        let buffer_size = buffer.len();
+        let calculated_hash_sum = verify::get_buffer_hash(buffer, args.algorithm)?;
+        (calculated_hash_sum, None, Some(buffer_size))
     } else {
         return Ok(());
     };
 
-    let mut calculated_hash_sum =
-        verify::get_hash_sum_as_lower_hex(data_to_hash, file_path.clone(), args.algorithm)?;
-
     let cmd_result = if let Some(origin_hash_sum) = args.hash_sum {
         if !verify::is_lower_hex(&origin_hash_sum) {
             // convert the calculated hash sum to UpperHex
@@ -189,7 +161,8 @@ pub fn handle_local_cmd(args: LocalArgs) -> Result<()> {
 
         let is_file_modified = verify::is_hash_equal(&origin_hash_sum, &calculated_hash_sum);
         CommandResult {
-            file_location: file_path,
+            file_location,
+            buffer_size,
             used_algorithm: args.algorithm,
             calculated_hash_sum,
             hash_compare_result: Some(HashCompareResult {
@@ -199,7 +172,8 @@ pub fn handle_local_cmd(args: LocalArgs) -> Result<()> {
         }
     } else {
         CommandResult {
-            file_location: file_path,
+            file_location,
+            buffer_size,
             used_algorithm: args.algorithm,
             calculated_hash_sum,
             hash_compare_result: None,

src/commands.rs

@@ -1,7 +1,6 @@
 #[macro_use]
 extern crate lazy_static;
 
-// make own custom modules available
 mod app;
 mod cli;
 mod color_templates;

src/main.rs

@@ -23,10 +23,10 @@ pub mod unit_tests {
     }
 
     #[test]
-    fn test_upper_hex() {
-        use verify::is_upper_hex;
-        let check_sum = "A92fAE5G42B9F444";
-        assert!(is_upper_hex(check_sum));
+    fn ne_is_lower_hex() {
+        use verify::is_lower_hex;
+        let check_sum = "A92FAE5G42B9F444";
+        assert!(!is_lower_hex(check_sum));
     }
 
     #[test]