Refactor download_gem.rb and build file generator

Author: Konstantin Gredeskoul

.rubocop.yml

@@ -1,12 +1,36 @@
 inherit_from: .relaxed-rubocop-2.4.yml
 
 AllCops:
-  TargetRubyVersion: 2.6.5
+  TargetRubyVersion: 2.6
+  UseCache: true
+  DefaultFormatter: progress
+  DisplayStyleGuide: true
+  DisplayCopNames: true
   Exclude:
-    - "**/rubocop"
-    - "examples/**/*"
+    - "external*/**/*"
     - "bazel-*/**/*"
-    - "external/**/*"
+    - "**/examples/**/*"
+    - "**/BUILD"
+    - "**/*.bazel"
+    - "**/*.bzl"
+    - "**/rubocop"
     - "**/vendor/bundle/**/*"
+  Include:
+    - '**/*.rb'
+    - '**/*.gemfile'
+    - '**/*.gemspec'
+    - '**/*.rake'
+    - '**/*.ru'
+    - '**/Gemfile'
+    - '**/Rakefile'
 
+Layout/HashAlignment:
+  Enabled: true
+  EnforcedColonStyle: table
+  
+Style/Dir:
+  Enabled: false
 
+Layout/MultilineMethodCallIndentation:
+  Enabled: true
+  EnforcedStyle: indented_relative_to_receiver

README.md

@@ -122,14 +122,14 @@ ruby_binary(
 )
 
 ruby_test(
-    name = "foo_test",
+    name = "foo-test",
     srcs = ["test/foo_test.rb"],
     deps = [":foo"],
 )
 
 ruby_rspec(
-    name = "foo_spec",
-    specs = glob(["spec/**/*.rb]),
+    name = "foo-spec",
+    specs = glob(["spec/**/*.rb"]),
     rspec_args = { "--format": "progress" },
     deps = [":foo"]
 }

WORKSPACE

@@ -1,6 +1,6 @@
 workspace(name = "bazelruby_ruby_rules")
 
-load("@//ruby/private:dependencies.bzl", "ruby_rules_dependencies")
+load("@//ruby:deps.bzl", "ruby_rules_dependencies")
 
 ruby_rules_dependencies()
 
@@ -97,10 +97,10 @@ load("@bazelruby_ruby_rules//ruby:defs.bzl", "bundle_install")
 
 bundle_install(
     name = "bundle",
+    bundler_version = "2.1.2",
     excludes = {
         "mini_portile": ["test/**/*"],
     },
     gemfile = "//:Gemfile",
     gemfile_lock = "//:Gemfile.lock",
-    version = "2.0.2",
 )

examples/simple_script/BUILD.bazel

@@ -47,6 +47,17 @@ ruby_binary(
     ],
 )
 
+ruby_binary(
+    name = "bin-all",
+    srcs = ["script.rb"],
+    main = "script.rb",
+    deps = [
+        ":lib",
+        "//lib:foo",
+        "@bundle//:gems",
+    ],
+)
+
 # This is an example of the RSpec definition that uses autorun
 # and points to spec_helper as the main spec file. It specifies
 # which specs to run using the args.
@@ -87,9 +98,8 @@ ruby_test(
     args = [
         "--format documentation",
         "--force-color",
-    ] + glob([
-        "spec/**/*.rb",
-    ]),
+        "spec",
+    ],
     main = "@bundle//:bin/rspec",
     deps = [
         "@bundle//:awesome_print",
@@ -110,6 +120,10 @@ ruby_rspec(
         ":sources",
         ":spec_sources",
     ],
+    rspec_args = {
+        # NOTE: the output is only visible with --test_output=streamed flag
+        "--format": "progress",  # this is how we can override rspec output format
+    },
     specs = glob([
         "spec/**/*.rb",
     ]),

examples/simple_script/WORKSPACE

@@ -8,26 +8,18 @@ local_repository(
 )
 
 load(
-    "@bazelruby_ruby_rules//ruby/private:dependencies.bzl",
+    "@bazelruby_ruby_rules//ruby:deps.bzl",
+    "ruby_register_toolchains",
     "ruby_rules_dependencies",
 )
 
 ruby_rules_dependencies()
 
-load("@bazel_skylib//:workspace.bzl", "bazel_skylib_workspace")
-
-bazel_skylib_workspace()
-
-load(
-    "@bazelruby_ruby_rules//ruby:deps.bzl",
-    "ruby_register_toolchains",
-)
-
 ruby_register_toolchains(version = "2.6.5")
 
-load("@bazelruby_ruby_rules//ruby:defs.bzl", "bundle_install")
+load("@bazelruby_ruby_rules//ruby:defs.bzl", "ruby_bundle")
 
-bundle_install(
+ruby_bundle(
     name = "bundle",
     excludes = {
         "mini_portile": ["test/**/*"],

examples/simple_script/spec/spec_helper.rb

@@ -18,7 +18,6 @@
 require 'awesome_print'
 require 'colored2'
 
-# frozen_string_literal: true
 RSpec.configure do |config|
   config.expect_with :rspec do |expectations|
     expectations.include_chain_clauses_in_custom_matcher_descriptions = true

ruby/deps.bzl

@@ -1,13 +1,13 @@
 # Repository rules
 load(
     "@bazelruby_ruby_rules//ruby/private:dependencies.bzl",
-    _load_ruby_rules_dependencies = "ruby_rules_dependencies",
+    _ruby_rules_dependencies = "ruby_rules_dependencies",
 )
 load(
     "@bazelruby_ruby_rules//ruby/private:sdk.bzl",
     _register_toolchains = "ruby_register_toolchains",
 )
 
-load_ruby_rules_dependencies = _load_ruby_rules_dependencies
+ruby_rules_dependencies = _ruby_rules_dependencies
 
 ruby_register_toolchains = _register_toolchains

ruby/private/bundle/bundle.bzl

@@ -1,22 +1,21 @@
 load(
     "//ruby/private:constants.bzl",
     "BUNDLE_ATTRS",
+    "BUNDLE_BINARY",
+    "BUNDLE_BIN_PATH",
+    "BUNDLE_PATH",
     "RULES_RUBY_WORKSPACE_NAME",
+    "SCRIPT_BUILD_FILE_GENERATOR",
+    "SCRIPT_INSTALL_GEM",
 )
 load("//ruby/private:providers.bzl", "RubyRuntimeContext")
 load("//ruby/private/tools:deprecations.bzl", "deprecated_attribute")
 
-BUNDLE_BIN_PATH = "bin"
-BUNDLE_PATH = "lib"
-BUNDLE_BINARY = "bundler/exe/bundler"
-SCRIPT_INSTALL_GEM = "install_bundler.rb"
-SCRIPT_BUILD_FILE_GENERATOR = "create_bundle_build_file.rb"
-
 # Runs bundler with arbitrary arguments
-#
 # eg: run_bundler(runtime_ctx, [ "lock", " --gemfile", "Gemfile.rails5" ])
-#
 def run_bundler(runtime_ctx, bundler_arguments):
+    #print("BUNDLE RUN", bundler_arguments)
+
     # Now we are running bundle install
     args = [
         runtime_ctx.interpreter,  # ruby
@@ -39,7 +38,7 @@ def run_bundler(runtime_ctx, bundler_arguments):
 #
 # Sets local bundler config values by calling
 #
-# $ bundler config --local | --global config-option config-value
+# $ bundle config --local | --global config-option config-value
 #
 # @config_category can be either 'local' or 'global'
 def set_bundler_config(runtime_ctx, config_category = "local"):
@@ -51,16 +50,15 @@ def set_bundler_config(runtime_ctx, config_category = "local"):
     #
     # Set local configuration options for bundler
     bundler_config = {
-        "binstubs": BUNDLE_BIN_PATH,
-        "deployment": "'true'",
-        "standalone": "'true'",
-        "frozen": "'true'",
+        "deployment": "true",
+        "standalone": "true",
+        "frozen": "true",
         "without": "development,test",
         "path": BUNDLE_PATH,
         "jobs": "20",
     }
 
-    for option, value in [(option, value) for option, value in bundler_config.items()]:
+    for option, value in bundler_config.items():
         args = ["config", "--%s" % (config_category), option, value]
 
         result = run_bundler(runtime_ctx, args)
@@ -72,6 +70,13 @@ def set_bundler_config(runtime_ctx, config_category = "local"):
             )
             fail(message)
 
+    # The new way to generate binstubs is via the binstubs command, not config option.
+    return run_bundler(runtime_ctx, ["binstubs", "--path", BUNDLE_BIN_PATH])
+
+# This function is called "pure_ruby" because it downloads and unpacks the gem
+# file into a given folder, which for gems without C-extensions is the same
+# as install. To support gems that have C-extensions, the Ruby file install_gem.rb
+# will need to be modified to use Gem::Installer.at(path).install(gem) API.
 def install_pure_ruby_gem(runtime_ctx, gem_name, gem_version, folder):
     # USAGE: ./install_bundler.rb gem-name gem-version destination-folder
     args = [
@@ -104,7 +109,7 @@ def bundle_install(runtime_ctx):
     result = run_bundler(
         runtime_ctx,
         [
-            "install",  #   > bundle install
+            "install",  #  bundle install
             "--standalone",  # Makes a bundle that can work without depending on Rubygems or Bundler at runtime.
             "--binstubs={}".format(BUNDLE_BIN_PATH),  # Creates a directory and place any executables from the gem there.
             "--path={}".format(BUNDLE_PATH),  # The location to install the specified gems to.
@@ -120,7 +125,7 @@ def generate_bundle_build_file(runtime_ctx):
     args = [
         runtime_ctx.interpreter,  # ruby interpreter
         "--enable=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)
+        "-I",  # -I lib (adds this folder to $LOAD_PATH where ruby searches for things)
         "bundler/lib",
         SCRIPT_BUILD_FILE_GENERATOR,  # The template used to created bundle file
         "BUILD.bazel",  # Bazel build file (can be empty)
@@ -134,14 +139,18 @@ def generate_bundle_build_file(runtime_ctx):
     if result.return_code:
         fail("build file generation failed: %s%s" % (result.stdout, result.stderr))
 
-def bundle_install_impl(ctx):
+def _ruby_bundle_impl(ctx):
     ctx.symlink(ctx.attr.gemfile, "Gemfile")
     ctx.symlink(ctx.attr.gemfile_lock, "Gemfile.lock")
     ctx.symlink(ctx.attr._create_bundle_build_file, SCRIPT_BUILD_FILE_GENERATOR)
     ctx.symlink(ctx.attr._install_bundler, SCRIPT_INSTALL_GEM)
 
     # version is too generic for this operation
     deprecated_attribute(ctx, "version", "bundler_version")
+    if ctx.attr.bundler_version:
+        bundler_version = ctx.attr.bundler_version
+    else:
+        bundler_version = ctx.attr.version
 
     # Setup this provider that we pass around between functions for convenience
     runtime_ctx = RubyRuntimeContext(
@@ -151,7 +160,7 @@ def bundle_install_impl(ctx):
     )
 
     # 1. Install the right version of the Bundler Gem
-    install_bundler(runtime_ctx, ctx.attr.bundler_version)
+    install_bundler(runtime_ctx, bundler_version)
 
     # Create label for the Bundler executable
     bundler = Label("//:" + BUNDLE_BINARY)
@@ -166,6 +175,6 @@ def bundle_install_impl(ctx):
     generate_bundle_build_file(runtime_ctx)
 
 ruby_bundle = repository_rule(
-    implementation = bundle_install_impl,
+    implementation = _ruby_bundle_impl,
     attrs = BUNDLE_ATTRS,
 )