refactor(enum): use value for discriminants to be less verbose

Refs: #178

Author: Xenira

crates/macros/src/enum_.rs

@@ -30,6 +30,7 @@ struct PhpEnumAttribute {
 struct PhpEnumVariantAttribute {
     #[darling(flatten)]
     rename: PhpRename,
+    #[darling(rename = "value")]
     discriminant: Option<Lit>,
     attrs: Vec<syn::Attribute>,
 }
@@ -47,7 +48,7 @@ pub fn parser(mut input: ItemEnum) -> Result<TokenStream> {
             bail!("Enum cases must be unit variants, found: {:?}", variant);
         }
         if !php_attr.allow_native_discriminants.is_present() && variant.discriminant.is_some() {
-            bail!(variant => "Native discriminants are currently not exported to PHP. To set a discriminant, use the `#[php(allow_native_discriminants)]` attribute on the enum. To export discriminants, set the #[php(discriminant = ...)] attribute on the enum case.");
+            bail!(variant => "Native discriminants are currently not exported to PHP. To set a discriminant, use the `#[php(allow_native_discriminants)]` attribute on the enum. To export discriminants, set the #[php(value = ...)] attribute on the enum case.");
         }
 
         let variant_attr = PhpEnumVariantAttribute::from_attributes(&variant.attrs)?;

crates/macros/src/lib.rs

@@ -237,10 +237,9 @@ fn php_class_internal(args: TokenStream2, input: TokenStream2) -> TokenStream2 {
 /// - `#[php(name = "CaseName")]` or `#[php(change_case = snake_case)]`: Sets
 ///   the name of the enum case in PHP. The default is the `PascalCase` name of
 ///   the case.
-/// - `#[php(discriminant = "value")]` or `#[php(discriminant = 123)]`: Sets the
-///   discriminant value for the enum case. This can be a string or an integer.
-///   If not set, the case will be exported as a simple enum case without a
-///   discriminant.
+/// - `#[php(value = "value")]` or `#[php(value = 123)]`: Sets the discriminant
+///   value for the enum case. This can be a string or an integer. If not set,
+///   the case will be exported as a simple enum case without a discriminant.
 ///
 /// ### Example
 ///
@@ -268,11 +267,11 @@ fn php_class_internal(args: TokenStream2, input: TokenStream2) -> TokenStream2 {
 ///
 /// ## Backed Enums
 /// Enums can also be backed by either `i64` or `&'static str`. Those values can
-/// be set using the `#[php(discriminant = "value")]` or `#[php(discriminant =
-/// 123)]` attributes on the enum variants.
+/// be set using the `#[php(value = "value")]` or `#[php(value = 123)]`
+/// attributes on the enum variants.
 ///
-/// All variants must have a discriminant of the same type, either all `i64` or
-/// all `&'static str`.
+/// All variants must have a value of the same type, either all `i64` or all
+/// `&'static str`.
 ///
 /// ```rust,no_run,ignore
 /// # #![cfg_attr(windows, feature(abi_vectorcall))]
@@ -281,13 +280,13 @@ fn php_class_internal(args: TokenStream2, input: TokenStream2) -> TokenStream2 {
 ///
 /// #[php_enum]
 /// pub enum Suit {
-///     #[php(discriminant = "hearts")]
+///     #[php(value = "hearts")]
 ///     Hearts,
-///     #[php(discriminant = "diamonds")]
+///     #[php(value = "diamonds")]
 ///     Diamonds,
-///     #[php(discriminant = "clubs")]
+///     #[php(value = "clubs")]
 ///     Clubs,
-///     #[php(discriminant = "spades")]
+///     #[php(value = "spades")]
 ///     Spades,
 /// }
 /// #[php_module]

guide/src/macros/enum.md

@@ -15,7 +15,7 @@ The `#[php_enum]` attribute can be configured with the following options:
 The cases of the enum can be configured with the following options:
 - `#[php(name = "CaseName")]` or `#[php(change_case = snake_case)]`: Sets the name of the enum case in PHP.
   The default is the `PascalCase` name of the case.
-- `#[php(discriminant = "value")]` or `#[php(discriminant = 123)]`: Sets the discriminant value for the enum case.
+- `#[php(value = "value")]` or `#[php(value = 123)]`: Sets the discriminant value for the enum case.
   This can be a string or an integer. If not set, the case will be exported as a simple enum case without a discriminant.
 
 ### Example
@@ -44,9 +44,9 @@ pub fn get_module(module: ModuleBuilder) -> ModuleBuilder {
 
 ## Backed Enums
 Enums can also be backed by either `i64` or `&'static str`. Those values can be set using the
-`#[php(discriminant = "value")]` or `#[php(discriminant = 123)]` attributes on the enum variants.
+`#[php(value = "value")]` or `#[php(value = 123)]` attributes on the enum variants.
 
-All variants must have a discriminant of the same type, either all `i64` or all `&'static str`.
+All variants must have a value of the same type, either all `i64` or all `&'static str`.
 
 ```rust,no_run
 # #![cfg_attr(windows, feature(abi_vectorcall))]
@@ -55,13 +55,13 @@ use ext_php_rs::prelude::*;
 
 #[php_enum]
 pub enum Suit {
-    #[php(discriminant = "hearts")]
+    #[php(value = "hearts")]
     Hearts,
-    #[php(discriminant = "diamonds")]
+    #[php(value = "diamonds")]
     Diamonds,
-    #[php(discriminant = "clubs")]
+    #[php(value = "clubs")]
     Clubs,
-    #[php(discriminant = "spades")]
+    #[php(value = "spades")]
     Spades,
 }
 #[php_module]

tests/src/integration/enum_/mod.rs

@@ -15,17 +15,17 @@ pub enum TestEnum {
 
 #[php_enum]
 pub enum IntBackedEnum {
-    #[php(discriminant = 1)]
+    #[php(value = 1)]
     Variant1,
-    #[php(discriminant = 2)]
+    #[php(value = 2)]
     Variant2,
 }
 
 #[php_enum]
 pub enum StringBackedEnum {
-    #[php(discriminant = "foo")]
+    #[php(value = "foo")]
     Variant1,
-    #[php(discriminant = "bar")]
+    #[php(value = "bar")]
     Variant2,
 }