gapic-generator 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ceba0ece82d90e96c30c312431c323b819876875dc8a4b9617bf91a96fb2bcae
-  data.tar.gz: '0499a196f065e571e43d0224bd0d1ff97e0093f3913cb1e7a6ed538629c34f98'
+  metadata.gz: ac1010a66ffc02b0775927f2d4407dbb28ad35ac6be10dafe5f59953b79afd34
+  data.tar.gz: f30721b9e721bd6ae5ba2d17cbc0158dcd5983ea53d7b53128b029dc37245886
 SHA512:
-  metadata.gz: 15df407d48360df1fb913e60d8008a4055eddb3da2d1a5f942d5f56199b8b99003845e510d79b7eb69812e99a66306b05cb36374c0fa15f93034241bbc352196
-  data.tar.gz: 37ae32e33d1cee983c188ebefa5a5841687ec8d518d73e85a7df25e2ee10ef838adc670a50699c5bbf3e21430940fe68a88ae178f03e95ced681f79c5eee0d98
+  metadata.gz: d44bfe9a92b92b4417fdb59c8cf3fcc727d43fb83a66502e10c6689bf95d5934038d7c7928a6df4152a1e2f410699dc06708cd841f9538fa29a3a609388c9c9e
+  data.tar.gz: 5c21836f4a939dd7d9b5bf6ac6ace693aa122c9d81eb3df3c44a1d55df29c9d2a74cc4b5823ba9f71809549ec108b97bbdc61f0c6675480233abd208498c31c0

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Release History for gapic-generator
 
+### 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.

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([^`]*(`[^`]*`[^`]*)*[^`\\])?\{([\w,]+)\}(.*)\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[1]}\\\\{#{m[3]}}#{m[4]}"
+        end
+        line
+      end
+    end
+  end
+end

data/lib/gapic/generator/version.rb

@@ -16,6 +16,6 @@
 
 module Gapic
   module Generator
-    VERSION = "0.1.3"
+    VERSION = "0.1.4"
   end
 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/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

@@ -14,8 +14,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "bigdecimal"
 require "active_support/inflector"
+require "gapic/formatting_utils"
 
 module DefaultHelper
   def prepend_with input, prepend
@@ -41,13 +41,7 @@ module DefaultHelper
   end
 
   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
+    Gapic::FormattingUtils.format_number value
   end
 
   def assert_locals *locals

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gapic-generator
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Ernest Landrito
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-11 00:00:00.000000000 Z
+date: 2020-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -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