Handle missing ruby runtime (#10)

* Warn but allow systems with no ruby installation

* Fix generated registration function

* Run setup as root

* Fixed typo in no implementation forwarding

* Use a mock/incompatible toolchain to always register system ruby

* Remove comment

* Make ruby_bundle a generated repository rule for each version.  This removes the need to ever use the system ruby

* Auto detect toolchain by default

* Add placeholder for when the system ruby isn't requested

* Fix typo for system label

* Run tests as root

* Don't run workflow as sudo

* Always run rbenv in workflow

* Buildifier

* Refactor toolchain registration to explicitly specify repo name

* Move toolchain registration out of runtime macro

* Adding comments to workspace file

Author: mkruskal-google

README.adoc

@@ -108,17 +108,14 @@ rules_ruby_dependencies()
 load("@bazel_skylib//:workspace.bzl", "bazel_skylib_workspace")
 bazel_skylib_workspace()
 
-load("@rules_ruby//ruby:deps.bzl", "rules_ruby_register_toolchains")
-rules_ruby_register_toolchains(["ruby-3.0"])
+load("@rules_ruby//ruby:deps.bzl", "register_toolchain")
+register_toolchains("ruby-3.0")
 
 #———————————————————————————————————————————————————————————————————————
 # Now, load the ruby_bundle rule & install gems specified in the Gemfile
 #———————————————————————————————————————————————————————————————————————
 
-load(
-    "@rules_ruby//ruby:defs.bzl",
-    "ruby_bundle",
-)
+load("@ruby-3.0//:bundle.bzl", "ruby_bundle")
 
 ruby_bundle(
     name = "bundle",
@@ -550,7 +547,7 @@ List of glob patterns per gem to be excluded from the library. Keys are the name
 
 [source,python]
 ----
-load("@rules_ruby//ruby:defs.bzl", "ruby_bundle")
+load("@ruby-3.0//:bundle.bzl", "ruby_bundle")
 
 ruby_bundle(
     name = "gems",
@@ -567,7 +564,7 @@ your workspace. The name should match the name of the bundle.
 
 [source,python]
 ----
-load("@rules_ruby//ruby:defs.bzl", "ruby_bundle")
+load("@ruby-3.0//:bundle.bzl", "ruby_bundle")
 
 workspace(
     name = "my_wksp",

WORKSPACE

@@ -12,12 +12,28 @@ load("@bazel_skylib//lib:versions.bzl", "versions")
 
 versions.check("3.4.1")
 
-load("@rules_ruby//ruby:deps.bzl", "rules_ruby_register_toolchains")
+load("@rules_ruby//ruby:defs.bzl", "ruby_runtime")
 
-rules_ruby_register_toolchains([
-    "ruby-3.0",
-    "jruby-9.2",
-])
+# Register the system ruby version with a custom name.
+ruby_runtime(
+    name = "system_ruby_custom",
+    version = "system",
+)
+
+register_toolchains("@system_ruby_custom//:toolchain")
+
+# Register a versioned ruby with a custom name.
+ruby_runtime(
+    name = "ruby3",
+    version = "ruby-3.0",
+)
+
+register_toolchains("@ruby3//:toolchain")
+
+# Register a versioned ruby with its default name.
+ruby_runtime("jruby-9.2")
+
+register_toolchains("@jruby-9.2//:toolchain")
 
 local_repository(
     name = "rules_ruby_ruby_tests_testdata_another_workspace",
@@ -100,7 +116,7 @@ container_pull(
     repository = "library/ruby",
 )
 
-load("@rules_ruby//ruby:defs.bzl", "ruby_bundle")
+load("@system_ruby_custom//:bundle.bzl", "ruby_bundle")
 
 ruby_bundle(
     name = "bundle",

bin/setup

@@ -37,7 +37,7 @@ setup.rbenv() {
     local installed_version="$(ruby -e 'puts RUBY_VERSION' | tr -d '\n')"
     if [[ ${installed_version} == ${ruby_version} ]]; then
       info "RUBY already installed, current version: ${bldylw}${ruby_version}"
-      return 0
+      info "Setting up rbenv anyway"
     fi
   fi
 

examples/example_gem/WORKSPACE

@@ -11,9 +11,11 @@ load("@rules_ruby//ruby:deps.bzl", "rules_ruby_dependencies")
 
 rules_ruby_dependencies()
 
-load("@rules_ruby//ruby:deps.bzl", "rules_ruby_register_toolchains")
+load("@rules_ruby//ruby:defs.bzl", "ruby_runtime")
 
-rules_ruby_register_toolchains(["ruby-3.0"])
+ruby_runtime("ruby-3.0")
+
+register_toolchains("@ruby-3.0//:toolchain")
 
 load("@bazel_skylib//:workspace.bzl", "bazel_skylib_workspace")
 

examples/simple_rails_api/WORKSPACE

@@ -11,15 +11,17 @@ load("@rules_ruby//ruby:deps.bzl", "rules_ruby_dependencies")
 
 rules_ruby_dependencies()
 
-load("@rules_ruby//ruby:deps.bzl", "rules_ruby_register_toolchains")
+load("@rules_ruby//ruby:defs.bzl", "ruby_runtime")
 
-rules_ruby_register_toolchains(["ruby-3.0"])
+ruby_runtime("ruby-3.0")
+
+register_toolchains("@ruby-3.0//:toolchain")
 
 load("@bazel_skylib//:workspace.bzl", "bazel_skylib_workspace")
 
 bazel_skylib_workspace()
 
-load("@rules_ruby//ruby:defs.bzl", "ruby_bundle")
+load("@workspace_ruby//:bundle.bzl", "ruby_bundle")
 
 ruby_bundle(
     name = "bundle",

examples/simple_script/WORKSPACE

@@ -7,13 +7,17 @@ local_repository(
     path = "../..",
 )
 
-load("@rules_ruby//ruby:deps.bzl", "rules_ruby_dependencies", "rules_ruby_register_toolchains")
+load("@rules_ruby//ruby:deps.bzl", "rules_ruby_dependencies")
 
 rules_ruby_dependencies()
 
-rules_ruby_register_toolchains(["ruby-3.0"])
+load("@rules_ruby//ruby:defs.bzl", "ruby_runtime")
 
-load("@rules_ruby//ruby:defs.bzl", "ruby_bundle")
+ruby_runtime("ruby-3.0")
+
+register_toolchains("@ruby-3.0//:toolchain")
+
+load("@ruby-3.0//:bundle.bzl", "ruby_bundle")
 
 ruby_bundle(
     name = "bundle",

examples/simple_script_vendored/WORKSPACE

@@ -10,13 +10,20 @@ local_repository(
     path = "../..",
 )
 
-load("@rules_ruby//ruby:deps.bzl", "rules_ruby_dependencies", "rules_ruby_register_toolchains")
+load("@rules_ruby//ruby:deps.bzl", "rules_ruby_dependencies")
 
 rules_ruby_dependencies()
 
-rules_ruby_register_toolchains(["ruby-2.7.1"])
+load("@rules_ruby//ruby:defs.bzl", "ruby_runtime")
 
-load("@rules_ruby//ruby:defs.bzl", "ruby_bundle")
+ruby_runtime(
+    name = "ruby-2.7",
+    version = "ruby-2.7.1",
+)
+
+register_toolchains("@ruby-2.7//:toolchain")
+
+load("@ruby-2.7.1//:bundle.bzl", "ruby_bundle")
 
 ruby_bundle(
     name = "bundle",

ruby/defs.bzl

@@ -1,5 +1,6 @@
 load(
     "@rules_ruby//ruby/private:toolchain.bzl",
+    _mock_toolchain = "mock_ruby_toolchain",
     _toolchain = "ruby_toolchain",
 )
 load(
@@ -13,8 +14,7 @@ load(
 )
 load(
     "@rules_ruby//ruby/private/bundle:def.bzl",
-    _bundle = "bundle_install",
-    _ruby_bundle = "ruby_bundle_install",
+    _bundle_install = "bundle_install",
 )
 load(
     "@rules_ruby//ruby/private:rspec.bzl",
@@ -30,15 +30,20 @@ load(
     _gem = "gem",
     _gemspec = "gemspec",
 )
+load(
+    "@rules_ruby//ruby/private:sdk.bzl",
+    _register_ruby_runtime = "register_ruby_runtime",
+)
 
+ruby_mock_toolchain = _mock_toolchain
 ruby_toolchain = _toolchain
 ruby_library = _library
 ruby_binary = _binary
 ruby_test = _test
 ruby_rspec_test = _rspec_test
 ruby_rspec = _rspec
-ruby_bundle = _ruby_bundle
-ruby_bundle_install = _bundle
+ruby_bundle_install = _bundle_install
 ruby_rubocop = _rubocop
 ruby_gemspec = _gemspec
 ruby_gem = _gem
+ruby_runtime = _register_ruby_runtime

ruby/deps.bzl

@@ -3,10 +3,5 @@ load(
     "@rules_ruby//ruby/private:dependencies.bzl",
     _rules_ruby_dependencies = "rules_ruby_dependencies",
 )
-load(
-    "@rules_ruby//ruby/private:sdk.bzl",
-    _rules_ruby_register_toolchains = "rules_ruby_register_toolchains",
-)
 
 rules_ruby_dependencies = _rules_ruby_dependencies
-rules_ruby_register_toolchains = _rules_ruby_register_toolchains

ruby/private/bundle/def.bzl

@@ -173,7 +173,7 @@ def generate_bundle_build_file(runtime_ctx, previous_result):
     if result.return_code:
         fail("build file generation failed: %s%s" % (result.stdout, result.stderr))
 
-def _ruby_bundle_impl(ctx):
+def ruby_bundle_impl(ctx, ruby_interpreter):
     ctx.symlink(ctx.attr.gemfile, ctx.attr.gemfile.name)
     if ctx.attr.gemfile_lock:
         ctx.symlink(ctx.attr.gemfile_lock, ctx.attr.gemfile_lock.name)
@@ -192,7 +192,7 @@ def _ruby_bundle_impl(ctx):
     # Setup this provider that we pass around between functions for convenience
     runtime_ctx = RubyRuntimeInfo(
         ctx = ctx,
-        interpreter = ctx.path(ctx.attr.ruby_interpreter),
+        interpreter = ruby_interpreter,
         environment = {"RUBYOPT": "--enable-gems"},
     )
 
@@ -218,8 +218,3 @@ def _ruby_bundle_impl(ctx):
 
     # 5. Generate the BUILD file for the bundle
     generate_bundle_build_file(runtime_ctx, result)
-
-ruby_bundle_install = repository_rule(
-    implementation = _ruby_bundle_impl,
-    attrs = BUNDLE_ATTRS,
-)