Merge pull request #35 from sancane/issues

Issues

.github/workflows/rust.yml

@@ -25,22 +25,22 @@ jobs:
     - name: Run tests
       run: cargo test --verbose
 
-  cargo_check:
-
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v2
-    - name: Install cargo-sort
-      run: cargo install --locked cargo-sort
-    - run: cargo sort -w -c
-
-  spellcheck:
-
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v2
-    - name: Install cargo-spellcheck
-      run: cargo install --locked cargo-spellcheck
-    - run: cargo spellcheck -m 99 --cfg=.github/workflows/spellchecker.cfg
+#  cargo_check:
+#
+#    runs-on: ubuntu-latest
+#
+#    steps:
+#    - uses: actions/checkout@v2
+#    - name: Install cargo-sort
+#      run: cargo install --locked cargo-sort
+#    - run: cargo sort -w -c
+
+#  spellcheck:
+
+#    runs-on: ubuntu-latest
+
+#    steps:
+#    - uses: actions/checkout@v2
+#    - name: Install cargo-spellcheck
+#      run: cargo install --locked cargo-spellcheck
+#    - run: cargo spellcheck -m 99 --cfg=.github/workflows/spellchecker.cfg

Cargo.toml

@@ -5,3 +5,13 @@ members = [
 	"precis-profiles",
 	"precis-tools",
 ]
+
+[workspace.dependencies]
+lazy_static = "1.4.0"
+precis-core = { path = "precis-core" }
+precis-profiles = { path = "precis-profiles" }
+precis-tools = { path = "precis-tools" }
+regex = "1"
+reqwest = { version = "0.11.4", features = ["blocking"] }
+ucd-parse = "0.1.8"
+unicode-normalization = "0.1.19"

precis-core/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "precis-core"
-version = "0.1.8"
+version = "0.1.9"
 authors = ["Santiago Carot-Nemesio <sancane@gmail.com>"]
 description = """
 PRECIS Framework: Preparation, Enforcement, and Comparison of
@@ -17,15 +17,15 @@ categories = ["text-processing", "internationalization"]
 edition = "2018"
 
 [dev-dependencies]
-precis-tools = { path = "../precis-tools", version = "0.1.6" }
-ucd-parse = "0.1.8"
+precis-tools.workspace = true
+ucd-parse.workspace = true
 
 [build-dependencies]
-precis-tools = { path = "../precis-tools", version = "0.1.6" }
-ucd-parse = "0.1.8"
+precis-tools.workspace = true
+ucd-parse.workspace = true
 
 [dependencies]
-unicode-normalization = "0.1.19"
+unicode-normalization.workspace = true
 
 [features]
 networking = ["precis-tools/networking"]

precis-core/build.rs

@@ -149,7 +149,7 @@ mod networking {
 
     fn create_dir(path: &Path) {
         if !path.is_dir() {
-            fs::create_dir(&path).unwrap();
+            fs::create_dir(path).unwrap();
         }
     }
 
@@ -210,8 +210,8 @@ fn main() {
     let out_path = Path::new(&out_dir);
     let ucd_path = Path::new(&out_path).join("ucd");
 
-    networking::download_files(&out_path);
-    generate_code(&ucd_path, &out_path);
+    networking::download_files(out_path);
+    generate_code(&ucd_path, out_path);
 
     println!("cargo:rerun-if-changed=build.rs");
 }

precis-profiles/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "precis-profiles"
-version = "0.1.8"
+version = "0.1.9"
 authors = ["Santiago Carot-Nemesio <sancane@gmail.com"]
 description = """
 Implementation of the PRECIS Framework: Preparation, Enforcement,
@@ -18,12 +18,12 @@ categories = ["text-processing", "internationalization"]
 edition = "2018"
 
 [build-dependencies]
-precis-tools = { path = "../precis-tools", version = "0.1.6" }
+precis-tools.workspace = true
 
 [dependencies]
-lazy_static = "1.4.0"
-precis-core = { path = "../precis-core", version = "0.1.8" }
-unicode-normalization = "0.1.19"
+lazy_static.workspace = true
+precis-core.workspace = true
+unicode-normalization.workspace = true
 
 [features]
 networking = ["precis-core/networking", "precis-tools/networking"]

precis-profiles/build.rs

@@ -46,7 +46,7 @@ mod download_ucd {
 
     pub fn create_dir(path: &Path) {
         if !path.is_dir() {
-            fs::create_dir(&path).unwrap();
+            fs::create_dir(path).unwrap();
         }
     }
 }
@@ -61,7 +61,7 @@ fn main() {
 
     precis_tools::download::get_ucd_file(UNICODE_VERSION, &ucd_path, "UnicodeData.txt").unwrap();
 
-    generate_code(&ucd_path, &out_path);
+    generate_code(&ucd_path, out_path);
 
     println!("cargo:rerun-if-changed=build.rs");
 }

precis-tools/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "precis-tools"
-version = "0.1.6"
+version = "0.1.7"
 authors = ["Santiago Carot-Nemesio <sancane@gmail.com>"]
 description = """
 Tools and parsers to generate PRECIS tables from the Unicode Character Database (UCD)
@@ -15,10 +15,10 @@ categories = ["text-processing", "internationalization"]
 edition = "2018"
 
 [dependencies]
-lazy_static = "1.4.0"
-regex = "1"
-reqwest = { version = "0.11.4", features = ["blocking"], optional = true }
-ucd-parse = "0.1.8"
+lazy_static.workspace = true
+regex.workspace = true
+reqwest = { workspace = true, optional = true }
+ucd-parse.workspace = true
 
 [features]
 networking = ["reqwest"]

precis-tools/src/download.rs

@@ -1,3 +1,5 @@
+//! Module for downloading files from the internet.
+
 use crate::Error;
 use reqwest::header::USER_AGENT;
 use std::env;
@@ -34,12 +36,25 @@ fn download(url: &str, dest: &Path) -> Result<(), Error> {
     Ok(fs::write(dest, text)?)
 }
 
+/// Gets a ucd file from the Internet
+/// # Arguments
+/// * `ucd_version`: Unicode version
+/// * `dest`: Destination directory
+/// * `file`: File name
+/// # Returns
+/// `Ok(())` if the file was downloaded successfully, `Err(Error)` otherwise
 pub fn get_ucd_file(ucd_version: &str, dest: &Path, file: &str) -> Result<(), Error> {
     let url = format!("{}/{}", get_unicode_ucd_uri(ucd_version), file);
     let dest_path = dest.join(file);
     download(&url, &dest_path)
 }
 
+/// Gets a csv file from the Internet
+/// # Arguments
+/// * `ucd_version`: Unicode version
+/// * `dest`: Destination directory
+/// # Returns
+/// `Ok(())` if the file was downloaded successfully, `Err(Error)` otherwise
 pub fn get_csv_file(ucd_version: &str, dest: &Path) -> Result<(), Error> {
     let dest_path = dest.join(get_csv_file_name(ucd_version));
     download(&get_precis_csv_tables_uri(ucd_version), &dest_path)