Added escaping to ActiveEnum to allow for non-UAX#31 chars, as well as camel_case related conflicts.

[denwong47]

PR Info

• Closes Issue #1373

Bug Fixes

• Fixes DeriveActiveEnum throwing
  • "" is not a valid identifier panic if string_value consists only of non-UAX#31 compliant characters
  • the name SomeName is defined multiple times if two enum values have string_value of someName and some_name respectively
  • "_0 123" is not a valid identifier if string_value starts with any digit followed by at least one space in the string.

Details

This adds a function camel_case_with_escaped_non_xid to util.rs of sea-orm-macros, which is a wrapper for camel_case to conduct further escaping specifically suitable for Rust Identifiers.

It does so by:

• iterating through each character to check
  • if it is not _ or whitespace, and
  • if its within XID_Start character set for first character, and
  • if its within XID_Continue character set for the rest of the string
• if not,
  • it decode the Unicode character to u32, then replace original character with its {:X} hex representation: e.g. whitespace becomes 0x20.
• the string is then reconstructed
• if the string is at this point empty,
  • return special string "__Empty".
• otherwise apply camel_case.
• the first character is then checked for numeric; if so, prepend an underscore.

For example,

#[derive(Clone, Debug, PartialEq, EnumIter, DeriveActiveEnum)]
#[sea_orm(
    rs_type = "String",
    db_type = "String(None)",
    enum_name = "conflicting_string_values"
)]
pub enum ConflictingStringValues {
    #[sea_orm(string_value = "")]
    Member1,
    #[sea_orm(string_value = "$")]
    Member2,
    #[sea_orm(string_value = "$$")]
    Member3,
    #[sea_orm(string_value = "AB")]
    Member4,
    #[sea_orm(string_value = "A_B")]
    Member5,
    #[sea_orm(string_value = "A$B")]
    Member6,
    #[sea_orm(string_value = "0 123")]
    Member7,
}

will now produce the following Variant Enum:

        pub enum ConflictingStringValuesVariant {
            __Empty,
            _0x24,
            _0x240x24,
            Ab,
            A0x5Fb,
            A0x24B,
            _0x300x20123,
        }

See Also

Valid Rust Identifier talking about XID_Start and XID_Continue

[denwong47]

Fixed CI errors. Apologies!

[tyt2y3]

😎

[tyt2y3]

Thank you for your contribution!

The implementation looks clean to me, and I appreciate the documentation.
Still require Billy's review as he is the primary author of sea-orm-macros

[tyt2y3]

For example,

#[derive(Clone, Debug, PartialEq, EnumIter, DeriveActiveEnum)]
#[sea_orm(
    rs_type = "String",
    db_type = "String(None)",
    enum_name = "conflicting_string_values"
)]
pub enum ConflictingStringValues {
    #[sea_orm(string_value = "")]
    Member1,
    #[sea_orm(string_value = "$")]
    Member2,
    #[sea_orm(string_value = "$$")]
    Member3,
    #[sea_orm(string_value = "AB")]
    Member4,
    #[sea_orm(string_value = "A_B")]
    Member5,
    #[sea_orm(string_value = "A$B")]
    Member6,
    #[sea_orm(string_value = "0 123")]
    Member7,
}

will now produce the following Variant Enum:

        pub enum ConflictingStringValuesVariant {
            __Empty,
            _0x24,
            _0x240x24,
            Ab,
            A0x5Fb,
            A0x24B,
            _0x300x20123,
        }

It will be great if we can also include this example as a doc test!

[denwong47]

Thank you, I'll have a look at doc testing tomorrow!

[denwong47]

Changes post-review:

• rebased onto latest SeaQL:master
• added unit test for camel_case_with_escaped_non_uax31 in sea_orm_macros::util::test submodule.
  • @tyt2y3 Unfortunately I wasn't able to do these test as a doc test as suggested - since util is private to the sub-crate, doc test can't import it as far as I know.
• renamed the main function of camel_case_with_escaped_non_xid to camel_case_with_escaped_non_uax31 - which is a better description of the standard we are trying to check against.
• fixed Cargo.toml in sea-orm-macros not specifying feature tests-cfg, which seems to be required for an existing unit test.

[billy1624]

Hey @denwong47, I just fetch from latest master. Now, I'm going to add a few more test cases here and there before merging. Thanks for the efforts!! Great contribution! :)

[billy1624]

Thanks again for the PR! More PRs are welcomed! See you around on GitHub :P

[github-actions]

🎉 Released In 0.12.1 🎉

Thank you everyone for the contribution!
This feature is now available in the latest release. Now is a good time to upgrade!
Your participation is what makes us unique; your adoption is what drives us forward.
You can support SeaQL 🌊 by starring our repos, sharing our libraries and becoming a sponsor ⭐.