feat: Resolve keyword conflicts with path pattern variable names (#1096)

gapic-generator/lib/gapic/path_pattern/parser.rb

@@ -118,7 +118,7 @@ def self.try_capture_simple_resource_id_segment url_pattern
         match = simple_resource_id_regex.match url_pattern
         segment_pattern = match[:segment_pattern]
 
-        resource_name = ActiveSupport::Inflector.underscore match[:resource_name]
+        resource_name = format_variable match[:resource_name]
         resource_pattern = match[:resource_pattern] if match.names.include? "resource_pattern"
         resource_patterns = resource_pattern.nil? ? [] : [resource_pattern]
 
@@ -143,13 +143,22 @@ def self.capture_collection_id_segment url_pattern
         [segment, remainder]
       end
 
-      # Formats path pattern variables to snake case if nonconforming.
+      # Formats variables within a path pattern.
       # @private
       def self.format_pattern pattern
-        pattern.gsub(/\{([a-z][a-zA-Z0-9]*)\}/) do |match|
-          ActiveSupport::Inflector.underscore match
+        pattern.gsub(/\{([a-zA-Z0-9_]+)\}/) do
+          "{#{format_variable(::Regexp.last_match(1))}}"
         end
       end
+
+      # Formats path pattern variables to snake case and resolves
+      # naming conflicts with reserved keywords.
+      # @private
+      def self.format_variable name
+        name = ActiveSupport::Inflector.underscore name
+        name = "#{name}_param" if Gapic::RubyInfo.keywords.include? name
+        name
+      end
     end
   end
 end

gapic-generator/test/gapic/presenters/pattern_presenter_test.rb

@@ -71,4 +71,12 @@ def test_snake_case_segment_pattern
     assert_equal "snakeCase/{snake_case}/patternTest/{pattern_test}", presenter.pattern
     assert_equal "snakeCase/\#{snake_case}/patternTest/\#{pattern_test}", presenter.path_string
   end
+
+  def test_reserved_keyword_segment_pattern
+    pattern = "modules/{module}/cases/{case}"
+    presenter = Gapic::Presenters::ResourcePresenter::PatternPresenter.new pattern
+    assert_equal ["module_param", "case_param"], presenter.arguments
+    assert_equal "modules/{module_param}/cases/{case_param}", presenter.pattern
+    assert_equal "modules/\#{module_param}/cases/\#{case_param}", presenter.path_string
+  end
 end

shared/output/gapic/templates/garbage/lib/so/much/trash/resource_names/paths.rb

@@ -186,6 +186,14 @@ def no_arguments_multi_path **args
           #
           #   @param request [String]
           #
+          # @overload resource_name_pattern_request_path(customer:, case_param:)
+          #   The resource will be in the following format:
+          #
+          #   `customers/{customer}/cases/{case_param}`
+          #
+          #   @param customer [String]
+          #   @param case_param [String]
+          #
           # @return [::String]
           def resource_name_pattern_request_path **args
             resources = {
@@ -196,6 +204,11 @@ def resource_name_pattern_request_path **args
               end),
               "request" => (proc do |request:|
                 "patternrequests/#{request}"
+              end),
+              "case_param:customer" => (proc do |customer:, case_param:|
+                raise ::ArgumentError, "customer cannot contain /" if customer.to_s.include? "/"
+
+                "customers/#{customer}/cases/#{case_param}"
               end)
             }
 

shared/output/gapic/templates/garbage/test/so/much/trash/resource_names_paths_test.rb

@@ -119,6 +119,9 @@ def test_resource_name_pattern_request_path
 
       path = client.resource_name_pattern_request_path request: "value0"
       assert_equal "patternrequests/value0", path
+
+      path = client.resource_name_pattern_request_path customer: "value0", case_param: "value1"
+      assert_equal "customers/value0/cases/value1", path
     end
   end
 

shared/protos/garbage/resource_names.proto

@@ -135,6 +135,7 @@ message ResourceNamePatternRequest {
     type: "resourcenames.example.com/ResourceNamePatternRequest"
     pattern: "customers/{customer}/path/{path=**}"
     pattern: "patternrequests/{request}"
+    pattern: "customers/{customer}/cases/{case}"
   };
 
   string name = 1;