tests/testthat/test.workbook.cellstyles.R

In XLConnect: Excel Connector for R

context("Workbook Cell Style Functionality")


test_that("Basic cell style operations (create, exists, get) work as expected", {
  skip_if_not(getOption("FULL.TEST.SUITE"), "FULL.TEST.SUITE is not TRUE for cellstyle tests")

  file.xls <- withr::local_tempfile(fileext = ".xls")
  file.xlsx <- withr::local_tempfile(fileext = ".xlsx")

  wb.xls <- loadWorkbook(file.xls, create = TRUE)
  wb.xlsx <- loadWorkbook(file.xlsx, create = TRUE)

  styleName <- "MyStyle"

  # Check that a cell style which hasn't been created yet does not exist
  expect_false(existsCellStyle(wb.xls, styleName))
  expect_false(existsCellStyle(wb.xlsx, styleName))

  # Using getCellStyle is expected to through an exception
  expect_error(getCellStyle(wb.xls, styleName), "IllegalArgumentException", info = "XLS: Getting non-existent style")
  expect_error(getCellStyle(wb.xlsx, styleName), "IllegalArgumentException", info = "XLSX: Getting non-existent style")

  # Check that a cell style can be created
  createCellStyle(wb.xls, styleName)
  createCellStyle(wb.xlsx, styleName)

  # Check that a cell style which has been created exists
  expect_true(existsCellStyle(wb.xls, styleName), info = "XLS: Style should exist after creation")
  expect_true(existsCellStyle(wb.xlsx, styleName), info = "XLSX: Style should exist after creation")

  # Attempting to create a cell style which already exists is expected
  # to throw an exception
  expect_error(createCellStyle(wb.xls, styleName), "IllegalArgumentException", info = "XLS: Creating existing style")
  expect_error(createCellStyle(wb.xlsx, styleName), "IllegalArgumentException", info = "XLSX: Creating existing style")

  # Check that a cell style which has been created can be retrieved
  cs_xls <- getCellStyle(wb.xls, styleName)
  expect_true(is(cs_xls, "cellstyle"), info = "XLS: getCellStyle should return a cellstyle object")
  cs_xlsx <- getCellStyle(wb.xlsx, styleName)
  expect_true(is(cs_xlsx, "cellstyle"), info = "XLSX: getCellStyle should return a cellstyle object")
})

test_that("getOrCreateCellStyle works as expected", {
  skip_if_not(getOption("FULL.TEST.SUITE"), "FULL.TEST.SUITE is not TRUE for cellstyle tests")

  file.xls <- withr::local_tempfile(fileext = ".xls")
  file.xlsx <- withr::local_tempfile(fileext = ".xlsx")

  wb.xls <- loadWorkbook(file.xls, create = TRUE)
  wb.xlsx <- loadWorkbook(file.xlsx, create = TRUE)

  anotherStyleName <- "MyOtherStyle"

  # Check creation and retrieval of cell styles using getOrCreateCellStyle
  expect_false(existsCellStyle(wb.xls, anotherStyleName))
  expect_false(existsCellStyle(wb.xlsx, anotherStyleName))

  cs_xls_new <- getOrCreateCellStyle(wb.xls, anotherStyleName)
  expect_true(is(cs_xls_new, "cellstyle"), info = "XLS: getOrCreate (new) should return cellstyle")
  cs_xlsx_new <- getOrCreateCellStyle(wb.xlsx, anotherStyleName)
  expect_true(is(cs_xlsx_new, "cellstyle"), info = "XLSX: getOrCreate (new) should return cellstyle")

  expect_true(existsCellStyle(wb.xls, anotherStyleName), info = "XLS: Style should exist after getOrCreate (new)")
  expect_true(existsCellStyle(wb.xlsx, anotherStyleName), info = "XLSX: Style should exist after getOrCreate (new)")

  cs_xls_existing <- getOrCreateCellStyle(wb.xls, anotherStyleName)
  expect_true(is(cs_xls_existing, "cellstyle"), info = "XLS: getOrCreate (existing) should return cellstyle")
  cs_xlsx_existing <- getOrCreateCellStyle(wb.xlsx, anotherStyleName)
  expect_true(is(cs_xlsx_existing, "cellstyle"), info = "XLSX: getOrCreate (existing) should return cellstyle")
})