Bench via criterion and codspeed

.github/workflows/ci.yml

@@ -191,3 +191,24 @@ jobs:
           version: latest
           args: --all-targets --all-features
 
+  benchmarks:
+    name: Test performance on benchmarks
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup rust toolchain, cache and cargo-codspeed binary
+        uses: moonrepo/setup-rust@v0
+        with:
+          channel: stable
+          cache-target: release
+          bins: cargo-codspeed
+
+      - name: Build the benchmark target(s)
+        run: cargo codspeed build
+
+      - name: Run the benchmarks
+        uses: CodSpeedHQ/action@v2
+        with:
+          run: cargo codspeed run
+          token: ${{ secrets.CODSPEED_TOKEN }}

Cargo.toml

@@ -15,4 +15,13 @@ nom-span = "0.1.1"
 thiserror = "1.0.50"
 
 [dev-dependencies]
+codspeed-criterion-compat = "2.3.3"
+criterion = "0.3"
 pretty_assertions_sorted = "1.2.3"
+
+[[bench]]
+name = "simple_parse"
+harness = false
+
+[package.metadata.cargo-udeps.ignore]
+development = ["criterion"]

benches/simple_parse.rs

@@ -0,0 +1,13 @@
+use asciidoc_parser::Document;
+use codspeed_criterion_compat::{black_box, criterion_group, criterion_main, Criterion};
+
+const TWO_BLOCKS_AND_TITLE: &str = "= Example Title\n\nabc\n\ndef";
+
+pub fn two_blocks_and_title(c: &mut Criterion) {
+    c.bench_function("2 blocks + title", |b| {
+        b.iter(|| Document::parse(black_box(TWO_BLOCKS_AND_TITLE)))
+    });
+}
+
+criterion_group!(benches, two_blocks_and_title);
+criterion_main!(benches);

deny.toml

@@ -9,6 +9,7 @@ targets = [
     { triple = "x86_64-pc-windows-msvc" },
     { triple = "aarch64-apple-darwin" },
 ]
+exclude-dev = true
 
 # Deny all advisories unless explicitly ignored.
 [advisories]

src/lib.rs

@@ -9,6 +9,7 @@
 pub mod blocks;
 
 pub mod document;
+pub use document::Document;
 
 mod error;
 pub use error::{Error, ParseResult};