Updated to use rules_updatesrc for file updates (#23)

cgrindel · web-flow · commit 3f7934799503 · 2021-10-26T18:53:19.000Z
Replaced swiftformat_update and swiftformat_update_all with updatesrc_update and updatesrc_update_all from rules_updatesrc.
diff --git a/BUILD.bazel b/BUILD.bazel
@@ -0,0 +1,11 @@
+load(
+    "@cgrindel_rules_updatesrc//updatesrc:updatesrc.bzl",
+    "updatesrc_update_all",
+)
+
+updatesrc_update_all(
+    name = "update_all",
+    targets_to_run = [
+        "//doc:update",
+    ],
+)
diff --git a/README.md b/README.md
@@ -33,6 +33,13 @@ swiftformat_rules_dependencies()
 
 # Configure the dependencies for rules_swiftformat
 
+load(
+    "@cgrindel_rules_updatesrc//updatesrc:deps.bzl",
+    "updatesrc_rules_dependencies",
+)
+
+updatesrc_rules_dependencies()
+
 load(
     "@cgrindel_rules_spm//spm:deps.bzl",
     "spm_rules_dependencies",
@@ -69,15 +76,15 @@ following:
 
 ```python
 load(
-    "@cgrindel_rules_swiftformat//swiftformat:swiftformat.bzl",
-    "swiftformat_update_all",
+    "@cgrindel_rules_updatesrc//updatesrc:updatesrc.bzl",
+    "updatesrc_update_all",
 )
 
 # We export this file to make it available to other Bazel packages in the workspace.
 exports_files([".swiftformat"])
 
 # Define a runnable target to copy all of the formatted files to the workspace directory.
-swiftformat_update_all(
+updatesrc_update_all(
     name = "update_all",
 )
 ```
diff --git a/WORKSPACE b/WORKSPACE
@@ -4,6 +4,13 @@ load("//swiftformat:deps.bzl", "swiftformat_rules_dependencies")
 
 swiftformat_rules_dependencies()
 
+load(
+    "@cgrindel_rules_updatesrc//updatesrc:deps.bzl",
+    "updatesrc_rules_dependencies",
+)
+
+updatesrc_rules_dependencies()
+
 load(
     "@cgrindel_rules_spm//spm:deps.bzl",
     "spm_rules_dependencies",
diff --git a/doc/BUILD.bazel b/doc/BUILD.bazel
@@ -26,8 +26,6 @@ _RULES_AND_MACROS_DOC_PROVIDER = doc_providers.create(
         "swiftformat_library",
         "swiftformat_pkg",
         "swiftformat_test",
-        "swiftformat_update",
-        "swiftformat_update_all",
     ],
     deps = ["//swiftformat"],
 )
diff --git a/doc/rules_and_macros_overview.md b/doc/rules_and_macros_overview.md
@@ -11,8 +11,6 @@ On this page:
   * [swiftformat_library](#swiftformat_library)
   * [swiftformat_pkg](#swiftformat_pkg)
   * [swiftformat_test](#swiftformat_test)
-  * [swiftformat_update](#swiftformat_update)
-  * [swiftformat_update_all](#swiftformat_update_all)
 
 
 <a id="#swiftformat_format"></a>
@@ -37,25 +35,6 @@ Formats the Swift source files using `nicklockwood/SwiftFormat`.
 | <a id="swiftformat_format-swift_version"></a>swift_version |  The Swift version to be used by <code>swiftformat</code>. You probably want to add this to your config file instead of adding it here.   | String | optional | "" |
 
 
-<a id="#swiftformat_update"></a>
-
-## swiftformat_update
-
-<pre>
-swiftformat_update(<a href="#swiftformat_update-name">name</a>, <a href="#swiftformat_update-formats">formats</a>)
-</pre>
-
-Copies the formatted Swift sources to the workspace directory.
-
-**ATTRIBUTES**
-
-
-| Name  | Description | Type | Mandatory | Default |
-| :------------- | :------------- | :------------- | :------------- | :------------- |
-| <a id="swiftformat_update-name"></a>name |  A unique name for this target.   | <a href="https://bazel.build/docs/build-ref.html#name">Name</a> | required |  |
-| <a id="swiftformat_update-formats"></a>formats |  The format build targets.   | <a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a> | optional | [] |
-
-
 <a id="#swiftformat_binary"></a>
 
 ## swiftformat_binary
@@ -145,27 +124,3 @@ Defines a `swift_test` along with a `swiftformat_pkg`.
 | <a id="swiftformat_test-kwargs"></a>kwargs |  The attributes for <code>swift_test</code>.   |  none |
 
 
-<a id="#swiftformat_update_all"></a>
-
-## swiftformat_update_all
-
-<pre>
-swiftformat_update_all(<a href="#swiftformat_update_all-name">name</a>)
-</pre>
-
-Defines a runnable target that will copy the formatted Swift files to the source tree.
-
-The utility queries for all of the swiftformat_update rules in the
-workspace and executes each one. Hence, only Swift source files that are
-referenced by a swiftformat_update will be copied to the workspace
-directory.
-
-
-**PARAMETERS**
-
-
-| Name  | Description | Default Value |
-| :------------- | :------------- | :------------- |
-| <a id="swiftformat_update_all-name"></a>name |  The name of the target.   |  none |
-
-
diff --git a/examples/exclude_files/BUILD.bazel b/examples/exclude_files/BUILD.bazel
@@ -1,6 +1,6 @@
 load(
-    "@cgrindel_rules_swiftformat//swiftformat:swiftformat.bzl",
-    "swiftformat_update_all",
+    "@cgrindel_rules_updatesrc//updatesrc:updatesrc.bzl",
+    "updatesrc_update_all",
 )
 
 # MARK: - SwiftFormat Targets
@@ -11,6 +11,6 @@ exports_files([".swiftformat"])
 
 # Defines a target that will copy all of the formatted Swift source files to
 # the workspace directory.
-swiftformat_update_all(
+updatesrc_update_all(
     name = "update_all",
 )
diff --git a/examples/exclude_files/WORKSPACE b/examples/exclude_files/WORKSPACE
@@ -9,6 +9,13 @@ load("@cgrindel_rules_swiftformat//swiftformat:deps.bzl", "swiftformat_rules_dep
 
 swiftformat_rules_dependencies()
 
+load(
+    "@cgrindel_rules_updatesrc//updatesrc:deps.bzl",
+    "updatesrc_rules_dependencies",
+)
+
+updatesrc_rules_dependencies()
+
 load(
     "@cgrindel_rules_spm//spm:deps.bzl",
     "spm_rules_dependencies",
diff --git a/examples/rules_swift_helpers/BUILD.bazel b/examples/rules_swift_helpers/BUILD.bazel
@@ -1,6 +1,6 @@
 load(
-    "@cgrindel_rules_swiftformat//swiftformat:swiftformat.bzl",
-    "swiftformat_update_all",
+    "@cgrindel_rules_updatesrc//updatesrc:updatesrc.bzl",
+    "updatesrc_update_all",
 )
 
 # MARK: - SwiftFormat Targets
@@ -11,6 +11,6 @@ exports_files([".swiftformat"])
 
 # Defines a target that will copy all of the formatted Swift source files to
 # the workspace directory.
-swiftformat_update_all(
+updatesrc_update_all(
     name = "update_all",
 )
diff --git a/examples/rules_swift_helpers/WORKSPACE b/examples/rules_swift_helpers/WORKSPACE
@@ -9,6 +9,13 @@ load("@cgrindel_rules_swiftformat//swiftformat:deps.bzl", "swiftformat_rules_dep
 
 swiftformat_rules_dependencies()
 
+load(
+    "@cgrindel_rules_updatesrc//updatesrc:deps.bzl",
+    "updatesrc_rules_dependencies",
+)
+
+updatesrc_rules_dependencies()
+
 load(
     "@cgrindel_rules_spm//spm:deps.bzl",
     "spm_rules_dependencies",
diff --git a/examples/simple/BUILD.bazel b/examples/simple/BUILD.bazel
@@ -2,7 +2,10 @@ load("@build_bazel_rules_swift//swift:swift.bzl", "swift_binary")
 load(
     "@cgrindel_rules_swiftformat//swiftformat:swiftformat.bzl",
     "swiftformat_pkg",
-    "swiftformat_update_all",
+)
+load(
+    "@cgrindel_rules_updatesrc//updatesrc:updatesrc.bzl",
+    "updatesrc_update_all",
 )
 
 # MARK: - Swift Targets
@@ -31,7 +34,7 @@ exports_files([".swiftformat"])
 
 # Defines a target that will copy all of the formatted Swift source files to
 # the workspace directory.
-swiftformat_update_all(
+updatesrc_update_all(
     name = "update_all",
 )
 
diff --git a/examples/simple/WORKSPACE b/examples/simple/WORKSPACE
@@ -9,6 +9,13 @@ load("@cgrindel_rules_swiftformat//swiftformat:deps.bzl", "swiftformat_rules_dep
 
 swiftformat_rules_dependencies()
 
+load(
+    "@cgrindel_rules_updatesrc//updatesrc:deps.bzl",
+    "updatesrc_rules_dependencies",
+)
+
+updatesrc_rules_dependencies()
+
 load(
     "@cgrindel_rules_spm//spm:deps.bzl",
     "spm_rules_dependencies",
diff --git a/swiftformat/BUILD.bazel b/swiftformat/BUILD.bazel
@@ -23,7 +23,5 @@ bzl_library(
         "//swiftformat/internal:swiftformat_library",
         "//swiftformat/internal:swiftformat_pkg",
         "//swiftformat/internal:swiftformat_test",
-        "//swiftformat/internal:swiftformat_update",
-        "//swiftformat/internal:swiftformat_update_all",
     ],
 )
diff --git a/swiftformat/deps.bzl b/swiftformat/deps.bzl
@@ -13,6 +13,14 @@ def swiftformat_rules_dependencies():
         ],
     )
 
+    maybe(
+        http_archive,
+        name = "cgrindel_rules_updatesrc",
+        sha256 = "18eb6620ac4684c2bc722b8fe447dfaba76f73d73e2dfcaf837f542379ed9bc3",
+        strip_prefix = "rules_updatesrc-0.1.0",
+        urls = ["https://github.com/cgrindel/rules_updatesrc/archive/v0.1.0.tar.gz"],
+    )
+
     maybe(
         http_archive,
         name = "cgrindel_bazel_doc",
diff --git a/swiftformat/internal/BUILD.bazel b/swiftformat/internal/BUILD.bazel
@@ -18,6 +18,7 @@ bzl_library(
     deps = [
         ":providers",
         "@bazel_skylib//lib:paths",
+        "@cgrindel_rules_updatesrc//updatesrc",
     ],
 )
 
@@ -27,25 +28,11 @@ bzl_library(
     deps = [
         ":src_utils",
         ":swiftformat_format",
-        ":swiftformat_update",
         "@bazel_skylib//rules:diff_test",
+        "@cgrindel_rules_updatesrc//updatesrc",
     ],
 )
 
-bzl_library(
-    name = "swiftformat_update",
-    srcs = ["swiftformat_update.bzl"],
-    deps = [
-        ":providers",
-        "@bazel_skylib//lib:dicts",
-    ],
-)
-
-bzl_library(
-    name = "swiftformat_update_all",
-    srcs = ["swiftformat_update_all.bzl"],
-)
-
 bzl_library(
     name = "swiftformat_library",
     srcs = ["swiftformat_library.bzl"],
diff --git a/swiftformat/internal/swiftformat_format.bzl b/swiftformat/internal/swiftformat_format.bzl
@@ -1,16 +1,18 @@
 load("@bazel_skylib//lib:paths.bzl", "paths")
-load(":providers.bzl", "SwiftFormatInfo")
+load(
+    "@cgrindel_rules_updatesrc//updatesrc:updatesrc.bzl",
+    "UpdateSrcsInfo",
+    "update_srcs",
+)
 
 """A build rule that formats Swift source files.
 """
 
 def _swiftformat_format_impl(ctx):
-    outputs = []
-    format_map = {}
+    updsrcs = []
     for src in ctx.files.srcs:
         out = ctx.actions.declare_file(src.basename + ctx.attr.output_suffix)
-        outputs.append(out)
-        format_map[src] = out
+        updsrcs.append(update_srcs.create(src = src, out = out))
         inputs = [src]
 
         args = ctx.actions.args()
@@ -39,8 +41,8 @@ def _swiftformat_format_impl(ctx):
         )
 
     return [
-        DefaultInfo(files = depset(outputs)),
-        SwiftFormatInfo(format_map = format_map),
+        DefaultInfo(files = depset([updsrc.out for updsrc in updsrcs])),
+        UpdateSrcsInfo(update_srcs = depset(updsrcs)),
     ]
 
 swiftformat_format = rule(
diff --git a/swiftformat/internal/swiftformat_pkg.bzl b/swiftformat/internal/swiftformat_pkg.bzl
@@ -1,7 +1,7 @@
 load(":src_utils.bzl", "src_utils")
 load(":swiftformat_format.bzl", "swiftformat_format")
-load(":swiftformat_update.bzl", "swiftformat_update")
 load("@bazel_skylib//rules:diff_test.bzl", "diff_test")
+load("@cgrindel_rules_updatesrc//updatesrc:updatesrc.bzl", "updatesrc_update")
 
 """A macro which defines targets that format Swift source files, test that 
 they are formatted and copies them to the workspace directory.
@@ -43,7 +43,7 @@ def swiftformat_pkg(name, srcs = None, config = None):
             file2 = ":" + format_name,
         )
 
-    swiftformat_update(
+    updatesrc_update(
         name = name + "_update",
-        formats = format_names,
+        deps = format_names,
     )
diff --git a/swiftformat/internal/swiftformat_update.bzl b/swiftformat/internal/swiftformat_update.bzl
diff --git a/swiftformat/internal/swiftformat_update_all.bzl b/swiftformat/internal/swiftformat_update_all.bzl
diff --git a/swiftformat/swiftformat.bzl b/swiftformat/swiftformat.bzl

Original file line number	Diff line number	Diff line change
`@@ -26,8 +26,6 @@ _RULES_AND_MACROS_DOC_PROVIDER = doc_providers.create(`
`26`	`26`	`"swiftformat_library",`
`27`	`27`	`"swiftformat_pkg",`
`28`	`28`	`"swiftformat_test",`
`29`		`- "swiftformat_update",`
`30`		`- "swiftformat_update_all",`
`31`	`29`	`],`
`32`	`30`	`deps = ["//swiftformat"],`
`33`	`31`	`)`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`load(`
`2`		`- "@cgrindel_rules_swiftformat//swiftformat:swiftformat.bzl",`
`3`		`- "swiftformat_update_all",`
	`2`	`+ "@cgrindel_rules_updatesrc//updatesrc:updatesrc.bzl",`
	`3`	`+ "updatesrc_update_all",`
`4`	`4`	`)`
`5`	`5`
`6`	`6`	`# MARK: - SwiftFormat Targets`
`@@ -11,6 +11,6 @@ exports_files([".swiftformat"])`
`11`	`11`
`12`	`12`	`# Defines a target that will copy all of the formatted Swift source files to`
`13`	`13`	`# the workspace directory.`
`14`		`-swiftformat_update_all(`
	`14`	`+updatesrc_update_all(`
`15`	`15`	`name = "update_all",`
`16`	`16`	`)`