gapic-generator 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd638c7b5855aa89dfd03c87f3f5d8d936d78005b51dd04a409ac7552e3eea05
-  data.tar.gz: 6372183134b8556a0a5ac7a4a6bf1250820c5b167b576454fae5f0228194078c
+  metadata.gz: 9d91e35272532a7605649615f5267d364c30a05a91f3e8f36414994260dc2d22
+  data.tar.gz: 18642517ba285a7aefd2620356e7d78d6a276ad987935d41358b80eb5de78858
 SHA512:
-  metadata.gz: 67b82518fe047ac185a3b596af6b3da223c774c96dbc6cb01761998920ca164e546bd72fc2222c6a945636c49e39a5b80ded892b821d493d79f40133fa973fa3
-  data.tar.gz: c316dd8c291a1204e73f18d7df06800734bf7e3690db5d5967e586cbaf0c215b02496a090a44eb5baee9b501fd418717312b8bb33d096fda5f5c6ef84e11d1fa
+  metadata.gz: 897662bfc6bae108225577e384cf043aa1ce2861597685a472d50b6fd034c960d7d535152d89a4f5d1d4bcedb01311bc427fc517cc702f8ea52d5ad7f61cf3df
+  data.tar.gz: 401ae995df47b01fd1ede289ed91a05dbac03ffaabc82996259c859b2996868ccd3058b35a7a6a88849de802d4047a25e034bec6b5609ed6f1c77d4264c6ad65

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release History for gapic-generator
 
+### 0.5.0 / 2020-05-19
+
+* Add quota_project to the generated configs.
+* Allow resource patterns with a star as a segment template.
+* Generate tests for resource path helpers.
+* Pin protobuf dependency for Ruby < 2.5.
+* Create a test helper in for generated tests.
+
 ### 0.4.2 / 2020-04-28
 
 * Prepend double-colon to absolute/global namespaces to prevent conflicts.

data/lib/gapic/generator/version.rb

@@ -16,6 +16,6 @@
 
 module Gapic
   module Generator
-    VERSION = "0.4.2"
+    VERSION = "0.5.0"
   end
 end

data/lib/gapic/generators/default_generator.rb

@@ -58,22 +58,24 @@ module Gapic
             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_paths.erb",      "test/#{service.test_paths_file_path}",             service: service) if service.paths?
             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)
-        files << g("gem/entrypoint.erb", "lib/#{gem.name}.rb",           gem: gem)
+        files << g("gem/gitignore.erb",   ".gitignore",                   gem: gem)
+        files << g("gem/version.erb",     "lib/#{gem.version_file_path}", gem: gem)
+        files << g("gem/test_helper.erb", "test/helper.rb",               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)
+        files << g("gem/entrypoint.erb",  "lib/#{gem.name}.rb",           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)

data/lib/gapic/path_template/segment.rb

@@ -56,6 +56,13 @@ module Gapic
         !@pattern.nil?
       end
 
+      # Determines if the segment has a nontrivial pattern (i.e. not `*` or `**`).
+      #
+      # @return [Boolean]
+      def nontrivial_pattern?
+        @pattern && @pattern != "*" && @pattern != "**"
+      end
+
       # @private
       def == other
         return false unless other.is_a? self.class

data/lib/gapic/presenters/resource_presenter.rb

@@ -15,7 +15,6 @@
 # limitations under the License.
 
 require "gapic/path_template"
-require "ostruct"
 require "active_support/inflector"
 
 module Gapic
@@ -28,20 +27,10 @@ module Gapic
       def initialize resource
         @resource = resource
 
-        @patterns = resource.pattern.map do |template|
-          segments = Gapic::PathTemplate.parse template
-          OpenStruct.new(
-            template:    template,
-            segments:    segments,
-            arguments:   arguments_for(segments),
-            path_string: path_string_for(segments)
-          )
-        end
+        @patterns = resource.pattern.map { |template| PatternPresenter.new template }
 
         # Keep only patterns that can be used to create path helpers
-        @patterns.reject! do |pattern|
-          named_arg_patterns?(pattern.segments) || positional_args?(pattern.segments)
-        end
+        @patterns.filter!(&:useful_for_helpers?)
       end
 
       def name
@@ -60,33 +49,64 @@ module Gapic
         "#{ActiveSupport::Inflector.underscore name}_path"
       end
 
-      private
+      ##
+      # A presenter for a particular pattern
+      #
+      class PatternPresenter
+        def initialize template
+          @template = template
+          @segments = Gapic::PathTemplate.parse template
+          @arguments = arg_segments.map(&:name)
+          @path_string = build_path_string
+        end
 
-      def arguments_for segments
-        arg_segments(segments).map(&:name)
-      end
+        attr_reader :template, :segments, :arguments, :path_string
 
-      def arg_segments segments
-        segments.select { |segment| segment.is_a? Gapic::PathTemplate::Segment }
-      end
+        def useful_for_helpers?
+          arg_segments.none?(&:nontrivial_pattern?) && arg_segments.none?(&:positional?)
+        end
 
-      def path_string_for segments
-        segments.map do |segment|
-          if segment.is_a? Gapic::PathTemplate::Segment
-            "\#{#{segment.name}}"
-          else
-            # Should be a String
-            segment
-          end
-        end.join
-      end
+        def formal_arguments
+          arguments.map { |arg| "#{arg}:" }.join ", "
+        end
 
-      def positional_args? segments
-        arg_segments(segments).any?(&:positional?)
-      end
+        def arguments_key
+          arguments.sort.join ":"
+        end
+
+        def arguments_with_dummy_values
+          arguments.each_with_index.map { |arg, index| "#{arg}: \"value#{index}\"" }.join ", "
+        end
+
+        def expected_path_for_dummy_values
+          index = -1
+          segments.map do |segment|
+            if segment.is_a? Gapic::PathTemplate::Segment
+              index += 1
+              "value#{index}"
+            else
+              # Should be a String
+              segment
+            end
+          end.join
+        end
 
-      def named_arg_patterns? segments
-        arg_segments(segments).any?(&:pattern)
+        private
+
+        def arg_segments
+          segments.select { |segment| segment.is_a? Gapic::PathTemplate::Segment }
+        end
+
+        def build_path_string
+          segments.map do |segment|
+            if segment.is_a? Gapic::PathTemplate::Segment
+              "\#{#{segment.name}}"
+            else
+              # Should be a String
+              segment
+            end
+          end.join
+        end
       end
     end
   end

data/lib/gapic/presenters/service_presenter.rb

@@ -272,6 +272,10 @@ module Gapic
         service_file_path.sub ".rb", "_test.rb"
       end
 
+      def test_paths_file_path
+        service_file_path.sub ".rb", "_paths_test.rb"
+      end
+
       def test_client_operations_file_path
         service_file_path.sub ".rb", "_operations_test.rb"
       end

data/templates/default/gem/gemfile.erb

@@ -2,3 +2,6 @@
 source "https://rubygems.org"
 
 gemspec
+
+# google-protobuf 3.12.0 requires Ruby 2.5 or later, so pin to 3.11 on older Rubies
+gem "google-protobuf", (RUBY_VERSION < "2.5" ? "~> 3.11.4" : "~> 3.12")

data/templates/default/gem/gemspec.erb

@@ -29,7 +29,9 @@ Gem::Specification.new do |gem|
   <%- end -%>
 
   gem.add_development_dependency "google-style", "~> 1.24.0"
-  gem.add_development_dependency "minitest", "~> 5.10"
+  gem.add_development_dependency "minitest", "~> 5.14"
+  gem.add_development_dependency "minitest-focus", "~> 1.1"
+  gem.add_development_dependency "minitest-rg", "~> 5.2"
   gem.add_development_dependency "rake", ">= 12.0"
   gem.add_development_dependency "redcarpet", "~> 3.0"
   gem.add_development_dependency "simplecov", "~> 0.18"

data/templates/default/gem/rakefile.erb

@@ -10,6 +10,7 @@ RuboCop::RakeTask.new
 require "rake/testtask"
 desc "Run tests."
 Rake::TestTask.new do |t|
+  t.libs << "test"
   t.test_files = FileList["test/**/*_test.rb"]
   t.warning = false
 end

data/templates/default/gem/test_helper.erb

@@ -0,0 +1,8 @@
+<%- assert_locals gem -%>
+<%= render partial: "shared/header" -%>
+
+require "simplecov"
+
+require "minitest/autorun"
+require "minitest/focus"
+require "minitest/rg"

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

@@ -100,7 +100,8 @@ class <%= service.client_name %>
     if credentials.is_a?(String) || credentials.is_a?(Hash)
       credentials = Credentials.new credentials, scope: @config.scope
     end
-    @quota_project_id = credentials.respond_to?(:quota_project_id) ? credentials.quota_project_id : nil
+    @quota_project_id = @config.quota_project
+    @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
 
     <%- if service.lro? -%>
     <%= service.lro_client_ivar %> = <%= service.operations_name %>.new do |config|

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

@@ -78,24 +78,28 @@
 #    *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
 #       trigger a retry.
 #   @return [::Hash]
+# @!attribute [rw] quota_project
+#   A separate project against which to charge quota.
+#   @return [::String]
 #
 class Configuration
   extend ::Gapic::Config
 
-  config_attr :endpoint,     <%= service.client_endpoint.inspect %>, String
-  config_attr :credentials,  nil do |value|
+  config_attr :endpoint,      <%= service.client_endpoint.inspect %>, ::String
+  config_attr :credentials,   nil do |value|
     allowed = [::String, ::Hash, ::Proc, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
     allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
     allowed.any? { |klass| klass === value }
   end
-  config_attr :scope,        nil, ::String, ::Array, nil
-  config_attr :lib_name,     nil, ::String, nil
-  config_attr :lib_version,  nil, ::String, nil
-  config_attr(:channel_args, <%= service.config_channel_args.inspect %>, ::Hash, nil)
-  config_attr :interceptors, nil, ::Array, nil
-  config_attr :timeout,      nil, ::Numeric, nil
-  config_attr :metadata,     nil, ::Hash, nil
-  config_attr :retry_policy, nil, ::Hash, Proc, nil
+  config_attr :scope,         nil, ::String, ::Array, nil
+  config_attr :lib_name,      nil, ::String, nil
+  config_attr :lib_version,   nil, ::String, nil
+  config_attr(:channel_args,  <%= service.config_channel_args.inspect %>, ::Hash, nil)
+  config_attr :interceptors,  nil, ::Array, nil
+  config_attr :timeout,       nil, ::Numeric, nil
+  config_attr :metadata,      nil, ::Hash, nil
+  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
+  config_attr :quota_project, nil, ::String, nil
 
   # @private
   def initialize parent_config = nil

data/templates/default/service/client/resource/_multi.erb

@@ -3,8 +3,7 @@
 # Create a fully-qualified <%= resource.name %> resource string.
 #
 <%- resource.patterns.each do |pattern| -%>
-<%- args_doc_sig = pattern.arguments.map { |arg| "#{arg}:" }.join ", " -%>
-# @overload <%= resource.path_helper %>(<%= args_doc_sig %>)
+# @overload <%= resource.path_helper %>(<%= pattern.formal_arguments %>)
 <%= indent render(partial: "service/client/resource/doc", locals: { pattern: pattern }), "#   " %>
 #
 <%- end -%>
@@ -14,9 +13,7 @@ def <%= resource.path_helper %> **args
 <%- last_pattern_index = resource.patterns.count - 1 -%>
 <%- resource.patterns.each_with_index do |pattern, index| -%>
 <%- comma = last_pattern_index == index ? "" : "," -%>
-<%- args_key = pattern.arguments.sort.join(":").inspect -%>
-<%- args_sig = pattern.arguments.map { |arg| "#{arg}:" }.join ", " -%>
-    <%= args_key %> => (proc do |<%= args_sig %>|
+    <%= pattern.arguments_key.inspect %> => (proc do |<%= pattern.formal_arguments %>|
 <%= indent render(partial: "service/client/resource/def", locals: { pattern: pattern }), 6 %>
     end)<%= comma %>
 <%- end -%>

data/templates/default/service/client/resource/_single.erb

@@ -5,7 +5,6 @@
 <%= indent render(partial: "service/client/resource/doc", locals: { pattern: resource.patterns.first }), "# " %>
 #
 # @return [::String]
-<%- args = resource.patterns.first.arguments.map { |arg| "#{arg}:" }.join ", " -%>
-def <%= resource.path_helper %> <%= args %>
+def <%= resource.path_helper %> <%= resource.patterns.first.formal_arguments %>
 <%= indent render(partial: "service/client/resource/def", locals: { pattern: resource.patterns.first }), 2 %>
 end

data/templates/default/service/test/_resource.erb

@@ -0,0 +1,16 @@
+<%- assert_locals resource -%>
+<%- assert_locals service -%>
+<%- full_client_name = defined?(client_name_full) ? client_name_full : service.client_name_full -%>
+def test_<%= resource.path_helper%>
+  grpc_channel = ::GRPC::Core::Channel.new "localhost:8888", nil, :this_channel_is_insecure
+  ::Gapic::ServiceStub.stub :new, nil do
+    client = <%= full_client_name %>.new do |config|
+      config.credentials = grpc_channel
+    end
+<%- resource.patterns.each do |pattern| -%>
+
+    path = client.<%= resource.path_helper%> <%= pattern.arguments_with_dummy_values %>
+    assert_equal <%= pattern.expected_path_for_dummy_values.inspect %>, path
+<%- end -%>
+  end
+end

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

@@ -2,8 +2,7 @@
 # frozen_string_literal: true
 
 <%= render partial: "shared/license" %>
-require "simplecov"
-require "minitest/autorun"
+require "helper"
 
 require "gapic/grpc/service_stub"
 

data/templates/default/service/test/client_operations.erb

@@ -2,8 +2,7 @@
 # frozen_string_literal: true
 
 <%= render partial: "shared/license" %>
-require "simplecov"
-require "minitest/autorun"
+require "helper"
 
 require "gapic/grpc/service_stub"
 

data/templates/default/service/test/client_paths.erb

@@ -0,0 +1,17 @@
+<%- assert_locals service -%>
+# frozen_string_literal: true
+
+<%= render partial: "shared/license" %>
+require "helper"
+
+require "gapic/grpc/service_stub"
+
+require "<%= service.service_require %>"
+
+class <%= service.client_name_full %>PathsTest < Minitest::Test
+<%- service.references.each do |resource| -%>
+<%= indent render(partial: "service/test/resource",
+                  locals: { resource: resource, service: service }), 2 %>
+
+<%- end %>
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gapic-generator
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Ernest Landrito
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-29 00:00:00.000000000 Z
+date: 2020-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -260,6 +260,7 @@ files:
 - templates/default/gem/rakefile.erb
 - templates/default/gem/readme.erb
 - templates/default/gem/rubocop.erb
+- templates/default/gem/test_helper.erb
 - templates/default/gem/version.erb
 - templates/default/gem/yardopts.erb
 - templates/default/helpers/default_helper.rb
@@ -319,8 +320,10 @@ files:
 - templates/default/service/credentials.erb
 - templates/default/service/operations.erb
 - templates/default/service/paths.erb
+- templates/default/service/test/_resource.erb
 - templates/default/service/test/client.erb
 - templates/default/service/test/client_operations.erb
+- templates/default/service/test/client_paths.erb
 - templates/default/service/test/method/_assert_response.erb
 - templates/default/service/test/method/_bidi.erb
 - templates/default/service/test/method/_client.erb