Protobuf DSL: generate namespaced enum constants on root

The Protobuf DSL compiler was causing errors by generating un-namespaced constants for enums. In certain cases, this could result in a constant conflicting with a reserved Ruby word, such as "BEGIN." Instead, we generate the constants with the correct namespace outside of the class or module, ensuring that RBIs never contain code such as "BEGIN = 3" which is invalid Ruby syntax. Co-authored-by: Alexandre Terrasa <[email protected]>
Shopify · Nov 9, 2022 · fe46892 · fe46892
1 parent e35819f
commit fe46892
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 5 deletions.
diff --git a/lib/tapioca/dsl/compilers/protobuf.rb b/lib/tapioca/dsl/compilers/protobuf.rb
@@ -95,7 +95,18 @@ def decorate
               case descriptor
               when Google::Protobuf::EnumDescriptor
                 descriptor.to_h.each do |sym, val|
-                  klass.create_constant(sym.to_s, value: val.to_s)
+                  # For each enum value, create a namespaced constant on the root rather than an un-namespaced
+                  # constant within the class. This is because un-namespaced constants might conflict with reserved
+                  # Ruby words, such as "BEGIN." By namespacing them, we avoid this problem.
+                  #
+                  # Invalid syntax:
+                  # class Foo
+                  #   BEGIN = 3
+                  # end
+                  #
+                  # Valid syntax:
+                  # Foo::BEGIN = 3
+                  root.create_constant("#{constant}::#{sym}", value: val.to_s)
                 end
 
                 klass.create_method(

diff --git a/spec/tapioca/dsl/compilers/protobuf_spec.rb b/spec/tapioca/dsl/compilers/protobuf_spec.rb
@@ -193,11 +193,11 @@ def lookup(number); end
                     sig { params(symbol: Symbol).returns(T.nilable(Integer)) }
                     def resolve(symbol); end
                   end
-
-                  FIXED_AMOUNT = 1
-                  NULL = 0
-                  PERCENTAGE = 2
                 end
+
+                Cart::VALUE_TYPE::FIXED_AMOUNT = 1
+                Cart::VALUE_TYPE::NULL = 0
+                Cart::VALUE_TYPE::PERCENTAGE = 2
               RBI
 
               assert_equal(expected_enum_rbi, rbi_for("Cart::VALUE_TYPE"))