Merge pull request #108 from plx-pdg/prepare-release-v0.2.0

samuelroland · web-flow · commit 3183de127693 · 2024-09-06T23:22:52.000+02:00
Prepare release v0.2.0
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -13,15 +13,40 @@ Take this line and fix version with current ($CV)
 ### Added
 ### Changed
 
-## [$CV without v!](https://github.com/plx-pdg/plx/compare/$CV...HEAD) - $DATE
+## [$CV without v!](https://github.com/plx-pdg/plx/compare/$CV before...$CV now) - $DATE
 -->
 
-## [Unreleased](https://github.com/plx-pdg/plx/compare/v0.1.2...HEAD)
+## [Unreleased](https://github.com/plx-pdg/plx/compare/v0.2.0...HEAD)
 
 ### Added
 ### Changed
 
-## [0.1.2](https://github.com/plx-pdg/plx/compare/v0.1.2...HEAD) - 2024-08-26
+## [0.2.0](https://github.com/plx-pdg/plx/compare/v0.1.2...v0.2.0) - 2024-09-06
+
+### Added
+- Home page with ASCII art, quick help and tagline
+- Help page to see all shortcuts and alternatives
+- List page to browse skills and exos list
+- Exo preview inside List page to show exo instruction without starting to compile it
+- Train page to do an exo from start to end
+- Automatic reload of checks when saving one of the exo files
+- Open `$EDITOR` (only GUI IDE right now) when opening a new exo
+- Show checks details with a nice word level diff generated by `similar`.
+- Show a Solution page with basic syntax highlighting via `syntect`
+- Support an exo structure with course - skills - exo hierarchy, with metadata described in TOML
+- Enable parsing TOML files directly into Rust structs using `serde` and `toml` crates.
+- Generate a lot of various errors for parsing, process and workers execution. We don't display them yet. When running `plx` in a folder without `course.toml`, the TUI will not start. It only displays skills and exos that were successfully parsed.
+- Create examples exos for manual and automated testings under folder `examples`
+- Switch to next exo when exo is done
+- Start to store exo state (In progress, Done) but this is not fully working, therefore not displayed
+- Create a logo ! Inspired from Delibay and PRJS gradient styles
+- Write logs to `debug.log` via crate `log` and `simplelog` to see events received by core and not make noise in the UI
+
+### Changed
+- Run CI with macos runner, in addition to Ubuntu and Windows
+- Rewrite a concise README in English and include it for `crates.io` release
+
+## [0.1.2](https://github.com/plx-pdg/plx/compare/v0.1.1...v0.1.2) - 2024-08-26
 
 ### Added
 - Trivial change to show CI release
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -5,9 +5,9 @@ homepage = "https://github.com/plx-pdg/plx"
 repository = "https://github.com/plx-pdg/plx"
 license-file = "LICENSE"
 readme = false
-version = "0.1.2"
+version = "0.2.0"
 edition = "2021"
-exclude = ["*.md"]
+exclude = ["examples"]
 
 [dependencies]
 console = "0.15.8"
diff --git a/README.md b/README.md
@@ -11,7 +11,6 @@
 [Git repository of PLX](https://github.com/plx-pdg/plx) -
 [Git repository of this website](https://github.com/plx-pdg/plx-pdg.github.io)
 
-
 ### Introduction
 
 PLX is a project developed to enhance the learning of programming languages, with a focus on a smooth and optimized learning experience. The goal of this project is to reduce the usual friction involved in completing coding exercises (such as manual compilation, running, testing, and result verification) by automating these steps.
@@ -55,7 +54,7 @@ On Linux and MacOS, you can easily change `EDITOR` just for PLX, here is an exam
 EDITOR=code plx
 ```
 
-The useful shortcuts are defined under shortcut `?`, you can mostly type `l`, `j` or `k` to move up and down, until you you reach the exo, then the editor should open and then you can do the exo (or just fill the solution next to it see `.sol.c` file), save and see changes...
+The useful shortcuts are defined under shortcut `?`, `j` or `k` to move up and down, you can mostly type `l`, until you reach the exo, then the editor should open and then you can do the exo (or just fill the solution next to it see `.sol.c` file), save and see changes...
 
 ### Building from source
 
@@ -71,7 +70,29 @@ git clone git@github.com:plx-pdg/plx.git
 cargo build --release
 ```
 
-This will install all necessary dependencies and build the program
+This will install all necessary dependencies and build the program in release mode.
+
+To run it
+```bash
+cargo run
+```
+
+**Install from source**
+```bash
+cargo install --path .
+```
+
+### Running tests
+
+```sh
+cargo test
+```
+
+### Showing Rust code documentation
+You can easily see all our code comments in a nice web page.
+```sh
+cargo doc --open
+```
 
 ### Contributing
 
diff --git a/src/app/app.rs b/src/app/app.rs
@@ -164,7 +164,7 @@ impl App {
     /// Stops the UI
     /// Useful if we want to restart the UI
     ///
-    fn stop_ui(&mut self) {
+    fn _stop_ui(&mut self) {
         if let Ok(mut work_handler) = self.work_handler.lock() {
             work_handler.stop_workers(WorkType::Ui);
         }
diff --git a/src/app/errors.rs b/src/app/errors.rs
@@ -23,13 +23,11 @@ impl fmt::Display for CompilationStartError {
 /// Represents a start exo error
 /// See `App::start_exo`
 pub(super) enum StartExoFail {
-    CouldNotLaunchEditor,
     CouldNotStartCompilation(CompilationStartError),
 }
 impl fmt::Display for StartExoFail {
     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
         match self {
-            StartExoFail::CouldNotLaunchEditor => write!(f, "Error launching editor"),
             StartExoFail::CouldNotStartCompilation(err) => write!(f, "{}", err),
         }
     }
diff --git a/src/app/exo_status_report.rs b/src/app/exo_status_report.rs
@@ -34,7 +34,7 @@ impl ExoStatusReport {
         }
     }
 
-    /// Helper function to get a Vec<CheckState> from check results
+    /// Helper function to get a `Vec<CheckState>` from check results
     /// Useful to send the check states to the Ui
     /// Check `UiState::CheckResults` for more information
     pub(super) fn to_vec_check_state(&self) -> Vec<CheckState> {
diff --git a/src/app/key_press.rs b/src/app/key_press.rs
@@ -17,7 +17,7 @@ impl App {
             Key::L | Key::Enter => self.on_l(), // Currently L and Enter do the same thing
             Key::N => self.on_n(),
             Key::P => self.on_p(),
-            Key::E => {}
+            // Key::E => {}
             Key::Esc => self.on_esc(),
             Key::Interrogation => self.on_interrogation(),
         }
diff --git a/src/core/work/work_handler.rs b/src/core/work/work_handler.rs
@@ -8,8 +8,6 @@ use std::{
     thread::{self, JoinHandle},
 };
 
-use log::info;
-
 use crate::models::event::Event;
 
 use super::{work::Work, work_type::WorkType, worker::Worker};
@@ -20,7 +18,6 @@ pub(crate) enum WorkEvent {
 
 /// Represents all information we have about a specific worker
 struct WorkInfo {
-    id: usize,
     work: WorkType,
     should_stop: Arc<AtomicBool>,
     join_handle: JoinHandle<()>,
@@ -34,14 +31,8 @@ pub struct WorkHandler {
     curr_work_id: usize,
 }
 impl WorkInfo {
-    fn new(
-        id: usize,
-        work: WorkType,
-        should_stop: Arc<AtomicBool>,
-        join_handle: JoinHandle<()>,
-    ) -> Self {
+    fn new(work: WorkType, should_stop: Arc<AtomicBool>, join_handle: JoinHandle<()>) -> Self {
         WorkInfo {
-            id,
             work,
             should_stop,
             join_handle,
@@ -91,7 +82,7 @@ impl WorkHandler {
         );
         let join_handle = worker.run_on_separate_thread();
         self.workers
-            .insert(id, WorkInfo::new(id, work_type, stop, join_handle));
+            .insert(id, WorkInfo::new(work_type, stop, join_handle));
         id
     }
 
diff --git a/src/models/key.rs b/src/models/key.rs
@@ -10,7 +10,7 @@ pub enum Key {
     L,
     N,
     P,
-    E,
+    // E,
     Enter,
     Esc,
     Interrogation,
@@ -28,7 +28,7 @@ impl Key {
             Key::L => "Move right",
             Key::N => "Next block",
             Key::P => "Previous block",
-            Key::E => "Edit exercise",
+            // Key::E => "Edit exo",
             Key::Enter => "Enter to continue",
             Key::Esc => "Go back",
             Key::Interrogation => "View help",
diff --git a/src/ui/pages/list.rs b/src/ui/pages/list.rs
@@ -1,11 +1,7 @@
 use crate::models::exo::Exo;
-use crate::models::exo_state::ExoState;
 use crate::models::skill::Skill;
 use crate::ui::pages::train::render_exo;
-use crate::ui::utils::{
-    get_gradient_line, popup_area, render_header, EXO_DONE_COLOR, EXO_INPROGRESS_COLOR, LOGO_LEFT,
-    LOGO_RIGHT,
-};
+use crate::ui::utils::{popup_area, render_header};
 use ratatui::style::Stylize;
 use ratatui::widgets::{Clear, Wrap};
 use ratatui::{
diff --git a/src/ui/pages/solution.rs b/src/ui/pages/solution.rs
@@ -1,11 +1,11 @@
 use crate::models::exo::Exo;
-use crate::ui::utils::{get_gradient_line, render_header, LOGO_LEFT, LOGO_RIGHT};
+use crate::ui::utils::render_header;
 use ratatui::prelude::Span;
 use ratatui::{
-    layout::{Constraint, Direction, Layout, Rect},
-    style::{Color, Modifier, Style},
-    text::{Line, Text},
-    widgets::{Block, Borders, List, ListItem, ListState, Paragraph},
+    layout::{Constraint, Direction, Layout},
+    style::{Color, Style},
+    text::Line,
+    widgets::{Block, Borders, Paragraph},
     Frame,
 };
 use std::path::PathBuf;
@@ -17,10 +17,10 @@ use syntect::util::LinesWithEndings;
 
 pub fn render_solution(
     frame: &mut Frame,
-    exo: &Arc<Exo>,
+    _exo: &Arc<Exo>,
     solution: &String,
-    solution_path: &PathBuf,
-    solution_idx: &usize,
+    _solution_path: &PathBuf,
+    _solution_idx: &usize,
 ) {
     let binding = Layout::default()
         .direction(Direction::Vertical)
diff --git a/src/ui/pages/train.rs b/src/ui/pages/train.rs
@@ -23,7 +23,7 @@ pub fn render_compilation(frame: &mut Frame, exo: &Arc<Exo>) {
     render_train(frame, exo, bottom);
 }
 
-/// Push lines with the given string taking \n as splitter, or push a "<empty>" dim line when empty
+/// Push lines with the given string taking \n as splitter, or push a `<empty>` dim line when empty
 /// We can define a prefix in front of the line
 pub fn push_each_line_or_empty_info(lines: &mut Vec<Line>, prefix: String, text: String) {
     let mut prefix = Line::from(prefix);
@@ -96,7 +96,7 @@ pub fn render_compilation_error(
 pub fn render_check_results(
     frame: &mut Frame,
     exo: &Arc<Exo>,
-    scroll_offset: &usize, //TODO: support scroll_offset
+    _scroll_offset: &usize, //TODO: support scroll_offset
     checks: &Vec<CheckState>,
 ) {
     // Show the Check results title
diff --git a/src/ui/ui.rs b/src/ui/ui.rs
@@ -73,7 +73,7 @@ impl Ui {
                 exo_index,
                 skills,
                 exos,
-                exo, //TODO: we access exo via exos[exo_index] so maybe we should remove this from the case ?
+                ..
             } => list::render_preview(frame, skills, exos, skill_index, *exo_index),
             UiState::Compiling { exo } => train::render_compilation(frame, &exo),
             UiState::CompileError {
@@ -87,15 +87,13 @@ impl Ui {
                 checks,
             } => train::render_check_results(frame, exo, scroll_offset, checks),
             UiState::ShowSolution {
-                scroll_offset,
                 exo,
                 solution,
                 solution_path,
                 solution_idx,
+                ..
             } => solution::render_solution(frame, exo, solution, solution_path, solution_idx),
             UiState::Quit => return,
-            //TODO all other pages
-            _ => {}
         }
     }
 
diff --git a/src/ui/utils.rs b/src/ui/utils.rs
@@ -25,10 +25,11 @@ pub const ASCII_LOGO: &str = r#"
 pub const SLOGAN: &str = "Practice programming exos in a delightful Learning eXperience";
 pub const LOGO_LEFT: (u8, u8, u8) = (252, 17, 0); // #fc1100 in RGB => 252, 17, 0
 pub const LOGO_RIGHT: (u8, u8, u8) = (255, 176, 0); // #ffb000 in RGB => 255, 176, 0
-pub const LOGO_LEFT_RGB: Color = Color::Rgb(LOGO_LEFT.0, LOGO_LEFT.1, LOGO_LEFT.2);
+
+//pub const LOGO_LEFT_RGB: Color = Color::Rgb(LOGO_LEFT.0, LOGO_LEFT.1, LOGO_LEFT.2);
 pub const LOGO_RIGHT_RGB: Color = Color::Rgb(LOGO_RIGHT.0, LOGO_RIGHT.1, LOGO_RIGHT.2);
-pub const EXO_INPROGRESS_COLOR: Color = Color::Rgb(254, 129, 0); // #fe8100
-pub const EXO_DONE_COLOR: Color = Color::Green;
+//pub const EXO_INPROGRESS_COLOR: Color = Color::Rgb(254, 129, 0); // #fe8100
+//pub const EXO_DONE_COLOR: Color = Color::Green;
 
 // FUNCTIONS
 

Original file line number	Diff line number	Diff line change
`@@ -164,7 +164,7 @@ impl App {`
`164`	`164`	`/// Stops the UI`
`165`	`165`	`/// Useful if we want to restart the UI`
`166`	`166`	`///`
`167`		`- fn stop_ui(&mut self) {`
	`167`	`+ fn _stop_ui(&mut self) {`
`168`	`168`	`if let Ok(mut work_handler) = self.work_handler.lock() {`
`169`	`169`	`work_handler.stop_workers(WorkType::Ui);`
`170`	`170`	`}`
Original file line number	Diff line number	Diff line change
`@@ -23,13 +23,11 @@ impl fmt::Display for CompilationStartError {`
`23`	`23`	`/// Represents a start exo error`
`24`	`24`	/// See `App::start_exo`
`25`	`25`	`pub(super) enum StartExoFail {`
`26`		`- CouldNotLaunchEditor,`
`27`	`26`	`CouldNotStartCompilation(CompilationStartError),`
`28`	`27`	`}`
`29`	`28`	`impl fmt::Display for StartExoFail {`
`30`	`29`	`fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {`
`31`	`30`	`match self {`
`32`		`- StartExoFail::CouldNotLaunchEditor => write!(f, "Error launching editor"),`
`33`	`31`	`StartExoFail::CouldNotStartCompilation(err) => write!(f, "{}", err),`
`34`	`32`	`}`
`35`	`33`	`}`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ impl ExoStatusReport {`
`34`	`34`	`}`
`35`	`35`	`}`
`36`	`36`
`37`		`- /// Helper function to get a Vec<CheckState> from check results`
	`37`	+ /// Helper function to get a `Vec<CheckState>` from check results
`38`	`38`	`/// Useful to send the check states to the Ui`
`39`	`39`	/// Check `UiState::CheckResults` for more information
`40`	`40`	`pub(super) fn to_vec_check_state(&self) -> Vec<CheckState> {`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ impl App {`
`17`	`17`	`Key::L \| Key::Enter => self.on_l(), // Currently L and Enter do the same thing`
`18`	`18`	`Key::N => self.on_n(),`
`19`	`19`	`Key::P => self.on_p(),`
`20`		`- Key::E => {}`
	`20`	`+ // Key::E => {}`
`21`	`21`	`Key::Esc => self.on_esc(),`
`22`	`22`	`Key::Interrogation => self.on_interrogation(),`
`23`	`23`	`}`