feat: Make wasm32-compatible

Also include all other open PR's and suggestions to the original crate.

Author: jan-ferdinand

.cargo/config.toml

@@ -0,0 +1,2 @@
+[target.wasm32-unknown-unknown]
+rustflags = ["--cfg", "getrandom_backend=\"wasm_js\""]

.github/workflows/main.yml

@@ -0,0 +1,55 @@
+name: Rust
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  rust:
+    name: Build, lint, test
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ ubuntu-latest, windows-latest, macos-latest ]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install stable toolchain
+        uses: dtolnay/rust-toolchain@1.90.0
+        with:
+          components: rustfmt, clippy
+
+      - name: Install nextest
+        uses: taiki-e/install-action@nextest
+
+      - name: Check max line length
+        # rustfmt gives up on lines that are too long
+        if: runner.os == 'Linux'
+        run: "! grep -rP '^.{101}' --include='*.rs' ."
+
+      - name: Run fmt
+        run: cargo fmt --all -- --check
+
+      - name: Build documentation
+        run: cargo doc --no-deps --workspace --document-private-items
+        env:
+          RUSTDOCFLAGS: -D warnings
+
+      - name: Run clippy
+        run: cargo clippy --all-targets -- -D warnings
+
+      - name: Run tests
+        run: cargo nextest run --no-fail-fast --all-targets
+
+        # doctests are special [^1] but this step does not incur a performance penalty [^2]
+        #
+        # [^1]: https://nexte.st/book/usage.html#limitations
+        # [^2]: https://github.com/nextest-rs/nextest/issues/16
+      - name: Run documentation tests
+        run: cargo test --doc

.github/workflows/wasm.yml

@@ -0,0 +1,38 @@
+name: WASM
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  wasm:
+    name: Build, lint, test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install stable toolchain
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          targets: wasm32-unknown-unknown
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v6
+        with:
+          node-version: '20'
+
+      - name: Install wasm-pack
+        uses: taiki-e/install-action@v2
+        with:
+          tool: wasm-pack
+
+      - name: Build with wasm-pack
+        run: wasm-pack build --release --target nodejs
+
+      - name: Run wasm-pack tests
+        run: wasm-pack test --node

.gitignore

@@ -1,2 +1,41 @@
-/target
-/Cargo.lock
+### Intellij ###
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+.idea/
+.idea_modules/
+
+# Generated by Cargo
+# will have compiled files and executables
+debug/
+target/
+
+# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
+# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
+Cargo.lock
+
+# These are backup files generated by rustfmt
+**/*.rs.bk
+
+# MSVC Windows builds of rustc generate these, which store debugging information
+*.pdb
+
+### VisualStudioCode ###
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+!.vscode/*.code-snippets
+
+# Local History for Visual Studio Code
+.history/
+
+# Built Visual Studio Code Extensions
+*.vsix
+
+### VisualStudioCode Patch ###
+# Ignore all local history of files
+.history
+.ionide
+
+# End of https://www.toptal.com/developers/gitignore/api/intellij,visualstudiocode,rust

Cargo.toml

@@ -1,13 +1,35 @@
 [package]
-name = "proptest-arbitrary-interop"
-description = "Interop glue between arbitrary and proptest crates"
-authors = ["Graydon Hoare <graydon@pobox.com>"]
+name = "proptest-arbitrary-adapter"
 version = "0.1.0"
-edition = "2021"
-license = "MIT OR Apache-2.0"
-keywords = ["property", "propcheck", "arbitrary", "fuzz", "testing"]
+authors = ["Graydon Hoare <graydon@pobox.com>", "Triton Software AG"]
+edition = "2024"
+description = "Make `arbitrary` interoperate with `proptest`."
+documentation = "https://docs.rs/crate/proptest-arbitrary-adapter/latest"
 readme = "README.md"
+repository = "https://github.com/Neptune-Crypto/proptest-arbitrary-adapter"
+license = "MIT OR Apache-2.0"
+keywords = ["proptest", "arbitrary", "property", "fuzz", "testing"]
+categories = ["development-tools::testing"]
+
+[lib]
+crate-type = ["cdylib", "rlib"]
 
 [dependencies]
+arbitrary = "1.0.0"
+
+[target.'cfg(not(target_arch = "wasm32"))'.dependencies]
 proptest = "1.0.0"
-arbitrary = "1.1.3"
+
+[target.'cfg(target_arch = "wasm32")'.dependencies]
+proptest = { version = "1.0.0", default-features = false, features = ["std"] }
+getrandom = { version = "0.3", features = ["wasm_js"] } # note: there is also a flag in .cargo/config.toml
+
+[dev-dependencies]
+arbitrary = { version = "1.0.0", features = ["derive"] }
+test-strategy = "0.4"
+
+[target.'cfg(target_arch = "wasm32")'.dev-dependencies]
+wasm-bindgen-test = "0.3.42"
+
+[lints.rust]
+unexpected_cfgs = { level = "warn", check-cfg = ['cfg(coverage_nightly)'] }

README.md

@@ -1,75 +1,36 @@
-# proptest-arbitrary-interop
+# proptest-arbitrary-adapter
 
-This crate provides the necessary glue to reuse an implementation of
-[`arbitrary::Arbitrary`] as a [`proptest::strategy::Strategy`].
+Provides the necessary glue to reuse an implementation of [`arbitrary::Arbitrary`][arbitrary] as a
+[`proptest::strategy::Strategy`][strategy].
 
-## Usage
+[arbitrary]: https://docs.rs/arbitrary/1.0.0/arbitrary/trait.Arbitrary.html
 
-in `Cargo.toml`:
+[strategy]: https://docs.rs/proptest/1.0.0/proptest/strategy/trait.Strategy.html
 
-```toml
-[dependencies]
-arbitrary = "1.1.3"
-proptest  = "1.0.0"
-```
+## Usage
 
-In your code:
+Assuming you use [`test-strategy`](https://crates.io/crates/test-strategy) (which you should), using a strategy for a
+type that implements `arbitrary::Arbitrary` is as simple as:
 
 ```rust
-
-// Part 1: suppose you implement Arbitrary for one of your types
-// because you want to fuzz it.
-
-use arbitrary::{Arbitrary, Result, Unstructured};
-#[derive(Copy, Clone, Debug)]
-pub struct Rgb {
-    pub r: u8,
-    pub g: u8,
-    pub b: u8,
-}
-impl<'a> Arbitrary<'a> for Rgb {
-    fn arbitrary(u: &mut Unstructured<'a>) -> Result<Self> {
-        let r = u8::arbitrary(u)?;
-        let g = u8::arbitrary(u)?;
-        let b = u8::arbitrary(u)?;
-        Ok(Rgb { r, g, b })
-    }
+#[proptest]
+fn my_test(#[strategy(arb())] my_type: MyType) {
+    // …
 }
+```
 
-// Part 2: suppose you later decide that in addition to fuzzing
-// you want to use that Arbitrary impl, but with proptest.
+## Origin
 
-use proptest::prelude::*;
-use proptest_arbitrary_interop::arb;
+This code is a copy of the unmaintained crate [`proptest-arbitrary-interop`][origin], with some additional improvements
+from open pull requests of the original's repository.
 
-proptest! {
-    #[test]
-    #[should_panic]
-    fn always_red(color in arb::<Rgb>()) {
-        prop_assert!(color.g == 0 || color.r > color.g);
-    }
-}
-```
+[origin]: https://crates.io/crates/proptest-arbitrary-interop
 
 ## Caveats
 
-It only works with types that implement [`arbitrary::Arbitrary`] in a
-particular fashion: those conforming to the requirements of [`ArbInterop`].
-These are roughly "types that, when randomly-generated, don't retain
-pointers into the random-data buffer wrapped by the
-[`arbitrary::Unstructured`] they are generated from". Many implementations
-of [`arbitrary::Arbitrary`] will fit the bill, but certain kinds of
-"zero-copy" implementations of [`arbitrary::Arbitrary`] will not work. This
-requirement appears to be a necessary part of the semantic model of
-[`proptest`] -- generated values have to own their pointer graph, no
-borrows. Patches welcome if you can figure out a way to not require it.
-
-This crate is based on
-[`proptest-quickcheck-interop`](https://crates.io/crates/proptest-quickcheck-interop)
-by Mazdak Farrokhzad, without whose work I wouldn't have had a clue how to
-approach this. The exact type signatures for the [`ArbInterop`] type are
-courtesy of Jim Blandy, who I hereby officially designate for-all-time as
-the Rust Puzzle King. Any errors I've introduced along the way are, of
-course, my own.
-
-License: MIT OR Apache-2.0
+It only works with types that implement `arbitrary::Arbitrary` in a particular fashion: those conforming to the
+requirements of `ArbInterop`. These are roughly "types that, when randomly-generated, don't retain pointers into the
+random-data buffer wrapped by the `arbitrary::Unstructured` they are generated from". Many implementations of
+`arbitrary::Arbitrary` will fit the bill, but certain kinds of "zero-copy" implementations of `arbitrary::Arbitrary`
+will not work. This requirement appears to be a necessary part of the semantic model of `proptest` – generated values
+have to own their pointer graph, no borrows. Patches welcome if you can figure out a way to not require it.