tests/testthat/test_rhymer.R

In rhymer: Wrapper for the 'Datamuse' API to Find Rhyming and Associated Words

library(rhymer)
context("rhymer Tests")

WORD_TO_TEST <- "test"

test_that("get_rhyme returns dataframe of words", {

  rhyme_data <- get_rhyme(WORD_TO_TEST, limit = 10)

  expect_is(rhyme_data, "data.frame")
  expect_equal(nrow(rhyme_data), 10)
  expect_true("best" %in% rhyme_data$word)
  expect_named(rhyme_data, c("word", "score", "numSyllables"))

})

test_that("get_rhyme with syllable argument works", {

  rhyme_data <- get_rhyme(WORD_TO_TEST, limit = 10, num_syl = 3)

  expect_is(rhyme_data, "data.frame")
  expect_equal(nrow(rhyme_data), 10)
  expect_true("budapest" %in% rhyme_data$word)
  expect_named(rhyme_data, c("word", "score", "numSyllables"))
  expect_error(get_rhyme(WORD_TO_TEST, limit = 10, num_syl = 7))

})

test_that("get_means_like returns dataframe of words", {

  means_like_data <- get_means_like(WORD_TO_TEST, limit = 10)

  expect_is(means_like_data, "data.frame")
  expect_equal(nrow(means_like_data), 10)
  expect_true("quiz" %in% means_like_data$word)
  expect_named(means_like_data, c("word", "score", "tags"))

})

test_that("get_sounds_like returns dataframe of words", {

  sounds_like_data <- get_sounds_like(WORD_TO_TEST, limit = 10)

  expect_is(sounds_like_data, "data.frame")
  expect_equal(nrow(sounds_like_data), 10)
  expect_true("tist" %in% sounds_like_data$word)
  expect_named(sounds_like_data, c("word", "score", "numSyllables"))

  sounds_like_data_with_syl <- get_sounds_like("document", limit = 10, num_syl = 3)
  expect_equal(min(sounds_like_data_with_syl$numSyllables), 3)
  expect_equal(max(sounds_like_data_with_syl$numSyllables), 3)
  expect_error(get_sounds_like("Supercalifragilisticexpialidocious", num_syl = 1), "No 1 syllable rhymes")

})

test_that("get_spelled_like returns dataframe of words", {

  spelled_like_data <- get_spelled_like(WORD_TO_TEST, limit = 10)

  expect_is(spelled_like_data, "data.frame")
  expect_equal(nrow(spelled_like_data), 1)
  expect_true("test" %in% spelled_like_data$word)
  expect_named(spelled_like_data, c("word", "score"))

})

test_that("get_other_related returns dataframe of words", {

  other_related_data <- get_other_related(WORD_TO_TEST, code = "spc", limit = 10)

  expect_is(other_related_data, "data.frame")
  expect_equal(nrow(other_related_data), 10)
  expect_true("take" %in% other_related_data$word)
  expect_named(other_related_data, c("word", "score"))
  expect_warning(get_other_related(WORD_TO_TEST, code = "not a real code :)", limit = 10))

})

test_that("datamuse_api errors if response code isn't 200", {
  expect_error(datamuse_api(path = "bad_path"), "Datamuse API request failed")
})

test_that("get_content sends warning if no results", {
  expect_warning(get_content("words?rel_rhy=giberishhh"), "No results found")
})

test_that("return_content returns correct type", {
  expect_is(get_content("words?rel_rhy=test", return_type = "df"), "data.frame")
  expect_is(get_content("words?rel_rhy=test", return_type = "word"), "character")
  expect_is(get_content("words?rel_rhy=test", return_type = "random_word"), "character")
  expect_is(get_content("words?rel_rhy=test", return_type = "rand"), "character")
  expect_is(get_content("words?rel_rhy=test", return_type = "vector"), "character")
  expect_warning(get_content("words?rel_rhy=test", return_type = "invalid_return_type"))
})