gapic-generator 0.1.5 → 0.3.0

data/lib/gapic/presenters/field_presenter.rb

@@ -0,0 +1,154 @@
+# 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 "gapic/helpers/namespace_helper"
+
+module Gapic
+  module Presenters
+    ##
+    # A presenter for proto fields.
+    #
+    class FieldPresenter
+      include Gapic::Helpers::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
+  end
+end

data/lib/gapic/presenters/file_presenter.rb

@@ -0,0 +1,59 @@
+# 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 "gapic/helpers/namespace_helper"
+
+module Gapic
+  module Presenters
+    ##
+    # A presenter for proto files.
+    #
+    class FilePresenter
+      include Gapic::Helpers::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
+  end
+end

data/lib/gapic/presenters/gem_presenter.rb

@@ -0,0 +1,176 @@
+# 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 "gapic/helpers/filepath_helper"
+require "gapic/helpers/namespace_helper"
+
+module Gapic
+  module Presenters
+    ##
+    # A presenter for gems.
+    #
+    class GemPresenter
+      include Gapic::Helpers::FilepathHelper
+      include Gapic::Helpers::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 packages?
+        !packages.empty?
+      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 client library for the #{title} API."
+      end
+
+      def summary
+        gem_config(:summary) ||
+          "API Client library for the #{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).any? { |f| f.start_with? "google/iam/v1/" }
+      end
+
+      def library_documentation_url
+        gem_config(:library_documentation_url) || "https://googleapis.dev/ruby/#{name}/latest"
+      end
+
+      def product_documentation_url
+        gem_config :product_documentation_url
+      end
+
+      def api_id
+        gem_config :api_id
+      end
+
+      def free_tier?
+        # Default to false unless the config is explicitly set to "true"
+        gem_config(:free_tier) == "true"
+      end
+
+      def yard_strict?
+        # Default to true unless the config is explicitly set to "false"
+        gem_config(:yard_strict) != "false"
+      end
+
+      def entrypoint_require
+        packages.first.package_require
+      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
+  end
+end

data/lib/gapic/presenters/message_presenter.rb

@@ -0,0 +1,73 @@
+# 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 "gapic/helpers/namespace_helper"
+
+module Gapic
+  module Presenters
+    ##
+    # A presenter for proto messages.
+    #
+    class MessagePresenter
+      include Gapic::Helpers::NamespaceHelper
+
+      def initialize api, message
+        @api = api
+        @message = message
+      end
+
+      def name
+        @message.name
+      end
+
+      def doc_types
+        type_name_full
+      end
+
+      def doc_description
+        @message.docs_leading_comments
+      end
+
+      def default_value
+        "{}"
+      end
+
+      def type_name_full
+        message_ruby_type @message
+      end
+
+      def fields
+        @fields = @message.fields.map { |f| FieldPresenter.new @api, @message, f }
+      end
+
+      def nested_enums
+        @nested_enums ||= @message.nested_enums.map { |e| EnumPresenter.new e }
+      end
+
+      def nested_messages
+        @nested_messages ||= @message.nested_messages.map { |m| MessagePresenter.new @api, m }
+      end
+
+      protected
+
+      def message_ruby_type message
+        ruby_namespace @api, message.address.join(".")
+      end
+    end
+  end
+end