add 'New Shiny App' dialog #528

kevinushey · 2015-11-16T23:32:09Z

Not quite ready for merge (still needs tweaks to UI + failure modes).

This PR adds a 'New Shiny Application' command to the 'Files' menu. Demo:

TODO

Icon for the menu item
How should we use the 'application name' element?
Consider a slightly less lightweight UI (?)
Failure modes (what to do if app.R, ui.R or server.R already exist (probably show an error dialog)?

kevinushey · 2015-11-16T23:33:10Z

app.R

+# This is a single-file Shiny web application.
+# You can find out more about building applications with Shiny here:
+#
+# http://www.rstudio.com/shiny/


Should this now be http://shiny.rstudio.com/?

kevinushey · 2015-11-16T23:35:46Z

src/cpp/session/modules/shiny/SessionShiny.cpp

+   else if (appType == kShinyAppTypeMultiFile)
+   {
+      // ui.R
+      copyTemplateFile("ui.R", appDir.complete("ui.R"), &result);


It's possible that we create ui.R, but fail to create server.R (or vice versa) and end up with leftovers. We should should verify that the files we're attempting to create don't exist beforehand.

kevinushey · 2015-11-16T23:44:58Z

src/gwt/src/org/rstudio/studio/client/workbench/views/source/Source.java

@@ -1054,6 +1057,91 @@ public void onNewRMarkdownDoc()
         newRMarkdownV1Doc();
   }

+   private void doNewRShinyApp(NewShinyWebApplication.Result result)
+   {
+      server_.createShinyApp(


Should also verify that Shiny is installed. (now done using dependencyManager_)

jjallaire · 2015-11-17T11:16:08Z

src/cpp/session/projects/SessionProjects.cpp

@@ -74,6 +74,17 @@ Error validateProjectPath(const json::JsonRpcRequest& request,
   return Success();
 }

+Error getWorkingDirectory(const json::JsonRpcRequest& request,


You don't need this since WorkbenchContext already has a method to get the current working directory (it's kept in sync as the working dir changes): https://github.com/rstudio/rstudio/blob/master/src/gwt/src/org/rstudio/studio/client/workbench/WorkbenchContext.java#L116-L119

jjallaire · 2015-11-17T11:37:05Z

@jjallaire: To overcome the fact that the dialog isn't immediately centered you need to create a static ensureStylesInjected method and call it from here: https://github.com/rstudio/rstudio/blob/master/src/gwt/src/org/rstudio/studio/client/RStudio.java#L208

@kevinushey: This was actually just an artefact of how I recorded the screencast (the bottom of the RStudio window was cut off; it does indeed open in the middle of the window)

jjallaire · 2015-11-17T11:38:00Z

@jjallaire: Saw that you had a todo for a more lightweight UI. I think a full-on dialog is fully appropriate for this level of user action.

@kevinushey: I was actually thinking the current version might be too lightweight (the help link helps to balance it out a lot)

jjallaire · 2015-11-17T11:40:07Z

The 'application name' should be the name of the directory created for the app. The "directory" is the parent directory for the application (so we may want to say "Create within directory" or something like that). To reinforce the fact that the directory is somewhat secondary you could do an alternate treatment like the one here:

Let's discuss this when you come in.

jjallaire · 2015-11-17T11:41:07Z

We'll want to preserve the user's choice for parent directory and application type using persistent client state (I think this can be global persistent client state as opposed to temporary or per-project)

jjallaire · 2015-11-17T11:42:02Z

After creating the application we'll want to open the source files within the editor. For ui.R and server.R we need to decide what order to open them in and which one to set focus to. I'd move we set focus to ui.R

jjallaire · 2015-11-17T11:42:47Z

For the icon let's use our standard shiny icon (but I'm not sure we have a command sized version of that, I'll check with Paul).

jjallaire · 2015-11-17T12:00:30Z

We might want to use a dialog layout that results in a bit larger dialog. Something like this:

I also think that we should add a left gutter widget in the dialog with a HelpLink (https://github.com/rstudio/rstudio/blob/master/src/gwt/src/org/rstudio/studio/client/common/HelpLink.java) control with caption "Shiny Web Applications" that links to shiny.rstudio.com

kevinushey · 2015-11-17T22:15:08Z

The icon unfortunately looks a bit out of place (all the other icons use the 'file' image as a background while the new one doesn't):

But then again, the dialog doesn't necessarily create just a single file, so I'm not sure if we really would want the file background...

kevinushey · 2015-11-17T22:33:07Z

The current view:

kevinushey · 2015-11-17T23:20:23Z

Alternate format using radio buttons (beefs up the widget a little bit + reduces number of clicks to change app type)

kevinushey · 2015-11-17T23:54:07Z

Thinking a bit more, are we sure we want to cache the directory where we create the Shiny application? IMO it seems more likely that one would want it to be part of the current project (if within an RStudio project).

That is, it seems to me like this action is more likely to be used to add a Shiny application to an existing project, and so it makes sense to make the project directory the default.

Perhaps we can chat about this (and other outstanding issues) sometime tomorrow?

jjallaire · 2015-11-18T12:22:30Z

Unfortunately the use of projects is not at all widespread so I don't think
that logic is as compelling as it is at first glance.

That said, we have an easy way to detect that a project is in use so
perhaps we do this:

If the user is in a project then use the current project's root
directory;
If the user is not in a project then use the sticky value.

On Tue, Nov 17, 2015 at 6:54 PM, Kevin Ushey notifications@github.com
wrote:

Thinking a bit more, are we sure we want to cache the directory where we
create the Shiny application? IMO it seems more likely that one would want
it to be part of the current project (if within an RStudio project).

That is, it seems to me like this action is more likely to be used to add
a Shiny application to an existing project, and so it makes sense to make
the project directory the default.

—
Reply to this email directly or view it on GitHub
#528 (comment).

…shiny-app

kevinushey · 2015-11-18T17:37:57Z

Agree on both fronts -- I'll take a stab at implementing this.

add 'New Shiny App' dialog

kevinushey reviewed Nov 16, 2015
View reviewed changes

kevinushey force-pushed the feature/create-new-shiny-app branch from 493656d to 0b7f3b4 Compare November 16, 2015 23:33

kevinushey reviewed Nov 16, 2015
View reviewed changes

add 'New Shiny App' dialog

d35dc98

kevinushey force-pushed the feature/create-new-shiny-app branch from f9ab701 to d35dc98 Compare November 16, 2015 23:43

kevinushey reviewed Nov 16, 2015
View reviewed changes

kevinushey added 3 commits November 16, 2015 15:47

ensure Shiny installed / available

45dcf7d

remove unneeded log

eacc436

only attempt file creation if no files already exist

ad5d695

jjallaire reviewed Nov 17, 2015
View reviewed changes

kevinushey added 2 commits November 17, 2015 10:17

use WorkbenchContext to get working dir

cbe9abf

improve error reporting

488c6a9

kevinushey added 2 commits November 17, 2015 14:06

add to global toolbar

f6349ed

add icon

1fc4eb0

kevinushey added 4 commits November 17, 2015 14:18

use showErrorMessage overload that focuses on dismiss

5b415b3

update templates

0697d5e

add ctor parameter to select whether clientinfo msg used

da1cc7c

expand dialog a bit more

8e584ca

small amount of padding for TextBox fields

377a7bb

kevinushey added 3 commits November 17, 2015 15:21

use RadioButtons instead of SelectWidget

8a6a31d

use constants for radio button values

e1836a4

use cached app name if available

e25d747

jjallaire added 7 commits November 18, 2015 07:34

Merge remote-tracking branch 'origin/master' into feature/create-new-…

af0adcb

…shiny-app

miscellaneous ui tweaks

c797f2d

revised new shiny web app icon

88ce8c7

improve shiny web application templates

0601181

more vertical spacing after directory chooser

9af9739

add shiny icon to new shiny web app dialog

88ba6de

opened files: ui.R then server.R (set focus to ui.R)

802dc4a

kevinushey added 4 commits November 18, 2015 09:51

use project dir as default (if available)

f7595f8

default to empty app name

be1644e

tweak field name for persisted options

927ca5b

don't reuse cached app name

effce42

jjallaire added a commit that referenced this pull request Nov 18, 2015

Merge pull request #528 from rstudio/feature/create-new-shiny-app

d581382

add 'New Shiny App' dialog

jjallaire merged commit d581382 into master Nov 18, 2015

jjallaire deleted the feature/create-new-shiny-app branch November 18, 2015 18:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add 'New Shiny App' dialog #528

add 'New Shiny App' dialog #528

kevinushey commented Nov 16, 2015

kevinushey Nov 16, 2015

kevinushey Nov 16, 2015

kevinushey Nov 16, 2015

jjallaire Nov 17, 2015

jjallaire commented Nov 17, 2015

jjallaire commented Nov 17, 2015

jjallaire commented Nov 17, 2015

jjallaire commented Nov 17, 2015

jjallaire commented Nov 17, 2015

jjallaire commented Nov 17, 2015

jjallaire commented Nov 17, 2015

kevinushey commented Nov 17, 2015

kevinushey commented Nov 17, 2015

kevinushey commented Nov 17, 2015

kevinushey commented Nov 17, 2015

jjallaire commented Nov 18, 2015

kevinushey commented Nov 18, 2015

add 'New Shiny App' dialog #528

add 'New Shiny App' dialog #528

Conversation

kevinushey commented Nov 16, 2015

TODO

kevinushey Nov 16, 2015

Choose a reason for hiding this comment

kevinushey Nov 16, 2015

Choose a reason for hiding this comment

kevinushey Nov 16, 2015

Choose a reason for hiding this comment

jjallaire Nov 17, 2015

Choose a reason for hiding this comment

jjallaire commented Nov 17, 2015

jjallaire commented Nov 17, 2015

jjallaire commented Nov 17, 2015

jjallaire commented Nov 17, 2015

jjallaire commented Nov 17, 2015

jjallaire commented Nov 17, 2015

jjallaire commented Nov 17, 2015

kevinushey commented Nov 17, 2015

kevinushey commented Nov 17, 2015

kevinushey commented Nov 17, 2015

kevinushey commented Nov 17, 2015

jjallaire commented Nov 18, 2015

kevinushey commented Nov 18, 2015