Release candidate 0.6.0 (#146)

ropensci · Oct 16, 2024 · 8d0427b · 8d0427b
1 parent 3aad506
commit 8d0427b
Show file tree

Hide file tree

Showing 81 changed files with 951 additions and 710 deletions.
diff --git a/.github/workflows/recheck.yml b/.github/workflows/recheck.yml
@@ -0,0 +1,19 @@
+on:
+  workflow_dispatch:
+    inputs:
+      which:
+        type: choice
+        description: Which dependents to check
+        options:
+          - strong
+          - most
+
+name: Reverse dependency check
+
+jobs:
+  revdep_check:
+    name: Reverse check ${{ inputs.which }} dependents
+    uses: r-devel/recheck/.github/workflows/recheck.yml@v1
+    with:
+      which: ${{ inputs.which }}
+      subdirectory: '' #if your package is in a git subdir
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -44,7 +44,8 @@ Suggests:
     ipaddress,
     stringi,
     spelling
-RoxygenNote: 7.2.3
+RoxygenNote: 7.3.2
+Config/testthat/edition: 3
 Depends: 
     R (>= 2.10)
 Collate: 

diff --git a/Makefile b/Makefile
@@ -34,7 +34,7 @@ locales_update:
 # No real targets!
 .PHONY: all test doc install
 
-vignettes:
+vignettes: vignettes/charlatan.Rmd vignettes/contributing.Rmd vignettes/creating-realistic-data.Rmd
 	${RSCRIPT} -e "devtools::build_vignettes()"
 
 style:
@@ -53,3 +53,6 @@ revdep:
 	${RSCRIPT} revdep/check.R
 
 release: style test doc readme build revdep
+
+codemeta:
+	${RSCRIPT} -e "codemetar::write_codemeta()"
diff --git a/NAMESPACE b/NAMESPACE
@@ -29,6 +29,7 @@ export(ElementProvider_nl_NL)
 export(FileProvider)
 export(FileProvider_en_US)
 export(FraudsterClient)
+export(ISBNProvider)
 export(InternetProvider)
 export(InternetProvider_bg_BG)
 export(InternetProvider_cs_CZ)

diff --git a/NEWS.md b/NEWS.md
@@ -48,6 +48,7 @@ every locale (when needed) without changing the logic for all locales.
 * add print method so the providers print nicely in the console.
 * All data fields are moved to `private` to reduce visual clutter.
 * Added docs for languages like `czech-language` `turkish-language`.
+* modified tests so they work for test_that version 3
 
 ### BUG FIXES
 * None

diff --git a/R/charlatan-package.R b/R/charlatan-package.R
@@ -10,7 +10,6 @@
 #' @importFrom whisker whisker.render
 #' @importFrom tibble as_tibble
 #' @aliases charlatan
-#' @docType package
 #' @keywords package
 #' @author Roel M. Hogervorst \email{[email protected]}
 #' @author Scott Chamberlain
@@ -50,4 +49,4 @@
 #' x <- ColorProvider_en_US$new()
 #' x$color_name()
 #' x$hex_color()
-NULL
+"_PACKAGE"
diff --git a/R/company-provider-bg_BG.R b/R/company-provider-bg_BG.R
@@ -1,6 +1,6 @@
 # modified from the python library faker:
 # https://github.com/joke2k/faker/blob/master/faker/providers/company/bg_BG/__init__.py
-#' @title CompanyProvider bg_BG
+#' @title CompanyProvider for Bulgarian (Bulgaria)
 #' @inherit CompanyProvider description details return
 #' @export
 #' @family bg

diff --git a/R/doi-provider.R b/R/doi-provider.R
@@ -1,5 +1,6 @@
 #' DOIProvider
 #'
+#' Generate random Digital Object Identifyers, used in scientific journals.
 #' @export
 #' @keywords internal
 #' @examples

diff --git a/R/internet-provider-bg_BG.R b/R/internet-provider-bg_BG.R
@@ -105,7 +105,7 @@ int_replacements_bg_bg <- list(
   c("\u044f", "ya")
 )
 
-#' Internet provider
+#' Internet provider for Bulgarian (Bulgaria)
 #'
 #' methods for internet related data, like email addresses,
 #' usernames, and websites.

diff --git a/R/internet-provider-cs_CZ.R b/R/internet-provider-cs_CZ.R
@@ -28,7 +28,7 @@ int_free_email_domains_cs_cz <- c(
 
 int_tlds_cs_cz <- c("cz", "com", "cz")
 
-#' Internet provider
+#' Internet provider Czech
 #'
 #' methods for internet related data, like email addresses,
 #' usernames, and websites.

diff --git a/R/internet-provider-de_DE.R b/R/internet-provider-de_DE.R
@@ -22,7 +22,7 @@ int_replacements_de_de <- list(
   c("\\u00df", "ss")
 )
 
-#' Internet provider
+#' Internet provider German (Germany)
 #'
 #' methods for internet related data, like email addresses,
 #' usernames, and websites.

diff --git a/R/internet-provider-en_AU.R b/R/internet-provider-en_AU.R
@@ -14,7 +14,7 @@ int_tlds_en_au <- c(
   "net.au", "biz", "info", "edu", "edu.au"
 )
 
-#' Internet provider
+#' Internet provider English (Australia)
 #'
 #' methods for internet related data, like email addresses,
 #' usernames, and websites.

diff --git a/R/internet-provider-fa_IR.R b/R/internet-provider-fa_IR.R
@@ -16,7 +16,7 @@ int_tlds_fa_ir <- c("com", "com", "com", "net", "org", "ir", "ir", "ir")
 #' @family IR
 #' @export
 #' @examples
-#' x <- InternetProvider_bg_BG$new()
+#' x <- InternetProvider_fa_IR$new()
 #' x$email()
 #' x$free_email()
 #' x$mac_address()

diff --git a/R/internet-provider-fr_FR.R b/R/internet-provider-fr_FR.R
@@ -51,7 +51,7 @@ int_replacements_fr_fr <- list(
 #' @family FR
 #' @export
 #' @examples
-#' x <- InternetProvider_bg_BG$new()
+#' x <- InternetProvider_fr_FR$new()
 #' x$email()
 #' x$free_email()
 #' x$mac_address()

diff --git a/R/internet-provider-hr_HR.R b/R/internet-provider-hr_HR.R
@@ -22,7 +22,7 @@ int_replacements_hr_hr <- list(
   c("\u017d", "Z")
 )
 
-#' Internet provider for
+#' Internet provider for Croatian (Croatia)
 #'
 #' methods for internet related data, like email addresses,
 #' usernames, and websites.

diff --git a/R/lorem-provider-ar_AA.R b/R/lorem-provider-ar_AA.R
@@ -697,7 +697,7 @@ lorem_word_list_ar_aa <- c(
   "\u0648\u0627\u0644\u0645\u0627\u0646\u064a\u0627"
 )
 
-#' Lorem provider
+#' Lorem provider Arabic
 #'
 #' Methods for Lorem Ipsum generation.
 #' Lorem Ipsum is a placeholder text commonly used to demonstrate the visual

diff --git a/R/lorem-provider-el_GR.R b/R/lorem-provider-el_GR.R
@@ -525,7 +525,7 @@ lorem_word_list_el_gr <- c(rep(lorem_common_words_el_gr, 2), c(
   "\u03ce\u03c1\u03b1"
 ))
 
-#' Lorem provider
+#' Lorem provider Greek (Greece)
 #'
 #' Methods for Lorem Ipsum generation.
 #' Lorem Ipsum is a placeholder text commonly used to demonstrate the visual

diff --git a/R/lorem-provider-en_US.R b/R/lorem-provider-en_US.R
@@ -979,7 +979,7 @@ lorem_word_list_en_us <- c(
   "yourself"
 )
 
-#' Lorem provider
+#' Lorem provider English (USA)
 #'
 #' Methods for Lorem Ipsum generation.
 #' Lorem Ipsum is a placeholder text commonly used to demonstrate the visual

diff --git a/R/lorem-provider-he_IL.R b/R/lorem-provider-he_IL.R
@@ -148,7 +148,7 @@ lorem_word_list_he_il <- c(
   "\u05ea\u05e8\u05d1\u05e0\u05da"
 )
 
-#' Lorem provider
+#' Lorem provider Hebrew
 #'
 #' Methods for Lorem Ipsum generation.
 #' Lorem Ipsum is a placeholder text commonly used to demonstrate the visual

diff --git a/R/lorem-provider-ru_RU.R b/R/lorem-provider-ru_RU.R
@@ -504,7 +504,7 @@ lorem_word_list_ru_ru <- c(
   "\u0440\u0430\u0432\u043d\u043e\u0434\u0443\u0448\u043d\u044b\u0439"
 )
 
-#' Lorem provider Russian
+#' Lorem provider Russian (Russia)
 #'
 #' Methods for Lorem Ipsum generation.
 #' Lorem Ipsum is a placeholder text commonly used to demonstrate the visual

diff --git a/R/lorem-provider-zh_CN.R b/R/lorem-provider-zh_CN.R
@@ -351,7 +351,7 @@ lorem_word_list_zh_cn <- c(
   "\u51c6\u5907"
 )
 
-#' Lorem provider
+#' Lorem provider Chinese (China)
 #'
 #' Methods for Lorem Ipsum generation.
 #' Lorem Ipsum is a placeholder text commonly used to demonstrate the visual

diff --git a/R/lorem-provider-zh_TW.R b/R/lorem-provider-zh_TW.R
@@ -351,7 +351,7 @@ lorem_word_list_zh_tw <- c(
   "\u51c6\u5099"
 )
 
-#' Lorem provider
+#' Lorem provider Chinese (Taiwan)
 #'
 #' Methods for Lorem Ipsum generation.
 #' Lorem Ipsum is a placeholder text commonly used to demonstrate the visual

diff --git a/R/zzz.R b/R/zzz.R
@@ -122,7 +122,7 @@ locale_mismatch <- function(parent_provider, child_provider) {
 #' generalized util function for sequence multiplication
 #'
 #' Util function for ISBN, ean, SSN providers.
-#' for cases such as sum(x[4]*5 + x[3]*4 + x[2]*3 + x[1] *2)
+#' for cases such as `sum(x[4]*5 + x[3]*4 + x[2]*3 + x[1] *2)`
 #' @keywords internal
 checksum_util <- function(vector, multiplicationvector) {
   stopifnot(length(vector) == length(multiplicationvector))

diff --git a/README.Rmd b/README.Rmd
@@ -92,27 +92,13 @@ x$color_name()
 
 ## locale support
 
-Adding more locales through time, e.g.,
-
-Locale support for job data
-
 ```{r}
-ch_job(locale = "en_US", n = 3)
 ch_job(locale = "fr_FR", n = 3)
 ch_job(locale = "hr_HR", n = 3)
 ch_job(locale = "uk_UA", n = 3)
 ch_job(locale = "zh_TW", n = 3)
 ```
 
-For colors:
-
-```{r}
-ch_color_name(locale = "en_US", n = 3)
-ch_color_name(locale = "uk_UA", n = 3)
-```
-
-More coming soon ...
-
 ## generate a dataset
 
 ```{r}
@@ -123,28 +109,6 @@ ch_generate()
 ch_generate("job", "phone_number", n = 30)
 ```
 
-
-## person name
-
-```{r}
-ch_name()
-```
-
-```{r}
-ch_name(10)
-```
-
-
-## phone number
-
-```{r}
-ch_phone_number()
-```
-
-```{r}
-ch_phone_number(10)
-```
-
 ## job
 
 ```{r}
@@ -163,7 +127,6 @@ ch_credit_card_provider(n = 4)
 ```
 
 ```{r}
-ch_credit_card_number()
 ch_credit_card_number(n = 10)
 ```
 
@@ -172,6 +135,15 @@ ch_credit_card_security_code()
 ch_credit_card_security_code(10)
 ```
 
+## Documentation
+
+All providers have documentation available through the help functions.
+All providers of the same locales, are linked together, and for every language
+we have a generic page, for example```?`dutch-language` ```.
+
+There are three vignettes, about contributing to this project, what {charlatan}
+does and a more in depth vignette about creating realistic data.
+
 ## Usage in the wild
 
 - eacton/R-Utility-Belt-ggplot2 (https://github.com/eacton/R-Utility-Belt-ggplot2/blob/836a6bd303fbfde4a334d351e0d1c63f71c4ec68/furry_dataset.R)