Align scala_proto changes with pull requests

Adds comments and rearranges existing logic and declarations, but no material changes. Hence, no "Bzlmod part the Nth" commit message.
mbland · Nov 17, 2024 · 99f58ac · 99f58ac
1 parent acd3a4b
commit 99f58ac
Show file tree

Hide file tree

Showing 3 changed files with 51 additions and 49 deletions.
diff --git a/scala/private/macros/toolchains.bzl b/scala/private/macros/toolchains.bzl
@@ -188,10 +188,10 @@ def scala_toolchains(
         scalatest = scalatest,
         junit = junit,
         specs2 = specs2,
-        twitter_scrooge = twitter_scrooge,
-        jmh = jmh,
-        scala_proto = scala_proto,
-        scala_proto_enable_all_options = scala_proto_enable_all_options,
         testing = testing,
         scalafmt = scalafmt,
+        scala_proto = scala_proto,
+        scala_proto_enable_all_options = scala_proto_enable_all_options,
+        jmh = jmh,
+        twitter_scrooge = twitter_scrooge,
     )
diff --git a/scala/private/macros/toolchains_repo.bzl b/scala/private/macros/toolchains_repo.bzl
@@ -21,6 +21,10 @@ def _generate_testing_toolchain_build_file_args(repo_attr):
 
     if len(framework_deps) == 0:
         return None
+
+    # The _TESTING_TOOLCHAIN_BUILD template expects that all framework keys are
+    # present in the dictionary, so it can set unset framework classpath
+    # parameters to `None`.
     return {
         "deps_symbols": "\",\n    \"".join(
             [s for s in framework_deps.values()],
@@ -41,12 +45,12 @@ def _scala_toolchains_repo_impl(repository_ctx):
 
     if repo_attr.scala:
         toolchains["scala"] = _SCALA_TOOLCHAIN_BUILD
-    if repo_attr.twitter_scrooge:
-        toolchains["twitter_scrooge"] = _TWITTER_SCROOGE_TOOLCHAIN_BUILD
-    if repo_attr.jmh:
-        toolchains["jmh"] = _JMH_TOOLCHAIN_BUILD
     if repo_attr.scala_proto:
         toolchains["scala_proto"] = _SCALA_PROTO_TOOLCHAIN_BUILD
+    if repo_attr.jmh:
+        toolchains["jmh"] = _JMH_TOOLCHAIN_BUILD
+    if repo_attr.twitter_scrooge:
+        toolchains["twitter_scrooge"] = _TWITTER_SCROOGE_TOOLCHAIN_BUILD
 
     testing_build_args = _generate_testing_toolchain_build_file_args(repo_attr)
     if testing_build_args != None:
@@ -74,12 +78,12 @@ _scala_toolchains_repo = repository_rule(
         "scalatest": attr.bool(),
         "junit": attr.bool(),
         "specs2": attr.bool(),
-        "twitter_scrooge": attr.bool(),
-        "jmh": attr.bool(),
-        "scala_proto": attr.bool(),
-        "scala_proto_enable_all_options": attr.bool(),
         "testing": attr.bool(),
         "scalafmt": attr.bool(),
+        "scala_proto": attr.bool(),
+        "scala_proto_enable_all_options": attr.bool(),
+        "jmh": attr.bool(),
+        "twitter_scrooge": attr.bool(),
     },
 )
 
@@ -130,19 +134,35 @@ load(
 ]
 """
 
-_TWITTER_SCROOGE_TOOLCHAIN_BUILD = """
+_TESTING_TOOLCHAIN_BUILD = """
+load("@@{rules_scala_repo}//scala:scala.bzl", "setup_scala_testing_toolchain")
+load("@@{rules_scala_repo}//scala:scala_cross_version.bzl", "version_suffix")
 load(
-    "@@{rules_scala_repo}//twitter_scrooge/toolchain:toolchain.bzl",
-    "setup_scrooge_toolchain",
+    "@@{rules_scala_repo}//testing:deps.bzl",
+    "{deps_symbols}",
 )
+load("@io_bazel_rules_scala_config//:config.bzl", "SCALA_VERSIONS")
 
-setup_scrooge_toolchain(name = "scrooge_toolchain")
+[
+    setup_scala_testing_toolchain(
+        name = "testing_toolchain" + version_suffix(scala_version),
+        scala_version = scala_version,
+        scalatest_classpath = {scalatest},
+        junit_classpath = {junit},
+        specs2_classpath = {specs2},
+        specs2_junit_classpath = {specs2_junit},
+    )
+    for scala_version in SCALA_VERSIONS
+]
 """
 
-_JMH_TOOLCHAIN_BUILD = """
-load("@@{rules_scala_repo}//jmh/toolchain:toolchain.bzl", "setup_jmh_toolchain")
+_SCALAFMT_TOOLCHAIN_BUILD = """
+load(
+    "@@{rules_scala_repo}//scala/scalafmt/toolchain:setup_scalafmt_toolchain.bzl",
+    "setup_scalafmt_toolchains",
+)
 
-setup_jmh_toolchain(name = "jmh_toolchain")
+setup_scalafmt_toolchains()
 """
 
 _SCALA_PROTO_TOOLCHAIN_BUILD = """
@@ -184,33 +204,17 @@ declare_deps_provider(
 )
 """
 
-_TESTING_TOOLCHAIN_BUILD = """
-load("@@{rules_scala_repo}//scala:scala.bzl", "setup_scala_testing_toolchain")
-load("@@{rules_scala_repo}//scala:scala_cross_version.bzl", "version_suffix")
-load(
-    "@@{rules_scala_repo}//testing:deps.bzl",
-    "{deps_symbols}",
-)
-load("@io_bazel_rules_scala_config//:config.bzl", "SCALA_VERSIONS")
+_JMH_TOOLCHAIN_BUILD = """
+load("@@{rules_scala_repo}//jmh/toolchain:toolchain.bzl", "setup_jmh_toolchain")
 
-[
-    setup_scala_testing_toolchain(
-        name = "testing_toolchain" + version_suffix(scala_version),
-        scala_version = scala_version,
-        scalatest_classpath = {scalatest},
-        junit_classpath = {junit},
-        specs2_classpath = {specs2},
-        specs2_junit_classpath = {specs2_junit},
-    )
-    for scala_version in SCALA_VERSIONS
-]
+setup_jmh_toolchain(name = "jmh_toolchain")
 """
 
-_SCALAFMT_TOOLCHAIN_BUILD = """
+_TWITTER_SCROOGE_TOOLCHAIN_BUILD = """
 load(
-    "@@{rules_scala_repo}//scala/scalafmt/toolchain:setup_scalafmt_toolchain.bzl",
-    "setup_scalafmt_toolchains",
+    "@@{rules_scala_repo}//twitter_scrooge/toolchain:toolchain.bzl",
+    "setup_scrooge_toolchain",
 )
 
-setup_scalafmt_toolchains()
+setup_scrooge_toolchain(name = "scrooge_toolchain")
 """
diff --git a/scala_proto/default/repositories.bzl b/scala_proto/default/repositories.bzl
@@ -64,17 +64,15 @@ def scala_proto_artifact_ids(scala_version):
 def scala_proto_default_repositories(
         maven_servers = default_maven_server_urls(),
         scala_version = SCALA_VERSION,
-        overriden_artifacts = {},
-        register_toolchains = True):
+        overriden_artifacts = {}):
     repositories(
         scala_version = scala_version,
-        for_artifact_ids = scala_proto_artifact_ids(),
+        for_artifact_ids = scala_proto_artifact_ids(scala_version),
         maven_servers = maven_servers,
         fetch_sources = True,
         overriden_artifacts = overriden_artifacts,
     )
 
-    if register_toolchains:
-        native.register_toolchains(
-            str(Label("//scala_proto:default_deps_toolchain")),
-        )
+    native.register_toolchains(
+        str(Label("//scala_proto:default_deps_toolchain")),
+    )