class Gapic::Presenters::CloudGemPresenter
A presenter subclass for cloud gems.
Public Instance Methods
cloud_env_prefix()
click to toggle source
# File lib/gapic/presenters/cloud_gem_presenter.rb, line 80 def cloud_env_prefix env_prefix || "GOOGLE_CLOUD" end
dependencies()
click to toggle source
Calls superclass method
# File lib/gapic/presenters/cloud_gem_presenter.rb, line 35 def dependencies deps = super deps["google-cloud-errors"] = "~> 1.0" deps end
description()
click to toggle source
Overrides the gemspec description including a note that users should consider installing the wrapper instead of this versioned gem.
Note: The method `readme_description` was aliased to the superclass method because the description without this note is used in the readme.
@return [String]
# File lib/gapic/presenters/cloud_gem_presenter.rb, line 70 def description desc = readme_description if has_wrapper? desc += " Note that #{name} is a version-specific client library." \ " For most uses, we recommend installing the main client library" \ " #{wrapper_name} instead. See the readme for more details." end desc end
Also aliased as: readme_description
extra_files()
click to toggle source
# File lib/gapic/presenters/cloud_gem_presenter.rb, line 30 def extra_files return ["README.md", "LICENSE.md", ".yardopts"] if generic_endpoint? ["README.md", "LICENSE.md", "AUTHENTICATION.md", ".yardopts"] end
generator_args_for_metadata()
click to toggle source
Returns a hash of extra generator arguments to be rendered into the repo-metadata.json file.
# File lib/gapic/presenters/cloud_gem_presenter.rb, line 88 def generator_args_for_metadata result = {} result["ruby-cloud-description"] = description result["ruby-cloud-env-prefix"] = env_prefix if env_prefix result["ruby-cloud-product-url"] = product_documentation_url if product_documentation_url path_overrides = @api.overrides_of(:file_path).map { |k, v| "#{k}=#{v}" }.join ";" result["ruby-cloud-path-override"] = path_overrides unless path_overrides.empty? namespace_overrides = @api.overrides_of(:namespace).map { |k, v| "#{k}=#{v}" }.join ";" result["ruby-cloud-namespace-override"] = namespace_overrides unless namespace_overrides.empty? service_overrides = @api.overrides_of(:service).map { |k, v| "#{k}=#{v}" }.join ";" result["ruby-cloud-service-override"] = service_overrides unless service_overrides.empty? result end
has_wrapper?()
click to toggle source
Whether this gem has a wrapper @return [Boolean]
# File lib/gapic/presenters/cloud_gem_presenter.rb, line 44 def has_wrapper? !wrapper_name.nil? end
license_name()
click to toggle source
# File lib/gapic/presenters/cloud_gem_presenter.rb, line 26 def license_name "Apache-2.0" end
wrapper_name()
click to toggle source
The name of the wrapper gem corresponding to this versioned gem @return [String, nil]
# File lib/gapic/presenters/cloud_gem_presenter.rb, line 52 def wrapper_name return @api.wrapper_gem_name_override if @api.wrapper_gem_name_override? minfo = /^(.+)-v\d\w*$/.match name minfo ? minfo[1] : nil end