Merge pull request RustedLessPass#33 from RustedLessPass/tests-and-better-comments

Tests and better comments

Author: M1n-74316D65

.github/workflows/cargo-test.yml

@@ -0,0 +1,16 @@
+name: "Cargo test"
+
+on:
+  pull_request:
+    types: [ready_for_review, review_requested]
+
+jobs:
+  test:
+    name: cargo test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@stable
+      - run: |
+          git submodule update --init --recursive
+          cargo test --all-features

.github/workflows/rust-clippy.yml

@@ -15,6 +15,7 @@ on:
   pull_request:
     # The branches below must be a subset of the branches above
     branches: [ "main" ]
+    types: [ready_for_review, review_requested]
   schedule:
     - cron: '22 1 * * 0'
 

.github/workflows/test-build-only.yml

@@ -1,6 +1,8 @@
 name: "test-on-pr"
 
-on: [pull_request]
+on:
+  pull_request:
+    types: [ready_for_review, review_requested]
 
 # This workflow will build your tauri app without uploading it anywhere.
 

src/app.rs

@@ -1,87 +1,89 @@
-use yew::prelude::*;
+/*
+    This module defines the Yew component for the RustedLessPass application.
+
+    It includes:
+        - The definition of the `Msg` enum representing different messages.
+        - The `App` struct representing the application state.
+        - Implementation of the `Component` trait for the `App` struct, providing methods for
+        creating, updating, and viewing the component.
+
+    The `App` component serves as the core controller of the password manager application.
+    It manages the application state, handles user interactions, and renders the user interface.
+*/
 
 use crate::fingerprintgen::fingerprint_calculate;
 use crate::password_utils::{update_disabled_characters, update_show_state};
 use crate::settings::Settings;
 use crate::slider::Slider;
 use crate::switch::Switch;
 use crate::text_input::TextInput;
+use yew::prelude::*;
 
-// Define message enum to handle events
 pub enum Msg {
-    ChangeSettings(Settings), // Message to change settings
-    SetWebsite(String),       // Message to set website value
-    SetUsername(String),      // Message to set username value
-    SetPassword(String),      // Message to set password value
-    GeneratePassword,         // Message to generate password
-    ShowInputPassword,        // Message to show/hide password input
+    ChangeSettings(Settings),
+    SetWebsite(String),
+    SetUsername(String),
+    SetPassword(String),
+    GeneratePassword,
+    ShowInputPassword,
 }
 
-// Define the main application component
 pub struct App {
-    settings: Settings,        // Application settings
-    website: String,           // Website input value
-    username: String,          // Username input value
-    password: String,          // Password input value
-    new_password: String,      // Newly generated password
-    fingerprint: Vec<String>,  // Password fingerprint
-    show: u8,                  // State to manage UI
-    show_input_password: bool, // Flag to show/hide password input
+    settings: Settings,
+    website: String,
+    username: String,
+    password: String,
+    new_password: String,
+    fingerprint: Vec<String>,
+    show: u8,
+    show_input_password: bool,
 }
 
-// Implement default trait for the main application component
 impl Default for App {
     fn default() -> Self {
         Self {
-            settings: Settings::load(),                    // Load settings
-            website: String::new(),                        // Initialize website value
-            username: String::new(),                       // Initialize username value
-            password: String::new(),                       // Initialize password value
-            new_password: "Generate and copy".to_string(), // Initialize new password value
-            fingerprint: fingerprint_calculate(""),        // Calculate fingerprint
-            show: 0,                                       // Initialize show state
-            show_input_password: false,                    // Initialize show_input_password flag
+            settings: Settings::load(),
+            website: String::new(),
+            username: String::new(),
+            password: String::new(),
+            new_password: "Generate and copy".to_string(),
+            fingerprint: fingerprint_calculate(""),
+            show: 0,
+            show_input_password: false,
         }
     }
 }
 
-// Implement component trait for the main application component
 impl Component for App {
-    type Message = Msg; // Define message type
-    type Properties = (); // Define properties type
+    type Message = Msg;
+    type Properties = ();
 
-    // Create function to initialize the component
     fn create(_ctx: &Context<Self>) -> Self {
-        Self::default() // Initialize default values
+        Self::default()
     }
 
-    // Update function to handle messages and update the component
     fn update(&mut self, _ctx: &Context<Self>, msg: Self::Message) -> bool {
         match msg {
             Msg::ChangeSettings(settings) => {
-                self.settings = settings.clone(); // Update settings
+                self.settings = settings.clone();
                 self.settings.disabled = update_disabled_characters(&settings);
-                self.settings.store(); // Store updated settings
-                self.show = 0; // Reset password button state
+                self.settings.store();
+                self.show = 0;
             }
             Msg::SetWebsite(next_website) => {
-                // Handle set website message
-                self.website = next_website; // Update website value
-                self.show = 0; // Reset password button state
+                self.website = next_website;
+                self.show = 0;
             }
             Msg::SetUsername(next_username) => {
-                // Handle set username message
-                self.username = next_username; // Update username value
-                self.show = 0; // Reset password button state
+                self.username = next_username;
+                self.show = 0;
             }
             Msg::SetPassword(next_password) => {
-                // Handle set password message
-                self.password = next_password; // Update password value
-                self.fingerprint = fingerprint_calculate(self.password.clone().as_str()); // Calculate fingerprint
-                self.show = 0; // Reset password button state
+                self.password = next_password;
+                self.fingerprint = fingerprint_calculate(self.password.clone().as_str());
+                self.show = 0;
             }
             Msg::GeneratePassword => {
-                // Handle generate password message
                 (self.show, self.new_password) = update_show_state(
                     self.show,
                     &self.website,
@@ -93,30 +95,27 @@ impl Component for App {
             }
 
             Msg::ShowInputPassword => {
-                // Handle show input password message
-                self.show_input_password = !self.show_input_password; // Toggle show input password flag
+                self.show_input_password = !self.show_input_password;
             }
         };
-        true // Return true to indicate successful update
+        true
     }
 
-    // View function to render the component
     fn view(&self, ctx: &Context<Self>) -> Html {
-        let on_website_change = ctx.link().callback(Msg::SetWebsite); // Callback for website change
-        let on_username_change = ctx.link().callback(Msg::SetUsername); // Callback for username change
-        let on_password_change = ctx.link().callback(Msg::SetPassword); // Callback for password change
+        let on_website_change = ctx.link().callback(Msg::SetWebsite);
+        let on_username_change = ctx.link().callback(Msg::SetUsername);
+        let on_password_change = ctx.link().callback(Msg::SetPassword);
         let on_password_click = ctx.link().callback(|e: MouseEvent| {
             e.prevent_default();
             Msg::ShowInputPassword
-        }); // Callback for password click
+        });
         let on_submit = ctx.link().callback(|e: SubmitEvent| {
             e.prevent_default();
             Msg::GeneratePassword
-        }); // Callback for form submission
+        });
 
-        let Self { ref settings, .. } = *self; // Reference to self
+        let Self { ref settings, .. } = *self;
 
-        // Macro to generate callback for settings change
         macro_rules! settings_callback {
             ($link:expr, $settings:ident; $key:ident as $ty:ty) => {{
                 let settings = $settings.clone();
@@ -131,20 +130,19 @@ impl Component for App {
             }
         }
 
-        // Render HTML using Yew's html! macro
         html! {
             <body>
             <nav class="container-fluid">
                 <ul>
                 <li>
                     <a href="./"><img src="assets/icons/maskable_icon_x48.png" alt="Description of the image" width="37.7048437335240"
-                        height="37.7048437335240"/><strong>{"RustedLessPass"}</strong></a> // Application name
+                        height="37.7048437335240"/><strong>{"RustedLessPass"}</strong></a>
                 </li>
                 </ul>
                 <ul>
                 <li>
                     <details class="dropdown">
-                    <summary role="button" class="secondary">{"Theme"}</summary> // Theme dropdown
+                    <summary role="button" class="secondary">{"Theme"}</summary>
                     <ul dir="rtl">
                         <li><a href="#" data-theme-switcher="auto">{"Auto"}</a></li>
                         <li><a href="#" data-theme-switcher="light">{"Light"}</a></li>
@@ -159,19 +157,19 @@ impl Component for App {
                 <article>
                 <div>
                     <hgroup class="title">
-                    <h1>{"Stateless Password Manager"}</h1> // Application title
+                    <h1>{"Stateless Password Manager"}</h1>
                     <p>{"Remember only one master password to access your passwords at any time, on any device, without the need
                         for
-                        syncing."}</p> // Application description
+                        syncing."}</p>
                     </hgroup>
                     <form onsubmit={on_submit}>
                     <TextInput value={self.website.clone()} input_type={"text"} name={"Website"} autocomplete={"off"}
-                        on_change={on_website_change} /> // Website input field
+                        on_change={on_website_change} />
                     <TextInput value={self.username.clone()} input_type={"text"} name={"Username"} autocomplete={"email,username"}
-                        on_change={on_username_change} /> // Username input field
+                        on_change={on_username_change} />
                     <fieldset role="group">
                         <TextInput value={self.password.clone()} input_type={if self.show_input_password {"text"} else {"password"}}
-                        name={"Password"} autocomplete={"current-password"} on_change={on_password_change} /> // Password input field
+                        name={"Password"} autocomplete={"current-password"} on_change={on_password_change} />
                         <button
                             style="white-space: nowrap;margin-left: 0rem; padding-left: 0.5rem; padding-right: 0.5rem; align-self: center;"
                             onclick={on_password_click}>
@@ -184,31 +182,28 @@ impl Component for App {
                             <i class={match self.fingerprint.last() { Some(s)=> format!("fa fa-fw {}", s),
                             None => String::new(),
                             }} style="margin-left: 0.2rem;"></i>
-                        </button> // Password fingerprint icons
+                        </button>
                     </fieldset>
                     <fieldset>
                         <nav>
-
                         <Switch label="a-z" onchange={settings_callback!(ctx.link(), settings; lowercase)}
-                            value={settings.lowercase} value_disabled={self.settings.disabled.clone() == "a-z"} /> // Switch for lowercase
+                            value={settings.lowercase} value_disabled={self.settings.disabled.clone() == "a-z"} />
                         <Switch label="A-Z" onchange={settings_callback!(ctx.link(), settings; uppercase)}
-                            value={settings.uppercase} value_disabled={self.settings.disabled.clone() == "A-Z"} /> // Switch for uppercase
+                            value={settings.uppercase} value_disabled={self.settings.disabled.clone() == "A-Z"} />
                         <Switch label="0-9" onchange={settings_callback!(ctx.link(), settings; numbers)}
-                            value={settings.numbers} value_disabled={self.settings.disabled.clone() == "0-9"} /> // Switch for numbers
+                            value={settings.numbers} value_disabled={self.settings.disabled.clone() == "0-9"} />
                         <Switch label="%!@" onchange={settings_callback!(ctx.link(), settings; symbols)}
-                            value={settings.symbols} value_disabled={self.settings.disabled.clone() == "%!@"} /> // Switch for symbols
-
+                            value={settings.symbols} value_disabled={self.settings.disabled.clone() == "%!@"} />
                         </nav>
                         <div class="grid" style="padding: 0rem;">
                         <Slider label="Size" max=35 min=1 onchange={settings_callback!(ctx.link(), settings; size)}
-                            value={settings.size} /> // Slider for password size
+                            value={settings.size} />
                         <Slider label="Counter" max=100 min=1 onchange={settings_callback!(ctx.link(), settings; counter)}
-                            value={settings.counter} /> // Slider for password counter
+                            value={settings.counter} />
                         </div>
-
                     </fieldset>
                     <button type="submit" class="contrast">{if self.show == 0 {"Generate and copy"} else if self.show == 1
-                        {"**************"} else {self.new_password.as_str()}}</button> // Submit button
+                        {"**************"} else {self.new_password.as_str()}}</button>
                     </form>
                 </div>
                 </article>
@@ -218,10 +213,9 @@ impl Component for App {
                 <small>{"Built with "}<a href="https://rust-lang.org" class="secondary">{"Rust"}</a>{", "}<a
                     href="https://github.com/71/lesspass.rs" class="secondary">{"lesspass.rs"}</a>{", "}<a href="https://yew.rs"
                     class="secondary">{"Yew"}</a>{" and "}<a href="https://picocss.com" class="secondary">{"Pico"}</a>{" • "}
-                <a href="https://github.com/RustedLessPass/RustedLessPass" class="secondary">{"Source code"}</a></small> // Footer information
+                <a href="https://github.com/RustedLessPass/RustedLessPass" class="secondary">{"Source code"}</a></small>
             </footer>
-
-            <script src="assets/minimal-theme-switcher.js"></script> // JavaScript for theme switcher
+            <script src="assets/minimal-theme-switcher.js"></script>
             </body>
         }
     }