finaally done

Author: mendelsshop

README.md

@@ -7,3 +7,12 @@ Parser (main) vs Regex approach benchmarks:
 | --- | --- | --- | --- |
 |regex| 313 second(s) | 22 second(s) | 8 second(s) |
 |parser| 22 second(s) | 21 second(s)| 1 second(s) |
+
+* These benchmarks were done in debug mode on a Ryzen 7 5700u with 16Gb of ram.
+
+## Structure of this project
+
+* [git-function-history-lib](https://github.com/mendelsshop/git_function_history/tree/main/git-function-history-lib) - the library itself
+* [function_history_backend_thread](https://github.com/mendelsshop/git_function_history/tree/main/function_history_backend_thread) - a threading middleware for the library (used by the GUI and TUI)
+* [cargo-function-history](https://github.com/mendelsshop/git_function_history/tree/main/cargo-function-history) - a cargo subcommand that uses the library (TUI)
+* [git-function-history-gui](https://github.com/mendelsshop/git_function_history/tree/main/git-function-history-gui) - the GUI frontend

TODO.md

@@ -12,10 +12,14 @@
   - [x] add new documentation for the new filters and fix some old documentation that talks about filter commitfunctions and files etc
 - TUI
   - [x] use a proper input box for the edit bar, so that delete and scrolling the input works
-  - [ ] finish documentation
+  - [x] finish documentation
 
 - General
   - [x] add the new filters to the GUI and TUI
   - [/] clean up the code
-  - [/] add more logging in the code (and remove the `println!`s)
-  - [ ] bump versions when all else is done and publish to crates.io
+  - [x] add more logging in the code (and remove the `println!`s)
+  - [x] bump versions when all else is done and publish to crates.io
+
+- version 7.0
+  - [ ] add more and better ways to filter dates
+  - [ ] add filters for git specific stuff like author, committer, etc

cargo-function-history/Cargo.toml

@@ -11,7 +11,7 @@ description = "cargo frontend for git-function-history"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-git_function_history = { path = "../git-function-history-lib", version = "0.5.4" }
+git_function_history = { path = "../git-function-history-lib", version = "0.6.0" }
 lazy_static = "1.3.0"
 tui = { version = "0.19", features = ["crossterm"], default-features = false }
 crossterm = "0.25.0"
@@ -20,5 +20,5 @@ eyre = "0.6"
 dirs = "4.0.0"
 simple_file_logger = "0.2.0"
 log = "0.4"
-function_history_backend_thread = { path = "../function_history_backend_thread", version = "0.1.0"}
+function_history_backend_thread = { path = "../function_history_backend_thread", version = "0.2.0"}
 tui-input = "0.5.1"

cargo-function-history/README.md

@@ -2,6 +2,8 @@
 
 # cargo function history
 
+* needs at least 15*15 terminal size
+
 A cargo frontend for the [git function history library](https://crates.io/crates/git-function-history).
 
 ## Installation
@@ -24,9 +26,9 @@ or cargo-function-history `<function-name<:filename>> <options>`
 
 - `--filter-date-range=<date1>:<date2>`: filter to the given date range
 
-- `file-absolute`: search the exact file with the filename specified after the function name
+- `--file-absolute`: search the exact file with the filename specified after the function name
 
-- `file-relative`: search any file ending with the filename specified after the function name
+- `--file-relative`: search any file ending with the filename specified after the function name
 
 ### using the tui
 
@@ -58,6 +60,8 @@ To exit editing mode press `esc`.
 
 If your command is to long to fit on the screen, you can can use the left and right arrow keys to scroll the command pane.
 
+You can also use the up and down arrow keys to scroll through your command history.
+
 Each command starts with one of three command types:
 
 - `search`: search for a function
@@ -134,8 +138,38 @@ Then press enter to execute the command, and after executing the command you wil
 
 #### viewing pane
 
+To navigate the viewing pane you need to be in viewing mode. To enter viewing mode from editing mode press `esc`.
+
+<img src="https://raw.githubusercontent.com/mendelsshop/git_function_history/main/cargo-function-history/resources/screenshots/viewing-pane.png" width="400">
+
+To scroll the file in the viewing pane you can use the the `up` or `k` and `down` or `j` keys.
+
+To move to the next or previous commit you can use the `right` or `l` and `left` or `h` keys.
+
+To move through files in a commit you can use the `shift` + `right` or `l` and `shift` + `left` or `h` keys.
+
+At the top it will show the commit hash, date, and time of the commit.
+With the file name under that.
+
+The file will be shown with the function you searched for with the line numbers.
+
 #### status pane
 
+The status pane is used to display the status of the program.
+
+There are 4 different status types:
+
+- `error`: This status type is used to display errors that occur during the program execution
+
+<img src="https://raw.githubusercontent.com/mendelsshop/git_function_history/main/cargo-function-history/resources/screenshots/status-pane-err.png" width="400">
+
+- `warning`: This status type is used to display warnings that occur during the program execution
+- `ok`: This status type is used to show when a command has been executed successfully
+
+<img src="https://raw.githubusercontent.com/mendelsshop/git_function_history/main/cargo-function-history/resources/screenshots/status-pane-ok.png" width="400">
+
+- `loading`: This status type is used to show when the program is loading
+
 ## Note
 
 When specifying dates please use the RFC 2822 format, e.g. `Mon, 15 Feb 2021 15:04:05 +0000`, please put underscores instead of spaces like `Mon,_15_Feb_2021_15:04:05_+0000`.

cargo-function-history/resources/screenshots/status-pane-err.png

@@ -38,12 +38,12 @@ impl Action {
         match self {
             Action::Quit => &[Key::Ctrl('c'), Key::Char('q')],
             Action::TextEdit => &[Key::Char(':'), Key::Shift(':')],
-            Action::ScrollUp => &[Key::Up],
-            Action::ScrollDown => &[Key::Down],
-            Action::BackCommit => &[Key::Left],
-            Action::ForwardCommit => &[Key::Right],
-            Action::BackFile => &[Key::Shiftleft],
-            Action::ForwardFile => &[Key::Shiftright],
+            Action::ScrollUp => &[Key::Up, Key::Char('k')],
+            Action::ScrollDown => &[Key::Down, Key::Char('j')],
+            Action::BackCommit => &[Key::Left, Key::Char('h')],
+            Action::ForwardCommit => &[Key::Right, Key::Char('l')],
+            Action::BackFile => &[Key::Shiftleft, Key::Char('H'), Key::Shift('h')],
+            Action::ForwardFile => &[Key::Shiftright, Key::Char('L'), Key::Shift('l')],
         }
     }
 }

cargo-function-history/resources/screenshots/status-pane-ok.png

@@ -7,6 +7,7 @@ use function_history_backend_thread::types::{
 };
 use git_function_history::{BlockType, FileType, Filter};
 use std::{sync::mpsc, time::Duration};
+use tui_input::InputRequest;
 pub mod actions;
 pub mod state;
 pub mod ui;
@@ -30,6 +31,8 @@ pub struct App {
         mpsc::Receiver<(CommandResult, Status)>,
     ),
     status: Status,
+    pub history: Vec<String>,
+    pub history_index: usize,
 }
 
 impl App {
@@ -39,6 +42,7 @@ impl App {
             mpsc::Sender<FullCommand>,
             mpsc::Receiver<(CommandResult, Status)>,
         ),
+        status: Status,
     ) -> Self {
         let actions = vec![
             Action::Quit,
@@ -60,7 +64,9 @@ impl App {
             scroll_pos: (0, 0),
             body_height: 0,
             channels,
-            status: Status::Ok(None),
+            status,
+            history: vec![],
+            history_index: 0,
         }
     }
 
@@ -94,7 +100,6 @@ impl App {
                     self.scroll_pos.0 += 1;
                     AppReturn::Continue
                 }
-                // TODO reset other things
                 Action::BackCommit => {
                     if let CommandResult::History(t) = &mut self.cmd_output {
                         t.move_back();
@@ -466,7 +471,13 @@ impl App {
         match self.channels.1.recv_timeout(Duration::from_millis(100)) {
             Ok(timeout) => match timeout {
                 (_, Status::Error(e)) => {
-                    log::info!("error recieved last command didn't work; {}", e);
+                    let e = e.split_once("why").unwrap_or((&e, ""));
+                    let e = format!(
+                        " error recieved last command didn't work; {}{}",
+                        e.0,
+                        e.1.split_once("why").unwrap_or(("", "")).0,
+                    );
+                    log::warn!("{}", e);
                     self.status = Status::Error(e);
                 }
                 (t, Status::Ok(msg)) => {
@@ -484,4 +495,38 @@ impl App {
             },
         }
     }
+    pub fn reset_and_save(&mut self) {
+        let input = self.input_buffer.to_string();
+        if !input.is_empty() {
+            self.history.push(input);
+        }
+        self.input_buffer.reset();
+    }
+
+    pub fn scroll_up(&mut self) {
+        self.history_index = self.history_index.saturating_sub(1);
+        let strs = match self.history.get(self.history_index) {
+            Some(string) => string.as_str(),
+            None => "",
+        };
+        for character in strs.chars() {
+            let req = InputRequest::InsertChar(character);
+            self.input_buffer.handle(req);
+        }
+    }
+
+    pub fn scroll_down(&mut self) {
+        self.history_index = match self.history_index.saturating_add(1) {
+            i if i >= self.history.len() - 1 => self.history.len() - 1,
+            i => i,
+        };
+        let strs = match self.history.get(self.history_index) {
+            Some(string) => string.as_str(),
+            None => "",
+        };
+        for character in strs.chars() {
+            let req = InputRequest::InsertChar(character);
+            self.input_buffer.handle(req);
+        }
+    }
 }

cargo-function-history/resources/screenshots/viewing-pane.png

@@ -19,6 +19,10 @@ where
     B: Backend,
 {
     let size = rect.size();
+    // check if we have enough space to draw
+    if size.width < 10 || size.height < 10 {
+        panic!("Not enough space to draw");
+    }
     let main_window = draw_main();
     let mut whole_chunks = Layout::default()
         .direction(Direction::Vertical)
@@ -94,13 +98,17 @@ fn draw_body<B: Backend>(app: &mut App, mut pos: Rect, frame: &mut Frame<B>) {
         }
         _ => None,
     };
-    let tick_text: Vec<Spans> = app
-        .cmd_output
-        .to_string()
-        .split('\n')
-        .map(|s| Spans::from(format!("{}\n", s)))
-        .collect();
-
+    let tick_text: Vec<Spans> = match &app.cmd_output {
+        CommandResult::None => match app.status {
+            Status::Loading => vec![Spans::from("Loading...")],
+            _ => vec![Spans::from("No output")],
+        },
+        a => a
+            .to_string()
+            .split('\n')
+            .map(|s| Spans::from(format!("{}\n", s)))
+            .collect(),
+    };
     let body = Paragraph::new(tick_text)
         .style(Style::default().fg(Color::LightCyan))
         .scroll(app.scroll_pos)