gapic-generator 0.1.5 → 0.3.0

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/lib/_package.erb

@@ -0,0 +1,17 @@
+<%- assert_locals package -%>
+<% @requires = capture do %>
+<%- package.services.each do |service| -%>
+require "<%= service.service_require %>"
+<%- end -%>
+require "<%= package.gem.version_require %>"
+<% end %>
+<%- unless package.empty? -%>
+##
+# To load this package, including all its services, and instantiate a client:
+#
+#     require "<%= package.package_require %>"
+#     client = <%= package.services.first.create_client_call %>
+#
+<%- end -%>
+module <%= package.module_name %>
+end

data/templates/default/lib/_service.erb

@@ -0,0 +1,32 @@
+<%- assert_locals service -%>
+<% @requires = capture do %>
+require "gapic/common"
+require "gapic/config"
+require "gapic/config/method"
+
+require "<%= service.gem.version_require %>"
+
+require "<%= service.credentials_require %>"
+<%- if service.paths? -%>
+require "<%= service.paths_require %>"
+<%- end -%>
+<%- if service.lro? -%>
+require "<%= service.operations_require %>"
+<%- end -%>
+require "<%= service.client_require %>"
+<% end %>
+##
+<%- if service.doc_description -%>
+<%= indent service.doc_description, "# " %>
+#
+<%- end -%>
+# To load this service and instantiate a client:
+#
+#     require "<%= service.service_require %>"
+#     client = <%= service.create_client_call %>
+#
+module <%= service.module_name %>
+end
+<% @footer = capture do %>
+<%= render partial: "service/helpers", locals: { service: service} -%>
+<% end %>

data/templates/default/package.erb

@@ -1,6 +1,6 @@
 <%- assert_locals package -%>
-<%= render partial: "shared/header" -%>
-
-<% package.services.each do |service| %>
-require "<%= service.service_require %>"
-<% end %>
+<%= render partial: "lib/package",
+           layout: "layouts/ruby",
+           locals: { package: package,
+                     namespace: package.parent_namespace }
+%>

data/templates/default/service.erb

@@ -1,8 +1,6 @@
 <%- assert_locals service -%>
-<%= render partial: "shared/header" -%>
-
-require "<%= service.client_require %>"
-<%- if service.lro? -%>
-require "<%= service.operations_require %>"
-<%- end -%>
-require "<%= service.credentials_require %>"
+<%= render partial: "lib/service",
+           layout: "layouts/ruby",
+           locals: { service: service,
+                     namespace: service.namespace }
+%>

data/templates/default/service/_helpers.erb

@@ -0,0 +1,3 @@
+<%- assert_locals service -%>
+helper_path = ::File.join __dir__, "<%= service.service_directory_name%>", "helpers.rb"
+require "<%= service.helpers_require %>" if ::File.file? helper_path

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

@@ -1,21 +1,15 @@
 <%- assert_locals service -%>
 <% @requires = capture do %>
-require "gapic/common"
-require "gapic/config"
-require "gapic/config/method"
-
 <%= render partial: "service/client/requires", locals: { service: service} -%>
-require "<%= service.gem.version_require %>"
 require "<%= service.proto_service_require %>"
-require "<%= service.credentials_require %>"
-<%- if service.paths? -%>
-require "<%= service.paths_require %>"
-<%- end -%>
-<%- if service.lro? -%>
-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 %>
@@ -131,7 +125,3 @@ class <%= service.client_name %>
 
   <%= indent_tail render(partial: "service/client/config", locals: { service: service }), 2 %>
 end
-
-<% @footer = capture do %>
-<%= render partial: "service/client/helpers", locals: { service: service} %>
-<% end %>

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

@@ -1,10 +1,6 @@
 <%- assert_locals service -%>
 <% @requires = capture do %>
-require "gapic/common"
 require "gapic/operation"
-
-require "<%= service.gem.version_require %>"
-require "<%= service.client_require %>"
 require "<%= service.lro_service.proto_service_require %>"
 <% end %>
 # Service that implements Longrunning Operations API.

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

data/templates/default/service/client/method/docs/_request_normal.erb

@@ -1,15 +1,21 @@
 <%- assert_locals method -%>
 # @overload <%= method.name %>(request, options = nil)
-#   @param request [<%= method.request_type %> | Hash]
-<%- if method.doc_description -%>
-<%= indent method.doc_description, "#     " %>
-<%- end -%>
+#   Pass arguments to `<%= method.name %>` via a request object, either of type
+#   {<%= method.request_type %>} or an equivalent Hash.
+#
+#   @param request [<%= method.request_type %>, Hash]
+#     A request object representing the call parameters. Required. To specify no
+#     parameters, or to keep all the default parameter values, pass an empty Hash.
 #   @param options [Gapic::CallOptions, Hash]
 #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
 <%-if method.arguments.any?-%>
 #
 <%- arg_list = method.arguments.map { |arg| "#{arg.name}: nil"}.join ", " -%>
 # @overload <%= method.name %>(<%= arg_list %>)
+#   Pass arguments to `<%= method.name %>` via keyword arguments. Note that at
+#   least one keyword argument is required. To specify no parameters, or to keep all
+#   the default parameter values, pass an empty Hash as a request object (see above).
+#
 <%- method.arguments.each do |arg| -%>
 #   @param <%= arg.name %> [<%= arg.doc_types %>]
 <%- if arg.doc_description -%>
@@ -17,4 +23,3 @@
 <%- end -%>
 <%- end -%>
 <%- end -%>
-#

data/templates/default/service/client/method/docs/_request_streaming.erb

@@ -1,5 +1,5 @@
 <%- assert_locals method -%>
-# @param request [Gapic::StreamInput, Enumerable<<%= method.request_type %> | Hash>]
+# @param request [Gapic::StreamInput, Enumerable<<%= method.request_type %>, Hash>]
 #   An enumerable of {<%= method.request_type %>} instances.
 # @param options [Gapic::CallOptions, Hash]
 #   Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gapic-generator
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.3.0
 platform: ruby
 authors:
 - Ernest Landrito
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-14 00:00:00.000000000 Z
+date: 2020-04-10 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
@@ -237,6 +251,7 @@ files:
 - lib/google/rpc/status.pb.rb
 - templates/default/gem/_version.erb
 - templates/default/gem/changelog.erb
+- templates/default/gem/entrypoint.erb
 - templates/default/gem/gemfile.erb
 - templates/default/gem/gemspec.erb
 - templates/default/gem/gitignore.erb
@@ -249,19 +264,9 @@ 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/lib/_package.erb
+- templates/default/lib/_service.erb
 - templates/default/package.erb
 - templates/default/proto_docs/_enum.erb
 - templates/default/proto_docs/_message.erb
@@ -269,11 +274,11 @@ files:
 - templates/default/proto_docs/proto_file.erb
 - templates/default/proto_docs/readme.erb
 - templates/default/service.erb
+- templates/default/service/_helpers.erb
 - templates/default/service/client.erb
 - templates/default/service/client/_client.erb
 - templates/default/service/client/_config.erb
 - templates/default/service/client/_credentials.erb
-- templates/default/service/client/_helpers.erb
 - templates/default/service/client/_operations.erb
 - templates/default/service/client/_paths.erb
 - templates/default/service/client/_requires.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