Add use_blank_slate() #139

jennybc · 2017-12-20T06:52:30Z

Closes #133.

Implements ~~use_freshstarts()~~ use_blank_slate(), to suppress save/reload of user's workspace upon R restarts.

Handles scope = "project" but not scope = "user". Reasons given in #133 (comment).

I needed to use work done in PRs #145 (Make scoped_temporary_package() easier to work with) and #146 (Less promiscuous Rbuildignoring) so those need approval first.

jennybc · 2017-12-20T06:53:44Z

R/rstudio.R

+  scope <- match.arg(scope)
+
+  if (scope == "user") {
+    message(


I suspect this appalls you. Happy to implement in a more usethis-style.

I think this is fine, just use todo() instead of message().

done 0dbc25a

jennybc · 2017-12-20T06:54:30Z

R/rstudio.R

+    rproj_path(),
+    list(RestoreWorkspace = "No", SaveWorkspace = "No")
+  )
+  write_utf8(file.path(proj_get(), rproj_path()), rproj_options)


I would prefer write_over() but I don't want to ask user's permission.

I think that's fine

jennybc · 2017-12-20T06:56:07Z

R/rstudio.R

+  write_utf8(file.path(proj_get(), rproj_path()), rproj_options)
+  restart_rstudio(
+    "A restart of RStudio is required to activate fresh starts"
+  )


I confirmed restart is necessary for this to take effect.

Maybe just "Restart RStudio for a fresh state?"

hadley · 2017-12-20T16:45:48Z

R/rstudio.R

+#' @inheritParams edit
+#'
+#' @export
+use_freshstarts <- function(scope = c("user", "project")) {


Should this be use_fresh_starts()?

Or use_blank_slate()? use_tabula_rasa()?

hadley · 2017-12-20T16:46:01Z

R/rstudio.R

+#' starts provide timely feedback that encourages the development of scripts
+#' that are complete and self-contained.
+#'
+#' Only `use_freshstarts("project")` is implemented so far, since RStudio


implemented -> automated

hadley · 2017-12-20T16:46:24Z

R/rstudio.R

+#'
+#' Only `use_freshstarts("project")` is implemented so far, since RStudio
+#' currently only supports modification of user-level or global options via the
+#' user interface.


Link to blog post for more info?

hadley · 2017-12-20T16:46:45Z

R/rstudio.R

+  scope <- match.arg(scope)
+
+  if (scope == "user") {
+    message(


I think this is fine, just use todo() instead of message().

hadley · 2017-12-20T16:47:04Z

R/rstudio.R

+    rproj_path(),
+    list(RestoreWorkspace = "No", SaveWorkspace = "No")
+  )
+  write_utf8(file.path(proj_get(), rproj_path()), rproj_options)


I think that's fine

hadley · 2017-12-20T16:47:16Z

R/rstudio.R

+  write_utf8(file.path(proj_get(), rproj_path()), rproj_options)
+  restart_rstudio(
+    "A restart of RStudio is required to activate fresh starts"
+  )


Maybe just "Restart RStudio for a fresh state?"

hadley · 2017-12-20T16:48:43Z

R/rstudio.R

@@ -32,3 +95,37 @@ in_rstudio <- function(base_path = proj_get()) {

  normalizePath(proj) == normalizePath(base_path)
 }
+
+build_rproj <- function(file, fields) {


I'd like to see a bunch of unit tests for this, since it's fairly high risk.

Tests added. This is ready for another look.

I needed to use work done in PRs #145 (Make scoped_temporary_package() easier to work with) and #146 (Less promiscuous Rbuildignoring) so those need approval first.

hadley · 2017-12-20T21:51:06Z

Let's call it use_blank_slate()

Fixes #141

* scoped-temporary-things: Prefer capture_output() to capture.output() Make scoped_temporary_package callable from the console Move scoped_temporary_package() to test dir

Fixes #127

* careful-rbuildignore: More specific pattern re: Rbuildignoring .Rproj files Remove .Rbuildignore from .gitignore More specific Rbuildignore for usethis.Rproj Test we can find templates vulnerable to Rbuildignore

hadley · 2017-12-22T14:09:28Z

.Rbuildignore

@@ -1,4 +1,4 @@
-^.*\.Rproj$


Doesn't RStudio modify this when you re-open?

It does not for me. Does it for you?

Hmmm, I could've sworn it did in the past, but not this time!

I have even checked with a full "new Project (that is a package) from GitHub" workflow. And RStudio doesn't modify this in .Rbuildignore

I've come to the conclusion that the problem of the missing template was self-inflicted. Although maybe that .Rbuildignore line was originally inspired by RStudio?

hadley · 2017-12-22T14:10:21Z

tests/testthat/test-rstudio.R

+  expect_identical(rproj, paste0(basename(dir), ".Rproj"))
+})
+
+test_that("a non-RStudio project is recognized", {


is not recognised?

hadley · 2017-12-22T14:11:37Z

tests/testthat/test-rstudio.R

+    list()
+  )
+  writeLines(serialize_rproj(rproj), tmp)
+  expect_equivalent(


Why not expect_equal() on the lines themselves?

jennybc · 2017-12-22T16:53:39Z

@hadley look again?

hadley · 2017-12-22T18:34:04Z

R/rstudio.R

@@ -13,12 +13,88 @@ use_rstudio <- function() {

  use_git_ignore(".Rproj.user")
  if (is_package()) {
-    use_build_ignore(c("^.*\\.Rproj$", "^\\.Rproj\\.user$"), escape = FALSE)
+    use_build_ignore(
+      c(


I think you could now make this:

use_build_ignore(c(paste0(project_name(), "\.Rproj"), ".Rproj.user"))

yes, changed

[skip ci]

jennybc requested a review from hadley December 20, 2017 06:52

jennybc commented Dec 20, 2017

View reviewed changes

jennybc force-pushed the use-freshstarts branch from a6e3d9d to 3ccf9b0 Compare December 20, 2017 07:50

hadley reviewed Dec 20, 2017

View reviewed changes

jennybc added 9 commits December 21, 2017 16:50

Move scoped_temporary_package() to test dir

35163b8

Make scoped_temporary_package callable from the console

7839b6d

Fixes #141

Prefer capture_output() to capture.output()

d0f4be5

Add use_freshstarts()

bd93226

Move restart_rstudio()

4a4791f

Use todo() in stub for scope = "user"

98efb71

Reword prompt re: RStudio restart

706674f

Link to blog post; "implemented" -> "automated"

b79ad28

New name: use_blank_slate()

4879ae8

jennybc force-pushed the use-freshstarts branch from e1d59d8 to 4879ae8 Compare December 22, 2017 01:19

jennybc added 10 commits December 21, 2017 17:20

Merge branch 'scoped-temporary-things' into use-freshstarts

5fd5add

* scoped-temporary-things: Prefer capture_output() to capture.output() Make scoped_temporary_package callable from the console Move scoped_temporary_package() to test dir

Refactor Rproj processing

5a92a9e

Allow scoped_temporary_package() to make RStudio project

39c175b

Test creation and detection of RStudio projects

790804f

Test we can find templates vulnerable to Rbuildignore

ae23017

More specific Rbuildignore for usethis.Rproj

ae69005

Fixes #127

Remove .Rbuildignore from .gitignore

304bbed

More specific pattern re: Rbuildignoring .Rproj files

7a30793

Merge branch 'careful-rbuildignore' into use-freshstarts

678e65a

* careful-rbuildignore: More specific pattern re: Rbuildignoring .Rproj files Remove .Rbuildignore from .gitignore More specific Rbuildignore for usethis.Rproj Test we can find templates vulnerable to Rbuildignore

Tests around modifying an Rproj file

bb991ca

jennybc changed the title ~~Add use_freshstarts()~~ Add use_blank_slate() Dec 22, 2017

Form full path to Rproj file

c84c9d3

hadley reviewed Dec 22, 2017

View reviewed changes

Compare Rproj before/after based on lines

e15cc06

hadley approved these changes Dec 22, 2017

View reviewed changes

jennybc added 2 commits December 22, 2017 10:39

Don't need tools anymore

eeffae6

Simplify buildignoring for RStudio project that is a package

06cbe8f

hadley approved these changes Dec 22, 2017

View reviewed changes

Add NEWS bullet

dcad150

[skip ci]

jennybc merged commit 7f5dee2 into master Dec 22, 2017

This was referenced Dec 22, 2017

Less promiscuous Rbuildignoring #146

Closed

Make scoped_temporary_package() easier to work with #145

Closed

jennybc deleted the use-freshstarts branch December 22, 2017 19:15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add use_blank_slate() #139

Add use_blank_slate() #139

jennybc commented Dec 20, 2017 •

edited

Loading

jennybc Dec 20, 2017 •

edited

Loading

hadley Dec 20, 2017

jennybc Dec 20, 2017

jennybc Dec 20, 2017

hadley Dec 20, 2017

jennybc Dec 20, 2017

hadley Dec 20, 2017

hadley Dec 20, 2017

hadley Dec 20, 2017

hadley Dec 20, 2017

hadley Dec 20, 2017

hadley Dec 20, 2017

hadley Dec 20, 2017

hadley Dec 20, 2017

hadley Dec 20, 2017

jennybc Dec 22, 2017

jennybc Dec 22, 2017

hadley commented Dec 20, 2017

hadley Dec 22, 2017

jennybc Dec 22, 2017

hadley Dec 22, 2017

jennybc Dec 22, 2017

hadley Dec 22, 2017

hadley Dec 22, 2017

jennybc Dec 22, 2017

hadley Dec 22, 2017

jennybc Dec 22, 2017

jennybc commented Dec 22, 2017

hadley Dec 22, 2017

jennybc Dec 22, 2017

Add use_blank_slate() #139

Add use_blank_slate() #139

Conversation

jennybc commented Dec 20, 2017 • edited Loading

jennybc Dec 20, 2017 • edited Loading

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

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

hadley commented Dec 20, 2017

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

jennybc commented Dec 22, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jennybc commented Dec 20, 2017 •

edited

Loading

jennybc Dec 20, 2017 •

edited

Loading