gapic-generator 0.6.0 → 0.6.5

data/lib/gapic/presenters/field_presenter.rb

@@ -80,6 +80,10 @@ module Gapic
         @field.enum?
       end
 
+      def proto3_optional?
+        @field.proto3_optional?
+      end
+
       def repeated?
         @field.repeated?
       end
@@ -88,6 +92,14 @@ module Gapic
         @field.map?
       end
 
+      def oneof?
+        @field.oneof?
+      end
+
+      def oneof_name
+        @message.oneof_decl[@field.oneof_index].name
+      end
+
       protected
 
       def field_doc_types field, output

data/lib/gapic/presenters/gem_presenter.rb

@@ -48,6 +48,10 @@ module Gapic
         end
       end
 
+      def first_non_common_service
+        services.find { |service| service.common_service_delegate.nil? }
+      end
+
       def proto_files
         @proto_files ||= begin
           files = @api.files
@@ -134,7 +138,17 @@ module Gapic
       end
 
       def api_id
-        gem_config :api_id
+        raw_id = gem_config :api_id
+        return nil unless raw_id
+        raw_id.include?(".") ? raw_id : "#{raw_id}.googleapis.com"
+      end
+
+      def api_shortname
+        gem_config :api_shortname
+      end
+
+      def issue_tracker_url
+        gem_config :issue_tracker_url
       end
 
       def free_tier?
@@ -164,7 +178,7 @@ module Gapic
       end
 
       def dependencies
-        deps = { "gapic-common" => "~> 0.2" }
+        deps = { "gapic-common" => "~> 0.3" }
         deps["grpc-google-iam-v1"] = [">= 0.6.10", "< 2.0"] if iam_dependency?
         extra_deps = gem_config :extra_dependencies
         deps.merge! extra_deps if extra_deps

data/lib/gapic/presenters/method_presenter.rb

@@ -15,7 +15,7 @@
 # limitations under the License.
 
 require "active_support/inflector"
-require "gapic/path_template"
+require "gapic/uri_template"
 require "gapic/ruby_info"
 require "gapic/helpers/namespace_helper"
 
@@ -92,6 +92,11 @@ module Gapic
         have_oneof = []
 
         @method.input.fields.each do |field|
+          unless field.oneof?
+            selected_fields << field
+            next
+          end
+
           idx = field.oneof_index
           selected_fields << field unless have_oneof.include? idx
           have_oneof << idx
@@ -194,8 +199,7 @@ module Gapic
       # @return [Array<String>] The segment key names.
       #
       def routing_params
-        segments = Gapic::PathTemplate.parse method_path
-        segments.select { |s| s.is_a? Gapic::PathTemplate::Segment }.map(&:name)
+        Gapic::UriTemplate.parse_arguments method_path
       end
 
       def routing_params?

data/lib/gapic/presenters/resource_presenter.rb

@@ -14,7 +14,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "gapic/path_template"
+require "gapic/path_pattern"
 require "active_support/inflector"
 
 module Gapic
@@ -27,7 +27,7 @@ module Gapic
       def initialize resource
         @resource = resource
 
-        @patterns = resource.pattern.map { |template| PatternPresenter.new template }
+        @patterns = resource.pattern.map { |pattern| PatternPresenter.new pattern }
 
         # Keep only patterns that can be used to create path helpers
         @patterns.filter!(&:useful_for_helpers?)
@@ -53,59 +53,51 @@ module Gapic
       # A presenter for a particular pattern
       #
       class PatternPresenter
-        def initialize template
-          @template = template
-          @segments = Gapic::PathTemplate.parse template
-          @arguments = arg_segments.map(&:name)
+        def initialize pattern_string
+          @pattern = pattern_string
+          @parsed_pattern = Gapic::PathPattern.parse pattern_string
           @path_string = build_path_string
         end
 
-        attr_reader :template, :segments, :arguments, :path_string
+        attr_reader :pattern, :path_string
 
         def useful_for_helpers?
-          arg_segments.none?(&:nontrivial_pattern?) && arg_segments.none?(&:positional?)
+          !@parsed_pattern.positional_segments? && !@parsed_pattern.nontrivial_pattern_segments?
+        end
+
+        def arguments
+          @parsed_pattern.arguments
         end
 
         def formal_arguments
-          arguments.map { |arg| "#{arg}:" }.join ", "
+          @parsed_pattern.arguments.map { |name| "#{name}:" }.join ", "
         end
 
         def arguments_key
-          arguments.sort.join ":"
+          @parsed_pattern.arguments.sort.join ":"
         end
 
         def arguments_with_dummy_values
-          arguments.each_with_index.map { |arg, index| "#{arg}: \"value#{index}\"" }.join ", "
+          @parsed_pattern.arguments.each_with_index.map { |name, index| "#{name}: \"value#{index}\"" }.join ", "
         end
 
         def expected_path_for_dummy_values
-          index = -1
-          segments.map do |segment|
-            if segment.is_a? Gapic::PathTemplate::Segment
-              index += 1
-              "value#{index}"
+          index = 0
+          @parsed_pattern.segments.map do |segment|
+            if segment.provides_arguments?
+              segment_dummy_path = segment.expected_path_for_dummy_values index
+              index += segment.arguments.length
+              segment_dummy_path
             else
-              # Should be a String
-              segment
+              segment.pattern
             end
-          end.join
+          end.join "/"
         end
 
         private
 
-        def arg_segments
-          segments.select { |segment| segment.is_a? Gapic::PathTemplate::Segment }
-        end
-
         def build_path_string
-          segments.map do |segment|
-            if segment.is_a? Gapic::PathTemplate::Segment
-              "\#{#{segment.name}}"
-            else
-              # Should be a String
-              segment
-            end
-          end.join
+          @parsed_pattern.segments.map(&:path_string).join "/"
         end
       end
     end

data/lib/gapic/presenters/service_presenter.rb

@@ -203,7 +203,8 @@ module Gapic
       def client_scopes
         common_service_delegate&.client_scopes ||
           @service.scopes ||
-          default_config(:oauth_scopes)
+          default_config(:oauth_scopes) ||
+          []
       end
 
       def credentials_name

data/lib/gapic/runner.rb

@@ -48,8 +48,10 @@ module Gapic
       output_files = generator.new(api).generate
 
       # Create and write the response
-      Google::Protobuf::Compiler::CodeGeneratorResponse.new \
+      response = Google::Protobuf::Compiler::CodeGeneratorResponse.new \
         file: output_files
+      response.supported_features = Google::Protobuf::Compiler::CodeGeneratorResponse::FEATURE_PROTO3_OPTIONAL
+      response
     end
 
     # Run protoc generation.

data/lib/gapic/schema/api.rb

@@ -44,14 +44,18 @@ module Gapic
       #
       # @param request [Google::Protobuf::Compiler::CodeGeneratorRequest]
       #   The request object.
-      def initialize request
+      # @param error_output [IO] An IO to write any errors/warnings to.
+      # @param configuration [Hash] Optional override of configuration.
+      def initialize request, error_output: STDERR, configuration: nil
         @request = request
         loader = Loader.new
         @files = request.proto_file.map do |fd|
           loader.load_file fd, request.file_to_generate.include?(fd.name)
         end
         @files.each { |f| f.parent = self }
+        @configuration = configuration
         @resource_types = analyze_resources
+        sanity_checks error_output
       end
 
       def containing_api
@@ -295,6 +299,18 @@ module Gapic
 
       private
 
+      # Perform a variety of sanity checks on the data, and prints errors to
+      # the given output as appropriate.
+      #
+      # @param output [IO] Stream to write outputs to.
+      def sanity_checks output
+        addrs = services.map { |service| service.address.join "." }
+        configuration[:common_services]&.each do |k, v|
+          output.puts "WARNING: configured common service #{k} is not present" unless addrs.include? k
+          output.puts "WARNING: configured common service delegate #{v} is not present" unless addrs.include? v
+        end
+      end
+
       # Does a pre-analysis of all resources defined in the job. This has
       # two effects:
       # * Side effect: each resource has its parent_resources field set.

data/lib/gapic/schema/wrappers.rb

@@ -15,6 +15,7 @@
 # limitations under the License.
 
 require "gapic/formatting_utils"
+require "gapic/path_pattern"
 
 module Gapic
   module Schema
@@ -654,6 +655,15 @@ module Gapic
         field_behavior.include? Google::Api::FieldBehavior::OPTIONAL
       end
 
+      # Denotes a field as a part of oneof.
+      # oneof_index is an int field so it'll be 0 by default for every field
+      # and an index in the message's oneof table for the oneof fields
+      # but since the indexes in the message's oneof table start with 0 as well
+      # we need this to determine whether the field is a part of the oneof
+      def oneof?
+        @descriptor.field? :oneof_index
+      end
+
       # Denotes a field as required. This indicates that the field **must** be
       # provided as part of the request, and failure to do so will cause an
       # error (usually `INVALID_ARGUMENT`).
@@ -730,7 +740,8 @@ module Gapic
         :default_value,
         :oneof_index,
         :json_name,
-        :options
+        :options,
+        :proto3_optional?
       )
     end
 
@@ -761,30 +772,32 @@ module Gapic
     #   @return [Array<Gapic::Schema::ResourceDescriptor>] The resource
     #     descriptor.
     # @!attribute [r] parsed_patterns
-    #   @return [Array<Array<String>>] The normalized, segmented forms of the
-    #     patterns. Normalized means all ID segments are replaced by asterisks
+    #   @return [Array<String>] The template form of the
+    #     patterns. Template means all ID segments are replaced by asterisks
     #     to remove non-structural differences due to different names being
-    #     used. Segmented means simply split on slashes.
+    #     used.
     #     For example, if a pattern is `"projects/{project}""`, the
-    #     corresponding parsed pattern would be `["projects", "*"]`.
+    #     corresponding parsed pattern would be `"projects/*"]`.
+    # @!attribure [r] parsed_parent_patterns
+    #   return [Array<String>] Parsed patterns for the expected parents.
     # @!attribute [r] parent_resources
     #   @return [Array<Gapic::Schema::Resource>] Parent resources
     class Resource
       extend Forwardable
-      attr_reader :descriptor, :parsed_patterns, :parent_resources
+      attr_reader :descriptor, :parsed_patterns, :parsed_parent_patterns, :parent_resources
       attr_accessor :parent
 
       # Initializes a resource object.
-      # @param descriptor [Google::Protobuf::ResourceDescriptor] the protobuf
+      # @param descriptor [Google::Api::ResourceDescriptor] the protobuf
       #   representation of this resource.
       def initialize descriptor
         @parent = nil
         @descriptor = descriptor
-        @parsed_patterns = descriptor.pattern.map do |pattern|
-          pattern.split("/").map do |segment|
-            segment =~ %r{\{[^/\}]+(=[^\}]+)?\}} ? "*" : segment
-          end.freeze
+        patterns = descriptor.pattern.map do |pattern|
+          Gapic::PathPattern.parse pattern
         end.freeze
+        @parsed_patterns = patterns.map(&:template).compact.uniq.freeze
+        @parsed_parent_patterns = patterns.map(&:parent_template).compact.uniq.freeze
         @parent_resources = []
       end
 
@@ -800,15 +813,6 @@ module Gapic
         parent&.containing_file
       end
 
-      # Returns parsed patterns for the expected parents.
-      # @return [Array<Array<String>>]
-      def parsed_parent_patterns
-        @parsed_patterns.map do |pat|
-          parent = pat.last =~ /^\*\*?$/ ? pat[0...-2] : pat[0...-1]
-          parent.empty? ? nil : parent
-        end.compact.uniq
-      end
-
       # @!method type
       #   @return [String] the resource type string.
       # @!method pattern

data/lib/gapic/uri_template.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require "gapic/uri_template/parser"
+
+module Gapic
+  # TODO: Enter docs
+  # Dooooooooocs!!!
+  module UriTemplate
+    # Parse arguments from a URI template.
+    # @see https://tools.ietf.org/html/rfc6570 URI Template
+    #
+    # used to satisfy AIP-4222 Routing headers
+    # @see https://google.aip.dev/client-libraries/4222
+    #
+    # @param uri_template [String] The URI template to be parsed.
+    #
+    # @return [Array<String>] The arguments of the URI template.
+    def self.parse_arguments uri_template
+      Parser.parse_arguments uri_template
+    end
+  end
+end

data/lib/gapic/uri_template/parser.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Gapic
+  module UriTemplate
+    # A URI template parser.
+    # see https://tools.ietf.org/html/rfc6570 URI Template
+    #
+    # @!attribute [r] path_pattern
+    #   @return [String] The path pattern to be parsed.
+    # @!attribute [r] segments
+    #   @return [Array<Segment|String>] The segments of the parsed path pattern.
+    module Parser
+      # @private
+      # /((?<positional>\*\*?)|{(?<name>[^\/]+?)(?:=(?<template>.+?))?})/
+      URI_TEMPLATE = %r{
+        (
+          (?<positional>\*\*?)
+          |
+          {(?<name>[^\/]+?)(?:=(?<template>.+?))?}
+        )
+      }x.freeze
+
+      def self.parse_arguments uri_template
+        arguments = []
+
+        while (match = URI_TEMPLATE.match uri_template)
+          # The String before the match needs to be added to the segments
+          arguments << match[:name] if match[:name]
+          uri_template = match.post_match
+        end
+
+        arguments
+      end
+    end
+  end
+end

data/lib/google/protobuf/compiler/plugin.pb.rb

@@ -1,7 +1,8 @@
 # encoding: utf-8
 
 ##
-# This file is auto-generated. DO NOT EDIT!
+# This file was auto-generated initially but now is hand-edited to add support 
+# for response features and proto3_optional
 #
 require 'protobuf'
 
@@ -54,6 +55,8 @@ module Google
       end
 
       class CodeGeneratorResponse
+        FEATURE_PROTO3_OPTIONAL = 1
+
         class File
           optional :string, :name, 1
           optional :string, :insertion_point, 2
@@ -61,6 +64,7 @@ module Google
         end
 
         optional :string, :error, 1
+        optional :int32, :supported_features, 2
         repeated ::Google::Protobuf::Compiler::CodeGeneratorResponse::File, :file, 15
       end