feat: major improvements

Author: mekwall

Cargo.lock

@@ -2,7 +2,7 @@
 name = "git-wippy"
 description = "Git stash with super powers"
 documentation = "https://github.com/mekwall/git-wippy"
-version = "0.1.0"
+version = "0.2.0"
 edition = "2021"
 
 [[bin]]
@@ -11,17 +11,19 @@ path = "src/main.rs"
 doc = false
 
 [dependencies]
-clap = { version = "4.5", features = [] }
-tokio = { version = "1.0", features = ["macros", "rt-multi-thread", "process"] }
-anyhow = "1.0"
-chrono = "0.4"
-dialoguer = "0.11"
+clap = { version = "4.5.3", features = [] }
+tokio = { version = "1.36.0", features = ["macros", "rt-multi-thread", "process"] }
+anyhow = "1.0.81"
+chrono = "0.4.35"
+dialoguer = "0.11.0"
+async-trait = "0.1.77"
+futures = "0.3.30"
 
 [dev-dependencies]
-precious = "0.6.2"
-tokio-test = "0.4"
-assert_cmd = "2.0"
-tempfile = "3.2"
-mockall = "0.12"
-async-trait = "0.1"
-regex = "1.5"
+tokio-test = "0.4.3"
+assert_cmd = "2.0.14"
+tempfile = "3.10.1"
+mockall = "0.12.1"
+async-trait = "0.1.77"
+regex = "1.10.3"
+tokio = { version = "1.36.0", features = ["macros", "rt-multi-thread", "process", "fs"] }

Cargo.toml

@@ -1,16 +1,36 @@
 # git-wippy
 
-## Description
+A Git utility for managing work-in-progress changes across branches with super powers! 🦸‍♂️
 
-Git stash with super powers! A dev tool to simplify working with work in progress changes that acts as a sub command for git.
+## Features
 
-When saving your work it creates a temporary WIP branch (pushes to remote by default) that stores your changes and allows you to restore them later. It even keeps track of which branch you were working on and which files were staged and untracked.
+- 🔄 Save WIP changes to a dedicated branch
+- 📋 List all your WIP branches
+- ⚡ Restore WIP changes back to their original branches
+- 🔒 Thread-safe and async operations
+- 🌟 Maintains file states (staged, unstaged, untracked)
+- 🔍 Smart branch naming with username and timestamps
+- 🌐 Supports both local and remote operations
 
 ## Installation
 
-Coming soon!
+- Coming soon!
+-
+- Download the latest binary for your platform under releases and put it in your executable paths.
 
-Download the latest binary for your platform under releases and put it in your executable paths.
+* ```bash
+
+  ```
+
+- # Install using cargo
+
+* cargo install git-wippy
+
+- ```
+
+  ```
+-
+- Or download the latest binary for your platform from the [releases page](https://github.com/mekwall/git-wippy/releases).
 
 ## Build and install from sources
 
@@ -21,19 +41,58 @@ To install, follow these steps:
 1. Install [Rust and cargo](https://www.rust-lang.org/tools/install).
 2. Clone this repository.
 3. Navigate to the project directory and run `cargo build -r`.
-4. Copy `git-wippy` binary from `target/release` to somehwere that is in your executable paths.
+4. Copy `git-wippy` binary from `target/release` to somewhere in your executable paths.
 
 ## Usage
 
 When `git-wippy` is located somewhere in your executable paths it can be used as a `git` subcommand.
 
-Executed with `git wippy <command>`:
+### Commands
+
+```bash
+# Save your WIP changes (pushes to remote by default)
+git wippy save
+
+# Save changes locally only
+git wippy save --local
+
+# List all your WIP branches
+git wippy list
+
+# Restore changes from a WIP branch
+git wippy restore
+```
+
+## How It Works
+
+1. **Saving Changes**:
 
-- `restore`: Restore your WIP changes
-- `save`: Save your WIP changes (use `--local` flag to only save locally)
-- `list`: List all WIP branches
+   - Creates a WIP branch named `wip/{username}/{timestamp}`
+   - Preserves the state of all files (staged, unstaged, untracked)
+   - Stores metadata about the source branch
+   - Optionally pushes to remote
 
-## Contributing
+2. **Listing Changes**:
+
+   - Shows all WIP branches for the current user
+   - Filters branches matching `wip/{username}/*`
+   - Handles both local and remote branches
+
+3. **Restoring Changes**:
+   - Retrieves changes from the WIP branch
+   - Recreates the original file states
+   - Returns to the source branch
+   - Cleans up the WIP branch
+
+## Development
+
+### Requirements
+
+- Git 2.0+
+- Rust 1.70+
+- Git username configured (`git config user.name`)
+
+### Contributing
 
 If you want to contribute to this project, please follow these steps:
 
@@ -43,6 +102,23 @@ If you want to contribute to this project, please follow these steps:
 4. Push your changes to your fork.
 5. Create a pull request.
 
+```bash
+# Run tests
+cargo test
+
+# Build release version
+cargo build -r
+
+# Install locally
+cargo install --path .
+```
+
+## Acknowledgments
+
+- Built with Rust 🦀
+- Uses [tokio](https://tokio.rs/) for async operations
+- Uses [clap](https://clap.rs/) for CLI argument parsing
+
 ## License
 
-This project is licensed under [MIT](./LICENSE).
+This project is licensed under the [MIT License](./LICENSE).

README.md

@@ -1,9 +1,21 @@
-use crate::utils::{get_user_wip_branches, git_username};
+use crate::utils::{get_user_wip_branches, git_username, GitCommand};
 use anyhow::Result;
 
+/// Lists all WIP branches for the current Git user.
+///
+/// # Details
+/// * Retrieves the current Git username
+/// * Finds all branches matching the pattern "wip/{username}/*"
+/// * Displays the branches in a formatted list
+/// * Shows a message if no WIP branches are found
+///
+/// # Returns
+/// * `Ok(())` if the operation succeeds
+/// * `Err` if username retrieval or branch listing fails
 pub async fn list_wip_branches() -> Result<()> {
+    let git = GitCommand::new();
     let username = git_username().await?;
-    let wip_branches = get_user_wip_branches(&username).await?;
+    let wip_branches = get_user_wip_branches(&username, &git).await?;
 
     if wip_branches.is_empty() {
         println!("No WIP branches found for the user: {}", username);
@@ -16,3 +28,68 @@ pub async fn list_wip_branches() -> Result<()> {
 
     Ok(())
 }
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use crate::utils::MockGit;
+
+    /// Tests listing WIP branches when branches exist
+    #[tokio::test]
+    async fn test_list_wip_branches() -> Result<()> {
+        let mut mock_git = MockGit::new();
+
+        // Mock the git username command
+        mock_git
+            .expect_execute()
+            .with(mockall::predicate::eq(vec![
+                "config".to_string(),
+                "user.name".to_string(),
+            ]))
+            .returning(|_| Ok("test-user".to_string()));
+
+        // Mock the branch listing command
+        mock_git
+            .expect_execute()
+            .with(mockall::predicate::eq(vec![
+                "branch".to_string(),
+                "-a".to_string(),
+            ]))
+            .returning(|_| {
+                Ok(
+                    "* main\nwip/test-user/branch1\nwip/test-user/branch2\nother-branch"
+                        .to_string(),
+                )
+            });
+
+        list_wip_branches().await?;
+        Ok(())
+    }
+
+    /// Tests listing WIP branches when no branches exist
+    #[tokio::test]
+    async fn test_list_wip_branches_empty() -> Result<()> {
+        let mut mock_git = MockGit::new();
+
+        // Mock the git username command
+        mock_git
+            .expect_execute()
+            .with(mockall::predicate::eq(vec![
+                "config".to_string(),
+                "user.name".to_string(),
+            ]))
+            .returning(|_| Ok("test-user".to_string()));
+
+        // Mock the branch listing command with no WIP branches
+        mock_git
+            .expect_execute()
+            .with(mockall::predicate::eq(vec![
+                "branch".to_string(),
+                "-a".to_string(),
+            ]))
+            .returning(|_| Ok("* main\nother-branch".to_string()));
+
+        list_wip_branches().await?;
+        Ok(())
+    }
+}

src/commands/list.rs

@@ -1,3 +1,12 @@
+//! Command implementations for git-wippy
+//!
+//! This module contains the main command implementations that provide
+//! the core functionality of git-wippy:
+//!
+//! * `list` - Lists all WIP branches for the current user
+//! * `save` - Saves current changes to a WIP branch
+//! * `restore` - Restores changes from a WIP branch back to original branch
+
 pub mod list;
 pub mod restore;
 pub mod save;