function for making new blog posts #171

topepo · 2024-04-16T13:39:18Z

Adds some dependencies (fs, whoami).

R/new-blog-post.R

topepo · 2024-04-16T13:41:55Z

R/new-blog-post.R

+    yml_values <- yml_values[names(yml_values) != "categories"]
+  }
+  yml_values <- yaml::as.yaml(yml_values)
+  yml_values <- paste0("---\n", yml_values, "---\n")


Also, maybe there is a better API.

While dealing with YAML in quarto context we have the issue of yaml R package being 1.1 spec, and Quarto using 1.2 spec.

So it requires some specific handlers as workaround. See

quarto-r/R/utils.R

Lines 6 to 16 in d71b135

write_yaml <- function(x, file) {

handlers <- list(

# Handle yes/no from 1.1 to 1.2

# https://github.com/vubiostat/r-yaml/issues/131

logical = function(x) {

value <- ifelse(x, "true", "false")

structure(value, class = "verbatim")

}

)

yaml::write_yaml(x, file, handlers = handlers)

}

We probably need to adapt for generating not in a file, or refactor the handlers so that we can use them in other functions.

Regaring ---, I believe this is good enough.

This post creation may also be done through templating 🤔 Having a whisker template (or else) to file out with some information. Probably more complex than necessary, but we did that for bookdown skeleton for example using placeholder in template file (https://github.com/rstudio/bookdown/blob/f244cf12bf2c2d7106ac6322b2b2a5796d4ef0c8/R/skeleton.R#L66-L83)

I am fine with current way

topepo · 2024-04-18T16:29:04Z

GHA failures are now down to infrastructure issues, not failing R CMD check

cderv

Thanks a lot ! This will be really useful.

Do you think this will be used more interactively or not ? Just curious about your use case.

Just a few suggestions below. I see that we may need to really start using fs

Also, I am wondering if we should have more check that this function is used in the right place.

website project where blog is supported not another type or no project
called in the root of the project so that posts folder is created in the right place
or no matter where called, the new post is created in the right place from the root project

Again, thanks !!

cderv · 2024-05-15T13:51:02Z

DESCRIPTION

As those two deps are only required for the new blog post function, and this function is aimed to be used mostly interactively, I wonder if we could rely on rlang::check_installed()

By using if(rlang::check_installed("whoami")), user will be asked to install if missing when used interactively.

This would allow to make them suggested dependencies.

For fs, we probably could start using it in this package.

cderv · 2024-05-15T13:51:29Z

NEWS.md

@@ -1,5 +1,7 @@
 # quarto (development version)

+- Added a `new_blog_post()` function (#22). 


Suggested change

- Added a `new_blog_post()` function (#22).

- Added a `new_blog_post()` function (thanks, @topepo , #22).

R/new-blog-post.R

cderv · 2024-05-15T14:04:23Z

R/new-blog-post.R

+#' default, the title is adapted as the directory name.
+#' @param open A logical: have the default editor open a window to edit the
+#' `index.qmd` file?
+#' @param call A call object for reporting errors.


My understanding is that the prefered way is to use

⁠@inheritParams rlang::args_error_context

From https://rlang.r-lib.org/reference/args_error_context.html and usage at several tidyverse packages

cderv · 2024-05-15T14:23:33Z

R/new-blog-post.R

+    yml_values <- yml_values[names(yml_values) != "categories"]
+  }
+  yml_values <- yaml::as.yaml(yml_values)
+  yml_values <- paste0("---\n", yml_values, "---\n")


While dealing with YAML in quarto context we have the issue of yaml R package being 1.1 spec, and Quarto using 1.2 spec.

So it requires some specific handlers as workaround. See

quarto-r/R/utils.R

Lines 6 to 16 in d71b135

write_yaml <- function(x, file) {

handlers <- list(

# Handle yes/no from 1.1 to 1.2

# https://github.com/vubiostat/r-yaml/issues/131

logical = function(x) {

value <- ifelse(x, "true", "false")

structure(value, class = "verbatim")

}

)

yaml::write_yaml(x, file, handlers = handlers)

}

We probably need to adapt for generating not in a file, or refactor the handlers so that we can use them in other functions.

Regaring ---, I believe this is good enough.

This post creation may also be done through templating 🤔 Having a whisker template (or else) to file out with some information. Probably more complex than necessary, but we did that for bookdown skeleton for example using placeholder in template file (https://github.com/rstudio/bookdown/blob/f244cf12bf2c2d7106ac6322b2b2a5796d4ef0c8/R/skeleton.R#L66-L83)

I am fine with current way

cderv · 2024-05-15T14:26:27Z

R/new-blog-post.R

+make_post_yaml <- function(title, ...) {
+  default_values <- list(
+    title = tools::toTitleCase(title),
+    author = tools::toTitleCase(whoami::fullname("Your name")),


We could document for .Rd file that whoami is used as default when available

We could also easily make this deps a suggest by using it only if available

tools::toTitleCase(if(rlang::is_installed("whoami")) whoami::fullname("Your name") else "Your name")

cderv · 2024-05-15T14:29:43Z

tests/testthat/test-new-blog-post.R

+  temp_dir <- withr::local_tempdir()
+  dir_path <- fs::path(temp_dir, "test-blog-project")
+
+  withr::defer(fs::dir_delete(dir_path), envir = rlang::current_env())


withr::local_tempdir() already include a defer call to unlink() recursively its content. So I believe no need for a new defer call

cderv · 2024-05-15T14:31:29Z

tests/testthat/test-new-blog-post.R

+  setwd(dir_path)
+  withr::defer(setwd(current_dir), envir = rlang::current_env())


Usually I use withr::local_dir() to change working directory for the rest of the test

This should be enough

withr::local_dir(fs::path(temp_dir, "test-blog-project"))

cderv · 2024-05-15T14:32:53Z

tests/testthat/test-new-blog-post.R

+  setwd(dir_path)
+  withr::defer(setwd(current_dir), envir = rlang::current_env())
+
+  Sys.setenv(FULLNAME="Max Kuhn")


Maybe we should keep using withr for that

Suggested change

Sys.setenv(FULLNAME="Max Kuhn")

withr::local_envvar(list(FULLNAME = "Max Kuhn"))

cderv · 2024-05-15T14:58:18Z

GHA failures are now down to infrastructure issues, not failing R CMD check

I have updated main to solve this. It should be ok now.

topepo and others added 5 commits April 12, 2024 14:25

initial version of new_blog_post

bec750e

add namespace to call

b41f130

initial unit tests

a8e7d13

news file update related to quarto-dev#22

ad0a01b

use test fixtures

56be9fb

topepo commented Apr 16, 2024

View reviewed changes

R/new-blog-post.R Show resolved Hide resolved

topepo commented Apr 16, 2024

View reviewed changes

R/new-blog-post.R Show resolved Hide resolved

topepo commented Apr 16, 2024

View reviewed changes

topepo marked this pull request as ready for review April 16, 2024 18:34

set env var for testing

0f2942d

topepo requested a review from cderv April 18, 2024 16:28

Merge remote-tracking branch 'upstream/main'

4066f0e

cderv reviewed May 15, 2024

View reviewed changes

‘topepo’ added 2 commits July 17, 2024 20:52

Merge remote-tracking branch 'upstream/main'

a229171

conditionally use whoami

cc2adcf

cderv linked an issue Sep 24, 2024 that may be closed by this pull request

Feature Request: new_post function / RStudio Addin #22

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

function for making new blog posts #171

function for making new blog posts #171

topepo commented Apr 16, 2024

topepo Apr 16, 2024

cderv May 15, 2024

topepo commented Apr 18, 2024

cderv left a comment

cderv May 15, 2024

cderv May 15, 2024

cderv May 15, 2024

cderv May 15, 2024

cderv May 15, 2024

cderv May 15, 2024

cderv May 15, 2024

cderv May 15, 2024

cderv May 15, 2024

cderv commented May 15, 2024

	write_yaml <- function(x, file) {
	handlers <- list(
	# Handle yes/no from 1.1 to 1.2
	# https://github.com/vubiostat/r-yaml/issues/131
	logical = function(x) {
	value <- ifelse(x, "true", "false")
	structure(value, class = "verbatim")
	}
	)
	yaml::write_yaml(x, file, handlers = handlers)
	}

		@@ -1,5 +1,7 @@
		# quarto (development version)

		- Added a `new_blog_post()` function (#22).

	- Added a `new_blog_post()` function (#22).
	- Added a `new_blog_post()` function (thanks, @topepo , #22).

		setwd(dir_path)
		withr::defer(setwd(current_dir), envir = rlang::current_env())

	Sys.setenv(FULLNAME="Max Kuhn")
	withr::local_envvar(list(FULLNAME = "Max Kuhn"))

function for making new blog posts #171

Are you sure you want to change the base?

function for making new blog posts #171

Conversation

topepo commented Apr 16, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

topepo commented Apr 18, 2024

cderv left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cderv commented May 15, 2024