Merge pull request #52 from r-lib/upkeep-2025-04

gaborcsardi · web-flow · commit f945a7334953 · 2025-04-29T14:15:44.000+02:00
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -15,3 +15,5 @@
 ^pkgdown$
 ^LICENSE\.md$
 ^CRAN-SUBMISSION$
+^[\.]?air\.toml$
+^\.vscode$
diff --git a/.github/workflows/R-CMD-check.yaml b/.github/workflows/R-CMD-check.yaml
@@ -8,7 +8,6 @@ on:
   push:
     branches: [main, master]
   pull_request:
-    branches: [main, master]
 
 name: R-CMD-check.yaml
 
@@ -26,7 +25,6 @@ jobs:
         config:
           - {os: macos-latest,   r: 'release'}
 
-          - {os: windows-latest, r: 'devel'}
           - {os: windows-latest, r: 'release'}
           # use 4.0 or 4.1 to check with rtools40's older compiler
           - {os: windows-latest, r: 'oldrel-4'}
diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml
@@ -4,7 +4,6 @@ on:
   push:
     branches: [main, master]
   pull_request:
-    branches: [main, master]
   release:
     types: [published]
   workflow_dispatch:
diff --git a/.github/workflows/test-coverage.yaml b/.github/workflows/test-coverage.yaml
@@ -4,7 +4,6 @@ on:
   push:
     branches: [main, master]
   pull_request:
-    branches: [main, master]
 
 name: test-coverage.yaml
 
@@ -35,14 +34,16 @@ jobs:
             clean = FALSE,
             install_path = file.path(normalizePath(Sys.getenv("RUNNER_TEMP"), winslash = "/"), "package")
           )
+          print(cov)
           covr::to_cobertura(cov)
         shell: Rscript {0}
 
-      - uses: codecov/codecov-action@v4
+      - uses: codecov/codecov-action@v5
         with:
-          fail_ci_if_error: ${{ github.event_name != 'pull_request' && true || false }}
-          file: ./cobertura.xml
-          plugin: noop
+          # Fail if error if not on PR, or if on PR and token is given
+          fail_ci_if_error: ${{ github.event_name != 'pull_request' || secrets.CODECOV_TOKEN }}
+          files: ./cobertura.xml
+          plugins: noop
           disable_search: true
           token: ${{ secrets.CODECOV_TOKEN }}
 
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -0,0 +1,5 @@
+{
+    "recommendations": [
+        "Posit.air-vscode"
+    ]
+}
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,6 @@
+{
+    "[r]": {
+        "editor.formatOnSave": true,
+        "editor.defaultFormatter": "Posit.air-vscode"
+    }
+}
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -3,7 +3,8 @@ Title: Portable File Locking
 Version: 1.0.3.9000
 Authors@R: c(
     person("Gábor", "Csárdi", , "csardi.gabor@gmail.com", role = c("aut", "cre")),
-    person("Posit Software, PBC", role = c("cph", "fnd"))
+    person("Posit Software, PBC", role = c("cph", "fnd"),
+           comment = c(ROR = "03wc8by49"))
   )
 Description: Place an exclusive or shared lock on a file. It uses
     'LockFile' on Windows and 'fcntl' locks on Unix-like systems.
@@ -18,6 +19,7 @@ Suggests:
     testthat (>= 3.0.0)
 Config/Needs/website: tidyverse/tidytemplate
 Config/testthat/edition: 3
+Config/usethis/last-upkeep: 2025-04-29
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
 RoxygenNote: 7.2.3
diff --git a/LICENSE b/LICENSE
@@ -1,2 +1,2 @@
-YEAR: 2023
+YEAR: 2025
 COPYRIGHT HOLDER: filelock authors
diff --git a/LICENSE.md b/LICENSE.md
@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright (c) 2023 filelock authors
+Copyright (c) 2025 filelock authors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/R/assertions.R b/R/assertions.R
@@ -1,4 +1,3 @@
-
 is_string <- function(x) {
   is.character(x) && length(x) == 1 && !is.na(x)
 }
diff --git a/R/package.R b/R/package.R
@@ -1,4 +1,3 @@
-
 #' Advisory File Locking and Unlocking
 #'
 #' There are two kinds of locks, *exclusive* and *shared*, see the
@@ -180,7 +179,8 @@ print.filelock_lock <- function(x, ...) {
   unlocked <- .Call(c_filelock_is_unlocked, x)
   cat(
     if (unlocked) "Unlocked lock on " else "Lock on ",
-    sQuote(x[[2]]), "\n",
+    sQuote(x[[2]]),
+    "\n",
     sep = ""
   )
   invisible(x)
diff --git a/README.Rmd b/README.Rmd
@@ -2,7 +2,10 @@
 output: github_document
 ---
 
-```{r, setup, echo = FALSE, message = FALSE}
+```{r}
+#| label: setup
+#| echo: false
+#| message: false
 knitr::opts_chunk$set(
   comment = "#>",
   tidy = FALSE,
@@ -19,9 +22,8 @@ knitr::opts_chunk$set(
 [![R build status](https://github.com/r-lib/filelock/workflows/R-CMD-check/badge.svg)](https://github.com/r-lib/filelock/actions)
 [![](https://www.r-pkg.org/badges/version/filelock)](https://www.r-pkg.org/pkg/filelock)
 [![CRAN RStudio mirror downloads](https://cranlogs.r-pkg.org/badges/filelock)](https://www.r-pkg.org/pkg/filelock)
-[![Coverage Status](https://img.shields.io/codecov/c/github/r-lib/filelock/main.svg)](https://app.codecov.io/github/r-lib/filelock?branch=main)
-[![Codecov test coverage](https://codecov.io/gh/r-lib/filelock/branch/main/graph/badge.svg)](https://app.codecov.io/gh/r-lib/filelock?branch=main)
 [![R-CMD-check](https://github.com/r-lib/filelock/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/r-lib/filelock/actions/workflows/R-CMD-check.yaml)
+[![Codecov test coverage](https://codecov.io/gh/r-lib/filelock/graph/badge.svg)](https://app.codecov.io/gh/r-lib/filelock)
 <!-- badges: end -->
 
 Place an exclusive or shared lock on a file. It uses `LockFile` on Windows
@@ -31,13 +33,15 @@ and `fcntl` locks on Unix-like systems.
 
 Install the package from CRAN as usual:
 
-```{r eval = FALSE}
+```{r}
+#| eval: false
 install.packages("filelock")
 ```
 
 Install the development version from GitHub:
 
-```{r eval = FALSE}
+```{r}
+#| eval: false
 pak::pak("r-lib/filelock")
 ```
 
diff --git a/README.md b/README.md
@@ -10,11 +10,9 @@ status](https://github.com/r-lib/filelock/workflows/R-CMD-check/badge.svg)](http
 [![](https://www.r-pkg.org/badges/version/filelock)](https://www.r-pkg.org/pkg/filelock)
 [![CRAN RStudio mirror
 downloads](https://cranlogs.r-pkg.org/badges/filelock)](https://www.r-pkg.org/pkg/filelock)
-[![Coverage
-Status](https://img.shields.io/codecov/c/github/r-lib/filelock/main.svg)](https://app.codecov.io/github/r-lib/filelock?branch=main)
-[![Codecov test
-coverage](https://codecov.io/gh/r-lib/filelock/branch/main/graph/badge.svg)](https://app.codecov.io/gh/r-lib/filelock?branch=main)
 [![R-CMD-check](https://github.com/r-lib/filelock/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/r-lib/filelock/actions/workflows/R-CMD-check.yaml)
+[![Codecov test
+coverage](https://codecov.io/gh/r-lib/filelock/graph/badge.svg)](https://app.codecov.io/gh/r-lib/filelock)
 <!-- badges: end -->
 
 Place an exclusive or shared lock on a file. It uses `LockFile` on
@@ -143,27 +141,27 @@ the locks. You can read more about it here:
 
 Some important points:
 
-- The lock is put on a file descriptor, which is kept open, until the
-  lock is released.
-- A process can only have one kind of lock set for a given file.
-- When any file descriptor for that file is closed by the process, all
-  of the locks that process holds on that file are released, even if the
-  locks were made using other descriptors that remain open. Note that in
-  R, using a one-shot function call to modify the file opens and closes
-  a file descriptor to it, so the lock will be released. (This is one of
-  the main reasons for using special lock files, instead of putting the
-  lock on the actual file.)
-- Locks are not inherited by child processes created using fork.
-- For lock requests with finite timeout intervals, we set an alarm, and
-  temporarily install a signal handler for it. R is single threaded, so
-  no other code can be running, while the process is waiting to acquire
-  the lock. The signal handler is restored to its original value
-  immediately after the lock is acquired or the timeout expires. (It is
-  actually restored from the signal handler, so there should be no race
-  conditions here. However, if multiple `SIGALRM` signals are delivered
-  via a single call to the signal handler, then alarms might get lost.
-  Currently base R does not use the `SIGALRM` signal for anything, but
-  other packages might.)
+-   The lock is put on a file descriptor, which is kept open, until the
+    lock is released.
+-   A process can only have one kind of lock set for a given file.
+-   When any file descriptor for that file is closed by the process, all
+    of the locks that process holds on that file are released, even if
+    the locks were made using other descriptors that remain open. Note
+    that in R, using a one-shot function call to modify the file opens
+    and closes a file descriptor to it, so the lock will be released.
+    (This is one of the main reasons for using special lock files,
+    instead of putting the lock on the actual file.)
+-   Locks are not inherited by child processes created using fork.
+-   For lock requests with finite timeout intervals, we set an alarm,
+    and temporarily install a signal handler for it. R is single
+    threaded, so no other code can be running, while the process is
+    waiting to acquire the lock. The signal handler is restored to its
+    original value immediately after the lock is acquired or the timeout
+    expires. (It is actually restored from the signal handler, so there
+    should be no race conditions here. However, if multiple `SIGALRM`
+    signals are delivered via a single call to the signal handler, then
+    alarms might get lost. Currently base R does not use the `SIGALRM`
+    signal for anything, but other packages might.)
 
 ### Internals on Windows:
 
@@ -175,15 +173,16 @@ See more about `LockFileEx` on the first hit here:
 
 Some important points:
 
-- `LockFileEx` locks are mandatory (as opposed to advisory), so indeed
-  no other processes have access to the locked file. Actually, even the
-  locking process has no access to it through a different file handle,
-  than the one used for locking. In general, R cannot read from the
-  locked file, and cannot write to it. (Although, the current R version
-  does not fail, it just does nothing, which is quite puzzling.)
-  Remember, always use a special lock file, instead of putting the lock
-  on the main file, so that you are not affected by these problems.
-- Inherited handles do not provide access to the child process.
+-   `LockFileEx` locks are mandatory (as opposed to advisory), so indeed
+    no other processes have access to the locked file. Actually, even
+    the locking process has no access to it through a different file
+    handle, than the one used for locking. In general, R cannot read
+    from the locked file, and cannot write to it. (Although, the current
+    R version does not fail, it just does nothing, which is quite
+    puzzling.) Remember, always use a special lock file, instead of
+    putting the lock on the main file, so that you are not affected by
+    these problems.
+-   Inherited handles do not provide access to the child process.
 
 ## Code of Conduct
 
diff --git a/air.toml b/air.toml
diff --git a/tests/testthat.R b/tests/testthat.R
@@ -1,4 +1,3 @@
-
 if (Sys.getenv("NOT_CRAN", "") != "") {
   Sys.setenv(R_TESTS = "")
   library(testthat)
diff --git a/tests/testthat/_snaps/test.md b/tests/testthat/_snaps/test.md
@@ -0,0 +1,24 @@
+# Multiple, incompatible lock types
+
+    Code
+      lock(tmp, exclusive = FALSE)
+    Condition
+      Error in `lock()`:
+      ! File already has an exclusive lock
+
+---
+
+    Code
+      lock(tmp, exclusive = TRUE)
+    Condition
+      Error in `lock()`:
+      ! File already has a shared lock
+
+# unlock() needs lock object
+
+    Code
+      unlock(1)
+    Condition
+      Error in `unlock()`:
+      ! `unlock()` needs a lock object, not a file name
+
diff --git a/tests/testthat/test.R b/tests/testthat/test.R
@@ -1,4 +1,3 @@
-
 test_that("can create a shared lock", {
   tmp <- tempfile()
   expect_silent({
@@ -106,7 +105,6 @@ test_that("timeout", {
 })
 
 test_that("timeout 2", {
-
   ## They don't like tests with timings on CRAN
   skip_on_cran()
 
@@ -140,7 +138,6 @@ test_that("timeout 2", {
 })
 
 test_that("wait forever", {
-
   ## Thy don't like tests with timings on CRAN
   skip_on_cran()
 
@@ -278,7 +275,6 @@ test_that("Multiple locks", {
 test_that("Relocking does not affect unlocked locks", {
   tmp <- tempfile()
 
-
   lck <- lock(tmp, exclusive = TRUE)
   lck2 <- lock(tmp, exclusive = TRUE)
   unlock(lck)
@@ -297,11 +293,11 @@ test_that("Relocking does not affect unlocked locks", {
 test_that("Multiple, incompatible lock types", {
   tmp <- tempfile()
   lck <- lock(tmp, exclusive = TRUE)
-  expect_error(lock(tmp, exclusive = FALSE))
+  expect_snapshot(error = TRUE, lock(tmp, exclusive = FALSE))
   unlock(lck)
 
   lck <- lock(tmp, exclusive = FALSE)
-  expect_error(lock(tmp, exclusive = TRUE))
+  expect_snapshot(error = TRUE, lock(tmp, exclusive = TRUE))
   unlock(lck)
 })
 
@@ -334,5 +330,5 @@ test_that("non-exclusive lock with timeout", {
 })
 
 test_that("unlock() needs lock object", {
-  expect_error(unlock(1), "needs a lock object")
+  expect_snapshot(error = TRUE, unlock(1))
 })

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +{
 +    "recommendations": [
 +        "Posit.air-vscode"
 +    ]
 +}
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`		`-YEAR: 2023`
	`1`	`+YEAR: 2025`
`2`	`2`	`COPYRIGHT HOLDER: filelock authors`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-`
`2`	`1`	`is_string <- function(x) {`
`3`	`2`	`is.character(x) && length(x) == 1 && !is.na(x)`
`4`	`3`	`}`