add the 2.0.0 changes (#9)

* change logo

* favr rework

Author: LJ-Jenkins

DESCRIPTION

@@ -1,22 +1,24 @@
 Package: favr
 Title: Function Argument Validation
-Version: 1.0.0.9000
+Version: 2.0.0
 Authors@R: 
     person("Luke", "Jenkins", , "luke-jenkins-dev@outlook.com", role = c("aut", "cre", "cph"), comment = c(ORCID = "0000-0002-7206-7242"))
-Description: Validate function arguments succinctly with informative error messages and optional automatic type casting and size recycling. Enable schema-based assertions by attaching reusable rules to data.frame and list objects for use throughout workflows.
+Description: Validate function arguments succinctly with informative error messages.
 License: MIT + file LICENSE
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.3.2
 Imports: 
     cli,
-    rlang,
+    lifecycle,
+    rlang (>= 1.1.0),
     tidyselect,
     vctrs
 Suggests: 
-    testthat (>= 3.0.0)
+    testthat (>= 3.0.0),
+    withr
 Config/testthat/edition: 3
 URL: https://lj-jenkins.github.io/favr/, https://github.com/LJ-Jenkins/favr
 Depends: 
     R (>= 4.1.0)
 BugReports: https://github.com/LJ-Jenkins/favr/issues
+Config/roxygen2/version: 8.0.0

NAMESPACE

@@ -21,6 +21,18 @@ S3method(cnd_body,favr_error_size_arg)
 S3method(cnd_footer,favr_error_logi_returned)
 S3method(cnd_footer,favr_error_rhs_formula)
 S3method(cnd_header,favr_error)
+S3method(do_n_check,default)
+S3method(do_n_check,favr_at_least)
+S3method(do_n_check,favr_at_most)
+S3method(do_n_check,favr_in_range)
+S3method(do_ncol_check,default)
+S3method(do_ncol_check,favr_at_least)
+S3method(do_ncol_check,favr_at_most)
+S3method(do_ncol_check,favr_in_range)
+S3method(do_nrow_check,default)
+S3method(do_nrow_check,favr_at_least)
+S3method(do_nrow_check,favr_at_most)
+S3method(do_nrow_check,favr_in_range)
 S3method(enforce_schema,default)
 S3method(enforce_schema,with_schema)
 S3method(eval_formula_rhs,"favr:::arg")
@@ -33,6 +45,8 @@ S3method(schema,default)
 S3method(schema,list)
 export(abort_if)
 export(abort_if_not)
+export(abortif)
+export(abortifnot)
 export(add_to_schema)
 export(are_atomic)
 export(are_bare_atomic)
@@ -77,17 +91,76 @@ export(are_scalar_vector)
 export(are_string)
 export(are_true)
 export(are_vector)
+export(at_least)
+export(at_most)
+export(bare)
 export(cast)
 export(cast_if_not)
+export(check)
+export(check_array)
+export(check_atomic)
+export(check_bool)
+export(check_bytes)
+export(check_character)
+export(check_class)
+export(check_complex)
+export(check_data_frame)
+export(check_data_table)
+export(check_date)
+export(check_dir)
+export(check_double)
+export(check_ext)
+export(check_factor)
+export(check_false)
+export(check_file)
+export(check_finite)
+export(check_inherits)
+export(check_integer)
+export(check_list)
+export(check_list_of)
+export(check_logical)
+export(check_matrix)
+export(check_no_na)
+export(check_null)
+export(check_numeric)
+export(check_nzchar)
+export(check_ordered)
+export(check_posixct)
+export(check_posixlt)
+export(check_raw)
+export(check_scalar_atomic)
+export(check_scalar_bytes)
+export(check_scalar_character)
+export(check_scalar_complex)
+export(check_scalar_double)
+export(check_scalar_integer)
+export(check_scalar_list)
+export(check_scalar_logical)
+export(check_scalar_numeric)
+export(check_scalar_raw)
+export(check_scalar_vector)
+export(check_string)
+export(check_table)
+export(check_tibble)
+export(check_tidytable)
+export(check_true)
+export(check_vctr)
+export(check_vector)
+export(check_with)
 export(coerce)
 export(enforce)
 export(enforce_schema)
 export(have_names)
+export(in_range)
 export(lossy)
 export(recycle)
 export(recycle_if_not)
+export(s3_df_check)
+export(s3_vec_check)
 export(schema)
+export(walk_check)
 import(cli)
+import(lifecycle)
 import(rlang)
 import(tidyselect)
 import(vctrs)

NEWS.md

@@ -1,4 +1,70 @@
-# favr (development version)
+# favr 2.0.0
+
+Refactor of the package to focus on function argument validation through "check" functions that throw an error if validation fails and return `NULL` (or occasionally the input) invisibly if validation succeeds.
+
+## New Features
+
+### General Validation
+
+* `abortif()` and `abortifnot()` functions to check conditions and error if a condition is `TRUE` or `FALSE`, respectively.
+* `check()` function to check conditions using tidy eval and error if a condition is `TRUE`.
+* `check_with()` function to check conditions in a data-masked context and error if a condition is `TRUE`.
+* `walk_check()` function to walk a predicate over a vector and error if any element fails the check.
+
+### Type and Class Validation
+
+* `check_inherits()` and `check_class()` functions to check the class of an object and error if it does not inherit from a specified class.
+
+### Type Validation
+
+* `check_list()`, `check_atomic()`, `check_vector()`, `check_integer()`, `check_double()`, `check_numeric()`, `check_character()`, `check_logical()`, `check_complex()`, `check_raw()`, `check_bytes()` and `check_null()` functions to check the type of an object and error if it does not match the specified type.
+
+* `check_scalar_list()`, `check_scalar_atomic()`, `check_scalar_vector()`, `check_scalar_integer()`, `check_scalar_double()`, `check_scalar_numeric()`, `check_scalar_character()`, `check_scalar_logical()`, `check_scalar_complex()`, `check_scalar_raw()` and `check_scalar_bytes()` functions to check if an object is a scalar of the specified type and error if it is not.
+
+* `check_array()`, `check_matrix()` and `check_table()` functions to check if an object is an array, matrix, or table, respectively, and error if it is not.
+
+### S3 Type Validation
+
+* `check_factor()`, `check_ordered()`, `check_date()`, `check_posixct()` and `check_posixlt()` functions to check if an object is of the specified S3 vector type and error if it is not.
+
+* `check_data_frame()`, `check_tibble()`, `check_data_table()` and `check_tidytable()` functions to check if an object is of the specified S3 data frame type and error if it is not.
+
+* `check_vctr()` and `check_list_of()` functions to check if an object is of the specified `vctrs` S3  type and error if it is not.
+
+* `s3_vec_check()` and `s3_df_check()` functions for developers to create their own S3 type checks for vector and data frame types, respectively.
+
+### Type Checking Modifiers
+
+* `bare()` modifier to check for bare objects (i.e. objects with no class attribute) in the type check functions, or bare S3 objects (where the expected S3 class is first in the class attribute vector) in the S3 type check functions.
+
+* `at_least()`, `at_most()`, and `in_range()` modifiers to check for ranges in length/number of rows/number of columns.
+
+### Scalar Value Validation
+
+* `check_true()`, `check_false()`, `check_bool()` and `check_string()` functions to check if an object is a scalar of the specified type and value and error if it is not.
+
+### Forbidden Values Validation
+
+* `check_no_na()`, `check_finite()` and `check_nzchar()` functions to check for the presence of forbidden values and error if found.
+
+### File and Directory Validation
+
+* `check_dir()` and `check_file()` functions to check if a directory or file exists and error if it does not.
+* `check_ext()` function to check the file extension of a file/path and error if it does not match the specified extensions.
+
+## Questioning
+
+Removed the online documentation for `enforce()`, `schema()`, `add_to_schema()`, `enforce_schema()`, and the associated casting and recycling helpers (`cast()`, `lossy()`, `recycle()` and `coerce()`).
+
+## Soft-Deprecated
+
+* `abort_if_not()` should be replaced with `abortifnot()` or `check()`.
+* `cast_if_not()` and `recycle_if_not()` should be replaced with their `vctrs` equivalents, `vctrs::vec_cast()` and `vctrs::vec_recycle()`, respectively.
+* All `are_*()` functions and the `have_names()` function - their use cases were limited and are easily replicated using `base::vapply()` and the associated predicate function.
+
+## Bug Fixes
+
+* Fixed a bug where `are_scalar_integerish()` would immediately error due to an erroneous `.n` argument.
 
 # favr 1.0.0