Remove is.layout, layout_container_id, and redundant component test#121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rpkyle merged 16 commits into from
May 26, 2020
Merged

Remove is.layout, layout_container_id, and redundant component test #121

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
a98b1be
:hocho: is.layout + layout_container_id
Aug 23, 2019
6002ea2
:hocho: overzealous component test
Aug 23, 2019
6d959dd
resolve merge conflict
Aug 23, 2019
1d0db3c
Merge branch 'dev' into 120-remove-layout-container
rpkyle Jan 13, 2020
4a65265
Merge branch 'dev' into 120-remove-layout-container
rpkyle Apr 8, 2020
2f6b50d
Merge branch 'dev' into 120-remove-layout-container
rpkyle Apr 22, 2020
8349974
:hammer: try to leave layout as-is
Apr 22, 2020
98d3049
remove container test
Apr 22, 2020
56ad73e
Merge branch 'dev' into 120-remove-layout-container
rpkyle May 20, 2020
e6e6770
Merge branch '120-remove-layout-container' of github.com:plotly/dashR…
May 20, 2020
07b7036
temporarily disable tests
May 25, 2020
6e3053e
:bug: :hammer: refactor to require component/tree of components
May 25, 2020
8233d35
:hammer: :rotating_light: fix unit test
May 25, 2020
930f53b
:hammer: :bug: fix duplicated ID handling
May 25, 2020
4f46264
:rotating_light: update unit test, +1 more
May 25, 2020
c7ec219
fix wildcards test
May 25, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 17 additions & 21 deletions R/dash.R
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -79,7 +79,7 @@
#'
#' @section Methods:
#' \describe{
#' \item{`layout(...)`}{
#' \item{`layout(value)`}{
#' Set the layout (i.e., user interface). The layout should be either a
#' collection of Dash components (e.g., [dccSlider], [htmlDiv], etc) or
#' a function which returns a collection of components.
Expand DownExpand Up@@ -771,8 +771,10 @@ Dash <- R6::R6Class(
layout_get = function(render = TRUE) {
if (render) private$layout_render() else private$layout_
},
layout = function(...) {
private$layout_ <- if (is.function(..1)) ..1 else list(...)
# layout = function(...) {
layout = function(value) {
# private$layout_ <- if (is.function(..1)) ..1 else list(...)
private$layout_ <- value
# render the layout, and then return the rendered layout without printing
invisible(private$layout_render())
},
Expand DownExpand Up@@ -1186,20 +1188,11 @@ Dash <- R6::R6Class(
layout_ = NULL,
layout_ids = NULL,
layout_render = function() {
# assuming private$layout is either a function or a list of components...
layout_ <- if (is.function(private$layout_)) private$layout_() else private$layout_

# accommodate functions that return a single component
if (is.component(layout_)) layout_ <- list(layout_)

# make sure we are working with a list of components
layout_ <- lapply(layout_, private$componentify)

# Put the list of components into a container div. I'm pretty sure dash
# requires the layout to be one component, but R folks are used to
# being able to supply "components" to ...
layout_ <- dashHtmlComponents::htmlDiv(children = layout_, id = layout_container_id())


# ensure that the layout is a component, or a collection of components
layout_ <- private$componentify(layout_)

# store the layout as a (flattened) vector form since we query the
# vector names several times to verify ID naming (among other things)
layout_flat <- rapply(layout_, I)
Expand All@@ -1210,19 +1203,23 @@ Dash <- R6::R6Class(
if (!length(idx)) {
warning(
"No ids were found in the layout. ",
"Component ids are critical for targetting callbacks in your application",
"Component ids are critical for targeting callbacks in your application",
call. = FALSE
)
}
private$layout_ids <- as.character(layout_flat[idx])
duped <- anyDuplicated(private$layout_ids)
layout_ids <- as.character(layout_flat[idx])
duped <- anyDuplicated(layout_ids) > 0

if (duped) {
duped_ids <- paste(layout_ids[duplicated(layout_ids)], collapse = ", ")

stop(
sprintf("layout ids must be unique -- the following id was duplicated: '%s'", private$layout_ids[duped]),
sprintf("layout ids must be unique -- please check the following list of duplicated ids: '%s'", duped_ids),
call. = FALSE
)
}

private$layout_ids <- layout_ids
# load package-level HTML dependencies from attached pkgs
metadataFns <- lapply(.packages(), getDashMetadata)
metadataFns <- metadataFns[lengths(metadataFns) != 0]
Expand DownExpand Up@@ -1709,7 +1706,6 @@ Dash <- R6::R6Class(
)

validate_dependency <- function(layout_, dependency) {
if (!is.layout(layout_)) stop("`layout` must be a dash layout object", call. = FALSE)
if (!is.dependency(dependency)) stop("`dependency` must be a dash dependency object", call. = FALSE)

valid_props <- component_props_given_id(layout_, dependency$id)
Expand Down
9 changes: 0 additions & 9 deletions R/utils.R
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,15 +15,6 @@ is.event <- function(x) is.dependency(x) && inherits(x, "event")
# components (TODO: this should be exported by dashRtranspile!)
is.component <- function(x) inherits(x, "dash_component")

# layout is really a special type of component
is.layout <- function(x) {
is.component(x) && identical(x[["props"]][["id"]], layout_container_id())
}

layout_container_id <- function() {
"_dashR-layout-container"
}

# retrieve the arguments of a callback function that are dash inputs
callback_inputs <- function(func) {
compact(lapply(formals(func), function(x) {
Expand Down
9 changes: 3 additions & 6 deletions tests/testthat/test-dash.R
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,15 +12,12 @@ test_that("Can set/get layout", {

d <- Dash$new()
div <- htmlDiv("A div", id = "An id")

# rendered layout has a container div
d$layout(div)

l <- d$layout_get()
expect_true(dash:::is.layout(l))
expect_identical(l$props$children[[1]], div)


# dynamic layouts
d$layout(function() { div })
d$layout(function() { htmlDiv("A div", id = "An id") })
l2 <- d$layout_get()
expect_identical(l, l2)
expect_is(d$layout_get(render = FALSE), "function")
Expand Down
18 changes: 14 additions & 4 deletions tests/testthat/test-layout.R
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,11 +2,21 @@ context("layout")

test_that("layout IDs must be unique", {

app <- Dash$new()
app <- Dash$new()

expect_error(
app$layout(htmlA(id = "a"), htmlA(id = "a")),
"layout ids must be unique -- the following id was duplicated: 'a'"
expect_error(
app$layout(htmlDiv(list(htmlA(id = "a"), htmlA(id = "a"), htmlP(id="b"), htmlP(id="c"), htmlA(id="c")))),
"layout ids must be unique -- please check the following list of duplicated ids: 'a, c'"
)

})

test_that("app$layout() only accepts components, or functions that return components", {
app <- Dash$new()

expect_error(
app$layout(htmlA(id = "a"), htmlA(id = "a")),
'unused argument (htmlA(id = "a"))',
fixed = TRUE)

})
2 changes: 1 addition & 1 deletion tests/testthat/test-wildcards.R
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ test_that("HTML `data-*` & `aria-* ` wildcards are passed along to layout approp
app <- Dash$new()
app$layout(htmlDiv(id = "foo", `data-foo` = 1))
x <- app$layout_get()
expect_equal(x$props$children[[1]]$props$`data-foo`, 1)
expect_equal(x$props$`data-foo`, 1)
})

# TODO: test NULL values aren't rendered on the HTML div
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Remove is.layout, layout_container_id, and redundant component test#121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

rpkyle
merged 16 commits into

from

May 26, 2020
 Merged


Remove is.layout, layout_container_id, and redundant component test
#121
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


16 commits


Select commit
Hold shift + click to select a range
a98b1be

:hocho: is.layout + layout_container_id

Aug 23, 2019
6002ea2

:hocho: overzealous component test

Aug 23, 2019
6d959dd

resolve merge conflict

Aug 23, 2019
1d0db3c

Merge branch 'dev' into 120-remove-layout-container


rpkyle Jan 13, 2020
4a65265

Merge branch 'dev' into 120-remove-layout-container


rpkyle Apr 8, 2020
2f6b50d

Merge branch 'dev' into 120-remove-layout-container


rpkyle Apr 22, 2020
8349974

:hammer: try to leave layout as-is

Apr 22, 2020
98d3049

remove container test

Apr 22, 2020
56ad73e

Merge branch 'dev' into 120-remove-layout-container


rpkyle May 20, 2020
e6e6770

Merge branch '120-remove-layout-container' of github.com:plotly/dashR…

May 20, 2020
07b7036

temporarily disable tests

May 25, 2020
6e3053e

:bug: :hammer: refactor to require component/tree of components

May 25, 2020
8233d35

:hammer: :rotating_light: fix unit test

May 25, 2020
930f53b

:hammer: :bug: fix duplicated ID handling

May 25, 2020
4f46264

:rotating_light: update unit test, +1 more

May 25, 2020
c7ec219

fix wildcards test

May 25, 2020

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


38 changes: 17 additions & 21 deletions
R/dash.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -79,7 +79,7 @@
#'
#' @section Methods:
#' \describe{
#' \item{`layout(...)`}{
#' \item{`layout(value)`}{
#' Set the layout (i.e., user interface). The layout should be either a
#' collection of Dash components (e.g., [dccSlider], [htmlDiv], etc) or
#' a function which returns a collection of components.
Expand DownExpand Up@@ -771,8 +771,10 @@ Dash <- R6::R6Class(
 layout_get = function(render = TRUE) {
 if (render) private$layout_render() else private$layout_
 },
 layout = function(...) {
 private$layout_ <- if (is.function(..1)) ..1 else list(...)
 # layout = function(...) {
 layout = function(value) { 
 # private$layout_ <- if (is.function(..1)) ..1 else list(...)
 private$layout_ <- value
 # render the layout, and then return the rendered layout without printing
 invisible(private$layout_render())
 },
Expand DownExpand Up@@ -1186,20 +1188,11 @@ Dash <- R6::R6Class(
 layout_ = NULL,
 layout_ids = NULL,
 layout_render = function() {
 # assuming private$layout is either a function or a list of components...
 layout_ <- if (is.function(private$layout_)) private$layout_() else private$layout_

 # accommodate functions that return a single component
 if (is.component(layout_)) layout_ <- list(layout_)

 # make sure we are working with a list of components
 layout_ <- lapply(layout_, private$componentify)

 # Put the list of components into a container div. I'm pretty sure dash
 # requires the layout to be one component, but R folks are used to
 # being able to supply "components" to ...
 layout_ <- dashHtmlComponents::htmlDiv(children = layout_, id = layout_container_id())


 # ensure that the layout is a component, or a collection of components
 layout_ <- private$componentify(layout_)

 # store the layout as a (flattened) vector form since we query the
 # vector names several times to verify ID naming (among other things)
 layout_flat <- rapply(layout_, I)
Expand All@@ -1210,19 +1203,23 @@ Dash <- R6::R6Class(
 if (!length(idx)) {
 warning(
 "No ids were found in the layout. ",
 "Component ids are critical for targetting callbacks in your application",
 "Component ids are critical for targeting callbacks in your application",
 call. = FALSE
 )
 }
 private$layout_ids <- as.character(layout_flat[idx])
 duped <- anyDuplicated(private$layout_ids)
 layout_ids <- as.character(layout_flat[idx])
 duped <- anyDuplicated(layout_ids) > 0

 if (duped) {
 duped_ids <- paste(layout_ids[duplicated(layout_ids)], collapse = ", ")

 stop(
 sprintf("layout ids must be unique -- the following id was duplicated: '%s'", private$layout_ids[duped]),
 sprintf("layout ids must be unique -- please check the following list of duplicated ids: '%s'", duped_ids),
 call. = FALSE
 )
 }

 private$layout_ids <- layout_ids
 # load package-level HTML dependencies from attached pkgs
 metadataFns <- lapply(.packages(), getDashMetadata)
 metadataFns <- metadataFns[lengths(metadataFns) != 0]
Expand DownExpand Up@@ -1709,7 +1706,6 @@ Dash <- R6::R6Class(
)

validate_dependency <- function(layout_, dependency) {
 if (!is.layout(layout_)) stop("`layout` must be a dash layout object", call. = FALSE)
 if (!is.dependency(dependency)) stop("`dependency` must be a dash dependency object", call. = FALSE)

 valid_props <- component_props_given_id(layout_, dependency$id)
Expand Down

9 changes: 0 additions & 9 deletions
R/utils.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,15 +15,6 @@ is.event <- function(x) is.dependency(x) && inherits(x, "event")
# components (TODO: this should be exported by dashRtranspile!)
is.component <- function(x) inherits(x, "dash_component")

# layout is really a special type of component
is.layout <- function(x) {
 is.component(x) && identical(x[["props"]][["id"]], layout_container_id())
}

layout_container_id <- function() {
 "_dashR-layout-container"
}

# retrieve the arguments of a callback function that are dash inputs
callback_inputs <- function(func) {
 compact(lapply(formals(func), function(x) {
Expand Down

9 changes: 3 additions & 6 deletions
tests/testthat/test-dash.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,15 +12,12 @@ test_that("Can set/get layout", {

 d <- Dash$new()
 div <- htmlDiv("A div", id = "An id")

 # rendered layout has a container div
 d$layout(div)

 l <- d$layout_get()
 expect_true(dash:::is.layout(l))
 expect_identical(l$props$children[[1]], div)


 # dynamic layouts
 d$layout(function() { div })
 d$layout(function() { htmlDiv("A div", id = "An id") })
 l2 <- d$layout_get()
 expect_identical(l, l2)
 expect_is(d$layout_get(render = FALSE), "function")
Expand Down

18 changes: 14 additions & 4 deletions
tests/testthat/test-layout.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,11 +2,21 @@ context("layout")

test_that("layout IDs must be unique", {

app <- Dash$new()
 app <- Dash$new()

expect_error(
app$layout(htmlA(id = "a"), htmlA(id = "a")),
"layout ids must be unique -- the following id was duplicated: 'a'"
 expect_error(
 app$layout(htmlDiv(list(htmlA(id = "a"), htmlA(id = "a"), htmlP(id="b"), htmlP(id="c"), htmlA(id="c")))),
 "layout ids must be unique -- please check the following list of duplicated ids: 'a, c'"
 )

})

test_that("app$layout() only accepts components, or functions that return components", {
 app <- Dash$new()

 expect_error(
 app$layout(htmlA(id = "a"), htmlA(id = "a")),
 'unused argument (htmlA(id = "a"))', 
 fixed = TRUE)

})

2 changes: 1 addition & 1 deletion
tests/testthat/test-wildcards.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ test_that("HTML `data-*` & `aria-* ` wildcards are passed along to layout approp
 app <- Dash$new()
 app$layout(htmlDiv(id = "foo", `data-foo` = 1))
 x <- app$layout_get()
 expect_equal(x$props$children[[1]]$props$`data-foo`, 1)
 expect_equal(x$props$`data-foo`, 1)
})

# TODO: test NULL values aren't rendered on the HTML div
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Remove is.layout, layout_container_id, and redundant component test#121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

rpkyle
merged 16 commits into

from

May 26, 2020
 Merged


Remove is.layout, layout_container_id, and redundant component test
#121
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


16 commits


Select commit
Hold shift + click to select a range
a98b1be

:hocho: is.layout + layout_container_id

Aug 23, 2019
6002ea2

:hocho: overzealous component test

Aug 23, 2019
6d959dd

resolve merge conflict

Aug 23, 2019
1d0db3c

Merge branch 'dev' into 120-remove-layout-container


rpkyle Jan 13, 2020
4a65265

Merge branch 'dev' into 120-remove-layout-container


rpkyle Apr 8, 2020
2f6b50d

Merge branch 'dev' into 120-remove-layout-container


rpkyle Apr 22, 2020
8349974

:hammer: try to leave layout as-is

Apr 22, 2020
98d3049

remove container test

Apr 22, 2020
56ad73e

Merge branch 'dev' into 120-remove-layout-container


rpkyle May 20, 2020
e6e6770

Merge branch '120-remove-layout-container' of github.com:plotly/dashR…

May 20, 2020
07b7036

temporarily disable tests

May 25, 2020
6e3053e

:bug: :hammer: refactor to require component/tree of components

May 25, 2020
8233d35

:hammer: :rotating_light: fix unit test

May 25, 2020
930f53b

:hammer: :bug: fix duplicated ID handling

May 25, 2020
4f46264

:rotating_light: update unit test, +1 more

May 25, 2020
c7ec219

fix wildcards test

May 25, 2020

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


38 changes: 17 additions & 21 deletions
R/dash.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -79,7 +79,7 @@
#'
#' @section Methods:
#' \describe{
#' \item{`layout(...)`}{
#' \item{`layout(value)`}{
#' Set the layout (i.e., user interface). The layout should be either a
#' collection of Dash components (e.g., [dccSlider], [htmlDiv], etc) or
#' a function which returns a collection of components.
Expand DownExpand Up@@ -771,8 +771,10 @@ Dash <- R6::R6Class(
 layout_get = function(render = TRUE) {
 if (render) private$layout_render() else private$layout_
 },
 layout = function(...) {
 private$layout_ <- if (is.function(..1)) ..1 else list(...)
 # layout = function(...) {
 layout = function(value) { 
 # private$layout_ <- if (is.function(..1)) ..1 else list(...)
 private$layout_ <- value
 # render the layout, and then return the rendered layout without printing
 invisible(private$layout_render())
 },
Expand DownExpand Up@@ -1186,20 +1188,11 @@ Dash <- R6::R6Class(
 layout_ = NULL,
 layout_ids = NULL,
 layout_render = function() {
 # assuming private$layout is either a function or a list of components...
 layout_ <- if (is.function(private$layout_)) private$layout_() else private$layout_

 # accommodate functions that return a single component
 if (is.component(layout_)) layout_ <- list(layout_)

 # make sure we are working with a list of components
 layout_ <- lapply(layout_, private$componentify)

 # Put the list of components into a container div. I'm pretty sure dash
 # requires the layout to be one component, but R folks are used to
 # being able to supply "components" to ...
 layout_ <- dashHtmlComponents::htmlDiv(children = layout_, id = layout_container_id())


 # ensure that the layout is a component, or a collection of components
 layout_ <- private$componentify(layout_)

 # store the layout as a (flattened) vector form since we query the
 # vector names several times to verify ID naming (among other things)
 layout_flat <- rapply(layout_, I)
Expand All@@ -1210,19 +1203,23 @@ Dash <- R6::R6Class(
 if (!length(idx)) {
 warning(
 "No ids were found in the layout. ",
 "Component ids are critical for targetting callbacks in your application",
 "Component ids are critical for targeting callbacks in your application",
 call. = FALSE
 )
 }
 private$layout_ids <- as.character(layout_flat[idx])
 duped <- anyDuplicated(private$layout_ids)
 layout_ids <- as.character(layout_flat[idx])
 duped <- anyDuplicated(layout_ids) > 0

 if (duped) {
 duped_ids <- paste(layout_ids[duplicated(layout_ids)], collapse = ", ")

 stop(
 sprintf("layout ids must be unique -- the following id was duplicated: '%s'", private$layout_ids[duped]),
 sprintf("layout ids must be unique -- please check the following list of duplicated ids: '%s'", duped_ids),
 call. = FALSE
 )
 }

 private$layout_ids <- layout_ids
 # load package-level HTML dependencies from attached pkgs
 metadataFns <- lapply(.packages(), getDashMetadata)
 metadataFns <- metadataFns[lengths(metadataFns) != 0]
Expand DownExpand Up@@ -1709,7 +1706,6 @@ Dash <- R6::R6Class(
)

validate_dependency <- function(layout_, dependency) {
 if (!is.layout(layout_)) stop("`layout` must be a dash layout object", call. = FALSE)
 if (!is.dependency(dependency)) stop("`dependency` must be a dash dependency object", call. = FALSE)

 valid_props <- component_props_given_id(layout_, dependency$id)
Expand Down

9 changes: 0 additions & 9 deletions
R/utils.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,15 +15,6 @@ is.event <- function(x) is.dependency(x) && inherits(x, "event")
# components (TODO: this should be exported by dashRtranspile!)
is.component <- function(x) inherits(x, "dash_component")

# layout is really a special type of component
is.layout <- function(x) {
 is.component(x) && identical(x[["props"]][["id"]], layout_container_id())
}

layout_container_id <- function() {
 "_dashR-layout-container"
}

# retrieve the arguments of a callback function that are dash inputs
callback_inputs <- function(func) {
 compact(lapply(formals(func), function(x) {
Expand Down

9 changes: 3 additions & 6 deletions
tests/testthat/test-dash.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,15 +12,12 @@ test_that("Can set/get layout", {

 d <- Dash$new()
 div <- htmlDiv("A div", id = "An id")

 # rendered layout has a container div
 d$layout(div)

 l <- d$layout_get()
 expect_true(dash:::is.layout(l))
 expect_identical(l$props$children[[1]], div)


 # dynamic layouts
 d$layout(function() { div })
 d$layout(function() { htmlDiv("A div", id = "An id") })
 l2 <- d$layout_get()
 expect_identical(l, l2)
 expect_is(d$layout_get(render = FALSE), "function")
Expand Down

18 changes: 14 additions & 4 deletions
tests/testthat/test-layout.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,11 +2,21 @@ context("layout")

test_that("layout IDs must be unique", {

app <- Dash$new()
 app <- Dash$new()

expect_error(
app$layout(htmlA(id = "a"), htmlA(id = "a")),
"layout ids must be unique -- the following id was duplicated: 'a'"
 expect_error(
 app$layout(htmlDiv(list(htmlA(id = "a"), htmlA(id = "a"), htmlP(id="b"), htmlP(id="c"), htmlA(id="c")))),
 "layout ids must be unique -- please check the following list of duplicated ids: 'a, c'"
 )

})

test_that("app$layout() only accepts components, or functions that return components", {
 app <- Dash$new()

 expect_error(
 app$layout(htmlA(id = "a"), htmlA(id = "a")),
 'unused argument (htmlA(id = "a"))', 
 fixed = TRUE)

})

2 changes: 1 addition & 1 deletion
tests/testthat/test-wildcards.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ test_that("HTML `data-*` & `aria-* ` wildcards are passed along to layout approp
 app <- Dash$new()
 app$layout(htmlDiv(id = "foo", `data-foo` = 1))
 x <- app$layout_get()
 expect_equal(x$props$children[[1]]$props$`data-foo`, 1)
 expect_equal(x$props$`data-foo`, 1)
})

# TODO: test NULL values aren't rendered on the HTML div
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Remove is.layout, layout_container_id, and redundant component test#121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

rpkyle
merged 16 commits into

from

May 26, 2020
 Merged


Remove is.layout, layout_container_id, and redundant component test
#121
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


16 commits


Select commit
Hold shift + click to select a range
a98b1be

:hocho: is.layout + layout_container_id

Aug 23, 2019
6002ea2

:hocho: overzealous component test

Aug 23, 2019
6d959dd

resolve merge conflict

Aug 23, 2019
1d0db3c

Merge branch 'dev' into 120-remove-layout-container


rpkyle Jan 13, 2020
4a65265

Merge branch 'dev' into 120-remove-layout-container


rpkyle Apr 8, 2020
2f6b50d

Merge branch 'dev' into 120-remove-layout-container


rpkyle Apr 22, 2020
8349974

:hammer: try to leave layout as-is

Apr 22, 2020
98d3049

remove container test

Apr 22, 2020
56ad73e

Merge branch 'dev' into 120-remove-layout-container


rpkyle May 20, 2020
e6e6770

Merge branch '120-remove-layout-container' of github.com:plotly/dashR…

May 20, 2020
07b7036

temporarily disable tests

May 25, 2020
6e3053e

:bug: :hammer: refactor to require component/tree of components

May 25, 2020
8233d35

:hammer: :rotating_light: fix unit test

May 25, 2020
930f53b

:hammer: :bug: fix duplicated ID handling

May 25, 2020
4f46264

:rotating_light: update unit test, +1 more

May 25, 2020
c7ec219

fix wildcards test

May 25, 2020

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


38 changes: 17 additions & 21 deletions
R/dash.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -79,7 +79,7 @@
#'
#' @section Methods:
#' \describe{
#' \item{`layout(...)`}{
#' \item{`layout(value)`}{
#' Set the layout (i.e., user interface). The layout should be either a
#' collection of Dash components (e.g., [dccSlider], [htmlDiv], etc) or
#' a function which returns a collection of components.
Expand DownExpand Up@@ -771,8 +771,10 @@ Dash <- R6::R6Class(
 layout_get = function(render = TRUE) {
 if (render) private$layout_render() else private$layout_
 },
 layout = function(...) {
 private$layout_ <- if (is.function(..1)) ..1 else list(...)
 # layout = function(...) {
 layout = function(value) { 
 # private$layout_ <- if (is.function(..1)) ..1 else list(...)
 private$layout_ <- value
 # render the layout, and then return the rendered layout without printing
 invisible(private$layout_render())
 },
Expand DownExpand Up@@ -1186,20 +1188,11 @@ Dash <- R6::R6Class(
 layout_ = NULL,
 layout_ids = NULL,
 layout_render = function() {
 # assuming private$layout is either a function or a list of components...
 layout_ <- if (is.function(private$layout_)) private$layout_() else private$layout_

 # accommodate functions that return a single component
 if (is.component(layout_)) layout_ <- list(layout_)

 # make sure we are working with a list of components
 layout_ <- lapply(layout_, private$componentify)

 # Put the list of components into a container div. I'm pretty sure dash
 # requires the layout to be one component, but R folks are used to
 # being able to supply "components" to ...
 layout_ <- dashHtmlComponents::htmlDiv(children = layout_, id = layout_container_id())


 # ensure that the layout is a component, or a collection of components
 layout_ <- private$componentify(layout_)

 # store the layout as a (flattened) vector form since we query the
 # vector names several times to verify ID naming (among other things)
 layout_flat <- rapply(layout_, I)
Expand All@@ -1210,19 +1203,23 @@ Dash <- R6::R6Class(
 if (!length(idx)) {
 warning(
 "No ids were found in the layout. ",
 "Component ids are critical for targetting callbacks in your application",
 "Component ids are critical for targeting callbacks in your application",
 call. = FALSE
 )
 }
 private$layout_ids <- as.character(layout_flat[idx])
 duped <- anyDuplicated(private$layout_ids)
 layout_ids <- as.character(layout_flat[idx])
 duped <- anyDuplicated(layout_ids) > 0

 if (duped) {
 duped_ids <- paste(layout_ids[duplicated(layout_ids)], collapse = ", ")

 stop(
 sprintf("layout ids must be unique -- the following id was duplicated: '%s'", private$layout_ids[duped]),
 sprintf("layout ids must be unique -- please check the following list of duplicated ids: '%s'", duped_ids),
 call. = FALSE
 )
 }

 private$layout_ids <- layout_ids
 # load package-level HTML dependencies from attached pkgs
 metadataFns <- lapply(.packages(), getDashMetadata)
 metadataFns <- metadataFns[lengths(metadataFns) != 0]
Expand DownExpand Up@@ -1709,7 +1706,6 @@ Dash <- R6::R6Class(
)

validate_dependency <- function(layout_, dependency) {
 if (!is.layout(layout_)) stop("`layout` must be a dash layout object", call. = FALSE)
 if (!is.dependency(dependency)) stop("`dependency` must be a dash dependency object", call. = FALSE)

 valid_props <- component_props_given_id(layout_, dependency$id)
Expand Down

9 changes: 0 additions & 9 deletions
R/utils.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,15 +15,6 @@ is.event <- function(x) is.dependency(x) && inherits(x, "event")
# components (TODO: this should be exported by dashRtranspile!)
is.component <- function(x) inherits(x, "dash_component")

# layout is really a special type of component
is.layout <- function(x) {
 is.component(x) && identical(x[["props"]][["id"]], layout_container_id())
}

layout_container_id <- function() {
 "_dashR-layout-container"
}

# retrieve the arguments of a callback function that are dash inputs
callback_inputs <- function(func) {
 compact(lapply(formals(func), function(x) {
Expand Down

9 changes: 3 additions & 6 deletions
tests/testthat/test-dash.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,15 +12,12 @@ test_that("Can set/get layout", {

 d <- Dash$new()
 div <- htmlDiv("A div", id = "An id")

 # rendered layout has a container div
 d$layout(div)

 l <- d$layout_get()
 expect_true(dash:::is.layout(l))
 expect_identical(l$props$children[[1]], div)


 # dynamic layouts
 d$layout(function() { div })
 d$layout(function() { htmlDiv("A div", id = "An id") })
 l2 <- d$layout_get()
 expect_identical(l, l2)
 expect_is(d$layout_get(render = FALSE), "function")
Expand Down

18 changes: 14 additions & 4 deletions
tests/testthat/test-layout.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,11 +2,21 @@ context("layout")

test_that("layout IDs must be unique", {

app <- Dash$new()
 app <- Dash$new()

expect_error(
app$layout(htmlA(id = "a"), htmlA(id = "a")),
"layout ids must be unique -- the following id was duplicated: 'a'"
 expect_error(
 app$layout(htmlDiv(list(htmlA(id = "a"), htmlA(id = "a"), htmlP(id="b"), htmlP(id="c"), htmlA(id="c")))),
 "layout ids must be unique -- please check the following list of duplicated ids: 'a, c'"
 )

})

test_that("app$layout() only accepts components, or functions that return components", {
 app <- Dash$new()

 expect_error(
 app$layout(htmlA(id = "a"), htmlA(id = "a")),
 'unused argument (htmlA(id = "a"))', 
 fixed = TRUE)

})

2 changes: 1 addition & 1 deletion
tests/testthat/test-wildcards.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ test_that("HTML `data-*` & `aria-* ` wildcards are passed along to layout approp
 app <- Dash$new()
 app$layout(htmlDiv(id = "foo", `data-foo` = 1))
 x <- app$layout_get()
 expect_equal(x$props$children[[1]]$props$`data-foo`, 1)
 expect_equal(x$props$`data-foo`, 1)
})

# TODO: test NULL values aren't rendered on the HTML div
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Remove is.layout, layout_container_id, and redundant component test#121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

rpkyle
merged 16 commits into

from

May 26, 2020
 Merged


Remove is.layout, layout_container_id, and redundant component test
#121
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


16 commits


Select commit
Hold shift + click to select a range
a98b1be

:hocho: is.layout + layout_container_id

Aug 23, 2019
6002ea2

:hocho: overzealous component test

Aug 23, 2019
6d959dd

resolve merge conflict

Aug 23, 2019
1d0db3c

Merge branch 'dev' into 120-remove-layout-container


rpkyle Jan 13, 2020
4a65265

Merge branch 'dev' into 120-remove-layout-container


rpkyle Apr 8, 2020
2f6b50d

Merge branch 'dev' into 120-remove-layout-container


rpkyle Apr 22, 2020
8349974

:hammer: try to leave layout as-is

Apr 22, 2020
98d3049

remove container test

Apr 22, 2020
56ad73e

Merge branch 'dev' into 120-remove-layout-container


rpkyle May 20, 2020
e6e6770

Merge branch '120-remove-layout-container' of github.com:plotly/dashR…

May 20, 2020
07b7036

temporarily disable tests

May 25, 2020
6e3053e

:bug: :hammer: refactor to require component/tree of components

May 25, 2020
8233d35

:hammer: :rotating_light: fix unit test

May 25, 2020
930f53b

:hammer: :bug: fix duplicated ID handling

May 25, 2020
4f46264

:rotating_light: update unit test, +1 more

May 25, 2020
c7ec219

fix wildcards test

May 25, 2020

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


38 changes: 17 additions & 21 deletions
R/dash.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -79,7 +79,7 @@
#'
#' @section Methods:
#' \describe{
#' \item{`layout(...)`}{
#' \item{`layout(value)`}{
#' Set the layout (i.e., user interface). The layout should be either a
#' collection of Dash components (e.g., [dccSlider], [htmlDiv], etc) or
#' a function which returns a collection of components.
Expand DownExpand Up@@ -771,8 +771,10 @@ Dash <- R6::R6Class(
 layout_get = function(render = TRUE) {
 if (render) private$layout_render() else private$layout_
 },
 layout = function(...) {
 private$layout_ <- if (is.function(..1)) ..1 else list(...)
 # layout = function(...) {
 layout = function(value) { 
 # private$layout_ <- if (is.function(..1)) ..1 else list(...)
 private$layout_ <- value
 # render the layout, and then return the rendered layout without printing
 invisible(private$layout_render())
 },
Expand DownExpand Up@@ -1186,20 +1188,11 @@ Dash <- R6::R6Class(
 layout_ = NULL,
 layout_ids = NULL,
 layout_render = function() {
 # assuming private$layout is either a function or a list of components...
 layout_ <- if (is.function(private$layout_)) private$layout_() else private$layout_

 # accommodate functions that return a single component
 if (is.component(layout_)) layout_ <- list(layout_)

 # make sure we are working with a list of components
 layout_ <- lapply(layout_, private$componentify)

 # Put the list of components into a container div. I'm pretty sure dash
 # requires the layout to be one component, but R folks are used to
 # being able to supply "components" to ...
 layout_ <- dashHtmlComponents::htmlDiv(children = layout_, id = layout_container_id())


 # ensure that the layout is a component, or a collection of components
 layout_ <- private$componentify(layout_)

 # store the layout as a (flattened) vector form since we query the
 # vector names several times to verify ID naming (among other things)
 layout_flat <- rapply(layout_, I)
Expand All@@ -1210,19 +1203,23 @@ Dash <- R6::R6Class(
 if (!length(idx)) {
 warning(
 "No ids were found in the layout. ",
 "Component ids are critical for targetting callbacks in your application",
 "Component ids are critical for targeting callbacks in your application",
 call. = FALSE
 )
 }
 private$layout_ids <- as.character(layout_flat[idx])
 duped <- anyDuplicated(private$layout_ids)
 layout_ids <- as.character(layout_flat[idx])
 duped <- anyDuplicated(layout_ids) > 0

 if (duped) {
 duped_ids <- paste(layout_ids[duplicated(layout_ids)], collapse = ", ")

 stop(
 sprintf("layout ids must be unique -- the following id was duplicated: '%s'", private$layout_ids[duped]),
 sprintf("layout ids must be unique -- please check the following list of duplicated ids: '%s'", duped_ids),
 call. = FALSE
 )
 }

 private$layout_ids <- layout_ids
 # load package-level HTML dependencies from attached pkgs
 metadataFns <- lapply(.packages(), getDashMetadata)
 metadataFns <- metadataFns[lengths(metadataFns) != 0]
Expand DownExpand Up@@ -1709,7 +1706,6 @@ Dash <- R6::R6Class(
)

validate_dependency <- function(layout_, dependency) {
 if (!is.layout(layout_)) stop("`layout` must be a dash layout object", call. = FALSE)
 if (!is.dependency(dependency)) stop("`dependency` must be a dash dependency object", call. = FALSE)

 valid_props <- component_props_given_id(layout_, dependency$id)
Expand Down

9 changes: 0 additions & 9 deletions
R/utils.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,15 +15,6 @@ is.event <- function(x) is.dependency(x) && inherits(x, "event")
# components (TODO: this should be exported by dashRtranspile!)
is.component <- function(x) inherits(x, "dash_component")

# layout is really a special type of component
is.layout <- function(x) {
 is.component(x) && identical(x[["props"]][["id"]], layout_container_id())
}

layout_container_id <- function() {
 "_dashR-layout-container"
}

# retrieve the arguments of a callback function that are dash inputs
callback_inputs <- function(func) {
 compact(lapply(formals(func), function(x) {
Expand Down

9 changes: 3 additions & 6 deletions
tests/testthat/test-dash.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,15 +12,12 @@ test_that("Can set/get layout", {

 d <- Dash$new()
 div <- htmlDiv("A div", id = "An id")

 # rendered layout has a container div
 d$layout(div)

 l <- d$layout_get()
 expect_true(dash:::is.layout(l))
 expect_identical(l$props$children[[1]], div)


 # dynamic layouts
 d$layout(function() { div })
 d$layout(function() { htmlDiv("A div", id = "An id") })
 l2 <- d$layout_get()
 expect_identical(l, l2)
 expect_is(d$layout_get(render = FALSE), "function")
Expand Down

18 changes: 14 additions & 4 deletions
tests/testthat/test-layout.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,11 +2,21 @@ context("layout")

test_that("layout IDs must be unique", {

app <- Dash$new()
 app <- Dash$new()

expect_error(
app$layout(htmlA(id = "a"), htmlA(id = "a")),
"layout ids must be unique -- the following id was duplicated: 'a'"
 expect_error(
 app$layout(htmlDiv(list(htmlA(id = "a"), htmlA(id = "a"), htmlP(id="b"), htmlP(id="c"), htmlA(id="c")))),
 "layout ids must be unique -- please check the following list of duplicated ids: 'a, c'"
 )

})

test_that("app$layout() only accepts components, or functions that return components", {
 app <- Dash$new()

 expect_error(
 app$layout(htmlA(id = "a"), htmlA(id = "a")),
 'unused argument (htmlA(id = "a"))', 
 fixed = TRUE)

})

2 changes: 1 addition & 1 deletion
tests/testthat/test-wildcards.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ test_that("HTML `data-*` & `aria-* ` wildcards are passed along to layout approp
 app <- Dash$new()
 app$layout(htmlDiv(id = "foo", `data-foo` = 1))
 x <- app$layout_get()
 expect_equal(x$props$children[[1]]$props$`data-foo`, 1)
 expect_equal(x$props$`data-foo`, 1)
})

# TODO: test NULL values aren't rendered on the HTML div
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Remove is.layout, layout_container_id, and redundant component test#121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

rpkyle
merged 16 commits into

from

May 26, 2020
 Merged


Remove is.layout, layout_container_id, and redundant component test
#121
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


16 commits


Select commit
Hold shift + click to select a range
a98b1be

:hocho: is.layout + layout_container_id

Aug 23, 2019
6002ea2

:hocho: overzealous component test

Aug 23, 2019
6d959dd

resolve merge conflict

Aug 23, 2019
1d0db3c

Merge branch 'dev' into 120-remove-layout-container


rpkyle Jan 13, 2020
4a65265

Merge branch 'dev' into 120-remove-layout-container


rpkyle Apr 8, 2020
2f6b50d

Merge branch 'dev' into 120-remove-layout-container


rpkyle Apr 22, 2020
8349974

:hammer: try to leave layout as-is

Apr 22, 2020
98d3049

remove container test

Apr 22, 2020
56ad73e

Merge branch 'dev' into 120-remove-layout-container


rpkyle May 20, 2020
e6e6770

Merge branch '120-remove-layout-container' of github.com:plotly/dashR…

May 20, 2020
07b7036

temporarily disable tests

May 25, 2020
6e3053e

:bug: :hammer: refactor to require component/tree of components

May 25, 2020
8233d35

:hammer: :rotating_light: fix unit test

May 25, 2020
930f53b

:hammer: :bug: fix duplicated ID handling

May 25, 2020
4f46264

:rotating_light: update unit test, +1 more

May 25, 2020
c7ec219

fix wildcards test

May 25, 2020

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


38 changes: 17 additions & 21 deletions
R/dash.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -79,7 +79,7 @@
#'
#' @section Methods:
#' \describe{
#' \item{`layout(...)`}{
#' \item{`layout(value)`}{
#' Set the layout (i.e., user interface). The layout should be either a
#' collection of Dash components (e.g., [dccSlider], [htmlDiv], etc) or
#' a function which returns a collection of components.
Expand DownExpand Up@@ -771,8 +771,10 @@ Dash <- R6::R6Class(
 layout_get = function(render = TRUE) {
 if (render) private$layout_render() else private$layout_
 },
 layout = function(...) {
 private$layout_ <- if (is.function(..1)) ..1 else list(...)
 # layout = function(...) {
 layout = function(value) { 
 # private$layout_ <- if (is.function(..1)) ..1 else list(...)
 private$layout_ <- value
 # render the layout, and then return the rendered layout without printing
 invisible(private$layout_render())
 },
Expand DownExpand Up@@ -1186,20 +1188,11 @@ Dash <- R6::R6Class(
 layout_ = NULL,
 layout_ids = NULL,
 layout_render = function() {
 # assuming private$layout is either a function or a list of components...
 layout_ <- if (is.function(private$layout_)) private$layout_() else private$layout_

 # accommodate functions that return a single component
 if (is.component(layout_)) layout_ <- list(layout_)

 # make sure we are working with a list of components
 layout_ <- lapply(layout_, private$componentify)

 # Put the list of components into a container div. I'm pretty sure dash
 # requires the layout to be one component, but R folks are used to
 # being able to supply "components" to ...
 layout_ <- dashHtmlComponents::htmlDiv(children = layout_, id = layout_container_id())


 # ensure that the layout is a component, or a collection of components
 layout_ <- private$componentify(layout_)

 # store the layout as a (flattened) vector form since we query the
 # vector names several times to verify ID naming (among other things)
 layout_flat <- rapply(layout_, I)
Expand All@@ -1210,19 +1203,23 @@ Dash <- R6::R6Class(
 if (!length(idx)) {
 warning(
 "No ids were found in the layout. ",
 "Component ids are critical for targetting callbacks in your application",
 "Component ids are critical for targeting callbacks in your application",
 call. = FALSE
 )
 }
 private$layout_ids <- as.character(layout_flat[idx])
 duped <- anyDuplicated(private$layout_ids)
 layout_ids <- as.character(layout_flat[idx])
 duped <- anyDuplicated(layout_ids) > 0

 if (duped) {
 duped_ids <- paste(layout_ids[duplicated(layout_ids)], collapse = ", ")

 stop(
 sprintf("layout ids must be unique -- the following id was duplicated: '%s'", private$layout_ids[duped]),
 sprintf("layout ids must be unique -- please check the following list of duplicated ids: '%s'", duped_ids),
 call. = FALSE
 )
 }

 private$layout_ids <- layout_ids
 # load package-level HTML dependencies from attached pkgs
 metadataFns <- lapply(.packages(), getDashMetadata)
 metadataFns <- metadataFns[lengths(metadataFns) != 0]
Expand DownExpand Up@@ -1709,7 +1706,6 @@ Dash <- R6::R6Class(
)

validate_dependency <- function(layout_, dependency) {
 if (!is.layout(layout_)) stop("`layout` must be a dash layout object", call. = FALSE)
 if (!is.dependency(dependency)) stop("`dependency` must be a dash dependency object", call. = FALSE)

 valid_props <- component_props_given_id(layout_, dependency$id)
Expand Down

9 changes: 0 additions & 9 deletions
R/utils.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,15 +15,6 @@ is.event <- function(x) is.dependency(x) && inherits(x, "event")
# components (TODO: this should be exported by dashRtranspile!)
is.component <- function(x) inherits(x, "dash_component")

# layout is really a special type of component
is.layout <- function(x) {
 is.component(x) && identical(x[["props"]][["id"]], layout_container_id())
}

layout_container_id <- function() {
 "_dashR-layout-container"
}

# retrieve the arguments of a callback function that are dash inputs
callback_inputs <- function(func) {
 compact(lapply(formals(func), function(x) {
Expand Down

9 changes: 3 additions & 6 deletions
tests/testthat/test-dash.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,15 +12,12 @@ test_that("Can set/get layout", {

 d <- Dash$new()
 div <- htmlDiv("A div", id = "An id")

 # rendered layout has a container div
 d$layout(div)

 l <- d$layout_get()
 expect_true(dash:::is.layout(l))
 expect_identical(l$props$children[[1]], div)


 # dynamic layouts
 d$layout(function() { div })
 d$layout(function() { htmlDiv("A div", id = "An id") })
 l2 <- d$layout_get()
 expect_identical(l, l2)
 expect_is(d$layout_get(render = FALSE), "function")
Expand Down

18 changes: 14 additions & 4 deletions
tests/testthat/test-layout.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,11 +2,21 @@ context("layout")

test_that("layout IDs must be unique", {

app <- Dash$new()
 app <- Dash$new()

expect_error(
app$layout(htmlA(id = "a"), htmlA(id = "a")),
"layout ids must be unique -- the following id was duplicated: 'a'"
 expect_error(
 app$layout(htmlDiv(list(htmlA(id = "a"), htmlA(id = "a"), htmlP(id="b"), htmlP(id="c"), htmlA(id="c")))),
 "layout ids must be unique -- please check the following list of duplicated ids: 'a, c'"
 )

})

test_that("app$layout() only accepts components, or functions that return components", {
 app <- Dash$new()

 expect_error(
 app$layout(htmlA(id = "a"), htmlA(id = "a")),
 'unused argument (htmlA(id = "a"))', 
 fixed = TRUE)

})

2 changes: 1 addition & 1 deletion
tests/testthat/test-wildcards.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ test_that("HTML `data-*` & `aria-* ` wildcards are passed along to layout approp
 app <- Dash$new()
 app$layout(htmlDiv(id = "foo", `data-foo` = 1))
 x <- app$layout_get()
 expect_equal(x$props$children[[1]]$props$`data-foo`, 1)
 expect_equal(x$props$`data-foo`, 1)
})

# TODO: test NULL values aren't rendered on the HTML div
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Remove is.layout, layout_container_id, and redundant component test#121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

rpkyle
merged 16 commits into

from

May 26, 2020
 Merged


Remove is.layout, layout_container_id, and redundant component test
#121
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


16 commits


Select commit
Hold shift + click to select a range
a98b1be

:hocho: is.layout + layout_container_id

Aug 23, 2019
6002ea2

:hocho: overzealous component test

Aug 23, 2019
6d959dd

resolve merge conflict

Aug 23, 2019
1d0db3c

Merge branch 'dev' into 120-remove-layout-container


rpkyle Jan 13, 2020
4a65265

Merge branch 'dev' into 120-remove-layout-container


rpkyle Apr 8, 2020
2f6b50d

Merge branch 'dev' into 120-remove-layout-container


rpkyle Apr 22, 2020
8349974

:hammer: try to leave layout as-is

Apr 22, 2020
98d3049

remove container test

Apr 22, 2020
56ad73e

Merge branch 'dev' into 120-remove-layout-container


rpkyle May 20, 2020
e6e6770

Merge branch '120-remove-layout-container' of github.com:plotly/dashR…

May 20, 2020
07b7036

temporarily disable tests

May 25, 2020
6e3053e

:bug: :hammer: refactor to require component/tree of components

May 25, 2020
8233d35

:hammer: :rotating_light: fix unit test

May 25, 2020
930f53b

:hammer: :bug: fix duplicated ID handling

May 25, 2020
4f46264

:rotating_light: update unit test, +1 more

May 25, 2020
c7ec219

fix wildcards test

May 25, 2020

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


38 changes: 17 additions & 21 deletions
R/dash.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -79,7 +79,7 @@
#'
#' @section Methods:
#' \describe{
#' \item{`layout(...)`}{
#' \item{`layout(value)`}{
#' Set the layout (i.e., user interface). The layout should be either a
#' collection of Dash components (e.g., [dccSlider], [htmlDiv], etc) or
#' a function which returns a collection of components.
Expand DownExpand Up@@ -771,8 +771,10 @@ Dash <- R6::R6Class(
 layout_get = function(render = TRUE) {
 if (render) private$layout_render() else private$layout_
 },
 layout = function(...) {
 private$layout_ <- if (is.function(..1)) ..1 else list(...)
 # layout = function(...) {
 layout = function(value) { 
 # private$layout_ <- if (is.function(..1)) ..1 else list(...)
 private$layout_ <- value
 # render the layout, and then return the rendered layout without printing
 invisible(private$layout_render())
 },
Expand DownExpand Up@@ -1186,20 +1188,11 @@ Dash <- R6::R6Class(
 layout_ = NULL,
 layout_ids = NULL,
 layout_render = function() {
 # assuming private$layout is either a function or a list of components...
 layout_ <- if (is.function(private$layout_)) private$layout_() else private$layout_

 # accommodate functions that return a single component
 if (is.component(layout_)) layout_ <- list(layout_)

 # make sure we are working with a list of components
 layout_ <- lapply(layout_, private$componentify)

 # Put the list of components into a container div. I'm pretty sure dash
 # requires the layout to be one component, but R folks are used to
 # being able to supply "components" to ...
 layout_ <- dashHtmlComponents::htmlDiv(children = layout_, id = layout_container_id())


 # ensure that the layout is a component, or a collection of components
 layout_ <- private$componentify(layout_)

 # store the layout as a (flattened) vector form since we query the
 # vector names several times to verify ID naming (among other things)
 layout_flat <- rapply(layout_, I)
Expand All@@ -1210,19 +1203,23 @@ Dash <- R6::R6Class(
 if (!length(idx)) {
 warning(
 "No ids were found in the layout. ",
 "Component ids are critical for targetting callbacks in your application",
 "Component ids are critical for targeting callbacks in your application",
 call. = FALSE
 )
 }
 private$layout_ids <- as.character(layout_flat[idx])
 duped <- anyDuplicated(private$layout_ids)
 layout_ids <- as.character(layout_flat[idx])
 duped <- anyDuplicated(layout_ids) > 0

 if (duped) {
 duped_ids <- paste(layout_ids[duplicated(layout_ids)], collapse = ", ")

 stop(
 sprintf("layout ids must be unique -- the following id was duplicated: '%s'", private$layout_ids[duped]),
 sprintf("layout ids must be unique -- please check the following list of duplicated ids: '%s'", duped_ids),
 call. = FALSE
 )
 }

 private$layout_ids <- layout_ids
 # load package-level HTML dependencies from attached pkgs
 metadataFns <- lapply(.packages(), getDashMetadata)
 metadataFns <- metadataFns[lengths(metadataFns) != 0]
Expand DownExpand Up@@ -1709,7 +1706,6 @@ Dash <- R6::R6Class(
)

validate_dependency <- function(layout_, dependency) {
 if (!is.layout(layout_)) stop("`layout` must be a dash layout object", call. = FALSE)
 if (!is.dependency(dependency)) stop("`dependency` must be a dash dependency object", call. = FALSE)

 valid_props <- component_props_given_id(layout_, dependency$id)
Expand Down

9 changes: 0 additions & 9 deletions
R/utils.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,15 +15,6 @@ is.event <- function(x) is.dependency(x) && inherits(x, "event")
# components (TODO: this should be exported by dashRtranspile!)
is.component <- function(x) inherits(x, "dash_component")

# layout is really a special type of component
is.layout <- function(x) {
 is.component(x) && identical(x[["props"]][["id"]], layout_container_id())
}

layout_container_id <- function() {
 "_dashR-layout-container"
}

# retrieve the arguments of a callback function that are dash inputs
callback_inputs <- function(func) {
 compact(lapply(formals(func), function(x) {
Expand Down

9 changes: 3 additions & 6 deletions
tests/testthat/test-dash.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,15 +12,12 @@ test_that("Can set/get layout", {

 d <- Dash$new()
 div <- htmlDiv("A div", id = "An id")

 # rendered layout has a container div
 d$layout(div)

 l <- d$layout_get()
 expect_true(dash:::is.layout(l))
 expect_identical(l$props$children[[1]], div)


 # dynamic layouts
 d$layout(function() { div })
 d$layout(function() { htmlDiv("A div", id = "An id") })
 l2 <- d$layout_get()
 expect_identical(l, l2)
 expect_is(d$layout_get(render = FALSE), "function")
Expand Down

18 changes: 14 additions & 4 deletions
tests/testthat/test-layout.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,11 +2,21 @@ context("layout")

test_that("layout IDs must be unique", {

app <- Dash$new()
 app <- Dash$new()

expect_error(
app$layout(htmlA(id = "a"), htmlA(id = "a")),
"layout ids must be unique -- the following id was duplicated: 'a'"
 expect_error(
 app$layout(htmlDiv(list(htmlA(id = "a"), htmlA(id = "a"), htmlP(id="b"), htmlP(id="c"), htmlA(id="c")))),
 "layout ids must be unique -- please check the following list of duplicated ids: 'a, c'"
 )

})

test_that("app$layout() only accepts components, or functions that return components", {
 app <- Dash$new()

 expect_error(
 app$layout(htmlA(id = "a"), htmlA(id = "a")),
 'unused argument (htmlA(id = "a"))', 
 fixed = TRUE)

})

2 changes: 1 addition & 1 deletion
tests/testthat/test-wildcards.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ test_that("HTML `data-*` & `aria-* ` wildcards are passed along to layout approp
 app <- Dash$new()
 app$layout(htmlDiv(id = "foo", `data-foo` = 1))
 x <- app$layout_get()
 expect_equal(x$props$children[[1]]$props$`data-foo`, 1)
 expect_equal(x$props$`data-foo`, 1)
})

# TODO: test NULL values aren't rendered on the HTML div
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Remove is.layout, layout_container_id, and redundant component test#121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

rpkyle
merged 16 commits into

from

May 26, 2020
 Merged


Remove is.layout, layout_container_id, and redundant component test
#121
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


16 commits


Select commit
Hold shift + click to select a range
a98b1be

:hocho: is.layout + layout_container_id

Aug 23, 2019
6002ea2

:hocho: overzealous component test

Aug 23, 2019
6d959dd

resolve merge conflict

Aug 23, 2019
1d0db3c

Merge branch 'dev' into 120-remove-layout-container


rpkyle Jan 13, 2020
4a65265

Merge branch 'dev' into 120-remove-layout-container


rpkyle Apr 8, 2020
2f6b50d

Merge branch 'dev' into 120-remove-layout-container


rpkyle Apr 22, 2020
8349974

:hammer: try to leave layout as-is

Apr 22, 2020
98d3049

remove container test

Apr 22, 2020
56ad73e

Merge branch 'dev' into 120-remove-layout-container


rpkyle May 20, 2020
e6e6770

Merge branch '120-remove-layout-container' of github.com:plotly/dashR…

May 20, 2020
07b7036

temporarily disable tests

May 25, 2020
6e3053e

:bug: :hammer: refactor to require component/tree of components

May 25, 2020
8233d35

:hammer: :rotating_light: fix unit test

May 25, 2020
930f53b

:hammer: :bug: fix duplicated ID handling

May 25, 2020
4f46264

:rotating_light: update unit test, +1 more

May 25, 2020
c7ec219

fix wildcards test

May 25, 2020

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


38 changes: 17 additions & 21 deletions
R/dash.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -79,7 +79,7 @@
#'
#' @section Methods:
#' \describe{
#' \item{`layout(...)`}{
#' \item{`layout(value)`}{
#' Set the layout (i.e., user interface). The layout should be either a
#' collection of Dash components (e.g., [dccSlider], [htmlDiv], etc) or
#' a function which returns a collection of components.
Expand DownExpand Up@@ -771,8 +771,10 @@ Dash <- R6::R6Class(
 layout_get = function(render = TRUE) {
 if (render) private$layout_render() else private$layout_
 },
 layout = function(...) {
 private$layout_ <- if (is.function(..1)) ..1 else list(...)
 # layout = function(...) {
 layout = function(value) { 
 # private$layout_ <- if (is.function(..1)) ..1 else list(...)
 private$layout_ <- value
 # render the layout, and then return the rendered layout without printing
 invisible(private$layout_render())
 },
Expand DownExpand Up@@ -1186,20 +1188,11 @@ Dash <- R6::R6Class(
 layout_ = NULL,
 layout_ids = NULL,
 layout_render = function() {
 # assuming private$layout is either a function or a list of components...
 layout_ <- if (is.function(private$layout_)) private$layout_() else private$layout_

 # accommodate functions that return a single component
 if (is.component(layout_)) layout_ <- list(layout_)

 # make sure we are working with a list of components
 layout_ <- lapply(layout_, private$componentify)

 # Put the list of components into a container div. I'm pretty sure dash
 # requires the layout to be one component, but R folks are used to
 # being able to supply "components" to ...
 layout_ <- dashHtmlComponents::htmlDiv(children = layout_, id = layout_container_id())


 # ensure that the layout is a component, or a collection of components
 layout_ <- private$componentify(layout_)

 # store the layout as a (flattened) vector form since we query the
 # vector names several times to verify ID naming (among other things)
 layout_flat <- rapply(layout_, I)
Expand All@@ -1210,19 +1203,23 @@ Dash <- R6::R6Class(
 if (!length(idx)) {
 warning(
 "No ids were found in the layout. ",
 "Component ids are critical for targetting callbacks in your application",
 "Component ids are critical for targeting callbacks in your application",
 call. = FALSE
 )
 }
 private$layout_ids <- as.character(layout_flat[idx])
 duped <- anyDuplicated(private$layout_ids)
 layout_ids <- as.character(layout_flat[idx])
 duped <- anyDuplicated(layout_ids) > 0

 if (duped) {
 duped_ids <- paste(layout_ids[duplicated(layout_ids)], collapse = ", ")

 stop(
 sprintf("layout ids must be unique -- the following id was duplicated: '%s'", private$layout_ids[duped]),
 sprintf("layout ids must be unique -- please check the following list of duplicated ids: '%s'", duped_ids),
 call. = FALSE
 )
 }

 private$layout_ids <- layout_ids
 # load package-level HTML dependencies from attached pkgs
 metadataFns <- lapply(.packages(), getDashMetadata)
 metadataFns <- metadataFns[lengths(metadataFns) != 0]
Expand DownExpand Up@@ -1709,7 +1706,6 @@ Dash <- R6::R6Class(
)

validate_dependency <- function(layout_, dependency) {
 if (!is.layout(layout_)) stop("`layout` must be a dash layout object", call. = FALSE)
 if (!is.dependency(dependency)) stop("`dependency` must be a dash dependency object", call. = FALSE)

 valid_props <- component_props_given_id(layout_, dependency$id)
Expand Down

9 changes: 0 additions & 9 deletions
R/utils.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,15 +15,6 @@ is.event <- function(x) is.dependency(x) && inherits(x, "event")
# components (TODO: this should be exported by dashRtranspile!)
is.component <- function(x) inherits(x, "dash_component")

# layout is really a special type of component
is.layout <- function(x) {
 is.component(x) && identical(x[["props"]][["id"]], layout_container_id())
}

layout_container_id <- function() {
 "_dashR-layout-container"
}

# retrieve the arguments of a callback function that are dash inputs
callback_inputs <- function(func) {
 compact(lapply(formals(func), function(x) {
Expand Down

9 changes: 3 additions & 6 deletions
tests/testthat/test-dash.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,15 +12,12 @@ test_that("Can set/get layout", {

 d <- Dash$new()
 div <- htmlDiv("A div", id = "An id")

 # rendered layout has a container div
 d$layout(div)

 l <- d$layout_get()
 expect_true(dash:::is.layout(l))
 expect_identical(l$props$children[[1]], div)


 # dynamic layouts
 d$layout(function() { div })
 d$layout(function() { htmlDiv("A div", id = "An id") })
 l2 <- d$layout_get()
 expect_identical(l, l2)
 expect_is(d$layout_get(render = FALSE), "function")
Expand Down

18 changes: 14 additions & 4 deletions
tests/testthat/test-layout.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,11 +2,21 @@ context("layout")

test_that("layout IDs must be unique", {

app <- Dash$new()
 app <- Dash$new()

expect_error(
app$layout(htmlA(id = "a"), htmlA(id = "a")),
"layout ids must be unique -- the following id was duplicated: 'a'"
 expect_error(
 app$layout(htmlDiv(list(htmlA(id = "a"), htmlA(id = "a"), htmlP(id="b"), htmlP(id="c"), htmlA(id="c")))),
 "layout ids must be unique -- please check the following list of duplicated ids: 'a, c'"
 )

})

test_that("app$layout() only accepts components, or functions that return components", {
 app <- Dash$new()

 expect_error(
 app$layout(htmlA(id = "a"), htmlA(id = "a")),
 'unused argument (htmlA(id = "a"))', 
 fixed = TRUE)

})

2 changes: 1 addition & 1 deletion
tests/testthat/test-wildcards.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ test_that("HTML `data-*` & `aria-* ` wildcards are passed along to layout approp
 app <- Dash$new()
 app$layout(htmlDiv(id = "foo", `data-foo` = 1))
 x <- app$layout_get()
 expect_equal(x$props$children[[1]]$props$`data-foo`, 1)
 expect_equal(x$props$`data-foo`, 1)
})

# TODO: test NULL values aren't rendered on the HTML div
Expand Down