feat: Allows serialization and deserialization to json

LICENSE.note

@@ -15,13 +15,6 @@ the licenses are the same as listed here.
 
 ===============================
 
-Name:    either
-Files:   vendor/either/*
-Authors: bluss
-License: MIT OR Apache-2.0
-
-------------------------------
-
 Name:    extendr-api
 Files:   vendor/extendr-api/*
 Authors: andy-thomason, Thomas Down, Mossa Merhi Reimert, Claus O. Wilke, Hiroaki Yutani, Ilia A. Kosenkov, Michael Milton
@@ -36,9 +29,9 @@ License: MIT
 
 ------------------------------
 
-Name:    itertools
-Files:   vendor/itertools/*
-Authors: bluss
+Name:    itoa
+Files:   vendor/itoa/*
+Authors: David Tolnay
 License: MIT OR Apache-2.0
 
 ------------------------------
@@ -57,6 +50,13 @@ License: MIT OR Apache-2.0
 
 ------------------------------
 
+Name:    orbweaver
+Files:   vendor/orbweaver/*
+Authors: ixpantia, Andrés F. Quintero
+License: MIT
+
+------------------------------
+
 Name:    paste
 Files:   vendor/paste/*
 Authors: David Tolnay
@@ -78,6 +78,34 @@ License: MIT OR Apache-2.0
 
 ------------------------------
 
+Name:    ryu
+Files:   vendor/ryu/*
+Authors: David Tolnay
+License: Apache-2.0 OR BSL-1.0
+
+------------------------------
+
+Name:    serde_derive
+Files:   vendor/serde_derive/*
+Authors: Erick Tryzelaar, David Tolnay
+License: MIT OR Apache-2.0
+
+------------------------------
+
+Name:    serde_json
+Files:   vendor/serde_json/*
+Authors: Erick Tryzelaar, David Tolnay
+License: MIT OR Apache-2.0
+
+------------------------------
+
+Name:    serde
+Files:   vendor/serde/*
+Authors: Erick Tryzelaar, David Tolnay
+License: MIT OR Apache-2.0
+
+------------------------------
+
 Name:    syn
 Files:   vendor/syn/*
 Authors: David Tolnay

NAMESPACE

@@ -32,6 +32,8 @@ S3method(get_nodes,DirectedAcyclicGraph)
 S3method(get_nodes,DirectedGraph)
 S3method(get_parents,DirectedAcyclicGraph)
 S3method(get_parents,DirectedGraph)
+S3method(graph_to_json,DirectedAcyclicGraph)
+S3method(graph_to_json,DirectedGraph)
 S3method(has_children,DirectedAcyclicGraph)
 S3method(has_children,DirectedGraph)
 S3method(has_parents,DirectedAcyclicGraph)
@@ -65,6 +67,8 @@ export(get_node)
 export(get_node_data)
 export(get_nodes)
 export(get_parents)
+export(graph_from_json)
+export(graph_to_json)
 export(has_children)
 export(has_parents)
 export(into_dag)

R/add_node.R

@@ -16,12 +16,12 @@ add_node <- function(graph, node_id, data = NULL) {
 }
 
 #' @export
-add_node.DirectedGraph <- function(graph, node_id, data) {
+add_node.DirectedGraph <- function(graph, node_id, data = NULL) {
   graph$add_node(node_id, data)
   return(graph)
 }
 
 #' @export
-add_node.DirectedAcyclicGraph <- function(graph, node_id, data) {
+add_node.DirectedAcyclicGraph <- function(graph, node_id, data = NULL) {
   rlang::abort(err_unable_to_modify_dag)
 }

R/extendr-wrappers.R

@@ -15,6 +15,14 @@ rs_populate_edges_directed_graph <- function(graph, parent_iter, child_iter) .Ca
 
 rs_populate_nodes_directed_graph <- function(graph, node_ids, data_iter) .Call(wrap__rs_populate_nodes_directed_graph, graph, node_ids, data_iter)
 
+rs_directed_graph_from_json <- function(text) .Call(wrap__rs_directed_graph_from_json, text)
+
+rs_directed_graph_to_json <- function(directed_graph, pretty) .Call(wrap__rs_directed_graph_to_json, directed_graph, pretty)
+
+rs_dag_to_json <- function(dag, pretty) .Call(wrap__rs_dag_to_json, dag, pretty)
+
+rs_dag_from_json <- function(text) .Call(wrap__rs_dag_from_json, text)
+
 Node <- new.env(parent = emptyenv())
 
 Node$get_data <- function() .Call(wrap__Node__get_data, self)

R/json.R

@@ -0,0 +1,34 @@
+#' @title Serialize the graph into a JSON string
+#' @param graph A graph object
+#' @param pretty If the JSON string should be prettified
+#' @return A JSON string
+#' @export
+graph_to_json <- function(graph, pretty = FALSE) {
+  UseMethod("graph_to_json")
+}
+
+#' @export
+graph_to_json.DirectedGraph <- function(graph, pretty = FALSE) {
+  rs_directed_graph_to_json(graph, pretty)
+}
+
+#' @export
+graph_to_json.DirectedAcyclicGraph <- function(graph, pretty = FALSE) {
+  rs_dag_to_json(graph, pretty)
+}
+
+#' @title Get a graph from a JSON string
+#' @param text The JSON string to be deserialized
+#' @param type The type of graph the JSON represents
+#' @return A graph object
+#' @export
+graph_from_json <- function(text, type = c("directed", "dag")) {
+  if (!type %in% c("directed", "dag")) {
+    rlang::abort("Invalid argument `type`")
+  }
+  switch(
+    type[1],
+    "directed" = rs_directed_graph_from_json(text),
+    "dag" = rs_dag_from_json(text)
+  )
+}

inst/AUTHORS

@@ -1,8 +1,5 @@
 The authors of the dependency Rust crates:
 
-either (version 1.9.0):
-  bluss
-
 extendr-api (version 0.6.0):
   andy-thomason
   Thomas Down
@@ -20,8 +17,8 @@ extendr-macros (version 0.6.0):
   Hiroaki Yutani
   Ilia A. Kosenkov
 
-itertools (version 0.11.0):
-  bluss
+itoa (version 1.0.11):
+  David Tolnay
 
 libR-sys (version 0.6.0):
   andy-thomason
@@ -31,20 +28,39 @@ libR-sys (version 0.6.0):
   Ilia A. Kosenkov
   Hiroaki Yutani
 
-once_cell (version 1.18.0):
+once_cell (version 1.19.0):
   Aleksey Kladov
 
-paste (version 1.0.14):
+orbweaver (version 0.2.1):
+  ixpantia
+  Andrés F. Quintero
+
+paste (version 1.0.15):
   David Tolnay
 
-proc-macro2 (version 1.0.69):
+proc-macro2 (version 1.0.83):
   David Tolnay
   Alex Crichton
 
-quote (version 1.0.33):
+quote (version 1.0.36):
+  David Tolnay
+
+ryu (version 1.0.18):
+  David Tolnay
+
+serde_derive (version 1.0.202):
+  Erick Tryzelaar
+  David Tolnay
+
+serde_json (version 1.0.117):
+  Erick Tryzelaar
+  David Tolnay
+
+serde (version 1.0.202):
+  Erick Tryzelaar
   David Tolnay
 
-syn (version 2.0.39):
+syn (version 2.0.66):
   David Tolnay
 
 unicode-ident (version 1.0.12):

src/rust/Cargo.toml

@@ -8,5 +8,6 @@ crate-type = [ 'staticlib' ]
 name = 'orbweaver'
 
 [dependencies]
-extendr-api = '*'
+extendr-api = { version = "0.6", features = ["serde"] }
 orbweaver = { version = "0.2.1" }
+serde_json = "1.0.117"

src/rust/src/lib.rs

@@ -2,6 +2,7 @@ use extendr_api::prelude::*;
 use orbweaver::prelude as ow;
 
 pub mod from_dataframe;
+pub mod to_json;
 
 struct Node(ow::Node<Robj>);
 
@@ -30,7 +31,7 @@ impl Node {
 pub struct DirectedGraph(ow::DirectedGraph<Robj>);
 pub struct DirectedAcyclicGraph(ow::DirectedAcyclicGraph<Robj>);
 
-fn to_r_error(err: impl std::error::Error) -> String {
+pub fn to_r_error(err: impl std::error::Error) -> String {
     err.to_string()
 }
 
@@ -291,4 +292,5 @@ extendr_module! {
     impl DirectedGraph;
     impl DirectedAcyclicGraph;
     use from_dataframe;
+    use to_json;
 }

src/rust/src/to_json.rs

@@ -0,0 +1,42 @@
+use super::{to_r_error, DirectedAcyclicGraph, DirectedGraph};
+use extendr_api::prelude::*;
+use orbweaver::prelude as ow;
+
+#[extendr]
+fn rs_directed_graph_to_json(directed_graph: &DirectedGraph, pretty: bool) -> Result<String> {
+    if pretty {
+        Ok(serde_json::to_string_pretty(&directed_graph.0).map_err(to_r_error)?)
+    } else {
+        Ok(serde_json::to_string(&directed_graph.0).map_err(to_r_error)?)
+    }
+}
+
+#[extendr]
+fn rs_directed_graph_from_json(text: &str) -> Result<DirectedGraph> {
+    let dg: ow::DirectedGraph<Robj> = serde_json::from_str(text).map_err(|e| e.to_string())?;
+    Ok(DirectedGraph(dg))
+}
+
+#[extendr]
+fn rs_dag_to_json(dag: &DirectedAcyclicGraph, pretty: bool) -> Result<String> {
+    if pretty {
+        Ok(serde_json::to_string_pretty(&dag.0).map_err(to_r_error)?)
+    } else {
+        Ok(serde_json::to_string(&dag.0).map_err(to_r_error)?)
+    }
+}
+
+#[extendr]
+fn rs_dag_from_json(text: &str) -> Result<DirectedAcyclicGraph> {
+    let dag: ow::DirectedAcyclicGraph<Robj> =
+        serde_json::from_str(text).map_err(|e| e.to_string())?;
+    Ok(DirectedAcyclicGraph(dag))
+}
+
+extendr_module! {
+    mod to_json;
+    fn rs_directed_graph_from_json;
+    fn rs_directed_graph_to_json;
+    fn rs_dag_to_json;
+    fn rs_dag_from_json;
+}