feat: improve installation process

Remove the need for an installation script, typy can now just be
installed using cargo (as is idiomatic for Rust projects).

Typy will now download the requested language package at run time, if it
is not already present.

Author: CardboardTurkey

Cargo.lock

@@ -16,3 +16,4 @@ lazy_static = "1.5.0"
 anyhow = "1.0.95"
 chrono = { version = "0.4", features = ["serde"] }
 comfy-table = "7.1.4"
+reqwest = { version = "0.12.12", features = ["blocking"] }

Cargo.toml

@@ -27,14 +27,14 @@ word and asks you to type it as fast as possible. The game tracks your typing sp
 different game modes, such as uppercase and punctuation, to help you improve your typing skills in different areas.
 
 ## Installation
-To install Typy on Linux, you can use the following command:
+To install Typy, you can use the [Cargo] package manager:
+
+[Cargo]: https://doc.rust-lang.org/cargo/
 
 ```bash
-curl -sSL https://raw.githubusercontent.com/Pazl27/typy-cli/master/scripts/install.sh | bash
+cargo install --git "https://github.com/Pazl27/typy-cli.git" --tag "v0.8.0"
 ```
 
-This command downloads and runs the installation script from the Typy GitHub repository. The script will handle the installation process for you, ensuring that Typy is set up correctly on your system.
-
 If you prefer to get the newest version and compile it yourself, follow these steps:
 
 1. Clone the Typy repository:
@@ -144,5 +144,5 @@ If you want to provide a new language to the Typy repository, feel free to creat
 
 ## Uninstall
 ```bash
-curl -sSL https://raw.githubusercontent.com/Pazl27/typy-cli/master/scripts/uninstall.sh | bash
+cargo uninstall typy-cli
 ```

README.md

@@ -67,9 +67,9 @@ pub fn run(mode: Mode, theme: ThemeColors) -> Result<()> {
     let mut stdout = stdout();
 
     let language = language::Language::new();
-    let file_name = format!(".local/share/typy/{}.txt", language.lang);
-    let mut game =
-        Game::new(word_provider::get_words(&file_name).context("Failed to get words from file")?);
+    let mut game = Game::new(
+        word_provider::get_words(&language.lang).context("Failed to get words from file")?,
+    );
 
     mode.transform(&mut game.list);
 

scripts/install.sh

@@ -1,26 +1,48 @@
-use anyhow::Result;
+use anyhow::{bail, Context, Result};
 use dirs::home_dir;
+use reqwest::blocking::get;
 use std::{
-    fs::File,
+    fs::{create_dir_all, write, File},
     io::{BufRead, BufReader},
     path::PathBuf,
+    sync::LazyLock,
 };
 
 use rand::seq::IndexedRandom;
 
-pub fn find(lenght: i32, res: &str) -> Result<Vec<String>, std::io::Error> {
-    let path = if res.contains("resources") {
-        PathBuf::from(res)
+static WORDS_DIR: LazyLock<Option<PathBuf>> = LazyLock::new(|| {
+    if cfg!(test) {
+        Some(PathBuf::from("./resources/"))
     } else {
-        let mut home_path = home_dir().ok_or(std::io::Error::new(
-            std::io::ErrorKind::NotFound,
-            "Home directory not found",
-        ))?;
-        home_path.push(res);
-        home_path
+        home_dir().map(|p| p.join(".local/share/typy"))
+    }
+});
+const WORDS_URL: &str =
+    "https://raw.githubusercontent.com/Pazl27/typy-cli/refs/heads/master/resources/";
+
+pub fn find(language: &str, lenght: i32) -> Result<Vec<String>> {
+    let Some(words_file) = WORDS_DIR
+        .as_ref()
+        .map(|p| p.join(format!("{language}.txt")))
+    else {
+        bail!("Unable to find home directory");
     };
 
-    let words = read_file(path.to_str().unwrap())?;
+    // Download words file if not already present
+    if !words_file.exists() {
+        create_dir_all(words_file.parent().unwrap())?;
+        let language_url = format!("{WORDS_URL}{language}.txt");
+        let resp = get(&language_url)
+            .context("Failed to download words file from ".to_owned() + &language_url)?;
+        write(
+            &words_file,
+            resp.text()
+                .context("Failed to extract text from words file download")?,
+        )
+        .with_context(|| format!("Failed to save words file to {words_file:#?}"))?;
+    }
+
+    let words = read_file(words_file.to_str().unwrap())?;
     let mut word = random_word(&words);
 
     let mut fitted_words = Vec::new();

scripts/uninstall.sh

@@ -5,10 +5,10 @@ use finder::find;
 
 const LENGTH: i32 = 70;
 
-pub fn get_words(res: &str) -> Result<Vec<Vec<String>>> {
+pub fn get_words(language: &str) -> Result<Vec<Vec<String>>> {
     let mut words = Vec::new();
     for _ in 0..3 {
-        words.push(find(LENGTH, res)?);
+        words.push(find(language, LENGTH)?);
     }
     Ok(words)
 }
@@ -19,7 +19,7 @@ mod word_provider_tests {
 
     #[test]
     fn test_get_words() {
-        let words = get_words("resources/english.txt");
+        let words = get_words("english");
 
         for word in &words.unwrap() {
             let mut length = 0;