Skip to content

Commit

Permalink
Fix #43: compilation checks
Browse files Browse the repository at this point in the history
including UBSAN, rchk, rcnst, and valgrind
  • Loading branch information
brodieG committed Sep 14, 2017
2 parents cc581b1 + 644b7bc commit 7060fb3
Show file tree
Hide file tree
Showing 26 changed files with 781 additions and 619 deletions.
14 changes: 10 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Contributing to `vetr`
# Contributing

Thank you for your interest in contributing to `vetr`. To make sure you do not
waste your time or mine, please read and follow the guidelines here.
Thank you for your interest in contributing to this package. To make sure you
do not waste your time or mine, please read and follow the guidelines here.

## Reporting Issues

Expand All @@ -26,7 +26,7 @@ creates a maintenance burden that I might not be willing to take on.

I realize the requirements I lay out here are annoying. If they prevent you
from making a contribution I am sorry and sympathize, having been on the
opposite side of such requirements myself. Nonetheless The requirements stand
opposite side of such requirements myself. Nonetheless the requirements stand
to ensure your contribution does not end up creating more work than it
saves.

Expand Down Expand Up @@ -55,3 +55,9 @@ Suggested:
* object.name
* FormalClassName
* formalMethodName()

## Thank You!

For taking the time to read these contribution guidelines. I apologize if they
seem a little hostile, but time, yours and mine, is precious and it would be a
shame to waste any of it.
11 changes: 11 additions & 0 deletions CRAN.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
## Submission Checklist

* Review CRAN policy
* Check version
* Run tests with
* winbuilder
* valgrind
* rchk
* Check coverage


## Submission Notes:

This is a new package submission.
Expand Down
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Title: Trust, but Verify
Description: Declarative template-based framework for verifying that objects
meet structural requirements, and auto-composing error messages when they do
not.
Version: 0.1.0.9007
Version: 0.1.0.9008
Authors@R: c(
person("Brodie", "Gaslam", email="brodie.gaslam@yahoo.com",
role=c("aut", "cre")),
Expand Down
48 changes: 25 additions & 23 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,32 @@
## 0.2.0

* [#48](https://github.com/brodieG/validate/issues/48): Implement `all_bw`, a
* [#43](https://github.com/brodieG/vetr/issues/43): Fix rchck, rcnst, UBSAN,
valgrind (ht @kalibera).
* [#48](https://github.com/brodieG/vetr/issues/48): Implement `all_bw`, a
more efficient version of `!anyNA(.) && all(. < x) && all(. > y)`.
* [#65](https://github.com/brodieG/validate/issues/65)
[#51](https://github.com/brodieG/validate/issues/51): Check expressions that
* [#65](https://github.com/brodieG/vetr/issues/65)
[#51](https://github.com/brodieG/vetr/issues/51): Check expressions that
return character vectors will have part of the first element of that vector
included in the error message.
* [#69](https://github.com/brodieG/validate/issues/69): Vetting expressions that
* [#69](https://github.com/brodieG/vetr/issues/69): Vetting expressions that
use the symbol of the object being vetted are no longer valid. This avoid
confusion caused by intended standard tokens being treated as template tokens
because they use the object symbol instead of `.` to refer to the object.
* [#64](https://github.com/brodieG/validate/issues/64): Rewrite result handling
* [#64](https://github.com/brodieG/vetr/issues/64): Rewrite result handling
for multi token expressions to avoid unnecessary slow downs
* [#76](https://github.com/brodieG/validate/issues/76): Standardize defined
* [#76](https://github.com/brodieG/vetr/issues/76): Standardize defined
terms (e.g. Standard vs Template Tokens)
* [#77](https://github.com/brodieG/validate/issues/77): Replace `SIZE_T_MAX`
* [#77](https://github.com/brodieG/vetr/issues/77): Replace `SIZE_T_MAX`
with `SIZE_MAX` for portability
* [#70](https://github.com/brodieG/validate/issues/70): Feedback from Richie
* [#70](https://github.com/brodieG/vetr/issues/70): Feedback from Richie
Cotton and Michel Lang re: comparison "vignette"
* [#45](https://github.com/brodieG/validate/issues/45): Cleanup error messages
* [#45](https://github.com/brodieG/vetr/issues/45): Cleanup error messages
for objects that should be NULL.
* [#73](https://github.com/brodieG/validate/issues/73): Cleaner protection stack
* [#73](https://github.com/brodieG/vetr/issues/73): Cleaner protection stack
handling
* [#56](https://github.com/brodieG/validate/issues/56): Over-aggressive
* [#56](https://github.com/brodieG/vetr/issues/56): Over-aggressive
detection of infinite recursion in symbol substitution
* [#59](https://github.com/brodieG/validate/issues/59): Add a `CONTRIBUTING.md`
* [#59](https://github.com/brodieG/vetr/issues/59): Add a `CONTRIBUTING.md`
* Custom tokens that return character vectors see the first element of that
vector incorporated in the error message
* Assorted typos (@franknarf1, @DasonK)
Expand All @@ -37,25 +39,25 @@ Initial release.

Finalizing initial release.

* [#40](https://github.com/brodieG/validate/issues/40): Removed `suggests`
* [#40](https://github.com/brodieG/vetr/issues/40): Removed `suggests`
dependencies to ggplot, microbenchmark, and valaddin to improve travis build
time
* Internal: formatting strings longer than `nchar.max` no longer allowed
* [#39](https://github.com/brodieG/validate/issues/39): `type_alike` return
* [#39](https://github.com/brodieG/vetr/issues/39): `type_alike` return
values structured like `alike`, doc fixes
* [#38](https://github.com/brodieG/validate/issues/38): Run with valgrind
* [#36](https://github.com/brodieG/validate/issues/36): Fix INTEGER C bug
* [#34](https://github.com/brodieG/validate/issues/34): allow substitution of
* [#38](https://github.com/brodieG/vetr/issues/38): Run with valgrind
* [#36](https://github.com/brodieG/vetr/issues/36): Fix INTEGER C bug
* [#34](https://github.com/brodieG/vetr/issues/34): allow substitution of
`.` symbol when part of `..`.
* [#33](https://github.com/brodieG/validate/issues/33): prevent infinite
* [#33](https://github.com/brodieG/vetr/issues/33): prevent infinite
recursion with recursive symbol substitution
* [#30](https://github.com/brodieG/validate/issues/30): allow specification of
* [#30](https://github.com/brodieG/vetr/issues/30): allow specification of
substitution / matching / evaluation environment
* [#28](https://github.com/brodieG/validate/issues/28): expose alike and vetr
* [#28](https://github.com/brodieG/vetr/issues/28): expose alike and vetr
setting control
* [#24](https://github.com/brodieG/validate/issues/24): clarify use of
* [#24](https://github.com/brodieG/vetr/issues/24): clarify use of
`vet_token`
* [#18](https://github.com/brodieG/validate/issues/18): better documentation for
* [#18](https://github.com/brodieG/vetr/issues/18): better documentation for
NSE
* [#11](https://github.com/brodieG/validate/issues/11): segfault when validating
* [#11](https://github.com/brodieG/vetr/issues/11): segfault when validating
language objects
3 changes: 3 additions & 0 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,9 @@ Thank you to:
* CRAN maintainers, for patiently shepherding packages onto CRAN and maintaining
the repository, and Uwe Ligges in particular for maintaining
[Winbuilder](http://win-builder.r-project.org/).
* Tomas Kalibera for [rchk](https://github.com/kalibera/rchk) and rcsnt, to help
detect errors in compiled code, and in particular for his infinite patience in
helping me resolve the issues he identified for me.
* [Jim Hester](https://github.com/jimhester) because
[covr](https://cran.r-project.org/package=covr) rocks.
* [Dirk Eddelbuettel](https://github.com/eddelbuettel) and [Carl
Expand Down
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ vet(numeric(1L) || NULL, NULL)
vet(numeric(1L) || NULL, 42)
## [1] TRUE
vet(numeric(1L) || NULL, "foo")
## [1] "`\"foo\"` should be \"NULL\", or type \"numeric\" (is \"character\")"
## [1] "`\"foo\"` should be `NULL`, or type \"numeric\" (is \"character\")"
```

Templates only check structure. When you need to check values use `.` to
Expand Down Expand Up @@ -292,6 +292,9 @@ Thank you to:
* CRAN maintainers, for patiently shepherding packages onto CRAN and maintaining
the repository, and Uwe Ligges in particular for maintaining
[Winbuilder](http://win-builder.r-project.org/).
* Tomas Kalibera for [rchk](https://github.com/kalibera/rchk) and rcsnt, to help
detect errors in compiled code, and in particular for his infinite patience in
helping me resolve the issues he identified for me.
* [Jim Hester](https://github.com/jimhester) because
[covr](https://cran.r-project.org/package=covr) rocks.
* [Dirk Eddelbuettel](https://github.com/eddelbuettel) and [Carl
Expand Down
Loading

0 comments on commit 7060fb3

Please sign in to comment.