Skip to content

Commit 0936605

Browse files
XeniraXenira
committed
feat(interface): add support for renaming all consts/methods
Refs: #533
1 parent f575a33 commit 0936605

File tree

7 files changed

+313
-116
lines changed

7 files changed

+313
-116
lines changed

‎crates/macros/src/interface.rs‎

Lines changed: 71 additions & 85 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,17 @@ use crate::impl_::{FnBuilder, MethodModifier};
1414
use crate::parsing::{PhpRename, RenameRule, Visibility};
1515
use crate::prelude::*;
1616

17+
const INTERNAL_INTERFACE_NAME_PREFIX: &str = "PhpInterface";
18+
1719
#[derive(FromAttributes, Debug, Default)]
1820
#[darling(attributes(php), forward_attrs(doc), default)]
19-
pub struct StructAttributes {
21+
pub struct TraitAttributes {
2022
#[darling(flatten)]
2123
rename: PhpRename,
24+
/// Rename methods to match the given rule.
25+
change_method_case: Option<RenameRule>,
26+
/// Rename constants to match the given rule.
27+
change_constant_case: Option<RenameRule>,
2228
#[darling(multiple)]
2329
extends: Vec<ClassEntryAttribute>,
2430
attrs: Vec<syn::Attribute>,
@@ -43,7 +49,7 @@ struct InterfaceData<'a> {
4349
ident: &'a Ident,
4450
name: String,
4551
path: Path,
46-
attrs: StructAttributes,
52+
extends: Vec<ClassEntryAttribute>,
4753
constructor: Option<Function<'a>>,
4854
methods: Vec<FnBuilder>,
4955
constants: Vec<Constant<'a>>,
@@ -53,9 +59,9 @@ struct InterfaceData<'a> {
5359
impl ToTokens for InterfaceData<'_> {
5460
#[allow(clippy::too_many_lines)]
5561
fn to_tokens(&self, tokens: &mut TokenStream) {
56-
let interface_name = format_ident!("PhpInterface{}", self.ident);
62+
let interface_name = format_ident!("{INTERNAL_INTERFACE_NAME_PREFIX}{}", self.ident);
5763
let name = &self.name;
58-
let implements = &self.attrs.extends;
64+
let implements = &self.extends;
5965
let methods_sig = &self.methods;
6066
let constants = &self.constants;
6167
let docs = &self.docs;
@@ -188,19 +194,19 @@ impl ToTokens for InterfaceData<'_> {
188194

189195
impl<'a> Parse<'a, InterfaceData<'a>> for ItemTrait {
190196
fn parse(&'a mut self) -> Result<InterfaceData<'a>> {
191-
let attrs = StructAttributes::from_attributes(&self.attrs)?;
197+
let attrs = TraitAttributes::from_attributes(&self.attrs)?;
192198
let ident = &self.ident;
193199
let name = attrs.rename.rename(ident.to_string(), RenameRule::Pascal);
194200
let docs = get_docs(&attrs.attrs)?;
195201
self.attrs.clean_php();
196-
let interface_name = format_ident!("PhpInterface{ident}");
202+
let interface_name = format_ident!("{INTERNAL_INTERFACE_NAME_PREFIX}{ident}");
197203
let ts = quote! { #interface_name };
198204
let path: Path = syn::parse2(ts)?;
199205
let mut data = InterfaceData {
200206
ident,
201207
name,
202208
path,
203-
attrs,
209+
extends: attrs.extends,
204210
constructor: None,
205211
methods: Vec::default(),
206212
constants: Vec::default(),
@@ -210,7 +216,7 @@ impl<'a> Parse<'a, InterfaceData<'a>> for ItemTrait {
210216
for item in &mut self.items {
211217
match item {
212218
TraitItem::Fn(f) => {
213-
match f.parse()? {
219+
match parse_trait_item_fn(f, attrs.change_method_case)? {
214220
MethodKind::Method(builder) => data.methods.push(builder),
215221
MethodKind::Constructor(builder) => {
216222
if data.constructor.replace(builder).is_some() {
@@ -219,7 +225,9 @@ impl<'a> Parse<'a, InterfaceData<'a>> for ItemTrait {
219225
}
220226
};
221227
}
222-
TraitItem::Const(c) => data.constants.push(c.parse()?),
228+
TraitItem::Const(c) => data
229+
.constants
230+
.push(parse_trait_item_const(c, attrs.change_constant_case)?),
223231
_ => {}
224232
}
225233
}
@@ -247,63 +255,51 @@ enum MethodKind<'a> {
247255
Constructor(Function<'a>),
248256
}
249257

250-
impl<'a> Parse<'a, MethodKind<'a>> for TraitItemFn {
251-
fn parse(&'a mut self) -> Result<MethodKind<'a>> {
252-
if self.default.is_some() {
253-
bail!(self => "Interface could not have default impl");
254-
}
255-
256-
let php_attr = PhpFunctionInterfaceAttribute::from_attributes(&self.attrs)?;
257-
self.attrs.clean_php();
258+
fn parse_trait_item_fn(
259+
fn_item: &mut TraitItemFn,
260+
change_case: Option<RenameRule>,
261+
) -> Result<MethodKind<'_>> {
262+
if fn_item.default.is_some() {
263+
bail!(fn_item => "Interface an not have default impl");
264+
}
258265

259-
let mut args = Args::parse_from_fnargs(self.sig.inputs.iter(), php_attr.defaults)?;
266+
let php_attr = PhpFunctionInterfaceAttribute::from_attributes(&fn_item.attrs)?;
267+
fn_item.attrs.clean_php();
260268

261-
let docs = get_docs(&php_attr.attrs)?;
269+
let mut args = Args::parse_from_fnargs(fn_item.sig.inputs.iter(), php_attr.defaults)?;
262270

263-
let mut modifiers: HashSet<MethodModifier> = HashSet::new();
264-
modifiers.insert(MethodModifier::Abstract);
271+
let docs = get_docs(&php_attr.attrs)?;
265272

266-
if args.typed.first().is_some_and(|arg| arg.name == "self_") {
267-
args.typed.pop();
268-
} else if args.receiver.is_none() {
269-
modifiers.insert(MethodModifier::Static);
270-
}
273+
let mut modifiers: HashSet<MethodModifier> = HashSet::new();
274+
modifiers.insert(MethodModifier::Abstract);
271275

272-
let f = Function::new(
273-
&self.sig,
274-
php_attr
275-
.rename
276-
.rename(self.sig.ident.to_string(), RenameRule::Camel),
277-
args,
278-
php_attr.optional,
279-
docs,
280-
);
281-
282-
if php_attr.constructor.is_present() {
283-
Ok(MethodKind::Constructor(f))
284-
} else {
285-
let builder = FnBuilder {
286-
builder: f.abstract_function_builder(),
287-
vis: php_attr.vis.unwrap_or(Visibility::Public),
288-
modifiers,
289-
};
290-
291-
Ok(MethodKind::Method(builder))
292-
}
276+
if args.typed.first().is_some_and(|arg| arg.name == "self_") {
277+
args.typed.pop();
278+
} else if args.receiver.is_none() {
279+
modifiers.insert(MethodModifier::Static);
293280
}
294-
}
295281

296-
impl<'a> Parse<'a, Vec<MethodKind<'a>>> for ItemTrait {
297-
fn parse(&'a mut self) -> Result<Vec<MethodKind<'a>>> {
298-
Ok(self
299-
.items
300-
.iter_mut()
301-
.filter_map(|item| match item {
302-
TraitItem::Fn(f) => Some(f),
303-
_ => None,
304-
})
305-
.flat_map(Parse::parse)
306-
.collect())
282+
let f = Function::new(
283+
&fn_item.sig,
284+
php_attr.rename.rename(
285+
fn_item.sig.ident.to_string(),
286+
change_case.unwrap_or(RenameRule::Camel),
287+
),
288+
args,
289+
php_attr.optional,
290+
docs,
291+
);
292+
293+
if php_attr.constructor.is_present() {
294+
Ok(MethodKind::Constructor(f))
295+
} else {
296+
let builder = FnBuilder {
297+
builder: f.abstract_function_builder(),
298+
vis: php_attr.vis.unwrap_or(Visibility::Public),
299+
modifiers,
300+
};
301+
302+
Ok(MethodKind::Method(builder))
307303
}
308304
}
309305

@@ -332,32 +328,22 @@ impl<'a> Constant<'a> {
332328
}
333329
}
334330

335-
impl<'a> Parse<'a, Constant<'a>> for TraitItemConst {
336-
fn parse(&'a mut self) -> Result<Constant<'a>> {
337-
if self.default.is_none() {
338-
bail!(self => "Interface const could not be empty");
339-
}
340-
341-
let attr = PhpConstAttribute::from_attributes(&self.attrs)?;
342-
let name = self.ident.to_string();
343-
let docs = get_docs(&attr.attrs)?;
344-
self.attrs.clean_php();
345-
346-
let (_, expr) = self.default.as_ref().unwrap();
347-
Ok(Constant::new(name, expr, docs))
331+
fn parse_trait_item_const(
332+
const_item: &mut TraitItemConst,
333+
change_case: Option<RenameRule>,
334+
) -> Result<Constant<'_>> {
335+
if const_item.default.is_none() {
336+
bail!(const_item => "PHP Interface const can not be empty");
348337
}
349-
}
350338

351-
impl<'a> Parse<'a, Vec<Constant<'a>>> for ItemTrait {
352-
fn parse(&'a mut self) -> Result<Vec<Constant<'a>>> {
353-
Ok(self
354-
.items
355-
.iter_mut()
356-
.filter_map(|item| match item {
357-
TraitItem::Const(c) => Some(c),
358-
_ => None,
359-
})
360-
.flat_map(Parse::parse)
361-
.collect())
362-
}
339+
let attr = PhpConstAttribute::from_attributes(&const_item.attrs)?;
340+
let name = attr.rename.rename(
341+
const_item.ident.to_string(),
342+
change_case.unwrap_or(RenameRule::ScreamingSnake),
343+
);
344+
let docs = get_docs(&attr.attrs)?;
345+
const_item.attrs.clean_php();
346+
347+
let (_, expr) = const_item.default.as_ref().unwrap();
348+
Ok(Constant::new(name, expr, docs))
363349
}

‎crates/macros/src/lib.rs‎

Lines changed: 56 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -345,44 +345,79 @@ fn php_enum_internal(_args: TokenStream2, input: TokenStream2) -> TokenStream2 {
345345
// BEGIN DOCS FROM interface.md
346346
/// # `#[php_interface]` Attribute
347347
///
348-
/// Traits can be exported to PHP as interface with the `#[php_interface]`
349-
/// attribute macro. This attribute generate empty struct and derives the
350-
/// `RegisteredClass`. To register the interface use the
351-
/// `interface::<PhpInterface{TraitName}>()` method on the `ModuleBuilder` in
352-
/// the `#[php_module]` macro.
348+
/// You can export a `Trait` block to PHP. This exports all methods as well as
349+
/// constants to PHP on the interface. Trait method SHOULD NOT contain default
350+
/// implementations, as these are not supported in PHP interfaces.
353351
///
354352
/// ## Options
355353
///
356-
/// The `#[php_interface]` attribute can be configured with the following
357-
/// options:
358-
/// - `#[php(name = "InterfaceName")]` or `#[php(change_case = snake_case)]`:
359-
/// Sets the name of the interface in PHP. The default is the `PascalCase`
360-
/// name of the interface.
361-
/// - `#[php(extends(ce = ce::throwable, stub = "\\Throwable"))]` to extends
362-
/// interface from other interface
354+
/// By default all constants are renamed to `UPPER_CASE` and all methods are
355+
/// renamed to `camelCase`. This can be changed by passing the
356+
/// `change_method_case` and `change_constant_case` as `#[php]` attributes on
357+
/// the `impl` block. The options are:
363358
///
364-
/// ### Example
359+
/// - `#[php(change_method_case = "snake_case")]` - Renames the method to snake
360+
/// case.
361+
/// - `#[php(change_constant_case = "snake_case")]` - Renames the constant to
362+
/// snake case.
363+
///
364+
/// See the [`name` and `change_case`](./php.md#name-and-change_case) section
365+
/// for a list of all available cases.
366+
///
367+
/// ## Methods
368+
///
369+
/// See the [`php_impl`](./impl.md#)
370+
///
371+
/// ## Constants
372+
///
373+
/// See the [`php_impl`](./impl.md#)
365374
///
366-
/// This example creates a PHP interface extend from php buildin Throwable.
375+
/// ## Example
376+
///
377+
/// Define an example trait with methods and constant:
367378
///
368379
/// ```rust,no_run,ignore
369380
/// # #![cfg_attr(windows, feature(abi_vectorcall))]
370381
/// # extern crate ext_php_rs;
371-
/// use ext_php_rs::prelude::*;
382+
/// use ext_php_rs::{prelude::*, types::ZendClassObject};
383+
///
372384
///
373385
/// #[php_interface]
374-
/// #[php(extends(ce = ce::throwable, stub = "\\Throwable"))]
375-
/// #[php(name = "LibName\\Exception\\MyCustomDomainException")]
376-
/// pub trait MyCustomDomainException {
377-
/// fn createWithMessage(message: String) -> Self;
386+
/// #[php(name = "Rust\\TestInterface")]
387+
/// trait Test {
388+
/// const TEST: &'static str = "TEST";
389+
///
390+
/// fn co();
391+
///
392+
/// #[php(defaults(value = 0))]
393+
/// fn set_value(&mut self, value: i32);
378394
/// }
379395
///
380396
/// #[php_module]
381-
/// pub fn get_module(module: ModuleBuilder) -> ModuleBuilder {
382-
/// module.interface::<PhpInterfaceMyCustomDomainException>()
397+
/// pub fn module(module: ModuleBuilder) -> ModuleBuilder {
398+
/// module
399+
/// .interface::<PhpInterfaceTest>()
383400
/// }
401+
///
384402
/// # fn main() {}
385403
/// ```
404+
///
405+
/// Using our newly created interface in PHP:
406+
///
407+
/// ```php
408+
/// <?php
409+
///
410+
/// assert(interface_exists("Rust\TestInterface"));
411+
///
412+
/// class B implements Rust\TestInterface {
413+
///
414+
/// public static function co() {}
415+
///
416+
/// public function setValue(?int $value = 0) {
417+
///
418+
/// }
419+
/// }
420+
/// ```
386421
// END DOCS FROM interface.md
387422
#[proc_macro_attribute]
388423
pub fn php_interface(args: TokenStream, input: TokenStream) -> TokenStream {
@@ -1308,7 +1343,6 @@ mod tests {
13081343
}
13091344

13101345
fn runtime_expand_attr(path: &PathBuf) {
1311-
dbg!(path);
13121346
let file = std::fs::File::open(path).expect("Failed to open expand test file");
13131347
runtime_macros::emulate_attributelike_macro_expansion(
13141348
file,

0 commit comments

Comments
 (0)