tests/testthat/test-cache_attrs.R

In rich-iannone/DiagrammeR: Graph/Network Visualization

# Caching attributes

test_that("Setting a cache is possible", {

  # Create a randomized graph
  graph <-
    create_graph() %>%
    add_gnm_graph(
      n = 10,
      m = 22,
      node_data = node_data(
        value = 1:10),
      set_seed = 23)

  # Get the closeness values (as a data frame) for
  # all nodes from `1` to `10`
  closeness_df <-
    get_closeness(graph)

  # Set the values in the `closeness_df` column
  # `closeness` in the graph's cache
  graph_cache <-
    graph %>%
    set_cache(
      name = "closeness_vector",
      to_cache = closeness_df,
      col = "closeness")

  # Expect that the column `closeness` in the df
  # is equivalent to the values in the cache
  expect_equal(
    closeness_df$closeness,
    graph_cache$cache$closeness_vector)

  # Expect an error if providing a data frame
  # and not specifying a column to extract as a vector
  # or specifying a column that doesn't exist
  expect_snapshot(error = TRUE, {
    set_cache(
      graph = graph,
      name = "closeness_df_2",
      to_cache = closeness_df)

    set_cache(
      graph = graph,
      name = "closeness_df_3",
      to_cache = closeness_df,
      col = "nonexistent")
  })

  # Get the closeness values (as a vector)
  closeness_vec <- closeness_df$closeness

  # Set the values from the `closeness_vec` vector
  # in the graph's cache
  graph_cache_from_vec <-
    graph %>%
    set_cache(
      name = "closeness_vector",
      to_cache = closeness_vec)

  # Expect that the cache (originating from a vector)
  # is equivalent to the `closeness_vec` vector
  expect_equal(
    closeness_vec,
    graph_cache_from_vec$cache$closeness_vector)

  # Set the values in the `closeness_df`
  # column `closeness` in the graph's cache
  # but don't provide a name for the
  # cached object
  graph_cache_no_name <-
    graph %>%
    set_cache(
      to_cache = closeness_df,
      col = "closeness")

  # Expect that an unnamed cache
  # object with no other caches
  # available will have the name `1`
  expect_equal(
    closeness_df$closeness,
    graph_cache_no_name$cache$`1`)

  # Set again the values in the `closeness_df`
  # column `closeness` in the graph's cache
  # and don't provide a name for this
  # second cached object
  graph_cache_no_name_2 <-
    graph_cache_no_name %>%
    set_cache(
      to_cache = closeness_df,
      col = "closeness")

  # Expect two vectors in [graph]$cache
  expect_length(
    graph_cache_no_name_2$cache, 2)
})

test_that("Getting a cache is possible", {

  # Create a randomized graph
  graph <-
    create_graph() %>%
    add_gnm_graph(
      n = 10,
      m = 22,
      node_data = node_data(
        value = 1:10),
      set_seed = 23)

  # Get the closeness values (as a data frame) for
  # all nodes from `1` to `10`
  closeness_df <-
    get_closeness(graph)

  # Set the values in the `closeness_df` column
  # `closeness` in the graph's cache
  graph_cache <-
    graph %>%
    set_cache(
      name = "closeness_vector",
      to_cache = closeness_df,
      col = "closeness")

  # Get the graph's cached values
  cached <-
    get_cache(
      graph = graph_cache,
      name = "closeness_vector")

  # Expect a numeric vector of length 10
  expect_length(cached, 10)
  expect_type(cached, "double")


  # Expect that the cached values in `cached` are
  # equivalent to those in `graph$cache`
  expect_equal(
    cached, graph_cache$cache$closeness_vector)

  # Get the last cached vector
  cached_last <-
    get_cache(
      graph = graph_cache)

  # Expect a numeric vector of length 10
  expect_length(cached_last, 10)
  expect_type(cached_last, "double")

  # Create a new graph
  graph <-
    create_graph() %>%
    add_gnm_graph(
      n = 10,
      m = 22,
      node_data = node_data(
        value = 1:10),
      set_seed = 23)

  # Expect NA when trying to obtain a cache that is
  # not present
  expect_true(is.na(get_cache(graph)))
})