gapic-generator 0.1.4 → 0.2.3

data/templates/default/gem/gemspec.erb

@@ -23,7 +23,7 @@ Gem::Specification.new do |gem|
 
   gem.required_ruby_version = ">= 2.4"
 
-  gem.add_dependency "gapic-common", "~> 0.1.0"
+  gem.add_dependency "gapic-common", "~> 0.2"
   <%- if gem.iam_dependency? -%>
   gem.add_dependency "grpc-google-iam-v1", "~> 0.6.9"
   <%- end -%>

data/templates/default/gem/readme.erb

@@ -1,9 +1,9 @@
 # <%= gem.title %>
 
-<%= gem.description %>
-
 <%= gem.summary %>
 
+<%= gem.description %>
+
 <%= gem.homepage %>
 
 ## Installation

data/templates/default/gem/rubocop.erb

@@ -57,3 +57,5 @@ Style/CaseEquality:
     - "lib/<%= service.client_file_path.sub "client.rb", "*.rb" %>"
     <%- end -%>
     <%- end -%>
+Style/ModuleFunction:
+  Enabled: false

data/templates/default/helpers/filepath_helper.rb

@@ -14,25 +14,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "active_support/inflector"
+require "gapic/helpers/filepath_helper"
 
-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
+FilepathHelper = Gapic::Helpers::FilepathHelper

data/templates/default/helpers/namespace_helper.rb

@@ -14,31 +14,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "active_support/inflector"
+require "gapic/helpers/namespace_helper"
 
-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
+NamespaceHelper = Gapic::Helpers::NamespaceHelper

data/templates/default/layouts/_ruby.erb

@@ -1,11 +1,9 @@
 <%- assert_locals namespace -%>
 <%= render partial: "shared/header" -%>
-<%- if instance_variable_defined? :@requires -%>
 
+<%- if instance_variable_defined? :@requires -%>
 <%= @requires -%>
 <%- end -%>
-<%- # Two newlines here so YARD won't use the header as documentation -%>
-
 
 <%- namespace.split("::").each_with_index do |ns, i| -%>
 <%= indent "module #{ns}", i*2 %>

data/templates/default/service/client/_client.erb

@@ -15,7 +15,13 @@ require "<%= service.paths_require %>"
 require "<%= service.operations_require %>"
 <%- end -%>
 <% end %>
-# Service that implements <%= service.name %> API.
+##
+# Client for the <%= service.name %> service.
+#
+<%- if service.doc_description -%>
+<%= indent service.doc_description, "# " %>
+#
+<%- end -%>
 class <%= service.client_name %>
 <%- if service.paths? -%>
   include <%= service.paths_name %>

data/templates/default/service/client/_paths.erb

@@ -5,4 +5,5 @@ module Paths
 <%= indent render(partial: "service/client/resource", locals: { resource: resource }), 2 %>
 
 <%- end %>
+  extend self
 end

data/templates/default/service/client/method/def/_options_defaults.erb

@@ -1,6 +1,6 @@
 <%- assert_locals method -%>
 # Converts hash and nil to an options object
-options = Gapic::CallOptions.new options.to_h if options.respond_to? :to_h
+options = Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
 
 # Customize the options with defaults
 metadata = @config.rpcs.<%= method.name %>.metadata.to_h

data/templates/default/service/client/method/def/_response_normal.erb

@@ -1,7 +1,7 @@
 <%- assert_locals method -%>
 @<%= method.service.stub_name %>.call_rpc :<%= method.name %>, request, options: options do |response, operation|
   <%- if method.lro? -%>
-  response = Gapic::Operation.new response, <%= method.service.lro_client_ivar %>
+  response = Gapic::Operation.new response, <%= method.service.lro_client_ivar %>, options: options
   <%- end -%>
   yield response, operation if block_given?
   return response

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gapic-generator
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.3
 platform: ruby
 authors:
 - Ernest Landrito
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-12 00:00:00.000000000 Z
+date: 2020-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -215,9 +215,23 @@ files:
 - lib/gapic/grpc_service_config/parsing_error.rb
 - lib/gapic/grpc_service_config/retry_policy.rb
 - lib/gapic/grpc_service_config/service_config.rb
+- lib/gapic/helpers/filepath_helper.rb
+- lib/gapic/helpers/namespace_helper.rb
 - lib/gapic/path_template.rb
 - lib/gapic/path_template/parser.rb
 - lib/gapic/path_template/segment.rb
+- lib/gapic/presenters.rb
+- lib/gapic/presenters/enum_presenter.rb
+- lib/gapic/presenters/enum_value_presenter.rb
+- lib/gapic/presenters/field_presenter.rb
+- lib/gapic/presenters/file_presenter.rb
+- lib/gapic/presenters/gem_presenter.rb
+- lib/gapic/presenters/message_presenter.rb
+- lib/gapic/presenters/method_presenter.rb
+- lib/gapic/presenters/package_presenter.rb
+- lib/gapic/presenters/resource_presenter.rb
+- lib/gapic/presenters/sample_presenter.rb
+- lib/gapic/presenters/service_presenter.rb
 - lib/gapic/resource_lookup.rb
 - lib/gapic/runner.rb
 - lib/gapic/schema.rb
@@ -249,18 +263,6 @@ files:
 - templates/default/helpers/default_helper.rb
 - templates/default/helpers/filepath_helper.rb
 - templates/default/helpers/namespace_helper.rb
-- templates/default/helpers/presenter_helper.rb
-- templates/default/helpers/presenters/enum_presenter.rb
-- templates/default/helpers/presenters/enum_value_presenter.rb
-- templates/default/helpers/presenters/field_presenter.rb
-- templates/default/helpers/presenters/file_presenter.rb
-- templates/default/helpers/presenters/gem_presenter.rb
-- templates/default/helpers/presenters/message_presenter.rb
-- templates/default/helpers/presenters/method_presenter.rb
-- templates/default/helpers/presenters/package_presenter.rb
-- templates/default/helpers/presenters/resource_presenter.rb
-- templates/default/helpers/presenters/sample_presenter.rb
-- templates/default/helpers/presenters/service_presenter.rb
 - templates/default/layouts/_ruby.erb
 - templates/default/package.erb
 - templates/default/proto_docs/_enum.erb

data/templates/default/helpers/presenter_helper.rb

@@ -1,24 +0,0 @@
-# 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/field_presenter.rb

@@ -1,146 +0,0 @@
-# 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"
-
-class FieldPresenter
-  include NamespaceHelper
-
-  def initialize api, message, field
-    @api = api
-    @message = message
-    @field = field
-  end
-
-  def name
-    @field.name
-  end
-
-  def doc_types
-    field_doc_types @field, false
-  end
-
-  def doc_attribute_type
-    mode = @field.output_only? ? "r" : "rw"
-    "@!attribute [#{mode}] #{@field.name}"
-  end
-
-  def output_doc_types
-    field_doc_types @field, true
-  end
-
-  def doc_description
-    @field.docs_leading_comments
-  end
-
-  def default_value
-    single = default_singular_value
-    return "[#{single}]" if @field.repeated? && !@field.map?
-    single
-  end
-
-  def as_kwarg value: nil
-    "#{name}: #{value || name}"
-  end
-
-  # TODO: remove, only used in tests
-  def type_name
-    @field.type_name
-  end
-
-  def type_name_full
-    return nil if type_name.blank?
-    ruby_namespace @api, type_name
-  end
-
-  def message?
-    @field.message?
-  end
-
-  def enum?
-    @field.enum?
-  end
-
-  def repeated?
-    @field.repeated?
-  end
-
-  def map?
-    @field.map?
-  end
-
-  protected
-
-  def field_doc_types field, output
-    return field_map_type field.message, output if field.map?
-    base_type =
-      if field.message?
-        type = message_ruby_type field.message
-        output ? type : "#{type} | Hash"
-      elsif field.enum?
-        # TODO: handle when arg message is nil and enum is the type
-        message_ruby_type field.enum
-      else
-        case field.type
-        when 1, 2                              then "Float"
-        when 3, 4, 5, 6, 7, 13, 15, 16, 17, 18 then "Integer"
-        when 9, 12                             then "String"
-        when 8                                 then "Boolean"
-        else
-          "Object"
-        end
-      end
-    field.repeated? ? "Array<#{base_type}>" : base_type
-  end
-
-  def field_map_type entry_message, output
-    key_field = value_field = nil
-    entry_message.fields.each do |field|
-      key_field = field if field.name == "key"
-      value_field = field if field.name == "value"
-    end
-    class_name = output ? "Google::Protobuf::Map" : "Hash"
-    if key_field && value_field
-      key_type = field_doc_types key_field, output
-      value_type = field_doc_types value_field, output
-      "#{class_name}{#{key_type} => #{value_type}}"
-    else
-      class_name
-    end
-  end
-
-  def default_singular_value
-    if @field.message?
-      "{}"
-    elsif @field.enum?
-      # TODO: select the first non-0 enum value
-      ":#{@field.enum.values.first.name}"
-    else
-      case @field.type
-      when 1, 2                              then "3.5"
-      when 3, 4, 5, 6, 7, 13, 15, 16, 17, 18 then "42"
-      when 9, 12                             then "\"hello world\""
-      when 8                                 then "true"
-      else
-        "Object"
-      end
-    end
-  end
-
-  def message_ruby_type message
-    ruby_namespace @api, message.address.join(".")
-  end
-end

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

@@ -1,53 +0,0 @@
-# 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_presenter"
-require_relative "message_presenter"
-
-class FilePresenter
-  include NamespaceHelper
-
-  # @param file [Gapic::Schema::File] the file to present
-  def initialize api, file
-    @api = api
-    @file = file
-  end
-
-  def name
-    @file.name
-  end
-
-  def address
-    @file.address
-  end
-
-  def namespace
-    return @file.ruby_package if @file.ruby_package.present?
-    ruby_namespace_for_address address
-  end
-
-  def messages
-    @messages ||= @file.messages.map { |m| MessagePresenter.new @api, m }
-  end
-
-  def enums
-    @enums ||= @file.enums.map { |e| EnumPresenter.new e }
-  end
-
-  def docs_file_path
-    @file.name.gsub ".proto", ".rb"
-  end
-end

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

@@ -1,140 +0,0 @@
-# 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_relative "file_presenter"
-require_relative "package_presenter"
-require_relative "service_presenter"
-
-class GemPresenter
-  include FilepathHelper
-  include NamespaceHelper
-
-  def initialize api
-    @api = api
-  end
-
-  def packages
-    @packages ||= begin
-      packages = @api.generate_files.map(&:package).uniq.sort
-      packages.map { |p| PackagePresenter.new @api, p }.delete_if(&:empty?)
-    end
-  end
-
-  def services
-    @services ||= begin
-      files = @api.generate_files
-      files.map(&:services).flatten.map { |s| ServicePresenter.new @api, s }
-    end
-  end
-
-  def proto_files
-    @proto_files ||= begin
-      files = @api.files
-      files = files.reject { |f| blacklist_protos.include? f.name }
-      files = files.reject { |f| f.messages.empty? && f.enums.empty? }
-      files.map { |f| FilePresenter.new @api, f }
-    end
-  end
-
-  def address
-    name.split("-").map(&:camelize)
-  end
-
-  def name
-    gem_config :name
-  end
-
-  def namespace
-    gem_config(:namespace) ||
-      fix_namespace(@api, name.split("-").map(&:camelize).join("::"))
-  end
-
-  def title
-    gem_config(:title) ||
-      namespace.split("::").join(" ")
-  end
-
-  def version
-    gem_config(:version) ||
-      "0.0.1"
-  end
-
-  def version_require
-    ruby_file_path @api, version_name_full
-  end
-
-  def version_file_path
-    "#{version_require}.rb"
-  end
-
-  def version_name_full
-    "#{namespace}::VERSION"
-  end
-
-  def authors
-    gem_config(:authors) ||
-      ["Google LLC"]
-  end
-
-  def email
-    gem_config(:email) ||
-      "googleapis-packages@google.com"
-  end
-
-  def description
-    gem_config(:description) ||
-      "#{name} is the official library for #{title} API."
-  end
-
-  def summary
-    gem_config(:summary) ||
-      "API Client library for #{title} API"
-  end
-
-  def homepage
-    gem_config(:homepage) ||
-      "https://github.com/googleapis/googleapis"
-  end
-
-  def env_prefix
-    (gem_config(:env_prefix) || name.split("-").last).upcase
-  end
-
-  def iam_dependency?
-    @api.files.map(&:name).include? "google/iam/v1/iam_policy.proto"
-  end
-
-  private
-
-  def gem_config key
-    return unless @api.configuration[:gem]
-
-    @api.configuration[:gem][key]
-  end
-
-  def blacklist_protos
-    blacklist = gem_config :blacklist
-
-    return default_blacklist_protos if blacklist.nil?
-    return default_blacklist_protos if blacklist[:protos].nil?
-
-    default_blacklist_protos[:protos]
-  end
-
-  def default_blacklist_protos
-    ["google/api/http.proto", "google/protobuf/descriptor.proto"]
-  end
-end