gapic-generator 0.1.0

data/gem_templates/shared/_header.erb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+<%= render partial: "shared/license" %>
+<%= render partial: "shared/warning" -%>

data/gem_templates/shared/_license.erb

@@ -0,0 +1,13 @@
+# Copyright [yyyy] [name of copyright owner]
+# 
+# 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
+# 
+#     http://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.

data/gem_templates/shared/_warning.erb

@@ -0,0 +1 @@
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!

data/gem_templates/test_generator.erb

@@ -0,0 +1,13 @@
+<%= render partial: "shared/header" -%>
+
+require "test_helper"
+require "gapic/generators/<%= gem_name %>_generator"
+
+class <%= gem_class_prefix %>GeneratorTest < GeneratorTest
+  def test_speech_generate
+    generator = Gapic::Generators::<%= gem_class_prefix %>Generator.new api(:speech)
+    generator.generate.each do |file|
+      assert_equal expected_content("<%= gem_name %>/#{file.name}"), file.content
+    end
+  end
+end

data/gem_templates/test_helper.erb

@@ -0,0 +1,25 @@
+<%= render partial: "shared/header" -%>
+
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+require "gapic/generators/<%= gem_name %>_generator"
+
+require "minitest/autorun"
+require "minitest/focus"
+
+class GeneratorTest < Minitest::Test
+  def proto_input service
+    File.binread "proto_input/#{service}_desc.bin"
+  end
+
+  def request service
+    Google::Protobuf::Compiler::CodeGeneratorRequest.decode proto_input(service)
+  end
+
+  def api service
+    Gapic::Schema::Api.new request(service)
+  end
+
+  def expected_content filename
+    File.read "expected_output/#{filename}"
+  end
+end

data/gem_templates/version.erb

@@ -0,0 +1,10 @@
+<%= render partial: "shared/header" -%>
+
+
+module Gapic
+  module Generator
+    module <%= gem_class_prefix %>
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/gapic/file_formatter.rb

@@ -0,0 +1,62 @@
+# 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 "tmpdir"
+require "fileutils"
+
+module Gapic
+  ##
+  # File Formatter
+  class FileFormatter
+    attr_reader :configuration, :files
+
+    ##
+    # Create a new file formatter object
+    #
+    # @param path_template [String] The URI path template to be parsed.
+    def initialize configuration, files
+      @configuration = configuration
+      @files = format! configuration, files
+    end
+
+    protected
+
+    def format! configuration, files
+      Dir.mktmpdir do |dir|
+        files.each do |file|
+          write_file dir, file
+        end
+
+        system "rubocop -x #{dir} -o #{dir}/rubocop.out -c #{configuration}"
+
+        files.each do |file|
+          read_file dir, file
+        end
+      end
+    end
+
+    def write_file dir, file
+      tmp_file = File.join dir, file.name
+      FileUtils.mkdir_p File.dirname tmp_file
+      File.write tmp_file, file.content
+    end
+
+    def read_file dir, file
+      tmp_file = File.join dir, file.name
+      file.content = File.read tmp_file
+    end
+  end
+end

data/lib/gapic/gem_builder.rb

@@ -0,0 +1,98 @@
+# 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 "fileutils"
+require "action_controller"
+require "active_support/inflector"
+
+module Gapic
+  ##
+  # The builder created files for new extension gems.
+  class GemBuilder
+    ##
+    # Initializes the builder.
+    #
+    # @param name [String] The name of the new extension gem.
+    # @param path [String] The directory to write the gem files.
+    #
+    def initialize name, path
+      @name = name
+      @path = path
+    end
+
+    ##
+    # Writes all the files for the gem.
+    #
+    def bootstrap
+      gen "readme.erb",     "README.md"
+      gen "gemspec.erb",    "gapic-generator-#{gem_name}.gemspec"
+      gen "rakefile.erb",   "Rakefile"
+      gen "gemfile.erb",    "Gemfile"
+      gen "gitignore.erb",  ".gitignore"
+      gen "rubocop.erb",    ".rubocop.yml"
+      gen "dockerfile.erb", "Dockerfile"
+      gen "entrypoint.erb", "docker-entrypoint.sh"
+      gen "gapic_sh.erb",   "gapic.sh"
+      gen "binary.erb",     "bin/protoc-gen-ruby_#{gem_name}"
+      gen "generator.erb",
+          "lib/gapic/generators/#{gem_name}_generator.rb"
+      gen "version.erb",
+          "lib/gapic/generator/#{gem_name}/version.rb"
+      gen "test_helper.erb",    "test/test_helper.rb"
+      gen "test_generator.erb", "test/generators/#{gem_name}_test.rb"
+      cp  "speech_desc.bin",    "proto_input/speech_desc.bin"
+    end
+
+    private
+
+    def template_path
+      File.join __dir__, "../../gem_templates"
+    end
+
+    def gem_name
+      ActiveSupport::Inflector.underscore @name
+    end
+
+    def gem_class_prefix
+      ActiveSupport::Inflector.camelize @name
+    end
+
+    def controller
+      @controller ||= Class.new(ActionController::Base).new.tap do |c|
+        # Configure the controller to know about the templates
+        c.prepend_view_path template_path
+      end
+    end
+
+    def cp from, to
+      input_path = File.join template_path, from
+      target_path = File.join @path, to
+      FileUtils.mkdir_p File.dirname(target_path)
+      FileUtils.cp input_path, target_path
+    end
+
+    def gen template, filename
+      content = controller.render_to_string(
+        template: template,
+        formats:  :text,
+        locals:   { gem_name: gem_name, gem_class_prefix: gem_class_prefix }
+      )
+      target_path = File.join @path, filename
+      FileUtils.mkdir_p File.dirname(target_path)
+      File.write target_path, content
+    end
+  end
+end

data/lib/gapic/generator.rb

@@ -0,0 +1,30 @@
+# 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
+  # TODO: Enter docs
+  # Dooooooooocs!!!
+  module Generator
+    def self.find type = nil
+      type ||= "default"
+      type_const = ActiveSupport::Inflector.camelize type
+      require "gapic/generators/#{type}_generator"
+      Kernel.const_get "Gapic::Generators::#{type_const}Generator"
+    end
+  end
+end

data/lib/gapic/generator/version.rb

@@ -0,0 +1,21 @@
+# 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.
+
+module Gapic
+  module Generator
+    VERSION = "0.1.0"
+  end
+end

data/lib/gapic/generators/base_generator.rb

@@ -0,0 +1,91 @@
+# 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/file_formatter"
+require "action_controller"
+require "google/protobuf/compiler/plugin.pb"
+require "tempfile"
+
+module Gapic
+  module Generators
+    # The generator orchestrates the rendering of templates.
+    class BaseGenerator
+      # Initializes the generator.
+      #
+      # @param api [Gapic::Schema::Api] The API model/context to
+      #   generate.
+      def initialize api
+        @api = api
+      end
+
+      # Generates all the files for the API.
+      #
+      # @return [Array<
+      #   Google::Protobuf::Compiler::CodeGeneratorResponse::File>]
+      #   The files that were generated for the API.
+      def generate
+        raise "must implement"
+      end
+
+      private
+
+      def use_templates! template_path
+        template_path = File.expand_path template_path
+        helpers_path = File.join template_path, "helpers"
+
+        # Configure Dependencies to know how to load helpers
+        ActiveSupport::Dependencies.autoload_paths.prepend helpers_path
+
+        # Configure the controller to know about the templates and helpers
+        controller.prepend_view_path template_path
+        controller.class.helper \
+          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.
+        @controller ||= Class.new(ActionController::Base).new
+      end
+
+      def generate_file template, filename, **args
+        content = controller.render_to_string(
+          template: template, formats: :text, locals: args
+        )
+        Google::Protobuf::Compiler::CodeGeneratorResponse::File.new(
+          name: filename, content: content
+        )
+      end
+      alias_method :g, :generate_file
+
+      def format_files files
+        FileFormatter.new(format_config, files).files
+      end
+
+      def format_config
+        File.expand_path File.join __dir__, "../../../default-rubocop.yml"
+      end
+    end
+  end
+end

data/lib/gapic/generators/default_generator.rb

@@ -0,0 +1,101 @@
+# 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/generators/base_generator"
+
+module Gapic
+  module Generators
+    # The generator orchestrates the rendering of templates.
+    class DefaultGenerator < BaseGenerator
+      # Initializes the generator.
+      #
+      # @param api [Gapic::Schema::Api] The API model/context to
+      #   generate.
+      def initialize api
+        super
+
+        # 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
+      # and more style rules.
+      # rubocop:disable all
+
+      # Generates all the files for the API.
+      #
+      # @return [Array<
+      #   Google::Protobuf::Compiler::CodeGeneratorResponse::File>]
+      #   The files that were generated for the API.
+      def generate
+        files = []
+
+        gem = gem_presenter @api
+
+        gem.packages.each do |package|
+          # Package level files
+          files << g("package.erb", "lib/#{package.package_file_path}", package: package)
+
+          package.services.each do |service|
+            # Service level files
+            files << g("service.erb",                        "lib/#{service.service_file_path}",                 service: service)
+            files << g("service/client.erb",                 "lib/#{service.client_file_path}",                  service: service)
+            files << g("service/credentials.erb",            "lib/#{service.credentials_file_path}",             service: service)
+            files << g("service/paths.erb",                  "lib/#{service.paths_file_path}",                   service: service) if service.paths?
+            files << g("service/operations.erb",             "lib/#{service.operations_file_path}",              service: service) if service.lro?
+            files << g("service/test/client.erb",            "test/#{service.test_client_file_path}",            service: service)
+            files << g("service/test/client_operations.erb", "test/#{service.test_client_operations_file_path}", service: service) if service.lro?
+          end
+        end
+
+        # Gem level files
+        files << g("gem/gitignore.erb", ".gitignore",                   gem: gem)
+        files << g("gem/version.erb",   "lib/#{gem.version_file_path}", gem: gem)
+        files << g("gem/gemspec.erb",   "#{gem.name}.gemspec",          gem: gem)
+        files << g("gem/gemfile.erb",   "Gemfile",                      gem: gem)
+        files << g("gem/rakefile.erb",  "Rakefile",                     gem: gem)
+        files << g("gem/readme.erb",    "README.md",                    gem: gem)
+        files << g("gem/changelog.erb", "CHANGELOG.md",                 gem: gem)
+        files << g("gem/rubocop.erb",   ".rubocop.yml",                 gem: gem)
+        files << g("gem/yardopts.erb",  ".yardopts",                    gem: gem)
+        files << g("gem/license.erb",   "LICENSE.md",                   gem: gem)
+
+        gem.proto_files.each do |proto_file|
+          files << g("proto_docs/proto_file.erb", "proto_docs/#{proto_file.docs_file_path}", file: proto_file)
+        end
+        files << g("proto_docs/readme.erb", "proto_docs/README.md", gem: gem)
+
+        format_files files
+
+        files
+      end
+
+      # rubocop:enable all
+
+      private
+
+      ##
+      # Override the default rubocop config file to be used.
+      def format_config
+        @api.configuration[:format_config] ||
+          super
+      end
+    end
+  end
+end