gapic-generator 0.3.1 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c03115844b852a0a3434c5f17fa3140e49c9c2eccefd12f66bc7613c5117ea35
-  data.tar.gz: 265ca6503985d740d36bc4d0660c14d37f877d3362f181b56bed1d5ddd1ffb2f
+  metadata.gz: 3aaec7f146400572f3b4ad346c8a69849ff3903073eadabd7eec6f6e882d6bb9
+  data.tar.gz: 39987ab08fe97c6e4acdcfe3357e398df99db73f2ab95960c8c1015456f79224
 SHA512:
-  metadata.gz: a8319b1bd6e1ac17ab22b365e97056b09d4f7537390e4689dca4f58d3d1587ef749ed95f0bd457bc2d30943a8b418204a416743003fb4e5339a983cb839673f4
-  data.tar.gz: 8b3bfae44552ee39a3f642aa9703dbc6a9eebe01174dfff0e20a9c0aecd69c3ddfb0ec669f62a63b51d275fd458ed4e65948bc3a434a15ed18b14316b3f2ff12
+  metadata.gz: 87bfd8d75d938d8e82ff4fc5b17aab92260dedb745faf47c5abda914920145d85a0415c43ddc57126bd7942fe1b76801ed53d4a2d0b14f851adb3539ce34d0c6
+  data.tar.gz: 89e9820c8f7ba98c77165e3ff0fb38ae2b84b333873bf458ca7c87dca1e0a38c7a09f5940027fe081a2589ef429488ebd7bad94284bc343b918faf414486296b

data/CHANGELOG.md

@@ -1,5 +1,40 @@
 # Release History for gapic-generator
 
+### 0.5.1 / 2020-05-21
+
+* Support a configuration for overriding service module names.
+* Operations client honors the quota_project setting.
+
+### 0.5.0 / 2020-05-19
+
+* Add quota_project to the generated configs.
+* Allow resource patterns with a star as a segment template.
+* Generate tests for resource path helpers.
+* Pin protobuf dependency for Ruby < 2.5.
+* Create a test helper in for generated tests.
+
+### 0.4.2 / 2020-04-28
+
+* Prepend double-colon to absolute/global namespaces to prevent conflicts.
+* Fix documentation/examples of timeouts to clarify they are in seconds.
+
+### 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.

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
@@ -137,13 +137,15 @@ module Gapic
 
         case entity
         when Gapic::Schema::Service
-          "{#{convert_address_to_ruby entity}::Client #{text}}"
+          "{::#{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
-          "{#{convert_address_to_ruby entity} #{text}}"
+          "{::#{convert_address_to_ruby entity.parent}::Client##{entity.name.underscore} #{text}}"
+        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}}"
+          "{::#{convert_address_to_ruby entity.parent}##{entity.name} #{text}}"
         end
       end
 
@@ -153,7 +155,7 @@ module Gapic
         address = entity.address
         address = address.join "." if address.is_a? Array
         address = address.sub file.package, file.ruby_package if file.ruby_package&.present?
-        address.split(".").reject(&:empty?).map(&:camelize).map { |node| api.fix_namespace node }.join("::")
+        address.split(/\.|::/).reject(&:empty?).map(&:camelize).map { |node| api.fix_namespace node }.join("::")
       end
     end
   end

data/lib/gapic/generator/version.rb

@@ -16,6 +16,6 @@
 
 module Gapic
   module Generator
-    VERSION = "0.3.1"
+    VERSION = "0.5.1"
   end
 end

data/lib/gapic/generators/default_generator.rb

@@ -58,22 +58,24 @@ module Gapic
             files << g("service/paths.erb",                  "lib/#{service.paths_file_path}",                   service: service) if service.paths?
             files << g("service/operations.erb",             "lib/#{service.operations_file_path}",              service: service) if service.lro?
             files << g("service/test/client.erb",            "test/#{service.test_client_file_path}",            service: service)
+            files << g("service/test/client_paths.erb",      "test/#{service.test_paths_file_path}",             service: service) if service.paths?
             files << g("service/test/client_operations.erb", "test/#{service.test_client_operations_file_path}", service: service) if service.lro?
           end
         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/entrypoint.erb", "lib/#{gem.name}.rb",           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/test_helper.erb", "test/helper.rb",               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/helpers/filepath_helper.rb

@@ -25,6 +25,7 @@ module Gapic
       ##
       # Converts a ruby namespace string to a file path string.
       def ruby_file_path api, namespace
+        namespace = namespace.sub(/^::/, "")
         file_path = ruby_file_path_for_namespace namespace
         fix_file_path api, file_path
       end

data/lib/gapic/helpers/namespace_helper.rb

@@ -38,7 +38,14 @@ module Gapic
       # Ruby double-semicolon separators.
       def ruby_namespace_for_address address
         address = address.split "." if address.is_a? String
-        address.reject(&:empty?).map(&:camelize).join "::"
+        ensure_absolute_namespace address.reject(&:empty?).map(&:camelize).join("::")
+      end
+
+      ##
+      # Returns the given namespace, ensuring double colons are prepended
+      #
+      def ensure_absolute_namespace namespace
+        namespace.start_with?("::") ? namespace : "::#{namespace}"
       end
 
       ##

data/lib/gapic/path_template/segment.rb

@@ -56,6 +56,13 @@ module Gapic
         !@pattern.nil?
       end
 
+      # Determines if the segment has a nontrivial pattern (i.e. not `*` or `**`).
+      #
+      # @return [Boolean]
+      def nontrivial_pattern?
+        @pattern && @pattern != "*" && @pattern != "**"
+      end
+
       # @private
       def == other
         return false unless other.is_a? self.class

data/lib/gapic/presenters/field_presenter.rb

@@ -95,21 +95,21 @@ 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
           else
             case field.type
-            when 1, 2                              then "Float"
-            when 3, 4, 5, 6, 7, 13, 15, 16, 17, 18 then "Integer"
-            when 9, 12                             then "String"
-            when 8                                 then "Boolean"
+            when 1, 2                              then "::Float"
+            when 3, 4, 5, 6, 7, 13, 15, 16, 17, 18 then "::Integer"
+            when 9, 12                             then "::String"
+            when 8                                 then "::Boolean"
             else
-              "Object"
+              "::Object"
             end
           end
-        field.repeated? ? "Array<#{base_type}>" : base_type
+        field.repeated? ? "::Array<#{base_type}>" : base_type
       end
 
       def field_map_type entry_message, output
@@ -118,7 +118,7 @@ module Gapic
           key_field = field if field.name == "key"
           value_field = field if field.name == "value"
         end
-        class_name = output ? "Google::Protobuf::Map" : "Hash"
+        class_name = output ? "::Google::Protobuf::Map" : "::Hash"
         if key_field && value_field
           key_type = field_doc_types key_field, output
           value_type = field_doc_types value_field, output
@@ -141,7 +141,7 @@ module Gapic
           when 9, 12                             then "\"hello world\""
           when 8                                 then "true"
           else
-            "Object"
+            "::Object"
           end
         end
       end

data/lib/gapic/presenters/file_presenter.rb

@@ -39,7 +39,7 @@ module Gapic
       end
 
       def namespace
-        return @file.ruby_package if @file.ruby_package.present?
+        return ensure_absolute_namespace @file.ruby_package if @file.ruby_package.present?
         ruby_namespace_for_address address
       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
@@ -59,13 +64,13 @@ module Gapic
 
       def doc_response_type
         ret = return_type
-        ret = "Gapic::Operation" if lro?
+        ret = "::Gapic::Operation" if lro?
         if server_streaming?
-          ret = "Enumerable<#{ret}>"
+          ret = "::Enumerable<#{ret}>"
         elsif paged?
           paged_type = paged_response_type
-          paged_type = "Gapic::Operation" if paged_type == "Google::Longrunning::Operation"
-          ret = "Gapic::PagedEnumerable<#{paged_type}>"
+          paged_type = "::Gapic::Operation" if paged_type == "::Google::Longrunning::Operation"
+          ret = "::Gapic::PagedEnumerable<#{paged_type}>"
         end
         ret
       end
@@ -118,7 +123,7 @@ module Gapic
           return [
             OpenStruct.new(
               name:      "operation",
-              doc_types: "Gapic::Operation"
+              doc_types: "::Gapic::Operation"
             )
           ]
         end
@@ -129,7 +134,7 @@ module Gapic
           ),
           OpenStruct.new(
             name:      "operation",
-            doc_types: "GRPC::ActiveCall::Operation"
+            doc_types: "::GRPC::ActiveCall::Operation"
           )
         ]
       end
@@ -145,9 +150,9 @@ module Gapic
       end
 
       def lro?
-        return paged_response_type == "Google::Longrunning::Operation" if paged?
+        return paged_response_type == "::Google::Longrunning::Operation" if paged?
 
-        message_ruby_type(@method.output) == "Google::Longrunning::Operation"
+        message_ruby_type(@method.output) == "::Google::Longrunning::Operation"
       end
 
       def client_streaming?
@@ -166,8 +171,9 @@ module Gapic
         # 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.SearchProfiles"
-        return false if address == "google.cloud.talent.v4beta1.SearchJobs"
+        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
@@ -220,12 +226,12 @@ module Gapic
           message_ruby_type arg.enum
         else
           case arg.type
-          when 1, 2                              then "Float"
-          when 3, 4, 5, 6, 7, 13, 15, 16, 17, 18 then "Integer"
-          when 9, 12                             then "String"
-          when 8                                 then "Boolean"
+          when 1, 2                              then "::Float"
+          when 3, 4, 5, 6, 7, 13, 15, 16, 17, 18 then "::Integer"
+          when 9, 12                             then "::String"
+          when 8                                 then "::Boolean"
           else
-            "Object"
+            "::Object"
           end
         end
       end
@@ -250,7 +256,7 @@ module Gapic
           when 9, 12                             then "\"hello world\""
           when 8                                 then "true"
           else
-            "Object"
+            "::Object"
           end
         end
       end

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/resource_presenter.rb

@@ -15,7 +15,6 @@
 # limitations under the License.
 
 require "gapic/path_template"
-require "ostruct"
 require "active_support/inflector"
 
 module Gapic
@@ -28,20 +27,10 @@ module Gapic
       def initialize resource
         @resource = resource
 
-        @patterns = resource.pattern.map do |template|
-          segments = Gapic::PathTemplate.parse template
-          OpenStruct.new(
-            template:    template,
-            segments:    segments,
-            arguments:   arguments_for(segments),
-            path_string: path_string_for(segments)
-          )
-        end
+        @patterns = resource.pattern.map { |template| PatternPresenter.new template }
 
         # 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
+        @patterns.filter!(&:useful_for_helpers?)
       end
 
       def name
@@ -60,33 +49,64 @@ module Gapic
         "#{ActiveSupport::Inflector.underscore name}_path"
       end
 
-      private
+      ##
+      # A presenter for a particular pattern
+      #
+      class PatternPresenter
+        def initialize template
+          @template = template
+          @segments = Gapic::PathTemplate.parse template
+          @arguments = arg_segments.map(&:name)
+          @path_string = build_path_string
+        end
 
-      def arguments_for segments
-        arg_segments(segments).map(&:name)
-      end
+        attr_reader :template, :segments, :arguments, :path_string
 
-      def arg_segments segments
-        segments.select { |segment| segment.is_a? Gapic::PathTemplate::Segment }
-      end
+        def useful_for_helpers?
+          arg_segments.none?(&:nontrivial_pattern?) && arg_segments.none?(&:positional?)
+        end
 
-      def path_string_for segments
-        segments.map do |segment|
-          if segment.is_a? Gapic::PathTemplate::Segment
-            "\#{#{segment.name}}"
-          else
-            # Should be a String
-            segment
-          end
-        end.join
-      end
+        def formal_arguments
+          arguments.map { |arg| "#{arg}:" }.join ", "
+        end
 
-      def positional_args? segments
-        arg_segments(segments).any?(&:positional?)
-      end
+        def arguments_key
+          arguments.sort.join ":"
+        end
+
+        def arguments_with_dummy_values
+          arguments.each_with_index.map { |arg, index| "#{arg}: \"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}"
+            else
+              # Should be a String
+              segment
+            end
+          end.join
+        end
 
-      def named_arg_patterns? segments
-        arg_segments(segments).any?(&:pattern)
+        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
+        end
       end
     end
   end