From 8f1968d5063d5691a9d2c278e106cd381dd15cf4 Mon Sep 17 00:00:00 2001
From: Nico Burniske <46934294+nicoburniske@users.noreply.github.com>
Date: Fri, 12 Apr 2024 13:12:25 -0400
Subject: [PATCH] Global Override OnceLock (#21)

* attempt global override with compile time env value

* set_tw_options OnceLock

* Remove unused .cargo/config.toml

* fix doc test

* fix clippy error, use copied

* improved docs

* update readme

* small readme update

* remove prefix from example

* example fixes

* fix broken doc link

* remove inline annotation
---
 README.md                         |  29 ++++++++
 example/start-axum/Cargo.lock     |  68 ++++++------------
 example/start-axum/Cargo.toml     |   4 +-
 example/start-axum/src/app.rs     |   2 +-
 example/start-axum/src/button.rs  |  22 +++---
 example/start-axum/src/lib.rs     |   3 +-
 fuse/src/core/join.rs             |   2 +-
 fuse/src/core/merge/config.rs     |  50 +++++++++++++
 fuse/src/core/merge/merge_impl.rs |   2 +-
 fuse/src/core/merge/mod.rs        | 114 ++++++++++++++----------------
 fuse/src/core/mod.rs              |   2 +-
 fuse/src/lib.rs                   |  31 +++++++-
 fuse/tests/override.rs            |   8 +--
 13 files changed, 205 insertions(+), 132 deletions(-)
 create mode 100644 fuse/src/core/merge/config.rs

diff --git a/README.md b/README.md
index 698fe7d..a47b57f 100644
--- a/README.md
+++ b/README.md
@@ -69,6 +69,35 @@ assert_eq!(
 )
 ```
 
+### Custom Tailwind Prefix/Separator
+
+Use [`merge::set_merge_options`] to set global options for [`tw_merge!`] and variant macros.
+
+This can only be set once. Subsequent calls will be ignored.
+
+```rust
+use tailwind_fuse::{*, merge::*};
+
+const OPTIONS: MergeOptions = MergeOptions {
+    prefix: "tw-",
+    separator: ":",
+};
+
+// Before setting options, the default (no prefix) is used
+assert_eq!(
+  "tw-bg-black tw-bg-white",
+  tw_merge!("tw-bg-black", "tw-bg-white"),
+);
+
+set_merge_options(OPTIONS);
+
+assert_eq!(
+  "tw-bg-white",
+  tw_merge!("tw-bg-black", "tw-bg-white"),
+);
+
+```
+
 
 ## Usage: Variants
 
diff --git a/example/start-axum/Cargo.lock b/example/start-axum/Cargo.lock
index 543db79..dd1ddf4 100644
--- a/example/start-axum/Cargo.lock
+++ b/example/start-axum/Cargo.lock
@@ -1979,11 +1979,20 @@ checksum = "2047c6ded9c721764247e62cd3b03c09ffc529b2ba5b10ec482ae507a4a70160"
 
 [[package]]
 name = "tailwind_fuse"
-version = "0.1.0"
+version = "0.2.0"
 dependencies = [
- "tw_fuse",
- "tw_utils",
- "tw_variant_macro",
+ "nom",
+ "tailwind_fuse_macro",
+]
+
+[[package]]
+name = "tailwind_fuse_macro"
+version = "0.2.0"
+dependencies = [
+ "darling 0.20.8",
+ "proc-macro2",
+ "quote",
+ "syn 2.0.52",
 ]
 
 [[package]]
@@ -2190,37 +2199,6 @@ dependencies = [
  "once_cell",
 ]
 
-[[package]]
-name = "tw_ast"
-version = "0.1.0"
-dependencies = [
- "nom",
-]
-
-[[package]]
-name = "tw_fuse"
-version = "0.1.0"
-dependencies = [
- "nom",
- "tw_ast",
-]
-
-[[package]]
-name = "tw_utils"
-version = "0.1.0"
-
-[[package]]
-name = "tw_variant_macro"
-version = "0.1.0"
-dependencies = [
- "darling 0.20.8",
- "proc-macro2",
- "quote",
- "syn 2.0.52",
- "tw_fuse",
- "tw_utils",
-]
-
 [[package]]
 name = "typed-builder"
 version = "0.18.1"
@@ -2333,9 +2311,9 @@ checksum = "9c8d87e72b64a3b4db28d11ce29237c246188f4f51057d65a7eab63b7987e423"
 
 [[package]]
 name = "wasm-bindgen"
-version = "0.2.89"
+version = "0.2.92"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "0ed0d4f68a3015cc185aff4db9506a015f4b96f95303897bfa23f846db54064e"
+checksum = "4be2531df63900aeb2bca0daaaddec08491ee64ceecbee5076636a3b026795a8"
 dependencies = [
  "cfg-if",
  "wasm-bindgen-macro",
@@ -2343,9 +2321,9 @@ dependencies = [
 
 [[package]]
 name = "wasm-bindgen-backend"
-version = "0.2.89"
+version = "0.2.92"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "1b56f625e64f3a1084ded111c4d5f477df9f8c92df113852fa5a374dbda78826"
+checksum = "614d787b966d3989fa7bb98a654e369c762374fd3213d212cfc0251257e747da"
 dependencies = [
  "bumpalo",
  "log",
@@ -2370,9 +2348,9 @@ dependencies = [
 
 [[package]]
 name = "wasm-bindgen-macro"
-version = "0.2.89"
+version = "0.2.92"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "0162dbf37223cd2afce98f3d0785506dcb8d266223983e4b5b525859e6e182b2"
+checksum = "a1f8823de937b71b9460c0c34e25f3da88250760bec0ebac694b49997550d726"
 dependencies = [
  "quote",
  "wasm-bindgen-macro-support",
@@ -2380,9 +2358,9 @@ dependencies = [
 
 [[package]]
 name = "wasm-bindgen-macro-support"
-version = "0.2.89"
+version = "0.2.92"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "f0eb82fcb7930ae6219a7ecfd55b217f5f0893484b7a13022ebb2b2bf20b5283"
+checksum = "e94f17b526d0a461a191c78ea52bbce64071ed5c04c9ffe424dcb38f74171bb7"
 dependencies = [
  "proc-macro2",
  "quote",
@@ -2393,9 +2371,9 @@ dependencies = [
 
 [[package]]
 name = "wasm-bindgen-shared"
-version = "0.2.89"
+version = "0.2.92"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "7ab9b36309365056cd639da3134bf87fa8f3d86008abf99e612384a6eecd459f"
+checksum = "af190c94f2773fdb3729c55b007a722abb5384da03bc0986df4c289bf5567e96"
 
 [[package]]
 name = "wasm-streams"
diff --git a/example/start-axum/Cargo.toml b/example/start-axum/Cargo.toml
index ef61136..588b5df 100644
--- a/example/start-axum/Cargo.toml
+++ b/example/start-axum/Cargo.toml
@@ -16,11 +16,11 @@ leptos_router = { version = "0.6", features = ["nightly"] }
 tokio = { version = "1", features = ["rt-multi-thread"], optional = true }
 tower = { version = "0.4", optional = true }
 tower-http = { version = "0.5", features = ["fs"], optional = true }
-wasm-bindgen = "=0.2.89"
+wasm-bindgen = "=0.2.92"
 thiserror = "1"
 tracing = { version = "0.1", optional = true }
 http = "1"
-tailwind_fuse = { path = "../../public", features = ["variant"]}
+tailwind_fuse = { path = "../../fuse", features = ["variant", "debug"]}
 
 [features]
 hydrate = ["leptos/hydrate", "leptos_meta/hydrate", "leptos_router/hydrate"]
diff --git a/example/start-axum/src/app.rs b/example/start-axum/src/app.rs
index 4ea583f..b415cb9 100644
--- a/example/start-axum/src/app.rs
+++ b/example/start-axum/src/app.rs
@@ -40,7 +40,7 @@ fn HomePage() -> impl IntoView {
     let on_click = move |_| set_count.update(|count| *count += 1);
 
     view! {
-        <div class="flex items-center gap-4 p-10">
+        <div class="flex items-center gap-4 p-10 flex-row">
             <Button on:click=on_click size=BtnSize::Lg>
                 "Click Me: "
                 {count}
diff --git a/example/start-axum/src/button.rs b/example/start-axum/src/button.rs
index 2b49e65..bd53b5f 100644
--- a/example/start-axum/src/button.rs
+++ b/example/start-axum/src/button.rs
@@ -3,20 +3,18 @@ use tailwind_fuse::*;
 
 #[component]
 pub fn Button(
-    #[prop(into, optional)] size: Option<BtnSize>,
-    #[prop(into, optional)] variant: Option<BtnVariant>,
-    #[prop(into, optional)] class: Option<String>,
-    /// Arbitrary additional attributes.
-    #[prop(attrs)]
-    attributes: Vec<(&'static str, Attribute)>,
+    #[prop(into, optional)] variant: MaybeSignal<BtnVariant>,
+    #[prop(into, optional)] size: MaybeSignal<BtnSize>,
+    #[prop(into, optional)] class: MaybeSignal<String>,
+    #[prop(attrs)] attributes: Vec<(&'static str, Attribute)>,
     children: Children,
 ) -> impl IntoView {
-    let btn = Btn {
-        size: size.unwrap_or_default(),
-        variant: variant.unwrap_or_default(),
-    };
-
-    let class = class.map_or(btn.to_class(), |c| btn.with_class(c));
+    let class = create_memo(move |_| {
+        let variant = variant.get();
+        let size = size.get();
+        let button = Btn { variant, size };
+        button.with_class(class.get())
+    });
 
     view! {
         <button {..attributes} class=class>
diff --git a/example/start-axum/src/lib.rs b/example/start-axum/src/lib.rs
index 8342bd1..c5968dc 100644
--- a/example/start-axum/src/lib.rs
+++ b/example/start-axum/src/lib.rs
@@ -7,7 +7,6 @@ pub mod fileserv;
 #[cfg(feature = "hydrate")]
 #[wasm_bindgen::prelude::wasm_bindgen]
 pub fn hydrate() {
-    use crate::app::*;
     console_error_panic_hook::set_once();
-    leptos::mount_to_body(App);
+    leptos::mount_to_body(crate::app::App);
 }
diff --git a/fuse/src/core/join.rs b/fuse/src/core/join.rs
index 892479c..d0e6268 100644
--- a/fuse/src/core/join.rs
+++ b/fuse/src/core/join.rs
@@ -1,6 +1,6 @@
 /// Joins the given classes into a single string.
 ///
-/// Items can be of type &[`str`] or [`String`].
+/// Items can be anything that implements [`crate::AsTailwindClass`].
 ///
 /// If you want to handle conflicts use [`crate::tw_merge!`].
 ///
diff --git a/fuse/src/core/merge/config.rs b/fuse/src/core/merge/config.rs
new file mode 100644
index 0000000..de95f3a
--- /dev/null
+++ b/fuse/src/core/merge/config.rs
@@ -0,0 +1,50 @@
+use std::sync::OnceLock;
+
+/// Configuration for merging Tailwind classes.
+/// If you want to set global options use [`set_merge_options`].
+#[derive(Clone, Copy, Debug)]
+pub struct MergeOptions {
+    /// Custom prefix for modifiers in Tailwind classes
+    ///
+    /// Default is empty string
+    ///
+    /// <https://tailwindcss.com/docs/configuration#prefix>
+    pub prefix: &'static str,
+    /// Custom separator for modifiers in Tailwind classes
+    ///
+    /// Default is `:`
+    ///
+    /// <https://tailwindcss.com/docs/configuration#separator>
+    pub separator: &'static str,
+}
+
+impl Default for MergeOptions {
+    fn default() -> Self {
+        MERGE_OVERRIDE
+            .get()
+            .copied()
+            .unwrap_or(DEFAULT_MERGE_OPTIONS)
+    }
+}
+
+const DEFAULT_MERGE_OPTIONS: MergeOptions = MergeOptions {
+    prefix: "",
+    separator: ":",
+};
+
+impl From<MergeOptions> for crate::ast::AstParseOptions<'static> {
+    fn from(options: MergeOptions) -> Self {
+        crate::ast::AstParseOptions {
+            prefix: options.prefix,
+            separator: options.separator,
+        }
+    }
+}
+
+pub(crate) static MERGE_OVERRIDE: OnceLock<MergeOptions> = OnceLock::new();
+
+/// Set global options for merging Tailwind classes.
+/// Useful for getting all the macros to work with custom options.
+pub fn set_merge_options(options: MergeOptions) {
+    let _ = MERGE_OVERRIDE.set(options);
+}
diff --git a/fuse/src/core/merge/merge_impl.rs b/fuse/src/core/merge/merge_impl.rs
index 144d4eb..f0bba9d 100644
--- a/fuse/src/core/merge/merge_impl.rs
+++ b/fuse/src/core/merge/merge_impl.rs
@@ -7,7 +7,7 @@ use crate::core::merge::get_collisions::get_collisions;
 
 /// Merges all the Tailwind classes, resolving conflicts.
 /// Can supply custom options, collision_id_fn and collisions_fn.
-pub fn tw_merge_with_override(
+pub fn tw_merge_override(
     class: &[&str],
     options: MergeOptions,
     collision_id_fn: impl CollisionIdFn,
diff --git a/fuse/src/core/merge/mod.rs b/fuse/src/core/merge/mod.rs
index d1c1d61..71fe129 100644
--- a/fuse/src/core/merge/mod.rs
+++ b/fuse/src/core/merge/mod.rs
@@ -1,16 +1,20 @@
-mod get_collision_id;
+pub(crate) mod config;
+pub(crate) mod get_collision_id;
 pub(crate) mod get_collisions;
 pub(crate) mod merge_impl;
-mod validators;
+pub(crate) mod validators;
 
-pub use merge_impl::tw_merge_with_override;
+pub use config::*;
+pub use merge_impl::tw_merge_override;
 
 /// Merges all the Tailwind classes, resolving conflicts.
 ///
-/// Items can be of type &[`str`], [`String`], [`Option<&str>`] or [`Option<String>`].
+/// Items can be anything that implements [`crate::AsTailwindClass`].
 ///
 /// If you DON'T want to handle conflicts use [`crate::tw_join!`].
 ///
+/// If you want to set global options use [`crate::merge::set_merge_options`].
+///
 /// If you want a custom type to be used with this macro, implement the [`crate::MaybeIntoTailwindClass`] trait.
 #[macro_export]
 macro_rules! tw_merge {
@@ -20,9 +24,21 @@ macro_rules! tw_merge {
     }};
 }
 
-/// Merges all the Tailwind classes, resolving conflicts.
+/// Merges all the Tailwind classes in the string, resolving conflicts.
+///
+/// If you need custom options use [`tw_merge_options`].
+#[inline]
 pub fn tw_merge(class: impl AsRef<str>) -> String {
-    tw_merge_slice(&[class.as_ref()])
+    tw_merge_slice_options(&[class.as_ref()], Default::default())
+}
+
+/// Merges all the Tailwind classes in the provided strings, resolving conflicts.
+/// Useful to avoid collecting all the strings into a single string.
+///
+/// If you need custom options use [`tw_merge_slice_options`].
+#[inline]
+pub fn tw_merge_slice(class: &[&str]) -> String {
+    tw_merge_slice_options(class, Default::default())
 }
 
 /// Merges all the Tailwind classes, resolving conflicts, with the provided options.
@@ -37,73 +53,47 @@ pub fn tw_merge(class: impl AsRef<str>) -> String {
 /// };
 ///
 /// pub fn my_custom_tw_merge(class: impl AsRef<str>) -> String {
-///    tw_merge_with_options(class, OPTIONS)
+///    tw_merge_options(class, OPTIONS)
 /// }
 /// ```
-pub fn tw_merge_with_options(class: impl AsRef<str>, options: MergeOptions) -> String {
-    merge_impl::tw_merge_with_override(
+#[inline]
+pub fn tw_merge_options(class: impl AsRef<str>, options: MergeOptions) -> String {
+    merge_impl::tw_merge_override(
         &[class.as_ref()],
         options,
-        noop_collision_id_fn,
-        noop_collision_fn,
+        |_: &[&str], _: Option<&str>| None,
+        |_: &str| None,
     )
 }
 
-/// Merges all the Tailwind classes, resolving conflicts.
-pub fn tw_merge_slice(class: &[&str]) -> String {
-    merge_impl::tw_merge_with_override(
+/// Merges all the Tailwind classes in the provided strings, resolving conflicts.
+/// Useful to avoid collecting all the strings into a single string.
+///
+/// If you don't need custom options use [`tw_merge_slice`].
+///
+/// ## Example: With Tailwind Prefix
+///
+/// ```
+/// # use tailwind_fuse::merge::*;
+/// const OPTIONS: MergeOptions = MergeOptions {
+///   prefix: "tw-",
+///   separator: ":",
+/// };
+///
+/// pub fn my_custom_tw_merge(class: &[&str]) -> String {
+///    tw_merge_slice_options(class, OPTIONS)
+/// }
+/// ```
+#[inline]
+pub fn tw_merge_slice_options(class: &[&str], options: MergeOptions) -> String {
+    merge_impl::tw_merge_override(
         class,
-        Default::default(),
-        noop_collision_id_fn,
-        noop_collision_fn,
+        options,
+        |_: &[&str], _: Option<&str>| None,
+        |_: &str| None,
     )
 }
 
-fn noop_collision_id_fn(_: &[&str], _: Option<&str>) -> Option<&'static str> {
-    None
-}
-
-fn noop_collision_fn(_: &str) -> Option<Vec<&'static str>> {
-    None
-}
-
-/// Configuration for merging Tailwind classes.
-#[derive(Clone, Copy, Debug)]
-pub struct MergeOptions {
-    /// Custom prefix for modifiers in Tailwind classes
-    ///
-    /// Default is empty string
-    ///
-    /// <https://tailwindcss.com/docs/configuration#prefix>
-    pub prefix: &'static str,
-    /// Custom separator for modifiers in Tailwind classes
-    ///
-    /// Default is `:`
-    ///
-    /// <https://tailwindcss.com/docs/configuration#separator>
-    pub separator: &'static str,
-}
-
-impl Default for MergeOptions {
-    fn default() -> Self {
-        DEFAULT_OPTIONS
-    }
-}
-
-const DEFAULT_OPTIONS: MergeOptions = MergeOptions {
-    prefix: "",
-    separator: ":",
-};
-
-impl From<MergeOptions> for crate::ast::AstParseOptions<'static> {
-    fn from(options: MergeOptions) -> Self {
-        crate::ast::AstParseOptions {
-            prefix: options.prefix,
-            separator: options.separator,
-        }
-    }
-}
-
 /// Return a ConflictId for a given Tailwind Class.
 pub trait CollisionIdFn {
     /// elements: parts of the Tailwind class separated by `-`.
diff --git a/fuse/src/core/mod.rs b/fuse/src/core/mod.rs
index d810dd5..b92e0bc 100644
--- a/fuse/src/core/mod.rs
+++ b/fuse/src/core/mod.rs
@@ -1,4 +1,4 @@
-pub(crate) mod join;
+mod join;
 
 /// Merges all the Tailwind classes, resolving conflicts.
 pub mod merge;
diff --git a/fuse/src/lib.rs b/fuse/src/lib.rs
index 49a214a..1f7f424 100644
--- a/fuse/src/lib.rs
+++ b/fuse/src/lib.rs
@@ -69,6 +69,35 @@
 //! )
 //! ```
 //!
+//! ### Custom Tailwind Prefix/Separator
+//!
+//! Use [`merge::set_merge_options`] to set global options for [`tw_merge!`] and variant macros.
+//!
+//! This can only be set once. Subsequent calls will be ignored.
+//!
+//! ```
+//! use tailwind_fuse::{*, merge::*};
+//!
+//! const OPTIONS: MergeOptions = MergeOptions {
+//!     prefix: "tw-",
+//!     separator: ":",
+//! };
+//!
+//! // Before setting options, the default (no prefix) is used
+//! assert_eq!(
+//!   "tw-bg-black tw-bg-white",
+//!   tw_merge!("tw-bg-black", "tw-bg-white"),
+//! );
+//!
+//! set_merge_options(OPTIONS);
+//!
+//! assert_eq!(
+//!   "tw-bg-white",
+//!   tw_merge!("tw-bg-black", "tw-bg-white"),
+//! );
+//!
+//! ```
+//!
 //!
 //! ## Usage: Variants
 //!
@@ -249,7 +278,7 @@ mod variant {
         fn fuse_classes(&self, class: &[&str]) -> String;
     }
 
-    /// Will merge Tailwind classes and handle conflicts using [`tw_merge()`]
+    /// Will merge Tailwind classes and handle conflicts using [`crate::merge::tw_merge_slice`]
     pub struct TailwindMerge;
 
     impl TailwindFuse for TailwindMerge {
diff --git a/fuse/tests/override.rs b/fuse/tests/override.rs
index b72d769..f092b1b 100644
--- a/fuse/tests/override.rs
+++ b/fuse/tests/override.rs
@@ -1,9 +1,9 @@
-use tailwind_fuse::merge::{tw_merge_with_options, tw_merge_with_override, MergeOptions};
+use tailwind_fuse::merge::{tw_merge_options, tw_merge_override, MergeOptions};
 
 #[test]
 fn test_collisions() {
     pub fn tw_merge(class: &str) -> String {
-        tw_merge_with_override(
+        tw_merge_override(
             &[class],
             Default::default(),
             collision_id_fn,
@@ -47,11 +47,11 @@ fn test_override_config() {
     };
 
     let class = "hover|lg|tw-bg-blue-100 hover|lg|tw-bg-red-500";
-    let result = tw_merge_with_options(class, config);
+    let result = tw_merge_options(class, config);
     assert_eq!("hover|lg|tw-bg-red-500", result);
 
     let class = "tw-bg-blue-100 bg-red-500";
-    let result = tw_merge_with_options(class, config);
+    let result = tw_merge_options(class, config);
     assert_eq!(
         class, result,
         "No conflict because non-prefix is not considered tailwind class"