feat: add clear_all and confetti

Add support for ray!().clear_all() and ray!().confetti

Author: ALameLlama

.github/workflows/publish.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     timeout-minutes: 10
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: bp3d-actions/audit-check@9c23bd47e5e7b15b824739e0862cb878a52cc211
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
@@ -20,7 +20,7 @@ jobs:
     runs-on: ubuntu-latest
     timeout-minutes: 10
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: dtolnay/rust-toolchain@stable
 
       - uses: taiki-e/install-action@nextest
@@ -35,7 +35,7 @@ jobs:
       - name: Prepare symlink configuration
         run: git config --global core.symlinks true
 
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: dtolnay/rust-toolchain@stable
 
       - uses: taiki-e/install-action@nextest
@@ -52,7 +52,7 @@ jobs:
     runs-on: ubuntu-latest
     timeout-minutes: 25
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: dtolnay/rust-toolchain@stable
 
       - name: cargo-release Cache

Cargo.toml

@@ -5,6 +5,7 @@ edition = "2021"
 authors = ["ALameLlama NicholasACiechanowski@gmail.com"]
 description = "Spatie Ray in Rust"
 homepage = "https://github.com/ALameLlama/ray-rust"
+readme = "README.md"
 repository = "https://github.com/ALameLlama/ray-rust"
 license = "MIT"
 keywords = ["spatie", "ray", "debug"]

README.md

@@ -1,2 +1,26 @@
 # ray-rust
-# ray-rust
+
+This is currently WIP and still missing features but has basic ray debugging.
+
+## Examples
+
+```rust
+use ray_rust::*
+
+fn main() {
+    ray!("Hello World");
+
+    ray!("Hello World!").color("green");
+
+    ray!().html("<strong>Hello World! 🦀</strong>");
+}
+```
+
+## Installation
+
+Add this to your `Cargo.toml`:
+
+```toml
+[dependencies]
+ray-rust = "0.1"
+```

src/lib.rs

@@ -27,6 +27,27 @@ macro_rules! ray {
     }};
 }
 
+#[macro_export]
+macro_rules! rd {
+    () => {{
+        Ray::new()
+
+        todo!("Need to add die");
+    }};
+    ($($arg:expr),*) => {{
+        let mut ray = Ray::new();
+        let mut vec = Vec::new();
+
+        $(vec.push(format!("{:#?}", $arg));)*
+
+        ray.log(vec);
+
+        ray
+
+        todo!("Need to add die");
+    }};
+}
+
 #[derive(Debug, Serialize, Deserialize, Clone)]
 pub struct RayPayload {
     uuid: String,
@@ -116,6 +137,22 @@ impl Ray {
         self
     }
 
+    pub fn clear_all(&mut self) -> &mut Self {
+        let message = RayMessage::ClearAll(RayClearAll {
+            label: RayMessageType::ClearAll,
+        });
+
+        let content = RayContent {
+            content_type: RayClearAll::get_type(),
+            origin: RayOrigin::new(),
+            content: message,
+        };
+
+        self.request.payloads.push(content);
+
+        self.send()
+    }
+
     pub fn log(&mut self, values: Vec<String>) -> &mut Self {
         let message = RayMessage::Log(RayLog {
             label: RayMessageType::Log,
@@ -182,4 +219,170 @@ impl Ray {
 
         self.send()
     }
+
+    pub fn confetti(&mut self) -> &mut Self {
+        let message = RayMessage::Confetti(RayConfetti {
+            label: RayMessageType::Confetti,
+        });
+
+        let content = RayContent {
+            content_type: RayConfetti::get_type(),
+            origin: RayOrigin::new(),
+            content: message,
+        };
+
+        self.request.payloads.push(content);
+
+        self.send()
+    }
+
+    pub fn count(&mut self) -> &mut Self {
+        todo!();
+    }
+
+    pub fn counter_value(&mut self) -> &mut Self {
+        todo!();
+    }
+
+    pub fn die(&mut self) -> &mut Self {
+        todo!();
+    }
+
+    pub fn disable(&mut self) -> &mut Self {
+        todo!();
+    }
+
+    pub fn disabled(&mut self) -> &mut Self {
+        todo!();
+    }
+
+    pub fn enable(&mut self) -> &mut Self {
+        todo!();
+    }
+
+    pub fn enabled(&mut self) -> &mut Self {
+        todo!();
+    }
+
+    pub fn file(&mut self) -> &mut Self {
+        todo!();
+    }
+
+    pub fn gray(&mut self) -> &mut Self {
+        todo!();
+    }
+
+    pub fn green(&mut self) -> &mut Self {
+        todo!();
+    }
+
+    pub fn hide(&mut self) -> &mut Self {
+        todo!();
+    }
+
+    pub fn hide_app(&mut self) -> &mut Self {
+        todo!();
+    }
+
+    pub fn image(&mut self) -> &mut Self {
+        todo!();
+    }
+
+    // I'm not sure if this is possible in Rust
+    pub fn r#if(&mut self) -> &mut Self {
+        todo!();
+    }
+
+    pub fn json(&mut self) -> &mut Self {
+        todo!();
+    }
+
+    pub fn label(&mut self) -> &mut Self {
+        todo!();
+    }
+
+    pub fn large(&mut self) -> &mut Self {
+        todo!();
+    }
+
+    pub fn limit(&mut self) -> &mut Self {
+        todo!();
+    }
+
+    pub fn link(&mut self) -> &mut Self {
+        todo!();
+    }
+
+    pub fn measure(&mut self) -> &mut Self {
+        todo!();
+    }
+
+    pub fn new_screen(&mut self) -> &mut Self {
+        todo!();
+    }
+
+    pub fn notify(&mut self) -> &mut Self {
+        todo!();
+    }
+
+    pub fn orange(&mut self) -> &mut Self {
+        todo!();
+    }
+
+    pub fn pass(&mut self) -> &mut Self {
+        todo!();
+    }
+
+    pub fn pause(&mut self) -> &mut Self {
+        todo!();
+    }
+
+    pub fn info(&mut self) -> &mut Self {
+        todo!();
+    }
+
+    pub fn purple(&mut self) -> &mut Self {
+        todo!();
+    }
+
+    // TODO: This has 3 functions max, per_second and clear
+    pub fn rate_limiter(&mut self) -> &mut Self {
+        todo!();
+    }
+
+    pub fn red(&mut self) -> &mut Self {
+        todo!();
+    }
+
+    pub fn separator(&mut self) -> &mut Self {
+        todo!();
+    }
+
+    pub fn show_app(&mut self) -> &mut Self {
+        todo!();
+    }
+
+    pub fn small(&mut self) -> &mut Self {
+        todo!();
+    }
+
+    pub fn table(&mut self) -> &mut Self {
+        todo!();
+    }
+
+    pub fn to_json(&mut self) -> &mut Self {
+        todo!();
+    }
+
+    pub fn trace(&mut self) -> &mut Self {
+        todo!();
+    }
+
+    pub fn url(&mut self) -> &mut Self {
+        todo!();
+    }
+
+    pub fn xml(&mut self) -> &mut Self {
+        todo!();
+    }
 }

src/message.rs

@@ -7,28 +7,36 @@ pub enum RayMessage {
     Text(RayText),
     Color(RayColor),
     HTML(RayHtml),
+    ClearAll(RayClearAll),
+    Confetti(RayConfetti),
 }
 
 #[derive(Debug, Serialize, Deserialize, Clone)]
 pub enum RayMessageType {
     Log,
     Text,
     HTML,
+    ClearAll,
+    Confetti,
 }
 
 #[derive(Debug, Serialize, Deserialize, Clone)]
 pub enum RayContentType {
     Log,
     Custom,
     Color,
+    ClearAll,
+    Confetti,
 }
 
 impl RayContentType {
-    pub fn as_string(&self) -> String {
+    pub fn to_string(&self) -> String {
         match self {
             RayContentType::Log => "log".to_string(),
             RayContentType::Custom => "custom".to_string(),
             RayContentType::Color => "color".to_string(),
+            RayContentType::ClearAll => "clear_all".to_string(),
+            RayContentType::Confetti => "confetti".to_string(),
         }
     }
 }
@@ -42,7 +50,7 @@ pub struct RayLog {
 
 impl RayLog {
     pub fn get_type() -> String {
-        RayContentType::Log.as_string()
+        RayContentType::Log.to_string()
     }
 }
 
@@ -55,7 +63,7 @@ pub struct RayText {
 
 impl RayText {
     pub fn get_type() -> String {
-        RayContentType::Custom.as_string()
+        RayContentType::Custom.to_string()
     }
 }
 
@@ -67,7 +75,7 @@ pub struct RayColor {
 
 impl RayColor {
     pub fn get_type() -> String {
-        RayContentType::Color.as_string()
+        RayContentType::Color.to_string()
     }
 }
 
@@ -106,6 +114,30 @@ pub struct RayHtml {
 
 impl RayHtml {
     pub fn get_type() -> String {
-        RayContentType::Custom.as_string()
+        RayContentType::Custom.to_string()
+    }
+}
+
+// https://github.com/spatie/ray/blob/main/src/Payloads/ClearAllPayload.php
+#[derive(Debug, Serialize, Deserialize, Clone)]
+pub struct RayClearAll {
+    pub label: RayMessageType,
+}
+
+impl RayClearAll {
+    pub fn get_type() -> String {
+        RayContentType::ClearAll.to_string()
+    }
+}
+
+// https://github.com/spatie/ray/blob/main/src/Payloads/ConfettiPayload.php
+#[derive(Debug, Serialize, Deserialize, Clone)]
+pub struct RayConfetti {
+    pub label: RayMessageType,
+}
+
+impl RayConfetti {
+    pub fn get_type() -> String {
+        RayContentType::Confetti.to_string()
     }
 }