gapic-generator-cloud 0.1.7 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08e2bcc2bd866986ff0297a7362e96fbc0aa43a508ce42fe660e6018913da292'
-  data.tar.gz: fd460034ab84232f65e1ff26d0206df9cef2f0ef00f0ab686617609d0cbec7f7
+  metadata.gz: 94f5a540b0be42593cb412dd12b4faedde7bfb63ab763a17fc0996b092aad140
+  data.tar.gz: f56a2ad37c354bfc8bfcaceec8ba2243fdd91fd90adcc225c63f1e3d4e9259af
 SHA512:
-  metadata.gz: bdc310b93f8b8e06c346706faa1356a184362f9185916ac16b6b85e0e7a373dc26294aa32af15e5707679952d799e27de2c52c45735a819b9d9cd984a24453b8
-  data.tar.gz: f0f0ad3514794a3070fbf63dca95a37087cd8f2987832a662e090b76d3df0b8f2a5857d3a7cfe47deb596ed09af606dd0f835c0f7ef02c2225916f9e5001ea9a
+  metadata.gz: 3967ad36a668b618cfcb254aee896451bc404a885f0d0ebee309878f56c1df5868ebe5fe237c990b9c51bd39ea4fb9626f4a919e1b1ff4c4a5165d1574b7605c
+  data.tar.gz: 73232e7e89e8f450e428c8cc13bc474ad77023d780e2ae29e8426f942940cdb6f07cb1ad0da8d59304d2f1a5956835f014d3ccec607a52cb9efa45866b2576cc

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Release History for gapic-generator-cloud
 
+### 0.2.0 / 2020-03-23
+
+* Includes changes from gapic-generator 0.2.0
+* The cloud generator can now be configured to generate wrapper gems.
+
 ### 0.1.7 / 2020-03-18
 
 * Includes changes from gapic-generator 0.1.7

data/bin/ruby-cloud-docker-entrypoint

@@ -18,38 +18,51 @@
 require "optparse"
 require "fileutils"
 
+bool_option_map = {
+  ":gem.:free_tier" => "ruby-cloud-free-tier",
+  ":gem.:yard_strict" => "ruby-cloud-yard-strict"
+}
+value_option_map = {
+  "configuration" => "ruby-cloud-config",
+  ":gem.:name" => "ruby-cloud-gem-name",
+  ":gem.:title" => "ruby-cloud-title",
+  ":gem.:description" => "ruby-cloud-description",
+  ":gem.:summary" => "ruby-cloud-summary",
+  ":gem.:homepage" => "ruby-cloud-homepage",
+  ":gem.:env_prefix" => "ruby-cloud-env-prefix",
+  ":gem.:version_dependencies" => "ruby-cloud-wrapper-of",
+  ":gem.:migration_version" => "ruby-cloud-migration-version",
+  ":gem.:product_documentation_url" => "ruby-cloud-product-url",
+  ":gem.:api_id" => "ruby-cloud-api-id",
+  ":gem.:factory_method_suffix" => "ruby-cloud-factory-method-suffix"
+}
+path_option_map = {
+  "samples" => ["ruby-cloud-samples", "samples"],
+  "grpc_service_config" => "ruby-cloud-grpc-service-config"
+}
+
 parameters = {}
 
 OptionParser.new do |op|
-  op.on "--ruby-cloud-config FILE" do |val|
-    parameters["configuration"] = val
-  end
-  op.on "--ruby-cloud-samples FILE", "--samples FILE" do |val|
-    paths = val.split(";")
-               .map { |path| File.expand_path path, "/in" }
-               .join(";")
-    parameters["samples"] = paths
-  end
-  op.on "--ruby-cloud-grpc-service-config FILE" do |val|
-    paths = val.split(";")
-               .map { |path| File.expand_path path, "/in" }
-               .join(";")
-    parameters["grpc_service_config"] = paths
-  end
-  op.on "--ruby-cloud-gem-name NAME" do |val|
-    parameters[":gem.:name"] = val
+  bool_option_map.each do |key, flags|
+    flags = Array(flags).map { |f| "--#{f}" }
+    op.on(*flags) do
+      parameters[key] = "true"
+    end
   end
-  op.on "--ruby-cloud-title NAME" do |val|
-    parameters[":gem.:title"] = val
+  value_option_map.each do |key, flags|
+    flags = Array(flags).map { |f| "--#{f} VAL" }
+    op.on(*flags) do |val|
+      parameters[key] = val
+    end
   end
-  op.on "--ruby-cloud-summary VAL" do |val|
-    parameters[":gem.:summary"] = val
-  end
-  op.on "--ruby-cloud-homepage VAL" do |val|
-    parameters[":gem.:homepage"] = val
-  end
-  op.on "--ruby-cloud-env-prefix VAL" do |val|
-    parameters[":gem.:env_prefix"] = val
+  path_option_map.each do |key, flags|
+    flags = Array(flags).map { |f| "--#{f} PATH" }
+    op.on(*flags) do |paths|
+      parameters[key] = paths.split(";")
+                             .map { |path| File.expand_path path, "/in" }
+                             .join(";")
+    end
   end
 end.parse! ARGV
 
@@ -59,11 +72,17 @@ parameter_strs =
     "#{k}=#{v}"
   end
 
+ruby_plugin_args =
+  if parameters[":gem.:version_dependencies"]
+    []
+  else
+    ["--ruby_out=/out/lib", "--grpc_out=/out/lib"]
+  end
+
 protoc_cmd = [
   "grpc_tools_ruby_protoc",
-  "--proto_path=/protos/", "--proto_path=/in/",
-  "--ruby_out=/out/lib",
-  "--grpc_out=/out/lib",
+  "--proto_path=/protos/", "--proto_path=/in/"
+] + ruby_plugin_args + [
   "--ruby_cloud_out=/out/",
   "--ruby_cloud_opt", parameter_strs.join(",")
 ] + ARGV + Dir.glob("/in/**/*.proto").sort

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

@@ -17,7 +17,7 @@
 module Gapic
   module Generator
     module Cloud
-      VERSION = "0.1.7"
+      VERSION = "0.2.0"
     end
   end
 end

data/lib/gapic/generators/cloud_generator.rb

@@ -15,6 +15,8 @@
 # limitations under the License.
 
 require "gapic/generators/default_generator"
+require "gapic/presenters"
+require "gapic/presenters/wrapper_gem_presenter"
 
 module Gapic
   module Generators
@@ -41,11 +43,14 @@ module Gapic
       #   Google::Protobuf::Compiler::CodeGeneratorResponse::File>]
       #   The files that were generated for the API.
       def generate
+        gem_config = @api.configuration[:gem] ||= {}
+        return generate_wrapper if gem_config[:version_dependencies]
+
         orig_files = super
 
         cloud_files = []
 
-        gem = gem_presenter @api
+        gem = Gapic::Presenters.gem_presenter @api
 
         # Additional Gem level files
         cloud_files << g("gem/repo-metadata.erb",  ".repo-metadata.json", gem: gem)
@@ -57,6 +62,45 @@ module Gapic
         orig_files + cloud_files
       end
 
+      # Disable Rubocop because we expect generate to grow and violate more
+      # and more style rules.
+      # rubocop:disable all
+
+      # Generates the files for a wrapper.
+      #
+      # @return [Array<Google::Protobuf::Compiler::CodeGeneratorResponse::File>]
+      #   The files that were generated for the API.
+      #
+      def generate_wrapper
+        files = []
+
+        gem = Gapic::Presenters.wrapper_gem_presenter @api
+
+        files << g("gem/gitignore.erb",            ".gitignore",                                    gem: gem)
+        files << g("gem/repo-metadata.erb",        ".repo-metadata.json",                           gem: gem)
+        files << g("wrapper_gem/rubocop.erb",      ".rubocop.yml",                                  gem: gem)
+        files << g("wrapper_gem/yardopts.erb",     ".yardopts",                                     gem: gem)
+        files << g("gem/authentication.erb",       "AUTHENTICATION.md",                             gem: gem)
+        files << g("gem/changelog.erb",            "CHANGELOG.md",                                  gem: gem)
+        files << g("wrapper_gem/gemfile.erb",      "Gemfile",                                       gem: gem)
+        files << g("gem/license.erb",              "LICENSE.md",                                    gem: gem)
+        files << g("wrapper_gem/rakefile.erb",     "Rakefile",                                      gem: gem)
+        files << g("wrapper_gem/readme.erb",       "README.md",                                     gem: gem)
+        files << g("wrapper_gem/gemspec.erb",      "#{gem.name}.gemspec",                           gem: gem)
+        files << g("wrapper_gem/dashed.erb",       "lib/#{gem.name}.rb",                            gem: gem) if gem.needs_dashed_ruby_file?
+        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("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)
+
+        format_files files
+
+        files
+      end
+
+      # rubocop:enable all
+
       private
 
       ##

data/lib/gapic/presenters/wrapper_gem_presenter.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+# Copyright 2019 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require "gapic/presenters"
+require "gapic/presenters/wrapper_service_presenter"
+
+module Gapic
+  module Presenters
+    ##
+    # A presenter for wrapper gems.
+    #
+    class WrapperGemPresenter < GemPresenter
+      def entrypoint_require
+        namespace_require
+      end
+
+      def services
+        @services ||= begin
+          files = @api.generate_files
+          files.map(&:services).flatten.map { |s| WrapperServicePresenter.new @api, s }
+        end
+      end
+
+      def namespace_require
+        ruby_file_path @api, namespace
+      end
+
+      def namespace_file_path
+        "#{namespace_require}.rb"
+      end
+
+      def needs_dashed_ruby_file?
+        name != namespace_file_path
+      end
+
+      def migration_version
+        gem_config :migration_version
+      end
+
+      def pre_migration_version
+        m = /^(\d)+\./.match migration_version.to_s
+        return nil unless m
+        "#{m[1].to_i - 1}.x"
+      end
+
+      def migration?
+        migration_version ? true : false
+      end
+
+      def extra_files
+        files = ["README.md", "AUTHENTICATION.md", "LICENSE.md", ".yardopts"]
+        files << "MIGRATING.md" if migration?
+        files
+      end
+
+      def factory_method_suffix
+        gem_config(:factory_method_suffix).to_s
+      end
+
+      def version_dependencies
+        gem_config(:version_dependencies).to_s.split(";").map { |str| str.split ":" }
+      end
+
+      def gem_version_dependencies
+        version_dependencies.sort_by { |version, _requirement| version }
+                            .map { |version, requirement| ["#{name}-#{version}", requirement] }
+      end
+
+      def versioned_gems
+        gem_version_dependencies.map { |name, _requirement| name }
+      end
+
+      def default_version
+        version_dependencies.first&.first
+      end
+
+      def google_cloud_short_name
+        m = /^google-cloud-(.*)$/.match name
+        return nil unless m
+        m[1].tr "-", "_"
+      end
+
+      def docs_link version: nil, class_name: nil, text: nil
+        gem_name = version ? "#{name}-#{version}" : name
+        base_url = "https://googleapis.dev/ruby/#{gem_name}/latest"
+        if class_name
+          path = namespace.gsub "::", "/"
+          path = "#{path}/#{version.capitalize}" if version
+          class_path = class_name.gsub "::", "/"
+          text ||= namespaced_class class_name, version: version
+          return "[#{text}](#{base_url}/#{path}/#{class_path}.html)"
+        end
+        "[#{text || name}](#{base_url})"
+      end
+
+      def namespaced_class name, version: nil
+        base = version ? "#{namespace}::#{version.capitalize}" : namespace
+        "#{base}::#{name}"
+      end
+    end
+
+    def self.wrapper_gem_presenter api
+      WrapperGemPresenter.new api
+    end
+  end
+end

data/lib/gapic/presenters/wrapper_service_presenter.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# Copyright 2019 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require "gapic/presenters"
+
+module Gapic
+  module Presenters
+    ##
+    # A presenter for wrapper services.
+    #
+    class WrapperServicePresenter < ServicePresenter
+      def gem
+        WrapperGemPresenter.new @api
+      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
+      end
+
+      def create_client_call
+        "#{gem.namespace}.#{factory_method_name}"
+      end
+
+      def configure_client_call
+        "#{gem.namespace}.configure"
+      end
+
+      def credentials_class_xref
+        "`#{credentials_name_full}`"
+      end
+    end
+  end
+end

data/templates/cloud/gem/authentication.erb

@@ -28,16 +28,16 @@ export <%= gem.env_prefix %>_CREDENTIALS=path/to/keyfile.json
 3. Initialize the client.
 
 ```ruby
-require "<%= service.package.package_require %>"
+require "<%= gem.entrypoint_require %>"
 
-client = <%= service.client_name_full %>.new
+client = <%= service.create_client_call %>
 ```
 
 ## Credential Lookup
 
 The <%= gem.name %> library aims to make authentication
 as simple as possible, and provides several mechanisms to configure your system
-without **Service Account Credentials** directly in code.
+without requiring **Service Account Credentials** directly in code.
 
 **Credentials** are discovered in the following order:
 
@@ -67,7 +67,7 @@ containers where writing files is difficult or not encouraged.
 
 The environment variables that <%= gem.name %>
 checks for credentials are configured on the service Credentials class (such as
-{<%= service.credentials_name_full %>}):
+<%= service.credentials_class_xref %>):
 
 1. `<%= gem.env_prefix %>_CREDENTIALS` - Path to JSON file, or JSON contents
 2. `<%= gem.env_prefix %>_KEYFILE` - Path to JSON file, or JSON contents
@@ -76,11 +76,11 @@ checks for credentials are configured on the service Credentials class (such as
 5. `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
 
 ```ruby
-require "<%= service.package.package_require %>"
+require "<%= gem.entrypoint_require %>"
 
 ENV["<%= gem.env_prefix %>_CREDENTIALS"] = "path/to/keyfile.json"
 
-client = <%= service.client_name_full %>.new
+client = <%= service.create_client_call %>
 ```
 
 ### Configuration
@@ -89,9 +89,9 @@ The **Credentials JSON** can be configured instead of placing them in
 environment variables. Either on an individual client initialization:
 
 ```ruby
-require "<%= service.package.package_require %>"
+require "<%= gem.entrypoint_require %>"
 
-client = <%= service.client_name_full %>.new do |config|
+client = <%= service.create_client_call %> do |config|
   config.credentials = "path/to/keyfile.json"
 end
 ```
@@ -99,13 +99,13 @@ end
 Or configured globally for all clients:
 
 ```ruby
-require "<%= service.package.package_require %>"
+require "<%= gem.entrypoint_require %>"
 
-<%= service.client_name_full %>.configure do |config|
+<%= service.configure_client_call %> do |config|
   config.credentials = "path/to/keyfile.json"
 end
 
-client = <%= service.client_name_full %>.new
+client = <%= service.create_client_call %>
 ```
 
 ### Cloud SDK
@@ -138,9 +138,9 @@ Google Cloud requires **Service Account Credentials** to
 connect to the APIs. You will use the **JSON key file** to
 connect to most services with <%= gem.name %>.
 
-If you are not running this client within [Google Cloud Platform
-environments](#google-cloud-platform-environments), you need a Google
-Developers service account.
+If you are not running this client within
+[Google Cloud Platform environments](#google-cloud-platform-environments), you
+need a Google Developers service account.
 
 1. Visit the [Google Developers Console][dev-console].
 2. Create a new project or click on an existing project.