Fixes to support external applications (#340)

- Add implementations of `Send` and `Sync` to trane.
- Add a `get_unit_score` to allow querying the final score of a unit.

Author: martinmr

Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "trane"
-version = "0.23.0"
-edition = "2021"
+version = "0.23.1"
+edition = "2024"
 description = "An automated system for learning complex skills"
 license = "AGPL-3.0"
 readme = "README.md"
@@ -18,7 +18,6 @@ fs_extra = "1.3.0"
 git2 = "0.20.0"
 hex = "0.4.3"
 indoc = "2.0.5"
-lazy_static = "1.5.0"
 mantra-miner = "0.1.1"
 parking_lot = { version = "0.12.3", features = ["hardware-lock-elision"] }
 r2d2 = "0.8.10"

src/blacklist.rs

@@ -12,7 +12,7 @@ use parking_lot::RwLock;
 use r2d2::Pool;
 use r2d2_sqlite::SqliteConnectionManager;
 use rusqlite::params;
-use rusqlite_migration::{Migrations, M};
+use rusqlite_migration::{M, Migrations};
 use ustr::{Ustr, UstrMap};
 
 use crate::{db_utils, error::BlacklistError};

src/course_builder.rs

@@ -11,10 +11,10 @@ pub mod knowledge_base_builder;
 #[cfg_attr(coverage, coverage(off))]
 pub mod music;
 
-use anyhow::{ensure, Context, Result};
+use anyhow::{Context, Result, ensure};
 use serde::{Deserialize, Serialize};
 use std::{
-    fs::{create_dir_all, File},
+    fs::{File, create_dir_all},
     io::Write,
     path::{Path, PathBuf},
 };

src/course_builder/knowledge_base_builder.rs

@@ -4,11 +4,11 @@
 //! hand. This module contains utilities to make it easier to generate these files, specially for
 //! testing purposes.
 
-use anyhow::{ensure, Context, Result};
+use anyhow::{Context, Result, ensure};
 use serde::{Deserialize, Serialize};
 use std::{
     collections::{BTreeMap, HashSet},
-    fs::{self, create_dir_all, File},
+    fs::{self, File, create_dir_all},
     io::Write,
     path::{Path, PathBuf},
 };
@@ -17,7 +17,7 @@ use ustr::Ustr;
 use crate::{
     course_builder::AssetBuilder,
     course_library::COURSE_MANIFEST_FILENAME,
-    data::{course_generator::knowledge_base::*, CourseManifest},
+    data::{CourseManifest, course_generator::knowledge_base::*},
 };
 
 /// A builder to generate a knowledge base exercise and associated assets.
@@ -415,7 +415,7 @@ mod test {
 
     use crate::{
         course_builder::knowledge_base_builder::*,
-        data::{course_generator::knowledge_base::KnowledgeBaseFile, ExerciseType},
+        data::{ExerciseType, course_generator::knowledge_base::KnowledgeBaseFile},
     };
 
     /// Creates a test lesson builder.

src/course_builder/music/circle_fifths.rs

@@ -11,7 +11,7 @@ use anyhow::Result;
 
 use crate::{
     course_builder::{AssetBuilder, CourseBuilder, LessonBuilder},
-    data::{music::notes::*, CourseManifest, LessonManifestBuilder},
+    data::{CourseManifest, LessonManifestBuilder, music::notes::*},
 };
 
 /// Generates a course builder that contains a lesson per key and which follows the circle of

src/course_library.rs

@@ -4,7 +4,7 @@
 //! courses that the student wishes to practice together. Courses, lessons, and exercises are
 //! defined by their manifest files (see [data](crate::data)).
 
-use anyhow::{anyhow, ensure, Context, Result};
+use anyhow::{Context, Result, anyhow, ensure};
 use parking_lot::RwLock;
 use serde::de::DeserializeOwned;
 use std::{
@@ -15,11 +15,11 @@ use std::{
     sync::Arc,
 };
 use tantivy::{
+    Index, IndexReader, IndexWriter, ReloadPolicy, TantivyDocument,
     collector::TopDocs,
     doc,
     query::QueryParser,
-    schema::{Field, Schema, Value, STORED, TEXT},
-    Index, IndexReader, IndexWriter, ReloadPolicy, TantivyDocument,
+    schema::{Field, STORED, Schema, TEXT, Value},
 };
 use ustr::{Ustr, UstrMap, UstrSet};
 use walkdir::WalkDir;

src/data.rs

@@ -7,7 +7,7 @@ pub mod filter;
 #[cfg_attr(coverage, coverage(off))]
 pub mod music;
 
-use anyhow::{bail, Result};
+use anyhow::{Result, bail};
 use derive_builder::Builder;
 use serde::{Deserialize, Serialize};
 use std::{collections::BTreeMap, path::Path};

src/data/course_generator/knowledge_base.rs

@@ -1,11 +1,11 @@
 //! Contains the logic to generate a Trane course based on a knowledge base of markdown files
 //! representing the front and back of flashcard exercises.
 
-use anyhow::{anyhow, Context, Error, Result};
-use serde::{de::DeserializeOwned, Deserialize, Serialize};
+use anyhow::{Context, Error, Result, anyhow};
+use serde::{Deserialize, Serialize, de::DeserializeOwned};
 use std::{
     collections::{BTreeMap, HashMap, HashSet},
-    fs::{read_dir, File},
+    fs::{File, read_dir},
     io::BufReader,
     path::Path,
 };

src/data/course_generator/literacy.rs

@@ -5,14 +5,15 @@
 //! how many they get right. Optionally, a dictation lesson can be generated where the student is
 //! asked to write the examples and exceptions based on the tutor's dictation.
 
-use anyhow::{anyhow, Context, Error, Result};
-use serde::{de::DeserializeOwned, Deserialize, Serialize};
+use anyhow::{Context, Error, Result, anyhow};
+use serde::{Deserialize, Serialize, de::DeserializeOwned};
 use std::{
     collections::BTreeMap,
-    fs::{read_dir, File},
+    fs::{File, read_dir},
     io::{BufReader, Read},
     path::Path,
 };
+use strum::Display;
 use ts_rs::TS;
 use ustr::{Ustr, UstrMap, UstrSet};
 
@@ -152,7 +153,7 @@ impl TryFrom<&str> for LiteracyFile {
 }
 
 /// The types of literacy lessons that can be generated.
-#[derive(Clone, Debug, Deserialize, PartialEq, Serialize, TS)]
+#[derive(Clone, Debug, Deserialize, Display, PartialEq, Serialize, TS)]
 #[ts(export)]
 pub enum LiteracyLessonType {
     /// A lesson that takes examples and exceptions and asks the student to read them.
@@ -544,9 +545,9 @@ mod test {
     use ustr::{Ustr, UstrSet};
 
     use crate::data::{
-        course_generator::literacy::{LiteracyConfig, LiteracyLesson, LiteracyLessonType},
         BasicAsset, CourseGenerator, CourseManifest, ExerciseAsset, ExerciseManifest, ExerciseType,
         GenerateManifests, GeneratedCourse, LessonManifest, UserPreferences,
+        course_generator::literacy::{LiteracyConfig, LiteracyLesson, LiteracyLessonType},
     };
 
     /// Verifies that lesson IDs are generated correctly.

src/data/course_generator/transcription.rs

@@ -7,7 +7,7 @@
 
 pub mod constants;
 
-use anyhow::{anyhow, bail, Context, Result};
+use anyhow::{Context, Result, anyhow, bail};
 use indoc::formatdoc;
 use serde::{Deserialize, Serialize};
 use std::{