Merge pull request #5 from cb4ds/cran

Cran
agenius-mohammed-ali · Mar 31, 2021 · dbc0440 · dbc0440
2 parents c60ab97 + 66258c9
commit dbc0440
Show file tree

Hide file tree

Showing 17 changed files with 61 additions and 46 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,7 +1,7 @@
 Package: periscope
 Type: Package
 Title: Enterprise Streamlined 'Shiny' Application Framework
-Version: 0.6.2.9001
+Version: 0.6.3.9002
 Authors@R: c(
     person("Constance", "Brett", email="[email protected]", role = c("aut", "cre")),
     person("Isaac", "Neuhaus", role = "aut", comment = "canvasXpress JavaScript Library Maintainer"),
@@ -17,7 +17,6 @@ BugReports: https://github.com/cb4ds/periscope/issues
 License: GPL-3
 Encoding: UTF-8
 Language: en-US
-LazyData: true
 Depends:
     R (>= 3.5)
 Imports:
@@ -34,8 +33,8 @@ RoxygenNote: 7.1.1
 Suggests:
     knitr,
     rmarkdown,
-    testthat,
     shinydashboardPlus,
+    testthat (>= 3.0),
     canvasXpress,
     openxlsx (>= 3.0)
 VignetteBuilder: knitr
diff --git a/NEWS.md b/NEWS.md
@@ -1,5 +1,8 @@
 #Revisions and Change Log
 
+### v0.6.2
+* Bugfix for the right sidebar when using shinydashboardPlus 2.0 - first tab was disappearing
+
 ### v0.6.1
 * Updated to provide handling for shinydashboardPlus old (<= 0.7.5) and new versions (2.X)
 * Removed import less-than requirement designation for shinydashboardPlus

diff --git a/R/fw_helpers_external.R b/R/fw_helpers_external.R
@@ -51,7 +51,11 @@ fw_create_header <- function() {
 
 # Framework UI Header Creation that includes a right sidebar
 fw_create_header_plus <- function(sidebar_right_icon = shiny::isolate(.g_opts$sidebar_right_icon)) {
-    if (utils::packageVersion('shinydashboardPlus') < 2) {
+    if (!(.g_sdp_installed)) {
+        stop('shinydashboardPlus is not installed')
+    }
+
+    if (.g_sdp_oldver) {
         plus_fxn <- getExportedValue("shinydashboardPlus", "dashboardHeaderPlus")
         arg_list <- list(enable_rightsidebar = TRUE, 
                          rightSidebarIcon = sidebar_right_icon)
@@ -119,14 +123,18 @@ fw_create_sidebar <- function(showsidebar = shiny::isolate(.g_opts$show_left_sid
 
 # Framework UI Right Sidebar Creation
 fw_create_right_sidebar <- function() {
+    if (!(.g_sdp_installed)) {
+        stop('shinydashboardPlus is not installed')
+    }
+
     side_right <- shiny::isolate(.g_opts$side_right)
 
     params <- list(shinyBS::bsAlert("sidebarRightAlert"))
     if (!is.null(side_right) && length(side_right) > 0) {
         params <- c(params, side_right)
     }
 
-    if (utils::packageVersion('shinydashboardPlus') < 2) {
+    if (.g_sdp_oldver) {
         plus_fxn <- getExportedValue("shinydashboardPlus", "rightSidebar")
     } else {
         plus_fxn <- getExportedValue("shinydashboardPlus", "dashboardControlbar")

diff --git a/R/fw_helpers_internal.R b/R/fw_helpers_internal.R
@@ -61,7 +61,7 @@
 
 .right_sidebar_injection <- function() {
     value <- NULL
-    if (utils::packageVersion('shinydashboardPlus') < 2) {
+    if (.g_sdp_oldver) {
         shiny::tags$script(shiny::HTML("setTimeout(function() {
                                             $('[class~=\"control-sidebar-tabs\"]').find('li:first').remove();
                                        }, 5000);"))

diff --git a/R/generate_template.R b/R/generate_template.R
@@ -6,7 +6,7 @@
 #' framework.  The application can be created either empty (default) or with a
 #' sample/documented example application.\cr \cr A running instance of the exact 
 #' sample application that will be created is
-#' \href{http://periscopeapps.org:3838/framework_template}{hosted here} if you
+#' \href{http://periscopeapps.org:3838/periscope_template}{hosted here} if you
 #' would like to see the sample application before creating your own copy.
 #'
 #' @param name name for the new application and directory
@@ -148,6 +148,10 @@ create_new_application <- function(name, location, sampleapp = FALSE, resetbutto
             }
         }
 
+        if (!(.g_sdp_installed)) {
+            stop('shinyDashboardPlus is not currently installed -- it is required to generate an application with a right sidebar.')
+        }
+
         .create_dirs(newloc, usersep)
         .copy_fw_files(newloc, usersep, resetbutton, dashboard_plus, leftsidebar, right_sidebar_icon, style)
         .copy_program_files(newloc, usersep, sampleapp, resetbutton, leftsidebar, dashboard_plus)

diff --git a/R/periscope.R b/R/periscope.R
@@ -40,9 +40,16 @@
 #' @name periscope
 NULL
 
+.g_sdp_installed <- FALSE
+.g_sdp_oldver    <- FALSE
 
 .onLoad <- function(libname, pkgname) {
-    #TBD
+    if (length(find.package('shinydashboardPlus', quiet = T)) > 0) {
+        if (utils::packageVersion('shinydashboardPlus') < 2) {
+            .g_sdp_oldver <<- TRUE
+        }
+        .g_sdp_installed <<- TRUE
+    }
 }
 
 .onAttach <- function(libname, pkgname) {

diff --git a/cran-comments.md b/cran-comments.md
@@ -1,9 +1,8 @@
 ## Comments from Maintainer
 
-* 0.6.1 - our host had issues and we needed a few redirect fixes.  Solved!  Apologies.
+* Right Sidebar Bug fix for ShinyDashboardPlus 2.0 compatibility
 
-* Updated the package to handle both the old and new releases of shinydashboardPlus
-* Updated tests, fixed a few minor bugs
+* There is a NOTE due to the short time between submissions, this is an important bugfix enabling right-sidebar applications to be generated for ShinyDashboardPlus 2.0 and I kindly ask for your exception to allow this release.
 
 ---  
 
@@ -19,7 +18,7 @@ Travis-CI (Ubuntu 16.04.6)
 
 * R 3.6.3
 * R 4.0.2
-* R devel (2021-03-11 r80086)
+* R devel (2021-03-17 r80092)
 
 WinBuilder
 

diff --git a/inst/fw_templ/p_example/server_local.R b/inst/fw_templ/p_example/server_local.R
@@ -93,7 +93,7 @@ output$download <- renderUI({
 
 output$alerts   <- renderUI({
     list(hr(),
-         p("There are three standardized locations for alerts. To create ",
+         p("There are three standardized locations for alerts in this app. To create ",
            "an alert call the following on the server: ",
            pre('S: createAlert(session, location, content = "Alert Text", ...)'),
            'LOCATION can be: "sidebarBasicAlert", "sidebarAdvancedAlert", ',
@@ -111,7 +111,6 @@ output$alerts   <- renderUI({
              bsButton( "exampleBodyAlert",
                        label  = "Body",
                        style  = "info",
-                       append = FALSE,
                        width  = "25%")) )
     })
 

diff --git a/inst/fw_templ/p_example/server_local_no_left.R b/inst/fw_templ/p_example/server_local_no_left.R
@@ -93,7 +93,7 @@ output$download <- renderUI({
 
 output$alerts   <- renderUI({
     list(hr(),
-         p("There are three standardized locations for alerts. To create ",
+         p("There is one standardized location for alerts in this app. To create ",
            "an alert call the following on the server: ",
            pre('S: createAlert(session, location, content = "Alert Text", ...)'),
            'LOCATION can be: "bodyAlert", See the ', em("alertBS"),
@@ -102,7 +102,6 @@ output$alerts   <- renderUI({
              bsButton( "exampleBodyAlert",
                        label  = "Body",
                        style  = "info",
-                       append = FALSE,
                        width  = "25%")) )
     })
 

diff --git a/inst/fw_templ/p_example/server_local_plus.R b/inst/fw_templ/p_example/server_local_plus.R
@@ -124,7 +124,7 @@ output$download <- renderUI({
 
 output$alerts   <- renderUI({
     list(hr(),
-         p("There are three standardized locations for alerts. To create ",
+         p("There are four standardized locations for alerts in this app. To create ",
            "an alert call the following on the server: ",
            pre('S: createAlert(session, location, content = "Alert Text", ...)'),
            'LOCATION can be: "sidebarBasicAlert", "sidebarAdvancedAlert", "sidebarRightAlert", ',
@@ -134,20 +134,19 @@ output$alerts   <- renderUI({
              bsButton( "exampleBasicAlert",
                        label  = "Sidebar - Basic",
                        style  = "success",
-                       width  = "25%"),
+                       width  = "20%"),
+             bsButton( "exampleBodyAlert",
+                       label  = "Body",
+                       style  = "info",
+                       width  = "20%"),
              bsButton( "exampleAdvancedAlert",
                        label  = "Sidebar - Advanced",
                        style  = "warning",
-                       width  = "25%"),
+                       width  = "20%"),
              bsButton( "exampleRightAlert",
                        label  = "Sidebar - Right",
                        style  = "danger",
-                       width  = "25%"),
-             bsButton( "exampleBodyAlert",
-                       label  = "Body",
-                       style  = "info",
-                       append = FALSE,
-                       width  = "25%")) )
+                       width  = "20%") ) )
     })
 
 output$loginfo <- renderUI({

diff --git a/inst/fw_templ/p_example/server_local_plus_no_left.R b/inst/fw_templ/p_example/server_local_plus_no_left.R
@@ -124,16 +124,19 @@ output$download <- renderUI({
 
 output$alerts   <- renderUI({
     list(hr(),
-         p("There are three standardized locations for alerts. To create ",
+         p("There are two standardized locations for alerts in this app. To create ",
            "an alert call the following on the server: ",
            pre('S: createAlert(session, location, content = "Alert Text", ...)'),
-           'LOCATION can be: "bodyAlert", See the ', em("alertBS"),
+           'LOCATION can be: "bodyAlert" and "sidebarRightAlert", See the ', em("alertBS"),
            "documentation for more information on styles and other options"),
          div(align = "center",
              bsButton( "exampleBodyAlert",
                        label  = "Body",
                        style  = "info",
-                       append = FALSE,
+                       width  = "25%"),
+             bsButton( "exampleRightAlert",
+                       label  = "Sidebar - Right",
+                       style  = "danger",
                        width  = "25%")) )
 })
 

diff --git a/man/create_new_application.Rd b/man/create_new_application.Rd
diff --git a/tests/testthat/sample_app/program/server_local.R b/tests/testthat/sample_app/program/server_local.R
@@ -93,7 +93,7 @@ output$download <- renderUI({
 
 output$alerts   <- renderUI({
     list(hr(),
-         p("There are three standardized locations for alerts. To create ",
+         p("There are three standardized locations for alerts in this app. To create ",
            "an alert call the following on the server: ",
            pre('S: createAlert(session, location, content = "Alert Text", ...)'),
            'LOCATION can be: "sidebarBasicAlert", "sidebarAdvancedAlert", ',
@@ -111,7 +111,6 @@ output$alerts   <- renderUI({
              bsButton( "exampleBodyAlert",
                        label  = "Body",
                        style  = "info",
-                       append = FALSE,
                        width  = "25%")) )
     })
 

diff --git a/tests/testthat/sample_app_both_sidebar/program/server_local.R b/tests/testthat/sample_app_both_sidebar/program/server_local.R
@@ -124,7 +124,7 @@ output$download <- renderUI({
 
 output$alerts   <- renderUI({
     list(hr(),
-         p("There are three standardized locations for alerts. To create ",
+         p("There are four standardized locations for alerts in this app. To create ",
            "an alert call the following on the server: ",
            pre('S: createAlert(session, location, content = "Alert Text", ...)'),
            'LOCATION can be: "sidebarBasicAlert", "sidebarAdvancedAlert", "sidebarRightAlert", ',
@@ -134,20 +134,19 @@ output$alerts   <- renderUI({
              bsButton( "exampleBasicAlert",
                        label  = "Sidebar - Basic",
                        style  = "success",
-                       width  = "25%"),
+                       width  = "20%"),
              bsButton( "exampleAdvancedAlert",
                        label  = "Sidebar - Advanced",
                        style  = "warning",
-                       width  = "25%"),
-             bsButton( "exampleRightAlert",
-                       label  = "Sidebar - Right",
-                       style  = "danger",
-                       width  = "25%"),
+                       width  = "20%"),
              bsButton( "exampleBodyAlert",
                        label  = "Body",
                        style  = "info",
-                       append = FALSE,
-                       width  = "25%")) )
+                       width  = "20%"),
+             bsButton( "exampleRightAlert",
+                       label  = "Sidebar - Right",
+                       style  = "danger",
+                       width  = "20%")) )
     })
 
 output$loginfo <- renderUI({

diff --git a/tests/testthat/sample_app_no_sidebar/program/server_local.R b/tests/testthat/sample_app_no_sidebar/program/server_local.R
@@ -93,7 +93,7 @@ output$download <- renderUI({
 
 output$alerts   <- renderUI({
     list(hr(),
-         p("There are three standardized locations for alerts. To create ",
+         p("There is one standardized location for alerts. To create ",
            "an alert call the following on the server: ",
            pre('S: createAlert(session, location, content = "Alert Text", ...)'),
            'LOCATION can be: "bodyAlert", See the ', em("alertBS"),
@@ -102,7 +102,6 @@ output$alerts   <- renderUI({
              bsButton( "exampleBodyAlert",
                        label  = "Body",
                        style  = "info",
-                       append = FALSE,
                        width  = "25%")) )
     })
 

diff --git a/tests/testthat/sample_app_no_sidebar_no_resetbutton/program/server_local.R b/tests/testthat/sample_app_no_sidebar_no_resetbutton/program/server_local.R
@@ -93,7 +93,7 @@ output$download <- renderUI({
 
 output$alerts   <- renderUI({
     list(hr(),
-         p("There are three standardized locations for alerts. To create ",
+         p("There is one standardized location for alerts. To create ",
            "an alert call the following on the server: ",
            pre('S: createAlert(session, location, content = "Alert Text", ...)'),
            'LOCATION can be: "bodyAlert", See the ', em("alertBS"),
@@ -102,7 +102,6 @@ output$alerts   <- renderUI({
              bsButton( "exampleBodyAlert",
                        label  = "Body",
                        style  = "info",
-                       append = FALSE,
                        width  = "25%")) )
     })
 

diff --git a/tests/testthat/sample_app_r_sidebar/program/server_local.R b/tests/testthat/sample_app_r_sidebar/program/server_local.R
@@ -124,7 +124,7 @@ output$download <- renderUI({
 
 output$alerts   <- renderUI({
     list(hr(),
-         p("There are three standardized locations for alerts. To create ",
+         p("There is one standardized location for alerts. To create ",
            "an alert call the following on the server: ",
            pre('S: createAlert(session, location, content = "Alert Text", ...)'),
            'LOCATION can be: "bodyAlert", See the ', em("alertBS"),
@@ -133,7 +133,6 @@ output$alerts   <- renderUI({
              bsButton( "exampleBodyAlert",
                        label  = "Body",
                        style  = "info",
-                       append = FALSE,
                        width  = "25%")) )
 })