gapic-generator 0.3.1 → 0.5.1

data/lib/gapic/presenters/service_presenter.rb

@@ -55,8 +55,26 @@ module Gapic
         @service.address
       end
 
+      # Returns a presenter for this service's delegate (if it is a common service)
+      # otherwise returns `nil`.
+      def common_service_delegate
+        unless defined? @common_service_delegate
+          delegate = @api.delegate_service_for @service
+          @common_service_delegate = delegate ? ServicePresenter.new(@api, delegate) : nil
+        end
+        @common_service_delegate
+      end
+
+      # The namespace of the client. Normally this is the version module. This
+      # may be different from the proto namespace for a common service.
       def namespace
-        return @service.ruby_package if @service.ruby_package.present?
+        # If this service is a common service, its client should go into its
+        # delegate's namespace rather than its own. For example, KMS includes
+        # the common IAMPolicy service, but that service's client should go
+        # into the KMS namespace.
+        return common_service_delegate.namespace if common_service_delegate
+
+        return ensure_absolute_namespace @service.ruby_package if @service.ruby_package.present?
 
         namespace = ruby_namespace_for_address @service.address[0...-1]
         fix_namespace @api, namespace
@@ -71,15 +89,25 @@ module Gapic
       end
 
       def name
-        @service.name
+        @api.fix_service_name @service.name
+      end
+
+      # The namespace of the protos. This may be different from the client
+      # namespace for a common service.
+      def proto_namespace
+        return ensure_absolute_namespace @service.ruby_package if @service.ruby_package.present?
+
+        namespace = ruby_namespace_for_address @service.address[0...-1]
+        @api.override_proto_namespaces? ? fix_namespace(@api, namespace) : namespace
       end
 
       def proto_service_name_full
-        fix_namespace @api, "#{namespace}::#{name}"
+        name_full = "#{proto_namespace}::#{@service.name}"
+        @api.override_proto_namespaces? ? fix_namespace(@api, name_full) : name_full
       end
 
       def module_name
-        proto_service_name_full.split("::").last
+        service_name_full.split("::").last
       end
 
       def proto_service_file_path
@@ -110,6 +138,10 @@ module Gapic
         "#{proto_service_name_full}::Stub"
       end
 
+      def service_name_full
+        fix_namespace @api, "#{namespace}::#{name}"
+      end
+
       def service_file_path
         service_require + ".rb"
       end
@@ -123,7 +155,7 @@ module Gapic
       end
 
       def service_require
-        ruby_file_path @api, proto_service_name_full
+        ruby_file_path @api, service_name_full
       end
 
       def client_name
@@ -131,7 +163,7 @@ module Gapic
       end
 
       def client_name_full
-        fix_namespace @api, "#{proto_service_name_full}::#{client_name}"
+        fix_namespace @api, "#{service_name_full}::#{client_name}"
       end
 
       def create_client_call
@@ -155,16 +187,17 @@ module Gapic
       end
 
       def client_endpoint
-        return @parent_service.client_endpoint if @parent_service
-        @service.host || default_config(:default_host) || "localhost"
+        @parent_service&.client_endpoint ||
+          common_service_delegate&.client_endpoint ||
+          @service.host ||
+          default_config(:default_host) ||
+          "localhost"
       end
 
       def client_scopes
-        @service.scopes || default_config(:oauth_scopes)
-      end
-
-      def client_proto_name
-        @service.address.join "."
+        common_service_delegate&.client_scopes ||
+          @service.scopes ||
+          default_config(:oauth_scopes)
       end
 
       def credentials_name
@@ -172,7 +205,7 @@ module Gapic
       end
 
       def credentials_name_full
-        fix_namespace @api, "#{proto_service_name_full}::#{credentials_name}"
+        fix_namespace @api, "#{service_name_full}::#{credentials_name}"
       end
 
       def credentials_class_xref
@@ -200,7 +233,7 @@ module Gapic
       end
 
       def helpers_require
-        ruby_file_path @api, "#{proto_service_name_full}::Helpers"
+        ruby_file_path @api, "#{service_name_full}::Helpers"
       end
 
       def references
@@ -216,7 +249,7 @@ module Gapic
       end
 
       def paths_name_full
-        fix_namespace @api, "#{proto_service_name_full}::#{paths_name}"
+        fix_namespace @api, "#{service_name_full}::#{paths_name}"
       end
 
       def paths_file_path
@@ -228,13 +261,17 @@ module Gapic
       end
 
       def paths_require
-        ruby_file_path @api, "#{proto_service_name_full}::#{paths_name}"
+        ruby_file_path @api, "#{service_name_full}::#{paths_name}"
       end
 
       def test_client_file_path
         service_file_path.sub ".rb", "_test.rb"
       end
 
+      def test_paths_file_path
+        service_file_path.sub ".rb", "_paths_test.rb"
+      end
+
       def test_client_operations_file_path
         service_file_path.sub ".rb", "_operations_test.rb"
       end
@@ -260,7 +297,7 @@ module Gapic
       end
 
       def operations_name_full
-        fix_namespace @api, "#{proto_service_name_full}::#{operations_name}"
+        fix_namespace @api, "#{service_name_full}::#{operations_name}"
       end
 
       def operations_file_path
@@ -272,7 +309,7 @@ module Gapic
       end
 
       def operations_require
-        ruby_file_path @api, "#{proto_service_name_full}::#{operations_name}"
+        ruby_file_path @api, "#{service_name_full}::#{operations_name}"
       end
 
       def lro_service

data/lib/gapic/ruby_info.rb

@@ -0,0 +1,93 @@
+# 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
+  ##
+  # Various Ruby language information useful for generators.
+  #
+  module RubyInfo
+    class << self
+      ##
+      # A sorted list of Ruby's keywords.
+      #
+      # @see https://docs.ruby-lang.org/en/2.7.0/keywords_rdoc.html
+      #
+      # @return [Array<String>]
+      #
+      def keywords
+        @keywords ||= [
+          "__ENCODING__",
+          "__LINE__",
+          "__FILE__",
+          "BEGIN",
+          "END",
+          "alias",
+          "and",
+          "begin",
+          "break",
+          "case",
+          "class",
+          "def",
+          "defined?",
+          "do",
+          "else",
+          "elsif",
+          "end",
+          "ensure",
+          "false",
+          "for",
+          "if",
+          "in",
+          "module",
+          "next",
+          "nil",
+          "not",
+          "or",
+          "redo",
+          "rescue",
+          "retry",
+          "return",
+          "self",
+          "super",
+          "then",
+          "true",
+          "undef",
+          "unless",
+          "until",
+          "when",
+          "while",
+          "yield"
+        ].freeze
+      end
+
+      ##
+      # A sorted list of method names that generated code should avoid.
+      # This includes methods of the Object class (including BasicObject and
+      # Kernel), Ruby keywords, and a few special names including "initialize"
+      # and "configure".
+      #
+      # @return [Array<String>]
+      #
+      def excluded_method_names
+        @excluded_method_names ||= begin
+          object_methods = (Object.instance_methods + Object.private_instance_methods).map(&:to_s)
+          other_methods = ["configure", "initialize"]
+          (object_methods + other_methods + keywords).sort.freeze
+        end
+      end
+    end
+  end
+end

data/lib/gapic/schema/api.rb

@@ -91,6 +91,13 @@ module Gapic
         configuration[:overrides][:namespace].fetch str, str
       end
 
+      def fix_service_name str
+        str = String str
+        return str if configuration[:overrides].nil?
+        return str if configuration[:overrides][:service].nil?
+        configuration[:overrides][:service].fetch str, str
+      end
+
       def generate_files
         @files.select(&:generate?)
       end
@@ -202,7 +209,7 @@ module Gapic
           config = config_file ? YAML.load_file(config_file) : {}
           protoc_options.each do |k, v|
             next if k == "configuration"
-            branch = key_to_str(k).split(".").reverse.inject(v) { |m, s| { str_to_key(s) => m } }
+            branch = parse_key(key_to_str(k)).reverse.inject(v) { |m, s| { str_to_key(s) => m } }
             config = deep_merge config, branch
           end
           config
@@ -225,6 +232,21 @@ module Gapic
         configuration[:generate_path_helpers_output] ||= false
       end
 
+      # Whether the override_proto_namespaces parameter was given in the configuration
+      def override_proto_namespaces_defined?
+        configuration.key? :override_proto_namespaces
+      end
+
+      # Sets the override_proto_namespaces parameter in the configuration
+      def override_proto_namespaces= value
+        configuration[:override_proto_namespaces] = value
+      end
+
+      # Whether namespace overrides apply to proto/grpc class references
+      def override_proto_namespaces?
+        configuration[:override_proto_namespaces] ||= false
+      end
+
       # Raw parsed json of the combined grpc service config files if provided
       # or an empty hash if no config was provided
       def grpc_service_config_raw
@@ -249,6 +271,28 @@ module Gapic
         @resource_types[resource_type]
       end
 
+      # Given a service, find all common services that use it as a delegate.
+      def common_services_for delegate
+        @delegate_to_common ||= begin
+          (configuration[:common_services] || {}).each_with_object({}) do |(c, d), mapping|
+            (mapping[d] ||= []) << c
+          end
+        end
+        all_services = services
+        @delegate_to_common.fetch(delegate.address.join("."), []).map do |addr|
+          addr = addr.split "."
+          all_services.find { |s| s.address == addr }
+        end.compact.uniq
+      end
+
+      # Given a common service, return its delegate.
+      def delegate_service_for common
+        addr = (configuration[:common_services] || {})[common.address.join "."]
+        return nil unless addr
+        addr = addr.split "."
+        services.find { |s| s.address == addr }
+      end
+
       private
 
       # Does a pre-analysis of all resources defined in the job. This has
@@ -291,6 +335,8 @@ module Gapic
         end
       end
 
+      # Parse a comma-delimited list of equals-delimited lists of strings, while
+      # mapping backslash-escaped commas and equal signs to literal characters.
       def parse_parameter str
         str.scan(/\\.|,|=|[^\\,=]+/)
            .each_with_object([[String.new]]) do |tok, arr|
@@ -307,6 +353,22 @@ module Gapic
            end
       end
 
+      # split the string on periods, but map backslash-escaped periods to
+      # literal periods.
+      def parse_key str
+        str.scan(/\.|\\.|[^\.\\]+/)
+           .each_with_object([String.new]) do |tok, arr|
+             if tok == "."
+               arr.append String.new
+             elsif tok.start_with? "\\"
+               arr.last << tok[1]
+             else
+               arr.last << tok
+             end
+             arr
+           end
+      end
+
       def str_to_key str
         str = str.to_s
         str.start_with?(":") ? str[1..-1].to_sym : str

data/templates/default/gem/gemfile.erb

@@ -2,3 +2,6 @@
 source "https://rubygems.org"
 
 gemspec
+
+# google-protobuf 3.12.0 requires Ruby 2.5 or later, so pin to 3.11 on older Rubies
+gem "google-protobuf", (RUBY_VERSION < "2.5" ? "~> 3.11.4" : "~> 3.12")

data/templates/default/gem/gemspec.erb

@@ -29,7 +29,9 @@ Gem::Specification.new do |gem|
   <%- end -%>
 
   gem.add_development_dependency "google-style", "~> 1.24.0"
-  gem.add_development_dependency "minitest", "~> 5.10"
+  gem.add_development_dependency "minitest", "~> 5.14"
+  gem.add_development_dependency "minitest-focus", "~> 1.1"
+  gem.add_development_dependency "minitest-rg", "~> 5.2"
   gem.add_development_dependency "rake", ">= 12.0"
   gem.add_development_dependency "redcarpet", "~> 3.0"
   gem.add_development_dependency "simplecov", "~> 0.18"

data/templates/default/gem/rakefile.erb

@@ -10,6 +10,7 @@ RuboCop::RakeTask.new
 require "rake/testtask"
 desc "Run tests."
 Rake::TestTask.new do |t|
+  t.libs << "test"
   t.test_files = FileList["test/**/*_test.rb"]
   t.warning = false
 end

data/templates/default/gem/test_helper.erb

@@ -0,0 +1,8 @@
+<%- assert_locals gem -%>
+<%= render partial: "shared/header" -%>
+
+require "simplecov"
+
+require "minitest/autorun"
+require "minitest/focus"
+require "minitest/rg"

data/templates/default/layouts/_ruby.erb

@@ -5,12 +5,13 @@
 <%= @requires -%>
 <%- end -%>
 
-<%- namespace.split("::").each_with_index do |ns, i| -%>
+<%- namespace_components = namespace.split("::").reject(&:empty?) -%>
+<%- namespace_components.each_with_index do |ns, i| -%>
 <%= indent "module #{ns}", i*2 %>
 <%- end -%>
-<%= indent yield, namespace.split("::").count*2 %>
-<%- namespace.split("::").count.times do |i| -%>
-<%= indent "end", (namespace.split("::").count-1-i)*2 %>
+<%= indent yield, namespace_components.count*2 %>
+<%- namespace_components.count.times do |i| -%>
+<%= indent "end", (namespace_components.count-1-i)*2 %>
 <%- end -%>
 <%- if instance_variable_defined? :@footer -%>
 

data/templates/default/proto_docs/_message.erb

@@ -10,8 +10,8 @@
 <%- end -%>
 <%- end -%>
 class <%= message.name %>
-  include Google::Protobuf::MessageExts
-  extend Google::Protobuf::MessageExts::ClassMethods
+  include ::Google::Protobuf::MessageExts
+  extend ::Google::Protobuf::MessageExts::ClassMethods
   <%- message.nested_messages.each do |submsg| -%>
 
   <%= indent_tail render(partial: "proto_docs/message", locals: { message: submsg }), 2 %>

data/templates/default/service/client.erb

@@ -2,5 +2,5 @@
 <%= render partial: "service/client/client",
            layout: "layouts/ruby",
            locals: { service: service,
-                     namespace: service.proto_service_name_full }
+                     namespace: service.service_name_full }
 %>

data/templates/default/service/client/_client.erb

@@ -29,7 +29,7 @@ class <%= service.client_name %>
   # To modify the configuration for all <%= service.name %> clients:
   #
   #     <%= service.client_name_full %>.configure do |config|
-  #       config.timeout = 10_000
+  #       config.timeout = 10.0
   #     end
   #
   # @yield [config] Configure the <%= service.client_name %> client.
@@ -75,7 +75,7 @@ class <%= service.client_name %>
   # configuration:
   #
   #     client = <%= service.client_name_full %>.new do |config|
-  #       config.timeout = 10_000
+  #       config.timeout = 10.0
   #     end
   #
   # @yield [config] Configure the <%= service.name %> client.
@@ -100,15 +100,17 @@ class <%= service.client_name %>
     if credentials.is_a?(String) || credentials.is_a?(Hash)
       credentials = Credentials.new credentials, scope: @config.scope
     end
-    @quota_project_id = credentials.respond_to?(:quota_project_id) ? credentials.quota_project_id : nil
+    @quota_project_id = @config.quota_project
+    @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
 
     <%- if service.lro? -%>
     <%= service.lro_client_ivar %> = <%= service.operations_name %>.new do |config|
       config.credentials = credentials
+      config.endpoint = @config.endpoint
     end
 
     <%- end -%>
-    @<%= service.stub_name %> = Gapic::ServiceStub.new(
+    @<%= service.stub_name %> = ::Gapic::ServiceStub.new(
       <%= service.proto_service_stub_name_full %>,
       credentials:  credentials,
       endpoint:     @config.endpoint,
@@ -117,6 +119,15 @@ class <%= service.client_name %>
     )
   end
 
+<%- if service.lro? -%>
+  ##
+  # Get the associated client for long-running operations.
+  #
+  # @return [<%= service.operations_name_full %>]
+  #
+  attr_reader :<%= service.lro_client_var %>
+
+<%- end -%>
   # Service calls
   <%- service.methods.each do |method| -%>