1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446
//! # Grammalecte Rust Client
//!
//! This crate is a Rust client to the Grammalecte server API.
//!
//! Grammalecte is an Open Source software that allows to do
//! french spell-checking.
//!
//! ## Integrated server
//! The optional feature `embedded-server` allows you to spin up an
//! temporary web server that will act as Grammalecte backend, instead
//! of targetting an existing instance:
//!
//! ```rust,ignore
//! use grammalecte_client::GrammalecteClient;
//!
//! let msg = "Les ange sont inssuportables!";
//! let res = GrammalecteClient::start_server()
//! .unwrap()
//! .spell_check(msg)
//! .await
//! .unwrap();
//! println!("RESULT = {:#?}", res);
//! ```
//!
//! ## Suggestion
//! You can also ask Grammalecte to give you valid alternatives words:
//! ```rust,ignore
//! use grammalecte_client::GrammalecteClient;
//!
//! let res = GrammalecteClient::start_server()
//! .unwrap()
//! .suggest("bonjou")
//! .await
//! .unwrap();
//! assert!(res.suggestions.contains(&"bonjour".to_string()));
//! println!("RESULT = {:#?}", res);
//! ```
#[cfg(feature = "embedded-server")]
use crate::server::EmbeddedServer;
use std::collections::HashMap;
use std::error::Error;
#[cfg(feature = "embedded-server")]
pub mod server;
/// Spell check options
#[derive(Hash, Debug, Eq, PartialEq)]
pub enum GramOpt {
/// Signes typographiques
SignesTypographiques,
/// Apostrophes typographiques
///
/// Correction des apostrophes droites. Automatisme possible dans le menu Outils > Options d’autocorrection > Options linguistiques > Guillemets simples > Remplacer (à cocher)
ApostropheTypographique,
/// Ecriture épicène
///
/// Normalisation de l’écriture épicène avec points médians.
EcritureEpicene,
/// Espaces surnuméraires
///
/// Signale les espaces inutiles entre les mots, en début et en fin de ligne.
EspacesSurnumeraires,
/// Tabulations surnuméraires
///
/// Signale les tabulations inutiles en début et en fin de ligne.
TabulationsSurnumeraires,
/// Espaces insécables
///
/// Vérifie les espaces insécables avec les ponctuations « ! ? : ; » (à désactiver si vous utilisez une police Graphite)
EspacesInsecables,
/// Majuscules
///
/// Vérifie l’utilisation des majuscules et des minuscules (par exemple, « la raison d’État », « les Européens »).
Majuscules,
/// Majuscules pour ministères
///
/// Majuscules pour les intitulés des ministères.
MajusuculesMinisteres,
/// Virgules
///
/// Vérifie s’il manque une ponctuation finale au paragraphe (seulement pour les paragraphes constitués de plusieurs phrases).
Virgules,
/// Ponctuation finale [!]
///
/// Vérifie s’il manque une ponctuation finale au paragraphe (seulement pour les paragraphes constitués de plusieurs phrases).
PonctuationFinale,
/// Traits d’union et soudures
///
/// Cherche les traits d’union manquants ou inutiles.
TraitsUnionEtSoudures,
/// Nombres
///
/// Espaces insécables avant unités de mesure
Nombres,
/// Espaces insécables avant unités de mesure
EspaceInsecableAvantUniteDeMesure,
/// Normes françaises
NormesFrancaises,
/// Signaler ligatures typographiques
///
/// Ligatures de fi, fl, ff, ffi, ffl, ft, st.
LigaturesTypographiques,
/// Apostrophe manquante après lettres isolées [!]
///
/// Apostrophe manquante après les lettres l d s n c j m t ç. Cette option sert surtout à repérer les défauts de numérisation des textes et est déconseillée pour les textes scientifiques.
ApostropheManquanteApresLettreIsolee,
/// Chimie
///
/// Typographie des composés chimiques (H₂O, CO₂, etc.).
Chimie,
/// Erreurs de numérisation (OCR)
///
/// Erreurs de reconnaissance optique des caractères. Beaucoup de faux positifs.
ErreurNumerisation,
/// Noms et adjectifs
Gramm,
/// Confusions et faux-amis
///
/// Cherche des erreurs souvent dues à l’homonymie (par exemple, les confusions entre « faîte » et « faite »).
ConfusionFauxAmis,
/// Locutions
///
/// Écriture des locutions usuelles.
Locutions,
/// Accords (genre et nombre)
///
/// Accords des noms et des adjectifs.
AccordsGenreEtNombre,
/// Verbes
Verbes,
/// Conjugaisons
///
/// Accord des verbes avec leur sujet.
Conjugaisons,
/// Infinitif
///
/// Confusion entre l’infinitif et d’autres formes.
Infinitif,
/// Impératif
///
/// Vérifie notamment la deuxième personne du singulier (par exemple, les erreurs : « vas… », « prend… », « manges… »).
Imperatif,
/// Interrogatif
///
/// Vérifie les formes interrogatives et suggère de lier les pronoms personnels avec les verbes.
Interrogatif,
/// Participes passés, adjectifs
ParticipePassesEtAdjectifs,
/// Modes verbaux
ModesVerbaux,
/// Style
Style,
/// Populaire
///
/// Souligne un langage courant considéré comme erroné, comme « malgré que ».
Populaire,
/// Pléonasmes
///
/// Repère des redondances sémantiques, comme « au jour d’aujourd’hui », « monter en haut », etc.
Pleonasmes,
/// Élisions et euphonies
///
/// Signale les élisions incorrectes et les tournures dysphoniques.
ElisisonsEtEuphonies,
/// Adverge de négation [!}
///
/// Ne … pas, ne … jamais, etc.
AdverbesNegation,
/// Répétitions dans le paragraphe [!]
///
/// Sont exclus les mots grammaticaux, ceux commençant par une majuscule, ainsi que “être” et “avoir”.
RepetitionsDansParagraphe,
/// Répétitions dans la phrase [!]
///
/// Sont exclus les mots grammaticaux, ainsi que “être” et “avoir”.
RepetitionDansPhrase,
/// Divers
Misc,
/// Mots composés [!]
MotsComposes,
/// Validation des dates
Date,
/// Debugagge
Debug,
/// Affiche l’identifiant de la règle de contrôle dans les messages d’erreur.
IdControlRule,
}
impl GramOpt {
/// Get the technical ID of the Grammalecte option
pub fn id(&self) -> &'static str {
match self {
GramOpt::SignesTypographiques => "typo",
GramOpt::ApostropheTypographique => "apos",
GramOpt::EcritureEpicene => "eepi",
GramOpt::EspacesSurnumeraires => "esp",
GramOpt::TabulationsSurnumeraires => "tab",
GramOpt::EspacesInsecables => "nbsp",
GramOpt::Majuscules => "maj",
GramOpt::MajusuculesMinisteres => "minis",
GramOpt::Virgules => "virg",
GramOpt::PonctuationFinale => "poncfin",
GramOpt::TraitsUnionEtSoudures => "tu",
GramOpt::Nombres => "num",
GramOpt::EspaceInsecableAvantUniteDeMesure => "unit",
GramOpt::NormesFrancaises => "nf",
GramOpt::LigaturesTypographiques => "liga",
GramOpt::ApostropheManquanteApresLettreIsolee => "mapos",
GramOpt::Chimie => "chim",
GramOpt::ErreurNumerisation => "ocr",
GramOpt::Gramm => "gramm",
GramOpt::ConfusionFauxAmis => "conf",
GramOpt::Locutions => "loc",
GramOpt::AccordsGenreEtNombre => "gn",
GramOpt::Verbes => "verbs",
GramOpt::Conjugaisons => "conj",
GramOpt::Infinitif => "infi",
GramOpt::Imperatif => "imp",
GramOpt::Interrogatif => "inte",
GramOpt::ParticipePassesEtAdjectifs => "ppas",
GramOpt::ModesVerbaux => "vmode",
GramOpt::Style => "style",
GramOpt::Populaire => "bs",
GramOpt::Pleonasmes => "pleo",
GramOpt::ElisisonsEtEuphonies => "eleu",
GramOpt::AdverbesNegation => "neg",
GramOpt::RepetitionsDansParagraphe => "redon1",
GramOpt::RepetitionDansPhrase => "redon2",
GramOpt::Misc => "misc",
GramOpt::MotsComposes => "mc",
GramOpt::Date => "date",
GramOpt::Debug => "debug",
GramOpt::IdControlRule => "idrule",
}
}
}
/// Check spelling result
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct CheckResult {
pub program: String,
pub version: String,
pub lang: String,
pub error: String,
#[serde(rename = "data")]
pub paragraphs: Vec<Paragraph>,
}
/// Check spell result of a given paragraph
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct Paragraph {
#[serde(rename = "iParagraph")]
pub num: usize,
#[serde(rename = "lGrammarErrors")]
pub grammars: Vec<GrammarError>,
#[serde(rename = "lSpellingErrors")]
pub spelling: Vec<SpellingError>,
}
/// Single grammar error
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct GrammarError {
#[serde(rename = "nStart")]
pub offset_start: usize,
#[serde(rename = "nEnd")]
pub offset_end: usize,
#[serde(rename = "sLineId")]
pub rule_line_id: String,
#[serde(rename = "sRuleId")]
pub rule_id: String,
#[serde(rename = "sType")]
pub rule_type: String,
#[serde(rename = "aColor")]
pub rule_underline_color: Option<Vec<u8>>,
#[serde(rename = "sMessage")]
pub message: String,
#[serde(rename = "aSuggestions")]
pub suggestions: Vec<String>,
#[serde(rename = "URL")]
pub url: String,
}
/// Spelling error information
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct SpellingError {
pub i: usize,
#[serde(rename = "nStart")]
pub offset_start: usize,
#[serde(rename = "nEnd")]
pub offset_end: usize,
#[serde(rename = "sValue")]
pub bad_word: String,
#[serde(rename = "sType")]
pub error_type: String,
}
/// Response to a suggestion request
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct SuggestResult {
/// Suggestions returned by Grammalecte
pub suggestions: Vec<String>,
}
/// The Grammalecte client itself
pub struct GrammalecteClient {
base_url: String,
#[cfg(feature = "embedded-server")]
_server: Option<EmbeddedServer>,
}
impl Default for GrammalecteClient {
fn default() -> Self {
Self {
base_url: "http://localhost:8080".to_string(),
#[cfg(feature = "embedded-server")]
_server: None,
}
}
}
impl GrammalecteClient {
/// Construct a new Grammalecte client, with a custom server URL
pub fn new(base_url: &str) -> Self {
Self {
base_url: base_url.to_string(),
#[cfg(feature = "embedded-server")]
_server: None,
}
}
/// Construct a new Grammalecte client, spinning up an associated
/// temporary web server.
///
/// Python 3.7 or higher must is required at runtime
#[cfg(feature = "embedded-server")]
pub fn start_server() -> Result<Self, Box<dyn Error>> {
let server = EmbeddedServer::start()?;
Ok(Self {
base_url: server.base_url(),
_server: Some(server),
})
}
/// Run spell check on text
pub async fn spell_check(&self, text: &str) -> Result<CheckResult, Box<dyn Error>> {
self.spell_check_with_options(text, &HashMap::new()).await
}
/// Run spell check with custom options
pub async fn spell_check_with_options(
&self,
text: &str,
options: &HashMap<GramOpt, bool>,
) -> Result<CheckResult, Box<dyn Error>> {
let url = format!("{}/gc_text/fr", self.base_url);
log::debug!("Will use URL {} for spell check", url);
let options = options
.iter()
.map(|t| (t.0.id(), t.1))
.collect::<HashMap<_, _>>();
let options = serde_json::to_string(&options)?;
let mut params = HashMap::new();
params.insert("text", text);
params.insert("options", &options);
let result = reqwest::Client::new()
.post(url)
.form(¶ms)
.send()
.await?
.json::<CheckResult>()
.await?;
Ok(result)
}
/// Ask for word suggestion
pub async fn suggest(&self, token: &str) -> Result<SuggestResult, Box<dyn Error>> {
let url = format!("{}/suggest/fr", self.base_url);
log::debug!("Will use URL {} for word suggestion", url);
let mut params = HashMap::new();
params.insert("token", token);
Ok(reqwest::Client::new()
.post(&url)
.form(¶ms)
.send()
.await?
.json()
.await?)
}
}
#[cfg(test)]
#[cfg(feature = "embedded-server")]
mod test {
use crate::{GramOpt, GrammalecteClient};
use std::collections::HashMap;
#[tokio::test]
async fn simple_correction() {
let _ = env_logger::builder().is_test(true).try_init();
let msg = "Les ange sont inssuportables!";
let res = GrammalecteClient::start_server()
.unwrap()
.spell_check(msg)
.await
.unwrap();
println!("RESULT = {:#?}", res);
}
#[tokio::test]
async fn customize_options() {
let _ = env_logger::builder().is_test(true).try_init();
let msg = "Bonjour !";
let mut opts = HashMap::new();
opts.insert(GramOpt::EspacesInsecables, false);
let res = GrammalecteClient::start_server()
.unwrap()
.spell_check_with_options(msg, &opts)
.await
.unwrap();
println!("RESULT = {:#?}", res);
assert!(res.paragraphs.is_empty());
}
#[tokio::test]
async fn simple_suggestion() {
let _ = env_logger::builder().is_test(true).try_init();
let res = GrammalecteClient::start_server()
.unwrap()
.suggest("bonjou")
.await
.unwrap();
assert!(res.suggestions.contains(&"bonjour".to_string()));
println!("RESULT = {:#?}", res);
}
}