gapic-generator 0.1.3 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ceba0ece82d90e96c30c312431c323b819876875dc8a4b9617bf91a96fb2bcae
-  data.tar.gz: '0499a196f065e571e43d0224bd0d1ff97e0093f3913cb1e7a6ed538629c34f98'
+  metadata.gz: 7c88e9ae5990030e6fd090eaebcc037a128121621b2be5442e12353985530f90
+  data.tar.gz: 3dd8af72aecf6cb4b2b2fedf692e987bf8aa74c7484e40ee1de677020a141e0b
 SHA512:
-  metadata.gz: 15df407d48360df1fb913e60d8008a4055eddb3da2d1a5f942d5f56199b8b99003845e510d79b7eb69812e99a66306b05cb36374c0fa15f93034241bbc352196
-  data.tar.gz: 37ae32e33d1cee983c188ebefa5a5841687ec8d518d73e85a7df25e2ee10ef838adc670a50699c5bbf3e21430940fe68a88ae178f03e95ced681f79c5eee0d98
+  metadata.gz: 0f508a5ab35d5a342c9f6a208bd888277cf82e3ba15215120b2bbdd71a01dff675fe54758e78e5f0a3240dfe3528aefcb120f7cb8b1caa9477f3f6dd5e6a9e5b
+  data.tar.gz: c1188319beee864fa260f0c6ef5f2b9e34ec0b3778de3901cf544e8ab151075dfb450c45159cff4ae1c666c838f7b2ce105f5cb29c07cbe6f2ff9ff5f815f9ef

data/CHANGELOG.md

@@ -1,5 +1,54 @@
 # Release History for gapic-generator
 
+### 0.2.2 / 2020-03-31
+
+* Updates to common protos, especially core types which were more than a year old.
+
+### 0.2.1 / 2020-03-26
+
+* Fix service address for LRO operation clients.
+* Tweak sample task names for wrapper-gem Rakefiles.
+
+### 0.2.0 / 2020-03-23
+
+Generation updates:
+
+* Proto service documentation is rendered into client class YARD docs.
+* Generated Apache license is now well-formatted markdown.
+* YARD titles updated with the word "API".
+* Tweaks to the default summary and description text.
+* Generated rakefiles can run acceptance tests if present.
+* Switch the order of summary and description in the readmes.
+* Exempt a few more files (notably gemspec and rakefile) from rubocop.
+* Several formatting tweaks, including removal of redundant whitespace.
+
+Internal changes:
+
+* New configuration allows path helpers to be generated from outputs.
+* Moved presenters into lib so they can be changed/subclassed more easily.
+* Several additions to GemPresenter to support new features.
+
+### 0.1.7 / 2020-03-18
+
+* Path modules extend self so helpers can be invoked on them directly
+* Trigger IAM dependency for IAM V1 files other than iam_policy.proto
+
+### 0.1.6 / 2020-03-17
+
+* Generated libraries now depend on gapic-common 0.2
+* Convert cross-reference syntax in proto docs to YARD cross-reference links.
+* Preserve call options in LROs
+* Fix implicit kwarg warnings under Ruby 2.7
+
+### 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.

data/lib/gapic/formatting_utils.rb

@@ -0,0 +1,160 @@
+# 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
+    @xref_detector = /\A(?<pre>[^`]*(`[^`]*`[^`]*)*)?\[(?<text>[\w\.]+)\]\[(?<addr>[\w\.]+)\](?<post>.*)\z/m
+    @list_element_detector = /\A\s*(\*|\+|-|[0-9a-zA-Z]+\.)\s/
+
+    class << self
+      ##
+      # Given an enumerable of lines, performs yardoc formatting, including:
+      # * Interpreting cross-references identified as described in AIP 192
+      # * Escaping literal braces that look like yardoc type links
+      #
+      # Tries to be smart about exempting preformatted text blocks.
+      #
+      # @param api [Gapic::Schema::Api]
+      # @param lines [Enumerable<String>]
+      # @param disable_xrefs [Boolean] (default is `false`) Disable linking to
+      #   cross-references, and render them simply as text. This can be used if
+      #   it is known that the targets are not present in the current library.
+      # @return [Enumerable<String>]
+      #
+      def format_doc_lines api, lines, disable_xrefs: false
+        # 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
+            if in_block == false
+              line = escape_line_braces line
+              line = format_line_xrefs api, line, disable_xrefs
+            end
+          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
+
+      def format_line_xrefs api, line, disable_xrefs
+        while (m = @xref_detector.match line)
+          entity = api.lookup m[:addr]
+          return line if entity.nil?
+          text = m[:text]
+          yard_link = disable_xrefs ? text : yard_link_for_entity(entity, text)
+          return line if yard_link.nil?
+          line = "#{m[:pre]}#{yard_link}#{m[:post]}"
+        end
+        line
+      end
+
+      ##
+      # Generate a YARD-style cross-reference for the given entity.
+      #
+      # @param entity [Gapic::Schema::Proto] the entity to link to
+      # @param text [String] the text for the link
+      # @return [String] YARD cross-reference syntax
+      #
+      def yard_link_for_entity entity, text
+        # As a special case, omit the service "google.longrunning.Operations"
+        # and its methods. This is because the generator creates
+        # service-specific copies of the operations client, rather than a
+        # Google::Longrunning::Operations::Client class, and there is in
+        # general no way to tell what the actual service-specific namespace is.
+        return text if entity.address[0, 3] == ["google", "longrunning", "Operations"]
+
+        case entity
+        when Gapic::Schema::Service
+          "{#{convert_address_to_ruby entity}::Client #{text}}"
+        when Gapic::Schema::Method
+          "{#{convert_address_to_ruby entity.parent}::Client##{entity.name.underscore} #{text}}"
+        when Gapic::Schema::Message, Gapic::Schema::Enum, Gapic::Schema::EnumValue
+          "{#{convert_address_to_ruby entity} #{text}}"
+        when Gapic::Schema::Field
+          "{#{convert_address_to_ruby entity.parent}##{entity.name} #{text}}"
+        end
+      end
+
+      def convert_address_to_ruby entity
+        file = entity.containing_file
+        api = file.containing_api
+        address = entity.address
+        address = address.join "." if address.is_a? Array
+        address = address.sub file.package, file.ruby_package if file.ruby_package&.present?
+        address.split(".").reject(&:empty?).map(&:camelize).map { |node| api.fix_namespace node }.join("::")
+      end
+    end
+  end
+end

data/lib/gapic/generator/version.rb

@@ -16,6 +16,6 @@
 
 module Gapic
   module Generator
-    VERSION = "0.1.3"
+    VERSION = "0.2.2"
   end
 end

data/lib/gapic/generators/base_generator.rb

@@ -55,14 +55,6 @@ module Gapic
           controller.class.all_helpers_from_path helpers_path
       end
 
-      def use_helpers! *helper_methods
-        helper_methods.each do |helper_method|
-          define_singleton_method helper_method do |*args|
-            controller.class.helpers.method(helper_method).call(*args)
-          end
-        end
-      end
-
       def controller
         # Each controller gets a new class, so multiple generators can be
         # active at the same time without stomping on each other.

data/lib/gapic/generators/default_generator.rb

@@ -15,6 +15,7 @@
 # limitations under the License.
 
 require "gapic/generators/base_generator"
+require "gapic/presenters"
 
 module Gapic
   module Generators
@@ -29,9 +30,6 @@ module Gapic
 
         # Configure to use a custom templates directory
         use_templates! File.join __dir__, "../../../templates/default"
-
-        # Configure these helper method to be used by the generator
-        use_helpers! :gem_presenter
       end
 
       # Disable Rubocop because we expect generate to grow and violate more
@@ -46,7 +44,7 @@ module Gapic
       def generate
         files = []
 
-        gem = gem_presenter @api
+        gem = Gapic::Presenters.gem_presenter @api
 
         gem.packages.each do |package|
           # Package level files

data/lib/gapic/helpers/filepath_helper.rb

@@ -0,0 +1,45 @@
+# 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 Gapic
+  module Helpers
+    ##
+    # Helpers related to generating paths to ruby files (e.g. for require)
+    #
+    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
+  end
+end

data/lib/gapic/helpers/namespace_helper.rb

@@ -0,0 +1,51 @@
+# 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 Gapic
+  module Helpers
+    ##
+    # Helpers related to generating ruby namespaces
+    #
+    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
+  end
+end

data/lib/gapic/presenters.rb

@@ -0,0 +1,44 @@
+# 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 "gapic/presenters/enum_presenter"
+require "gapic/presenters/enum_value_presenter"
+require "gapic/presenters/field_presenter"
+require "gapic/presenters/file_presenter"
+require "gapic/presenters/gem_presenter"
+require "gapic/presenters/message_presenter"
+require "gapic/presenters/method_presenter"
+require "gapic/presenters/package_presenter"
+require "gapic/presenters/resource_presenter"
+require "gapic/presenters/sample_presenter"
+require "gapic/presenters/service_presenter"
+
+module Gapic
+  ##
+  # A namespace for presenter classes.
+  #
+  module Presenters
+    ##
+    # Return a gem presenter
+    #
+    # @param api [Gapic::Schema::Api] The api schema object
+    # @return [Gapic::Presenters::GemPresenter]
+    #
+    def self.gem_presenter api
+      GemPresenter.new api
+    end
+  end
+end

data/{templates/default/helpers → lib/gapic}/presenters/enum_presenter.rb

@@ -14,22 +14,27 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require_relative "enum_value_presenter"
+module Gapic
+  module Presenters
+    ##
+    # A presenter for proto enums.
+    #
+    class EnumPresenter
+      def initialize enum
+        @enum = enum
+      end
 
-class EnumPresenter
-  def initialize enum
-    @enum = enum
-  end
-
-  def name
-    @enum.name
-  end
+      def name
+        @enum.name
+      end
 
-  def doc_description
-    @enum.docs_leading_comments
-  end
+      def doc_description
+        @enum.docs_leading_comments
+      end
 
-  def values
-    @values ||= @enum.values.map { |v| EnumValuePresenter.new v }
+      def values
+        @values ||= @enum.values.map { |v| EnumValuePresenter.new v }
+      end
+    end
   end
 end