Merge pull request #297 from meilisearch/fix-doc

Improve the documentation, the CI and fix Clippy

Author: Kerollmops

.github/workflows/rust.yml

@@ -3,7 +3,7 @@ on: [pull_request]
 
 name: Rust
 jobs:
-  test:
+  heed-test:
     name: Test the heed project
     runs-on: ${{ matrix.os }}
     strategy:
@@ -13,7 +13,30 @@ jobs:
           - os: ubuntu-latest
           - os: windows-latest
           - os: macos-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          submodules: recursive
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: stable
+          override: true
+      - name: Run cargo test
+        run: |
+          cargo clean
+          cargo test
 
+  heed3-test:
+    name: Test the heed3 project
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        include:
+          - os: ubuntu-latest
+          - os: windows-latest
+          - os: macos-latest
     steps:
       - uses: actions/checkout@v2
         with:
@@ -26,6 +49,7 @@ jobs:
       - name: Run cargo test
         run: |
           cargo clean
+          bash convert-to-heed3.sh
           cargo test
 
   check-heed3:
@@ -38,7 +62,6 @@ jobs:
           - os: ubuntu-latest
           - os: windows-latest
           - os: macos-latest
-
     steps:
       - uses: actions/checkout@v2
         with:
@@ -65,7 +88,6 @@ jobs:
         include:
           - os: ubuntu-latest
           - os: macos-latest
-
     steps:
       - uses: actions/checkout@v2
         with:
@@ -75,7 +97,16 @@ jobs:
           profile: minimal
           toolchain: stable
           override: true
+      - id: check_toml
+        run: |
+          if grep -q 'name = "heed3"' heed/Cargo.toml; then
+            echo "should_skip=true" >> $GITHUB_OUTPUT
+          else
+            echo "should_skip=false" >> $GITHUB_OUTPUT
+          fi
       - name: Run cargo test
+        # Skip it if the CI is running with the heed3 Cargo.toml
+        if: ${{ steps.check_toml.outputs.should_skip == 'false' }}
         run: |
           cargo clean
           cargo check --all-features -p heed
@@ -91,7 +122,6 @@ jobs:
         include:
           - os: ubuntu-latest
           - os: macos-latest
-
     steps:
       - uses: actions/checkout@v2
         with:
@@ -116,7 +146,6 @@ jobs:
         include:
           - os: ubuntu-latest
           - os: macos-latest
-
     steps:
       - uses: actions/checkout@v2
         with:
@@ -126,7 +155,16 @@ jobs:
           profile: minimal
           toolchain: stable
           override: true
+      - id: check_toml
+        run: |
+          if grep -q 'name = "heed3"' heed/Cargo.toml; then
+            echo "should_skip=true" >> $GITHUB_OUTPUT
+          else
+            echo "should_skip=false" >> $GITHUB_OUTPUT
+          fi
       - name: Run the examples
+        # Skip it if the CI is running with the heed3 Cargo.toml
+        if: ${{ steps.check_toml.outputs.should_skip == 'false' }}
         run: |
           cargo clean
           # rmp-serde needs a feature activated, so we'll just run it separately.
@@ -142,7 +180,6 @@ jobs:
         include:
           - os: ubuntu-latest
           - os: macos-latest
-
     steps:
       - uses: actions/checkout@v2
         with:
@@ -158,8 +195,26 @@ jobs:
           bash convert-to-heed3.sh
           cargo run --example 2>&1 | grep -E '^ '| xargs -n1 cargo run --example
 
+  clippy:
+    name: Ensure clippy is happy on heed and heed3
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          submodules: recursive
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: stable
+          override: true
+      - name: Run the examples
+        run: |
+          cargo clippy --all-targets -- --deny warnings
+          bash convert-to-heed3.sh
+          cargo clippy --all-targets -- --deny warnings
+
   fmt:
-    name: Ensure the heed project is formatted
+    name: Ensure the heed and heed3 project are formatted
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
@@ -170,7 +225,10 @@ jobs:
           override: true
           components: rustfmt
       - name: Run cargo fmt
-        run: cargo fmt --check
+        run: |
+          cargo fmt --check
+          bash convert-to-heed3.sh
+          cargo fmt --check
 
   no-heed3-in-heed-folder:
     name: Ensure heed3 is not erasing heed

convert-to-heed3.sh

@@ -30,7 +30,13 @@ done
 # Make it easier to rollback by doing a commit
 git config --local user.email "[email protected]"
 git config --local user.name "The CI"
-git commit -am 'remove-me: heed3 changes generate by the convert-to-heed3.sh script'
+
+# But only commit if there is something to commit
+git diff -q --exit-code || git commit -am 'remove-me: heed3 changes generated by the convert-to-heed3.sh script'
+
+git config --local --unset user.email
+git config --local --unset user.name
+
 
 echo "Heed3 crate setup completed successfully. Configurations for the heed crate have been copied and modified."
 echo "A commit (starting with remove-me) has been generated and must be deleted before merging into the main branch."

examples/all-types.rs

@@ -1,16 +1,12 @@
 use std::error::Error;
-use std::fs;
-use std::path::Path;
 
 use heed::byteorder::BE;
 use heed::types::*;
 use heed::{Database, EnvOpenOptions};
 use serde::{Deserialize, Serialize};
 
 fn main() -> Result<(), Box<dyn Error>> {
-    let path = Path::new("target").join("heed.mdb");
-
-    fs::create_dir_all(&path)?;
+    let path = tempfile::tempdir()?;
 
     let env = unsafe {
         EnvOpenOptions::new()

examples/clear-database.rs

@@ -1,18 +1,13 @@
 use std::error::Error;
-use std::fs;
-use std::path::Path;
 
 use heed::types::*;
 use heed::{Database, EnvOpenOptions};
 
 // In this test we are checking that we can clear database entries and
 // write just after in the same transaction without loosing the writes.
 fn main() -> Result<(), Box<dyn Error>> {
-    let env_path = Path::new("target").join("clear-database.mdb");
+    let env_path = tempfile::tempdir()?;
 
-    let _ = fs::remove_dir_all(&env_path);
-
-    fs::create_dir_all(&env_path)?;
     let env = unsafe {
         EnvOpenOptions::new()
             .map_size(10 * 1024 * 1024) // 10MB

examples/cursor-append.rs

@@ -1,18 +1,13 @@
 use std::error::Error;
-use std::fs;
-use std::path::Path;
 
 use heed::types::*;
 use heed::{Database, EnvOpenOptions, PutFlags};
 
 // In this test we are checking that we can append ordered entries in one
 // database even if there is multiple databases which already contain entries.
 fn main() -> Result<(), Box<dyn Error>> {
-    let env_path = Path::new("target").join("cursor-append.mdb");
+    let env_path = tempfile::tempdir()?;
 
-    let _ = fs::remove_dir_all(&env_path);
-
-    fs::create_dir_all(&env_path)?;
     let env = unsafe {
         EnvOpenOptions::new()
             .map_size(10 * 1024 * 1024) // 10MB

examples/custom-comparator.rs

@@ -1,7 +1,6 @@
 use std::cmp::Ordering;
 use std::error::Error;
-use std::path::Path;
-use std::{fs, str};
+use std::str;
 
 use heed::EnvOpenOptions;
 use heed_traits::Comparator;
@@ -21,11 +20,8 @@ impl Comparator for StringAsIntCmp {
 }
 
 fn main() -> Result<(), Box<dyn Error>> {
-    let env_path = Path::new("target").join("custom-key-cmp.mdb");
+    let env_path = tempfile::tempdir()?;
 
-    let _ = fs::remove_dir_all(&env_path);
-
-    fs::create_dir_all(&env_path)?;
     let env = unsafe {
         EnvOpenOptions::new()
             .map_size(10 * 1024 * 1024) // 10MB

examples/heed3-all-types.rs

@@ -1,16 +1,12 @@
 use std::error::Error;
-use std::fs;
-use std::path::Path;
 
 use heed3::byteorder::BE;
 use heed3::types::*;
 use heed3::{Database, EnvOpenOptions};
 use serde::{Deserialize, Serialize};
 
 fn main() -> Result<(), Box<dyn Error>> {
-    let path = Path::new("target").join("heed3.mdb");
-
-    fs::create_dir_all(&path)?;
+    let path = tempfile::tempdir()?;
 
     let env = unsafe {
         EnvOpenOptions::new()

examples/heed3-encrypted.rs

@@ -1,20 +1,15 @@
 use std::error::Error;
-use std::fs;
-use std::path::Path;
 
 use argon2::Argon2;
 use chacha20poly1305::{ChaCha20Poly1305, Key};
 use heed3::types::*;
 use heed3::EnvOpenOptions;
 
 fn main() -> Result<(), Box<dyn Error>> {
-    let env_path = Path::new("target").join("encrypt.mdb");
+    let env_path = tempfile::tempdir()?;
     let password = "This is the password that will be hashed by the argon2 algorithm";
     let salt = "The salt added to the password hashes to add more security when stored";
 
-    let _ = fs::remove_dir_all(&env_path);
-    fs::create_dir_all(&env_path)?;
-
     // We choose to use argon2 as our Key Derivation Function, but you can choose whatever you want.
     // <https://github.com/RustCrypto/traits/tree/master/password-hash#supported-crates>
     let mut key = Key::default();

examples/multi-env.rs

@@ -1,6 +1,4 @@
 use std::error::Error;
-use std::fs;
-use std::path::Path;
 
 use byteorder::BE;
 use heed::types::*;
@@ -9,18 +7,15 @@ use heed::{Database, EnvOpenOptions};
 type BEU32 = U32<BE>;
 
 fn main() -> Result<(), Box<dyn Error>> {
-    let env1_path = Path::new("target").join("env1.mdb");
-    let env2_path = Path::new("target").join("env2.mdb");
-
-    fs::create_dir_all(&env1_path)?;
+    let env1_path = tempfile::tempdir()?;
+    let env2_path = tempfile::tempdir()?;
     let env1 = unsafe {
         EnvOpenOptions::new()
             .map_size(10 * 1024 * 1024) // 10MB
             .max_dbs(3000)
             .open(env1_path)?
     };
 
-    fs::create_dir_all(&env2_path)?;
     let env2 = unsafe {
         EnvOpenOptions::new()
             .map_size(10 * 1024 * 1024) // 10MB

examples/nested.rs

@@ -1,14 +1,10 @@
 use std::error::Error;
-use std::fs;
-use std::path::Path;
 
 use heed::types::*;
 use heed::{Database, EnvOpenOptions};
 
 fn main() -> Result<(), Box<dyn Error>> {
-    let path = Path::new("target").join("heed.mdb");
-
-    fs::create_dir_all(&path)?;
+    let path = tempfile::tempdir()?;
 
     let env = unsafe {
         EnvOpenOptions::new()