Added Reactive trait, bumped to 0.6.0

Author: sfisol

CHANGES.md

@@ -1,10 +1,11 @@
 <!-- markdownlint-configure-file { "no-duplicate-heading": { "siblings_only": true } } -->
 
 <!-- markdownlint-disable-next-line first-line-h1 -->
-## Unreleased
+## 0.6.0 Unreleased
 
 ### Added
 
+* `Reactive` trait that allows generic components to be more flexible with props
 * `BTreeMap` and `chrono::DateTime<Utc>` support in `AutoJsJson`
 * `#[js_json(default = "None")]` attribute to `AutoJsJson`
 * All http methods in `FetchMethod`

crates/vertigo-cli/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "vertigo-cli"
-version = "0.5.0"
+version = "0.6.0"
 authors = ["Grzegorz Szeliga <szeligagrzegorz@gmail.com>", "Michał Pokrywka <wolfmoon@o2.pl>"]
 description = "Reactive Real-DOM library with SSR for Rust - packaging/serving tool"
 categories = ["command-line-utilities", "development-tools", "development-tools::build-utils", "wasm", "web-programming"]
@@ -39,4 +39,4 @@ tokio-stream = "0.1"
 tower-http = { version = "0.4", features = ["fs"] }
 tokio-retry = "0.3"
 wasmtime = "19.0"
-vertigo = { path = "../vertigo", version = "0.5.0" }
+vertigo = { path = "../vertigo", version = "0.6.0" }

crates/vertigo-macro/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "vertigo-macro"
-version = "0.5.0"
+version = "0.6.0"
 authors = ["Grzegorz Szeliga <szeligagrzegorz@gmail.com>", "Michał Pokrywka <wolfmoon@o2.pl>"]
 description = "Reactive Real-DOM library with SSR for Rust - macros"
 edition = "2021"

crates/vertigo/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "vertigo"
-version = "0.5.0"
+version = "0.6.0"
 authors = ["Grzegorz Szeliga <szeligagrzegorz@gmail.com>", "Michał Pokrywka <wolfmoon@o2.pl>"]
 description = "Reactive Real-DOM library with SSR for Rust"
 readme = "README.md"
@@ -15,4 +15,4 @@ edition = "2021"
 [dependencies]
 chrono = { version = "0.4", default-features = false, features = ["std"], optional = true }
 log = { version = "0.4", features = ["std"] }
-vertigo-macro = { path = "../../crates/vertigo-macro", version = "0.5.0" }
+vertigo-macro = { path = "../../crates/vertigo-macro", version = "0.6.0" }

crates/vertigo/src/computed/mod.rs

@@ -5,6 +5,7 @@ mod dependencies;
 mod drop_resource;
 mod graph_id;
 mod graph_value;
+mod reactive;
 pub mod struct_mut;
 mod value;
 
@@ -17,6 +18,7 @@ pub use dependencies::Dependencies;
 pub use drop_resource::DropResource;
 pub use graph_id::GraphId;
 pub use graph_value::GraphValue;
+pub use reactive::Reactive;
 pub use value::Value;
 
 /// Allows to create `Computed<T1, T2, ...>` out of `Value<T1>`, `Value<T2>`, ...

crates/vertigo/src/computed/reactive.rs

@@ -0,0 +1,100 @@
+use crate::{Context, Value};
+
+/// A trait that tells `Something<T>` is behaving like a [`Value<T>`].
+///
+/// Generic components should accept [`Reactive<T>`] instead of [`Value<T>`] to be more flexible,
+/// so that types wrapping a Value can implement Reactive and be used in those components.
+///
+/// Automatically implemented for the [Value] itself.
+///
+/// Example:
+///
+/// ```rust
+/// use vertigo::{component, EmbedDom, Computed, Context, dom, DomNode, Reactive, Value, transaction};
+///
+/// // Define reactive object with `Value` wrapped
+/// #[derive(Clone, PartialEq)]
+/// struct Lisper {
+///     inner: Value<String>
+/// }
+///
+/// // Implement `EmbedDom` so it can be easily rendered
+/// impl EmbedDom for Lisper {
+///     fn embed(self) -> DomNode {
+///         self.inner.embed()
+///     }
+/// }
+///
+/// // Implement `Reactive`
+/// impl Reactive<String> for Lisper {
+///     fn set(&self, val: String) {
+///         let lisp = val.replace('r', "w");
+///         self.inner.set(lisp)
+///     }
+///
+///     fn get(&self, ctx: &Context) -> std::string::String {
+///         self.inner.get(ctx)
+///     }
+///
+///     fn change(&self, change_fn: impl FnOnce(&mut String)) {
+///         self.inner.change(|val| {
+///             change_fn(val);
+///             *val = val.replace('r', "w");
+///         });
+///     }
+/// }
+///
+/// // Exemplary generic component
+/// #[component]
+/// fn Print<R>(saying: R)
+/// where
+///    R: Reactive<String> + EmbedDom
+/// {
+///     dom! {
+///         <quote>{saying}</quote>
+///     }
+/// }
+///
+/// // Create reactive object
+/// let lisper = Lisper {
+///     inner: Value::new("".to_string())
+/// };
+///
+/// // Specialize Print component
+/// type PrintL = Print::<Lisper>;
+///
+/// // Use reactive object in generic component
+/// let _ = dom! {
+///     <div>
+///         <PrintL saying={lisper.clone()} />
+///     </div>
+/// };
+///
+/// lisper.set("Eating raisins and radishes".to_string());
+///
+/// transaction(|context| {
+///     assert_eq!(lisper.get(context), "Eating waisins and wadishes");
+/// })
+/// ```
+pub trait Reactive<T>: PartialEq {
+    fn set(&self, value: T);
+    fn get(&self, context: &Context) -> T;
+    fn change(&self, change_fn: impl FnOnce(&mut T));
+}
+
+impl<T> Reactive<T> for Value<T>
+where
+    T: Clone + PartialEq + 'static
+{
+    fn set(&self, value: T) {
+        Value::set(self, value)
+    }
+
+    fn get(&self, context: &Context) -> T {
+        Value::get(self, context)
+    }
+
+    fn change(&self, change_fn: impl FnOnce(&mut T)) {
+        Value::change(self, change_fn)
+    }
+}

crates/vertigo/src/computed/value.rs

@@ -64,7 +64,7 @@ impl<T: PartialEq> PartialEq for Value<T> {
 }
 
 impl<T: Clone + 'static> Value<T> {
-    pub fn new(value: T) -> Value<T> {
+    pub fn new(value: T) -> Self {
         let deps = get_driver().inner.dependencies;
         Value {
             inner: Rc::new(ValueInner {

crates/vertigo/src/driver_module/src_js/index.ts

@@ -2,7 +2,7 @@ import { WasmModule } from "./wasm_module";
 
 // vertigo-cli compatibility version, change together with package version.
 const VERTIGO_COMPAT_VERSION_MAJOR = 0;
-const VERTIGO_COMPAT_VERSION_MINOR = 5;
+const VERTIGO_COMPAT_VERSION_MINOR = 6;
 
 const moduleRun: Set<string> = new Set();
 

crates/vertigo/src/driver_module/wasm_run.js

@@ -1978,7 +1978,7 @@ class WasmModule {
 
 // vertigo-cli compatibility version, change together with package version.
 const VERTIGO_COMPAT_VERSION_MAJOR = 0;
-const VERTIGO_COMPAT_VERSION_MINOR = 5;
+const VERTIGO_COMPAT_VERSION_MINOR = 6;
 const moduleRun = new Set();
 const runModule = async (wasm) => {
     if (moduleRun.has(wasm)) {

crates/vertigo/src/lib.rs

@@ -116,7 +116,7 @@ mod websocket;
 use computed::struct_mut::ValueMut;
 
 pub use computed::{
-    context::Context, struct_mut, AutoMap, Computed, Dependencies, DropResource, GraphId,
+    context::Context, struct_mut, AutoMap, Computed, Dependencies, DropResource, GraphId, Reactive,
     ToComputed, Value,
 };
 

crates/vertigo/src/router.rs

@@ -1,9 +1,9 @@
-use crate::{computed::Value, get_driver, Computed};
+use crate::{computed::Value, get_driver, Computed, DomNode, EmbedDom, Reactive, ToComputed};
 
 /// Router based on hash part of current location.
 ///
 /// ```rust
-/// use vertigo::{dom, Computed, Value, DomNode};
+/// use vertigo::{dom, Computed, Reactive, Value, DomNode};
 /// use vertigo::router::Router;
 ///
 /// #[derive(Clone, PartialEq, Debug)]
@@ -115,4 +115,38 @@ impl<T: Clone + ToString + From<String> + PartialEq + 'static> Router<T> {
             true => driver.inner.api.push_history_location(&route.to_string()),
         };
     }
+
+    fn change(&self, change_fn: impl FnOnce(&mut T)) {
+        get_driver().inner.dependencies.transaction(|ctx| {
+            let mut value = self.get(ctx);
+            change_fn(&mut value);
+            self.set(value);
+        });
+    }
+}
+
+impl<T: Clone + PartialEq + ToString + From<String>> Reactive<T> for Router<T> {
+    fn set(&self, value: T) {
+        Router::set(self, value)
+    }
+
+    fn get(&self, context: &crate::Context) -> T {
+        self.route.get(context)
+    }
+
+    fn change(&self, change_fn: impl FnOnce(&mut T)) {
+        Router::change(self, change_fn)
+    }
+}
+
+impl<T: Clone + PartialEq + ToString + From<String>> ToComputed<T> for Router<T> {
+    fn to_computed(&self) -> Computed<T> {
+        self.route.to_computed()
+    }
+}
+
+impl<T: Clone + PartialEq + ToString + From<String>> EmbedDom for Router<T> {
+    fn embed(self) -> DomNode {
+        self.route.embed()
+    }
 }

demo/app/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "vertigo-demo"
-version = "0.5.0"
+version = "0.6.0"
 authors = ["Grzegorz Szeliga <szeligagrzegorz@gmail.com>", "Michał Pokrywka <wolfmoon@o2.pl>"]
 edition = "2021"
 
@@ -9,4 +9,4 @@ crate-type = ["cdylib", "rlib"]
 
 [dependencies]
 log = "0.4.17"
-vertigo = { path = "../../crates/vertigo", version = "0.5.0" }
+vertigo = { path = "../../crates/vertigo", version = "0.6.0" }

examples/counter/Cargo.toml

@@ -1,11 +1,11 @@
 [package]
 name = "vertigo-example-counter"
-version = "0.5.0"
+version = "0.6.0"
 authors = ["Grzegorz Szeliga <szeligagrzegorz@gmail.com>", "Michał Pokrywka <wolfmoon@o2.pl>"]
 edition = "2021"
 
 [lib]
 crate-type = ["cdylib", "rlib"]
 
 [dependencies]
-vertigo = { path = "../../crates/vertigo", version = "0.5.0" }
+vertigo = { path = "../../crates/vertigo", version = "0.6.0" }

examples/router/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "vertigo-example-router"
-version = "0.5.0"
+version = "0.6.0"
 authors = ["Grzegorz Szeliga <szeligagrzegorz@gmail.com>", "Michał Pokrywka <wolfmoon@o2.pl>"]
 edition = "2021"
 
@@ -9,4 +9,4 @@ crate-type = ["cdylib", "rlib"]
 
 [dependencies]
 log = "0.4.14"
-vertigo = { path = "../../crates/vertigo", version = "0.5.0" }
+vertigo = { path = "../../crates/vertigo", version = "0.6.0" }

examples/trafficlights/Cargo.toml

@@ -1,11 +1,11 @@
 [package]
 name = "vertigo-example-trafficlights"
-version = "0.5.0"
+version = "0.6.0"
 authors = ["Grzegorz Szeliga <szeligagrzegorz@gmail.com>", "Michał Pokrywka <wolfmoon@o2.pl>"]
 edition = "2021"
 
 [lib]
 crate-type = ["cdylib", "rlib"]
 
 [dependencies]
-vertigo = { path = "../../crates/vertigo", version = "0.5.0" }
+vertigo = { path = "../../crates/vertigo", version = "0.6.0" }

tutorial.md

@@ -2,7 +2,7 @@
 <!-- markdownlint-disable no-inline-html -->
 
 <!-- markdownlint-disable-next-line no-emphasis-as-heading -->
-*Up to date with version 0.5.0*
+*Up to date with version 0.6.0*
 
 <!-- markdownlint-disable-next-line heading-increment -->
 ### Table of contents