make reactive input arguments explicit

dfe-analytical-services · Jul 19, 2024 · f3505d9 · f3505d9
1 parent 03263c7
commit f3505d9
Show file tree

Hide file tree

Showing 17 changed files with 72 additions and 44 deletions.
diff --git a/R/cookies.R b/R/cookies.R
@@ -33,10 +33,16 @@
 #'
 #' server <- function(input, output, session) {
 #'   # Server logic for the pop up banner, can be placed anywhere in server.R -
-#'   output$cookie_status <- dfeshiny::cookie_banner_server(google_analytics_key = ga_key)
+#'   output$cookie_status <- dfeshiny::cookie_banner_server(
+#'     input_cookies = reactive(input$cookies),
+#'     google_analytics_key = ga_key
+#'   )
 #'
 #'   # Server logic for the panel, can be placed anywhere in server.R ---------
-#'   cookies_panel_server(google_analytics_key = ga_key)
+#'   cookies_panel_server(
+#'     input_cookies = reactive(input$cookies),
+#'     google_analytics_key = ga_key
+#'   )
 #' }
 #'
 #' # How to run the minimal app give in this example ==========================

diff --git a/man/cookie_banner_server.Rd b/man/cookie_banner_server.Rd
diff --git a/man/cookie_banner_ui.Rd b/man/cookie_banner_ui.Rd
diff --git a/man/cookies.Rd b/man/cookies.Rd
diff --git a/man/cookies_panel_server.Rd b/man/cookies_panel_server.Rd
diff --git a/man/cookies_panel_ui.Rd b/man/cookies_panel_ui.Rd
diff --git a/tests/test_dashboard/global.R b/tests/test_dashboard/global.R
@@ -1,4 +1,4 @@
 library(shiny)
 devtools::load_all(path = "../../")
 
-google_analytics_key <- "ABCDE12345"
+ga_key <- "ABCDE12345"
diff --git a/tests/test_dashboard/server.R b/tests/test_dashboard/server.R
@@ -5,17 +5,12 @@ server <- function(input, output, session) {
   )
 
   output$cookie_status <- cookie_banner_server(
-    "cookies",
-    input_cookies = shiny::reactive(input$cookies),
-    parent_session = session,
-    google_analytics_key = google_analytics_key, # # nolint: [object_usage_linter]
-    cookie_link_panel = "cookies_panel_ui"
+    input_cookies = reactive(input$cookies),
+    google_analytics_key = ga_key # nolint: [object_usage_linter]
   )
 
-
   cookies_panel_server(
-    id = "cookies_panel",
-    input_cookies = shiny::reactive(input$cookies),
-    google_analytics_key = google_analytics_key # # nolint: [object_usage_linter]
+    input_cookies = reactive(input$cookies),
+    google_analytics_key = ga_key # nolint: [object_usage_linter]
   )
 }
diff --git a/tests/test_dashboard/tests/testthat/_snaps/cookie-auth/cookie_consent-001.json b/tests/test_dashboard/tests/testthat/_snaps/cookie-auth/cookie_consent-001.json
@@ -3,9 +3,9 @@
     "cookies": {
 
     },
-    "cookies-cookie_accept": 0,
-    "cookies-cookie_link": 0,
-    "cookies-cookie_reject": 0,
+    "cookies_banner-cookie_accept": 0,
+    "cookies_banner-cookie_link": 0,
+    "cookies_banner-cookie_reject": 0,
     "cookies_panel-cookies_analytics": "no",
     "cookies_panel-submit_btn": 0,
     "navlistPanel": "support_panel"

diff --git a/tests/test_dashboard/tests/testthat/_snaps/cookie-auth/cookie_consent-001_.new.png b/tests/test_dashboard/tests/testthat/_snaps/cookie-auth/cookie_consent-001_.new.png
diff --git a/tests/test_dashboard/tests/testthat/_snaps/cookie-auth/cookie_consent-001_.png b/tests/test_dashboard/tests/testthat/_snaps/cookie-auth/cookie_consent-001_.png
diff --git a/tests/test_dashboard/tests/testthat/_snaps/cookie-auth/cookie_consent-002.json b/tests/test_dashboard/tests/testthat/_snaps/cookie-auth/cookie_consent-002.json
@@ -3,9 +3,9 @@
     "cookies": {
       "dfe_analytics": "granted"
     },
-    "cookies-cookie_accept": 1,
-    "cookies-cookie_link": 0,
-    "cookies-cookie_reject": 0,
+    "cookies_banner-cookie_accept": 1,
+    "cookies_banner-cookie_link": 0,
+    "cookies_banner-cookie_reject": 0,
     "cookies_panel-cookies_analytics": "yes",
     "cookies_panel-submit_btn": 0,
     "navlistPanel": "support_panel"

diff --git a/tests/test_dashboard/tests/testthat/_snaps/cookie-auth/cookie_consent-003.json b/tests/test_dashboard/tests/testthat/_snaps/cookie-auth/cookie_consent-003.json
@@ -3,9 +3,9 @@
     "cookies": {
       "dfe_analytics": "denied"
     },
-    "cookies-cookie_accept": 1,
-    "cookies-cookie_link": 0,
-    "cookies-cookie_reject": 1,
+    "cookies_banner-cookie_accept": 1,
+    "cookies_banner-cookie_link": 0,
+    "cookies_banner-cookie_reject": 1,
     "cookies_panel-cookies_analytics": "no",
     "cookies_panel-submit_btn": 0,
     "navlistPanel": "support_panel"

diff --git a/tests/test_dashboard/tests/testthat/_snaps/cookie-auth/cookie_consent-004.json b/tests/test_dashboard/tests/testthat/_snaps/cookie-auth/cookie_consent-004.json
@@ -3,9 +3,9 @@
     "cookies": {
       "dfe_analytics": "granted"
     },
-    "cookies-cookie_accept": 1,
-    "cookies-cookie_link": 0,
-    "cookies-cookie_reject": 1,
+    "cookies_banner-cookie_accept": 1,
+    "cookies_banner-cookie_link": 0,
+    "cookies_banner-cookie_reject": 1,
     "cookies_panel-cookies_analytics": "yes",
     "cookies_panel-submit_btn": 1,
     "navlistPanel": "support_panel"

diff --git a/tests/test_dashboard/tests/testthat/_snaps/cookie-auth/cookie_consent-005.json b/tests/test_dashboard/tests/testthat/_snaps/cookie-auth/cookie_consent-005.json
@@ -3,9 +3,9 @@
     "cookies": {
       "dfe_analytics": "denied"
     },
-    "cookies-cookie_accept": 1,
-    "cookies-cookie_link": 0,
-    "cookies-cookie_reject": 1,
+    "cookies_banner-cookie_accept": 1,
+    "cookies_banner-cookie_link": 0,
+    "cookies_banner-cookie_reject": 1,
     "cookies_panel-cookies_analytics": "no",
     "cookies_panel-submit_btn": 2,
     "navlistPanel": "support_panel"

diff --git a/tests/test_dashboard/tests/testthat/test-cookie-auth.R b/tests/test_dashboard/tests/testthat/test-cookie-auth.R
@@ -21,13 +21,13 @@ test_that("App loads", {
   app$expect_values()
 })
 
-app$click("cookies-cookie_accept")
+app$click("cookies_banner-cookie_accept")
 test_that("Cookies accepted banner", {
   # Capture initial values
   app$expect_values()
 })
 
-app$click("cookies-cookie_reject")
+app$click("cookies_banner-cookie_reject")
 test_that("Cookies rejected banner", {
   # Capture initial values
   app$expect_values()

diff --git a/tests/test_dashboard/ui.R b/tests/test_dashboard/ui.R
@@ -11,7 +11,7 @@ ui <- function(input, output, session) {
       publication_link = "https://explore-education-statistics.service.gov.uk/find-statistics/pupil-attendance-in-schools" # nolint: [line_length_linter]
     ),
     dfe_cookie_script(),
-    cookie_banner_ui("cookies"),
+    cookie_banner_ui(name = "My DfE R-Shiny data dashboard"),
     shiny::navlistPanel(
       "",
       id = "navlistPanel",
@@ -22,10 +22,7 @@ ui <- function(input, output, session) {
         repo_name = "https://github.com/dfe-analytical-services/dfeshiny/",
         form_url = "https://forms.office.com"
       ),
-      cookies_panel_ui(
-        id = "cookies_panel",
-        google_analytics_key = google_analytics_key
-      ) # # nolint: [object_usage_linter]
+      cookies_panel_ui(google_analytics_key = ga_key) # nolint: [object_usage_linter]
     )
   )
 }