tree: a2adecaaa49af3642e2bf29307f154cab70156b3

ruby/README.md

`ruby`

Rule	Description
ruby_proto_compile	Generates *.ruby protobuf artifacts
ruby_grpc_compile	Generates *.ruby protobuf+gRPC artifacts
ruby_proto_aspect_compile	Generates *.ruby protobuf artifacts using aspect based compilation
ruby_grpc_aspect_compile	Generates *.ruby protobuf+gRPC artifacts using aspect based compilation
ruby_proto_library	Generates *.rb protobuf library
ruby_grpc_library	Generates *.rb protobuf+gRPC library

`ruby_proto_compile`

Generates *.ruby protobuf artifacts

`WORKSPACE`

load("@build_stack_rules_proto//ruby:deps.bzl", "ruby_proto_compile")

ruby_proto_compile()

`BUILD.bazel`

load("@build_stack_rules_proto//ruby:ruby_proto_compile.bzl", "ruby_proto_compile")

ruby_proto_compile(
    name = "person_ruby_proto",
    deps = ["@build_stack_rules_proto//example/proto:person_proto"],
)

Mandatory Attributes

Name	Type	Default	Description
deps	`list<ProtoInfo>`	`[]`	List of labels that provide a `ProtoInfo` (such as `native.proto_library`)

Optional Attributes

Name	Type	Default	Description
plugins	`list<ProtoPluginInfo>`	`[]`	List of labels that provide a `ProtoPluginInfo`
plugin_options	`list<string>`	`[]`	List of additional ‘global’ plugin options (applies to all plugins). To apply plugin specific options, use the `options` attribute on `proto_plugin`
outputs	`list<generated file>`	`[]`	List of additional expected generated file outputs
verbose	`int`	`0`	The verbosity level. Supported values and results are 1: show command, 2: show command and sandbox after running protoc, 3: show command and sandbox before and after running protoc, 4. show env, command, expected outputs and sandbox before and after running protoc
include_imports	`bool`	`True`	Pass the --include_imports argument to the protoc_plugin
include_source_info	`bool`	`True`	Pass the --include_source_info argument to the protoc_plugin
transitive	`bool`	`True`	Generate outputs for both *.proto directly named in `deps` AND all their transitive proto_library dependencies
transitivity	`string_dict`	`{}`	Transitive filters to apply when the ‘transitive’ property is enabled. This string_dict can be used to exclude or explicitly include protos from the compilation list by using `exclude` or `include` respectively as the dict value

`ruby_grpc_compile`

Generates *.ruby protobuf+gRPC artifacts

`WORKSPACE`

load("@build_stack_rules_proto//ruby:deps.bzl", "ruby_grpc_compile")

ruby_grpc_compile()

load("@com_github_grpc_grpc//bazel:grpc_deps.bzl", "grpc_deps")

grpc_deps()

`BUILD.bazel`

load("@build_stack_rules_proto//ruby:ruby_grpc_compile.bzl", "ruby_grpc_compile")

ruby_grpc_compile(
    name = "greeter_ruby_grpc",
    deps = ["@build_stack_rules_proto//example/proto:greeter_grpc"],
)

Mandatory Attributes

Name	Type	Default	Description
deps	`list<ProtoInfo>`	`[]`	List of labels that provide a `ProtoInfo` (such as `native.proto_library`)

Optional Attributes

Name	Type	Default	Description
plugins	`list<ProtoPluginInfo>`	`[]`	List of labels that provide a `ProtoPluginInfo`
plugin_options	`list<string>`	`[]`	List of additional ‘global’ plugin options (applies to all plugins). To apply plugin specific options, use the `options` attribute on `proto_plugin`
outputs	`list<generated file>`	`[]`	List of additional expected generated file outputs
verbose	`int`	`0`	The verbosity level. Supported values and results are 1: show command, 2: show command and sandbox after running protoc, 3: show command and sandbox before and after running protoc, 4. show env, command, expected outputs and sandbox before and after running protoc
include_imports	`bool`	`True`	Pass the --include_imports argument to the protoc_plugin
include_source_info	`bool`	`True`	Pass the --include_source_info argument to the protoc_plugin
transitive	`bool`	`True`	Generate outputs for both *.proto directly named in `deps` AND all their transitive proto_library dependencies
transitivity	`string_dict`	`{}`	Transitive filters to apply when the ‘transitive’ property is enabled. This string_dict can be used to exclude or explicitly include protos from the compilation list by using `exclude` or `include` respectively as the dict value

`ruby_proto_aspect_compile`

NOTE: this rule is EXPERIMENTAL. It may not work correctly or even compile!

Generates *.ruby protobuf artifacts using aspect based compilation

`WORKSPACE`

load("@build_stack_rules_proto//ruby:deps.bzl", "ruby_proto_aspect_compile")

ruby_proto_aspect_compile()

`BUILD.bazel`

load("@build_stack_rules_proto//ruby:ruby_proto_aspect_compile.bzl", "ruby_proto_aspect_compile")

ruby_proto_aspect_compile(
    name = "person_ruby_proto",
    deps = ["@build_stack_rules_proto//example/proto:person_proto"],
)

Mandatory Attributes

Name	Type	Default	Description
deps	`list<ProtoInfo>`	`[]`	List of labels that provide a `ProtoInfo` (such as `native.proto_library`)

Optional Attributes

Name	Type	Default	Description
plugins	`list<ProtoPluginInfo>`	`[]`	List of labels that provide a `ProtoPluginInfo`
plugin_options	`list<string>`	`[]`	List of additional ‘global’ plugin options (applies to all plugins). To apply plugin specific options, use the `options` attribute on `proto_plugin`
outputs	`list<generated file>`	`[]`	List of additional expected generated file outputs
verbose	`int`	`0`	The verbosity level. Supported values and results are 1: show command, 2: show command and sandbox after running protoc, 3: show command and sandbox before and after running protoc, 4. show env, command, expected outputs and sandbox before and after running protoc
include_imports	`bool`	`True`	Pass the --include_imports argument to the protoc_plugin
include_source_info	`bool`	`True`	Pass the --include_source_info argument to the protoc_plugin
transitive	`bool`	`True`	Generate outputs for both *.proto directly named in `deps` AND all their transitive proto_library dependencies
transitivity	`string_dict`	`{}`	Transitive filters to apply when the ‘transitive’ property is enabled. This string_dict can be used to exclude or explicitly include protos from the compilation list by using `exclude` or `include` respectively as the dict value

`ruby_grpc_aspect_compile`

NOTE: this rule is EXPERIMENTAL. It may not work correctly or even compile!

Generates *.ruby protobuf+gRPC artifacts using aspect based compilation

`WORKSPACE`

load("@build_stack_rules_proto//ruby:deps.bzl", "ruby_grpc_aspect_compile")

ruby_grpc_aspect_compile()

load("@com_github_grpc_grpc//bazel:grpc_deps.bzl", "grpc_deps")

grpc_deps()

`BUILD.bazel`

load("@build_stack_rules_proto//ruby:ruby_grpc_aspect_compile.bzl", "ruby_grpc_aspect_compile")

ruby_grpc_aspect_compile(
    name = "greeter_ruby_grpc",
    deps = ["@build_stack_rules_proto//example/proto:greeter_grpc"],
)

Mandatory Attributes

Name	Type	Default	Description
deps	`list<ProtoInfo>`	`[]`	List of labels that provide a `ProtoInfo` (such as `native.proto_library`)

Optional Attributes

Name	Type	Default	Description
plugins	`list<ProtoPluginInfo>`	`[]`	List of labels that provide a `ProtoPluginInfo`
plugin_options	`list<string>`	`[]`	List of additional ‘global’ plugin options (applies to all plugins). To apply plugin specific options, use the `options` attribute on `proto_plugin`
outputs	`list<generated file>`	`[]`	List of additional expected generated file outputs
verbose	`int`	`0`	The verbosity level. Supported values and results are 1: show command, 2: show command and sandbox after running protoc, 3: show command and sandbox before and after running protoc, 4. show env, command, expected outputs and sandbox before and after running protoc
include_imports	`bool`	`True`	Pass the --include_imports argument to the protoc_plugin
include_source_info	`bool`	`True`	Pass the --include_source_info argument to the protoc_plugin
transitive	`bool`	`True`	Generate outputs for both *.proto directly named in `deps` AND all their transitive proto_library dependencies
transitivity	`string_dict`	`{}`	Transitive filters to apply when the ‘transitive’ property is enabled. This string_dict can be used to exclude or explicitly include protos from the compilation list by using `exclude` or `include` respectively as the dict value

`ruby_proto_library`

Generates *.rb protobuf library

`WORKSPACE`

load("@build_stack_rules_proto//ruby:deps.bzl", "ruby_proto_library")

ruby_proto_library()

load("@com_github_yugui_rules_ruby//ruby:def.bzl", "ruby_register_toolchains")

ruby_register_toolchains()

load("@com_github_yugui_rules_ruby//ruby/private:bundle.bzl", "bundle_install")

bundle_install(
    name = "routeguide_gems_bundle",
    gemfile = "//ruby:Gemfile",
    gemfile_lock = "//ruby:Gemfile.lock",
)

`BUILD.bazel`

load("@build_stack_rules_proto//ruby:ruby_proto_library.bzl", "ruby_proto_library")

ruby_proto_library(
    name = "person_ruby_library",
    deps = ["@build_stack_rules_proto//example/proto:person_proto"],
)

Mandatory Attributes

Name	Type	Default	Description
deps	`list<ProtoInfo>`	`[]`	List of labels that provide a `ProtoInfo` (such as `native.proto_library`)

Optional Attributes

Name	Type	Default	Description
plugins	`list<ProtoPluginInfo>`	`[]`	List of labels that provide a `ProtoPluginInfo`
plugin_options	`list<string>`	`[]`	List of additional ‘global’ plugin options (applies to all plugins). To apply plugin specific options, use the `options` attribute on `proto_plugin`
outputs	`list<generated file>`	`[]`	List of additional expected generated file outputs
verbose	`int`	`0`	The verbosity level. Supported values and results are 1: show command, 2: show command and sandbox after running protoc, 3: show command and sandbox before and after running protoc, 4. show env, command, expected outputs and sandbox before and after running protoc
include_imports	`bool`	`True`	Pass the --include_imports argument to the protoc_plugin
include_source_info	`bool`	`True`	Pass the --include_source_info argument to the protoc_plugin
transitive	`bool`	`True`	Generate outputs for both *.proto directly named in `deps` AND all their transitive proto_library dependencies
transitivity	`string_dict`	`{}`	Transitive filters to apply when the ‘transitive’ property is enabled. This string_dict can be used to exclude or explicitly include protos from the compilation list by using `exclude` or `include` respectively as the dict value

`ruby_grpc_library`

Generates *.rb protobuf+gRPC library

`WORKSPACE`

load("@build_stack_rules_proto//ruby:deps.bzl", "ruby_grpc_library")

ruby_grpc_library()

load("@com_github_yugui_rules_ruby//ruby:def.bzl", "ruby_register_toolchains")

ruby_register_toolchains()

load("@com_github_grpc_grpc//bazel:grpc_deps.bzl", "grpc_deps")

grpc_deps()

load("@com_github_yugui_rules_ruby//ruby/private:bundle.bzl", "bundle_install")

bundle_install(
    name = "routeguide_gems_bundle",
    gemfile = "//ruby:Gemfile",
    gemfile_lock = "//ruby:Gemfile.lock",
)

`BUILD.bazel`

load("@build_stack_rules_proto//ruby:ruby_grpc_library.bzl", "ruby_grpc_library")

ruby_grpc_library(
    name = "greeter_ruby_library",
    deps = ["@build_stack_rules_proto//example/proto:greeter_grpc"],
)

Mandatory Attributes

Name	Type	Default	Description
deps	`list<ProtoInfo>`	`[]`	List of labels that provide a `ProtoInfo` (such as `native.proto_library`)

Optional Attributes

Name	Type	Default	Description
plugins	`list<ProtoPluginInfo>`	`[]`	List of labels that provide a `ProtoPluginInfo`
plugin_options	`list<string>`	`[]`	List of additional ‘global’ plugin options (applies to all plugins). To apply plugin specific options, use the `options` attribute on `proto_plugin`
outputs	`list<generated file>`	`[]`	List of additional expected generated file outputs
verbose	`int`	`0`	The verbosity level. Supported values and results are 1: show command, 2: show command and sandbox after running protoc, 3: show command and sandbox before and after running protoc, 4. show env, command, expected outputs and sandbox before and after running protoc
include_imports	`bool`	`True`	Pass the --include_imports argument to the protoc_plugin
include_source_info	`bool`	`True`	Pass the --include_source_info argument to the protoc_plugin
transitive	`bool`	`True`	Generate outputs for both *.proto directly named in `deps` AND all their transitive proto_library dependencies
transitivity	`string_dict`	`{}`	Transitive filters to apply when the ‘transitive’ property is enabled. This string_dict can be used to exclude or explicitly include protos from the compilation list by using `exclude` or `include` respectively as the dict value