Upkeep 2023 (#399)

* Use `test_path()`

* `usethis::use_readme_rmd()`

* `usethis::use_tidy_style()`

* `usethis::use_package_doc()`

* Align the names of `R/` and `/test` files

* Remove `context()`

* Replace `expect_is()` by `expect_s3_class()`

* Replace `expect_that()`

* Use `expect_type()` in two places

* Replace `expect_equivalent()`

* Replace `expect_output()` by snapshots

* Brace test

* `usethis::use_tidy_dependencies()`

* `usethis::use_tidy_github_actions()`

* Bump R to 3.6

* `usethis::use_tidy_coc()`

* `devtools::document()`

* Use standalone type check

* Replace `stop()` by `abort()`

* Add files to Collate

Author: mgirlich

.Rbuildignore

@@ -23,3 +23,4 @@ windows
 \.o$
 \.so$
 ^CRAN-SUBMISSION$
+^README\.Rmd$

.github/CODE_OF_CONDUCT.md

@@ -1,25 +1,126 @@
-# Contributor Code of Conduct
+# Contributor Covenant Code of Conduct
 
-As contributors and maintainers of this project, we pledge to respect all people who 
-contribute through reporting issues, posting feature requests, updating documentation,
-submitting pull requests or patches, and other activities.
+## Our Pledge
 
-We are committed to making participation in this project a harassment-free experience for
-everyone, regardless of level of experience, gender, gender identity and expression,
-sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
 
-Examples of unacceptable behavior by participants include the use of sexual language or
-imagery, derogatory comments or personal attacks, trolling, public or private harassment,
-insults, or other unprofessional conduct.
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
 
-Project maintainers have the right and responsibility to remove, edit, or reject comments,
-commits, code, wiki edits, issues, and other contributions that are not aligned to this 
-Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed 
-from the project team.
+## Our Standards
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by 
-opening an issue or contacting one or more of the project maintainers.
+Examples of behavior that contributes to a positive environment for our
+community include:
 
-This Code of Conduct is adapted from the Contributor Covenant 
-(https://www.contributor-covenant.org), version 1.0.0, available at 
-https://contributor-covenant.org/version/1/0/0/.
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at [email protected]. 
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+<https://www.contributor-covenant.org/version/2/1/code_of_conduct.html>.
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][https://github.com/mozilla/inclusion].
+
+For answers to common questions about this code of conduct, see the FAQ at
+<https://www.contributor-covenant.org/faq>. Translations are available at <https://www.contributor-covenant.org/translations>.
+
+[homepage]: https://www.contributor-covenant.org

.github/workflows/R-CMD-check.yaml

@@ -22,14 +22,14 @@ jobs:
       fail-fast: false
       matrix:
         config:
-          - {os: macOS-latest,   r: 'release'}
-          - {os: macOS-12,   r: 'release'}
+          - {os: macos-latest,   r: 'release'}
 
           - {os: windows-latest, r: 'release'}
-          - {os: windows-latest, r: '4.1'}
+          # Use 3.6 to trigger usage of RTools35
           - {os: windows-latest, r: '3.6'}
+          # use 4.1 to check with rtools40's older compiler
+          - {os: windows-latest, r: '4.1'}
 
-          # Use older ubuntu to maximise backward compatibility
           - {os: ubuntu-latest,   r: 'devel', http-user-agent: 'release'}
           - {os: ubuntu-latest,   r: 'release'}
           - {os: ubuntu-latest,   r: 'oldrel-1'}

.github/workflows/pkgdown.yaml

@@ -19,8 +19,10 @@ jobs:
       group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }}
     env:
       GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+    permissions:
+      contents: write
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - uses: r-lib/actions/setup-pandoc@v2
 
@@ -39,7 +41,7 @@ jobs:
 
       - name: Deploy to GitHub pages 🚀
         if: github.event_name != 'pull_request'
-        uses: JamesIves/[email protected].4
+        uses: JamesIves/github-pages-deploy-action@v4.4.1
         with:
           clean: false
           branch: gh-pages

.github/workflows/pr-commands.yaml

@@ -14,7 +14,7 @@ jobs:
     env:
       GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - uses: r-lib/actions/pr-fetch@v2
         with:
@@ -51,7 +51,7 @@ jobs:
     env:
       GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - uses: r-lib/actions/pr-fetch@v2
         with:

.github/workflows/test-coverage.yaml

@@ -15,7 +15,7 @@ jobs:
       GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - uses: r-lib/actions/setup-r@v2
         with:
@@ -27,5 +27,24 @@ jobs:
           needs: coverage
 
       - name: Test coverage
-        run: covr::codecov(quiet = FALSE)
+        run: |
+          covr::codecov(
+            quiet = FALSE,
+            clean = FALSE,
+            install_path = file.path(Sys.getenv("RUNNER_TEMP"), "package")
+          )
         shell: Rscript {0}
+
+      - name: Show testthat output
+        if: always()
+        run: |
+          ## --------------------------------------------------------------------
+          find ${{ runner.temp }}/package -name 'testthat.Rout*' -exec cat '{}' \; || true
+        shell: bash
+
+      - name: Upload test results
+        if: failure()
+        uses: actions/upload-artifact@v3
+        with:
+          name: coverage-test-failures
+          path: ${{ runner.temp }}/package

DESCRIPTION

@@ -15,9 +15,14 @@ License: MIT + file LICENSE
 URL: https://xml2.r-lib.org/, https://github.com/r-lib/xml2
 BugReports: https://github.com/r-lib/xml2/issues
 Depends:
-    R (>= 3.1.0)
+    R (>= 3.6.0)
 Imports:
-    methods
+    cli,
+    glue,
+    lifecycle,
+    methods,
+    rlang (>= 1.1.0),
+    withr
 Suggests:
     covr,
     curl,
@@ -26,7 +31,7 @@ Suggests:
     magrittr,
     mockery,
     rmarkdown,
-    testthat (>= 2.1.0)
+    testthat (>= 3.0.0)
 VignetteBuilder: 
     knitr
 Config/Needs/website: tidyverse/tidytemplate
@@ -40,15 +45,25 @@ Collate:
     'xml_parse.R'
     'as_xml_document.R'
     'classes.R'
+    'format.R'
+    'import-standalone-obj-type.R'
+    'import-standalone-purrr.R'
+    'import-standalone-types-check.R'
     'init.R'
+    'nodeset_apply.R'
     'paths.R'
     'utils.R'
+    'xml2-package.R'
     'xml_attr.R'
     'xml_children.R'
+    'xml_document.R'
     'xml_find.R'
+    'xml_missing.R'
     'xml_modify.R'
     'xml_name.R'
     'xml_namespaces.R'
+    'xml_node.R'
+    'xml_nodeset.R'
     'xml_path.R'
     'xml_schema.R'
     'xml_serialize.R'
@@ -58,3 +73,4 @@ Collate:
     'xml_url.R'
     'xml_write.R'
     'zzz.R'
+Config/testthat/edition: 3

NAMESPACE

@@ -212,5 +212,8 @@ exportClasses(xml_document)
 exportClasses(xml_missing)
 exportClasses(xml_node)
 exportClasses(xml_nodeset)
+import(rlang)
+importFrom(glue,glue)
+importFrom(lifecycle,deprecated)
 importFrom(methods,setOldClass)
 useDynLib(xml2, .registration = TRUE)

R/as_list.R

@@ -52,10 +52,12 @@ as_list.xml_node <- function(x, ns = character(), ...) {
     # Base case - contents
     type <- xml_type(x)
 
-    if (type %in% c("text", "cdata"))
+    if (type %in% c("text", "cdata")) {
       return(xml_text(x))
-    if (type != "element" && type != "document")
+    }
+    if (type != "element" && type != "document") {
       return(paste("[", type, "]"))
+    }
 
     out <- list()
   } else {

R/as_xml_document.R

@@ -10,16 +10,17 @@
 #' @export
 #' @examples
 # empty lists generate empty nodes
-#'as_xml_document(list(x = list()))
+#' as_xml_document(list(x = list()))
 #'
-#'# Nesting multiple nodes
-#'as_xml_document(list(foo = list(bar = list(baz = list()))))
+#' # Nesting multiple nodes
+#' as_xml_document(list(foo = list(bar = list(baz = list()))))
 #'
-#'# attributes are stored as R attributes
-#'as_xml_document(list(foo = structure(list(), id = "a")))
-#'as_xml_document(list(foo = list(
-#'      bar = structure(list(), id = "a"),
-#'      bar = structure(list(), id = "b"))))
+#' # attributes are stored as R attributes
+#' as_xml_document(list(foo = structure(list(), id = "a")))
+#' as_xml_document(list(foo = list(
+#'   bar = structure(list(), id = "a"),
+#'   bar = structure(list(), id = "b")
+#' )))
 as_xml_document <- function(x, ...) {
   UseMethod("as_xml_document")
 }
@@ -39,7 +40,7 @@ as_xml_document.response <- read_xml.response
 #' @export
 as_xml_document.list <- function(x, ...) {
   if (length(x) > 1) {
-    stop("Root nodes must be of length 1", call. = FALSE)
+    abort("Root nodes must be of length 1")
   }