gapic-generator 0.1.0 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7438b616f56c0f6c150b04d5facd7b77dea1ad988f4892bf2143f455a236653d
-  data.tar.gz: d3d836af88d5bc7ebc433c1a5da15690bd62ba2aabee75b8a647f2aa6e729287
+  metadata.gz: 87900df01c425c43c7c7ac1a46965b2324af78eb6c56b91e6cfe36eb0abf3d56
+  data.tar.gz: 3f72d4b99665d5e235332854e4bbd4cc69f181e08e66fff9a2444cdbd9f44693
 SHA512:
-  metadata.gz: b8a752648197f7b2065bdcde4d9d5462660e8f073adcdd8687b1d9d8c55de34d86dfa69f8e118d51fb8d9a21d3a5c65a95586f633ed33b6db17529443eb429a8
-  data.tar.gz: 68dda5a00441de0c2e8645f9c3c0862d68bf8d96b5e379990c076edde6ea607466bdf95aeb9178e4e45c7be4b0384a94438745abd7596e9a90cd56eea4a5d289
+  metadata.gz: 89550d2af9728e7efdb9a3813fa50bf237dc8322057fce25653fba88aae3871672e50af88d0844e4c2ff34d725734236500e5c17cf0db889e0d517a67852760e
+  data.tar.gz: 653271d51b4f3142d99b21cee2dff0146ddea8768a3d2d128cad0fc3914a498cac532223b53773145a33c57d5167059d1d2c8fd29b17b66d51bf7cb7c1d792d8

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Release History for gapic-generator
 
+### 0.1.5 / 2020-03-13
+
+* More improvements to escaping of curly braces.
+
+### 0.1.4 / 2020-03-12
+
+* Fixed over-escaping of curly braces in preformatted blocks in the yardocs.
+* Fixed typo in authentication document.
+
+### 0.1.3 / 2020-03-11
+
+* Generated numeric constants are formatted with underscores if necessary.
+
+### 0.1.2 / 2020-03-09
+
+* Support multiple grpc service config files
+
+### 0.1.1 / 2020-03-09
+
+* Relax rake dependency.
+
 ### 0.1.0 / 2020-03-07
 
 * Generate default timeout and retry configs based on GRPC service configs.

data/lib/gapic/formatting_utils.rb

@@ -0,0 +1,109 @@
+# 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
+#
+#     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 "bigdecimal"
+
+module Gapic
+  ##
+  # Various string formatting utils
+  #
+  module FormattingUtils
+    @brace_detector = /\A(?<pre>[^`]*(`[^`]*`[^`]*)*[^`\\])?\{(?<inside>[^\s][^}]*)\}(?<post>.*)\z/m
+    @list_element_detector = /\A\s*(\*|\+|-|[0-9a-zA-Z]+\.)\s/
+
+    class << self
+      ##
+      # Given an enumerable of lines, escape braces that look like yardoc type
+      # links. Tries to be smart about handling only braces that would be
+      # interpreted by yard (i.e. those that are not part of preformatted text
+      # blocks).
+      #
+      # @param lines [Enumerable<String>]
+      # @return [Enumerable<String>]
+      #
+      def escape_braces lines
+        # This looks for braces that:
+        # * Are opened and closed on the same line
+        # * Are not nested
+        # * Are not located between backticks
+        # * Are not in a preformatted block
+        #
+        # To detect preformatted blocks, this tracks the "expected" base indent
+        # according to Markdown. Specifically, this is the effective indent of
+        # previous block, which is normally 0 except if we're in a list item.
+        # Then, if a block is indented at least 4 spaces past that expected
+        # indent (and as long as it remains so), those lines are considered
+        # preformatted.
+        in_block = nil
+        base_indent = 0
+        lines.map do |line|
+          indent = line_indent line
+          if indent.nil?
+            in_block = nil
+          else
+            in_block, base_indent = update_indent_state in_block, base_indent, line, indent
+            line = escape_line_braces line if in_block == false
+          end
+          line
+        end
+      end
+
+      ##
+      # Given a number, format it in such a way that Rubocop will be happy.
+      # Specifically, we add underscores if the magnitude is at least 10_000.
+      # This works for both integers and floats.
+      #
+      # @param value [Numeric]
+      # @return [String]
+      #
+      def format_number value
+        return value.to_s if value.abs < 10_000
+        str = value.is_a?(Integer) ? value.to_s : BigDecimal(value.to_f.to_s).to_s("F")
+        re = /^(-?\d+)(\d\d\d)([_\.][_\.\d]+)?$/
+        while (m = re.match str)
+          str = "#{m[1]}_#{m[2]}#{m[3]}"
+        end
+        str
+      end
+
+      private
+
+      def update_indent_state in_block, base_indent, line, indent
+        if in_block != true && @list_element_detector =~ line
+          in_block = false
+          indent = base_indent if indent > base_indent
+          base_indent = (indent + 7) / 4 * 4
+        else
+          in_block = indent >= base_indent + 4 unless in_block == false
+          base_indent = indent / 4 * 4 if in_block == false && indent < base_indent
+        end
+        [in_block, base_indent]
+      end
+
+      def line_indent line
+        m = /^( *)\S/.match line
+        m.nil? ? nil : m[1].length
+      end
+
+      def escape_line_braces line
+        while (m = @brace_detector.match line)
+          line = "#{m[:pre]}\\\\{#{m[:inside]}}#{m[:post]}"
+        end
+        line
+      end
+    end
+  end
+end

data/lib/gapic/generator/version.rb

@@ -16,6 +16,6 @@
 
 module Gapic
   module Generator
-    VERSION = "0.1.0"
+    VERSION = "0.1.5"
   end
 end

data/lib/gapic/grpc_service_config/parser.rb

@@ -26,8 +26,8 @@ module Gapic
     # usable by the microgenerator templates
     #
     module Parser
-      METHOD_CONFIG_JSON_KEY = "method_config"
-      RETRY_POLICY_JSON_KEY = "retry_policy"
+      METHOD_CONFIG_JSON_KEY = "methodConfig"
+      RETRY_POLICY_JSON_KEY = "retryPolicy"
 
       NAMES_JSON_KEY = "name"
       SERVICE_NAME_JSON_KEY = "service"
@@ -35,10 +35,10 @@ module Gapic
 
       TIMEOUT_JSON_KEY = "timeout"
 
-      INITIAL_DELAY_JSON_KEY = "initial_backoff"
-      MAX_DELAY_JSON_KEY = "max_backoff"
-      MULTIPLIER_JSON_KEY = "backoff_multiplier"
-      STATUS_CODES_JSON_KEY = "retryable_status_codes"
+      INITIAL_DELAY_JSON_KEY = "initialBackoff"
+      MAX_DELAY_JSON_KEY = "maxBackoff"
+      MULTIPLIER_JSON_KEY = "backoffMultiplier"
+      STATUS_CODES_JSON_KEY = "retryableStatusCodes"
 
 
       ##
@@ -52,21 +52,21 @@ module Gapic
         service_level_result = {}
         service_method_level_result = {}
 
-        if !service_config_json.nil? && service_config_json.key?(METHOD_CONFIG_JSON_KEY)
-          method_configs_json = service_config_json[METHOD_CONFIG_JSON_KEY]
+        if !service_config_json.nil? && key?(service_config_json, METHOD_CONFIG_JSON_KEY)
+          method_configs_json = get service_config_json, METHOD_CONFIG_JSON_KEY
 
           method_configs_json.each do |method_config_json|
             method_config = parse_config method_config_json
-            service_names = parse_service_names method_config_json[NAMES_JSON_KEY]
-            service_method_names = filter_service_method_names method_config_json[NAMES_JSON_KEY]
+            service_names = parse_service_names get(method_config_json, NAMES_JSON_KEY)
+            service_method_names = filter_service_method_names get(method_config_json, NAMES_JSON_KEY)
 
             service_names.each do |service_name|
               service_level_result[service_name] = method_config
             end
 
             service_method_names.each do |service_method_name|
-              service_name = service_method_name[SERVICE_NAME_JSON_KEY]
-              method_name = service_method_name[METHOD_NAME_JSON_KEY]
+              service_name = get service_method_name, SERVICE_NAME_JSON_KEY
+              method_name = get service_method_name, METHOD_NAME_JSON_KEY
 
               service_method_level_result[service_name] ||= {}
               service_method_level_result[service_name][method_name] = method_config
@@ -92,10 +92,10 @@ module Gapic
       #
       def self.parse_service_names method_config_json_names
         service_names_jsons = method_config_json_names.select do |names_json|
-          names_json.size == 1 && names_json.key?(SERVICE_NAME_JSON_KEY)
+          names_json.size == 1 && key?(names_json, SERVICE_NAME_JSON_KEY)
         end
 
-        service_names_jsons.map { |names_json| names_json[SERVICE_NAME_JSON_KEY] }
+        service_names_jsons.map { |names_json| get names_json, SERVICE_NAME_JSON_KEY }
       end
 
       ##
@@ -113,7 +113,7 @@ module Gapic
       #
       def self.filter_service_method_names method_config_json_names
         method_config_json_names.select do |names_json|
-          names_json.size == 2 && names_json.key?(SERVICE_NAME_JSON_KEY) && names_json.key?(METHOD_NAME_JSON_KEY)
+          names_json.size == 2 && key?(names_json, SERVICE_NAME_JSON_KEY) && key?(names_json, METHOD_NAME_JSON_KEY)
         end
       end
 
@@ -126,8 +126,8 @@ module Gapic
       # @return [Gapic::GrpcServiceConfig::MethodConfig] parsed MethodConfig
       #
       def self.parse_config method_config_json
-        timeout_seconds = parse_interval_seconds method_config_json[TIMEOUT_JSON_KEY]
-        retry_policy = parse_retry_policy method_config_json[RETRY_POLICY_JSON_KEY]
+        timeout_seconds = parse_interval_seconds get(method_config_json, TIMEOUT_JSON_KEY)
+        retry_policy = parse_retry_policy get(method_config_json, RETRY_POLICY_JSON_KEY)
 
         MethodConfig.new timeout_seconds, retry_policy
       end
@@ -143,10 +143,10 @@ module Gapic
       def self.parse_retry_policy retry_policy_json
         return nil if retry_policy_json.nil? || retry_policy_json.empty?
 
-        initial_delay_seconds = parse_interval_seconds retry_policy_json[INITIAL_DELAY_JSON_KEY]
-        max_delay_seconds = parse_interval_seconds retry_policy_json[MAX_DELAY_JSON_KEY]
-        multiplier = retry_policy_json[MULTIPLIER_JSON_KEY]
-        status_codes = retry_policy_json[STATUS_CODES_JSON_KEY]
+        initial_delay_seconds = parse_interval_seconds get(retry_policy_json, INITIAL_DELAY_JSON_KEY)
+        max_delay_seconds = parse_interval_seconds get(retry_policy_json, MAX_DELAY_JSON_KEY)
+        multiplier = get retry_policy_json, MULTIPLIER_JSON_KEY
+        status_codes = get retry_policy_json, STATUS_CODES_JSON_KEY
 
         RetryPolicy.new initial_delay_seconds, max_delay_seconds, multiplier, status_codes
       end
@@ -175,6 +175,28 @@ module Gapic
         Float(timestring_nos)
       end
 
+      ##
+      # Determines if the key or its underscore form exists
+      #
+      # @param hash [Hash] hash structure
+      # @param key [String] lowerCamelCase string
+      # @return [Boolean]
+      #
+      def self.key? hash, key
+        hash.key?(key) || hash.key?(ActiveSupport::Inflector.underscore(key))
+      end
+
+      ##
+      # Look up a key including checking its underscore form
+      #
+      # @param hash [Hash] hash structure
+      # @param key [String] lowerCamelCase string
+      # @return [Object] the result, or `nil` if not found
+      #
+      def self.get hash, key
+        hash[key] || hash[ActiveSupport::Inflector.underscore(key)]
+      end
+
       ##
       # Determines if a given string can be converted to a float
       #

data/lib/gapic/schema/api.rb

@@ -200,16 +200,14 @@ module Gapic
         end
       end
 
-      # Raw parsed json of the grpc service config if provided
-      # or an empty hash if config was not provided
+      # Raw parsed json of the combined grpc service config files if provided
+      # or an empty hash if no config was provided
       def grpc_service_config_raw
         @grpc_service_config_raw ||= begin
-          grpc_service_config_filename = protoc_options["grpc_service_config"]
-          if grpc_service_config_filename
-            file = ::File.read grpc_service_config_filename
-            JSON.parse file
-          else
-            {}
+          filenames = protoc_options["grpc_service_config"].to_s.split ";"
+          filenames.inject({}) do |running_hash, filename|
+            file_hash = JSON.parse ::File.read filename
+            deep_merge running_hash, file_hash
           end
         end
       end
@@ -252,6 +250,8 @@ module Gapic
         left.merge right do |_k, lt, rt|
           if lt.is_a?(Hash) && rt.is_a?(Hash)
             deep_merge lt, rt
+          elsif lt.is_a?(Array) && rt.is_a?(Array)
+            lt + rt
           else
             rt
           end

data/lib/gapic/schema/wrappers.rb

@@ -14,6 +14,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require "gapic/formatting_utils"
+
 module Gapic
   module Schema
     # Base class for all generic proto types including: enums, messages,
@@ -98,13 +100,10 @@ module Gapic
         return nil if @docs.nil?
         return nil if @docs.leading_comments.empty?
 
-        @docs
-          .leading_comments
-          .each_line
-          .map { |line| line.start_with?(" ") ? line[1..-1] : line }
-          .join
-          .split("{").join("\\\\\\{") # The only safe way to replace with \ characters...
-          .split("}").join("\\}")
+        lines = @docs.leading_comments.each_line.to_a
+        lines.map! { |line| line.start_with?(" ") ? line[1..-1] : line }
+        lines = FormattingUtils.escape_braces lines
+        lines.join
       end
 
       # @!method path

data/templates/default/gem/gemspec.erb

@@ -30,7 +30,7 @@ Gem::Specification.new do |gem|
 
   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 "rake", ">= 12.0"
   gem.add_development_dependency "redcarpet", "~> 3.0"
   gem.add_development_dependency "simplecov", "~> 0.18"
   gem.add_development_dependency "yard", "~> 0.9"

data/templates/default/gem/gitignore.erb

@@ -16,3 +16,5 @@ pkg/*
 # Ignore files commonly present in certain dev environments
 .vagrant
 .DS_STORE
+.idea
+*.iml

data/templates/default/helpers/default_helper.rb

@@ -15,6 +15,7 @@
 # limitations under the License.
 
 require "active_support/inflector"
+require "gapic/formatting_utils"
 
 module DefaultHelper
   def prepend_with input, prepend
@@ -39,6 +40,10 @@ module DefaultHelper
     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

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

@@ -2,27 +2,7 @@
 <%- method_service ||= service -%>
 @configure ||= begin
   default_config = <%= service.client_name %>::Configuration.new
-  <%- if service.grpc_service_config && !service.grpc_service_config.empty? -%>
-
-    <%- if service.grpc_service_config.timeout_seconds -%>
-      default_config.timeout = <%= service.grpc_service_config.timeout_seconds %>
-    <%- end -%>
-    <%- if service.grpc_service_config.retry_policy -%>
-      default_config.retry_policy = <%= indent_tail render(partial: "service/client/self_configure_retry_policy", locals: { retry_policy: service.grpc_service_config.retry_policy }), 2 %>
-    <%- end -%>
-  <%- end -%>
-  <%- method_service.methods.each do |method| -%>
-    <%- if method.grpc_service_config && !method.grpc_service_config.empty? -%>
-
-      <%- if method.grpc_service_config.timeout_seconds -%>
-        default_config.rpcs.<%= method.name %>.timeout = <%= method.grpc_service_config.timeout_seconds %>
-      <%- end -%>
-      <%- if method.grpc_service_config.retry_policy -%>
-        default_config.rpcs.<%= method.name %>.retry_policy =<%= indent_tail render(partial: "service/client/self_configure_retry_policy", locals: { retry_policy: method.grpc_service_config.retry_policy }), 2 %>
-      <%- end -%>
-    <%- end -%>
-  <%- end -%>
-
+  <%= render partial: "service/client/self_configure_defaults", locals: {service: service} %>
   default_config
 end
 yield @configure if block_given?

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

@@ -0,0 +1,22 @@
+<%- assert_locals service -%>
+<%- method_service ||= service -%>
+<%- if service.grpc_service_config && !service.grpc_service_config.empty? -%>
+
+  <%- if service.grpc_service_config.timeout_seconds -%>
+    default_config.timeout = <%= format_number service.grpc_service_config.timeout_seconds %>
+  <%- end -%>
+  <%- if service.grpc_service_config.retry_policy -%>
+    default_config.retry_policy = <%= indent_tail render(partial: "service/client/self_configure_retry_policy", locals: { retry_policy: service.grpc_service_config.retry_policy }), 2 %>
+  <%- end -%>
+<%- end -%>
+<%- method_service.methods.each do |method| -%>
+  <%- if method.grpc_service_config && !method.grpc_service_config.empty? -%>
+
+    <%- if method.grpc_service_config.timeout_seconds -%>
+      default_config.rpcs.<%= method.name %>.timeout = <%= format_number method.grpc_service_config.timeout_seconds %>
+    <%- end -%>
+    <%- if method.grpc_service_config.retry_policy -%>
+      default_config.rpcs.<%= method.name %>.retry_policy =<%= indent_tail render(partial: "service/client/self_configure_retry_policy", locals: { retry_policy: method.grpc_service_config.retry_policy }), 2 %>
+    <%- end -%>
+  <%- end -%>
+<%- end -%>

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

@@ -1,13 +1,13 @@
 <%- assert_locals retry_policy -%>
 {
   <%- if retry_policy.initial_delay_seconds -%>
-  initial_delay: <%= retry_policy.initial_delay_seconds %>,
+  initial_delay: <%= format_number retry_policy.initial_delay_seconds %>,
   <%- end -%>
   <%- if retry_policy.max_delay_seconds -%>
-  max_delay: <%= retry_policy.max_delay_seconds %>,
+  max_delay: <%= format_number retry_policy.max_delay_seconds %>,
   <%- end -%>
   <%- if retry_policy.multiplier -%>
-  multiplier: <%= retry_policy.multiplier %>,
+  multiplier: <%= format_number retry_policy.multiplier %>,
   <%- end-%>
   <%- if retry_policy.status_codes -%>
   retry_codes: <%= retry_policy.status_codes %>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gapic-generator
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.5
 platform: ruby
 authors:
 - Ernest Landrito
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-08 00:00:00.000000000 Z
+date: 2020-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -128,14 +128,14 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '12.0'
 - !ruby/object:Gem::Dependency
@@ -204,6 +204,7 @@ files:
 - gem_templates/test_helper.erb
 - gem_templates/version.erb
 - lib/gapic/file_formatter.rb
+- lib/gapic/formatting_utils.rb
 - lib/gapic/gem_builder.rb
 - lib/gapic/generator.rb
 - lib/gapic/generator/version.rb
@@ -278,6 +279,7 @@ files:
 - templates/default/service/client/_requires.erb
 - templates/default/service/client/_resource.erb
 - templates/default/service/client/_self_configure.erb
+- templates/default/service/client/_self_configure_defaults.erb
 - templates/default/service/client/_self_configure_retry_policy.erb
 - templates/default/service/client/method/_def.erb
 - templates/default/service/client/method/def/_options_defaults.erb