tests/testthat/test-set-main-contributors.R

In plume: A Simple Author Handler for Scientific Writing

test_that("ranking contributors makes a `contributor_rank` column", {
  aut <- Plume$new(basic_df)
  aut$set_main_contributors(1, .roles = "analysis")

  expect_named(
    aut$get_plume()$role[[1]],
    c("role", "contributor_rank")
  )
})

test_that("set_main_contributors() ranks contributors", {
  aut <- Plume$new(basic_df)
  aut$set_main_contributors(2, 3, .roles = "analysis")

  expect_equal(
    pull_nested_var(aut, "role", "contributor_rank"),
    c(3, NA, 1, NA, 2, NA)
  )
})

test_that("`.roles` applies to any unnamed expression (#65)", {
  aut <- Plume$new(data.frame(
    given_name = LETTERS[1:3],
    family_name = LETTERS[1:3],
    analysis = 1,
    writing = 1
  ))

  aut$set_main_contributors(analysis = 3, 2, 3, .roles = "writing")
  expect_equal(
    pull_nested_var(aut, "role", "contributor_rank"),
    c(2, 3, 2, 1, 1, 2)
  )

  aut$set_main_contributors(analysis = 3, 2, 3, .roles = c(writing = "foo"))
  expect_equal(
    pull_nested_var(aut, "role", "contributor_rank"),
    c(2, 3, 2, 1, 1, 2)
  )
})

test_that("named expressions have the priority over `.roles`", {
  aut <- Plume$new(basic_df)
  aut$set_main_contributors(analysis = 3, 2, .roles = "analysis")

  expect_equal(
    pull_nested_var(aut, "role", "contributor_rank"),
    c(2, NA, 2, NA, 1, NA)
  )
})

# Errors ----

test_that("set_ranks() gives meaningful error messages", {
  aut <- Plume$new(basic_df)

  expect_snapshot({
    (expect_error(aut$set_main_contributors()))
    (expect_error(aut$set_main_contributors(1, .roles = 1)))
    (expect_error(aut$set_main_contributors(1, .roles = c("x", "x"))))
    (expect_error(aut$set_main_contributors(1, .by = 1)))
  })
})