feat proto-structs: camel case for enums

commit_hash:d873964ff730542de5223de0fc1675ea750700c2

Author: ArkadyRudenko

libraries/proto-structs/codegen-tests/proto/enums/names.proto

@@ -41,3 +41,11 @@ message NestedTrickEnum {
         BAR_VAR = 2;
     }
 }
+
+enum WithoutPrefix {
+    BarVar = 0;
+    Bar_Foo = 1;
+    Bar_foo1 = 2;
+    Bar_FooQux = 3;
+    Bar_FooQuX1 = 4;
+}

libraries/proto-structs/codegen-tests/src/enums/names_test.cpp

@@ -9,31 +9,40 @@ USERVER_NAMESPACE_BEGIN
 TEST(EnumNames, Unprefixed) {
     using Enum = enums::structs::Unprefixed;
     static_assert(std::is_enum_v<Enum>);
-    static_assert(std::is_same_v<decltype(Enum::FOO_VAR), Enum>);
-    static_assert(std::is_same_v<decltype(Enum::BAR_VAR), Enum>);
+    static_assert(std::is_same_v<decltype(Enum::kFooVar), Enum>);
+    static_assert(std::is_same_v<decltype(Enum::kBarVar), Enum>);
 }
 
 TEST(EnumNames, AllowedCuts) {
     using Enum = enums::structs::AllowedCuts;
     static_assert(std::is_enum_v<Enum>);
-    static_assert(std::is_same_v<decltype(Enum::FOO_VAR), Enum>);
-    static_assert(std::is_same_v<decltype(Enum::DIGITS1), Enum>);
+    static_assert(std::is_same_v<decltype(Enum::kFooVar), Enum>);
+    static_assert(std::is_same_v<decltype(Enum::kDigits1), Enum>);
 }
 
 TEST(EnumNames, DisallowedCuts) {
     using Enum = enums::structs::DisallowedCuts;
     static_assert(std::is_enum_v<Enum>);
-    static_assert(std::is_same_v<decltype(Enum::DisallowedCuts_UNKNOWN), Enum>);
-    static_assert(std::is_same_v<decltype(Enum::DISALLOWED_CUTS), Enum>);
-    static_assert(std::is_same_v<decltype(Enum::DISALLOWED_CUTS1), Enum>);
-    static_assert(std::is_same_v<decltype(Enum::DISALLOWED_CUTS_2), Enum>);
-    static_assert(std::is_same_v<decltype(Enum::DisallowedCutsCamel), Enum>);
+    static_assert(std::is_same_v<decltype(Enum::kDisallowedCutsUnknown), Enum>);
+    static_assert(std::is_same_v<decltype(Enum::kDisallowedCuts), Enum>);
+    static_assert(std::is_same_v<decltype(Enum::kDisallowedCuts1), Enum>);
+    static_assert(std::is_same_v<decltype(Enum::kDisallowedCuts2), Enum>);
+    static_assert(std::is_same_v<decltype(Enum::kDisallowedCutsCamel), Enum>);
 }
 
 TEST(EnumNames, NestedTrick) {
     using Enum = enums::structs::NestedTrickEnum;
     static_assert(std::is_enum_v<Enum>);
-    static_assert(std::is_same_v<decltype(Enum::FOO_VAR), Enum>);
+    static_assert(std::is_same_v<decltype(Enum::kFooVar), Enum>);
+}
+
+TEST(EnumNames, WithoutPrefix) {
+    using Enum = enums::structs::WithoutPrefix;
+    static_assert(std::is_same_v<decltype(Enum::kBarVar), Enum>);
+    static_assert(std::is_same_v<decltype(Enum::kBarFoo), Enum>);
+    static_assert(std::is_same_v<decltype(Enum::kBarFoo1), Enum>);
+    static_assert(std::is_same_v<decltype(Enum::kBarFooQux), Enum>);
+    static_assert(std::is_same_v<decltype(Enum::kBarFooQuX1), Enum>);
 }
 
 USERVER_NAMESPACE_END

libraries/proto-structs/codegen-tests/src/simple_test.cpp

@@ -19,7 +19,7 @@ TEST(SingleFile, SimpleStruct) {
     message.is_condition = true;
     message.some_bytes = {"foo", "bar"};
     message.something.set_bar("bar_val");
-    message.inner_enum = ss::SimpleStruct::InnerEnum2::FOO_VAL;
+    message.inner_enum = ss::SimpleStruct::InnerEnum2::kFooVal;
 
     ss::SimpleStruct::ProtobufMessage vanilla;
 
@@ -57,12 +57,12 @@ TEST(SingleFile, NestedStruct) {
 
 TEST(SingleFile, InnerEnum1) {
     static_assert(std::is_enum_v<ss::SimpleStruct::NestedStruct::NestedStruct2::InnerEnum1>);
-    [[maybe_unused]] const auto inner_enum1 = ss::SimpleStruct::NestedStruct::NestedStruct2::InnerEnum1::BAR_VAL;
+    [[maybe_unused]] const auto inner_enum1 = ss::SimpleStruct::NestedStruct::NestedStruct2::InnerEnum1::kBarVal;
 }
 
 TEST(SingleFile, InnerEnum2) {
     static_assert(std::is_enum_v<ss::SimpleStruct::InnerEnum2>);
-    [[maybe_unused]] const auto inner_enum2 = ss::SimpleStruct::InnerEnum2::FOO_VAL;
+    [[maybe_unused]] const auto inner_enum2 = ss::SimpleStruct::InnerEnum2::kFooVal;
 }
 
 TEST(SingleFile, SecondStruct) {

libraries/proto-structs/include/userver/proto-structs/impl/bundles/structs_hpp.hpp

@@ -1,6 +1,5 @@
 #pragma once
 
-#include <cstddef>
 #include <cstdint>
 #include <limits>
 #include <optional>

scripts/proto_structs/descriptors/node_parsers.py

@@ -72,11 +72,16 @@ def parse_enum_value(value: descriptor.EnumValueDescriptor) -> gen_node.EnumValu
     enum_name = typing.cast(str, enum_descriptor.name)
 
     return gen_node.EnumValue(
-        short_name=names.escape_id(_cut_enum_value_name(enum_value_name, enum_name=enum_name)),
+        short_name=names.escape_id(_format_enum_value_name(enum_value_name, enum_name=enum_name)),
         number=typing.cast(int, value.number),
     )
 
 
+def _format_enum_value_name(value_name: str, *, enum_name: str) -> str:
+    name = _cut_enum_value_name(value_name, enum_name=enum_name)
+    return f'k{names.to_pascal_case(name, to_lower=True)}'
+
+
 def _cut_enum_value_name(value_name: str, *, enum_name: str) -> str:
     if value_name.startswith(upper_enum_name := names.to_upper_case(enum_name)):
         # ENUM_NAME_VALUE_NAME -> VALUE_NAME

scripts/proto_structs/models/gen_node.py

@@ -80,8 +80,6 @@ def __init__(self, *, proto_relative_path: pathlib.Path, children: Sequence[Code
     def collect_includes(self) -> Iterable[includes.Include]:
         for child in self.children:
             yield from child.collect_includes()
-        yield includes.Include(path='cstddef', kind=includes.IncludeKind.FOR_HPP)
-        yield includes.Include(path='utility', kind=includes.IncludeKind.FOR_HPP)
 
     def gen_path(self, *, ext: str) -> pathlib.Path:
         """Path to the generated userver proto structs file."""
@@ -199,6 +197,7 @@ def own_includes(self) -> Iterable[includes.Include]:
         yield from [
             includes.Include(path=path, kind=includes.IncludeKind.FOR_CPP)
             for path in [
+                'utility',
                 'userver/proto-structs/io/impl/field_accessor.hpp',
                 'userver/proto-structs/io/impl/read.hpp',
                 'userver/proto-structs/io/impl/write.hpp',
@@ -239,6 +238,7 @@ def field_number_name(self) -> str:
         """
         Converts a `snake_case` or `camelCase` identifier to `PascalCase`.
         Example: some_bytes_my_word -> kSomeBytesMyWordFieldNumber
+        Example: IYandexUid -> kIYandexUidFieldNumber
         """
         return f'k{names.to_pascal_case(self.short_name)}FieldNumber'
 

scripts/proto_structs/models/includes_bundles.py

@@ -3,7 +3,6 @@
 from typing import Set
 
 BUNDLE_HPP: Set[str] = {
-    'cstddef',
     'cstdint',
     'limits',
     'optional',

scripts/proto_structs/models/names.py

@@ -225,14 +225,25 @@ def make_nested_type_name(containing_type_name: TypeName, short_name: str) -> Ty
     )
 
 
-def to_pascal_case(name: str) -> str:
+_SPLIT_PASCAL_PATTERN = re.compile(r'_|(?<=[a-z])(?=[A-Z])')
+
+
+def to_pascal_case(name: str, to_lower: bool = False) -> str:
     """
-    Converts a `snake_case` or `camelCase` identifier to `PascalCase`.
+    Converts a `snake_case` or `UPPER_CASE` or `camelCase` identifier to `PascalCase`.
     Examples:
-    some_bytes_my_word -> kSomeBytesMyWordFieldNumber
-    by2tes_m1y -> kBy2TesM1YFieldNumber
-    IYandexUid -> kIYandexUidFieldNumber
+    some_bytes_my_word -> SomeBytesMyWord
+    by2tes_m1y -> By2TesM1Y
+    IYandexUid -> IYandexUid (if to_lower=False)
+    FOO_BAR_BazQux -> FooBarBazQux
     """
+    # We should split name by '_' and uppers letters. 'FOO_BAR_BazQux' -> ["FOO", "BAR", "Baz", "Qux"]
+    words = _SPLIT_PASCAL_PATTERN.split(name)
+    name = '_'.join(words)
+
+    if to_lower:
+        name = name.lower()
+
     words = ''.join(word[0].upper() + word[1:] for word in name.split('_') if len(word) > 0)
 
     result = ''