Skip to content

Commit 1516d32

Browse files
prep for release
1 parent 640fce6 commit 1516d32

27 files changed

+102
-75
lines changed

DESCRIPTION

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
11
Package: testthis
22
Type: Package
33
Title: Utils and 'RStudio' Addins to Make Testing Even More Fun
4-
Version: 1.0.4.9006
4+
Version: 1.1.0
55
Authors@R: person("Stefan", "Fleck", email = "[email protected]", role = c("aut", "cre"))
66
Maintainer: Stefan Fleck <[email protected]>
77
Description:
8-
Utility functions and 'RStudio' addins to ease the life of people using
9-
'testthat', 'devtools' and 'usethis' in their package development workflow.
10-
Hotkeyable addins are provided for such common tasks as switching between a
11-
source file and an associated test file, or running unit tests in a single
12-
file. 'testthis' also provides utility function to manage and run tests in
8+
Utility functions and 'RStudio' addins for writing, running and organizing
9+
automated tests. Integrates tightly with the packages 'testthat', 'devtools'
10+
and 'usethis'.
11+
Hotkeys can be assigned to the 'RStudio' addins for running tests in a single
12+
file or to switch between a source file and the associated test file. In
13+
addition, testthis provides function to manage and run tests in
1314
subdirectories of the test/testthat directory.
1415
License: MIT + file LICENSE
1516
Imports:

NEWS.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,15 @@
1919
* Import `parse_ns_file()` from pkgload instead of devtools
2020
* #* @testfile tag paths can now contain the script file extension `.R`
2121
* removed deprecated `lest_this()` function
22-
* various small bugfixes and improvements
22+
* various small bug fixes and improvements
2323

2424

2525

2626
# testthis 1.0.3
2727

2828
* Maintenance release to make vignette comply with new CRAN guidelines
2929
* test (`test_this()`, `test_subdir()`, etc..) functions now save all files in
30-
Rstudio and reload the package before running tests.
30+
RStudio and reload the package before running tests.
3131
* `lest_this()` has been deprecated. `test_this()` now behaves like
3232
`lest_this()`
3333

@@ -38,7 +38,7 @@
3838

3939
* added `test_all()` to run tests in all subdirectories
4040
* Use `usethis::proj_get()` instead of the `base_path` function argument for
41-
compatbility with usethis.
41+
compatibility with usethis.
4242

4343

4444

@@ -56,8 +56,8 @@
5656
# testthis 1.0.0
5757

5858
* Reworked an expanded infrastructure functions, such as `use_testdata()` and
59-
`use_test_subdir()`. See readme for details.
60-
* `test_skeleton()` now honours the `#* @testfile` tag
59+
`use_test_subdir()`. See README for details.
60+
* `test_skeleton()` now honors the `#* @testfile` tag
6161
* `open_test()` can now jump back and forth between source and test file, and
6262
does no longer automatically create test files.
6363
* testthis now depends on the new usethis package that replaces some of the

R/test_coverage.R

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
#'
33
#' This determines the test coverage of the target package based on the `desc`
44
#' argument of `test_that()` calls. If you require a more comprehensive analysis
5-
#' of thest coverage, try the package **covr** instead.
5+
#' of test coverage, try the package **covr** instead.
66
#'
77
#' `test_coverage` looks in `.covrignore` for functions that should be ignored
88
#' for coverage analysis (see [usethis::use_covr_ignore()])
@@ -12,7 +12,7 @@
1212
#' in any of your test files, myfunction will be marked as tested.
1313
#' @param from_desc `logical` scalar. Checks the `desc` argument
1414
#' `test_that(...)` of the tests in your test directory for functions
15-
#' names. E.g. if you have a testfile that contains
15+
#' names. E.g. if you have a test file that contains
1616
#' `test_that("myfunction works", {...})`, myfunction will be marked as
1717
#' tested.
1818
#'
@@ -63,7 +63,7 @@ test_coverage <- function(
6363

6464
#' Get Test Coverage
6565
#'
66-
#' Deprecated in favour of [test_coverage()]
66+
#' Deprecated in favor of [test_coverage()]
6767
#' @param from_tags,from_desc see [test_coverage()]
6868
#'
6969
#' @export

R/testthis-package.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,13 +39,13 @@
3939
#'
4040
#' @section Testthis Tags:
4141
#'
42-
#' Test_this tags are special comments that modify the behavious of the
42+
#' test_this tags are special comments that modify the behaviour of the
4343
#' functions supplied by this package. They are of the form `#* @tag <value>`.
4444
#' Please not that only some test_this tags really require a `<value>`.
4545
#'
4646
#' **Valid tags for script files in the /R/ dir (`pkg/R/*.R`)**
4747
#'
48-
#' * `@testfile <filename>`: manually specifiy associated test file. Should
48+
#' * `@testfile <filename>`: manually specify associated test file. Should
4949
#' usually start with `test_`. This is used by `test_this()`, `lest_this()` and
5050
#' `open_testfile()`.
5151
#'

README.Rmd

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -26,20 +26,20 @@ assigned them to hotkeys RStudio (*Tools/Modify Keyboard Shortcuts*).
2626

2727
* `test_this()`: Reloads the package and runs tests associated with the
2828
currently open R script file.
29-
* `open_testfile()`: Opens the associated testfile in an editor window. If the
30-
currently open file already is a testfile, it opens the associated file in
29+
* `open_testfile()`: Opens the associated test file in an editor window. If the
30+
currently open file already is a test file, it opens the associated file in
3131
the `/R` directory. Can be used to jump back and forth between both.
3232

3333
The *associated test file* for a file `R/foo.R` is usually
34-
`/tests/testhat/test_foo.R` (or `test-foo.R`). You can modify this behaviour by
34+
`/tests/testhat/test_foo.R` (or `test-foo.R`). You can modify this behavior by
3535
putting the comment `#* @testfile anotherfile` anywhere in `R/foo.R`.
3636

3737

3838
testthis also provides functions for managing tests in subdirectories of
3939
`tests/testthat`:
4040

4141
* `use_testdata()` places a single R object in the `tests/testhat/testdata`
42-
directory. It is analoguous to `usethis::use_data()`, except that it saves the
42+
directory. It is analogous to `usethis::use_data()`, except that it saves the
4343
object in the `.rds` format, which is more appropriate for single R objects
4444
than `.rda` or `.Rdata` (see `?readRDS`).
4545
* `use_testdata_raw()` creates the directory `tests/testhat/testdata-raw`. Use
@@ -50,8 +50,8 @@ testthis also provides functions for managing tests in subdirectories of
5050
* `use_test_subdir()` and `test_subdir()` for putting/running tests in
5151
subdirectories of `tests/testhat/`. These tests will *not* be run on CRAN or
5252
by `devtools::test()`. This is useful for tests that take a long time to
53-
execute, or that require external ressources (web, databases) that may not
54-
always be availabe.
53+
execute, or that require external resources (web, databases) that may not
54+
always be available.
5555

5656
`test_acceptance()`, `test_manual()` and
5757
`test_integration()` are presets to run tests in the
@@ -63,7 +63,7 @@ Testthis also provides some simple code analysis tools
6363

6464
* `test_coverage()` lists all functions of package and shows whether they
6565
are mentioned in any `test_that()` calls' desc argument; e.g. if you have
66-
a testfile containing `test_that("testing that function foo works", <...>)`,
66+
a test file containing `test_that("testing that function foo works", <...>)`,
6767
`foo()` will show up marked as tested. This can be used as a simple todo list
6868
for testing, but does not replace a proper test coverage analyzer like
6969
[covr](https://github.com/r-lib/covr).
@@ -93,7 +93,7 @@ library(testthis)
9393
```
9494

9595

96-
Rstudio addins (can be assigned to hotkeys):
96+
RStudio addins (can be assigned to hotkeys):
9797

9898
```{r, eval = FALSE}
9999
open_testfile()

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -25,21 +25,21 @@ Shortcuts*).
2525

2626
- `test_this()`: Reloads the package and runs tests associated with
2727
the currently open R script file.
28-
- `open_testfile()`: Opens the associated testfile in an editor
29-
window. If the currently open file already is a testfile, it opens
28+
- `open_testfile()`: Opens the associated test file in an editor
29+
window. If the currently open file already is a test file, it opens
3030
the associated file in the `/R` directory. Can be used to jump back
3131
and forth between both.
3232

3333
The *associated test file* for a file `R/foo.R` is usually
3434
`/tests/testhat/test_foo.R` (or `test-foo.R`). You can modify this
35-
behaviour by putting the comment `#* @testfile anotherfile` anywhere in
35+
behavior by putting the comment `#* @testfile anotherfile` anywhere in
3636
`R/foo.R`.
3737

3838
testthis also provides functions for managing tests in subdirectories of
3939
`tests/testthat`:
4040

4141
- `use_testdata()` places a single R object in the
42-
`tests/testhat/testdata` directory. It is analoguous to
42+
`tests/testhat/testdata` directory. It is analogous to
4343
`usethis::use_data()`, except that it saves the object in the `.rds`
4444
format, which is more appropriate for single R objects than `.rda`
4545
or `.Rdata` (see `?readRDS`).
@@ -54,8 +54,8 @@ testthis also provides functions for managing tests in subdirectories of
5454
- `use_test_subdir()` and `test_subdir()` for putting/running tests in
5555
subdirectories of `tests/testhat/`. These tests will *not* be run on
5656
CRAN or by `devtools::test()`. This is useful for tests that take a
57-
long time to execute, or that require external ressources (web,
58-
databases) that may not always be availabe.
57+
long time to execute, or that require external resources (web,
58+
databases) that may not always be available.
5959

6060
`test_acceptance()`, `test_manual()` and `test_integration()` are
6161
presets to run tests in the `integration_tests`, `acceptance_tests`
@@ -65,7 +65,7 @@ Testthis also provides some simple code analysis tools
6565

6666
- `test_coverage()` lists all functions of package and shows whether
6767
they are mentioned in any `test_that()` calls’ desc argument;
68-
e.g. if you have a testfile containing `test_that("testing that
68+
e.g. if you have a test file containing `test_that("testing that
6969
function foo works", <...>)`, `foo()` will show up marked as tested.
7070
This can be used as a simple todo list for testing, but does not
7171
replace a proper test coverage analyzer like
@@ -91,7 +91,7 @@ reference](https://s-fleck.github.io/testthis/reference/index.html)
9191
library(testthis)
9292
```
9393

94-
Rstudio addins (can be assigned to hotkeys):
94+
RStudio addins (can be assigned to hotkeys):
9595

9696
``` r
9797
open_testfile()

cran-comments.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
## Test environments
2-
* local ubuntu 17.10 install, R 3.4.3
2+
* local ubuntu 16.04 install, R 3.5.3
3+
* local ubuntu 18.10 install, R 3.6.0
34
* win-builder (devel and release)
5+
* rhub::check_for_cran
46

57
## R CMD check results
68

@@ -12,8 +14,7 @@ None
1214

1315
## Notes
1416

15-
The last submission attempt accidentaly included some temporary fles
16-
from checking reverse dependences wth `devtools::revdep_check()`. I must have
17-
created them in the last stage of the submission process, sorry.
17+
Ironed out a few old bugs, added some new functionality and improved
18+
documentation
1819

1920
---

docs/LICENSE-text.html

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/authors.html

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/index.html

Lines changed: 12 additions & 11 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)