gapic-generator 0.6.12 → 0.6.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: afaa0b6b4a0d16eaae66efab5a4e45e7cda3ffd7be99ca7bf2c6367c520dacc0
-  data.tar.gz: 6894ec83f3ad88187f11e1fd3c9a55d3044c262338e5a4b6deab4c84bae5d675
+  metadata.gz: c9f0e5ee2a9fd5c53dd43b0cc3d04c0c6c590ce06782dcb0a5eb9a346369d241
+  data.tar.gz: 7a4787ff915d5a8355677377f60481fa5f714923ccf4d1f65e02f5ef8754dd4d
 SHA512:
-  metadata.gz: 9368519ee9f66aeed7df95a11dbabf826ace7f22d8a36698e6625663ffdc49f7566f2f6977eca02d412410bbdc1012f10e4676bfb9bea6fd253cd470a1a8b31c
-  data.tar.gz: fd1a76c09ad489a9ed8a99616b9a9e4b1ecc17a47faf5044d3fd4abf111d5a01a0efede4bc3232d896837a441251fad974e4a9afcb1bc75e827b0a58ef5bf983
+  metadata.gz: c01dd5965a8a54e79e802135eb6df543200b338252e7f129a6adddc53e1c9d92ae91043ebe3ad30846ae496b868d489a1190b477b72448f8ecc022abcd1eb6bb
+  data.tar.gz: df3aed51dc4573c7bde9370f77920434a58bb12b13e4a3388fe741deabee9d0ecefa60f50b165c7ab6856a9ea5c0149d789ab825059bf93d1749de66358298ad

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Release History for gapic-generator
 
+### 0.6.13 / 2021-02-22
+
+* Remove InputOnly and OutputOnly proto tags from docs to avoid confusing YARD.
+* Generate drift manifest.
+* Executable entrypoints set the default external locale to utf-8.
+
 ### 0.6.12 / 2021-02-01
 
 * No changes.

data/bin/protoc-gen-ruby_gapic

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+#!/usr/bin/env -S ruby -E UTF-8
 # frozen_string_literal: true
 
 # Copyright 2018 Google LLC

data/lib/gapic/formatting_utils.rb

@@ -24,6 +24,7 @@ module Gapic
     @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/
+    @omit_lines = ["@InputOnly\n", "@OutputOnly\n"]
 
     class << self
       ##
@@ -49,7 +50,7 @@ module Gapic
         # preformatted.
         in_block = nil
         base_indent = 0
-        lines.map do |line|
+        (lines - @omit_lines).map do |line|
           indent = line_indent line
           if indent.nil?
             in_block = nil

data/lib/gapic/generator/version.rb

@@ -16,6 +16,6 @@
 
 module Gapic
   module Generator
-    VERSION = "0.6.12"
+    VERSION = "0.6.13"
   end
 end

data/lib/gapic/generators/default_generator.rb

@@ -65,18 +65,19 @@ 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/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)
+        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)
+        files << g("gem/gapic_metadata_json.erb",   "gapic_metadata.json",          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/gem_presenter.rb

@@ -17,6 +17,8 @@
 require "gapic/helpers/filepath_helper"
 require "gapic/helpers/namespace_helper"
 
+require "json"
+
 module Gapic
   module Presenters
     ##
@@ -191,6 +193,27 @@ module Gapic
                     .sort_by { |name, _requirements| name }
       end
 
+      ##
+      # Returns a hash with a drift_manifest of
+      # a first package in this gem
+      # (while the behaviour in case of multiple packages is clarified).
+      # See https://github.com/googleapis/googleapis/blob/master/gapic/metadata/gapic_metadata.proto
+      #
+      # @return [Hash]
+      def first_package_drift_manifest
+        return {} unless packages?
+        packages[0].drift_manifest
+      end
+
+      ##
+      # Returns a drift manifest of the first package in
+      # a pretty JSON string form
+      #
+      # @return [String]
+      def first_package_drift_json
+        JSON.pretty_generate first_package_drift_manifest
+      end
+
       private
 
       def gem_config key

data/lib/gapic/presenters/package_presenter.rb

@@ -99,6 +99,24 @@ module Gapic
       def helpers_require
         package_require + "/_helpers"
       end
+
+      ##
+      # Returns a hash with a drift_manifest of this package
+      # describing correspondence between the proto description
+      # of the package with the generated code for the package.
+      # See https://github.com/googleapis/googleapis/blob/master/gapic/metadata/gapic_metadata.proto
+      #
+      # @return [Hash]
+      def drift_manifest
+        {
+          schema:         "1.0",
+          comment:        "This file maps proto services/RPCs to the corresponding library clients/methods",
+          language:       "ruby",
+          protoPackage:   name,
+          libraryPackage: namespace,
+          services:       services.map { |s| [s.grpc_service_name, s.drift_manifest] }.to_h
+        }
+      end
     end
   end
 end

data/lib/gapic/presenters/service_presenter.rb

@@ -333,10 +333,40 @@ module Gapic
         @api.grpc_service_config.service_level_configs[grpc_full_name]
       end
 
+      ##
+      # The short proto name for this service
+      #
+      # @return [String]
+      def grpc_service_name
+        @service.name
+      end
+
       def grpc_full_name
         @service.address.join "."
       end
 
+      ##
+      # Returns a hash with a drift_manifest of this service,
+      # describing correspondence between the proto description
+      # of the service with the generated code for the service.
+      # See https://github.com/googleapis/googleapis/blob/master/gapic/metadata/gapic_metadata.proto
+      #
+      # @return [Hash]
+      def drift_manifest
+        {
+          clients: {
+            grpc: {
+              libraryClient: client_name_full,
+              # The methods should grouped by grpc_method_name and then
+              # their names are returned together in an array.
+              # For Ruby currently we have 1:1 proto to code
+              # correspondence for methods, so our generation is easier
+              methods:       methods.map { |m| [m.grpc_method_name, [m.name]] }.to_h
+            }
+          }
+        }
+      end
+
       private
 
       def default_config key

data/templates/default/gem/gapic_metadata_json.erb

@@ -0,0 +1,2 @@
+<%- assert_locals gem -%>
+<%= gem.first_package_drift_json %>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gapic-generator
 version: !ruby/object:Gem::Version
-  version: 0.6.12
+  version: 0.6.13
 platform: ruby
 authors:
 - Ernest Landrito
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-02 00:00:00.000000000 Z
+date: 2021-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -246,6 +246,7 @@ files:
 - templates/default/gem/_version.erb
 - templates/default/gem/changelog.erb
 - templates/default/gem/entrypoint.erb
+- templates/default/gem/gapic_metadata_json.erb
 - templates/default/gem/gemfile.erb
 - templates/default/gem/gemspec.erb
 - templates/default/gem/gitignore.erb