chore: draft release via GitHub action

.github/labeler.yml

@@ -32,8 +32,8 @@ rust:
 
 c:
   - changed-files:
-     - any-glob-to-any-file: "c/**"
+      - any-glob-to-any-file: "c/**"
 
 d:
   - changed-files:
-     - any-glob-to-any-file: "d/**"
+      - any-glob-to-any-file: "d/**"

.github/workflows/c-gen-docs.yml

@@ -38,8 +38,8 @@ jobs:
       - name: Build docs with Doxygen
         uses: mattnotmitt/[email protected]
         with:
-          working-directory: 'c/'
-          doxyfile-path: 'Doxyfile'
+          working-directory: "c/"
+          doxyfile-path: "Doxyfile"
 
       - name: Publish to GitHub Pages
         if: success()

.github/workflows/c-releases.yml

@@ -4,7 +4,7 @@ on:
   workflow_dispatch:
     inputs:
       tag:
-        description: 'Release tag (.eg v1.0.0)'
+        description: "Release tag (.eg v1.0.0)"
         required: true
         type: string
 
@@ -51,15 +51,15 @@ jobs:
       - name: Create archive
         uses: TheDoctor0/[email protected]
         with:
-          type: 'tar'
-          filename: 'github-release/c-release.tar.gz'
-          directory: 'c'
-          exclusions: './build/* github-release'
+          type: "tar"
+          filename: "github-release/c-release.tar.gz"
+          directory: "c"
+          exclusions: "./build/* github-release"
 
       - name: Upload release
         uses: ncipollo/[email protected]
         with:
-          name: 'Kuliya latest'
-          artifacts: 'c/github-release/c-release.tar.gz'
-          tag: 'c-${{ inputs.tag }}'
+          name: "Kuliya latest"
+          artifacts: "c/github-release/c-release.tar.gz"
+          tag: "c-${{ inputs.tag }}"
           token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/draft-new-release.yml

@@ -2,77 +2,77 @@ name: "Draft New Release"
 run-name: "Draft: ${{ github.event.inputs.project }}-${{ github.event.inputs.version }}"
 
 on:
-    workflow_dispatch:
-        inputs:
-            project:
-                type: choice
-                options:
-                    - "c"
-                    - "csharp"
-                    - "d"
-                    - "java"
-                    - "javascript"
-                    - "php"
-                    - "python"
-                    - "rust"
-                required: true
-            version:
-                description: "eg. 0.1.0"
-                required: true
+  workflow_dispatch:
+    inputs:
+      project:
+        type: choice
+        options:
+          - "c"
+          - "csharp"
+          - "d"
+          - "java"
+          - "javascript"
+          - "php"
+          - "python"
+          - "rust"
+        required: true
+      version:
+        description: "eg. 0.1.0"
+        required: true
 
 jobs:
-    apply-version-rust:
-        name: "Apply Version for: ${{ github.event.inputs.project }}"
-        runs-on: ubuntu-latest
-        if: ${{ github.event.inputs.project == 'rust' }}
-        env:
-            CWD: "./${{ github.event.inputs.project }}"
-            PROJECT: ${{ github.event.inputs.project }}
-            PUBLISH_VERSION: ${{ github.event.inputs.version }}
-            BRANCH: "main"
-        steps:
-            - uses: actions/checkout@v4
-              with:
-                  fetch-depth: 0
-            - uses: actions-rust-lang/setup-rust-toolchain@v1
-            - run: cargo install cargo-bump
-              working-directory: ${{ env.CWD }}
-            - run: cargo bump ${{ env.PUBLISH_VERSION }}
-              working-directory: ${{ env.CWD }}
-            - run: cargo build
-              working-directory: ${{ env.CWD }}
-            - name: "Commit and Push"
-              run: |
-                  git config user.name github-actions[bot]
-                  git config user.email github-actions[bot]@users.noreply.github.com
-                  git checkout ${{ env.BRANCH }}
-                  git add .
-                  git commit -m "$PROJECT$PUBLISH_VERSION"
-                  git push origin HEAD:refs/heads/${{ env.BRANCH }}
+  apply-version-rust:
+    name: "Apply Version for: ${{ github.event.inputs.project }}"
+    runs-on: ubuntu-latest
+    if: ${{ github.event.inputs.project == 'rust' }}
+    env:
+      CWD: "./${{ github.event.inputs.project }}"
+      PROJECT: ${{ github.event.inputs.project }}
+      PUBLISH_VERSION: ${{ github.event.inputs.version }}
+      BRANCH: "main"
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions-rust-lang/setup-rust-toolchain@v1
+      - run: cargo install cargo-bump
+        working-directory: ${{ env.CWD }}
+      - run: cargo bump ${{ env.PUBLISH_VERSION }}
+        working-directory: ${{ env.CWD }}
+      - run: cargo build
+        working-directory: ${{ env.CWD }}
+      - name: "Commit and Push"
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email github-actions[bot]@users.noreply.github.com
+          git checkout ${{ env.BRANCH }}
+          git add .
+          git commit -m "$PROJECT$PUBLISH_VERSION"
+          git push origin HEAD:refs/heads/${{ env.BRANCH }}
 
-    draft-github-release:
-        name: "Draft GitHub Release"
-        runs-on: ubuntu-latest
-        needs: [apply-version-rust]
-        permissions:
-            contents: write
-        env:
-            PROJECT: ${{ github.event.inputs.project }}
-            PUBLISH_VERSION: ${{ github.event.inputs.version }}
-            GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-            BRANCH: "main"
-        steps:
-            - name: "Create Release"
-              run: |
-                  curl -X POST \
-                  -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \
-                  -H "Content-Type: application/json" \
-                  -d '{
-                      "tag_name": "${{ env.PROJECT }}-${{ env.PUBLISH_VERSION }}",
-                      "target_commitish": "${{ env.BRANCH }}",
-                      "name": "${{ env.PROJECT }}-${{ env.PUBLISH_VERSION }}",
-                      "body": "",
-                      "draft": true,
-                      "prerelease": false
-                  }' \
-                  https://api.github.com/repos/${{ github.repository }}/releases
+  draft-github-release:
+    name: "Draft GitHub Release"
+    runs-on: ubuntu-latest
+    needs: [apply-version-rust]
+    permissions:
+      contents: write
+    env:
+      PROJECT: ${{ github.event.inputs.project }}
+      PUBLISH_VERSION: ${{ github.event.inputs.version }}
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      BRANCH: "main"
+    steps:
+      - name: "Create Release"
+        run: |
+          curl -X POST \
+          -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \
+          -H "Content-Type: application/json" \
+          -d '{
+              "tag_name": "${{ env.PROJECT }}-${{ env.PUBLISH_VERSION }}",
+              "target_commitish": "${{ env.BRANCH }}",
+              "name": "${{ env.PROJECT }}-${{ env.PUBLISH_VERSION }}",
+              "body": "",
+              "draft": true,
+              "prerelease": false
+          }' \
+          https://api.github.com/repos/${{ github.repository }}/releases

.github/workflows/rust-checks.yml

@@ -13,20 +13,29 @@ jobs:
   build_and_test:
     name: kuliya - latest
     runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        toolchain:
-          - stable
-          - beta
-          - nightly
+    env:
+      CWD: "rust"
     steps:
       - uses: actions/checkout@v4
-      - run: rustup update ${{ matrix.toolchain }}
-      - run: rustup default ${{ matrix.toolchain }}
-      - run: rustup component add clippy
-      - run: cd rust && cargo clippy --all-features -- -Dwarnings
-      - run: cd rust && cargo build --verbose
-      - run: cd rust && cargo test --verbose
-      - run: cd rust && cargo test --verbose --lib --bins --tests --features serde_derive
-      - run: cd rust && cargo test --verbose  --lib --bins --tests --no-default-features --features storage
-      - run: cd rust && cargo test --verbose --all-features
+        with:
+          fetch-depth: 0
+      - uses: actions-rust-lang/setup-rust-toolchain@v1
+        with:
+          components: clippy
+      - run: cargo install cargo-readme
+      - run: cargo readme > README.md
+        working-directory: ${{ env.CWD }}
+      - run: cargo clippy --all-features -- -Dwarnings
+        working-directory: ${{ env.CWD }}
+      - run: cargo build --verbose
+        working-directory: ${{ env.CWD }}
+      - name: "is docs updated and generated files are committed"
+        run: exit $(git status --porcelain | wc -l)
+      - run: cargo test --verbose
+        working-directory: ${{ env.CWD }}
+      - run: cargo test --verbose --lib --bins --tests --features serde_derive
+        working-directory: ${{ env.CWD }}
+      - run: cargo test --verbose  --lib --bins --tests --no-default-features --features storage
+        working-directory: ${{ env.CWD }}
+      - run: cargo test --verbose --all-features
+        working-directory: ${{ env.CWD }}

.github/workflows/rust-publish.yml

@@ -0,0 +1,22 @@
+name: "CD"
+run-name: "Publish: ${{ github.ref_name }}"
+
+on:
+  push:
+    tags:
+      - "rust-*"
+
+jobs:
+  publish:
+    name: cargo publish
+    runs-on: ubuntu-latest
+    env:
+      CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
+      CWD: "rust"
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions-rust-lang/setup-rust-toolchain@v1
+      - run: cargo publish
+        working-directory: ${{ env.CWD }}

rust/.gitignore

@@ -1,2 +1,2 @@
 target
-src/static/_auto_generated
+

rust/Cargo.toml

@@ -1,7 +1,9 @@
 [package]
 name = "kuliya"
+description = "A library for querying Algerian education dataset."
 version = "0.1.0"
 edition = "2021"
+license = "MIT"
 
 [package.metadata.docs.rs]
 all-features = true

rust/README.md

@@ -1,13 +1,24 @@
-# kuliya for Rust
+# kuliya
 
-Algeria's college hierarchy dataset as Cargo package
+Algeria's college hierarchy dataset as a crate with useful APIs.
 
-# Get started
+Example
 
-WIP
+```rust
+use kuliya::r#static::api::get_node_by_path;
 
-# Contribute
+let faculty_of_science_and_technology = get_node_by_path("umkb/fst");
 
-Please install Rust compiler using https://rustup.rs/
+assert_eq!(faculty_of_science_and_technology.is_some(), true);
 
-Feel free to ask for help in [#kuliya](https://dzcode.slack.com/archives/C01C0155CKC) group chat
+let faculty_of_science_and_technology = faculty_of_science_and_technology.unwrap();
+
+assert_eq!(faculty_of_science_and_technology.name.ar, "كلية العلوم والتكنلوجيا");
+
+// when the path is not found, the function returns None
+let non_existing_node = get_node_by_path("umkb/fst/unknown");
+
+assert_eq!(non_existing_node.is_none(), true);
+```
+
+License: MIT

rust/build.rs

@@ -83,22 +83,26 @@ mod r#static {
         };
 
         let sub_dirs = fs::read_dir(&dir).unwrap();
-        let children = sub_dirs.filter_map(|entry| {
-            let entry = entry.unwrap();
-            let ty = entry.file_type().unwrap();
-            if ty.is_dir() {
-                Some(dir_tree_to_list(entry.path()))
-            } else {
-                None
-            }
-        });
+        let mut children: Vec<(String, String)> = sub_dirs
+            .filter_map(|entry| {
+                let entry = entry.unwrap();
+                let ty = entry.file_type().unwrap();
+                if ty.is_dir() {
+                    Some(dir_tree_to_list(entry.path()))
+                } else {
+                    None
+                }
+            })
+            .collect();
+        // to ensure deterministic output on different platforms
+        children.sort();
 
         let mut constants = String::new();
         let mut matches = String::new();
-        children.for_each(|(c, m)| {
+        for (c, m) in children {
             constants.push_str(&c);
             matches.push_str(&m);
-        });
+        }
 
         (
             format!("{}{}", this_node, constants),
@@ -134,7 +138,11 @@ pub mod data;
     }
 
     pub fn main() {
-        generate_data_file().unwrap();
+        if Path::new("../_data").exists() {
+            generate_data_file().unwrap();
+        } else {
+            println!("No _data directory found. Skipping data generation.");
+        }
     }
 }