[Feature] install ruby if none exists

Author: graham jenson

.ruby-version

@@ -0,0 +1 @@
+2.6.5

examples/simple_script/.ruby-version

@@ -0,0 +1 @@
+2.6.5

examples/simple_script/BUILD

@@ -12,7 +12,7 @@ ruby_binary(
     main = "script.rb",
     deps = [
         "//lib:foo",
-        "@bundle//:libs",
+        "@bundle//:awesome_print",
     ],
 )
 
@@ -26,6 +26,7 @@ ruby_test(
     rubyopt = ["-rrspec/autorun"],  # require autorun because it is needed
     deps = [
         "//lib:foo",
-        "@bundle//:libs",
+        "@bundle//:awesome_print",
+        "@bundle//:rspec",
     ],
 )

examples/simple_script/Gemfile

@@ -5,3 +5,4 @@ source "https://rubygems.org"
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 gem 'rspec', '~> 3.7.0'
+gem 'awesome_print'

examples/simple_script/Gemfile.lock

@@ -1,6 +1,7 @@
 GEM
   remote: https://rubygems.org/
   specs:
+    awesome_print (1.8.0)
     diff-lcs (1.3)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
@@ -20,7 +21,8 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  awesome_print
   rspec (~> 3.7.0)
 
 BUNDLED WITH
-   1.16.1
+   1.17.3

examples/simple_script/WORKSPACE

@@ -15,7 +15,7 @@ load(
 
 ruby_rules_dependencies()
 
-ruby_register_toolchains()
+ruby_register_toolchains(version = "2.6.5")
 
 load("@bazel_skylib//:workspace.bzl", "bazel_skylib_workspace")
 

examples/simple_script/script.rb

@@ -2,9 +2,14 @@
 
 require 'openssl'
 require 'lib/foo'
+require "awesome_print"
 
 def oss_rand
   OpenSSL::BN.rand(512).to_s
 end
 
 puts Foo.aha + " " + oss_rand
+
+puts $LOAD_PATH
+
+ap Class

ruby/private/bundle/bundle.bzl

@@ -1,28 +1,40 @@
 load("//ruby/private:constants.bzl", "RULES_RUBY_WORKSPACE_NAME")
 
-def _get_interpreter_label(repository_ctx, ruby_sdk):
-    # TODO(yugui) Support windows as rules_nodejs does
-    return Label("%s//:ruby" % ruby_sdk)
+_DEFAULT_VERSION = "2.0.2"
 
-def _get_bundler_label(repository_ctx, ruby_sdk):
-    # TODO(yugui) Support windows as rules_nodejs does
-    return Label("%s//:bundler/exe/bundler" % ruby_sdk)
+def install_bundler(ctx, interpreter, install_bundler, dest, version = _DEFAULT_VERSION):
+    args = ["env", "-i", interpreter, install_bundler, version, dest]
+    environment = {"RUBYOPT": "--disable-gems"}
 
-def _get_bundler_lib_label(repository_ctx, ruby_sdk):
-    # TODO(yugui) Support windows as rules_nodejs does
-    return Label("%s//:bundler/lib" % ruby_sdk)
+    result = ctx.execute(args, environment = environment)
+    if result.return_code:
+        message = "Failed to evaluate ruby snippet with {}: {}".format(
+            interpreter,
+            result.stderr,
+        )
+        fail(message)
 
 def bundle_install_impl(ctx):
     ctx.symlink(ctx.attr.gemfile, "Gemfile")
     ctx.symlink(ctx.attr.gemfile_lock, "Gemfile.lock")
     ctx.symlink(ctx.attr._create_bundle_build_file, "create_bundle_build_file.rb")
+    ctx.symlink(ctx.attr._install_bundler, "install_bundler.rb")
 
     # TODO(kig) Make Gemspec reference from Gemfile actually work
     if ctx.attr.gemspec:
         ctx.symlink(ctx.attr.gemspec, ctx.path(ctx.attr.gemspec).basename)
 
-    ruby = _get_interpreter_label(ctx, ctx.attr.ruby_sdk)
-    bundler = _get_bundler_label(ctx, ctx.attr.ruby_sdk)
+    ruby = ctx.attr.ruby_interpreter
+    interpreter_path = ctx.path(ruby)
+
+    install_bundler(
+        ctx,
+        interpreter_path,
+        "install_bundler.rb",
+        "bundler",
+    )
+
+    bundler = Label("//:bundler/exe/bundler")
 
     # Install the Gems into the workspace
     args = [
@@ -31,8 +43,8 @@ def bundle_install_impl(ctx):
         ctx.path(ruby),  # ruby
         "--disable-gems",  # prevent the addition of gem installation directories to the default load path
         "-I",  # Used to tell Ruby where to load the library scripts
-        ctx.path(bundler).dirname.dirname.get_child("lib"),
-        ctx.path(bundler),  # run
+        "bundler/lib",
+        "bundler/exe/bundler",  # run
         "install",  #   > bundle install
         "--deployment",  # In the deployment mode, gems are dumped to --path and frozen; also .bundle/config file is created
         "--standalone",  # Makes a bundle that can work without depending on Rubygems or Bundler at runtime.
@@ -58,7 +70,7 @@ def bundle_install_impl(ctx):
         ctx.path(ruby),  # ruby interpreter
         "--disable-gems",  # prevent the addition of gem installation directories to the default load path
         "-I",  # -I lib (adds this folder to $LOAD_PATH where ruby searchesf for things)
-        ctx.path(bundler).dirname.dirname.get_child("lib"),
+        "bundler/lib",
         "create_bundle_build_file.rb",  # The template used to created bundle file
         "BUILD.bazel",  # Bazel build file (can be empty)
         "Gemfile.lock",  # Gemfile.lock where we list all direct and transitive dependencies
@@ -85,7 +97,10 @@ bundle_install = repository_rule(
     implementation = bundle_install_impl,
     attrs = {
         "ruby_sdk": attr.string(
-            default = "@org_ruby_lang_ruby_host",
+            default = "@org_ruby_lang_ruby_toolchain",
+        ),
+        "ruby_interpreter": attr.label(
+            default = "@org_ruby_lang_ruby_toolchain//:ruby",
         ),
         "gemfile": attr.label(
             allow_single_file = True,
@@ -99,6 +114,12 @@ bundle_install = repository_rule(
         "excludes": attr.string_list_dict(
             doc = "List of glob patterns per gem to be excluded from the library",
         ),
+        "_install_bundler": attr.label(
+            default = "%s//ruby/private/bundle:install_bundler.rb" % (
+                RULES_RUBY_WORKSPACE_NAME
+            ),
+            allow_single_file = True,
+        ),
         "_create_bundle_build_file": attr.label(
             default = "%s//ruby/private/bundle:create_bundle_build_file.rb" % (
                 RULES_RUBY_WORKSPACE_NAME

ruby/private/bundle/gem_install.bzl

@@ -0,0 +1,37 @@
+load(":constants.bzl", "TOOLCHAIN_TYPE_NAME")
+
+# Gem install is a rule that takes a Gemfile and Gemfile.lock and installs
+def _gem_install_impl(ctx):
+    if not ctx.attr.srcs and not ctx.attr.deps:
+        fail("At least srcs or deps must be present")
+
+    deps = _transitive_deps(ctx)
+    return [
+        DefaultInfo(
+            default_runfiles = deps.default_files,
+            data_runfiles = deps.data_files,
+        ),
+        RubyLibrary(
+            transitive_ruby_srcs = deps.srcs,
+            ruby_incpaths = deps.incpaths,
+            rubyopt = deps.rubyopt,
+        ),
+    ]
+
+gem_install = rule(
+    implementation = _gem_install_impl,
+    attrs = {
+        "gemfile": attr.label_list(
+            allow_files = True,
+        ),
+        "includes": attr.string_list(),
+        "rubyopt": attr.string_list(),
+        "deps": attr.label_list(
+            providers = [RubyLibrary],
+        ),
+        "data": attr.label_list(
+            allow_files = True,
+        ),
+    },
+    toolchains = [TOOLCHAIN_TYPE_NAME],
+)