gapic-generator 0.1.4

data/templates/default/gem/gemfile.erb

@@ -0,0 +1,4 @@
+<%- assert_locals gem -%>
+source "https://rubygems.org"
+
+gemspec

data/templates/default/gem/gemspec.erb

@@ -0,0 +1,37 @@
+<%- assert_locals gem -%>
+# -*- ruby -*-
+# encoding: utf-8
+require File.expand_path("lib/<%= gem.version_require %>", __dir__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "<%= gem.name %>"
+  gem.version       = <%= gem.version_name_full %>
+
+  gem.authors       = <%= gem.authors.inspect %>
+  gem.email         = <%= gem.email.inspect %>
+  gem.description   = <%= gem.description.inspect %>
+  gem.summary       = <%= gem.summary.inspect %>
+  gem.homepage      = <%= gem.homepage.inspect %>
+  gem.license       = "MIT"
+
+  gem.platform      = Gem::Platform::RUBY
+
+  gem.files         = `git ls-files -- lib/*`.split("\n") +
+                      `git ls-files -- proto_docs/*`.split("\n") +
+                      ["README.md", "LICENSE.md", ".yardopts"]
+  gem.require_paths = ["lib"]
+
+  gem.required_ruby_version = ">= 2.4"
+
+  gem.add_dependency "gapic-common", "~> 0.1.0"
+  <%- if gem.iam_dependency? -%>
+  gem.add_dependency "grpc-google-iam-v1", "~> 0.6.9"
+  <%- end -%>
+
+  gem.add_development_dependency "google-style", "~> 1.24.0"
+  gem.add_development_dependency "minitest", "~> 5.10"
+  gem.add_development_dependency "rake", ">= 12.0"
+  gem.add_development_dependency "redcarpet", "~> 3.0"
+  gem.add_development_dependency "simplecov", "~> 0.18"
+  gem.add_development_dependency "yard", "~> 0.9"
+end

data/templates/default/gem/gitignore.erb

@@ -0,0 +1,20 @@
+<%- assert_locals gem -%>
+# Ignore bundler lockfiles
+Gemfile.lock
+gems.locked
+
+# Ignore documentation output
+doc/*
+.yardoc/*
+
+# Ignore test output
+coverage/*
+
+# Ignore build artifacts
+pkg/*
+
+# Ignore files commonly present in certain dev environments
+.vagrant
+.DS_STORE
+.idea
+*.iml

data/templates/default/gem/license.erb

@@ -0,0 +1,22 @@
+<%- assert_locals gem -%>
+The MIT License (MIT)
+
+Copyright <YEAR> <COPYRIGHT HOLDER>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/templates/default/gem/rakefile.erb

@@ -0,0 +1,27 @@
+<%- assert_locals gem -%>
+<%= render partial: "shared/header" -%>
+
+require "bundler/setup"
+require "bundler/gem_tasks"
+
+require "rubocop/rake_task"
+RuboCop::RakeTask.new
+
+require "rake/testtask"
+desc "Run tests."
+Rake::TestTask.new do |t|
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.warning = false
+end
+
+desc "Run smoke tests."
+Rake::TestTask.new :smoke_test do |t|
+  t.test_files = FileList["acceptance/**/*smoke_test.rb"]
+  t.warning = false
+end
+
+require "yard"
+require "yard/rake/yardoc_task"
+YARD::Rake::YardocTask.new
+
+task default: :test

data/templates/default/gem/readme.erb

@@ -0,0 +1,24 @@
+# <%= gem.title %>
+
+<%= gem.description %>
+
+<%= gem.summary %>
+
+<%= gem.homepage %>
+
+## Installation
+
+```
+$ gem install <%= gem.name %>
+```
+
+## Supported Ruby Versions
+
+This library is supported on Ruby 2.4+.
+
+Google provides official support for Ruby versions that are actively supported
+by Ruby Core—that is, Ruby versions that are either in normal maintenance or
+in security maintenance, and not end of life. Currently, this means Ruby 2.4
+and later. Older versions of Ruby _may_ still work, but are unsupported and not
+recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
+about the Ruby support schedule.

data/templates/default/gem/rubocop.erb

@@ -0,0 +1,59 @@
+<%- assert_locals gem -%>
+inherit_gem:
+  google-style: google-style.yml
+
+AllCops:
+  Exclude:
+    - "lib/**/*_pb.rb"
+    - "proto_docs/**/*"
+    - "test/**/*"
+
+Metrics/AbcSize:
+  Exclude:
+    <%- gem.packages.each do |package| -%>
+    <%- package.services.each do |service| -%>
+    - "lib/<%= service.client_file_path.sub "client.rb", "*.rb" %>"
+    <%- end -%>
+    <%- end -%>
+Metrics/ClassLength:
+  Exclude:
+    <%- gem.packages.each do |package| -%>
+    <%- package.services.each do |service| -%>
+    - "lib/<%= service.client_file_path.sub "client.rb", "*.rb" %>"
+    <%- end -%>
+    <%- end -%>
+Metrics/CyclomaticComplexity:
+  Exclude:
+    <%- gem.packages.each do |package| -%>
+    <%- package.services.each do |service| -%>
+    - "lib/<%= service.client_file_path.sub "client.rb", "*.rb" %>"
+    <%- end -%>
+    <%- end -%>
+Metrics/LineLength:
+  Exclude:
+    <%- gem.packages.each do |package| -%>
+    <%- package.services.each do |service| -%>
+    - "lib/<%= service.client_file_path.sub "client.rb", "*.rb" %>"
+    <%- end -%>
+    <%- end -%>
+Metrics/MethodLength:
+  Exclude:
+    <%- gem.packages.each do |package| -%>
+    <%- package.services.each do |service| -%>
+    - "lib/<%= service.client_file_path.sub "client.rb", "*.rb" %>"
+    <%- end -%>
+    <%- end -%>
+Metrics/PerceivedComplexity:
+  Exclude:
+    <%- gem.packages.each do |package| -%>
+    <%- package.services.each do |service| -%>
+    - "lib/<%= service.client_file_path.sub "client.rb", "*.rb" %>"
+    <%- end -%>
+    <%- end -%>
+Style/CaseEquality:
+  Exclude:
+    <%- gem.packages.each do |package| -%>
+    <%- package.services.each do |service| -%>
+    - "lib/<%= service.client_file_path.sub "client.rb", "*.rb" %>"
+    <%- end -%>
+    <%- end -%>

data/templates/default/gem/version.erb

@@ -0,0 +1,6 @@
+<%- assert_locals gem -%>
+<%= render partial: "gem/version",
+           layout: "layouts/ruby",
+           locals: { gem: gem,
+                     namespace: gem.namespace }
+%>

data/templates/default/gem/yardopts.erb

@@ -0,0 +1,12 @@
+<%- assert_locals gem -%>
+--no-private
+--title=<%= gem.title %>
+--exclude _pb\.rb$
+--markup markdown
+--markup-provider redcarpet
+
+./lib/**/*.rb
+./proto_docs/**/*.rb
+-
+README.md
+LICENSE.md

data/templates/default/helpers/default_helper.rb

@@ -0,0 +1,50 @@
+# 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 "active_support/inflector"
+require "gapic/formatting_utils"
+
+module DefaultHelper
+  def prepend_with input, prepend
+    input
+      .strip
+      .each_line
+      .map { |line| prepend + line }
+      .map { |line| line.blank? ? "\n" : line }
+      .join
+  end
+
+  def indent input, spacing
+    spacing = " " * spacing unless spacing.is_a? String
+    ret = prepend_with input, spacing
+    # Remove trailing whitespace from each line end if present
+    ret.split("\n").map(&:rstrip).join("\n")
+  end
+
+  def indent_tail input, spacing
+    return input if input.lines.count < 2
+
+    input.lines[0] + indent(input.lines[1..-1].join, spacing)
+  end
+
+  def format_number value
+    Gapic::FormattingUtils.format_number value
+  end
+
+  def assert_locals *locals
+    locals.each { |local| raise "missing local in template" if local.nil? }
+  end
+end

data/templates/default/helpers/filepath_helper.rb

@@ -0,0 +1,38 @@
+# 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 "active_support/inflector"
+
+module FilepathHelper
+  ##
+  # Converts a ruby namespace string to a file path string.
+  def ruby_file_path api, namespace
+    file_path = ruby_file_path_for_namespace namespace
+    fix_file_path api, file_path
+  end
+
+  ##
+  # Converts a ruby namespace string to a file path string.
+  def ruby_file_path_for_namespace namespace
+    ActiveSupport::Inflector.underscore namespace
+  end
+
+  ##
+  # Corrects a namespace by replacing known bad values with good values.
+  def fix_file_path api, file_path
+    file_path.split("/").map { |node| api.fix_file_path node }.join("/")
+  end
+end

data/templates/default/helpers/namespace_helper.rb

@@ -0,0 +1,44 @@
+# 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 "active_support/inflector"
+
+module NamespaceHelper
+  ##
+  # Looks up the ruby_package for a dot-separated address string to a new string
+  # and creates the corrected Ruby namespace
+  def ruby_namespace api, address
+    file = api.file_for address
+    address = address.dup
+    address[file.package] = file.ruby_package if file.ruby_package.present?
+    namespace = ruby_namespace_for_address address
+    fix_namespace api, namespace
+  end
+
+  ##
+  # Converts an array or dot-separated address string to a new string with
+  # Ruby double-semicolon separators.
+  def ruby_namespace_for_address address
+    address = address.split "." if address.is_a? String
+    address.reject(&:empty?).map(&:camelize).join "::"
+  end
+
+  ##
+  # Corrects a namespace by replacing known bad values with good values.
+  def fix_namespace api, namespace
+    namespace.split("::").map { |node| api.fix_namespace node }.join("::")
+  end
+end

data/templates/default/helpers/presenter_helper.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.
+
+require "active_support/inflector"
+require_relative "presenters/gem_presenter"
+
+module PresenterHelper
+  def gem_presenter api
+    GemPresenter.new api
+  end
+end

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

@@ -0,0 +1,35 @@
+# 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_relative "enum_value_presenter"
+
+class EnumPresenter
+  def initialize enum
+    @enum = enum
+  end
+
+  def name
+    @enum.name
+  end
+
+  def doc_description
+    @enum.docs_leading_comments
+  end
+
+  def values
+    @values ||= @enum.values.map { |v| EnumValuePresenter.new v }
+  end
+end

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

@@ -0,0 +1,33 @@
+# 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.
+
+class EnumValuePresenter
+  def initialize value
+    @value = value
+  end
+
+  def name
+    @value.name
+  end
+
+  def doc_description
+    @value.docs_leading_comments
+  end
+
+  def number
+    @value.number
+  end
+end