Get rid of once_cell crate

- bump up MSRV to 1.80
cucumber-rs · Jul 26, 2024 · 4010c1a · 4010c1a
1 parent a5daa52
commit 4010c1a
Show file tree

Hide file tree

Showing 49 changed files with 209 additions and 178 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -106,7 +106,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        msrv: ["1.75.0"]
+        msrv: ["1.80.0"]
         crate:
           - cucumber-codegen
           - cucumber

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,20 @@ All user visible changes to `cucumber` crate will be documented in this file. Th
 
 
 
+## [0.22.0] · 2024-??-?? (unreleased)
+[0.22.0]: /../../tree/v0.22.0
+
+[Diff](/../../compare/v0.21.1...v0.22.0) | [Milestone](/../../milestone/28)
+
+### BC Breaks
+
+- Bumped up [MSRV] to 1.80 to get rid of `once_cell` crate. ([todo])
+
+[todo]: /../../commit/todo-full
+
+
+
+
 ## [0.21.1] · 2024-06-16
 [0.21.1]: /../../tree/v0.21.1
 

diff --git a/Cargo.toml b/Cargo.toml
@@ -2,7 +2,7 @@
 name = "cucumber"
 version = "0.21.1"
 edition = "2021"
-rust-version = "1.75"
+rust-version = "1.80"
 description = """\
     Cucumber testing framework for Rust, with async support. \
     Fully native, no external test runners or dependencies.\
@@ -73,11 +73,9 @@ gherkin = "0.14"
 globwalk = "0.9"
 humantime = "2.1"
 itertools = "0.13"
-lazy-regex = "3.0"
 linked-hash-map = "0.5.3"
-once_cell = "1.13"
 pin-project = "1.0"
-regex = "1.5.5"
+regex = "1.9"
 sealed = "0.5"
 smart-default = "0.7.1"
 

diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@ Cucumber testing framework for Rust
 ===================================
 
 [![crates.io](https://img.shields.io/crates/v/cucumber.svg?maxAge=2592000 "crates.io")](https://crates.io/crates/cucumber)
-[![Rust 1.75+](https://img.shields.io/badge/rustc-1.75+-lightgray.svg "Rust 1.75")](https://blog.rust-lang.org/2023/12/28/Rust-1.75.0.html)
+[![Rust 1.80+](https://img.shields.io/badge/rustc-1.80+-lightgray.svg "Rust 1.80")](https://blog.rust-lang.org/2024/07/25/Rust-1.80.0.html)
 [![Unsafe Forbidden](https://img.shields.io/badge/unsafe-forbidden-success.svg "Unsafe forbidden")](https://github.com/rust-secure-code/safety-dance)  
 [![CI](https://github.com/cucumber-rs/cucumber/workflows/CI/badge.svg?branch=main "CI")](https://github.com/cucumber-rs/cucumber/actions?query=workflow%3ACI+branch%3Amain)
 [![Rust docs](https://docs.rs/cucumber/badge.svg "Rust docs")](https://docs.rs/cucumber)

diff --git a/book/src/architecture/runner.md b/book/src/architecture/runner.md
@@ -8,13 +8,12 @@ Now, let's implement a custom [`Runner`] which simply executes [scenario]s in [f
 ```rust
 # extern crate cucumber;
 # extern crate futures;
-# extern crate once_cell;
 # extern crate tokio;
 #
 # use std::{
 #     panic::{self, AssertUnwindSafe},
 #     path::PathBuf,
-#     sync::Arc,
+#     sync::{Arc, LazyLock},
 #     time::Duration,
 # };
 #
@@ -25,7 +24,6 @@ Now, let's implement a custom [`Runner`] which simply executes [scenario]s in [f
 #     future::{self, FutureExt as _},
 #     stream::{self, LocalBoxStream, Stream, StreamExt as _, TryStreamExt as _},
 # };
-# use once_cell::sync::Lazy;
 # use tokio::time::sleep;
 #
 # #[derive(Clone, Copy, Debug, Default)]
@@ -135,8 +133,8 @@ struct CustomRunner;
 impl CustomRunner {
     fn steps_fns() -> &'static step::Collection<AnimalWorld> {
         // Wire the static collection of step matching functions.
-        static STEPS: Lazy<step::Collection<AnimalWorld>> =
-            Lazy::new(AnimalWorld::collection);
+        static STEPS: LazyLock<step::Collection<AnimalWorld>> =
+            LazyLock::new(AnimalWorld::collection);
         &STEPS
     }
 

diff --git a/book/src/architecture/writer.md b/book/src/architecture/writer.md
@@ -8,13 +8,12 @@ Finally, let's implement a custom [`Writer`] which simply outputs [cucumber even
 ```rust
 # extern crate cucumber;
 # extern crate futures;
-# extern crate once_cell;
 # extern crate tokio;
 #
 # use std::{
 #     panic::{self, AssertUnwindSafe},
 #     path::PathBuf,
-#     sync::Arc,
+#     sync::{Arc, LazyLock},
 #     time::Duration,
 # };
 #
@@ -26,7 +25,6 @@ Finally, let's implement a custom [`Writer`] which simply outputs [cucumber even
 #     future::{self, FutureExt as _},
 #     stream::{self, LocalBoxStream, Stream, StreamExt as _, TryStreamExt as _},
 # };
-# use once_cell::sync::Lazy;
 # use tokio::time::sleep;
 #
 # #[derive(Clone, Copy, Debug, Default)]
@@ -135,8 +133,8 @@ Finally, let's implement a custom [`Writer`] which simply outputs [cucumber even
 #
 # impl CustomRunner {
 #     fn steps_fns() -> &'static step::Collection<AnimalWorld> {
-#         static STEPS: Lazy<step::Collection<AnimalWorld>> =
-#             Lazy::new(AnimalWorld::collection);
+#         static STEPS: LazyLock<step::Collection<AnimalWorld>> =
+#             LazyLock::new(AnimalWorld::collection);
 #         &STEPS
 #     }
 #

diff --git a/codegen/CHANGELOG.md b/codegen/CHANGELOG.md
@@ -6,6 +6,20 @@ All user visible changes to `cucumber-codegen` crate will be documented in this
 
 
 
+## [0.22.0] · 2024-??-?? (unreleased)
+[0.22.0]: /../../tree/v0.22.0/codegen
+
+[Milestone](/../../milestone/28)
+
+### BC Breaks
+
+- Bumped up [MSRV] to 1.80 to get rid of `once_cell` crate. ([todo])
+
+[todo]: /../../commit/todo-full
+
+
+
+
 ## [0.21.1] · 2024-06-16
 [0.21.1]: /../../tree/v0.21.1/codegen
 

diff --git a/codegen/Cargo.toml b/codegen/Cargo.toml
@@ -2,7 +2,7 @@
 name = "cucumber-codegen"
 version = "0.21.1" # should be the same as main crate version
 edition = "2021"
-rust-version = "1.75"
+rust-version = "1.80"
 description = "Code generation for `cucumber` crate."
 license = "MIT OR Apache-2.0"
 authors = [

diff --git a/codegen/README.md b/codegen/README.md
@@ -2,7 +2,7 @@
 ========================
 
 [![crates.io](https://img.shields.io/crates/v/cucumber-codegen.svg?maxAge=2592000 "crates.io")](https://crates.io/crates/cucumber-codegen)
-[![Rust 1.75+](https://img.shields.io/badge/rustc-1.75+-lightgray.svg "Rust 1.75")](https://blog.rust-lang.org/2023/12/28/Rust-1.75.0.html)
+[![Rust 1.80+](https://img.shields.io/badge/rustc-1.80+-lightgray.svg "Rust 1.80")](https://blog.rust-lang.org/2024/07/25/Rust-1.80.0.html)
 [![Unsafe Forbidden](https://img.shields.io/badge/unsafe-forbidden-success.svg "Unsafe forbidden")](https://github.com/rust-secure-code/safety-dance)  
 [![CI](https://github.com/cucumber-rs/cucumber/workflows/CI/badge.svg?branch=main "CI")](https://github.com/cucumber-rs/cucumber/actions?query=workflow%3ACI+branch%3Amain)
 [![Rust docs](https://docs.rs/cucumber-codegen/badge.svg "Rust docs")](https://docs.rs/cucumber-codegen)

diff --git a/codegen/src/attribute.rs b/codegen/src/attribute.rs
@@ -135,9 +135,9 @@ impl Step {
                         column: ::std::column!(),
                     },
                     regex: || {
-                        static LAZY: ::cucumber::codegen::Lazy<
+                        static LAZY: ::std::sync::LazyLock<
                             ::cucumber::codegen::Regex
-                        > = ::cucumber::codegen::Lazy::new(|| { #regex });
+                        > = ::std::sync::LazyLock::new(|| { #regex });
                         LAZY.clone()
                     },
                     func: |__cucumber_world, __cucumber_ctx| {

diff --git a/src/codegen.rs b/src/codegen.rs
@@ -22,7 +22,6 @@ pub use cucumber_expressions::{
 };
 pub use futures::future::LocalBoxFuture;
 pub use inventory::{self, collect, submit};
-pub use once_cell::sync::Lazy;
 pub use regex::Regex;
 
 /// [`World`] extension allowing to register steps in [`inventory`].
@@ -43,7 +42,7 @@ pub trait WorldInventory: World {
     type Then: inventory::Collect + StepConstructor<Self>;
 }
 
-/// Alias for a [`fn`] returning a [`Lazy`] [`Regex`].
+/// Alias for a [`fn`] returning a [`Regex`].
 pub type LazyRegex = fn() -> Regex;
 
 /// Trait for registering a [`Step`] with [`given`], [`when`] and [`then`]

diff --git a/src/feature.rs b/src/feature.rs
@@ -13,11 +13,10 @@
 use std::{
     iter, mem,
     path::{Path, PathBuf},
+    sync::LazyLock,
 };
 
 use derive_more::{Display, Error};
-use lazy_regex::regex;
-use once_cell::sync::Lazy;
 use regex::Regex;
 use sealed::sealed;
 
@@ -144,7 +143,11 @@ fn expand_scenario(
     /// [`Regex`] matching placeholders [`Examples`] should expand into.
     ///
     /// [`Examples`]: gherkin::Examples
-    static TEMPLATE_REGEX: &Lazy<Regex> = regex!(r"<([^>\s]+)>");
+    // TODO: Switch back to `lazy-regex::regex!()` once it migrates to `std`:
+    //       https://github.com/Canop/lazy-regex/issues/10
+    #[allow(clippy::unwrap_used)] // never panics
+    static TEMPLATE_REGEX: LazyLock<Regex> =
+        LazyLock::new(|| Regex::new(r"<([^>\s]+)>").unwrap());
 
     if scenario.examples.is_empty() {
         return vec![Ok(scenario)];

diff --git a/src/lib.rs b/src/lib.rs
@@ -225,11 +225,10 @@ pub use self::{
 /// across [scenarios][0], because we want some friction there to avoid tests
 /// being dependent on each other. If your workflow needs a way to share state
 /// between [scenarios][0] (ex. database connection pool), we recommend using
-/// [`once_cell`][1] crate or organize it other way via [shared state][2].
+/// a [`std::sync::LazyLock`] or organize it other way via [shared state][1].
 ///
 /// [0]: https://cucumber.io/docs/gherkin/reference#descriptions
-/// [1]: https://docs.rs/once_cell
-/// [2]: https://doc.rust-lang.org/book/ch16-03-shared-state.html
+/// [1]: https://doc.rust-lang.org/book/ch16-03-shared-state.html
 /// [Cucumber]: https://cucumber.io
 pub trait World: Sized + 'static {
     /// Error of creating a new [`World`] instance.

diff --git a/src/writer/basic.rs b/src/writer/basic.rs
@@ -16,11 +16,11 @@ use std::{
     fmt::{Debug, Display},
     io,
     str::FromStr,
+    sync::LazyLock,
 };
 
 use derive_more::{Deref, DerefMut};
 use itertools::Itertools as _;
-use once_cell::sync::Lazy;
 use regex::CaptureLocations;
 use smart_default::SmartDefault;
 
@@ -1123,7 +1123,7 @@ where
 /// Trims start of the path if it matches the current project directory.
 pub(crate) fn trim_path(path: &str) -> &str {
     /// Path of the current project directory.
-    static CURRENT_DIR: Lazy<String> = Lazy::new(|| {
+    static CURRENT_DIR: LazyLock<String> = LazyLock::new(|| {
         env::var("CARGO_WORKSPACE_DIR")
             .or_else(|_| env::var("CARGO_MANIFEST_DIR"))
             .unwrap_or_else(|_| {

diff --git a/src/writer/json.rs b/src/writer/json.rs
@@ -15,14 +15,14 @@
 use std::{
     fmt::{self, Debug},
     io, mem,
+    sync::LazyLock,
     time::SystemTime,
 };
 
 use base64::Engine as _;
 use derive_more::Display;
 use inflector::Inflector as _;
 use mime::Mime;
-use once_cell::sync::Lazy;
 use serde::{Serialize, Serializer};
 
 use crate::{
@@ -448,7 +448,7 @@ impl Embedding {
     /// Creates [`Embedding`] from the provided [`event::Scenario::Log`].
     fn from_log(msg: impl AsRef<str>) -> Self {
         /// [`Mime`] of the [`event::Scenario::Log`] [`Embedding`].
-        static LOG_MIME: Lazy<Mime> = Lazy::new(|| {
+        static LOG_MIME: LazyLock<Mime> = LazyLock::new(|| {
             "text/x.cucumber.log+plain"
                 .parse()
                 .unwrap_or_else(|_| unreachable!("valid MIME"))