Skip to content

Support for meta tags in Dash for R#142

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 9 commits into from
Nov 5, 2019
Merged

Support for meta tags in Dash for R #142

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
10ae196
:sparkles: initial support for meta tags
Nov 4, 2019
f0f7b15
:hammer: fix tags
Nov 5, 2019
bb897d3
:see_no_evil: properly detect paths
Nov 5, 2019
253e8be
support arbitrary tags
Nov 5, 2019
67fb44a
:rotating_light: add tests
Nov 5, 2019
3e77327
:microscope: add asserts
Nov 5, 2019
1624eef
add reference to meta tag PR
rpkyle Nov 5, 2019
d459cbe
:fast_forward: indent meta tags
Nov 5, 2019
d9c419a
Merge branch '141-meta-tags' of github.com:plotly/dashR into 141-meta…
Nov 5, 2019
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
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ All notable changes to this project will be documented in this file.

## Unreleased
### Added
- Support for adding `<meta>` tags to index [#142](https://github.com/plotly/dashR/pull/142)
- Hot reloading now supported in debug mode [#127](https://github.com/plotly/dashR/pull/127)
- Support for displaying Dash for R applications within RStudio's viewer pane when `use_viewer = TRUE`
- Clientside callbacks written in JavaScript are now supported [#130](https://github.com/plotly/dashR/pull/130)
Expand Down
23 changes: 19 additions & 4 deletions R/dash.R
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@
#' assets_url_path = '/assets',
#' assets_ignore = '',
#' serve_locally = TRUE,
#' meta_tags = NULL,
#' routes_pathname_prefix = '/',
#' requests_pathname_prefix = '/',
#' external_scripts = NULL,
Expand All@@ -34,6 +35,9 @@
#' cannot use this to prevent access to sensitive files. \cr
#' `serve_locally` \tab \tab Whether to serve HTML dependencies locally or
#' remotely (via URL).\cr
#' `meta_tags` \tab \tab List of lists. HTML `<meta>`tags to be added to the index page.
#' Each list element should have the attributes and values for one tag, eg:
#' `list(name = 'description', content = 'My App')`.\cr
#' `routes_pathname_prefix` \tab \tab a prefix applied to the backend routes.\cr
#' `requests_pathname_prefix` \tab \tab a prefix applied to request endpoints
#' made by Dash's front-end.\cr
Expand DownExpand Up@@ -158,6 +162,7 @@ Dash <- R6::R6Class(
assets_url_path = '/assets',
assets_ignore = '',
serve_locally = TRUE,
meta_tags = NULL,
routes_pathname_prefix = NULL,
requests_pathname_prefix = NULL,
external_scripts = NULL,
Expand All@@ -181,6 +186,7 @@ Dash <- R6::R6Class(
private$suppress_callback_exceptions <- suppress_callback_exceptions
private$app_root_path <- getAppPath()
private$app_launchtime <- as.integer(Sys.time())
private$meta_tags <- meta_tags

# config options
self$config$routes_pathname_prefix <- resolve_prefix(routes_pathname_prefix, "DASH_ROUTES_PATHNAME_PREFIX")
Expand DownExpand Up@@ -815,6 +821,7 @@ Dash <- R6::R6Class(
# private fields defined on initiation
name = NULL,
serve_locally = NULL,
meta_tags = NULL,
assets_folder = NULL,
assets_url_path = NULL,
assets_ignore = NULL,
Expand DownExpand Up@@ -1231,17 +1238,21 @@ Dash <- R6::R6Class(
css_tags <- paste(c(css_deps,
css_external,
css_assets),
collapse = "\n")
collapse = "\n")

scripts_tags <- paste(c(scripts_deps,
scripts_external,
scripts_assets,
scripts_invoke_renderer),
collapse = "\n")
collapse = "\n")

meta_tags <- paste(generate_meta_tags(private$meta_tags),
collapse = "\n ")

return(list(css_tags = css_tags,
scripts_tags = scripts_tags,
favicon = favicon))
favicon = favicon,
meta_tags = meta_tags))
},

index = function() {
Expand All@@ -1257,11 +1268,14 @@ Dash <- R6::R6Class(
# retrieve script tags for serving in the index
scripts_tags <- all_tags[["scripts_tags"]]

# insert meta tags if present
meta_tags <- all_tags[["meta_tags"]]

private$.index <- sprintf(
'<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8"/>
%s
<title>%s</title>
%s
%s
Expand All@@ -1278,6 +1292,7 @@ Dash <- R6::R6Class(
</footer>
</body>
</html>',
meta_tags,
private$name,
favicon,
css_tags,
Expand Down
28 changes: 27 additions & 1 deletion R/utils.R
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -607,6 +607,32 @@ generate_js_dist_html <- function(href,
}
}

generate_meta_tags <- function(metas) {
has_ie_compat <- any(vapply(metas, function(x)
x$name == "http-equiv" && x$content == "X-UA-Compatible",
logical(1)), na.rm=TRUE)
has_charset <- any(vapply(metas, function(x)
"charset" %in% names(x),
logical(1)), na.rm=TRUE)

# allow arbitrary tags with varying numbers of keys
tags <- vapply(metas,
function(tag) sprintf("<meta %s>", paste(sprintf("%s=\"%s\"",
names(tag),
unlist(tag, use.names = FALSE)),
collapse=" ")),
character(1))

if (!has_ie_compat) {
tags <- c('<meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge\">', tags)
}

if (!has_charset) {
tags <- c('<meta charset=\"UTF-8\">', tags)
}
return(tags)
}

# This function takes the list object containing asset paths
# for all stylesheets and scripts, as well as the URL path
# to search, then returns the absolute local path (when
Expand DownExpand Up@@ -970,7 +996,7 @@ modtimeFromPath <- function(path, recursive = FALSE, asset_path="") {
}
} else {
# check if the path is for a directory or file, and handle accordingly
if (dir.exists(path))
if (length(path) == 1 && dir.exists(path))
modtime <- as.integer(max(file.info(list.files(path, full.names = TRUE))$mtime, na.rm=TRUE))
else
modtime <- as.integer(file.info(path)$mtime)
Expand Down
58 changes: 58 additions & 0 deletions tests/integration/test_meta.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
from selenium.webdriver.support.select import Select
import time, os


app = """
library(dash)
library(dashHtmlComponents)

app <- Dash$new(meta_tags = list(list(name = "description", content = "some content")))

app$layout(
htmlDiv(children = "Hello world!",
id = "hello-div"
)
)

app$run_server()
"""


def test_rstm001_test_meta(dashr):
dashr.start_server(app)
dashr.wait_for_text_to_equal(
"#hello-div",
"Hello world!"
)
assert dashr.find_element("meta[name='description']").get_attribute("content") == "some content"
Comment thread
rpkyle marked this conversation as resolved.
assert dashr.find_element("meta[charset='UTF-8']")
assert dashr.find_element("meta[http-equiv='X-UA-Compatible']").get_attribute("content") == "IE=edge"


app2 = """
library(dash)
library(dashHtmlComponents)

app <- Dash$new(meta_tags = list(list(charset = "ISO-8859-1"),
list(name = "keywords", content = "dash,pleasant,productive"),
list(`http-equiv` = 'content-type', content = 'text/html')))

app$layout(
htmlDiv(children = "Hello world!",
id = "hello-div"
)
)

app$run_server()
"""


def test_rstm002_test_meta(dashr):
dashr.start_server(app2)
dashr.wait_for_text_to_equal(
"#hello-div",
"Hello world!"
)
assert dashr.find_element("meta[charset='ISO-8859-1']")
assert dashr.find_element("meta[name='keywords']").get_attribute("content") == "dash,pleasant,productive"
assert dashr.find_element("meta[http-equiv='content-type']").get_attribute("content") == "text/html"
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
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;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Support for meta tags in Dash for R by rpkyle · Pull Request #142 · plotly/dashR · GitHub
Skip to content
Support for meta tags in Dash for R#142

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 9 commits into

from

Nov 5, 2019
 Merged


Support for meta tags in Dash for R
#142
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
10ae196

:sparkles: initial support for meta tags

Nov 4, 2019
f0f7b15

:hammer: fix tags

Nov 5, 2019
bb897d3

:see_no_evil: properly detect paths

Nov 5, 2019
253e8be

support arbitrary tags

Nov 5, 2019
67fb44a

:rotating_light: add tests

Nov 5, 2019
3e77327

:microscope: add asserts

Nov 5, 2019
1624eef

add reference to meta tag PR


rpkyle Nov 5, 2019
d459cbe

:fast_forward: indent meta tags

Nov 5, 2019
d9c419a

Merge branch '141-meta-tags' of github.com:plotly/dashR into 141-meta…

Nov 5, 2019

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


1 change: 1 addition & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ All notable changes to this project will be documented in this file.

## Unreleased
### Added
- Support for adding `<meta>` tags to index [#142](https://github.com/plotly/dashR/pull/142)
- Hot reloading now supported in debug mode [#127](https://github.com/plotly/dashR/pull/127)
- Support for displaying Dash for R applications within RStudio's viewer pane when `use_viewer = TRUE`
- Clientside callbacks written in JavaScript are now supported [#130](https://github.com/plotly/dashR/pull/130)
Expand Down

23 changes: 19 additions & 4 deletions
R/dash.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@
#' assets_url_path = '/assets',
#' assets_ignore = '',
#' serve_locally = TRUE,
#' meta_tags = NULL,
#' routes_pathname_prefix = '/',
#' requests_pathname_prefix = '/',
#' external_scripts = NULL,
Expand All@@ -34,6 +35,9 @@
#' cannot use this to prevent access to sensitive files. \cr
#' `serve_locally` \tab \tab Whether to serve HTML dependencies locally or
#' remotely (via URL).\cr
#' `meta_tags` \tab \tab List of lists. HTML `<meta>`tags to be added to the index page.
#' Each list element should have the attributes and values for one tag, eg:
#' `list(name = 'description', content = 'My App')`.\cr
#' `routes_pathname_prefix` \tab \tab a prefix applied to the backend routes.\cr
#' `requests_pathname_prefix` \tab \tab a prefix applied to request endpoints
#' made by Dash's front-end.\cr
Expand DownExpand Up@@ -158,6 +162,7 @@ Dash <- R6::R6Class(
 assets_url_path = '/assets',
 assets_ignore = '',
 serve_locally = TRUE,
 meta_tags = NULL,
 routes_pathname_prefix = NULL,
 requests_pathname_prefix = NULL,
 external_scripts = NULL,
Expand All@@ -181,6 +186,7 @@ Dash <- R6::R6Class(
 private$suppress_callback_exceptions <- suppress_callback_exceptions
 private$app_root_path <- getAppPath()
 private$app_launchtime <- as.integer(Sys.time())
 private$meta_tags <- meta_tags

 # config options
 self$config$routes_pathname_prefix <- resolve_prefix(routes_pathname_prefix, "DASH_ROUTES_PATHNAME_PREFIX")
Expand DownExpand Up@@ -815,6 +821,7 @@ Dash <- R6::R6Class(
 # private fields defined on initiation
 name = NULL,
 serve_locally = NULL,
 meta_tags = NULL,
 assets_folder = NULL,
 assets_url_path = NULL,
 assets_ignore = NULL,
Expand DownExpand Up@@ -1231,17 +1238,21 @@ Dash <- R6::R6Class(
 css_tags <- paste(c(css_deps,
 css_external,
 css_assets),
 collapse = "\n")
 collapse = "\n")

 scripts_tags <- paste(c(scripts_deps,
 scripts_external,
 scripts_assets,
 scripts_invoke_renderer),
 collapse = "\n")
 collapse = "\n")

 meta_tags <- paste(generate_meta_tags(private$meta_tags),
 collapse = "\n ")

 return(list(css_tags = css_tags,
 scripts_tags = scripts_tags,
 favicon = favicon))
 favicon = favicon,
 meta_tags = meta_tags))
 },

 index = function() {
Expand All@@ -1257,11 +1268,14 @@ Dash <- R6::R6Class(
 # retrieve script tags for serving in the index
 scripts_tags <- all_tags[["scripts_tags"]]

 # insert meta tags if present
 meta_tags <- all_tags[["meta_tags"]]

 private$.index <- sprintf(
 '<!DOCTYPE html>
 <html>
 <head>
<meta charset="UTF-8"/>
%s
 <title>%s</title>
 %s
 %s
Expand All@@ -1278,6 +1292,7 @@ Dash <- R6::R6Class(
 </footer>
 </body>
 </html>',
 meta_tags,
 private$name,
 favicon,
 css_tags,
Expand Down

28 changes: 27 additions & 1 deletion
R/utils.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -607,6 +607,32 @@ generate_js_dist_html <- function(href,
 }
}

generate_meta_tags <- function(metas) {
 has_ie_compat <- any(vapply(metas, function(x) 
 x$name == "http-equiv" && x$content == "X-UA-Compatible", 
 logical(1)), na.rm=TRUE)
 has_charset <- any(vapply(metas, function(x) 
 "charset" %in% names(x), 
 logical(1)), na.rm=TRUE)

 # allow arbitrary tags with varying numbers of keys
 tags <- vapply(metas, 
 function(tag) sprintf("<meta %s>", paste(sprintf("%s=\"%s\"", 
 names(tag), 
 unlist(tag, use.names = FALSE)), 
 collapse=" ")),
 character(1))

 if (!has_ie_compat) {
 tags <- c('<meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge\">', tags)
 }

 if (!has_charset) {
 tags <- c('<meta charset=\"UTF-8\">', tags)
 }
 return(tags)
}

# This function takes the list object containing asset paths
# for all stylesheets and scripts, as well as the URL path
# to search, then returns the absolute local path (when
Expand DownExpand Up@@ -970,7 +996,7 @@ modtimeFromPath <- function(path, recursive = FALSE, asset_path="") {
 }
 } else {
 # check if the path is for a directory or file, and handle accordingly
 if (dir.exists(path))
 if (length(path) == 1 && dir.exists(path))
 modtime <- as.integer(max(file.info(list.files(path, full.names = TRUE))$mtime, na.rm=TRUE))
 else
 modtime <- as.integer(file.info(path)$mtime)
Expand Down

58 changes: 58 additions & 0 deletions
tests/integration/test_meta.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
from selenium.webdriver.support.select import Select
import time, os


app = """
library(dash)
library(dashHtmlComponents)

app <- Dash$new(meta_tags = list(list(name = "description", content = "some content")))

app$layout(
 htmlDiv(children = "Hello world!",
 id = "hello-div"
 )
)

app$run_server()
"""


def test_rstm001_test_meta(dashr):
 dashr.start_server(app)
 dashr.wait_for_text_to_equal(
 "#hello-div",
 "Hello world!"
 )
 assert dashr.find_element("meta[name='description']").get_attribute("content") == "some content"
Comment thread
rpkyle marked this conversation as resolved.

 assert dashr.find_element("meta[charset='UTF-8']")
 assert dashr.find_element("meta[http-equiv='X-UA-Compatible']").get_attribute("content") == "IE=edge"


app2 = """ 
library(dash)
library(dashHtmlComponents)

app <- Dash$new(meta_tags = list(list(charset = "ISO-8859-1"), 
 list(name = "keywords", content = "dash,pleasant,productive"), 
 list(`http-equiv` = 'content-type', content = 'text/html')))

app$layout(
 htmlDiv(children = "Hello world!",
 id = "hello-div"
 )
)

app$run_server()
"""


def test_rstm002_test_meta(dashr):
 dashr.start_server(app2)
 dashr.wait_for_text_to_equal(
 "#hello-div",
 "Hello world!"
 )
 assert dashr.find_element("meta[charset='ISO-8859-1']")
 assert dashr.find_element("meta[name='keywords']").get_attribute("content") == "dash,pleasant,productive"
 assert dashr.find_element("meta[http-equiv='content-type']").get_attribute("content") == "text/html"

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

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 9 commits into

from

Nov 5, 2019
 Merged


Support for meta tags in Dash for R
#142
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
10ae196

:sparkles: initial support for meta tags

Nov 4, 2019
f0f7b15

:hammer: fix tags

Nov 5, 2019
bb897d3

:see_no_evil: properly detect paths

Nov 5, 2019
253e8be

support arbitrary tags

Nov 5, 2019
67fb44a

:rotating_light: add tests

Nov 5, 2019
3e77327

:microscope: add asserts

Nov 5, 2019
1624eef

add reference to meta tag PR


rpkyle Nov 5, 2019
d459cbe

:fast_forward: indent meta tags

Nov 5, 2019
d9c419a

Merge branch '141-meta-tags' of github.com:plotly/dashR into 141-meta…

Nov 5, 2019

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


1 change: 1 addition & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ All notable changes to this project will be documented in this file.

## Unreleased
### Added
- Support for adding `<meta>` tags to index [#142](https://github.com/plotly/dashR/pull/142)
- Hot reloading now supported in debug mode [#127](https://github.com/plotly/dashR/pull/127)
- Support for displaying Dash for R applications within RStudio's viewer pane when `use_viewer = TRUE`
- Clientside callbacks written in JavaScript are now supported [#130](https://github.com/plotly/dashR/pull/130)
Expand Down

23 changes: 19 additions & 4 deletions
R/dash.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@
#' assets_url_path = '/assets',
#' assets_ignore = '',
#' serve_locally = TRUE,
#' meta_tags = NULL,
#' routes_pathname_prefix = '/',
#' requests_pathname_prefix = '/',
#' external_scripts = NULL,
Expand All@@ -34,6 +35,9 @@
#' cannot use this to prevent access to sensitive files. \cr
#' `serve_locally` \tab \tab Whether to serve HTML dependencies locally or
#' remotely (via URL).\cr
#' `meta_tags` \tab \tab List of lists. HTML `<meta>`tags to be added to the index page.
#' Each list element should have the attributes and values for one tag, eg:
#' `list(name = 'description', content = 'My App')`.\cr
#' `routes_pathname_prefix` \tab \tab a prefix applied to the backend routes.\cr
#' `requests_pathname_prefix` \tab \tab a prefix applied to request endpoints
#' made by Dash's front-end.\cr
Expand DownExpand Up@@ -158,6 +162,7 @@ Dash <- R6::R6Class(
 assets_url_path = '/assets',
 assets_ignore = '',
 serve_locally = TRUE,
 meta_tags = NULL,
 routes_pathname_prefix = NULL,
 requests_pathname_prefix = NULL,
 external_scripts = NULL,
Expand All@@ -181,6 +186,7 @@ Dash <- R6::R6Class(
 private$suppress_callback_exceptions <- suppress_callback_exceptions
 private$app_root_path <- getAppPath()
 private$app_launchtime <- as.integer(Sys.time())
 private$meta_tags <- meta_tags

 # config options
 self$config$routes_pathname_prefix <- resolve_prefix(routes_pathname_prefix, "DASH_ROUTES_PATHNAME_PREFIX")
Expand DownExpand Up@@ -815,6 +821,7 @@ Dash <- R6::R6Class(
 # private fields defined on initiation
 name = NULL,
 serve_locally = NULL,
 meta_tags = NULL,
 assets_folder = NULL,
 assets_url_path = NULL,
 assets_ignore = NULL,
Expand DownExpand Up@@ -1231,17 +1238,21 @@ Dash <- R6::R6Class(
 css_tags <- paste(c(css_deps,
 css_external,
 css_assets),
 collapse = "\n")
 collapse = "\n")

 scripts_tags <- paste(c(scripts_deps,
 scripts_external,
 scripts_assets,
 scripts_invoke_renderer),
 collapse = "\n")
 collapse = "\n")

 meta_tags <- paste(generate_meta_tags(private$meta_tags),
 collapse = "\n ")

 return(list(css_tags = css_tags,
 scripts_tags = scripts_tags,
 favicon = favicon))
 favicon = favicon,
 meta_tags = meta_tags))
 },

 index = function() {
Expand All@@ -1257,11 +1268,14 @@ Dash <- R6::R6Class(
 # retrieve script tags for serving in the index
 scripts_tags <- all_tags[["scripts_tags"]]

 # insert meta tags if present
 meta_tags <- all_tags[["meta_tags"]]

 private$.index <- sprintf(
 '<!DOCTYPE html>
 <html>
 <head>
<meta charset="UTF-8"/>
%s
 <title>%s</title>
 %s
 %s
Expand All@@ -1278,6 +1292,7 @@ Dash <- R6::R6Class(
 </footer>
 </body>
 </html>',
 meta_tags,
 private$name,
 favicon,
 css_tags,
Expand Down

28 changes: 27 additions & 1 deletion
R/utils.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -607,6 +607,32 @@ generate_js_dist_html <- function(href,
 }
}

generate_meta_tags <- function(metas) {
 has_ie_compat <- any(vapply(metas, function(x) 
 x$name == "http-equiv" && x$content == "X-UA-Compatible", 
 logical(1)), na.rm=TRUE)
 has_charset <- any(vapply(metas, function(x) 
 "charset" %in% names(x), 
 logical(1)), na.rm=TRUE)

 # allow arbitrary tags with varying numbers of keys
 tags <- vapply(metas, 
 function(tag) sprintf("<meta %s>", paste(sprintf("%s=\"%s\"", 
 names(tag), 
 unlist(tag, use.names = FALSE)), 
 collapse=" ")),
 character(1))

 if (!has_ie_compat) {
 tags <- c('<meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge\">', tags)
 }

 if (!has_charset) {
 tags <- c('<meta charset=\"UTF-8\">', tags)
 }
 return(tags)
}

# This function takes the list object containing asset paths
# for all stylesheets and scripts, as well as the URL path
# to search, then returns the absolute local path (when
Expand DownExpand Up@@ -970,7 +996,7 @@ modtimeFromPath <- function(path, recursive = FALSE, asset_path="") {
 }
 } else {
 # check if the path is for a directory or file, and handle accordingly
 if (dir.exists(path))
 if (length(path) == 1 && dir.exists(path))
 modtime <- as.integer(max(file.info(list.files(path, full.names = TRUE))$mtime, na.rm=TRUE))
 else
 modtime <- as.integer(file.info(path)$mtime)
Expand Down

58 changes: 58 additions & 0 deletions
tests/integration/test_meta.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
from selenium.webdriver.support.select import Select
import time, os


app = """
library(dash)
library(dashHtmlComponents)

app <- Dash$new(meta_tags = list(list(name = "description", content = "some content")))

app$layout(
 htmlDiv(children = "Hello world!",
 id = "hello-div"
 )
)

app$run_server()
"""


def test_rstm001_test_meta(dashr):
 dashr.start_server(app)
 dashr.wait_for_text_to_equal(
 "#hello-div",
 "Hello world!"
 )
 assert dashr.find_element("meta[name='description']").get_attribute("content") == "some content"
Comment thread
rpkyle marked this conversation as resolved.

 assert dashr.find_element("meta[charset='UTF-8']")
 assert dashr.find_element("meta[http-equiv='X-UA-Compatible']").get_attribute("content") == "IE=edge"


app2 = """ 
library(dash)
library(dashHtmlComponents)

app <- Dash$new(meta_tags = list(list(charset = "ISO-8859-1"), 
 list(name = "keywords", content = "dash,pleasant,productive"), 
 list(`http-equiv` = 'content-type', content = 'text/html')))

app$layout(
 htmlDiv(children = "Hello world!",
 id = "hello-div"
 )
)

app$run_server()
"""


def test_rstm002_test_meta(dashr):
 dashr.start_server(app2)
 dashr.wait_for_text_to_equal(
 "#hello-div",
 "Hello world!"
 )
 assert dashr.find_element("meta[charset='ISO-8859-1']")
 assert dashr.find_element("meta[name='keywords']").get_attribute("content") == "dash,pleasant,productive"
 assert dashr.find_element("meta[http-equiv='content-type']").get_attribute("content") == "text/html"

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

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 9 commits into

from

Nov 5, 2019
 Merged


Support for meta tags in Dash for R
#142
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
10ae196

:sparkles: initial support for meta tags

Nov 4, 2019
f0f7b15

:hammer: fix tags

Nov 5, 2019
bb897d3

:see_no_evil: properly detect paths

Nov 5, 2019
253e8be

support arbitrary tags

Nov 5, 2019
67fb44a

:rotating_light: add tests

Nov 5, 2019
3e77327

:microscope: add asserts

Nov 5, 2019
1624eef

add reference to meta tag PR


rpkyle Nov 5, 2019
d459cbe

:fast_forward: indent meta tags

Nov 5, 2019
d9c419a

Merge branch '141-meta-tags' of github.com:plotly/dashR into 141-meta…

Nov 5, 2019

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


1 change: 1 addition & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ All notable changes to this project will be documented in this file.

## Unreleased
### Added
- Support for adding `<meta>` tags to index [#142](https://github.com/plotly/dashR/pull/142)
- Hot reloading now supported in debug mode [#127](https://github.com/plotly/dashR/pull/127)
- Support for displaying Dash for R applications within RStudio's viewer pane when `use_viewer = TRUE`
- Clientside callbacks written in JavaScript are now supported [#130](https://github.com/plotly/dashR/pull/130)
Expand Down

23 changes: 19 additions & 4 deletions
R/dash.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@
#' assets_url_path = '/assets',
#' assets_ignore = '',
#' serve_locally = TRUE,
#' meta_tags = NULL,
#' routes_pathname_prefix = '/',
#' requests_pathname_prefix = '/',
#' external_scripts = NULL,
Expand All@@ -34,6 +35,9 @@
#' cannot use this to prevent access to sensitive files. \cr
#' `serve_locally` \tab \tab Whether to serve HTML dependencies locally or
#' remotely (via URL).\cr
#' `meta_tags` \tab \tab List of lists. HTML `<meta>`tags to be added to the index page.
#' Each list element should have the attributes and values for one tag, eg:
#' `list(name = 'description', content = 'My App')`.\cr
#' `routes_pathname_prefix` \tab \tab a prefix applied to the backend routes.\cr
#' `requests_pathname_prefix` \tab \tab a prefix applied to request endpoints
#' made by Dash's front-end.\cr
Expand DownExpand Up@@ -158,6 +162,7 @@ Dash <- R6::R6Class(
 assets_url_path = '/assets',
 assets_ignore = '',
 serve_locally = TRUE,
 meta_tags = NULL,
 routes_pathname_prefix = NULL,
 requests_pathname_prefix = NULL,
 external_scripts = NULL,
Expand All@@ -181,6 +186,7 @@ Dash <- R6::R6Class(
 private$suppress_callback_exceptions <- suppress_callback_exceptions
 private$app_root_path <- getAppPath()
 private$app_launchtime <- as.integer(Sys.time())
 private$meta_tags <- meta_tags

 # config options
 self$config$routes_pathname_prefix <- resolve_prefix(routes_pathname_prefix, "DASH_ROUTES_PATHNAME_PREFIX")
Expand DownExpand Up@@ -815,6 +821,7 @@ Dash <- R6::R6Class(
 # private fields defined on initiation
 name = NULL,
 serve_locally = NULL,
 meta_tags = NULL,
 assets_folder = NULL,
 assets_url_path = NULL,
 assets_ignore = NULL,
Expand DownExpand Up@@ -1231,17 +1238,21 @@ Dash <- R6::R6Class(
 css_tags <- paste(c(css_deps,
 css_external,
 css_assets),
 collapse = "\n")
 collapse = "\n")

 scripts_tags <- paste(c(scripts_deps,
 scripts_external,
 scripts_assets,
 scripts_invoke_renderer),
 collapse = "\n")
 collapse = "\n")

 meta_tags <- paste(generate_meta_tags(private$meta_tags),
 collapse = "\n ")

 return(list(css_tags = css_tags,
 scripts_tags = scripts_tags,
 favicon = favicon))
 favicon = favicon,
 meta_tags = meta_tags))
 },

 index = function() {
Expand All@@ -1257,11 +1268,14 @@ Dash <- R6::R6Class(
 # retrieve script tags for serving in the index
 scripts_tags <- all_tags[["scripts_tags"]]

 # insert meta tags if present
 meta_tags <- all_tags[["meta_tags"]]

 private$.index <- sprintf(
 '<!DOCTYPE html>
 <html>
 <head>
<meta charset="UTF-8"/>
%s
 <title>%s</title>
 %s
 %s
Expand All@@ -1278,6 +1292,7 @@ Dash <- R6::R6Class(
 </footer>
 </body>
 </html>',
 meta_tags,
 private$name,
 favicon,
 css_tags,
Expand Down

28 changes: 27 additions & 1 deletion
R/utils.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -607,6 +607,32 @@ generate_js_dist_html <- function(href,
 }
}

generate_meta_tags <- function(metas) {
 has_ie_compat <- any(vapply(metas, function(x) 
 x$name == "http-equiv" && x$content == "X-UA-Compatible", 
 logical(1)), na.rm=TRUE)
 has_charset <- any(vapply(metas, function(x) 
 "charset" %in% names(x), 
 logical(1)), na.rm=TRUE)

 # allow arbitrary tags with varying numbers of keys
 tags <- vapply(metas, 
 function(tag) sprintf("<meta %s>", paste(sprintf("%s=\"%s\"", 
 names(tag), 
 unlist(tag, use.names = FALSE)), 
 collapse=" ")),
 character(1))

 if (!has_ie_compat) {
 tags <- c('<meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge\">', tags)
 }

 if (!has_charset) {
 tags <- c('<meta charset=\"UTF-8\">', tags)
 }
 return(tags)
}

# This function takes the list object containing asset paths
# for all stylesheets and scripts, as well as the URL path
# to search, then returns the absolute local path (when
Expand DownExpand Up@@ -970,7 +996,7 @@ modtimeFromPath <- function(path, recursive = FALSE, asset_path="") {
 }
 } else {
 # check if the path is for a directory or file, and handle accordingly
 if (dir.exists(path))
 if (length(path) == 1 && dir.exists(path))
 modtime <- as.integer(max(file.info(list.files(path, full.names = TRUE))$mtime, na.rm=TRUE))
 else
 modtime <- as.integer(file.info(path)$mtime)
Expand Down

58 changes: 58 additions & 0 deletions
tests/integration/test_meta.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
from selenium.webdriver.support.select import Select
import time, os


app = """
library(dash)
library(dashHtmlComponents)

app <- Dash$new(meta_tags = list(list(name = "description", content = "some content")))

app$layout(
 htmlDiv(children = "Hello world!",
 id = "hello-div"
 )
)

app$run_server()
"""


def test_rstm001_test_meta(dashr):
 dashr.start_server(app)
 dashr.wait_for_text_to_equal(
 "#hello-div",
 "Hello world!"
 )
 assert dashr.find_element("meta[name='description']").get_attribute("content") == "some content"
Comment thread
rpkyle marked this conversation as resolved.

 assert dashr.find_element("meta[charset='UTF-8']")
 assert dashr.find_element("meta[http-equiv='X-UA-Compatible']").get_attribute("content") == "IE=edge"


app2 = """ 
library(dash)
library(dashHtmlComponents)

app <- Dash$new(meta_tags = list(list(charset = "ISO-8859-1"), 
 list(name = "keywords", content = "dash,pleasant,productive"), 
 list(`http-equiv` = 'content-type', content = 'text/html')))

app$layout(
 htmlDiv(children = "Hello world!",
 id = "hello-div"
 )
)

app$run_server()
"""


def test_rstm002_test_meta(dashr):
 dashr.start_server(app2)
 dashr.wait_for_text_to_equal(
 "#hello-div",
 "Hello world!"
 )
 assert dashr.find_element("meta[charset='ISO-8859-1']")
 assert dashr.find_element("meta[name='keywords']").get_attribute("content") == "dash,pleasant,productive"
 assert dashr.find_element("meta[http-equiv='content-type']").get_attribute("content") == "text/html"

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

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 9 commits into

from

Nov 5, 2019
 Merged


Support for meta tags in Dash for R
#142
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
10ae196

:sparkles: initial support for meta tags

Nov 4, 2019
f0f7b15

:hammer: fix tags

Nov 5, 2019
bb897d3

:see_no_evil: properly detect paths

Nov 5, 2019
253e8be

support arbitrary tags

Nov 5, 2019
67fb44a

:rotating_light: add tests

Nov 5, 2019
3e77327

:microscope: add asserts

Nov 5, 2019
1624eef

add reference to meta tag PR


rpkyle Nov 5, 2019
d459cbe

:fast_forward: indent meta tags

Nov 5, 2019
d9c419a

Merge branch '141-meta-tags' of github.com:plotly/dashR into 141-meta…

Nov 5, 2019

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


1 change: 1 addition & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ All notable changes to this project will be documented in this file.

## Unreleased
### Added
- Support for adding `<meta>` tags to index [#142](https://github.com/plotly/dashR/pull/142)
- Hot reloading now supported in debug mode [#127](https://github.com/plotly/dashR/pull/127)
- Support for displaying Dash for R applications within RStudio's viewer pane when `use_viewer = TRUE`
- Clientside callbacks written in JavaScript are now supported [#130](https://github.com/plotly/dashR/pull/130)
Expand Down

23 changes: 19 additions & 4 deletions
R/dash.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@
#' assets_url_path = '/assets',
#' assets_ignore = '',
#' serve_locally = TRUE,
#' meta_tags = NULL,
#' routes_pathname_prefix = '/',
#' requests_pathname_prefix = '/',
#' external_scripts = NULL,
Expand All@@ -34,6 +35,9 @@
#' cannot use this to prevent access to sensitive files. \cr
#' `serve_locally` \tab \tab Whether to serve HTML dependencies locally or
#' remotely (via URL).\cr
#' `meta_tags` \tab \tab List of lists. HTML `<meta>`tags to be added to the index page.
#' Each list element should have the attributes and values for one tag, eg:
#' `list(name = 'description', content = 'My App')`.\cr
#' `routes_pathname_prefix` \tab \tab a prefix applied to the backend routes.\cr
#' `requests_pathname_prefix` \tab \tab a prefix applied to request endpoints
#' made by Dash's front-end.\cr
Expand DownExpand Up@@ -158,6 +162,7 @@ Dash <- R6::R6Class(
 assets_url_path = '/assets',
 assets_ignore = '',
 serve_locally = TRUE,
 meta_tags = NULL,
 routes_pathname_prefix = NULL,
 requests_pathname_prefix = NULL,
 external_scripts = NULL,
Expand All@@ -181,6 +186,7 @@ Dash <- R6::R6Class(
 private$suppress_callback_exceptions <- suppress_callback_exceptions
 private$app_root_path <- getAppPath()
 private$app_launchtime <- as.integer(Sys.time())
 private$meta_tags <- meta_tags

 # config options
 self$config$routes_pathname_prefix <- resolve_prefix(routes_pathname_prefix, "DASH_ROUTES_PATHNAME_PREFIX")
Expand DownExpand Up@@ -815,6 +821,7 @@ Dash <- R6::R6Class(
 # private fields defined on initiation
 name = NULL,
 serve_locally = NULL,
 meta_tags = NULL,
 assets_folder = NULL,
 assets_url_path = NULL,
 assets_ignore = NULL,
Expand DownExpand Up@@ -1231,17 +1238,21 @@ Dash <- R6::R6Class(
 css_tags <- paste(c(css_deps,
 css_external,
 css_assets),
 collapse = "\n")
 collapse = "\n")

 scripts_tags <- paste(c(scripts_deps,
 scripts_external,
 scripts_assets,
 scripts_invoke_renderer),
 collapse = "\n")
 collapse = "\n")

 meta_tags <- paste(generate_meta_tags(private$meta_tags),
 collapse = "\n ")

 return(list(css_tags = css_tags,
 scripts_tags = scripts_tags,
 favicon = favicon))
 favicon = favicon,
 meta_tags = meta_tags))
 },

 index = function() {
Expand All@@ -1257,11 +1268,14 @@ Dash <- R6::R6Class(
 # retrieve script tags for serving in the index
 scripts_tags <- all_tags[["scripts_tags"]]

 # insert meta tags if present
 meta_tags <- all_tags[["meta_tags"]]

 private$.index <- sprintf(
 '<!DOCTYPE html>
 <html>
 <head>
<meta charset="UTF-8"/>
%s
 <title>%s</title>
 %s
 %s
Expand All@@ -1278,6 +1292,7 @@ Dash <- R6::R6Class(
 </footer>
 </body>
 </html>',
 meta_tags,
 private$name,
 favicon,
 css_tags,
Expand Down

28 changes: 27 additions & 1 deletion
R/utils.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -607,6 +607,32 @@ generate_js_dist_html <- function(href,
 }
}

generate_meta_tags <- function(metas) {
 has_ie_compat <- any(vapply(metas, function(x) 
 x$name == "http-equiv" && x$content == "X-UA-Compatible", 
 logical(1)), na.rm=TRUE)
 has_charset <- any(vapply(metas, function(x) 
 "charset" %in% names(x), 
 logical(1)), na.rm=TRUE)

 # allow arbitrary tags with varying numbers of keys
 tags <- vapply(metas, 
 function(tag) sprintf("<meta %s>", paste(sprintf("%s=\"%s\"", 
 names(tag), 
 unlist(tag, use.names = FALSE)), 
 collapse=" ")),
 character(1))

 if (!has_ie_compat) {
 tags <- c('<meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge\">', tags)
 }

 if (!has_charset) {
 tags <- c('<meta charset=\"UTF-8\">', tags)
 }
 return(tags)
}

# This function takes the list object containing asset paths
# for all stylesheets and scripts, as well as the URL path
# to search, then returns the absolute local path (when
Expand DownExpand Up@@ -970,7 +996,7 @@ modtimeFromPath <- function(path, recursive = FALSE, asset_path="") {
 }
 } else {
 # check if the path is for a directory or file, and handle accordingly
 if (dir.exists(path))
 if (length(path) == 1 && dir.exists(path))
 modtime <- as.integer(max(file.info(list.files(path, full.names = TRUE))$mtime, na.rm=TRUE))
 else
 modtime <- as.integer(file.info(path)$mtime)
Expand Down

58 changes: 58 additions & 0 deletions
tests/integration/test_meta.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
from selenium.webdriver.support.select import Select
import time, os


app = """
library(dash)
library(dashHtmlComponents)

app <- Dash$new(meta_tags = list(list(name = "description", content = "some content")))

app$layout(
 htmlDiv(children = "Hello world!",
 id = "hello-div"
 )
)

app$run_server()
"""


def test_rstm001_test_meta(dashr):
 dashr.start_server(app)
 dashr.wait_for_text_to_equal(
 "#hello-div",
 "Hello world!"
 )
 assert dashr.find_element("meta[name='description']").get_attribute("content") == "some content"
Comment thread
rpkyle marked this conversation as resolved.

 assert dashr.find_element("meta[charset='UTF-8']")
 assert dashr.find_element("meta[http-equiv='X-UA-Compatible']").get_attribute("content") == "IE=edge"


app2 = """ 
library(dash)
library(dashHtmlComponents)

app <- Dash$new(meta_tags = list(list(charset = "ISO-8859-1"), 
 list(name = "keywords", content = "dash,pleasant,productive"), 
 list(`http-equiv` = 'content-type', content = 'text/html')))

app$layout(
 htmlDiv(children = "Hello world!",
 id = "hello-div"
 )
)

app$run_server()
"""


def test_rstm002_test_meta(dashr):
 dashr.start_server(app2)
 dashr.wait_for_text_to_equal(
 "#hello-div",
 "Hello world!"
 )
 assert dashr.find_element("meta[charset='ISO-8859-1']")
 assert dashr.find_element("meta[name='keywords']").get_attribute("content") == "dash,pleasant,productive"
 assert dashr.find_element("meta[http-equiv='content-type']").get_attribute("content") == "text/html"

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Support for meta tags in Dash for R by rpkyle · Pull Request #142 · plotly/dashR · GitHub
Skip to content
Support for meta tags in Dash for R#142

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 9 commits into

from

Nov 5, 2019
 Merged


Support for meta tags in Dash for R
#142
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
10ae196

:sparkles: initial support for meta tags

Nov 4, 2019
f0f7b15

:hammer: fix tags

Nov 5, 2019
bb897d3

:see_no_evil: properly detect paths

Nov 5, 2019
253e8be

support arbitrary tags

Nov 5, 2019
67fb44a

:rotating_light: add tests

Nov 5, 2019
3e77327

:microscope: add asserts

Nov 5, 2019
1624eef

add reference to meta tag PR


rpkyle Nov 5, 2019
d459cbe

:fast_forward: indent meta tags

Nov 5, 2019
d9c419a

Merge branch '141-meta-tags' of github.com:plotly/dashR into 141-meta…

Nov 5, 2019

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


1 change: 1 addition & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ All notable changes to this project will be documented in this file.

## Unreleased
### Added
- Support for adding `<meta>` tags to index [#142](https://github.com/plotly/dashR/pull/142)
- Hot reloading now supported in debug mode [#127](https://github.com/plotly/dashR/pull/127)
- Support for displaying Dash for R applications within RStudio's viewer pane when `use_viewer = TRUE`
- Clientside callbacks written in JavaScript are now supported [#130](https://github.com/plotly/dashR/pull/130)
Expand Down

23 changes: 19 additions & 4 deletions
R/dash.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@
#' assets_url_path = '/assets',
#' assets_ignore = '',
#' serve_locally = TRUE,
#' meta_tags = NULL,
#' routes_pathname_prefix = '/',
#' requests_pathname_prefix = '/',
#' external_scripts = NULL,
Expand All@@ -34,6 +35,9 @@
#' cannot use this to prevent access to sensitive files. \cr
#' `serve_locally` \tab \tab Whether to serve HTML dependencies locally or
#' remotely (via URL).\cr
#' `meta_tags` \tab \tab List of lists. HTML `<meta>`tags to be added to the index page.
#' Each list element should have the attributes and values for one tag, eg:
#' `list(name = 'description', content = 'My App')`.\cr
#' `routes_pathname_prefix` \tab \tab a prefix applied to the backend routes.\cr
#' `requests_pathname_prefix` \tab \tab a prefix applied to request endpoints
#' made by Dash's front-end.\cr
Expand DownExpand Up@@ -158,6 +162,7 @@ Dash <- R6::R6Class(
 assets_url_path = '/assets',
 assets_ignore = '',
 serve_locally = TRUE,
 meta_tags = NULL,
 routes_pathname_prefix = NULL,
 requests_pathname_prefix = NULL,
 external_scripts = NULL,
Expand All@@ -181,6 +186,7 @@ Dash <- R6::R6Class(
 private$suppress_callback_exceptions <- suppress_callback_exceptions
 private$app_root_path <- getAppPath()
 private$app_launchtime <- as.integer(Sys.time())
 private$meta_tags <- meta_tags

 # config options
 self$config$routes_pathname_prefix <- resolve_prefix(routes_pathname_prefix, "DASH_ROUTES_PATHNAME_PREFIX")
Expand DownExpand Up@@ -815,6 +821,7 @@ Dash <- R6::R6Class(
 # private fields defined on initiation
 name = NULL,
 serve_locally = NULL,
 meta_tags = NULL,
 assets_folder = NULL,
 assets_url_path = NULL,
 assets_ignore = NULL,
Expand DownExpand Up@@ -1231,17 +1238,21 @@ Dash <- R6::R6Class(
 css_tags <- paste(c(css_deps,
 css_external,
 css_assets),
 collapse = "\n")
 collapse = "\n")

 scripts_tags <- paste(c(scripts_deps,
 scripts_external,
 scripts_assets,
 scripts_invoke_renderer),
 collapse = "\n")
 collapse = "\n")

 meta_tags <- paste(generate_meta_tags(private$meta_tags),
 collapse = "\n ")

 return(list(css_tags = css_tags,
 scripts_tags = scripts_tags,
 favicon = favicon))
 favicon = favicon,
 meta_tags = meta_tags))
 },

 index = function() {
Expand All@@ -1257,11 +1268,14 @@ Dash <- R6::R6Class(
 # retrieve script tags for serving in the index
 scripts_tags <- all_tags[["scripts_tags"]]

 # insert meta tags if present
 meta_tags <- all_tags[["meta_tags"]]

 private$.index <- sprintf(
 '<!DOCTYPE html>
 <html>
 <head>
<meta charset="UTF-8"/>
%s
 <title>%s</title>
 %s
 %s
Expand All@@ -1278,6 +1292,7 @@ Dash <- R6::R6Class(
 </footer>
 </body>
 </html>',
 meta_tags,
 private$name,
 favicon,
 css_tags,
Expand Down

28 changes: 27 additions & 1 deletion
R/utils.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -607,6 +607,32 @@ generate_js_dist_html <- function(href,
 }
}

generate_meta_tags <- function(metas) {
 has_ie_compat <- any(vapply(metas, function(x) 
 x$name == "http-equiv" && x$content == "X-UA-Compatible", 
 logical(1)), na.rm=TRUE)
 has_charset <- any(vapply(metas, function(x) 
 "charset" %in% names(x), 
 logical(1)), na.rm=TRUE)

 # allow arbitrary tags with varying numbers of keys
 tags <- vapply(metas, 
 function(tag) sprintf("<meta %s>", paste(sprintf("%s=\"%s\"", 
 names(tag), 
 unlist(tag, use.names = FALSE)), 
 collapse=" ")),
 character(1))

 if (!has_ie_compat) {
 tags <- c('<meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge\">', tags)
 }

 if (!has_charset) {
 tags <- c('<meta charset=\"UTF-8\">', tags)
 }
 return(tags)
}

# This function takes the list object containing asset paths
# for all stylesheets and scripts, as well as the URL path
# to search, then returns the absolute local path (when
Expand DownExpand Up@@ -970,7 +996,7 @@ modtimeFromPath <- function(path, recursive = FALSE, asset_path="") {
 }
 } else {
 # check if the path is for a directory or file, and handle accordingly
 if (dir.exists(path))
 if (length(path) == 1 && dir.exists(path))
 modtime <- as.integer(max(file.info(list.files(path, full.names = TRUE))$mtime, na.rm=TRUE))
 else
 modtime <- as.integer(file.info(path)$mtime)
Expand Down

58 changes: 58 additions & 0 deletions
tests/integration/test_meta.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
from selenium.webdriver.support.select import Select
import time, os


app = """
library(dash)
library(dashHtmlComponents)

app <- Dash$new(meta_tags = list(list(name = "description", content = "some content")))

app$layout(
 htmlDiv(children = "Hello world!",
 id = "hello-div"
 )
)

app$run_server()
"""


def test_rstm001_test_meta(dashr):
 dashr.start_server(app)
 dashr.wait_for_text_to_equal(
 "#hello-div",
 "Hello world!"
 )
 assert dashr.find_element("meta[name='description']").get_attribute("content") == "some content"
Comment thread
rpkyle marked this conversation as resolved.

 assert dashr.find_element("meta[charset='UTF-8']")
 assert dashr.find_element("meta[http-equiv='X-UA-Compatible']").get_attribute("content") == "IE=edge"


app2 = """ 
library(dash)
library(dashHtmlComponents)

app <- Dash$new(meta_tags = list(list(charset = "ISO-8859-1"), 
 list(name = "keywords", content = "dash,pleasant,productive"), 
 list(`http-equiv` = 'content-type', content = 'text/html')))

app$layout(
 htmlDiv(children = "Hello world!",
 id = "hello-div"
 )
)

app$run_server()
"""


def test_rstm002_test_meta(dashr):
 dashr.start_server(app2)
 dashr.wait_for_text_to_equal(
 "#hello-div",
 "Hello world!"
 )
 assert dashr.find_element("meta[charset='ISO-8859-1']")
 assert dashr.find_element("meta[name='keywords']").get_attribute("content") == "dash,pleasant,productive"
 assert dashr.find_element("meta[http-equiv='content-type']").get_attribute("content") == "text/html"

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Support for meta tags in Dash for R by rpkyle · Pull Request #142 · plotly/dashR · GitHub
Skip to content
Support for meta tags in Dash for R#142

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 9 commits into

from

Nov 5, 2019
 Merged


Support for meta tags in Dash for R
#142
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
10ae196

:sparkles: initial support for meta tags

Nov 4, 2019
f0f7b15

:hammer: fix tags

Nov 5, 2019
bb897d3

:see_no_evil: properly detect paths

Nov 5, 2019
253e8be

support arbitrary tags

Nov 5, 2019
67fb44a

:rotating_light: add tests

Nov 5, 2019
3e77327

:microscope: add asserts

Nov 5, 2019
1624eef

add reference to meta tag PR


rpkyle Nov 5, 2019
d459cbe

:fast_forward: indent meta tags

Nov 5, 2019
d9c419a

Merge branch '141-meta-tags' of github.com:plotly/dashR into 141-meta…

Nov 5, 2019

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


1 change: 1 addition & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ All notable changes to this project will be documented in this file.

## Unreleased
### Added
- Support for adding `<meta>` tags to index [#142](https://github.com/plotly/dashR/pull/142)
- Hot reloading now supported in debug mode [#127](https://github.com/plotly/dashR/pull/127)
- Support for displaying Dash for R applications within RStudio's viewer pane when `use_viewer = TRUE`
- Clientside callbacks written in JavaScript are now supported [#130](https://github.com/plotly/dashR/pull/130)
Expand Down

23 changes: 19 additions & 4 deletions
R/dash.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@
#' assets_url_path = '/assets',
#' assets_ignore = '',
#' serve_locally = TRUE,
#' meta_tags = NULL,
#' routes_pathname_prefix = '/',
#' requests_pathname_prefix = '/',
#' external_scripts = NULL,
Expand All@@ -34,6 +35,9 @@
#' cannot use this to prevent access to sensitive files. \cr
#' `serve_locally` \tab \tab Whether to serve HTML dependencies locally or
#' remotely (via URL).\cr
#' `meta_tags` \tab \tab List of lists. HTML `<meta>`tags to be added to the index page.
#' Each list element should have the attributes and values for one tag, eg:
#' `list(name = 'description', content = 'My App')`.\cr
#' `routes_pathname_prefix` \tab \tab a prefix applied to the backend routes.\cr
#' `requests_pathname_prefix` \tab \tab a prefix applied to request endpoints
#' made by Dash's front-end.\cr
Expand DownExpand Up@@ -158,6 +162,7 @@ Dash <- R6::R6Class(
 assets_url_path = '/assets',
 assets_ignore = '',
 serve_locally = TRUE,
 meta_tags = NULL,
 routes_pathname_prefix = NULL,
 requests_pathname_prefix = NULL,
 external_scripts = NULL,
Expand All@@ -181,6 +186,7 @@ Dash <- R6::R6Class(
 private$suppress_callback_exceptions <- suppress_callback_exceptions
 private$app_root_path <- getAppPath()
 private$app_launchtime <- as.integer(Sys.time())
 private$meta_tags <- meta_tags

 # config options
 self$config$routes_pathname_prefix <- resolve_prefix(routes_pathname_prefix, "DASH_ROUTES_PATHNAME_PREFIX")
Expand DownExpand Up@@ -815,6 +821,7 @@ Dash <- R6::R6Class(
 # private fields defined on initiation
 name = NULL,
 serve_locally = NULL,
 meta_tags = NULL,
 assets_folder = NULL,
 assets_url_path = NULL,
 assets_ignore = NULL,
Expand DownExpand Up@@ -1231,17 +1238,21 @@ Dash <- R6::R6Class(
 css_tags <- paste(c(css_deps,
 css_external,
 css_assets),
 collapse = "\n")
 collapse = "\n")

 scripts_tags <- paste(c(scripts_deps,
 scripts_external,
 scripts_assets,
 scripts_invoke_renderer),
 collapse = "\n")
 collapse = "\n")

 meta_tags <- paste(generate_meta_tags(private$meta_tags),
 collapse = "\n ")

 return(list(css_tags = css_tags,
 scripts_tags = scripts_tags,
 favicon = favicon))
 favicon = favicon,
 meta_tags = meta_tags))
 },

 index = function() {
Expand All@@ -1257,11 +1268,14 @@ Dash <- R6::R6Class(
 # retrieve script tags for serving in the index
 scripts_tags <- all_tags[["scripts_tags"]]

 # insert meta tags if present
 meta_tags <- all_tags[["meta_tags"]]

 private$.index <- sprintf(
 '<!DOCTYPE html>
 <html>
 <head>
<meta charset="UTF-8"/>
%s
 <title>%s</title>
 %s
 %s
Expand All@@ -1278,6 +1292,7 @@ Dash <- R6::R6Class(
 </footer>
 </body>
 </html>',
 meta_tags,
 private$name,
 favicon,
 css_tags,
Expand Down

28 changes: 27 additions & 1 deletion
R/utils.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -607,6 +607,32 @@ generate_js_dist_html <- function(href,
 }
}

generate_meta_tags <- function(metas) {
 has_ie_compat <- any(vapply(metas, function(x) 
 x$name == "http-equiv" && x$content == "X-UA-Compatible", 
 logical(1)), na.rm=TRUE)
 has_charset <- any(vapply(metas, function(x) 
 "charset" %in% names(x), 
 logical(1)), na.rm=TRUE)

 # allow arbitrary tags with varying numbers of keys
 tags <- vapply(metas, 
 function(tag) sprintf("<meta %s>", paste(sprintf("%s=\"%s\"", 
 names(tag), 
 unlist(tag, use.names = FALSE)), 
 collapse=" ")),
 character(1))

 if (!has_ie_compat) {
 tags <- c('<meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge\">', tags)
 }

 if (!has_charset) {
 tags <- c('<meta charset=\"UTF-8\">', tags)
 }
 return(tags)
}

# This function takes the list object containing asset paths
# for all stylesheets and scripts, as well as the URL path
# to search, then returns the absolute local path (when
Expand DownExpand Up@@ -970,7 +996,7 @@ modtimeFromPath <- function(path, recursive = FALSE, asset_path="") {
 }
 } else {
 # check if the path is for a directory or file, and handle accordingly
 if (dir.exists(path))
 if (length(path) == 1 && dir.exists(path))
 modtime <- as.integer(max(file.info(list.files(path, full.names = TRUE))$mtime, na.rm=TRUE))
 else
 modtime <- as.integer(file.info(path)$mtime)
Expand Down

58 changes: 58 additions & 0 deletions
tests/integration/test_meta.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
from selenium.webdriver.support.select import Select
import time, os


app = """
library(dash)
library(dashHtmlComponents)

app <- Dash$new(meta_tags = list(list(name = "description", content = "some content")))

app$layout(
 htmlDiv(children = "Hello world!",
 id = "hello-div"
 )
)

app$run_server()
"""


def test_rstm001_test_meta(dashr):
 dashr.start_server(app)
 dashr.wait_for_text_to_equal(
 "#hello-div",
 "Hello world!"
 )
 assert dashr.find_element("meta[name='description']").get_attribute("content") == "some content"
Comment thread
rpkyle marked this conversation as resolved.

 assert dashr.find_element("meta[charset='UTF-8']")
 assert dashr.find_element("meta[http-equiv='X-UA-Compatible']").get_attribute("content") == "IE=edge"


app2 = """ 
library(dash)
library(dashHtmlComponents)

app <- Dash$new(meta_tags = list(list(charset = "ISO-8859-1"), 
 list(name = "keywords", content = "dash,pleasant,productive"), 
 list(`http-equiv` = 'content-type', content = 'text/html')))

app$layout(
 htmlDiv(children = "Hello world!",
 id = "hello-div"
 )
)

app$run_server()
"""


def test_rstm002_test_meta(dashr):
 dashr.start_server(app2)
 dashr.wait_for_text_to_equal(
 "#hello-div",
 "Hello world!"
 )
 assert dashr.find_element("meta[charset='ISO-8859-1']")
 assert dashr.find_element("meta[name='keywords']").get_attribute("content") == "dash,pleasant,productive"
 assert dashr.find_element("meta[http-equiv='content-type']").get_attribute("content") == "text/html"

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

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 9 commits into

from

Nov 5, 2019
 Merged


Support for meta tags in Dash for R
#142
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
10ae196

:sparkles: initial support for meta tags

Nov 4, 2019
f0f7b15

:hammer: fix tags

Nov 5, 2019
bb897d3

:see_no_evil: properly detect paths

Nov 5, 2019
253e8be

support arbitrary tags

Nov 5, 2019
67fb44a

:rotating_light: add tests

Nov 5, 2019
3e77327

:microscope: add asserts

Nov 5, 2019
1624eef

add reference to meta tag PR


rpkyle Nov 5, 2019
d459cbe

:fast_forward: indent meta tags

Nov 5, 2019
d9c419a

Merge branch '141-meta-tags' of github.com:plotly/dashR into 141-meta…

Nov 5, 2019

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


1 change: 1 addition & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ All notable changes to this project will be documented in this file.

## Unreleased
### Added
- Support for adding `<meta>` tags to index [#142](https://github.com/plotly/dashR/pull/142)
- Hot reloading now supported in debug mode [#127](https://github.com/plotly/dashR/pull/127)
- Support for displaying Dash for R applications within RStudio's viewer pane when `use_viewer = TRUE`
- Clientside callbacks written in JavaScript are now supported [#130](https://github.com/plotly/dashR/pull/130)
Expand Down

23 changes: 19 additions & 4 deletions
R/dash.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@
#' assets_url_path = '/assets',
#' assets_ignore = '',
#' serve_locally = TRUE,
#' meta_tags = NULL,
#' routes_pathname_prefix = '/',
#' requests_pathname_prefix = '/',
#' external_scripts = NULL,
Expand All@@ -34,6 +35,9 @@
#' cannot use this to prevent access to sensitive files. \cr
#' `serve_locally` \tab \tab Whether to serve HTML dependencies locally or
#' remotely (via URL).\cr
#' `meta_tags` \tab \tab List of lists. HTML `<meta>`tags to be added to the index page.
#' Each list element should have the attributes and values for one tag, eg:
#' `list(name = 'description', content = 'My App')`.\cr
#' `routes_pathname_prefix` \tab \tab a prefix applied to the backend routes.\cr
#' `requests_pathname_prefix` \tab \tab a prefix applied to request endpoints
#' made by Dash's front-end.\cr
Expand DownExpand Up@@ -158,6 +162,7 @@ Dash <- R6::R6Class(
 assets_url_path = '/assets',
 assets_ignore = '',
 serve_locally = TRUE,
 meta_tags = NULL,
 routes_pathname_prefix = NULL,
 requests_pathname_prefix = NULL,
 external_scripts = NULL,
Expand All@@ -181,6 +186,7 @@ Dash <- R6::R6Class(
 private$suppress_callback_exceptions <- suppress_callback_exceptions
 private$app_root_path <- getAppPath()
 private$app_launchtime <- as.integer(Sys.time())
 private$meta_tags <- meta_tags

 # config options
 self$config$routes_pathname_prefix <- resolve_prefix(routes_pathname_prefix, "DASH_ROUTES_PATHNAME_PREFIX")
Expand DownExpand Up@@ -815,6 +821,7 @@ Dash <- R6::R6Class(
 # private fields defined on initiation
 name = NULL,
 serve_locally = NULL,
 meta_tags = NULL,
 assets_folder = NULL,
 assets_url_path = NULL,
 assets_ignore = NULL,
Expand DownExpand Up@@ -1231,17 +1238,21 @@ Dash <- R6::R6Class(
 css_tags <- paste(c(css_deps,
 css_external,
 css_assets),
 collapse = "\n")
 collapse = "\n")

 scripts_tags <- paste(c(scripts_deps,
 scripts_external,
 scripts_assets,
 scripts_invoke_renderer),
 collapse = "\n")
 collapse = "\n")

 meta_tags <- paste(generate_meta_tags(private$meta_tags),
 collapse = "\n ")

 return(list(css_tags = css_tags,
 scripts_tags = scripts_tags,
 favicon = favicon))
 favicon = favicon,
 meta_tags = meta_tags))
 },

 index = function() {
Expand All@@ -1257,11 +1268,14 @@ Dash <- R6::R6Class(
 # retrieve script tags for serving in the index
 scripts_tags <- all_tags[["scripts_tags"]]

 # insert meta tags if present
 meta_tags <- all_tags[["meta_tags"]]

 private$.index <- sprintf(
 '<!DOCTYPE html>
 <html>
 <head>
<meta charset="UTF-8"/>
%s
 <title>%s</title>
 %s
 %s
Expand All@@ -1278,6 +1292,7 @@ Dash <- R6::R6Class(
 </footer>
 </body>
 </html>',
 meta_tags,
 private$name,
 favicon,
 css_tags,
Expand Down

28 changes: 27 additions & 1 deletion
R/utils.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -607,6 +607,32 @@ generate_js_dist_html <- function(href,
 }
}

generate_meta_tags <- function(metas) {
 has_ie_compat <- any(vapply(metas, function(x) 
 x$name == "http-equiv" && x$content == "X-UA-Compatible", 
 logical(1)), na.rm=TRUE)
 has_charset <- any(vapply(metas, function(x) 
 "charset" %in% names(x), 
 logical(1)), na.rm=TRUE)

 # allow arbitrary tags with varying numbers of keys
 tags <- vapply(metas, 
 function(tag) sprintf("<meta %s>", paste(sprintf("%s=\"%s\"", 
 names(tag), 
 unlist(tag, use.names = FALSE)), 
 collapse=" ")),
 character(1))

 if (!has_ie_compat) {
 tags <- c('<meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge\">', tags)
 }

 if (!has_charset) {
 tags <- c('<meta charset=\"UTF-8\">', tags)
 }
 return(tags)
}

# This function takes the list object containing asset paths
# for all stylesheets and scripts, as well as the URL path
# to search, then returns the absolute local path (when
Expand DownExpand Up@@ -970,7 +996,7 @@ modtimeFromPath <- function(path, recursive = FALSE, asset_path="") {
 }
 } else {
 # check if the path is for a directory or file, and handle accordingly
 if (dir.exists(path))
 if (length(path) == 1 && dir.exists(path))
 modtime <- as.integer(max(file.info(list.files(path, full.names = TRUE))$mtime, na.rm=TRUE))
 else
 modtime <- as.integer(file.info(path)$mtime)
Expand Down

58 changes: 58 additions & 0 deletions
tests/integration/test_meta.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
from selenium.webdriver.support.select import Select
import time, os


app = """
library(dash)
library(dashHtmlComponents)

app <- Dash$new(meta_tags = list(list(name = "description", content = "some content")))

app$layout(
 htmlDiv(children = "Hello world!",
 id = "hello-div"
 )
)

app$run_server()
"""


def test_rstm001_test_meta(dashr):
 dashr.start_server(app)
 dashr.wait_for_text_to_equal(
 "#hello-div",
 "Hello world!"
 )
 assert dashr.find_element("meta[name='description']").get_attribute("content") == "some content"
Comment thread
rpkyle marked this conversation as resolved.

 assert dashr.find_element("meta[charset='UTF-8']")
 assert dashr.find_element("meta[http-equiv='X-UA-Compatible']").get_attribute("content") == "IE=edge"


app2 = """ 
library(dash)
library(dashHtmlComponents)

app <- Dash$new(meta_tags = list(list(charset = "ISO-8859-1"), 
 list(name = "keywords", content = "dash,pleasant,productive"), 
 list(`http-equiv` = 'content-type', content = 'text/html')))

app$layout(
 htmlDiv(children = "Hello world!",
 id = "hello-div"
 )
)

app$run_server()
"""


def test_rstm002_test_meta(dashr):
 dashr.start_server(app2)
 dashr.wait_for_text_to_equal(
 "#hello-div",
 "Hello world!"
 )
 assert dashr.find_element("meta[charset='ISO-8859-1']")
 assert dashr.find_element("meta[name='keywords']").get_attribute("content") == "dash,pleasant,productive"
 assert dashr.find_element("meta[http-equiv='content-type']").get_attribute("content") == "text/html"