Merge pull request #285 from christianschleifer/workspaces

Introduce cargo workspaces
RoaringBitmap · Aug 18, 2024 · 9e743c4 · 9e743c4
2 parents c57c476 + eefaa3d
commit 9e743c4
Show file tree

Hide file tree

Showing 70 changed files with 65 additions and 68 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -46,48 +46,24 @@ jobs:
         with:
           command: fetch
 
-      - name: Fetch benchmarks
-        uses: actions-rs/cargo@v1
-        with:
-          command: fetch
-          args: --manifest-path benchmarks/Cargo.toml
-
       - name: Build
         uses: actions-rs/cargo@v1
         with:
           command: build
           args: --all-targets
 
-      - name: Build benchmarks
-        uses: actions-rs/cargo@v1
-        with:
-          command: build
-          args: --manifest-path benchmarks/Cargo.toml --all-targets
-
       - name: Check
         uses: actions-rs/cargo@v1
         with:
           command: clippy
           args: --all-targets -- -D warnings
 
-      - name: Check benchmarks
-        uses: actions-rs/cargo@v1
-        with:
-          command: clippy
-          args: --manifest-path benchmarks/Cargo.toml --all-targets -- -D warnings
-
       - name: Check formatting
         uses: actions-rs/cargo@v1
         with:
           command: fmt
           args: -- --check
 
-      - name: Check benchmark formatting
-        uses: actions-rs/cargo@v1
-        with:
-          command: fmt
-          args: --manifest-path benchmarks/Cargo.toml -- --check
-
       - name: Test
         uses: actions-rs/cargo@v1
         with:
@@ -103,8 +79,7 @@ jobs:
       - name: Test benchmarks
         uses: actions-rs/cargo@v1
         with:
-          command: test
-          args: --manifest-path benchmarks/Cargo.toml --benches
+          command: bench
 
       - name: SIMD test
         if: matrix.rust == 'nightly'
@@ -119,5 +94,5 @@ jobs:
         uses: actions-rs/cargo@v1
         with:
           toolchain: nightly
-          command: test
-          args: --manifest-path benchmarks/Cargo.toml --features "simd" --benches
+          command: bench
+          args: --features "simd"
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,35 +1,22 @@
-[package]
-name = "roaring"
-version = "0.10.6"
-rust-version = "1.65.0"
-authors = ["Wim Looman <wim@nemo157.com>", "Kerollmops <kero@meilisearch.com>"]
-description = "A better compressed bitset - pure Rust implementation"
+[workspace]
+members = ["roaring", "benchmarks"]
+resolver = "2"
 
-documentation = "https://docs.rs/roaring"
-repository = "https://github.com/RoaringBitmap/roaring-rs"
+[workspace.dependencies]
+roaring = { path = "roaring" }
 
-readme = "README.md"
-keywords = ["roaring", "data-structure", "bitmap"]
-categories = ["data-structures"]
-edition = "2021"
-
-license = "MIT OR Apache-2.0"
-
-[dependencies]
-bytemuck = { version = "1.16.1", optional = true }
-byteorder = { version = "1.5.0", optional = true }
-serde = { version = "1.0.203", optional = true }
-
-[features]
-default = ["std"]
-serde = ["dep:serde", "std"]
-simd = []
-std = ["dep:bytemuck", "dep:byteorder"]
-
-[dev-dependencies]
+bincode = "1.3.3"
+bytemuck = "1.16.1"
+byteorder = "1.5.0"
+criterion = "0.3"
+git2 = { version = "0.19", default-features = false }
+indicatif = "0.17"
+itertools = "0.13"
+once_cell = "1.9"
 proptest = "1.5.0"
+serde = "1.0.203"
 serde_json = "1.0.120"
-bincode = "1.3.3"
+zip = { version = "0.6", default-features = false }
 
 [profile.test]
 opt-level = 2
diff --git a/README.md b/README.md
@@ -17,18 +17,17 @@ This project uses [Clippy][], [rustfmt][], and denies warnings in CI builds. Ava
 To ensure your changes will be accepted please check them with:
 ```
 cargo fmt -- --check
-cargo fmt --manifest-path benchmarks/Cargo.toml -- --check
 cargo clippy --all-targets -- -D warnings
 ```
 
 In addition, ensure all tests are passing with `cargo test`
 
 ### Benchmarking
 
-It is recommended to run the `cargo bench` command inside of the `benchmarks` directory.
-This directory contains a library that is dedicated to benchmarking the Roaring library
-by using a set of [real-world datasets][]. It is also advised to run the benchmarks on
-a bare-metal machine, running them on the base branch and then on the contribution PR
+It is recommended to run the `cargo bench` command.
+The [benchmarks directory](./benchmarks) contains a library that is dedicated to benchmarking the 
+Roaring library by using a set of [real-world datasets][]. It is also advised to run the benchmarks
+on a bare-metal machine, running them on the base branch and then on the contribution PR
 branch to better see the changes.
 
 Those benchmarks are designed on top of the Criterion library,

diff --git a/benchmarks/Cargo.toml b/benchmarks/Cargo.toml
@@ -4,18 +4,19 @@ description = "An external library for benchmarking the roaring crate with real
 version = "0.1.0"
 authors = ["Kerollmops <renault.cle@gmail.com>"]
 edition = "2021"
+rust-version = "1.65.0"
 publish = false
 
 [dependencies]
-roaring = { path = ".." }
+roaring = { workspace = true }
 
 [dev-dependencies]
-once_cell = "1.9"
-git2 = { version = "0.17", default-features = false, features = ["https", "vendored-openssl"] }
-zip = { version = "0.5", default-features = false, features = ["deflate"] }
-indicatif = "0.16"
-criterion = { version = "0.3", features = ["html_reports"] }
-itertools = "0.10"
+criterion = { workspace = true, features = ["html_reports"] }
+git2 = { workspace = true, default-features = false, features = ["https", "vendored-openssl"] }
+indicatif = { workspace = true }
+itertools = { workspace = true }
+once_cell = { workspace = true }
+zip = { workspace = true, default-features = false, features = ["deflate"] }
 
 [features]
 simd = ["roaring/simd"]

diff --git a/benchmarks/benches/datasets.rs b/benchmarks/benches/datasets.rs
@@ -81,6 +81,7 @@ fn init_datasets() -> Result<PathBuf, Box<dyn std::error::Error>> {
                             "{{prefix}}{{msg:.cyan/blue}} [{{bar}}] {{pos}}/{}",
                             progress.total_objects()
                         ))
+                        .expect("template string invalid")
                         .progress_chars("#> "),
                 )
                 .with_prefix("    ")
@@ -168,6 +169,7 @@ fn parse_datasets<P: AsRef<Path>>(path: P) -> Result<Vec<Dataset>, Box<dyn std::
                 .with_style(
                     ProgressStyle::default_bar()
                         .template("    {prefix:.green} [{bar}] {msg}")
+                        .expect("template string invalid")
                         .progress_chars("#> "),
                 )
                 .with_prefix("Parsing")

diff --git a/roaring/Cargo.toml b/roaring/Cargo.toml
@@ -0,0 +1,33 @@
+[package]
+name = "roaring"
+version = "0.10.6"
+rust-version = "1.65.0"
+authors = ["Wim Looman <wim@nemo157.com>", "Kerollmops <kero@meilisearch.com>"]
+description = "A better compressed bitset - pure Rust implementation"
+
+documentation = "https://docs.rs/roaring"
+repository = "https://github.com/RoaringBitmap/roaring-rs"
+
+readme = "../README.md"
+keywords = ["roaring", "data-structure", "bitmap"]
+categories = ["data-structures"]
+edition = "2021"
+
+license = "MIT OR Apache-2.0"
+
+[dependencies]
+bytemuck = { workspace = true, optional = true }
+byteorder = { workspace = true, optional = true }
+serde = { workspace = true, optional = true }
+
+[features]
+default = ["std"]
+serde = ["dep:serde", "std"]
+simd = []
+std = ["dep:bytemuck", "dep:byteorder"]
+
+[dev-dependencies]
+proptest = { workspace = true }
+serde_json = { workspace = true }
+bincode = { workspace = true }
+
diff --git a/src/bitmap/arbitrary.rs → roaring/src/bitmap/arbitrary.rs b/src/bitmap/arbitrary.rs → roaring/src/bitmap/arbitrary.rs
diff --git a/src/bitmap/cmp.rs → roaring/src/bitmap/cmp.rs b/src/bitmap/cmp.rs → roaring/src/bitmap/cmp.rs
diff --git a/src/bitmap/container.rs → roaring/src/bitmap/container.rs b/src/bitmap/container.rs → roaring/src/bitmap/container.rs
diff --git a/src/bitmap/fmt.rs → roaring/src/bitmap/fmt.rs b/src/bitmap/fmt.rs → roaring/src/bitmap/fmt.rs
diff --git a/src/bitmap/inherent.rs → roaring/src/bitmap/inherent.rs b/src/bitmap/inherent.rs → roaring/src/bitmap/inherent.rs
diff --git a/src/bitmap/iter.rs → roaring/src/bitmap/iter.rs b/src/bitmap/iter.rs → roaring/src/bitmap/iter.rs
diff --git a/src/bitmap/mod.rs → roaring/src/bitmap/mod.rs b/src/bitmap/mod.rs → roaring/src/bitmap/mod.rs
diff --git a/src/bitmap/multiops.rs → roaring/src/bitmap/multiops.rs b/src/bitmap/multiops.rs → roaring/src/bitmap/multiops.rs
diff --git a/src/bitmap/ops.rs → roaring/src/bitmap/ops.rs b/src/bitmap/ops.rs → roaring/src/bitmap/ops.rs
diff --git a/src/bitmap/ops_with_serialized.rs → roaring/src/bitmap/ops_with_serialized.rs b/src/bitmap/ops_with_serialized.rs → roaring/src/bitmap/ops_with_serialized.rs
diff --git a/src/bitmap/proptests.rs → roaring/src/bitmap/proptests.rs b/src/bitmap/proptests.rs → roaring/src/bitmap/proptests.rs
diff --git a/src/bitmap/serde.rs → roaring/src/bitmap/serde.rs b/src/bitmap/serde.rs → roaring/src/bitmap/serde.rs
diff --git a/src/bitmap/serialization.rs → roaring/src/bitmap/serialization.rs b/src/bitmap/serialization.rs → roaring/src/bitmap/serialization.rs
diff --git a/src/bitmap/store/array_store/mod.rs → roaring/src/bitmap/store/array_store/mod.rs b/src/bitmap/store/array_store/mod.rs → roaring/src/bitmap/store/array_store/mod.rs
diff --git a/src/bitmap/store/array_store/scalar.rs → ...ng/src/bitmap/store/array_store/scalar.rs b/src/bitmap/store/array_store/scalar.rs → ...ng/src/bitmap/store/array_store/scalar.rs
diff --git a/src/bitmap/store/array_store/vector.rs → ...ng/src/bitmap/store/array_store/vector.rs b/src/bitmap/store/array_store/vector.rs → ...ng/src/bitmap/store/array_store/vector.rs
diff --git a/src/bitmap/store/array_store/visitor.rs → ...g/src/bitmap/store/array_store/visitor.rs b/src/bitmap/store/array_store/visitor.rs → ...g/src/bitmap/store/array_store/visitor.rs
diff --git a/src/bitmap/store/bitmap_store.rs → roaring/src/bitmap/store/bitmap_store.rs b/src/bitmap/store/bitmap_store.rs → roaring/src/bitmap/store/bitmap_store.rs
diff --git a/src/bitmap/store/mod.rs → roaring/src/bitmap/store/mod.rs b/src/bitmap/store/mod.rs → roaring/src/bitmap/store/mod.rs
diff --git a/src/bitmap/util.rs → roaring/src/bitmap/util.rs b/src/bitmap/util.rs → roaring/src/bitmap/util.rs
diff --git a/src/lib.rs → roaring/src/lib.rs b/src/lib.rs → roaring/src/lib.rs
diff --git a/src/treemap/arbitrary.rs → roaring/src/treemap/arbitrary.rs b/src/treemap/arbitrary.rs → roaring/src/treemap/arbitrary.rs
diff --git a/src/treemap/cmp.rs → roaring/src/treemap/cmp.rs b/src/treemap/cmp.rs → roaring/src/treemap/cmp.rs
diff --git a/src/treemap/fmt.rs → roaring/src/treemap/fmt.rs b/src/treemap/fmt.rs → roaring/src/treemap/fmt.rs
diff --git a/src/treemap/inherent.rs → roaring/src/treemap/inherent.rs b/src/treemap/inherent.rs → roaring/src/treemap/inherent.rs
diff --git a/src/treemap/iter.rs → roaring/src/treemap/iter.rs b/src/treemap/iter.rs → roaring/src/treemap/iter.rs
diff --git a/src/treemap/mod.rs → roaring/src/treemap/mod.rs b/src/treemap/mod.rs → roaring/src/treemap/mod.rs
diff --git a/src/treemap/multiops.rs → roaring/src/treemap/multiops.rs b/src/treemap/multiops.rs → roaring/src/treemap/multiops.rs
diff --git a/src/treemap/ops.rs → roaring/src/treemap/ops.rs b/src/treemap/ops.rs → roaring/src/treemap/ops.rs
diff --git a/src/treemap/serde.rs → roaring/src/treemap/serde.rs b/src/treemap/serde.rs → roaring/src/treemap/serde.rs
diff --git a/src/treemap/serialization.rs → roaring/src/treemap/serialization.rs b/src/treemap/serialization.rs → roaring/src/treemap/serialization.rs
diff --git a/src/treemap/util.rs → roaring/src/treemap/util.rs b/src/treemap/util.rs → roaring/src/treemap/util.rs
diff --git a/tests/bitmapwithoutruns.bin → roaring/tests/bitmapwithoutruns.bin b/tests/bitmapwithoutruns.bin → roaring/tests/bitmapwithoutruns.bin
diff --git a/tests/bitmapwithruns.bin → roaring/tests/bitmapwithruns.bin b/tests/bitmapwithruns.bin → roaring/tests/bitmapwithruns.bin
diff --git a/tests/clone.rs → roaring/tests/clone.rs b/tests/clone.rs → roaring/tests/clone.rs
diff --git a/tests/difference_with.rs → roaring/tests/difference_with.rs b/tests/difference_with.rs → roaring/tests/difference_with.rs
diff --git a/tests/intersect_with.rs → roaring/tests/intersect_with.rs b/tests/intersect_with.rs → roaring/tests/intersect_with.rs
diff --git a/tests/is_disjoint.rs → roaring/tests/is_disjoint.rs b/tests/is_disjoint.rs → roaring/tests/is_disjoint.rs
diff --git a/tests/is_subset.rs → roaring/tests/is_subset.rs b/tests/is_subset.rs → roaring/tests/is_subset.rs
diff --git a/tests/iter.rs → roaring/tests/iter.rs b/tests/iter.rs → roaring/tests/iter.rs
diff --git a/tests/lib.rs → roaring/tests/lib.rs b/tests/lib.rs → roaring/tests/lib.rs
diff --git a/tests/ops.rs → roaring/tests/ops.rs b/tests/ops.rs → roaring/tests/ops.rs
diff --git a/tests/push.rs → roaring/tests/push.rs b/tests/push.rs → roaring/tests/push.rs
diff --git a/tests/range_checks.rs → roaring/tests/range_checks.rs b/tests/range_checks.rs → roaring/tests/range_checks.rs
diff --git a/tests/rank.rs → roaring/tests/rank.rs b/tests/rank.rs → roaring/tests/rank.rs
diff --git a/tests/select.rs → roaring/tests/select.rs b/tests/select.rs → roaring/tests/select.rs
diff --git a/tests/serialization.rs → roaring/tests/serialization.rs b/tests/serialization.rs → roaring/tests/serialization.rs
diff --git a/tests/size_hint.rs → roaring/tests/size_hint.rs b/tests/size_hint.rs → roaring/tests/size_hint.rs
diff --git a/tests/symmetric_difference_with.rs → roaring/tests/symmetric_difference_with.rs b/tests/symmetric_difference_with.rs → roaring/tests/symmetric_difference_with.rs
diff --git a/tests/treemap_clone.rs → roaring/tests/treemap_clone.rs b/tests/treemap_clone.rs → roaring/tests/treemap_clone.rs
diff --git a/tests/treemap_difference_with.rs → roaring/tests/treemap_difference_with.rs b/tests/treemap_difference_with.rs → roaring/tests/treemap_difference_with.rs
diff --git a/tests/treemap_intersect_with.rs → roaring/tests/treemap_intersect_with.rs b/tests/treemap_intersect_with.rs → roaring/tests/treemap_intersect_with.rs
diff --git a/tests/treemap_is_disjoint.rs → roaring/tests/treemap_is_disjoint.rs b/tests/treemap_is_disjoint.rs → roaring/tests/treemap_is_disjoint.rs
diff --git a/tests/treemap_is_subset.rs → roaring/tests/treemap_is_subset.rs b/tests/treemap_is_subset.rs → roaring/tests/treemap_is_subset.rs
diff --git a/tests/treemap_iter.rs → roaring/tests/treemap_iter.rs b/tests/treemap_iter.rs → roaring/tests/treemap_iter.rs
diff --git a/tests/treemap_lib.rs → roaring/tests/treemap_lib.rs b/tests/treemap_lib.rs → roaring/tests/treemap_lib.rs
diff --git a/tests/treemap_ops.rs → roaring/tests/treemap_ops.rs b/tests/treemap_ops.rs → roaring/tests/treemap_ops.rs
diff --git a/tests/treemap_rank.rs → roaring/tests/treemap_rank.rs b/tests/treemap_rank.rs → roaring/tests/treemap_rank.rs
diff --git a/tests/treemap_select.rs → roaring/tests/treemap_select.rs b/tests/treemap_select.rs → roaring/tests/treemap_select.rs
diff --git a/tests/treemap_serialization.rs → roaring/tests/treemap_serialization.rs b/tests/treemap_serialization.rs → roaring/tests/treemap_serialization.rs
diff --git a/tests/treemap_size_hint.rs → roaring/tests/treemap_size_hint.rs b/tests/treemap_size_hint.rs → roaring/tests/treemap_size_hint.rs
diff --git a/tests/treemap_symmetric_difference_with.rs → ...ests/treemap_symmetric_difference_with.rs b/tests/treemap_symmetric_difference_with.rs → ...ests/treemap_symmetric_difference_with.rs
diff --git a/tests/treemap_union_with.rs → roaring/tests/treemap_union_with.rs b/tests/treemap_union_with.rs → roaring/tests/treemap_union_with.rs
diff --git a/tests/union_with.rs → roaring/tests/union_with.rs b/tests/union_with.rs → roaring/tests/union_with.rs