README.md

In rappster/valid: Facilitating systematic input validation

valid

Installation

# install.packages("remotes")
remotes::install_github("rappster/valid")

What?

Helpers for facilitating systematic input validation

Why?

Input validation is tedious already. This package hopefully provides some functionality to make the task a bit easier or at least more fun.

How?

library(valid)

The actual workhorse is valid() while valid2() makes choice input a bit more convenient via the ... mechanism.

Built-in functions

There are some built-in functions for typical validation tasks.

The number of such built-in functions will grow over time in a “scratch my own itch” manner

valid_authentication()
#>     ssh   https 
#>   "ssh" "https"
valid_authentication("https")
#>   https 
#> "https"
valid_authentication(2)
#>   https 
#> "https"
try(valid_authentication("I don't exist"))
#> Your choice:
#> I don't exist
#> Valid choices:
#> ssh
#> https
#> Error : Invalid choice: valid_authentication("I don't exist")
try(valid_authentication(3))
#> Your choice:
#> 3
#> 
#> Valid choices:
#> ssh
#> https
#> Error : Invalid choice: valid_authentication(3)

valid_dep_types()
#>    Suggests     Imports     Depends    Enhances   LinkingTo 
#>  "Suggests"   "Imports"   "Depends"  "Enhances" "LinkingTo"
valid_dep_types("Suggests")
#>   Suggests 
#> "Suggests"
try(valid_dep_types("I don't exist"))
#> Your choice:
#> I don't exist
#> Valid choices:
#> Suggests
#> Imports
#> Depends
#> Enhances
#> LinkingTo
#> Error : Invalid choice: valid_dep_types("I don't exist")

valid_devops_envs()
#>       dev   staging      prod 
#>     "dev" "staging"    "prod"
valid_devops_envs("staging")
#>   staging 
#> "staging"
try(valid_devops_envs("I don't exist"))
#> Your choice:
#> I don't exist
#> Valid choices:
#> dev
#> staging
#> prod
#> Error : Invalid choice: valid_devops_envs("I don't exist")

valid_licenses()
#>       gpl3        mit        cc0       ccby       lgpl       apl2      agpl3 
#>   "GPL v3"      "MIT"      "CC0" "CCBY 4.0"  "LGPL v3"  "APL 2.0"  "AGPL v3"
valid_licenses("mit")
#>   mit 
#> "MIT"
try(valid_licenses("I don't exist"))
#> Your choice:
#> I don't exist
#> Valid choices:
#> GPL v3
#> MIT
#> CC0
#> CCBY 4.0
#> LGPL v3
#> APL 2.0
#> AGPL v3
#> Error : Invalid choice: valid_licenses("I don't exist")

valid_yes_no()
#>   yes    no 
#> "Yes"  "No"
valid_again_exit()
#>               again                exit 
#> "Let me start over"              "Exit"
valid_yes_no_again_exit()
#>                 yes                  no               again                exit 
#>               "Yes"                "No" "Let me start over"              "Exit"
valid_keep_reset()
#>    keep   reset 
#>  "Keep" "Reset"
valid_keep_reset_again_exit()
#>                keep               reset               again                exit 
#>              "Keep"             "Reset" "Let me start over"              "Exit"

Storage

valid_storage_remote()
#>   aws_s3   gcp_cs   gcp_s3 
#> "aws_s3" "gcp_cs" "gcp_s3"
valid_storage_remote("gcp_s3")
#>   gcp_s3 
#> "gcp_s3"
valid_storage_remote("gcp_cs", "aws_s3", "gcp_s3")
#>   gcp_cs   aws_s3   gcp_s3 
#> "gcp_cs" "aws_s3" "gcp_s3"
valid_storage_remote(1, 3)
#>   aws_s3   gcp_s3 
#> "aws_s3" "gcp_s3"
try(valid_storage_remote("I don't exist"))
#> Your choice:
#> I don't exist
#> Valid choices:
#> aws_s3
#> gcp_cs
#> gcp_s3
#> Error : Invalid choice: valid_storage_remote("I don't exist")

valid_storage_local()
#>   fs 
#> "fs"
valid_storage_local("fs")
#>   fs 
#> "fs"
valid_storage_local(1)
#>   fs 
#> "fs"
try(valid_storage_local("I don't exist"))
#> Your choice:
#> I don't exist
#> Valid choices:
#> fs
#> Error : Invalid choice: valid_storage_local("I don't exist")

valid_storage()
#>       fs   aws_s3   gcp_cs   gcp_s3 
#>     "fs" "aws_s3" "gcp_cs" "gcp_s3"
valid_storage("fs", "gcp_s3", "aws_s3")
#>       fs   gcp_s3   aws_s3 
#>     "fs" "gcp_s3" "aws_s3"
valid_storage(2, 3, 1)
#>   aws_s3   gcp_cs       fs 
#> "aws_s3" "gcp_cs"     "fs"
try(valid_storage("I don't exist"))
#> Your choice:
#> I don't exist
#> Valid choices:
#> fs
#> aws_s3
#> gcp_cs
#> gcp_s3
#> Error : Invalid choice: valid_storage("I don't exist")

You can reverse the order or flip names and values

valid_devops_envs(reverse = TRUE)
#>      prod   staging       dev 
#>    "prod" "staging"     "dev"
valid_devops_envs(flip = TRUE) # doesn't really make sense in this case as both is lowercase
#>       dev   staging      prod 
#>     "dev" "staging"    "prod"
valid_devops_envs(unname = TRUE)
#> [1] "dev"     "staging" "prod"

Custom function

Definition

You can build your functions on top of valid::valid()

my_valid_devops_envs <- function(
  x = character(),
  ...
) {
  choices <- c("dev", "staging", "prod")
  names(choices) <- toupper(choices)

  valid(
    choice = x,
    choices = choices,
    ...
  )
}

my_valid_devops_envs2 <- function(
  ...
) {
  choices <- c("dev", "staging", "prod")
  names(choices) <- toupper(choices)

  valid2(
    ...,
    .choices = choices
  )
}

Apply without explicit choice

my_valid_devops_envs()
#>       DEV   STAGING      PROD 
#>     "dev" "staging"    "prod"

my_valid_devops_envs(reverse = TRUE)
#>      PROD   STAGING       DEV 
#>    "prod" "staging"     "dev"

my_valid_devops_envs(flip = TRUE)
#>       dev   staging      prod 
#>     "DEV" "STAGING"    "PROD"

my_valid_devops_envs(unname = TRUE)
#> [1] "dev"     "staging" "prod"

my_valid_devops_envs(flip = TRUE, unname = TRUE)
#> [1] "DEV"     "STAGING" "PROD"

Choice via name

Valid:

my_valid_devops_envs("PROD")
#>   PROD 
#> "prod"

my_valid_devops_envs(c("STAGING", "PROD"))
#>   STAGING      PROD 
#> "staging"    "prod"
my_valid_devops_envs2("STAGING", "PROD")
#>   STAGING      PROD 
#> "staging"    "prod"

Invalid:

try(my_valid_devops_envs("ABC"))
#> Your choice:
#> ABC
#> Valid choices:
#> dev
#> staging
#> prod
#> Error : Invalid choice: my_valid_devops_envs("ABC")

my_valid_devops_envs("ABC", strict = FALSE)
#> Warning: Invalid choice: my_valid_devops_envs("ABC")
#> Your choice:
#> ABC
#> Valid choices:
#> dev
#> staging
#> prod
#> named character(0)

Partially invalid:

try(my_valid_devops_envs(x = c("DEV", "ABC")))
#> Your choice:
#> dev
#> ABC
#> Valid choices:
#> dev
#> staging
#> prod
#> Error : Invalid choice: my_valid_devops_envs("ABC")
try(my_valid_devops_envs2("DEV", "ABC"))
#> Your choice:
#> dev
#> ABC
#> 
#> Valid choices:
#> dev
#> staging
#> prod
#> Error : Invalid choice: my_valid_devops_envs2("ABC")

my_valid_devops_envs(x = c("DEV", "ABC"), strict = FALSE)
#> Warning: Invalid choice: my_valid_devops_envs("ABC")
#> Your choice:
#> dev
#> ABC
#> Valid choices:
#> dev
#> staging
#> prod
#>   DEV 
#> "dev"
my_valid_devops_envs2("DEV", "ABC", .strict = FALSE)
#> Warning: Invalid choice: my_valid_devops_envs2("ABC")
#> Your choice:
#> dev
#> ABC
#> 
#> Valid choices:
#> dev
#> staging
#> prod
#>   DEV 
#> "dev"

Choice via value

Valid:

my_valid_devops_envs("dev")
#>   DEV 
#> "dev"

my_valid_devops_envs(c("dev", "staging"))
#>       DEV   STAGING 
#>     "dev" "staging"
my_valid_devops_envs2("dev", "staging")
#>       DEV   STAGING 
#>     "dev" "staging"

Invalid:

try(my_valid_devops_envs("abc"))
#> Your choice:
#> abc
#> Valid choices:
#> dev
#> staging
#> prod
#> Error : Invalid choice: my_valid_devops_envs("abc")

my_valid_devops_envs("abc", strict = FALSE)
#> Warning: Invalid choice: my_valid_devops_envs("abc")
#> Your choice:
#> abc
#> Valid choices:
#> dev
#> staging
#> prod
#> named character(0)

Partially invalid

try(my_valid_devops_envs(c("dev", "abc")))
#> Your choice:
#> dev
#> abc
#> Valid choices:
#> dev
#> staging
#> prod
#> Error : Invalid choice: my_valid_devops_envs("abc")
try(my_valid_devops_envs2("dev", "abc"))
#> Your choice:
#> dev
#> abc
#> 
#> Valid choices:
#> dev
#> staging
#> prod
#> Error : Invalid choice: my_valid_devops_envs2("abc")

my_valid_devops_envs(c("dev", "abc"), strict = FALSE)
#> Warning: Invalid choice: my_valid_devops_envs("abc")
#> Your choice:
#> dev
#> abc
#> Valid choices:
#> dev
#> staging
#> prod
#>   DEV 
#> "dev"
my_valid_devops_envs2("dev", "abc", .strict = FALSE)
#> Warning: Invalid choice: my_valid_devops_envs2("abc")
#> Your choice:
#> dev
#> abc
#> 
#> Valid choices:
#> dev
#> staging
#> prod
#>   DEV 
#> "dev"

Choice via index/position

Valid:

my_valid_devops_envs(2)
#>   STAGING 
#> "staging"

my_valid_devops_envs(c(2, 3))
#>   STAGING      PROD 
#> "staging"    "prod"
my_valid_devops_envs2(2, 3)
#>   STAGING      PROD 
#> "staging"    "prod"

Invalid:

try(my_valid_devops_envs(4))
#> Your choice:
#> 4
#> Valid choices:
#> dev
#> staging
#> prod
#> Error : Invalid choice: my_valid_devops_envs(4)

my_valid_devops_envs(4, strict = FALSE)
#> Warning: Invalid choice: my_valid_devops_envs(4)
#> Your choice:
#> 4
#> Valid choices:
#> dev
#> staging
#> prod
#> named character(0)

Partially invalid:

try(my_valid_devops_envs(x = c(1, 4)))
#> Your choice:
#> dev
#> 4
#> Valid choices:
#> dev
#> staging
#> prod
#> Error : Invalid choice: my_valid_devops_envs(4)
try(my_valid_devops_envs2(1, 4))
#> Your choice:
#> dev
#> 4
#> 
#> Valid choices:
#> dev
#> staging
#> prod
#> Error : Invalid choice: my_valid_devops_envs2(4)

my_valid_devops_envs(x = c(1, 4), strict = FALSE)
#> Warning: Invalid choice: my_valid_devops_envs(4)
#> Your choice:
#> dev
#> 4
#> Valid choices:
#> dev
#> staging
#> prod
#>   DEV 
#> "dev"
my_valid_devops_envs2(1, 4, .strict = FALSE)
#> Warning: Invalid choice: my_valid_devops_envs2(4)
#> Your choice:
#> dev
#> 4
#> 
#> Valid choices:
#> dev
#> staging
#> prod
#>   DEV 
#> "dev"

Use validation function inside of another function

foo <- function(
  devops_env = my_valid_devops_envs2("dev")
) {
  # Input validation
  devops_env <- match.arg(devops_env, my_valid_devops_envs2())

  # Body
  stringr::str_glue("DevOps env: {stringr::str_c(devops_env, collapse = ', ')}")
}

Keeping the default

foo()
#> DevOps env: dev

Eager input validation

foo(
  devops_env = my_valid_devops_envs2("dev")
)
#> DevOps env: dev

try(
  foo(
    devops_env = my_valid_devops_envs2("abc")
  )
)
#> Your choice:
#> abc
#> Valid choices:
#> dev
#> staging
#> prod
#> Error : Invalid choice: my_valid_devops_envs2("abc")

try(
  foo(
    devops_env = my_valid_devops_envs2("dev", "abc")
  )
)
#> Your choice:
#> dev
#> abc
#> Valid choices:
#> dev
#> staging
#> prod
#> Error : Invalid choice: my_valid_devops_envs2("abc")

Lazy input validation

foo(
  devops_env = "dev"
)
#> DevOps env: dev

try(
  foo(
    devops_env = "abc"
  )
)
#> Error in match.arg(devops_env, my_valid_devops_envs2()) : 
#>   'arg' should be one of "dev", "staging", "prod"

Code of Conduct

Please note that the valid project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

rappster/valid documentation built on Aug. 19, 2022, 1:59 p.m.