Merge pull request #12 from quanteda/Add-lint-spell

Add linting and spell-checking tests

.Rbuildignore

@@ -10,3 +10,6 @@ languages_by_source.xlsx
 ^CNAME$
 ^_pkgdown\.yml$
 ^css/
+^images/
+^pkgdown/
+^\.lintr$

.lintr

@@ -0,0 +1,4 @@
+linters: with_defaults(
+    line_length_linter(100),
+    NULL
+  )

.travis.yml

@@ -4,5 +4,9 @@ language: R
 sudo: false
 cache: packages
 
+env:
+  global:
+    - LINTR_COMMENT_BOT=false
+
 after_success:
     - Rscript -e 'covr::codecov()'

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: stopwords
 Type: Package
 Title: Multilingual Stopword Lists
-Version: 0.9.0
+Version: 0.9.9000
 Authors@R: c(person("Kenneth", "Benoit", email = "kbenoit@lse.ac.uk", role = "aut"),
     person("David", "Muhr", email = "muhrdavid+github@gmail.com", role = c("aut", "cre")), 
     person("Kohei", "Watanabe", email = "watanabe.kohei@gmail.com", role = "aut"))
@@ -12,12 +12,15 @@ Depends:
 Imports:
     ISOcodes
 Suggests: 
+    covr,
+    lintr,
     quanteda,
-    testthat,
-    covr
+    spelling,
+    testthat
 URL: https://github.com/davnn/stopwords
 BugReports: https://github.com/davnn/stopwords/issues
 Encoding: UTF-8
 LazyData: true
+Language: en-GB
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 6.0.1
+RoxygenNote: 6.1.1

README.Rmd

@@ -13,7 +13,7 @@ knitr::opts_chunk$set(
 # stopwords: the R package
 
 [![CRAN Version](https://www.r-pkg.org/badges/version/stopwords)](https://CRAN.R-project.org/package=stopwords)
-[![Travis-CI Build Status](https://travis-ci.org/davnn/stopwords.svg?branch=master)](https://travis-ci.org/davnn/stopwords)
+[![Travis-CI Build Status](https://travis-ci.org/quanteda/stopwords.svg?branch=master)](https://travis-ci.org/quanteda/stopwords)
 [![Coverage status](https://codecov.io/gh/davnn/stopwords/branch/master/graph/badge.svg)](https://codecov.io/github/davnn/stopwords?branch=master)
 [![Downloads](https://cranlogs.r-pkg.org/badges/stopwords)](https://CRAN.R-project.org/package=stopwords)
 [![Total Downloads](https://cranlogs.r-pkg.org/badges/grand-total/stopwords?color=orange)](https://CRAN.R-project.org/package=stopwords)

README.md

@@ -4,7 +4,7 @@
 [![CRAN
 Version](https://www.r-pkg.org/badges/version/stopwords)](https://CRAN.R-project.org/package=stopwords)
 [![Travis-CI Build
-Status](https://travis-ci.org/davnn/stopwords.svg?branch=master)](https://travis-ci.org/davnn/stopwords)
+Status](https://travis-ci.org/quanteda/stopwords.svg?branch=master)](https://travis-ci.org/quanteda/stopwords)
 [![Coverage
 status](https://codecov.io/gh/davnn/stopwords/branch/master/graph/badge.svg)](https://codecov.io/github/davnn/stopwords?branch=master)
 [![Downloads](https://cranlogs.r-pkg.org/badges/stopwords)](https://CRAN.R-project.org/package=stopwords)

inst/WORDLIST

@@ -0,0 +1,52 @@
+af
+ar
+bg
+Bhogayata
+bn
+br
+Chandrakant
+com
+cs
+el
+eo
+es
+eu
+fi
+ga
+github
+gl
+gu
+Hausa
+hr
+hu
+hy
+iso
+ja
+ko
+ku
+lt
+lv
+mr
+nl
+NLP
+pl
+Rcv
+ro
+ru
+Schwemmer
+sk
+sl
+st
+stemmer
+stemmer's
+stopword
+Stopword
+sv
+sw
+th
+tl
+tr
+uk
+ur
+zh
+zu

tests/lint.R

@@ -0,0 +1,7 @@
+library("lintr")
+library("testthat")
+
+context("lints")
+test_that("Package Style", {
+    lintr::expect_lint_free()
+})

tests/spelling.R

@@ -0,0 +1,5 @@
+if (requireNamespace("spelling", quietly = TRUE)) {
+    # regular package check
+    spelling::spell_check_test(vignettes = TRUE, error = TRUE,
+                               skip_on_cran = TRUE)
+}

tests/testthat/test-stopwords.R

@@ -1,10 +1,10 @@
 context("test-stopwords.R")
 
 # Helper
-createTestData <- function(sourceData, sourceName) {
-  testData <- lapply(names(sourceData), function(x) stopwords(x, source = sourceName))
-  names(testData) <- names(sourceData)
-  testData
+create_test_data <- function(source_data, source_name) {
+  test_data <- lapply(names(source_data), function(x) stopwords(x, source = source_name))
+  names(test_data) <- names(source_data)
+  test_data
 }
 
 # Sources
@@ -14,23 +14,23 @@ misc <- stopwords::data_stopwords_misc
 smart <- stopwords::data_stopwords_smart
 
 test_that("all languages work for source: Snowball", {
-  testData <- createTestData(snowball, "snowball")
-  expect_equal(snowball, testData)
+  test_data <- create_test_data(snowball, "snowball")
+  expect_equal(snowball, test_data)
 })
 
 test_that("all languages work for source: Stopwords-ISO", {
-  testData <- createTestData(stopwordsiso, "stopwords-iso")
-  expect_equal(stopwordsiso, testData)
+  test_data <- create_test_data(stopwordsiso, "stopwords-iso")
+  expect_equal(stopwordsiso, test_data)
 })
 
 test_that("all languages work for source: Misc", {
-  testData <- createTestData(misc, "misc")
-  expect_equal(misc, testData)
+  test_data <- create_test_data(misc, "misc")
+  expect_equal(misc, test_data)
 })
 
 test_that("all languages work for source: Smart", {
-  testData <- createTestData(smart, "smart")
-  expect_equal(smart, testData)
+  test_data <- create_test_data(smart, "smart")
+  expect_equal(smart, test_data)
 })
 
 test_that("full name language returns same values", {

tests/testthat/test-stopwords_getsources.R

@@ -1,6 +1,6 @@
 context("stopwords_getsources")
 
 test_that("returns all source names", {
-  sourceNames <- names(getOption("stopwords_sources"))
-  expect_equal(sourceNames, stopwords_getsources())
+  source_names <- names(getOption("stopwords_sources"))
+  expect_equal(source_names, stopwords_getsources())
 })