gapic-generator-cloud 0.5.0

data/bin/ruby-cloud-docker-entrypoint

@@ -0,0 +1,130 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Copyright 2020 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
+#
+#     http://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 "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",
+  ":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 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"
+}
+
+# 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|
+  bool_option_map.each do |key, flags|
+    flags = Array(flags).map { |f| "--#{f} BOOL" }
+    op.on(*flags) do |val|
+      val = val.downcase
+      parameters[key] = val if ["true", "false"].include? val
+    end
+  end
+  value_option_map.each do |key, flags|
+    flags = Array(flags).map { |f| "--#{f} VAL" }
+    op.on(*flags) do |val|
+      parameters[key] = val
+    end
+  end
+  path_option_map.each do |key, flags|
+    flags = Array(flags).map { |f| "--#{f} PATHS" }
+    op.on(*flags) do |paths|
+      parameters[key] = paths.split(";")
+                             .map { |path| File.expand_path path, "/in" }
+                             .join(";")
+    end
+  end
+  map_option_map.each do |key, flags|
+    flags = Array(flags).map { |f| "--#{f} MAPPING" }
+    op.on(*flags) do |mapping|
+      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
+
+parameter_strs =
+  parameters.map do |k, v|
+    v = v.gsub("\\", "\\\\\\\\").gsub(",", "\\\\,").gsub("=", "\\\\=")
+    "#{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",
+  # 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"
+system(*protoc_cmd)
+
+remove_paths.each do |path|
+  FileUtils.rm_f Dir.glob "/out/#{path}"
+end

data/cloud-rubocop.yml

@@ -0,0 +1,14 @@
+# This file is to be used as the config for formatting the generated cloud files.
+# We can't reference the generated .rubocop.yml file because Rubocop is so clevar
+# that it won't find the google-style gem unless the file is referenced here.
+inherit_gem:
+  google-style: google-style.yml
+
+AllCops:
+  Exclude:
+    - "acceptance/**/*"
+    - "*.gemspec"
+    - "lib/**/*_pb.rb"
+    - "Rakefile"
+    - "support/**/*"
+    - "test/**/*"

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# Copyright 2018 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.
+
+
+module Gapic
+  module Generator
+    module Cloud
+      VERSION = "0.5.0"
+    end
+  end
+end

data/lib/gapic/generators/cloud_generator.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+# Copyright 2018 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/generators/default_generator"
+require "gapic/presenters"
+require "gapic/presenters/wrapper_gem_presenter"
+
+module Gapic
+  module Generators
+    # The generator orchestrates the rendering of templates for Google Cloud
+    # projects.
+    class CloudGenerator < DefaultGenerator
+      # Initializes the generator.
+      #
+      # @param api [Gapic::Schema::Api] The API model/context to
+      #   generate.
+      def initialize api
+        gem_config = api.configuration[:gem] ||= {}
+        gem_config[:homepage] ||= "https://github.com/googleapis/google-cloud-ruby"
+
+        super
+
+        # Configure to use prefer Google Cloud templates
+        use_templates! File.join __dir__, "../../../templates/cloud"
+      end
+
+      # Generates all the files for the API.
+      #
+      # @return [Array<
+      #   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 = Gapic::Presenters.gem_presenter @api
+
+        # Additional Gem level files
+        cloud_files << g("gem/repo-metadata.erb",  ".repo-metadata.json", gem: gem)
+        cloud_files << g("gem/authentication.erb", "AUTHENTICATION.md",   gem: gem) unless gem.services.empty?
+
+        format_files cloud_files
+
+        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/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("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
+
+      ##
+      # Override the default rubocop config file to be used.
+      def format_config
+        @api.configuration[:format_config] ||
+          google_style_config
+      end
+
+      ##
+      # Path to the rubocop file for this project, which uses google-style
+      def google_style_config
+        File.expand_path File.join __dir__, "../../../cloud-rubocop.yml"
+      end
+    end
+  end
+end

data/lib/gapic/presenters/wrapper_gem_presenter.rb

@@ -0,0 +1,137 @@
+# 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 main_directory_name
+        namespace_require.split("/").last
+      end
+
+      def helpers_require
+        "#{namespace_require}/helpers"
+      end
+
+      def namespace_file_path
+        "#{namespace_require}.rb"
+      end
+
+      def needs_entrypoint?
+        name != namespace_file_path
+      end
+
+      def needs_default_config_block?
+        needs_entrypoint? && !google_cloud_short_name.nil?
+      end
+
+      def migration_version
+        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
+        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?
+        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,53 @@
+# 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/ruby_info"
+
+module Gapic
+  module Presenters
+    ##
+    # A presenter for wrapper services.
+    #
+    class WrapperServicePresenter < ServicePresenter
+      def gem
+        WrapperGemPresenter.new @api
+      end
+
+      def factory_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
+        "#{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