gapic-generator 0.1.5 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87900df01c425c43c7c7ac1a46965b2324af78eb6c56b91e6cfe36eb0abf3d56
-  data.tar.gz: 3f72d4b99665d5e235332854e4bbd4cc69f181e08e66fff9a2444cdbd9f44693
+  metadata.gz: 7758f2d15a52b89f57555f192cf9d477cbfdbd9788578ba30b5e04d9c468ed85
+  data.tar.gz: ef2c5bd9924646eea488db7060dc654dc0cc2ff2ad1d5736e4f04cad217e0fe4
 SHA512:
-  metadata.gz: 89550d2af9728e7efdb9a3813fa50bf237dc8322057fce25653fba88aae3871672e50af88d0844e4c2ff34d725734236500e5c17cf0db889e0d517a67852760e
-  data.tar.gz: 653271d51b4f3142d99b21cee2dff0146ddea8768a3d2d128cad0fc3914a498cac532223b53773145a33c57d5167059d1d2c8fd29b17b66d51bf7cb7c1d792d8
+  metadata.gz: 6d28f3903643f3b86770f83538dcaa669668bcd9f89e85592bbc6680c95c13fc043b323cf406fa0fa37b0ad0ad21ed30bb56ed42c7a2be0b423cbfc4c0b7c423
+  data.tar.gz: a98b3d1af7be74a680e0b738b4d0753130f90c51ef71fb181a94189d1806b947338558826cd3e4f5b8c3315897546d2e36a1ce5d99d58dd501fd5aa5e8c3a76d

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Release History for gapic-generator
 
+### 0.1.7 / 2020-03-18
+
+* Path modules extend self so helpers can be invoked on them directly
+* Trigger IAM dependency for IAM V1 files other than iam_policy.proto
+
+### 0.1.6 / 2020-03-17
+
+* Generated libraries now depend on gapic-common 0.2
+* Convert cross-reference syntax in proto docs to YARD cross-reference links.
+* Preserve call options in LROs
+* Fix implicit kwarg warnings under Ruby 2.7
+
 ### 0.1.5 / 2020-03-13
 
 * More improvements to escaping of curly braces.

data/lib/gapic/formatting_utils.rb

@@ -22,25 +22,21 @@ module Gapic
   #
   module FormattingUtils
     @brace_detector = /\A(?<pre>[^`]*(`[^`]*`[^`]*)*[^`\\])?\{(?<inside>[^\s][^}]*)\}(?<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
       ##
-      # Given an enumerable of lines, escape braces that look like yardoc type
-      # links. Tries to be smart about handling only braces that would be
-      # interpreted by yard (i.e. those that are not part of preformatted text
-      # blocks).
+      # Given an enumerable of lines, performs yardoc formatting, including:
+      # * Interpreting cross-references identified as described in AIP 192
+      # * Escaping literal braces that look like yardoc type links
+      #
+      # Tries to be smart about exempting preformatted text blocks.
       #
       # @param lines [Enumerable<String>]
       # @return [Enumerable<String>]
       #
-      def escape_braces lines
-        # This looks for braces that:
-        # * Are opened and closed on the same line
-        # * Are not nested
-        # * Are not located between backticks
-        # * Are not in a preformatted block
-        #
+      def format_doc_lines api, lines
         # To detect preformatted blocks, this tracks the "expected" base indent
         # according to Markdown. Specifically, this is the effective indent of
         # previous block, which is normally 0 except if we're in a list item.
@@ -55,7 +51,10 @@ module Gapic
             in_block = nil
           else
             in_block, base_indent = update_indent_state in_block, base_indent, line, indent
-            line = escape_line_braces line if in_block == false
+            if in_block == false
+              line = escape_line_braces line
+              line = format_line_xrefs api, line
+            end
           end
           line
         end
@@ -104,6 +103,53 @@ module Gapic
         end
         line
       end
+
+      def format_line_xrefs api, line
+        while (m = @xref_detector.match line)
+          entity = api.lookup m[:addr]
+          return line if entity.nil?
+          yard_link = yard_link_for_entity entity, m[:text]
+          return line if yard_link.nil?
+          line = "#{m[:pre]}#{yard_link}#{m[:post]}"
+        end
+        line
+      end
+
+      ##
+      # Generate a YARD-style cross-reference for the given entity.
+      #
+      # @param entity [Gapic::Schema::Proto] the entity to link to
+      # @param text [String] the text for the link
+      # @return [String] YARD cross-reference syntax
+      #
+      def yard_link_for_entity entity, text
+        # As a special case, omit the service "google.longrunning.Operations"
+        # and its methods. This is because the generator creates
+        # service-specific copies of the operations client, rather than a
+        # Google::Longrunning::Operations::Client class, and there is in
+        # general no way to tell what the actual service-specific namespace is.
+        return text if entity.address[0, 3] == ["google", "longrunning", "Operations"]
+
+        case entity
+        when Gapic::Schema::Service
+          "{#{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}}"
+        when Gapic::Schema::Field
+          "{#{convert_address_to_ruby entity.parent}##{entity.name} #{text}}"
+        end
+      end
+
+      def convert_address_to_ruby entity
+        file = entity.containing_file
+        api = file.containing_api
+        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("::")
+      end
     end
   end
 end

data/lib/gapic/generator/version.rb

@@ -16,6 +16,6 @@
 
 module Gapic
   module Generator
-    VERSION = "0.1.5"
+    VERSION = "0.1.7"
   end
 end

data/lib/gapic/schema/api.rb

@@ -53,6 +53,14 @@ module Gapic
         @files.each { |f| f.parent = self }
       end
 
+      def containing_api
+        self
+      end
+
+      def containing_file
+        nil
+      end
+
       def lookup address
         address = address.join "." if address.is_a? Array
         @files.each do |f|

data/lib/gapic/schema/wrappers.rb

@@ -95,6 +95,18 @@ module Gapic
         @docs = docs
       end
 
+      # Returns the "root" of this schema.
+      # @return [Gapic::Schema::Api]
+      def containing_api
+        parent&.containing_api
+      end
+
+      # Returns the file containing this proto entity
+      # @return [Gapic::Schema::File]
+      def containing_file
+        parent&.containing_file
+      end
+
       # Gets the cleaned up leading comments documentation
       def docs_leading_comments
         return nil if @docs.nil?
@@ -102,7 +114,7 @@ module Gapic
 
         lines = @docs.leading_comments.each_line.to_a
         lines.map! { |line| line.start_with?(" ") ? line[1..-1] : line }
-        lines = FormattingUtils.escape_braces lines
+        lines = FormattingUtils.format_doc_lines containing_api, lines
         lines.join
       end
 
@@ -376,6 +388,10 @@ module Gapic
         @services.each { |m| m.parent = self }
       end
 
+      def containing_file
+        self
+      end
+
       def lookup address
         address = address.split(".").reject(&:empty?).join(".")
         @registry[address]

data/templates/default/gem/gemspec.erb

@@ -23,7 +23,7 @@ Gem::Specification.new do |gem|
 
   gem.required_ruby_version = ">= 2.4"
 
-  gem.add_dependency "gapic-common", "~> 0.1.0"
+  gem.add_dependency "gapic-common", "~> 0.2"
   <%- if gem.iam_dependency? -%>
   gem.add_dependency "grpc-google-iam-v1", "~> 0.6.9"
   <%- end -%>

data/templates/default/gem/rubocop.erb

@@ -57,3 +57,5 @@ Style/CaseEquality:
     - "lib/<%= service.client_file_path.sub "client.rb", "*.rb" %>"
     <%- end -%>
     <%- end -%>
+Style/ModuleFunction:
+  Enabled: false

data/templates/default/helpers/presenters/gem_presenter.rb

@@ -114,7 +114,7 @@ class GemPresenter
   end
 
   def iam_dependency?
-    @api.files.map(&:name).include? "google/iam/v1/iam_policy.proto"
+    @api.files.map(&:name).any? { |f| f.start_with? "google/iam/v1/" }
   end
 
   private

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

@@ -5,4 +5,5 @@ module Paths
 <%= indent render(partial: "service/client/resource", locals: { resource: resource }), 2 %>
 
 <%- end %>
+  extend self
 end

data/templates/default/service/client/method/def/_options_defaults.erb

@@ -1,6 +1,6 @@
 <%- assert_locals method -%>
 # Converts hash and nil to an options object
-options = Gapic::CallOptions.new options.to_h if options.respond_to? :to_h
+options = Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
 
 # Customize the options with defaults
 metadata = @config.rpcs.<%= method.name %>.metadata.to_h

data/templates/default/service/client/method/def/_response_normal.erb

@@ -1,7 +1,7 @@
 <%- assert_locals method -%>
 @<%= method.service.stub_name %>.call_rpc :<%= method.name %>, request, options: options do |response, operation|
   <%- if method.lro? -%>
-  response = Gapic::Operation.new response, <%= method.service.lro_client_ivar %>
+  response = Gapic::Operation.new response, <%= method.service.lro_client_ivar %>, options: options
   <%- end -%>
   yield response, operation if block_given?
   return response

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gapic-generator
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.7
 platform: ruby
 authors:
 - Ernest Landrito
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-14 00:00:00.000000000 Z
+date: 2020-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack