gapic-generator 0.2.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c88e9ae5990030e6fd090eaebcc037a128121621b2be5442e12353985530f90
-  data.tar.gz: 3dd8af72aecf6cb4b2b2fedf692e987bf8aa74c7484e40ee1de677020a141e0b
+  metadata.gz: 6eb09d3958e2bf3212a940df300ab29228dabdb7dabc31b1d9755eddee129c5b
+  data.tar.gz: e9431a7bc6f8680553e0bd682d68cdf6ec5fc61a6c564fec5c074f4884d362c9
 SHA512:
-  metadata.gz: 0f508a5ab35d5a342c9f6a208bd888277cf82e3ba15215120b2bbdd71a01dff675fe54758e78e5f0a3240dfe3528aefcb120f7cb8b1caa9477f3f6dd5e6a9e5b
-  data.tar.gz: c1188319beee864fa260f0c6ef5f2b9e34ec0b3778de3901cf544e8ab151075dfb450c45159cff4ae1c666c838f7b2ce105f5cb29c07cbe6f2ff9ff5f815f9ef
+  metadata.gz: 554bdbb8d1b6ca6dbfb646656cb91dc5f1080d60e8e7103771ca8e3352f09e33a0b9ef3edd86547c173cfc98e18d45da1be8b9648aef40525b1bfb13c5579d62
+  data.tar.gz: c998693373a980357d17d540fdbaa891959666bfb2b2dd12b2843eb9b8df0bca1808259305c25614a3951f695b004fa28b862888e1e9e4fa706ce6cfcd2b4f5f

data/CHANGELOG.md

@@ -1,5 +1,42 @@
 # 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.
+
+### 0.3.2 / 2020-04-12
+
+* Fix the talent.v4beta1 hack.
+
+### 0.3.1 / 2020-04-11
+
+* Disable ModuleLength metric for generated code.
+* Omit nonconforming resource patterns instead of crashing.
+
+### 0.3.0 / 2020-04-10
+
+* Detect when a resource is referenced implicitly via child_type, and generate path helpers.
+* Update grpc-google-iam-v1 dependency to require the latest version.
+* Generated require graph is more sane and does not include cycles.
+* The bundler entrypoint now loads the entire gem for wrapper gems.
+* Generated readmes are more useful and include a quickstart.
+* Package and service modules now have basic documentation.
+* Overloads for methods now have basic explanatory documentation, including how to pass an empty request.
+* Request object documentation no longer duplicates the method documentation.
+
+### 0.2.3 / 2020-04-06
+
+* No changes
+
 ### 0.2.2 / 2020-03-31
 
 * Updates to common protos, especially core types which were more than a year old.

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
@@ -140,8 +140,10 @@ module Gapic
           "{#{convert_address_to_ruby entity}::Client #{text}}"
         when Gapic::Schema::Method
           "{#{convert_address_to_ruby entity.parent}::Client##{entity.name.underscore} #{text}}"
-        when Gapic::Schema::Message, Gapic::Schema::Enum, Gapic::Schema::EnumValue
+        when Gapic::Schema::Message, Gapic::Schema::Enum
           "{#{convert_address_to_ruby entity} #{text}}"
+        when Gapic::Schema::EnumValue
+          "{#{convert_address_to_ruby entity.parent}::#{entity.name} #{text}}"
         when Gapic::Schema::Field
           "{#{convert_address_to_ruby entity.parent}##{entity.name} #{text}}"
         end

data/lib/gapic/generator/version.rb

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

data/lib/gapic/generators/default_generator.rb

@@ -63,16 +63,17 @@ module Gapic
         end
 
         # Gem level files
-        files << g("gem/gitignore.erb", ".gitignore",                   gem: gem)
-        files << g("gem/version.erb",   "lib/#{gem.version_file_path}", gem: gem)
-        files << g("gem/gemspec.erb",   "#{gem.name}.gemspec",          gem: gem)
-        files << g("gem/gemfile.erb",   "Gemfile",                      gem: gem)
-        files << g("gem/rakefile.erb",  "Rakefile",                     gem: gem)
-        files << g("gem/readme.erb",    "README.md",                    gem: gem)
-        files << g("gem/changelog.erb", "CHANGELOG.md",                 gem: gem)
-        files << g("gem/rubocop.erb",   ".rubocop.yml",                 gem: gem)
-        files << g("gem/yardopts.erb",  ".yardopts",                    gem: gem)
-        files << g("gem/license.erb",   "LICENSE.md",                   gem: gem)
+        files << g("gem/gitignore.erb",  ".gitignore",                   gem: gem)
+        files << g("gem/version.erb",    "lib/#{gem.version_file_path}", gem: gem)
+        files << g("gem/gemspec.erb",    "#{gem.name}.gemspec",          gem: gem)
+        files << g("gem/gemfile.erb",    "Gemfile",                      gem: gem)
+        files << g("gem/rakefile.erb",   "Rakefile",                     gem: gem)
+        files << g("gem/readme.erb",     "README.md",                    gem: gem)
+        files << g("gem/changelog.erb",  "CHANGELOG.md",                 gem: gem)
+        files << g("gem/rubocop.erb",    ".rubocop.yml",                 gem: gem)
+        files << g("gem/yardopts.erb",   ".yardopts",                    gem: gem)
+        files << g("gem/license.erb",    "LICENSE.md",                   gem: gem)
+        files << g("gem/entrypoint.erb", "lib/#{gem.name}.rb",           gem: gem)
 
         gem.proto_files.each do |proto_file|
           files << g("proto_docs/proto_file.erb", "proto_docs/#{proto_file.docs_file_path}", file: proto_file)

data/lib/gapic/presenters/field_presenter.rb

@@ -95,7 +95,7 @@ module Gapic
         base_type =
           if field.message?
             type = message_ruby_type field.message
-            output ? type : "#{type} | Hash"
+            output ? type : "#{type}, Hash"
           elsif field.enum?
             # TODO: handle when arg message is nil and enum is the type
             message_ruby_type field.enum

data/lib/gapic/presenters/gem_presenter.rb

@@ -37,6 +37,10 @@ module Gapic
         end
       end
 
+      def packages?
+        !packages.empty?
+      end
+
       def services
         @services ||= begin
           files = @api.generate_files
@@ -134,11 +138,13 @@ module Gapic
       end
 
       def free_tier?
-        gem_config(:free_tier) ? true : false
+        # Default to false unless the config is explicitly set to "true"
+        gem_config(:free_tier) == "true"
       end
 
       def yard_strict?
-        gem_config(:yard_strict) ? true : false
+        # Default to true unless the config is explicitly set to "false"
+        gem_config(:yard_strict) != "false"
       end
 
       def entrypoint_require

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
@@ -160,6 +165,16 @@ module Gapic
 
       def paged?
         return false if server_streaming? # Cannot page a streaming response
+
+        # HACK(dazuma, 2020-04-06): Two specific RPCs should not be paged.
+        # This is an intentionally hard-coded exception (and a temporary one,
+        # to be removed when these methods no longer conform to AIP-4233.) For
+        # detailed information, see internal link go/actools-talent-pagination.
+        address = @method.address.join "."
+        return false if address == "google.cloud.talent.v4beta1.ProfileService.SearchProfiles"
+        return false if address == "google.cloud.talent.v4beta1.JobService.SearchJobs"
+        return false if address == "google.cloud.talent.v4beta1.JobService.SearchJobsForAlert"
+
         paged_request?(@method.input) && paged_response?(@method.output)
       end
 
@@ -205,7 +220,7 @@ module Gapic
 
       def doc_types_for arg
         if arg.message?
-          "#{message_ruby_type arg.message} | Hash"
+          "#{message_ruby_type arg.message}, Hash"
         elsif arg.enum?
           # TODO: handle when arg message is nil and enum is the type
           message_ruby_type arg.enum

data/lib/gapic/presenters/package_presenter.rb

@@ -45,10 +45,25 @@ module Gapic
         ruby_namespace_for_address address
       end
 
+      def parent_namespace
+        namespace.split("::")[0...-1].join("::")
+      end
+
+      def module_name
+        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/resource_presenter.rb

@@ -38,15 +38,9 @@ module Gapic
           )
         end
 
-        @patterns.each do |pattern|
-          # URI path template verification for expected proto resource usage
-          if named_arg_patterns? pattern.segments
-            raise ArgumentError, "only resources without named patterns are supported, " \
-                                " not #{pattern.template}"
-          elsif positional_args? pattern.segments
-            raise ArgumentError, "only resources with named segments are supported, " \
-                                " not #{pattern.template}"
-          end
+        # Keep only patterns that can be used to create path helpers
+        @patterns.reject! do |pattern|
+          named_arg_patterns?(pattern.segments) || positional_args?(pattern.segments)
         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,8 +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
+        service_name_full.split("::").last
       end
 
       def proto_service_file_path
@@ -106,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
@@ -114,8 +150,12 @@ module Gapic
         service_file_path.split("/").last
       end
 
+      def service_directory_name
+        service_require.split("/").last
+      end
+
       def service_require
-        ruby_file_path @api, proto_service_name_full
+        ruby_file_path @api, service_name_full
       end
 
       def client_name
@@ -123,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
@@ -147,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
@@ -164,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
@@ -192,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
@@ -208,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
@@ -220,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
@@ -252,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
@@ -264,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/resource_lookup.rb

@@ -26,64 +26,42 @@ module Gapic
 
     # @private
     def lookup!
-      resources = @api.files.flat_map { |file| lookup_file_resource_descriptors file }
-      resources.compact.uniq
-    end
-
-    # @private
-    def lookup_file_resource_descriptors file
       resources = []
-      resources += file.resources.select { |resource| service_resource_types.include? resource.type }
-      resources += file.messages.flat_map { |message| lookup_message_resources_descriptors message }
-      resources
-    end
-
-    # @private
-    def service_resource_types
-      @service_resource_types ||= begin
-        @service.methods.flat_map do |method|
-          input_resource_types = message_resource_types method.input
-
-          if @api.generate_path_helpers_output?
-            output_resource_types = message_resource_types method.output
-            input_resource_types + output_resource_types
-          else
-            input_resource_types
-          end
-        end.uniq
+      @service.methods.each do |method|
+        resources.concat resources_for_message(method.input)
+        resources.concat resources_for_message(method.output) if @api.generate_path_helpers_output?
       end
+      resources.uniq
     end
 
     # @private
-    def message_resource_types message, seen_messages = []
-      return [] if seen_messages.include? message
+    def resources_for_message message, seen_messages = []
+      resources = []
+      return resources if seen_messages.include? message
       seen_messages << message
-      resource_types = []
-      resource_types << message.resource.type if message.resource
-      resource_types += message.nested_messages.map do |nested_message|
-        message_resource_types nested_message, seen_messages
+      resources << message.resource if message.resource
+      message.nested_messages.each do |nested_message|
+        resources.concat resources_for_message(nested_message, seen_messages)
       end
       message.fields.each do |field|
-        resource_types << field.resource_reference.type if field.resource_reference
-        resource_types += message_resource_types field.message, seen_messages if field.message?
+        resources.concat resources_for_reference(field.resource_reference) if field.resource_reference
+        resources.concat resources_for_message(field.message, seen_messages) if field.message?
       end
-      resource_types.flatten
+      resources
     end
 
     # @private
-    def lookup_message_resources_descriptors message
-      resources = []
-
-      # We don't expect service_resource_types to iclude nil, so we can use message.resource&.type
-      resources << message.resource if service_resource_types.include? message.resource&.type
-
-      if message.nested_messages
-        resources += message.nested_messages.flat_map do |nested_message|
-          lookup_message_resources_descriptors nested_message
-        end
+    # Given a reference (either a type or child type), return the corresponding
+    # resources.
+    def resources_for_reference reference
+      if (type = reference.type) && !type.empty?
+        Array(@api.lookup_resource_type(type))
+      elsif (child_type = reference.child_type) && !child_type.empty?
+        child_resource = @api.lookup_resource_type child_type
+        child_resource ? child_resource.parent_resources : []
+      else
+        []
       end
-
-      resources
     end
 
     # Lookup all resources for a given service.