gapic-generator 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 141fbba25c93dca9ccac5c4a380f7a0f8c1c1643ef2e9517fbb158ba92db822c
-  data.tar.gz: c61466f199a4d34b6c1fefea9aa8773abc7d9514dfb232385a1e6806e49140f2
+  metadata.gz: 6eb09d3958e2bf3212a940df300ab29228dabdb7dabc31b1d9755eddee129c5b
+  data.tar.gz: e9431a7bc6f8680553e0bd682d68cdf6ec5fc61a6c564fec5c074f4884d362c9
 SHA512:
-  metadata.gz: 1cefa5cb936a4d9f211c0af9f03a9bcbd4ba76f35417cc3a1723164c949dc93b0f9f8be3602ac882d19c2a1109eed7b47150f4be4587ab5d5a368d7942df14f5
-  data.tar.gz: eab763dd18a81db68af29cc55e54b69f7f8fe504bca56aa93925a66e0c8f548335a4700c0cb89cb13aef65f5de7d640dc8dc0a704190e6a06f7ecdaeb294b065
+  metadata.gz: 554bdbb8d1b6ca6dbfb646656cb91dc5f1080d60e8e7103771ca8e3352f09e33a0b9ef3edd86547c173cfc98e18d45da1be8b9648aef40525b1bfb13c5579d62
+  data.tar.gz: c998693373a980357d17d540fdbaa891959666bfb2b2dd12b2843eb9b8df0bca1808259305c25614a3951f695b004fa28b862888e1e9e4fa706ce6cfcd2b4f5f

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Release History for gapic-generator
 
+### 0.4.0 / 2020-04-20
+
+* Support generating clients of "common" interfaces by delegating to another service config.
+* Added an accessor for the long-running-operation client from the main client.
+* Generate tests for the configure method and operations client accessor.
+* Prevent generation of RPC or factory methods with reserved names.
+* Fixed: LRO clients weren't inheriting custom endpoints from the main client.
+* Fixed: Cross-references weren't interpreted if the text included backticks, spaces, or hyphens.
+
 ### 0.3.3 / 2020-04-13
 
 * Fix cross-reference links to multi-word enum values.

data/lib/gapic/formatting_utils.rb

@@ -22,7 +22,7 @@ module Gapic
   #
   module FormattingUtils
     @brace_detector = /\A(?<pre>[^`]*(`[^`]*`[^`]*)*[^`\\])?\{(?<inside>[^\s][^}]*)\}(?<post>.*)\z/m
-    @xref_detector = /\A(?<pre>[^`]*(`[^`]*`[^`]*)*)?\[(?<text>[\w\.]+)\]\[(?<addr>[\w\.]+)\](?<post>.*)\z/m
+    @xref_detector = /\A(?<pre>[^`]*(`[^`]*`[^`]*)*)?\[(?<text>[\w\. `-]+)\]\[(?<addr>[\w\.]+)\](?<post>.*)\z/m
     @list_element_detector = /\A\s*(\*|\+|-|[0-9a-zA-Z]+\.)\s/
 
     class << self

data/lib/gapic/generator/version.rb

@@ -16,6 +16,6 @@
 
 module Gapic
   module Generator
-    VERSION = "0.3.3"
+    VERSION = "0.4.0"
   end
 end

data/lib/gapic/presenters/method_presenter.rb

@@ -16,6 +16,7 @@
 
 require "active_support/inflector"
 require "gapic/path_template"
+require "gapic/ruby_info"
 require "gapic/helpers/namespace_helper"
 
 module Gapic
@@ -36,7 +37,11 @@ module Gapic
       end
 
       def name
-        ActiveSupport::Inflector.underscore @method.name
+        @name ||= begin
+          candidate = ActiveSupport::Inflector.underscore @method.name
+          candidate = "call_#{candidate}" if Gapic::RubyInfo.excluded_method_names.include? candidate
+          candidate
+        end
       end
 
       def kind

data/lib/gapic/presenters/package_presenter.rb

@@ -53,10 +53,17 @@ module Gapic
         namespace.split("::").last
       end
 
+      # Services whose clients should be generated in this package namespace.
       def services
         @services ||= begin
           files = @api.generate_files.select { |f| f.package == @package }
-          files.map(&:services).flatten.map { |s| ServicePresenter.new @api, s }
+          services = files.map(&:services).flatten
+          # Omit common services in this package. Common service clients do not
+          # go into their own package.
+          normal_services = services.select { |s| @api.delegate_service_for(s).nil? }
+          # But include common services that delegate to normal services in this package.
+          common_services = normal_services.flat_map { |s| @api.common_services_for s }
+          (normal_services + common_services).map { |s| ServicePresenter.new @api, s }
         end
       end
 

data/lib/gapic/presenters/service_presenter.rb

@@ -55,7 +55,25 @@ 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
+        # 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 @service.ruby_package if @service.ruby_package.present?
 
         namespace = ruby_namespace_for_address @service.address[0...-1]
@@ -74,12 +92,22 @@ module Gapic
         @service.name
       end
 
+      # The namespace of the protos. This may be different from the client
+      # namespace for a common service.
+      def proto_namespace
+        return @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}::#{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,12 +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)
+        common_service_delegate&.client_scopes ||
+          @service.scopes ||
+          default_config(:oauth_scopes)
       end
 
       def client_proto_name
@@ -172,7 +209,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 +237,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 +253,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,7 +265,7 @@ 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
@@ -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

@@ -202,7 +202,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 +225,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 +264,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 +328,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 +346,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/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

@@ -105,6 +105,7 @@ class <%= service.client_name %>
     <%- if service.lro? -%>
     <%= service.lro_client_ivar %> = <%= service.operations_name %>.new do |config|
       config.credentials = credentials
+      config.endpoint = @config.endpoint
     end
 
     <%- end -%>
@@ -117,6 +118,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| -%>
 

data/templates/default/service/credentials.erb

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

data/templates/default/service/operations.erb

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

data/templates/default/service/paths.erb

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

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

@@ -17,8 +17,22 @@ class <%= service.client_name_full %>Test < Minitest::Test
 <% service.methods.each do |method| %>
 <%= indent render(partial: "service/test/method/#{method.kind}",
                   locals: { method: method }), 2 %>
-<% if method != service.methods.last %>
 
 <% end %>
-<% end %>
+<%= indent render(partial: "service/test/method/configure", locals: { service: service }), 2 %>
+<%- if service.lro? -%>
+
+  def test_<%= service.lro_client_var %>
+    grpc_channel = GRPC::Core::Channel.new "localhost:8888", nil, :this_channel_is_insecure
+
+    client = nil
+    Gapic::ServiceStub.stub :new, nil do
+      client = <%= service.client_name_full =%>.new do |config|
+        config.credentials = grpc_channel
+      end
+    end
+
+    assert_kind_of <%= service.operations_name_full %>, client.<%= service.lro_client_var %>
+  end
+<%- end -%>
 end

data/templates/default/service/test/client_operations.erb

@@ -17,8 +17,8 @@ class <%= service.operations_name_full %>Test < Minitest::Test
 <% service.lro_service.methods.each do |method| %>
 <%= indent render(partial: "service/test/method/#{method.kind}",
                   locals: { client_name_full: service.operations_name_full, method: method }), 2 %>
-<% if method != service.lro_service.methods.last %>
 
 <% end %>
-<% end %>
+<%= indent render(partial: "service/test/method/configure",
+                  locals: { service: service, client_name_full: service.operations_name_full }), 2 %>
 end

data/templates/default/service/test/method/_configure.erb

@@ -0,0 +1,19 @@
+<%- assert_locals service -%>
+<%- full_client_name = defined?(client_name_full) ? client_name_full : service.client_name_full -%>
+def test_configure
+  grpc_channel = GRPC::Core::Channel.new "localhost:8888", nil, :this_channel_is_insecure
+
+  client = block_config = config = nil
+  Gapic::ServiceStub.stub :new, nil do
+    client = <%= full_client_name =%>.new do |config|
+      config.credentials = grpc_channel
+    end
+  end
+
+  config = client.configure do |c|
+    block_config = c
+  end
+
+  assert_same block_config, config
+  assert_kind_of <%= full_client_name %>::Configuration, config
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gapic-generator
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Ernest Landrito
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-13 00:00:00.000000000 Z
+date: 2020-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -233,6 +233,7 @@ files:
 - lib/gapic/presenters/sample_presenter.rb
 - lib/gapic/presenters/service_presenter.rb
 - lib/gapic/resource_lookup.rb
+- lib/gapic/ruby_info.rb
 - lib/gapic/runner.rb
 - lib/gapic/schema.rb
 - lib/gapic/schema/api.rb
@@ -323,6 +324,7 @@ files:
 - templates/default/service/test/method/_assert_response.erb
 - templates/default/service/test/method/_bidi.erb
 - templates/default/service/test/method/_client.erb
+- templates/default/service/test/method/_configure.erb
 - templates/default/service/test/method/_normal.erb
 - templates/default/service/test/method/_server.erb
 - templates/default/service/test/method/_setup.erb