feat: WIP

Cargo.lock

@@ -345,6 +345,18 @@ dependencies = [
  "winnow",
 ]
 
+[[package]]
+name = "console"
+version = "0.15.11"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "054ccb5b10f9f2cbf51eb355ca1d05c2d279ce1804688d0db74b4733a5aeafd8"
+dependencies = [
+ "encode_unicode",
+ "libc",
+ "once_cell",
+ "windows-sys 0.59.0",
+]
+
 [[package]]
 name = "core-foundation"
 version = "0.9.4"
@@ -455,6 +467,12 @@ dependencies = [
  "embedded-hal",
 ]
 
+[[package]]
+name = "encode_unicode"
+version = "1.0.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "34aa73646ffb006b8f5147f3dc182bd4bcb190227ce861fc4a4844bf8e3cb2c0"
+
 [[package]]
 name = "env_home"
 version = "0.1.0"
@@ -969,6 +987,17 @@ dependencies = [
  "serde",
 ]
 
+[[package]]
+name = "insta"
+version = "1.43.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "46fdb647ebde000f43b5b53f773c30cf9b0cb4300453208713fa38b2c70935a0"
+dependencies = [
+ "console",
+ "once_cell",
+ "similar",
+]
+
 [[package]]
 name = "inventory"
 version = "0.3.21"
@@ -1816,6 +1845,14 @@ dependencies = [
  "serde",
 ]
 
+[[package]]
+name = "serde_luacats"
+version = "0.1.0"
+dependencies = [
+ "insta",
+ "serde",
+]
+
 [[package]]
 name = "serde_path_to_error"
 version = "0.1.17"
@@ -1873,6 +1910,12 @@ version = "1.3.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "0fda2ff0d084019ba4d7c6f371c95d8fd75ce3524c3cb8fb653a3023f6323e64"
 
+[[package]]
+name = "similar"
+version = "2.7.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "bbbb5d9659141646ae647b42fe094daf6c6192d1620870b449d9557f748b2daa"
+
 [[package]]
 name = "slab"
 version = "0.4.11"

Cargo.toml

@@ -10,7 +10,7 @@ members = [
   "automation_lib",
   "automation_macro",
   "google_home/google_home",
-  "google_home/google_home_macro",
+  "google_home/google_home_macro", "serde_luacats",
 ]
 
 [workspace.dependencies]

config.lua

@@ -2,17 +2,21 @@ local devices = require("automation:devices")
 local device_manager = require("automation:device_manager")
 local utils = require("automation:utils")
 local secrets = require("automation:secrets")
-local debug = require("automation:variables").debug or false
+local debug = require("automation:variables").debug and true or false
 
 print(_VERSION)
 
 local host = utils.get_hostname()
 print("Running @" .. host)
 
+--- @param topic string
+--- @return string
 local function mqtt_z2m(topic)
 	return "zigbee2mqtt/" .. topic
 end
 
+--- @param topic string
+--- @return string
 local function mqtt_automation(topic)
 	return "automation/" .. topic
 end

definitions/automation:devices.lua

@@ -0,0 +1,40 @@
+---@meta
+
+local devices
+
+---@class Action
+---@field action "broadcast"
+---@field extras table<string, string> | nil
+---@field label string | nil
+---@clear clear bool|nil
+
+---@alias Priority
+---| "min"
+---| "low"
+---| "default"
+---| "high"
+---| "max"
+
+---@class Notification
+---@field title string
+---@field message string | nil
+-- NOTE: It might be possible to specify this down to the actual possible values
+---@field tags string[] | nil
+---@field priority Priority | nil
+---@field actions Action[] | nil
+
+---@class Ntfy
+local Ntfy
+---@async
+---@param notification Notification
+function Ntfy:send_notification(notification) end
+
+---@class NtfyConfig
+---@field topic string
+
+devices.Ntfy = {}
+---@param config NtfyConfig
+---@return Ntfy
+function devices.Ntfy.new(config) end
+
+return devices

definitions/automation:secrets.lua

@@ -0,0 +1,6 @@
+---@meta
+
+---@type table<string, string|nil>
+local secrets
+
+return secrets

definitions/automation:utils.lua

@@ -0,0 +1,27 @@
+---@meta
+
+local utils
+
+---@class Timeout
+local Timeout
+---@async
+---@param timeout number
+---@param callback fun()
+function Timeout:start(timeout, callback) end
+---@async
+function Timeout:cancel() end
+---@async
+---@return boolean
+function Timeout:is_waiting() end
+
+utils.Timeout = {}
+---@return Timeout
+function utils.Timeout.new() end
+
+--- @return string hostname
+function utils.get_hostname() end
+
+--- @return number epoch
+function utils.get_epoch() end
+
+return utils

definitions/automation:variables.lua

@@ -0,0 +1,6 @@
+---@meta
+
+---@type table<string, string|nil>
+local variables
+
+return variables

serde_luacats/Cargo.toml

@@ -0,0 +1,8 @@
+[package]
+name = "serde_luacats"
+version = "0.1.0"
+edition = "2024"
+
+[dependencies]
+insta = "1.43.2"
+serde = { workspace = true }

serde_luacats/src/.ser.rs.pending-snap

@@ -0,0 +1,4 @@
+{"run_id":"1757770490-872092575","line":386,"new":{"module_name":"serde_luacats__ser","snapshot_name":"test","metadata":{"source":"serde_luacats/src/ser.rs","assertion_line":386,"expression":"to_string(&test).unwrap()"},"snapshot":"---@class Test\n---@field int integer\n---@field text string\n---@field other ---@class Other\n---@field cool bool"},"old":{"module_name":"serde_luacats__ser","metadata":{},"snapshot":"---@class Test\n---@field int integer\n---@field text string"}}
+{"run_id":"1757770536-381047902","line":386,"new":{"module_name":"serde_luacats__ser","snapshot_name":"test","metadata":{"source":"serde_luacats/src/ser.rs","assertion_line":386,"expression":"to_string(&test).unwrap()"},"snapshot":"---@class Test\n---@field int integer\n---@field text string\n---@field test nil"},"old":{"module_name":"serde_luacats__ser","metadata":{},"snapshot":"---@class Test\n---@field int integer\n---@field text string"}}
+{"run_id":"1757770547-700188086","line":386,"new":{"module_name":"serde_luacats__ser","snapshot_name":"test","metadata":{"source":"serde_luacats/src/ser.rs","assertion_line":386,"expression":"to_string(&test).unwrap()"},"snapshot":"---@class Test\n---@field int integer\n---@field text string\n---@field test bool"},"old":{"module_name":"serde_luacats__ser","metadata":{},"snapshot":"---@class Test\n---@field int integer\n---@field text string"}}
+{"run_id":"1757770652-863230562","line":389,"new":{"module_name":"serde_luacats__ser","snapshot_name":"test","metadata":{"source":"serde_luacats/src/ser.rs","assertion_line":389,"expression":"to_string(&test).unwrap()"},"snapshot":"---@class Test\n---@field int integer\n---@field text string\n---@field test bool|nil"},"old":{"module_name":"serde_luacats__ser","metadata":{},"snapshot":"---@class Test\n---@field int integer\n---@field text string"}}

serde_luacats/src/error.rs

@@ -0,0 +1,26 @@
+use std::fmt::{self, Display};
+
+use serde::ser;
+
+pub type Result<T> = std::result::Result<T, Error>;
+
+#[derive(Debug)]
+pub enum Error {
+    Message(String),
+}
+
+impl ser::Error for Error {
+    fn custom<T: Display>(msg: T) -> Self {
+        Self::Message(msg.to_string())
+    }
+}
+
+impl Display for Error {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        match self {
+            Error::Message(msg) => f.write_str(msg),
+        }
+    }
+}
+
+impl std::error::Error for Error {}

serde_luacats/src/lib.rs

@@ -0,0 +1,5 @@
+mod error;
+mod ser;
+
+pub use error::{Error, Result};
+// pub use ser::{Serializer, to_string};

serde_luacats/src/ser.rs

@@ -0,0 +1,394 @@
+use serde::{Serialize, ser};
+
+use crate::error::{Error, Result};
+
+pub struct Serializer {
+    output: String,
+}
+
+pub fn to_string<T: Serialize>(value: &T) -> Result<String> {
+    let mut serializer = Serializer {
+        output: String::new(),
+    };
+
+    value.serialize(&mut serializer)?;
+
+    Ok(serializer.output)
+}
+
+impl<'a> ser::Serializer for &'a mut Serializer {
+    type Ok = ();
+
+    type Error = Error;
+
+    type SerializeSeq = Self;
+    type SerializeTuple = Self;
+    type SerializeTupleStruct = Self;
+    type SerializeTupleVariant = Self;
+    type SerializeMap = Self;
+    type SerializeStruct = Self;
+    type SerializeStructVariant = Self;
+
+    fn serialize_bool(self, v: bool) -> std::result::Result<Self::Ok, Self::Error> {
+        self.output += "bool";
+
+        Ok(())
+    }
+
+    fn serialize_i8(self, v: i8) -> std::result::Result<Self::Ok, Self::Error> {
+        self.output += "integer";
+
+        Ok(())
+    }
+
+    fn serialize_i16(self, v: i16) -> std::result::Result<Self::Ok, Self::Error> {
+        self.output += "integer";
+
+        Ok(())
+    }
+
+    fn serialize_i32(self, v: i32) -> std::result::Result<Self::Ok, Self::Error> {
+        self.output += "integer";
+
+        Ok(())
+    }
+
+    fn serialize_i64(self, v: i64) -> std::result::Result<Self::Ok, Self::Error> {
+        self.output += "integer";
+
+        Ok(())
+    }
+
+    fn serialize_u8(self, v: u8) -> std::result::Result<Self::Ok, Self::Error> {
+        self.output += "integer";
+
+        Ok(())
+    }
+
+    fn serialize_u16(self, v: u16) -> std::result::Result<Self::Ok, Self::Error> {
+        self.output += "integer";
+
+        Ok(())
+    }
+
+    fn serialize_u32(self, v: u32) -> std::result::Result<Self::Ok, Self::Error> {
+        self.output += "integer";
+
+        Ok(())
+    }
+
+    fn serialize_u64(self, v: u64) -> std::result::Result<Self::Ok, Self::Error> {
+        self.output += "integer";
+
+        Ok(())
+    }
+
+    fn serialize_f32(self, v: f32) -> std::result::Result<Self::Ok, Self::Error> {
+        self.output += "number";
+
+        Ok(())
+    }
+
+    fn serialize_f64(self, v: f64) -> std::result::Result<Self::Ok, Self::Error> {
+        self.output += "number";
+
+        Ok(())
+    }
+
+    fn serialize_char(self, v: char) -> std::result::Result<Self::Ok, Self::Error> {
+        todo!()
+    }
+
+    fn serialize_str(self, v: &str) -> std::result::Result<Self::Ok, Self::Error> {
+        self.output += "string";
+
+        Ok(())
+    }
+
+    fn serialize_bytes(self, v: &[u8]) -> std::result::Result<Self::Ok, Self::Error> {
+        todo!()
+    }
+
+    fn serialize_none(self) -> std::result::Result<Self::Ok, Self::Error> {
+        self.output += "nil";
+
+        Ok(())
+    }
+
+    fn serialize_some<T>(self, value: &T) -> std::result::Result<Self::Ok, Self::Error>
+    where
+        T: ?Sized + Serialize,
+    {
+        value.serialize(&mut *self)?;
+        self.output += "|nil";
+
+        Ok(())
+    }
+
+    fn serialize_unit(self) -> std::result::Result<Self::Ok, Self::Error> {
+        self.output += "nil";
+
+        Ok(())
+    }
+
+    fn serialize_unit_struct(
+        self,
+        name: &'static str,
+    ) -> std::result::Result<Self::Ok, Self::Error> {
+        self.serialize_unit()
+    }
+
+    fn serialize_unit_variant(
+        self,
+        name: &'static str,
+        variant_index: u32,
+        variant: &'static str,
+    ) -> std::result::Result<Self::Ok, Self::Error> {
+        todo!()
+    }
+
+    fn serialize_newtype_struct<T>(
+        self,
+        name: &'static str,
+        value: &T,
+    ) -> std::result::Result<Self::Ok, Self::Error>
+    where
+        T: ?Sized + Serialize,
+    {
+        todo!()
+    }
+
+    fn serialize_newtype_variant<T>(
+        self,
+        name: &'static str,
+        variant_index: u32,
+        variant: &'static str,
+        value: &T,
+    ) -> std::result::Result<Self::Ok, Self::Error>
+    where
+        T: ?Sized + Serialize,
+    {
+        todo!()
+    }
+
+    fn serialize_seq(
+        self,
+        len: Option<usize>,
+    ) -> std::result::Result<Self::SerializeSeq, Self::Error> {
+        todo!()
+    }
+
+    fn serialize_tuple(self, len: usize) -> std::result::Result<Self::SerializeTuple, Self::Error> {
+        todo!()
+    }
+
+    fn serialize_tuple_struct(
+        self,
+        name: &'static str,
+        len: usize,
+    ) -> std::result::Result<Self::SerializeTupleStruct, Self::Error> {
+        todo!()
+    }
+
+    fn serialize_tuple_variant(
+        self,
+        name: &'static str,
+        variant_index: u32,
+        variant: &'static str,
+        len: usize,
+    ) -> std::result::Result<Self::SerializeTupleVariant, Self::Error> {
+        todo!()
+    }
+
+    fn serialize_map(
+        self,
+        len: Option<usize>,
+    ) -> std::result::Result<Self::SerializeMap, Self::Error> {
+        todo!()
+    }
+
+    fn serialize_struct(
+        self,
+        name: &'static str,
+        len: usize,
+    ) -> std::result::Result<Self::SerializeStruct, Self::Error> {
+        self.output += &format!("---@class {name}\n");
+
+        Ok(self)
+    }
+
+    fn serialize_struct_variant(
+        self,
+        name: &'static str,
+        variant_index: u32,
+        variant: &'static str,
+        len: usize,
+    ) -> std::result::Result<Self::SerializeStructVariant, Self::Error> {
+        todo!()
+    }
+}
+
+impl<'a> ser::SerializeSeq for &'a mut Serializer {
+    type Ok = ();
+
+    type Error = Error;
+
+    fn serialize_element<T>(&mut self, value: &T) -> std::result::Result<(), Self::Error>
+    where
+        T: ?Sized + Serialize,
+    {
+        todo!()
+    }
+
+    fn end(self) -> std::result::Result<Self::Ok, Self::Error> {
+        todo!()
+    }
+}
+
+impl<'a> ser::SerializeTuple for &'a mut Serializer {
+    type Ok = ();
+
+    type Error = Error;
+
+    fn serialize_element<T>(&mut self, value: &T) -> std::result::Result<(), Self::Error>
+    where
+        T: ?Sized + Serialize,
+    {
+        todo!()
+    }
+
+    fn end(self) -> std::result::Result<Self::Ok, Self::Error> {
+        todo!()
+    }
+}
+
+impl<'a> ser::SerializeTupleStruct for &'a mut Serializer {
+    type Ok = ();
+
+    type Error = Error;
+
+    fn serialize_field<T>(&mut self, value: &T) -> std::result::Result<(), Self::Error>
+    where
+        T: ?Sized + Serialize,
+    {
+        todo!()
+    }
+
+    fn end(self) -> std::result::Result<Self::Ok, Self::Error> {
+        todo!()
+    }
+}
+
+impl<'a> ser::SerializeTupleVariant for &'a mut Serializer {
+    type Ok = ();
+
+    type Error = Error;
+
+    fn serialize_field<T>(&mut self, value: &T) -> std::result::Result<(), Self::Error>
+    where
+        T: ?Sized + Serialize,
+    {
+        todo!()
+    }
+
+    fn end(self) -> std::result::Result<Self::Ok, Self::Error> {
+        todo!()
+    }
+}
+
+impl<'a> ser::SerializeMap for &'a mut Serializer {
+    type Ok = ();
+
+    type Error = Error;
+
+    fn serialize_key<T>(&mut self, key: &T) -> std::result::Result<(), Self::Error>
+    where
+        T: ?Sized + Serialize,
+    {
+        todo!()
+    }
+
+    fn serialize_value<T>(&mut self, value: &T) -> std::result::Result<(), Self::Error>
+    where
+        T: ?Sized + Serialize,
+    {
+        todo!()
+    }
+
+    fn end(self) -> std::result::Result<Self::Ok, Self::Error> {
+        todo!()
+    }
+}
+
+impl<'a> ser::SerializeStruct for &'a mut Serializer {
+    type Ok = ();
+
+    type Error = Error;
+
+    fn serialize_field<T>(
+        &mut self,
+        key: &'static str,
+        value: &T,
+    ) -> std::result::Result<(), Self::Error>
+    where
+        T: ?Sized + Serialize,
+    {
+        self.output += &format!("---@field {key} ");
+        value.serialize(&mut **self)?;
+        self.output += "\n";
+
+        Ok(())
+    }
+
+    fn end(self) -> std::result::Result<Self::Ok, Self::Error> {
+        Ok(())
+    }
+}
+
+impl<'a> ser::SerializeStructVariant for &'a mut Serializer {
+    type Ok = ();
+
+    type Error = Error;
+
+    fn serialize_field<T>(
+        &mut self,
+        key: &'static str,
+        value: &T,
+    ) -> std::result::Result<(), Self::Error>
+    where
+        T: ?Sized + Serialize,
+    {
+        todo!()
+    }
+
+    fn end(self) -> std::result::Result<Self::Ok, Self::Error> {
+        todo!()
+    }
+}
+
+#[test]
+fn test() {
+    #[derive(Serialize)]
+    struct Other {
+        cool: bool,
+    }
+
+    #[derive(Serialize)]
+    struct Test {
+        int: u32,
+        text: String,
+        test: Option<bool>, // other: Other,
+    }
+
+    let test = Test {
+        int: 1,
+        text: "Hello, World".into(),
+        test: Some(true), // other: Other { cool: true },
+    };
+
+    insta::assert_snapshot!(to_string(&test).unwrap(), @r"
+    ---@class Test
+    ---@field int integer
+    ---@field text string
+    ");
+}