Skip to content

Commit

Permalink
Add ExpandDerive handler (#1685)
Browse files Browse the repository at this point in the history
**Stack**:
- #1686
- #1685⚠️ *Part of a stack created by [spr](https://github.com/ejoffe/spr). Do
not merge manually using the UI - doing so may have unexpected results.*
  • Loading branch information
Draggu authored Nov 9, 2024
1 parent 3be33e4 commit 3e71fa0
Show file tree
Hide file tree
Showing 4 changed files with 82 additions and 1 deletion.
41 changes: 41 additions & 0 deletions scarb/src/ops/proc_macro_server/methods/expand_derive.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
use std::sync::Arc;

use anyhow::Result;
use cairo_lang_macro::TokenStream;
use convert_case::{Case, Casing};
use scarb_proc_macro_server_types::methods::{expand::ExpandDerive, ProcMacroResult};

use super::Handler;
use crate::compiler::plugin::proc_macro::{Expansion, ExpansionKind, ProcMacroHost};

impl Handler for ExpandDerive {
fn handle(proc_macro_host: Arc<ProcMacroHost>, params: Self::Params) -> Result<Self::Response> {
let mut derived_code = String::new();
let mut all_diagnostics = vec![];

for derive in params.derives {
let expansion = Expansion::new(derive.to_case(Case::Snake), ExpansionKind::Derive);
let instance = proc_macro_host
.macros()
.iter()
.find(|e| e.get_expansions().contains(&expansion))
.unwrap();

let result = instance.generate_code(
expansion.name.clone(),
TokenStream::empty(),
params.item.clone(),
);

// Register diagnostics.
all_diagnostics.extend(result.diagnostics);
// Add generated code.
derived_code.push_str(&result.token_stream.to_string());
}

Ok(ProcMacroResult {
token_stream: TokenStream::new(derived_code),
diagnostics: all_diagnostics,
})
}
}
1 change: 1 addition & 0 deletions scarb/src/ops/proc_macro_server/methods/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ use crate::compiler::plugin::proc_macro::ProcMacroHost;

pub mod defined_macros;
pub mod expand_attribute;
pub mod expand_derive;

pub trait Handler: Method {
fn handle(proc_macro_host: Arc<ProcMacroHost>, params: Self::Params) -> Result<Self::Response>;
Expand Down
3 changes: 2 additions & 1 deletion scarb/src/ops/proc_macro_server/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ use crossbeam_channel::{Receiver, Sender};
use methods::Handler;
use scarb_proc_macro_server_types::jsonrpc::{ResponseError, RpcRequest, RpcResponse};
use scarb_proc_macro_server_types::methods::defined_macros::DefinedMacros;
use scarb_proc_macro_server_types::methods::expand::ExpandAttribute;
use scarb_proc_macro_server_types::methods::expand::{ExpandAttribute, ExpandDerive};
use scarb_proc_macro_server_types::methods::Method;
use serde_json::Value;

Expand Down Expand Up @@ -74,6 +74,7 @@ fn route_request(proc_macros: Arc<ProcMacroHost>, request: RpcRequest) -> Result
ExpandAttribute::METHOD => {
run_handler::<ExpandAttribute>(proc_macros.clone(), request.value)
}
ExpandDerive::METHOD => run_handler::<ExpandDerive>(proc_macros.clone(), request.value),
_ => Err(anyhow!("method not found")),
}
}
Expand Down
38 changes: 38 additions & 0 deletions scarb/tests/proc_macro_server.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ use scarb_proc_macro_server_types::methods::defined_macros::DefinedMacros;
use scarb_proc_macro_server_types::methods::defined_macros::DefinedMacrosParams;
use scarb_proc_macro_server_types::methods::expand::ExpandAttribute;
use scarb_proc_macro_server_types::methods::expand::ExpandAttributeParams;
use scarb_proc_macro_server_types::methods::expand::ExpandDerive;
use scarb_proc_macro_server_types::methods::expand::ExpandDeriveParams;
use scarb_test_support::cairo_plugin_project_builder::CairoPluginProjectBuilder;
use scarb_test_support::proc_macro_server::ProcMacroClient;
use scarb_test_support::proc_macro_server::SIMPLE_MACROS;
Expand Down Expand Up @@ -88,3 +90,39 @@ fn expand_attribute() {
TokenStream::new("fn very_new_name(){}".to_string())
);
}

#[test]
fn expand_derive() {
let t = TempDir::new().unwrap();
let plugin_package = t.child("some");

CairoPluginProjectBuilder::default()
.lib_rs(SIMPLE_MACROS)
.build(&plugin_package);

let project = t.child("test_package");

ProjectBuilder::start()
.name("test_package")
.version("1.0.0")
.lib_cairo("")
.dep("some", plugin_package)
.build(&project);

let mut proc_macro_server = ProcMacroClient::new(&project);

let item = TokenStream::new("fn some_test_fn(){}".to_string());

let response = proc_macro_server
.request_and_wait::<ExpandDerive>(ExpandDeriveParams {
derives: vec!["some_derive".to_string()],
item,
})
.unwrap();

assert_eq!(response.diagnostics, vec![]);
assert_eq!(
response.token_stream,
TokenStream::new("impl SomeImpl of SomeTrait {}".to_string())
);
}

0 comments on commit 3e71fa0

Please sign in to comment.