gapic-generator-cloud 0.3.1 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70fd9ffac64e2c0ea96cbf5a154ff35e7bdb5e65012668745ae66e4ce42013f3
-  data.tar.gz: c54b2af52a759abbd2f44f86d1b28cd5777f7a49c7f5cc2a7aa810c8c398e68e
+  metadata.gz: '05991cbbec5b9595616970ff1f3a119df0630e2c42065946237a9066db8a6d7d'
+  data.tar.gz: 3bd49bf2a990e322ca5e751765ed6dec1654e5cf850a5367959d765d81471ffa
 SHA512:
-  metadata.gz: fcc24a9bb44fbb2b9884a1a88e8957e6a43e477cd271b9d9e4e9ba0c67aeb581d9b0ededb0a83068fd378630a379d843cd43a8001a51d0a7a3cb5278ec63337e
-  data.tar.gz: 10e176617a47bac0d1069a7353b26840763eb240ba960622c002f3547ee84e59e633d140d450f67352e51a35a16ae3d97359bcd2e93543b205cd6ec2aa408024
+  metadata.gz: d7cd78ff4fea33d1570025d27b5c7d95d85ef81305d6cd099a0269d7a6c55df9af8cf2f2ff8871a4e41a33fa2d6dd644e381272faf94e171c4803a6cf963cf97
+  data.tar.gz: 80b97974c461eca68e5126319dbfd47fac990c95c3f2f4a50e8e726d1226f1304541ab383f213a750bfd0bccd810b9aafd0614687152944d6c5a3d73163f73f1

data/CHANGELOG.md

@@ -1,5 +1,45 @@
 # Release History for gapic-generator-cloud
 
+### 0.5.1 / 2020-05-21
+
+* Includes changes from gapic-generator 0.5.1
+
+### 0.5.0 / 2020-05-19
+
+* Includes changes from gapic-generator 0.5.0
+* Wrappers now support partial-gapic helpers.
+* Generated configs for wrappers now include endpoint and scope.
+
+### 0.4.3 / 2020-05-01
+
+* Unpin minitest in the generated wrappers.
+
+### 0.4.2 / 2020-04-28
+
+* Includes changes from gapic-generator 0.4.2
+* Eliminate a circular require in generated wrappers.
+
+### 0.4.1 / 2020-04-23
+
+* Wrapper templates honor overridden namespaces.
+* Support setting the gem namespace from the docker interface.
+
+### 0.4.0 / 2020-04-20
+
+* Includes changes from gapic-generator 0.4.0
+* Apply overrides to client namespaces but not proto namespaces.
+* Remove common resources proto from generated files.
+* Multiple overrides can be specified in the docker interface.
+* Fixed: The pre-migration versions in wrapper readmes were malformed if the migration version was still 0.x.
+
+### 0.3.3 / 2020-04-13
+
+* Includes changes from gapic-generator 0.3.3
+
+### 0.3.2 / 2020-04-12
+
+* Includes changes from gapic-generator 0.3.2
+
 ### 0.3.1 / 2020-04-11
 
 * Includes changes from gapic-generator 0.3.1

data/bin/ruby-cloud-docker-entrypoint

@@ -18,13 +18,17 @@
 require "optparse"
 require "fileutils"
 
+# Boolean options may have values "true" or "false" (as strings)
 bool_option_map = {
   ":gem.:free_tier" => "ruby-cloud-free-tier",
   ":gem.:yard_strict" => "ruby-cloud-yard-strict"
 }
+
+# Value options always take string values.
 value_option_map = {
   "configuration" => "ruby-cloud-config",
   ":gem.:name" => "ruby-cloud-gem-name",
+  ":gem.:namespace" => "ruby-cloud-gem-namespace",
   ":gem.:title" => "ruby-cloud-title",
   ":gem.:description" => "ruby-cloud-description",
   ":gem.:summary" => "ruby-cloud-summary",
@@ -36,15 +40,29 @@ value_option_map = {
   ":gem.:api_id" => "ruby-cloud-api-id",
   ":gem.:factory_method_suffix" => "ruby-cloud-factory-method-suffix"
 }
+
+# Path options take one or more file paths delimited by semicolons.
 path_option_map = {
   "samples" => ["ruby-cloud-samples", "samples"],
   "grpc_service_config" => "ruby-cloud-grpc-service-config"
 }
+
+# Map options take one or more mappings delimited by semicolons. Each mapping
+# must be of the form "key=value". Note that periods in keys are treated as
+# literal periods, not subkey delimiters.
 map_option_map = {
+  ":common_services" => "ruby-cloud-common-services",
   ":overrides.:file_path" => "ruby-cloud-path-override",
-  ":overrides.:namespace" => "ruby-cloud-namespace-override"
+  ":overrides.:namespace" => "ruby-cloud-namespace-override",
+  ":overrides.:service" => "ruby-cloud-service-override"
 }
 
+# A set of files that, if generated, should be removed.
+remove_paths = [
+  "lib/google/iam/v1/iam_policy_pb.rb",
+  "lib/google/cloud/common_resources_pb.rb"
+]
+
 parameters = {}
 
 OptionParser.new do |op|
@@ -72,8 +90,11 @@ OptionParser.new do |op|
   map_option_map.each do |key, flags|
     flags = Array(flags).map { |f| "--#{f} MAPPING" }
     op.on(*flags) do |mapping|
-      mapping_key, mapping_val = mapping.split("=", 2)
-      parameters["#{key}.#{mapping_key}"] = mapping_val if mapping_val
+      mapping.split(";").each do |mapping_kv|
+        mapping_key, mapping_val = mapping_kv.split("=", 2)
+        mapping_key.gsub!(".", "\\\\\\\\.")
+        parameters["#{key}.#{mapping_key}"] = mapping_val if mapping_val
+      end
     end
   end
 end.parse! ARGV
@@ -93,11 +114,18 @@ ruby_plugin_args =
 
 protoc_cmd = [
   "grpc_tools_ruby_protoc",
-  "--proto_path=/protos/", "--proto_path=/in/"
+  # It is important for /in to come before /protos because all input files
+  # come from /in, and protoc will complain if any of those are also found
+  # earlier in the proto path.
+  "--proto_path=/in/", "--proto_path=/protos/"
 ] + ruby_plugin_args + [
   "--ruby_cloud_out=/out/",
   "--ruby_cloud_opt", parameter_strs.join(",")
 ] + ARGV + Dir.glob("/in/**/*.proto").sort
 
 FileUtils.mkdir_p "/out/lib"
-exec(*protoc_cmd)
+system(*protoc_cmd)
+
+remove_paths.each do |path|
+  FileUtils.rm_f Dir.glob "/out/#{path}"
+end

data/lib/gapic/generator/cloud/version.rb

@@ -14,10 +14,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+
 module Gapic
   module Generator
     module Cloud
-      VERSION = "0.3.1"
+      VERSION = "0.5.1"
     end
   end
 end

data/lib/gapic/generators/cloud_generator.rb

@@ -89,7 +89,7 @@ module Gapic
         files << g("wrapper_gem/entrypoint.erb",   "lib/#{gem.name}.rb",                            gem: gem) if gem.needs_entrypoint?
         files << g("wrapper_gem/main.erb",         "lib/#{gem.namespace_file_path}",                gem: gem)
         files << g("gem/version.erb",              "lib/#{gem.version_file_path}",                  gem: gem)
-        files << g("wrapper_gem/test_helper.erb",  "test/helper.rb",                                gem: gem)
+        files << g("gem/test_helper.erb",          "test/helper.rb",                                gem: gem)
         files << g("wrapper_gem/client_test.erb",  "test/#{gem.namespace_require}/client_test.rb",  gem: gem)
         files << g("wrapper_gem/version_test.erb", "test/#{gem.namespace_require}/version_test.rb", gem: gem)
 

data/lib/gapic/presenters/wrapper_gem_presenter.rb

@@ -38,6 +38,14 @@ module Gapic
         ruby_file_path @api, namespace
       end
 
+      def main_directory_name
+        namespace_require.split("/").last
+      end
+
+      def helpers_require
+        "#{namespace_require}/helpers"
+      end
+
       def namespace_file_path
         "#{namespace_require}.rb"
       end
@@ -54,10 +62,16 @@ module Gapic
         gem_config :migration_version
       end
 
+      # A description of the versions prior to the migration version.
+      # Could be "a.x" if the migration version is 1.0 or later, otherwise
+      # falls back to "pre-a.b".
       def pre_migration_version
-        m = /^(\d)+\./.match migration_version.to_s
-        return nil unless m
-        "#{m[1].to_i - 1}.x"
+        match = /^(\d)+\.0/.match migration_version.to_s
+        if match
+          major = match[1].to_i
+          return "#{major - 1}.x" if major.positive?
+        end
+        "pre-#{migration_version}"
       end
 
       def migration?

data/lib/gapic/presenters/wrapper_service_presenter.rb

@@ -15,6 +15,7 @@
 # limitations under the License.
 
 require "gapic/presenters"
+require "gapic/ruby_info"
 
 module Gapic
   module Presenters
@@ -27,10 +28,13 @@ module Gapic
       end
 
       def factory_method_name
-        method_name = ActiveSupport::Inflector.underscore name
-        suffix = gem.factory_method_suffix
-        method_name = "#{method_name}#{suffix}" unless method_name.end_with? suffix
-        method_name
+        @factory_method_name ||= begin
+          method_name = ActiveSupport::Inflector.underscore name
+          suffix = gem.factory_method_suffix
+          method_name = "#{method_name}#{suffix}" unless method_name.end_with? suffix
+          method_name = "#{method_name}_client" if Gapic::RubyInfo.excluded_method_names.include? method_name
+          method_name
+        end
       end
 
       def create_client_call

data/templates/cloud/gem/gemspec.erb

@@ -30,7 +30,9 @@ Gem::Specification.new do |gem|
   <%- end -%>
 
   gem.add_development_dependency "google-style", "~> 1.24.0"
-  gem.add_development_dependency "minitest", "~> 5.10"
+  gem.add_development_dependency "minitest", "~> 5.14"
+  gem.add_development_dependency "minitest-focus", "~> 1.1"
+  gem.add_development_dependency "minitest-rg", "~> 5.2"
   gem.add_development_dependency "rake", ">= 12.0"
   gem.add_development_dependency "redcarpet", "~> 3.0"
   gem.add_development_dependency "simplecov", "~> 0.18"

data/templates/cloud/gem/rakefile.erb

@@ -11,6 +11,7 @@ RuboCop::RakeTask.new
 require "rake/testtask"
 desc "Run tests."
 Rake::TestTask.new do |t|
+  t.libs << "test"
   t.test_files = FileList["test/**/*_test.rb"]
   t.warning = false
 end

data/templates/cloud/service/client/_credentials.erb

@@ -3,7 +3,7 @@
 require "googleauth"
 <% end %>
 # Credentials for the <%= service.name %> API.
-class <%= service.credentials_name %> < Google::Auth::Credentials
+class <%= service.credentials_name %> < ::Google::Auth::Credentials
   <%- if service.client_scopes.any? -%>
   self.scope = [
   <%- service.client_scopes.each_with_index do |client_scope, index| -%>

data/templates/cloud/service/client/_self_configure.erb

@@ -1,6 +1,6 @@
 <%- assert_locals service -%>
 @configure ||= begin
-  namespace = <%= service.namespace.split("::").inspect %>
+  namespace = <%= service.namespace.split("::").reject(&:empty?).inspect %>
   parent_config = while namespace.any?
                     parent_name = namespace.join "::"
                     parent_const = const_get parent_name

data/templates/cloud/service/client/method/def/_rescue.erb

@@ -1,3 +1,3 @@
  <%- assert_locals method -%>
-rescue GRPC::BadStatus => e
-  raise Google::Cloud::Error.from_error(e)
+rescue ::GRPC::BadStatus => e
+  raise ::Google::Cloud::Error.from_error(e)

data/templates/cloud/service/client/method/docs/_error.erb

@@ -1,2 +1,2 @@
 <%- assert_locals method -%>
-# @raise [Google::Cloud::Error] if the RPC is aborted.
+# @raise [::Google::Cloud::Error] if the RPC is aborted.

data/templates/cloud/wrapper_gem/_main.erb

@@ -1,45 +1,53 @@
 <%- assert_locals gem -%>
 <% @requires = capture do %>
+# Require this file early so that the version constant gets defined before
+# requiring "google/cloud". This is because google-cloud-core will load the
+# entrypoint (gem name) file, which in turn re-requires this file (hence
+# causing a require cycle) unless the version constant is already defined.
 require "<%= gem.version_require %>"
+
 require "googleauth"
 <%- if gem.needs_default_config_block? -%>
 gem "google-cloud-core"
-require "google/cloud" unless defined? Google::Cloud.new
+require "google/cloud" unless defined? ::Google::Cloud.new
 require "google/cloud/config"
 
 # Set the default configuration
-Google::Cloud.configure.add_config! :<%= gem.google_cloud_short_name %> do |config|
-  config.add_field! :credentials,  nil, match: [String, Hash, Google::Auth::Credentials]
-  config.add_field! :lib_name,     nil, match: String
-  config.add_field! :lib_version,  nil, match: String
-  config.add_field! :interceptors, nil, match: Array
-  config.add_field! :timeout,      nil, match: Numeric
-  config.add_field! :metadata,     nil, match: Hash
-  config.add_field! :retry_policy, nil, match: [Hash, Proc]
+::Google::Cloud.configure.add_config! :<%= gem.google_cloud_short_name %> do |config|
+  config.add_field! :endpoint,      <%= gem.services.first&.client_endpoint.inspect %>, match: ::String
+  config.add_field! :credentials,   nil, match: [::String, ::Hash, ::Google::Auth::Credentials]
+  config.add_field! :scope,         nil, match: [::Array, ::String]
+  config.add_field! :lib_name,      nil, match: ::String
+  config.add_field! :lib_version,   nil, match: ::String
+  config.add_field! :interceptors,  nil, match: ::Array
+  config.add_field! :timeout,       nil, match: ::Numeric
+  config.add_field! :metadata,      nil, match: ::Hash
+  config.add_field! :retry_policy,  nil, match: [::Hash, ::Proc]
+  config.add_field! :quota_project, nil, match: ::String
 end
 <%- end -%>
 <% end %>
 <%- gem.services.each do |service| -%>
 ##
-# Create a new client object for <%= service.name %>.
+# Create a new client object for <%= service.module_name %>.
 #
 # By default, this returns an instance of
-# <%= gem.docs_link version: gem.default_version, class_name: "#{service.name}::Client" %>
+# <%= gem.docs_link version: gem.default_version, class_name: "#{service.module_name}::Client" %>
 # for version <%= gem.default_version.capitalize %> of the API.
 # However, you can specify specify a different API version by passing it in the
-# `version` parameter. If the <%= service.name %> service is
+# `version` parameter. If the <%= service.module_name %> service is
 # supported by that API version, and the corresponding gem is available, the
 # appropriate versioned client will be returned.
 #
 <%- if service.doc_description -%>
-# ## About <%= service.name %>
+# ## About <%= service.module_name %>
 #
 <%= indent service.doc_description(disable_xrefs: true), "# " %>
 #
 <%- end -%>
-# @param version [String, Symbol] The API version to connect to. Optional.
+# @param version [::String, ::Symbol] The API version to connect to. Optional.
 #   Defaults to `:<%= gem.default_version %>`.
-# @return [<%= service.name %>::Client] A client object for the specified version.
+# @return [<%= service.module_name %>::Client] A client object for the specified version.
 #
 def self.<%= service.factory_method_name %> version: :<%= gem.default_version %>, &block
   require "<%= gem.namespace_require %>/#{version.to_s.downcase}"
@@ -49,7 +57,7 @@ def self.<%= service.factory_method_name %> version: :<%= gem.default_version %>
                   .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                   .first
   package_module = <%= gem.namespace %>.const_get package_name
-  package_module.const_get(:<%= service.name %>).const_get(:Client).new(&block)
+  package_module.const_get(:<%= service.module_name %>).const_get(:Client).new(&block)
 end
 
 <%- end -%>
@@ -80,11 +88,15 @@ end
 #     * `:retry_codes` (*type:* `Array<String>`) -
 #       The error codes that should trigger a retry.
 #
-# @return [Google::Cloud::Config] The default configuration used by this library
+# @return [::Google::Cloud::Config] The default configuration used by this library
 #
 def self.configure
-  yield Google::Cloud.configure.<%= gem.google_cloud_short_name %> if block_given?
+  yield ::Google::Cloud.configure.<%= gem.google_cloud_short_name %> if block_given?
 
-  Google::Cloud.configure.<%= gem.google_cloud_short_name %>
+  ::Google::Cloud.configure.<%= gem.google_cloud_short_name %>
 end
 <%- end -%>
+<% @footer = capture do %>
+helper_path = ::File.join __dir__, "<%= gem.main_directory_name %>", "helpers.rb"
+require "<%= gem.helpers_require %>" if ::File.file? helper_path
+<% end %>

data/templates/cloud/wrapper_gem/client_test.erb

@@ -14,7 +14,7 @@ class <%= gem.namespace %>::ClientConstructionMinitest < Minitest::Test
       client = <%= gem.namespace %>.<%= service.factory_method_name %> do |config|
         config.credentials = grpc_channel
       end
-      assert_kind_of <%= gem.namespaced_class "#{service.name}::Client", version: gem.default_version %>, client
+      assert_kind_of <%= gem.namespaced_class "#{service.module_name}::Client", version: gem.default_version %>, client
     end
   end
 

data/templates/cloud/wrapper_gem/entrypoint.erb

@@ -1,4 +1,4 @@
 <%- assert_locals gem -%>
 <%= render partial: "shared/header" -%>
 
-require "<%= gem.namespace_require %>"
+require "<%= gem.namespace_require %>" unless defined? <%= gem.namespace %>::VERSION

data/templates/cloud/wrapper_gem/gemfile.erb

@@ -10,8 +10,5 @@ gem "google-cloud-errors", path: "../google-cloud-errors"
 gem "<%= name %>", path: "../<%= name %>"
 <%- end -%>
 
-gem "rake"
-
-# Pin minitest to 5.11.x to avoid warnings emitted by 5.12.
-# See https://github.com/googleapis/google-cloud-ruby/issues/4110
-gem "minitest", "~> 5.11.3"
+# google-protobuf 3.12.0 requires Ruby 2.5 or later, so pin to 3.11 on older Rubies
+gem "google-protobuf", (RUBY_VERSION < "2.5" ? "~> 3.11.4" : "~> 3.12")

data/templates/cloud/wrapper_gem/gemspec.erb

@@ -28,12 +28,11 @@ Gem::Specification.new do |gem|
   gem.add_dependency "<%= name %>", "~> <%= requirement %>"
   <%- end -%>
 
-  gem.add_development_dependency "autotest-suffix", "~> 1.1"
   gem.add_development_dependency "google-style", "~> 1.24.0"
-  gem.add_development_dependency "minitest", "~> 5.10"
-  gem.add_development_dependency "minitest-autotest", "~> 1.0"
+  gem.add_development_dependency "minitest", "~> 5.14"
   gem.add_development_dependency "minitest-focus", "~> 1.1"
   gem.add_development_dependency "minitest-rg", "~> 5.2"
+  gem.add_development_dependency "rake", ">= 12.0"
   gem.add_development_dependency "redcarpet", "~> 3.0"
   gem.add_development_dependency "simplecov", "~> 0.9"
   gem.add_development_dependency "yard", "~> 0.9"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gapic-generator-cloud
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.5.1
 platform: ruby
 authors:
 - Ernest Landrito
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-11 00:00:00.000000000 Z
+date: 2020-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -32,14 +32,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: 0.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: 0.5.1
 - !ruby/object:Gem::Dependency
   name: google-style
   requirement: !ruby/object:Gem::Requirement
@@ -198,7 +198,6 @@ files:
 - templates/cloud/wrapper_gem/rakefile.erb
 - templates/cloud/wrapper_gem/readme.erb
 - templates/cloud/wrapper_gem/rubocop.erb
-- templates/cloud/wrapper_gem/test_helper.erb
 - templates/cloud/wrapper_gem/version_test.erb
 - templates/cloud/wrapper_gem/yardopts.erb
 homepage: https://github.com/googleapis/gapic-generator-ruby
@@ -220,7 +219,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: An API Client Generator for Ruby in Ruby!

data/templates/cloud/wrapper_gem/test_helper.erb

@@ -1,9 +0,0 @@
-<%- assert_locals gem -%>
-<%= render partial: "shared/header" -%>
-
-require "simplecov"
-
-gem "minitest"
-require "minitest/autorun"
-require "minitest/focus"
-require "minitest/rg"