v0.2.0 refactored some fuctions for better performance

Author: git-user-cpp

src/functionality.rs

@@ -1,19 +1,19 @@
 /*
  *  gnulinwiz AKA GNU/Linux Config Wizard: The ultimate post-installation setup assistant for Linux,
  *  streamlining your configuration process with ease and precision.
- *  
+ *
  *  Copyright (C) 2025  Andrew Kushyk
- *  
+ *
  *  This program is free software: you can redistribute it and/or modify
  *  it under the terms of the GNU General Public License as published by
  *  the Free Software Foundation, either version 3 of the License, or
  *  (at your option) any later version.
- *  
+ *
  *  This program is distributed in the hope that it will be useful,
  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  *  GNU General Public License for more details.
- *  
+ *
  *  You should have received a copy of the GNU General Public License
  *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */

src/functionality/commands.rs

@@ -1,19 +1,19 @@
 /*
  *  gnulinwiz AKA GNU/Linux Config Wizard: The ultimate post-installation setup assistant for Linux,
  *  streamlining your configuration process with ease and precision.
- *  
+ *
  *  Copyright (C) 2025  Andrew Kushyk
- *  
+ *
  *  This program is free software: you can redistribute it and/or modify
  *  it under the terms of the GNU General Public License as published by
  *  the Free Software Foundation, either version 3 of the License, or
  *  (at your option) any later version.
- *  
+ *
  *  This program is distributed in the hope that it will be useful,
  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  *  GNU General Public License for more details.
- *  
+ *
  *  You should have received a copy of the GNU General Public License
  *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
@@ -39,7 +39,7 @@ pub fn run_sudo_command(command: &str, args: &[&str]) -> Result<(), String> {
             String::from_utf8_lossy(&output.stderr).trim()
         ))
     }
-} // run_sudo_command
+}
 
 /// runs user commands
 pub fn run_user_command(command: &str, args: &[&str]) -> Result<(), String> {
@@ -58,7 +58,7 @@ pub fn run_user_command(command: &str, args: &[&str]) -> Result<(), String> {
             String::from_utf8_lossy(&output.stderr).trim()
         ))
     }
-} // run_user_command
+}
 
 /// runs sudo commands with stdin
 pub fn run_sudo_command_with_stdin(
@@ -94,4 +94,4 @@ pub fn run_sudo_command_with_stdin(
             String::from_utf8_lossy(&output.stderr).trim()
         ))
     }
-} // run_sudo_command_with_stdin
+}

src/functionality/configs.rs

@@ -1,19 +1,19 @@
 /*
  *  gnulinwiz AKA GNU/Linux Config Wizard: The ultimate post-installation setup assistant for Linux,
  *  streamlining your configuration process with ease and precision.
- *  
+ *
  *  Copyright (C) 2025  Andrew Kushyk
- *  
+ *
  *  This program is free software: you can redistribute it and/or modify
  *  it under the terms of the GNU General Public License as published by
  *  the Free Software Foundation, either version 3 of the License, or
  *  (at your option) any later version.
- *  
+ *
  *  This program is distributed in the hope that it will be useful,
  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  *  GNU General Public License for more details.
- *  
+ *
  *  You should have received a copy of the GNU General Public License
  *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
@@ -23,7 +23,7 @@ use colored::Colorize;
 use std::path::Path;
 
 /// sets up config files in home directory
-pub fn user_config_setup(config_path: String, home_dir: String, cfg_name: &str) -> i8 {
+pub fn user_config_setup(config_path: &str, home_dir: &str, cfg_name: &str) -> i8 {
     let source = Path::new(&config_path);
     let filename = source.file_name();
 
@@ -54,10 +54,10 @@ pub fn user_config_setup(config_path: String, home_dir: String, cfg_name: &str)
             return 1;
         }
     }
-} // user_config_setup
+}
 
 /// sets up root config in /root directory
-pub fn setup_root_config(home_dir: String) -> i8 {
+pub fn setup_root_config(home_dir: &str) -> i8 {
     let oh_my_zsh_src = format!("{}{}", home_dir, "/.oh-my-zsh");
     let oh_my_zsh_dest = String::from("/root/.oh-my-zsh");
     let zshrc_src = format!("{}{}", home_dir, "/.zshrc");
@@ -108,4 +108,4 @@ pub fn setup_root_config(home_dir: String) -> i8 {
     }
 
     return 0;
-} // setup_root_config
+}

src/functionality/env.rs

@@ -1,19 +1,19 @@
 /*
  *  gnulinwiz AKA GNU/Linux Config Wizard: The ultimate post-installation setup assistant for Linux,
  *  streamlining your configuration process with ease and precision.
- *  
+ *
  *  Copyright (C) 2025  Andrew Kushyk
- *  
+ *
  *  This program is free software: you can redistribute it and/or modify
  *  it under the terms of the GNU General Public License as published by
  *  the Free Software Foundation, either version 3 of the License, or
  *  (at your option) any later version.
- *  
+ *
  *  This program is distributed in the hope that it will be useful,
  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  *  GNU General Public License for more details.
- *  
+ *
  *  You should have received a copy of the GNU General Public License
  *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
@@ -22,23 +22,15 @@ use colored::Colorize;
 use std::env::var;
 
 /// gets environment variables
-fn get_env_var(env_var: &str) -> Option<String> {
+/// Returns the value as an owned String if found, None otherwise.
+/// Prints a basic error message if the variable is missing or reading fails.
+pub fn get_env_var(env_var: &str) -> Option<String> {
     match var(env_var) {
-        Ok(username) => Some(username),
-        Err(_) => {
-            eprintln!(
-                "{}\n",
-                "error: could not determine the environment variables.".red()
-            );
+        Ok(value) => Some(value),
+        Err(e) => {
+            eprintln!("{} failed to get environment variable '{}': {}",
+                      "error:".red(), env_var, e);
             None
         }
     }
-} // get_env_var
-
-/// validates environment variables
-pub fn validate_env_var(env_var: &str) -> String {
-    match get_env_var(env_var) {
-        Some(env_var) => env_var,
-        None => "".to_string(),
-    }
-} // validate_env_var
+}

src/functionality/iptables.rs

@@ -1,19 +1,19 @@
 /*
  *  gnulinwiz AKA GNU/Linux Config Wizard: The ultimate post-installation setup assistant for Linux,
  *  streamlining your configuration process with ease and precision.
- *  
+ *
  *  Copyright (C) 2025  Andrew Kushyk
- *  
+ *
  *  This program is free software: you can redistribute it and/or modify
  *  it under the terms of the GNU General Public License as published by
  *  the Free Software Foundation, either version 3 of the License, or
  *  (at your option) any later version.
- *  
+ *
  *  This program is distributed in the hope that it will be useful,
  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  *  GNU General Public License for more details.
- *  
+ *
  *  You should have received a copy of the GNU General Public License
  *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
@@ -48,7 +48,7 @@ pub fn iptables_file_setup() -> i8 {
             2
         }
     }
-} // iptables_setup()
+}
 
 /// immediately sets up iptables rules
 pub fn iptables_rules_setup() -> i8 {
@@ -66,4 +66,4 @@ pub fn iptables_rules_setup() -> i8 {
             1
         }
     }
-} // iptables_rules_setup()
+}

src/functionality/prog_fun.rs

@@ -1,126 +1,129 @@
 /*
  *  gnulinwiz AKA GNU/Linux Config Wizard: The ultimate post-installation setup assistant for Linux,
  *  streamlining your configuration process with ease and precision.
- *  
+ *
  *  Copyright (C) 2025  Andrew Kushyk
- *  
+ *
  *  This program is free software: you can redistribute it and/or modify
  *  it under the terms of the GNU General Public License as published by
  *  the Free Software Foundation, either version 3 of the License, or
  *  (at your option) any later version.
- *  
+ *
  *  This program is distributed in the hope that it will be useful,
  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  *  GNU General Public License for more details.
- *  
+ *
  *  You should have received a copy of the GNU General Public License
  *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
 use colored::Colorize;
 use std::{io::stdin, process::exit};
 
-/// default software installation package
-pub fn default_sw_package() -> Vec<String> {
-    vec![
-        "firefox".to_string(),
-        "clang".to_string(),
-        "zsh".to_string(),
-        "git".to_string(),
-        "gimp".to_string(),
-        "mpv".to_string(),
-        "spectacle".to_string(),
-        "curl".to_string(),
+/// default software installation package list
+/// Returns a slice of static strings.
+pub fn default_sw_package() -> &'static [&'static str] {
+    &[
+        "firefox",
+        "clang",
+        "zsh",
+        "git",
+        "gimp",
+        "mpv",
+        "spectacle",
+        "curl",
     ]
-} // default_package()
+}
 
 /// prints license information
 pub fn print_license_info() {
-    println!("gnulinwiz AKA GNU/Linux Config Wizard  Copyright (C) 2025  Andrew Kushyk\n\
-This program comes with ABSOLUTELY NO WARRANTY; for details see https://www.gnu.org/licenses/gpl-3.0.html/\n\
+    let link = "https://www.gnu.org/licenses/gpl-3.0.html/".blue();
+    println!(
+        "gnulinwiz AKA GNU/Linux Config Wizard  Copyright (C) 2025  Andrew Kushyk\n\
+This program comes with ABSOLUTELY NO WARRANTY; for details see {}\n\
 This is free software, and you are welcome to redistribute it\n\
-under certain conditions; for details see https://www.gnu.org/licenses/gpl-3.0.html/\n");
-} // print_license_info()
+under certain conditions; for details see {}\n",
+        link, link
+    );
+}
 
-/// validates if user has root priviliges. Terminates the program otherwise.
+/// validates if user has root privileges. Terminates the program otherwise.
+///
+/// Running this tool with root privileges is generally unsafe and unnecessary.
+/// This check prevents root execution.
 pub fn validate_root_priviliges() {
     if unsafe { libc::getuid() } == 0 {
         eprintln!("{}", "this program is not recommended to run with root privileges. please run it with your current user.\nexample: ./gnulinwiz".red());
         // exits if root
         exit(1);
     }
-} // validate_root_priviliges()
+}
 
 /// prints green-colored success message if set up successfully
 pub fn print_setup_status_success() {
     println!(
         "{}",
         "all set! your gnu/linux system is ready to use!".green()
     );
-} // print_setup_status_success()
+}
 
 /// prints red-colored failure message if set up unseccessfully
 pub fn print_setup_status_failed() {
     println!(
         "{}",
         "something went wrong... please fix the reported problems and re-run the program.".red()
     );
-} // print_setup_status_failed()
+}
 
-/// checks wether user wants to use default installation list or to enter a custom one
+/// checks whether user wants to use default installation list or to enter a custom one
+/// Returns true for custom list, false for default. Exits on invalid input.
 pub fn check_sw_install_type() -> bool {
     println!(
         "{}",
         "enter any number for the default list of software or 0 to enter a custom list:".yellow()
     );
 
-    let input = read_input().trim().to_string();
+    let input = read_input();
 
-    match input.parse::<i8>() {
+    match input.trim().parse::<i8>() {
         Ok(value) if value == 0 => {
             println!("{}", "you chose to enter a custom list.\ninstallation takes a few minutes, please wait...".green());
-            true
+            return true;
         }
         Ok(_) => {
             println!("{}", "you chose to use the default list.\ninstallation takes a few minutes, please wait...".green());
-            false
+            return false;
         }
         Err(_) => {
-            handle_error("please enter a valid number (0 or 1).");
-            false
+            handle_error(
+                "please enter 0 for a custom list or any other number for the default list.",
+            )
         }
     }
-} // check_sw_install_type
+}
 
 /// Reads a line of input from the user.
+/// Handles read errors by calling handle_error and exiting.
 fn read_input() -> String {
     let mut input = String::new();
     if let Err(error) = stdin().read_line(&mut input) {
-        handle_error(&format!("{}{}", "error reading input:".red(), error));
-        exit(1);
+        handle_error(&format!("{}{}", "error reading input: ".red(), error))
     }
-    input
-} // read_input
+    return input;
+}
 
-/// Handles errors by printing the error message and performing any necessary cleanup.
-fn handle_error(message: &str) {
+/// Handles errors by printing the error message and exiting.
+pub fn handle_error(message: &str) -> ! {
     eprintln!("{}{}", "error: ".red(), message);
     print_setup_status_failed();
     exit(1);
-} // handle_error
+}
 
-/// sets a list of software to install
+/// sets a list of software to install by reading user input
+/// Uses the read_input function and handles potential errors via it.
 pub fn set_sw_list() -> Vec<String> {
-    let mut packages = Vec::new();
-    let mut input = String::new();
-
     println!("enter the software packages to install (separated by spaces):");
-    std::io::stdin()
-        .read_line(&mut input)
-        .expect("failed to read line");
-
-    packages.extend(input.trim().split_whitespace().map(String::from));
-
-    return packages;
-} // set_software()
+    let input = read_input();
+    return input.trim().split_whitespace().map(String::from).collect();
+}