entproto: Added PhpNamespace() message option

Signed-off-by: Vincent Composieux <[email protected]>

Author: eko

entproto/README.md

@@ -174,14 +174,23 @@ func (User) Annotations() []schema.Annotation {
 By default the proto package name for the generated files will be `entpb` but it can be specified using a functional option:
 
 ```go
-
 func (MessageWithPackageName) Annotations() []schema.Annotation {
 	return []schema.Annotation{entproto.Message(
 		entproto.PackageName("io.entgo.apps.todo"),
 	)}
 }
 ```
 
+In case you want to add a custom PHP namespace, you can also add the following option:
+
+```go
+func (MessageWithPackageName) Annotations() []schema.Annotation {
+	return []schema.Annotation{entproto.Message(
+		entproto.PhpNamespace("My\\Company\\Todo"),
+	)}
+}
+```
+
 Per the protobuf style guide:
 
 > Package name should be in lowercase, and should correspond to the directory hierarchy. e.g., if a file is in my/package/, then the package name should be my.package.
@@ -331,7 +340,7 @@ message User {
 Field type mappings:
 
 | Ent Type       | Proto Type                | More considerations                                                                                                                                                         |
-|----------------|---------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| -------------- | ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | TypeBool       | bool                      |                                                                                                                                                                             |
 | TypeTime       | google.protobuf.Timestamp |                                                                                                                                                                             |
 | TypeJSON\[[]T] | repeated T                | T must be one of: `string`, `int32`, `int64`, `uint32`, `uint64`                                                                                                            |

entproto/adapter.go

@@ -121,6 +121,7 @@ func (a *Adapter) parse() error {
 
 		if _, ok := protoPackages[protoPkg]; !ok {
 			goPkg := a.goPackageName(protoPkg)
+
 			protoPackages[protoPkg] = &descriptorpb.FileDescriptorProto{
 				Name:    relFileName(protoPkg),
 				Package: &protoPkg,
@@ -130,6 +131,17 @@ func (a *Adapter) parse() error {
 				},
 			}
 		}
+
+		// Extract and set PhpNamespace if provided (even for existing packages)
+		msgAnnot, err := extractMessageAnnotation(genType)
+		if err == nil && msgAnnot.PhpNamespace != "" {
+			fd := protoPackages[protoPkg]
+			if fd.Options == nil {
+				fd.Options = &descriptorpb.FileOptions{}
+			}
+			fd.Options.PhpNamespace = &msgAnnot.PhpNamespace
+		}
+
 		fd := protoPackages[protoPkg]
 		fd.MessageType = append(fd.MessageType, messageDescriptor)
 		a.schemaProtoFiles[genType.Name] = *fd.Name

entproto/internal/entprototest/adapter_test.go

@@ -290,3 +290,9 @@ func (suite *AdapterTestSuite) TestOptionals() {
 	suite.Require().EqualValues(descriptorpb.FieldDescriptorProto_TYPE_MESSAGE, bytesField.GetType())
 	suite.Require().EqualValues("BytesValue", uuidField.GetMessageType().GetName())
 }
+
+func (suite *AdapterTestSuite) TestMessageWithPhpNamespace() {
+	fd, err := suite.adapter.GetFileDescriptor("MessageWithPhpNamespace")
+	suite.Require().NoError(err)
+	suite.Equal("My\\Company\\Todo", fd.GetFileOptions().GetPhpNamespace())
+}