├── .Rbuildignore ├── makefile ├── man ├── roclets.Rd ├── create.Rd ├── minify_css.Rd ├── minify_js.Rd ├── dot-test_css.Rd ├── dot-test_javascript.Rd ├── dot-test_ui.Rd ├── test_ui.Rd ├── test_server.Rd ├── remove_component.Rd ├── dot-test_server.Rd └── namespace.Rd ├── .lintr ├── R ├── create.R ├── component-generated-test.R ├── minify.R ├── remove.R ├── file.R ├── component-test.R ├── namespace.R ├── utils.R └── component.R ├── DESCRIPTION ├── NAMESPACE ├── inst └── templates │ └── component.R ├── README.md └── LICENSE.md /.Rbuildignore: -------------------------------------------------------------------------------- 1 | ^LICENSE\.md$ 2 | ^makefile$ 3 | ^\.lintr$ 4 | -------------------------------------------------------------------------------- /makefile: -------------------------------------------------------------------------------- 1 | check: document 2 | Rscript -e "devtools::check()" 3 | 4 | document: 5 | Rscript -e "devtools::document()" 6 | 7 | install: document 8 | Rscript -e "devtools::install()" 9 | 10 | run: document 11 | Rscript test.R 12 | 13 | -------------------------------------------------------------------------------- /man/roclets.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/component.R 3 | \name{roclet_component} 4 | \alias{roclet_component} 5 | \title{Component} 6 | \usage{ 7 | roclet_component() 8 | } 9 | \description{ 10 | Generate Component 11 | } 12 | -------------------------------------------------------------------------------- /man/create.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/create.R 3 | \name{create} 4 | \alias{create} 5 | \title{Create} 6 | \usage{ 7 | create(name) 8 | } 9 | \arguments{ 10 | \item{name}{Name of component.} 11 | } 12 | \description{ 13 | Create component 14 | } 15 | -------------------------------------------------------------------------------- /man/minify_css.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/minify.R 3 | \name{minify_css} 4 | \alias{minify_css} 5 | \title{Minify CSS} 6 | \usage{ 7 | minify_css(css) 8 | } 9 | \arguments{ 10 | \item{css}{CSS string to minify.} 11 | } 12 | \description{ 13 | Minify CSS 14 | } 15 | -------------------------------------------------------------------------------- /man/minify_js.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/minify.R 3 | \name{minify_js} 4 | \alias{minify_js} 5 | \title{Minify JavaScript} 6 | \usage{ 7 | minify_js(js) 8 | } 9 | \arguments{ 10 | \item{js}{JavaScript string to minify.} 11 | } 12 | \description{ 13 | Minify JavaScript 14 | } 15 | -------------------------------------------------------------------------------- /man/dot-test_css.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/component-test.R 3 | \name{.test_css} 4 | \alias{.test_css} 5 | \title{test css} 6 | \usage{ 7 | .test_css(...) 8 | } 9 | \arguments{ 10 | \item{...}{Any other argument.} 11 | } 12 | \description{ 13 | test css component. 14 | } 15 | \keyword{internal} 16 | -------------------------------------------------------------------------------- /man/dot-test_javascript.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/component-test.R 3 | \name{.test_javascript} 4 | \alias{.test_javascript} 5 | \title{test javascript} 6 | \usage{ 7 | .test_javascript(...) 8 | } 9 | \arguments{ 10 | \item{...}{Any other argument.} 11 | } 12 | \description{ 13 | test javascript component. 14 | } 15 | \keyword{internal} 16 | -------------------------------------------------------------------------------- /man/dot-test_ui.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/component-test.R 3 | \name{.test_ui} 4 | \alias{.test_ui} 5 | \title{test ui} 6 | \usage{ 7 | .test_ui(ns, ...) 8 | } 9 | \arguments{ 10 | \item{ns}{Shiny's namespace function.} 11 | 12 | \item{...}{Any other argument.} 13 | } 14 | \description{ 15 | test UI component. 16 | } 17 | \keyword{internal} 18 | -------------------------------------------------------------------------------- /man/test_ui.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/component-generated-test.R 3 | \name{test_ui} 4 | \alias{test_ui} 5 | \title{Test generated UI} 6 | \usage{ 7 | test_ui(id, ...) 8 | } 9 | \arguments{ 10 | \item{id}{ID of module} 11 | 12 | \item{...}{Any arguments to pass to .test_ui()} 13 | } 14 | \description{ 15 | UI generated from: .test_ui() 16 | } 17 | \keyword{internal} 18 | -------------------------------------------------------------------------------- /man/test_server.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/component-generated-test.R 3 | \name{test_server} 4 | \alias{test_server} 5 | \title{Test generated server} 6 | \usage{ 7 | test_server(id, ...) 8 | } 9 | \arguments{ 10 | \item{id}{ID of module} 11 | 12 | \item{...}{Any arguments to pass to .test_server()} 13 | } 14 | \description{ 15 | Server generated from: .test_server() 16 | } 17 | \keyword{internal} 18 | -------------------------------------------------------------------------------- /man/remove_component.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/remove.R 3 | \name{remove_component} 4 | \alias{remove_component} 5 | \title{Remove component} 6 | \usage{ 7 | remove_component(name, check = interactive()) 8 | } 9 | \arguments{ 10 | \item{name}{Name of component to detele.} 11 | 12 | \item{check}{Whether to run an interactive check.} 13 | } 14 | \description{ 15 | Remove a component from the package. 16 | } 17 | -------------------------------------------------------------------------------- /man/dot-test_server.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/component-test.R 3 | \name{.test_server} 4 | \alias{.test_server} 5 | \title{test server} 6 | \usage{ 7 | .test_server(input, output, session, ...) 8 | } 9 | \arguments{ 10 | \item{input, output, session}{Arguments passed from mdoule's server.} 11 | 12 | \item{...}{Any other argument.} 13 | } 14 | \description{ 15 | test server component. 16 | } 17 | \keyword{internal} 18 | -------------------------------------------------------------------------------- /.lintr: -------------------------------------------------------------------------------- 1 | linters: linters_with_defaults( 2 | line_length_linter(120), 3 | trailing_whitespace_linter = NULL, 4 | commented_code_linter = NULL, 5 | function_left_parentheses_linter = NULL, 6 | function_return_linter = NULL, 7 | spaces_left_parentheses_linter = NULL, 8 | paren_body_linter = NULL, 9 | brace_linter = NULL, 10 | indentation_linter( 11 | indent = 2L, 12 | hanging_indent_style = "never" 13 | ), 14 | object_usage_linter = NULL # this uses eval() 15 | ) 16 | -------------------------------------------------------------------------------- /R/create.R: -------------------------------------------------------------------------------- 1 | #' Create 2 | #' 3 | #' Create component 4 | #' 5 | #' @param name Name of component. 6 | #' 7 | #' @export 8 | create <- \(name) { 9 | if(missing(name)) 10 | stop("missing `name`") 11 | 12 | name <- make_component_name(name) 13 | 14 | file <- pkg_file("templates/component.R") |> 15 | readLines() |> 16 | (\(.) gsub("COMPONENT", name, .))() 17 | 18 | con <- sprintf("R/component-%s.R", name) 19 | writeLines(file, con) 20 | 21 | cat(con, "created!\n") 22 | 23 | usethis::use_package("component") 24 | 25 | invisible(con) 26 | } 27 | -------------------------------------------------------------------------------- /DESCRIPTION: -------------------------------------------------------------------------------- 1 | Package: component 2 | Title: Components for 'Shiny' 3 | Version: 0.0.1.9000 4 | Authors@R: 5 | c( 6 | person(given = "John", 7 | family = "Coene", 8 | role = c("aut", "cre"), 9 | email = "jcoenep@gmail.com"), 10 | person(family = "Opifex", 11 | role = c("cph", "fnd"), 12 | email = "john@opifex.org") 13 | ) 14 | Description: 'Components' for 'Shiny', similar to 'Shiny' modules. 15 | License: GPL (>= 3) 16 | Encoding: UTF-8 17 | Roxygen: list(markdown = TRUE, roclets = c("collate", "namespace", "rd", "component::roclet_component")) 18 | RoxygenNote: 7.2.3 19 | Imports: 20 | glue, 21 | sass, 22 | roxygen2, 23 | styler 24 | Suggests: 25 | shiny, 26 | htmltools, 27 | jsonlite, 28 | usethis 29 | -------------------------------------------------------------------------------- /man/namespace.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/namespace.R 3 | \name{namespace} 4 | \alias{namespace} 5 | \title{Namespace} 6 | \usage{ 7 | namespace(strings, ns, env = parent.frame()) 8 | } 9 | \arguments{ 10 | \item{strings}{Vector of string to namespace.} 11 | 12 | \item{ns}{Namespace function.} 13 | 14 | \item{env}{Environment to evaluate \code{strings}.} 15 | } 16 | \description{ 17 | Namespace a string. 18 | } 19 | \section{Transformers}{ 20 | 21 | \itemize{ 22 | \item \code{class}: transforms \verb{\{\{ class red \}\}} into \code{.namespace-red} 23 | \item \code{id}: transforms \verb{\{\{ id red \}\}} into \verb{#namespace-red} 24 | \item \code{ns}: transforms \verb{\{\{ ns red \}\}} into \code{namespace-red} 25 | \item \code{json}: transforms \verb{\{\{ json letters[1:2] \}\}} into \verb{['a', 'b']} 26 | } 27 | } 28 | 29 | -------------------------------------------------------------------------------- /NAMESPACE: -------------------------------------------------------------------------------- 1 | # Generated by roxygen2: do not edit by hand 2 | 3 | S3method(format,rd_section_component) 4 | S3method(roclet_output,roclet_component) 5 | S3method(roclet_process,roclet_component) 6 | S3method(roxy_tag_parse,roxy_tag_component) 7 | S3method(roxy_tag_rd,roxy_tag_component) 8 | export(create) 9 | export(minify_css) 10 | export(minify_js) 11 | export(namespace) 12 | export(remove_component) 13 | export(roclet_component) 14 | importFrom(glue,glue) 15 | importFrom(glue,identity_transformer) 16 | importFrom(roxygen2,block_get_tags) 17 | importFrom(roxygen2,rd_section) 18 | importFrom(roxygen2,roclet) 19 | importFrom(roxygen2,roclet_output) 20 | importFrom(roxygen2,roclet_process) 21 | importFrom(roxygen2,roxy_tag_parse) 22 | importFrom(roxygen2,roxy_tag_rd) 23 | importFrom(roxygen2,roxy_tag_warning) 24 | importFrom(sass,sass) 25 | importFrom(sass,sass_options) 26 | importFrom(styler,style_file) 27 | -------------------------------------------------------------------------------- /R/component-generated-test.R: -------------------------------------------------------------------------------- 1 | #' Test generated UI 2 | #' 3 | #' UI generated from: .test_ui() 4 | #' 5 | #' @param id ID of module 6 | #' @param ... Any arguments to pass to .test_ui() 7 | #' 8 | #' @keywords internal 9 | test_ui <- \(id, ...){ 10 | ns <- shiny::NS(id) 11 | shiny::tagList( 12 | shiny::tags$head( 13 | shiny::tags$style(shiny::HTML(.test_css(...) |> component::namespace(ns, list(...)) |> component::minify_css())), 14 | shiny::tags$script(shiny::HTML(.test_javascript(...) |> (\(.) c("$(() => {", ., "})"))() |> component::namespace(ns, list(...)) |> component::minify_js())) 15 | ), 16 | .test_ui(ns, ...) 17 | ) 18 | } 19 | #' Test generated server 20 | #' 21 | #' Server generated from: .test_server() 22 | #' 23 | #' @param id ID of module 24 | #' @param ... Any arguments to pass to .test_server() 25 | #' 26 | #' @keywords internal 27 | test_server <- \(id, ...){ 28 | shiny::moduleServer(id, .test_server) 29 | } 30 | -------------------------------------------------------------------------------- /R/minify.R: -------------------------------------------------------------------------------- 1 | #' Minify CSS 2 | #' 3 | #' Minify CSS 4 | #' 5 | #' @param css CSS string to minify. 6 | #' 7 | #' @importFrom sass sass sass_options 8 | #' 9 | #' @export 10 | minify_css <- function(css){ 11 | sass(css, options = sass_options(output_style = "compressed")) 12 | } 13 | 14 | #' Minify JavaScript 15 | #' 16 | #' Minify JavaScript 17 | #' 18 | #' @param js JavaScript string to minify. 19 | #' 20 | #' @export 21 | minify_js <- function(js){ 22 | cmd <- Sys.which("uglifyjs") 23 | 24 | if(cmd == "") 25 | return(js) 26 | 27 | temp_in <- tempfile(fileext = ".js") 28 | temp_out <- tempfile(fileext = ".js") 29 | 30 | on.exit({ 31 | unlist(temp_in) 32 | unlist(temp_out) 33 | }) 34 | 35 | writeLines(js, con = temp_in) 36 | 37 | system2( 38 | cmd, 39 | paste0("--compress --mangle --output ", temp_out, " -- ", temp_in) 40 | ) 41 | 42 | temp_out |> 43 | readLines() |> 44 | suppressWarnings() 45 | } 46 | -------------------------------------------------------------------------------- /R/remove.R: -------------------------------------------------------------------------------- 1 | #' Remove component 2 | #' 3 | #' Remove a component from the package. 4 | #' 5 | #' @param name Name of component to detele. 6 | #' @param check Whether to run an interactive check. 7 | #' 8 | #' @export 9 | remove_component <- function(name, check = interactive()) { 10 | name <- make_component_name(name) 11 | 12 | comp <- sprintf("R/component-%s.R", name) 13 | comp_generated <- sprintf("R/component-generated-%s.R", name) 14 | 15 | if(check){ 16 | cat( 17 | "Are you sure you want to delete", 18 | comp, 19 | "and", 20 | comp_generated, 21 | "?" 22 | ) 23 | 24 | ans <- utils::menu(c("y", "n")) 25 | 26 | if(ans != 1L) { 27 | cat("Aborting\n") 28 | return(invisible(FALSE)) 29 | } 30 | } 31 | 32 | comp |> 33 | file.remove() |> 34 | suppressWarnings() 35 | 36 | comp_generated |> 37 | file.remove() |> 38 | suppressWarnings() 39 | 40 | cat( 41 | "Deleted", 42 | comp, 43 | "and", 44 | comp_generated, 45 | "\n" 46 | ) 47 | 48 | invisible(TRUE) 49 | } 50 | -------------------------------------------------------------------------------- /R/file.R: -------------------------------------------------------------------------------- 1 | pkg_file <- \(...){ 2 | system.file(..., package = "component") 3 | } 4 | 5 | file_exists <- function(...){ 6 | file.path(...) |> 7 | file.exists() 8 | } 9 | 10 | remove_file_if_exists <- function(...){ 11 | if(!file_exists(...)) 12 | return() 13 | 14 | file.remove(...) 15 | } 16 | 17 | get_package_name <- function(){ 18 | pkg <- readLines("DESCRIPTION")[1] 19 | gsub("Package: ", "", pkg) |> trimws() 20 | } 21 | 22 | #' @importFrom styler style_file 23 | make_write_lines <- \(file){ 24 | CON <- file(file, "a") # nolint 25 | 26 | list( 27 | w = \(...){ 28 | paste0(...) |> 29 | writeLines(con = CON) 30 | }, 31 | c = \(){ 32 | close(CON) 33 | 34 | if(!grepl("\\.R$", file)) 35 | return() 36 | 37 | style_file(file) 38 | } 39 | ) 40 | } 41 | 42 | make_file <- function(component, extension) { 43 | sprintf( 44 | "%s.%s", 45 | component, 46 | extension 47 | ) 48 | } 49 | 50 | make_output_file <- function(component, extension, dir) { 51 | sprintf( 52 | "%s/%s", 53 | dir, 54 | make_file( 55 | component, 56 | extension 57 | ) 58 | ) 59 | } 60 | -------------------------------------------------------------------------------- /R/component-test.R: -------------------------------------------------------------------------------- 1 | #' @component test 2 | NULL 3 | 4 | #' test javascript 5 | #' 6 | #' test javascript component. 7 | #' 8 | #' @param ... Any other argument. 9 | #' 10 | #' @keywords internal 11 | .test_javascript <- \(...) { 12 | "$('{{class red}}').on('mouseenter', (e) => { 13 | $(e.target).toggleClass('{{ns red}}') 14 | })" 15 | } 16 | 17 | #' test css 18 | #' 19 | #' test css component. 20 | #' 21 | #' @param ... Any other argument. 22 | #' 23 | #' @keywords internal 24 | .test_css <- \(...) { 25 | c( 26 | "{{class red}}{color:red;}", 27 | "h1{font-weight: bold;}" 28 | ) 29 | } 30 | 31 | #' test ui 32 | #' 33 | #' test UI component. 34 | #' 35 | #' @param ns Shiny's namespace function. 36 | #' @param ... Any other argument. 37 | #' 38 | #' @keywords internal 39 | .test_ui <- \(ns, ...) { 40 | shiny::div( 41 | shiny::h1("Component", class = ns("red")), 42 | shiny::plotOutput(ns("plot")) 43 | ) 44 | } 45 | 46 | #' test server 47 | #' 48 | #' test server component. 49 | #' 50 | #' @param input,output,session Arguments passed from mdoule's server. 51 | #' @param ... Any other argument. 52 | #' 53 | #' @keywords internal 54 | .test_server <- \(input, output, session, ...) { 55 | output$plot <- shiny::renderPlot(plot(stats::runif(200))) 56 | } 57 | -------------------------------------------------------------------------------- /inst/templates/component.R: -------------------------------------------------------------------------------- 1 | #' @component COMPONENT 2 | NULL 3 | 4 | #' COMPONENT javascript 5 | #' 6 | #' COMPONENT javascript component. 7 | #' 8 | #' @param ... Any other argument. 9 | #' 10 | #' @keywords internal 11 | .COMPONENT_javascript <- \(...) { 12 | "$('{{class red}}').on('mouseenter', (e) => { 13 | $(e.target).toggleClass('{{ns red}}') 14 | })" 15 | } 16 | 17 | #' COMPONENT css 18 | #' 19 | #' COMPONENT css component. 20 | #' 21 | #' @param ... Any other argument. 22 | #' 23 | #' @keywords internal 24 | .COMPONENT_css <- \(...) { 25 | c( 26 | "{{class red}}{color:red;}", 27 | "h1{font-weight: bold;}" 28 | ) 29 | } 30 | 31 | #' COMPONENT ui 32 | #' 33 | #' COMPONENT UI component. 34 | #' 35 | #' @param ns Shiny's namespace function. 36 | #' @param ... Any other argument. 37 | #' 38 | #' @keywords internal 39 | .COMPONENT_ui <- \(ns, ...) { 40 | shiny::div( 41 | shiny::h1("Component", class = ns("red")), 42 | shiny::plotOutput(ns("plot")) 43 | ) 44 | } 45 | 46 | #' COMPONENT server 47 | #' 48 | #' COMPONENT server component. 49 | #' 50 | #' @param input,output,session Arguments passed from mdoule's server. 51 | #' @param ... Any other argument. 52 | #' 53 | #' @keywords internal 54 | .COMPONENT_server <- \(input, output, session, ...) { 55 | output$plot <- shiny::renderPlot(plot(stats::runif(200))) 56 | } 57 | -------------------------------------------------------------------------------- /R/namespace.R: -------------------------------------------------------------------------------- 1 | #' Namespace 2 | #' 3 | #' Namespace a string. 4 | #' 5 | #' @param strings Vector of string to namespace. 6 | #' @param ns Namespace function. 7 | #' @param env Environment to evaluate `strings`. 8 | #' 9 | #' @section Transformers: 10 | #' 11 | #' * `class`: transforms `{{ class red }}` into `.namespace-red` 12 | #' * `id`: transforms `{{ id red }}` into `#namespace-red` 13 | #' * `ns`: transforms `{{ ns red }}` into `namespace-red` 14 | #' * `json`: transforms `{{ json letters[1:2] }}` into `['a', 'b']` 15 | #' 16 | #' @importFrom glue identity_transformer glue 17 | #' 18 | #' @export 19 | namespace <- function(strings, ns, env = parent.frame()) { 20 | if(missing(strings)) 21 | stop("missing `strings`") 22 | 23 | if(missing(ns)) 24 | stop("missing `ns`") 25 | 26 | if(!is.function(ns)) 27 | stop("`ns` must be a function") 28 | 29 | strings |> 30 | sapply(\(string) { 31 | glue( 32 | string, 33 | .open = "{{", 34 | .close = "}}", 35 | .transformer = namespace_transformer(ns), 36 | .envir = env 37 | ) 38 | }) |> 39 | (\(.) paste0(., collapse = "\n"))() 40 | } 41 | 42 | namespace_transformer <- function(ns, ...) { 43 | function(text, envir) { 44 | text <- trimws(text) 45 | 46 | text <- strsplit(text, " ")[[1]] 47 | 48 | if(length(text) == 1L) 49 | return(text[1] |> identity_transformer(envir)) 50 | 51 | arg <- ns(paste0(text[2:length(text)], collapse = " ")) 52 | 53 | prefix <- "" 54 | if(text[1] == "class") 55 | prefix <- "." 56 | 57 | if(text[1] == "id") 58 | prefix <- "#" 59 | 60 | if(text[1] == "json") 61 | arg <- text[2] |> 62 | identity_transformer(envir) |> 63 | jsonlite::toJSON(auto_unbox = TRUE) |> 64 | as.character() 65 | 66 | paste0(prefix, arg, collapse = " ") 67 | } 68 | } 69 | -------------------------------------------------------------------------------- /R/utils.R: -------------------------------------------------------------------------------- 1 | make_component_fn <- function(name, what) { 2 | paste0(".", name, "_", what) 3 | } 4 | 5 | make_ui <- function(params) { 6 | wl <- make_write_lines(params$path_r) 7 | on.exit(wl$c()) 8 | 9 | wl$w("#' ", tools::toTitleCase(params$component), " generated UI") 10 | wl$w("#' ") 11 | wl$w("#' UI generated from: .", params$component, "_ui()") 12 | wl$w("#' ") 13 | wl$w("#' @param id ID of module") 14 | wl$w("#' @param ... Any arguments to pass to .", params$component, "_ui()") 15 | wl$w("#' ") 16 | wl$w("#' @keywords internal") 17 | wl$w(params$component, "_ui <- \\(id, ...){") 18 | wl$w("\tns <- shiny::NS(id)") 19 | wl$w("\tshiny::tagList(") 20 | wl$w("\t\tshiny::tags$head(") 21 | wl$w("\t\t\tshiny::tags$style(shiny::HTML(.", params$component, "_css(...) |> component::namespace(ns, list(...)) |> component::minify_css())),") 22 | wl$w("\t\t\tshiny::tags$script(shiny::HTML(.", params$component, "_javascript(...) |> (\\(.) c(\"$(() => {\", ., \"})\"))() |> component::namespace(ns, list(...)) |> component::minify_js()))") 23 | wl$w("\t\t),") 24 | wl$w("\t\t.", params$component, "_ui(ns, ...)") 25 | wl$w("\t)") 26 | wl$w("}") 27 | wl$w("") 28 | } 29 | 30 | make_server <- function(params) { 31 | wl <- make_write_lines(params$path_r) 32 | on.exit(wl$c()) 33 | 34 | wl$w("#' ", tools::toTitleCase(params$component), " generated server") 35 | wl$w("#' ") 36 | wl$w("#' Server generated from: .", params$component, "_server()") 37 | wl$w("#' ") 38 | wl$w("#' @param id ID of module") 39 | wl$w("#' @param ... Any arguments to pass to .", params$component, "_server()") 40 | wl$w("#' ") 41 | wl$w("#' @keywords internal") 42 | wl$w(params$component, "_server <- \\(id, ...){") 43 | wl$w("\tshiny::moduleServer(id, .", params$component, "_server)") 44 | wl$w("}") 45 | wl$w("") 46 | } 47 | 48 | make_component_name <- function(name) { 49 | gsub("\\.R$", "", name) |> 50 | (\(.) gsub(" ", "", .))() |> 51 | trimws() 52 | } 53 | -------------------------------------------------------------------------------- /R/component.R: -------------------------------------------------------------------------------- 1 | #' Component 2 | #' 3 | #' Generate Component 4 | #' 5 | #' @importFrom roxygen2 roclet roxy_tag_warning block_get_tags roclet_output 6 | #' @importFrom roxygen2 roclet_process roxy_tag_parse rd_section roxy_tag_rd 7 | #' 8 | #' @rdname roclets 9 | #' @export 10 | roclet_component <- function() { 11 | roclet("component") 12 | } 13 | 14 | #' @export 15 | roclet_process.roclet_component <- function(x, blocks, env, base_path, ...) { 16 | results <- list() 17 | 18 | for (block in blocks) { 19 | tags <- block_get_tags(block, "component") 20 | 21 | for (tag in tags) { 22 | res <- tag$val 23 | res$fn_js <- env[[make_component_fn(res$component, "javascript")]] 24 | res$fn_css <- env[[make_component_fn(res$component, "css")]] 25 | 26 | res$file_js <- make_file(res$component, "js") 27 | res$file_css <- make_file(res$component, "css") 28 | res$file_r <- make_file(res$component, "R") 29 | 30 | res$path_js <- make_output_file(res$component, "js", dir = sprintf("inst/%s", res$component)) 31 | res$path_css <- make_output_file(res$component, "css", dir = sprintf("inst/%s", res$component)) 32 | res$path_r <- make_output_file(paste0("component-generated-", res$component), "R", dir = "R") 33 | 34 | results <- append( 35 | results, 36 | list(res) 37 | ) 38 | } 39 | } 40 | 41 | results 42 | } 43 | 44 | #' @export 45 | roclet_output.roclet_component <- function(x, results, base_path, ...) { 46 | roxygen2::load_pkgload(base_path) 47 | 48 | for (component in results) { 49 | remove_file_if_exists(component$path_r) 50 | 51 | make_ui(component) 52 | make_server(component) 53 | } 54 | 55 | invisible(NULL) 56 | } 57 | 58 | #' @export 59 | roxy_tag_parse.roxy_tag_component <- function(x) { 60 | component <- x$raw |> trimws() 61 | 62 | x$val <- list( 63 | file = x$file, 64 | component = component 65 | ) 66 | 67 | return(x) 68 | } 69 | 70 | #' @export 71 | roxy_tag_rd.roxy_tag_component <- function(x, base_path, env) { 72 | rd_section("component", x$val) 73 | } 74 | 75 | #' @export 76 | format.rd_section_component <- function(x, ...) { 77 | paste0( 78 | "\\section{Component}{\n", 79 | "Generated Component\n", 80 | "}\n" 81 | ) 82 | } 83 | 84 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |
2 | 3 | 4 | 5 | 6 | # component 7 | 8 | Creating components for [shiny](https://shiny.rstudio.com) inspired by [Vue](https://vuejs.org/) 9 | 10 |
11 | 12 | It tackles three "issues" with Shiny modules: 13 | 14 | 1. Generating scoped (namespaced) CSS and JavaScript code. 15 | 2. Places all the code for a module in a single file. 16 | 3. Binds CSS, and JavaScript of a module to it 17 | 18 | This is inspired from Vue where one defines a component in a single file. 19 | 20 | ```vue 21 | 25 | 26 | 29 | 30 | 35 | ``` 36 | 37 | Where the file includes the style, script, and template. 38 | We reproduce the same with R with the addition of the server component. 39 | 40 | ## Installation 41 | 42 | You can install the development version of component from [GitHub](https://github.com/) with: 43 | 44 | ``` r 45 | # install.packages("remotes") 46 | remotes::install_github("devOpifex/component") 47 | ``` 48 | 49 | ## Create 50 | 51 | From a package (see [lerprechaun](https://leprechaun.opifex.org) or 52 | [golem](https://thinkr-open.github.io/golem/)), create a component. 53 | 54 | ``` r 55 | # create a component 56 | # give it a name 57 | component::create("test") 58 | ``` 59 | 60 | This creates a new file in `R/` named `component-test.R`. 61 | 62 | Components generate code via `devtools::document()` (more on that later) 63 | add the roxygen2 roclet to your `DESCRIPTION`, e.g.: 64 | 65 | ``` 66 | Roxygen: list(markdown = TRUE, roclets = c("collate", "namespace", "rd", "component::roclet_component")) 67 | ``` 68 | 69 | So `create()` creates the component file but `devtools::document()` generates 70 | the usable version of the component. 71 | 72 | ```r 73 | component::create() => `component-.R` => devtools::document() => `component-generated-.R` 74 | ``` 75 | 76 | ## Component Anatomy 77 | 78 | The default component as created by `component::create()` looks something like the code below 79 | (`R/component-test.R`). 80 | 81 | ```r 82 | #' @component test 83 | NULL 84 | 85 | #' test javascript 86 | #' 87 | #' test javascript component. 88 | #' 89 | #' @param ... Any other argument. 90 | #' 91 | #' @keywords internal 92 | .test_javascript <- \(...) { 93 | "$('{{class red}}').on('mouseenter', (e) => { 94 | $(e.target).toggleClass('{{ns red}}'); 95 | })" 96 | } 97 | 98 | #' test css 99 | #' 100 | #' test css component. 101 | #' 102 | #' @param ... Any other argument. 103 | #' 104 | #' @keywords internal 105 | .test_css <- \(...) { 106 | c( 107 | "{{class red}}{color:red;}", 108 | "h1{font-weight: bold;}" 109 | ) 110 | } 111 | 112 | #' test ui 113 | #' 114 | #' test UI component. 115 | #' 116 | #' @param ns Shiny's namespace function. 117 | #' @param ... Any other argument. 118 | #' 119 | #' @keywords internal 120 | .test_ui <- \(ns, ...) { 121 | shiny::div( 122 | shiny::h1("Component", class = ns("red")), 123 | plotOutput(ns("plot")) 124 | ) 125 | } 126 | 127 | #' test server 128 | #' 129 | #' test server component. 130 | #' 131 | #' @param input,output,session Arguments passed from mdoule's server. 132 | #' @param ... Any other argument. 133 | #' 134 | #' @keywords internal 135 | .test_server <- \(input, output, session, ...) { 136 | output$plot <- shiny::renderPlot(plot(stats::runif(200))) 137 | } 138 | ``` 139 | 140 | ### Component tag 141 | 142 | The `@component` tag indicates the name of the component, 143 | in this example `test`. 144 | This tells component which functions to scan for: 145 | 146 | - `._javascript` 147 | - `._css` 148 | - `._server` 149 | - `._ui` 150 | 151 | ### JavaScript and CSS 152 | 153 | The `.test_javascript` and `.test_css` functions are used to generate 154 | scoped code. 155 | 156 | - `class`: transforms `{{ class red }}` into `.namespace-red` 157 | - `id`: transforms `{{ id red }}` into `#namespace-red` 158 | - `ns`: transforms `{{ ns red }}` into `namespace-red` 159 | - `json`: transforms `{{ json letters[1:2] }}` into `['a', 'b']` 160 | - You may still use `{{ x }}` in which case it will evaluate `x` 161 | (passed `*ui` or `*server` function). 162 | 163 | These functions should return a character vector of length one or more. 164 | 165 | The CSS is minified using [sass](https://github.com/rstudio/sass/), if you have 166 | [uglifyjs](https://www.npmjs.com/package/uglify-js) installed 167 | it is used to minify the JavaScript otherwise it is not 168 | (install it with `npm install uglify-js -g`). 169 | 170 | ### UI and Server 171 | 172 | Almost identical to the UI and server functions of a shiny module 173 | 174 | ### How to use 175 | 176 | The created template __cannot__ be used as-is, by documenting the code with 177 | `devtools::document()` we create a new file (`R/component-generated-.R`) 178 | which contains: 179 | 180 | - `_ui` 181 | - `_server` 182 | 183 | In this example, `test_ui`, and `server_ui`. 184 | 185 | These are the functions that one should use in the application. 186 | Always work on/edit the functions starting with a dot (e.g.: `.test_ui`), 187 | as the generated files get regenerated at every `devtools::document()` call. 188 | 189 | Example based on the abose "test" component, after running `devtools::document()`. 190 | 191 | ```r 192 | library(shiny) 193 | 194 | ui <- fluidPage( 195 | title = "Test", 196 | test_ui("test") 197 | ) 198 | 199 | server <- function(...){ 200 | test_server("test") 201 | } 202 | 203 | shinyApp(ui, server) 204 | ``` 205 | 206 | ## Example 207 | 208 | Here is the classic counter example but scoped and using JavaScript only. 209 | 210 | ```r 211 | #' @component counter 212 | NULL 213 | 214 | #' counter javascript 215 | #' 216 | #' counter javascript component. 217 | #' 218 | #' @param ... Any other argument. 219 | #' 220 | #' @keywords internal 221 | .counter_javascript <- \(...) { 222 | "$(() => { 223 | let index = 0; 224 | $('{{id button}}').on('click', (e) => { 225 | index++; 226 | $('{{id output}}').html(index); 227 | $('{{id output}}').toggleClass('{{ns criminal}}'); 228 | }) 229 | })" 230 | } 231 | 232 | #' counter css 233 | #' 234 | #' counter css component. 235 | #' 236 | #' @param ... Any other argument. 237 | #' 238 | #' @keywords internal 239 | .counter_css <- \(...) { 240 | "{{class criminal}}{ 241 | color: {{color}}; 242 | font-weight: bold; 243 | }" 244 | } 245 | 246 | #' counter ui 247 | #' 248 | #' counter UI component. 249 | #' 250 | #' @param ns Shiny's namespace function. 251 | #' @param ... Any other argument. 252 | #' 253 | #' @keywords internal 254 | .counter_ui <- \(ns, ...) { 255 | shiny::div( 256 | shiny::h1("Counter"), 257 | shiny::tags$button( 258 | class = "btn btn-sm btn-primary", 259 | id = ns("button"), 260 | "Counter" 261 | ), 262 | shiny::p( 263 | id = ns("output"), 264 | 0L 265 | ) 266 | ) 267 | } 268 | 269 | #' counter server 270 | #' 271 | #' counter server component. 272 | #' 273 | #' @param input,output,session Arguments passed from mdoule's server. 274 | #' @param ... Any other argument. 275 | #' 276 | #' @keywords internal 277 | .counter_server <- \(input, output, session, ...) {} 278 | ``` 279 | 280 | Then, after documenting, it can be used as. 281 | 282 | ```r 283 | library(shiny) 284 | 285 | ui <- fluidPage( 286 | title = "Test", 287 | counter_ui("c1", color = "red"), 288 | counter_ui("c2", color = "blue"), 289 | ) 290 | 291 | server <- function(...){ 292 | counter_server("c1") 293 | counter_server("c2") 294 | } 295 | 296 | shinyApp(ui, server) 297 | ``` 298 | 299 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | GNU General Public License 2 | ========================== 3 | 4 | _Version 3, 29 June 2007_ 5 | _Copyright © 2007 Free Software Foundation, Inc. <>_ 6 | 7 | Everyone is permitted to copy and distribute verbatim copies of this license 8 | document, but changing it is not allowed. 9 | 10 | ## Preamble 11 | 12 | The GNU General Public License is a free, copyleft license for software and other 13 | kinds of works. 14 | 15 | The licenses for most software and other practical works are designed to take away 16 | your freedom to share and change the works. By contrast, the GNU General Public 17 | License is intended to guarantee your freedom to share and change all versions of a 18 | program--to make sure it remains free software for all its users. We, the Free 19 | Software Foundation, use the GNU General Public License for most of our software; it 20 | applies also to any other work released this way by its authors. You can apply it to 21 | your programs, too. 22 | 23 | When we speak of free software, we are referring to freedom, not price. Our General 24 | Public Licenses are designed to make sure that you have the freedom to distribute 25 | copies of free software (and charge for them if you wish), that you receive source 26 | code or can get it if you want it, that you can change the software or use pieces of 27 | it in new free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you these rights or 30 | asking you to surrender the rights. Therefore, you have certain responsibilities if 31 | you distribute copies of the software, or if you modify it: responsibilities to 32 | respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether gratis or for a fee, 35 | you must pass on to the recipients the same freedoms that you received. You must make 36 | sure that they, too, receive or can get the source code. And you must show them these 37 | terms so they know their rights. 38 | 39 | Developers that use the GNU GPL protect your rights with two steps: **(1)** assert 40 | copyright on the software, and **(2)** offer you this License giving you legal permission 41 | to copy, distribute and/or modify it. 42 | 43 | For the developers' and authors' protection, the GPL clearly explains that there is 44 | no warranty for this free software. For both users' and authors' sake, the GPL 45 | requires that modified versions be marked as changed, so that their problems will not 46 | be attributed erroneously to authors of previous versions. 47 | 48 | Some devices are designed to deny users access to install or run modified versions of 49 | the software inside them, although the manufacturer can do so. This is fundamentally 50 | incompatible with the aim of protecting users' freedom to change the software. The 51 | systematic pattern of such abuse occurs in the area of products for individuals to 52 | use, which is precisely where it is most unacceptable. Therefore, we have designed 53 | this version of the GPL to prohibit the practice for those products. If such problems 54 | arise substantially in other domains, we stand ready to extend this provision to 55 | those domains in future versions of the GPL, as needed to protect the freedom of 56 | users. 57 | 58 | Finally, every program is threatened constantly by software patents. States should 59 | not allow patents to restrict development and use of software on general-purpose 60 | computers, but in those that do, we wish to avoid the special danger that patents 61 | applied to a free program could make it effectively proprietary. To prevent this, the 62 | GPL assures that patents cannot be used to render the program non-free. 63 | 64 | The precise terms and conditions for copying, distribution and modification follow. 65 | 66 | ## TERMS AND CONDITIONS 67 | 68 | ### 0. Definitions 69 | 70 | “This License” refers to version 3 of the GNU General Public License. 71 | 72 | “Copyright” also means copyright-like laws that apply to other kinds of 73 | works, such as semiconductor masks. 74 | 75 | “The Program” refers to any copyrightable work licensed under this 76 | License. Each licensee is addressed as “you”. “Licensees” and 77 | “recipients” may be individuals or organizations. 78 | 79 | To “modify” a work means to copy from or adapt all or part of the work in 80 | a fashion requiring copyright permission, other than the making of an exact copy. The 81 | resulting work is called a “modified version” of the earlier work or a 82 | work “based on” the earlier work. 83 | 84 | A “covered work” means either the unmodified Program or a work based on 85 | the Program. 86 | 87 | To “propagate” a work means to do anything with it that, without 88 | permission, would make you directly or secondarily liable for infringement under 89 | applicable copyright law, except executing it on a computer or modifying a private 90 | copy. Propagation includes copying, distribution (with or without modification), 91 | making available to the public, and in some countries other activities as well. 92 | 93 | To “convey” a work means any kind of propagation that enables other 94 | parties to make or receive copies. Mere interaction with a user through a computer 95 | network, with no transfer of a copy, is not conveying. 96 | 97 | An interactive user interface displays “Appropriate Legal Notices” to the 98 | extent that it includes a convenient and prominently visible feature that **(1)** 99 | displays an appropriate copyright notice, and **(2)** tells the user that there is no 100 | warranty for the work (except to the extent that warranties are provided), that 101 | licensees may convey the work under this License, and how to view a copy of this 102 | License. If the interface presents a list of user commands or options, such as a 103 | menu, a prominent item in the list meets this criterion. 104 | 105 | ### 1. Source Code 106 | 107 | The “source code” for a work means the preferred form of the work for 108 | making modifications to it. “Object code” means any non-source form of a 109 | work. 110 | 111 | A “Standard Interface” means an interface that either is an official 112 | standard defined by a recognized standards body, or, in the case of interfaces 113 | specified for a particular programming language, one that is widely used among 114 | developers working in that language. 115 | 116 | The “System Libraries” of an executable work include anything, other than 117 | the work as a whole, that **(a)** is included in the normal form of packaging a Major 118 | Component, but which is not part of that Major Component, and **(b)** serves only to 119 | enable use of the work with that Major Component, or to implement a Standard 120 | Interface for which an implementation is available to the public in source code form. 121 | A “Major Component”, in this context, means a major essential component 122 | (kernel, window system, and so on) of the specific operating system (if any) on which 123 | the executable work runs, or a compiler used to produce the work, or an object code 124 | interpreter used to run it. 125 | 126 | The “Corresponding Source” for a work in object code form means all the 127 | source code needed to generate, install, and (for an executable work) run the object 128 | code and to modify the work, including scripts to control those activities. However, 129 | it does not include the work's System Libraries, or general-purpose tools or 130 | generally available free programs which are used unmodified in performing those 131 | activities but which are not part of the work. For example, Corresponding Source 132 | includes interface definition files associated with source files for the work, and 133 | the source code for shared libraries and dynamically linked subprograms that the work 134 | is specifically designed to require, such as by intimate data communication or 135 | control flow between those subprograms and other parts of the work. 136 | 137 | The Corresponding Source need not include anything that users can regenerate 138 | automatically from other parts of the Corresponding Source. 139 | 140 | The Corresponding Source for a work in source code form is that same work. 141 | 142 | ### 2. Basic Permissions 143 | 144 | All rights granted under this License are granted for the term of copyright on the 145 | Program, and are irrevocable provided the stated conditions are met. This License 146 | explicitly affirms your unlimited permission to run the unmodified Program. The 147 | output from running a covered work is covered by this License only if the output, 148 | given its content, constitutes a covered work. This License acknowledges your rights 149 | of fair use or other equivalent, as provided by copyright law. 150 | 151 | You may make, run and propagate covered works that you do not convey, without 152 | conditions so long as your license otherwise remains in force. You may convey covered 153 | works to others for the sole purpose of having them make modifications exclusively 154 | for you, or provide you with facilities for running those works, provided that you 155 | comply with the terms of this License in conveying all material for which you do not 156 | control copyright. Those thus making or running the covered works for you must do so 157 | exclusively on your behalf, under your direction and control, on terms that prohibit 158 | them from making any copies of your copyrighted material outside their relationship 159 | with you. 160 | 161 | Conveying under any other circumstances is permitted solely under the conditions 162 | stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 163 | 164 | ### 3. Protecting Users' Legal Rights From Anti-Circumvention Law 165 | 166 | No covered work shall be deemed part of an effective technological measure under any 167 | applicable law fulfilling obligations under article 11 of the WIPO copyright treaty 168 | adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention 169 | of such measures. 170 | 171 | When you convey a covered work, you waive any legal power to forbid circumvention of 172 | technological measures to the extent such circumvention is effected by exercising 173 | rights under this License with respect to the covered work, and you disclaim any 174 | intention to limit operation or modification of the work as a means of enforcing, 175 | against the work's users, your or third parties' legal rights to forbid circumvention 176 | of technological measures. 177 | 178 | ### 4. Conveying Verbatim Copies 179 | 180 | You may convey verbatim copies of the Program's source code as you receive it, in any 181 | medium, provided that you conspicuously and appropriately publish on each copy an 182 | appropriate copyright notice; keep intact all notices stating that this License and 183 | any non-permissive terms added in accord with section 7 apply to the code; keep 184 | intact all notices of the absence of any warranty; and give all recipients a copy of 185 | this License along with the Program. 186 | 187 | You may charge any price or no price for each copy that you convey, and you may offer 188 | support or warranty protection for a fee. 189 | 190 | ### 5. Conveying Modified Source Versions 191 | 192 | You may convey a work based on the Program, or the modifications to produce it from 193 | the Program, in the form of source code under the terms of section 4, provided that 194 | you also meet all of these conditions: 195 | 196 | * **a)** The work must carry prominent notices stating that you modified it, and giving a 197 | relevant date. 198 | * **b)** The work must carry prominent notices stating that it is released under this 199 | License and any conditions added under section 7. This requirement modifies the 200 | requirement in section 4 to “keep intact all notices”. 201 | * **c)** You must license the entire work, as a whole, under this License to anyone who 202 | comes into possession of a copy. This License will therefore apply, along with any 203 | applicable section 7 additional terms, to the whole of the work, and all its parts, 204 | regardless of how they are packaged. This License gives no permission to license the 205 | work in any other way, but it does not invalidate such permission if you have 206 | separately received it. 207 | * **d)** If the work has interactive user interfaces, each must display Appropriate Legal 208 | Notices; however, if the Program has interactive interfaces that do not display 209 | Appropriate Legal Notices, your work need not make them do so. 210 | 211 | A compilation of a covered work with other separate and independent works, which are 212 | not by their nature extensions of the covered work, and which are not combined with 213 | it such as to form a larger program, in or on a volume of a storage or distribution 214 | medium, is called an “aggregate” if the compilation and its resulting 215 | copyright are not used to limit the access or legal rights of the compilation's users 216 | beyond what the individual works permit. Inclusion of a covered work in an aggregate 217 | does not cause this License to apply to the other parts of the aggregate. 218 | 219 | ### 6. Conveying Non-Source Forms 220 | 221 | You may convey a covered work in object code form under the terms of sections 4 and 222 | 5, provided that you also convey the machine-readable Corresponding Source under the 223 | terms of this License, in one of these ways: 224 | 225 | * **a)** Convey the object code in, or embodied in, a physical product (including a 226 | physical distribution medium), accompanied by the Corresponding Source fixed on a 227 | durable physical medium customarily used for software interchange. 228 | * **b)** Convey the object code in, or embodied in, a physical product (including a 229 | physical distribution medium), accompanied by a written offer, valid for at least 230 | three years and valid for as long as you offer spare parts or customer support for 231 | that product model, to give anyone who possesses the object code either **(1)** a copy of 232 | the Corresponding Source for all the software in the product that is covered by this 233 | License, on a durable physical medium customarily used for software interchange, for 234 | a price no more than your reasonable cost of physically performing this conveying of 235 | source, or **(2)** access to copy the Corresponding Source from a network server at no 236 | charge. 237 | * **c)** Convey individual copies of the object code with a copy of the written offer to 238 | provide the Corresponding Source. This alternative is allowed only occasionally and 239 | noncommercially, and only if you received the object code with such an offer, in 240 | accord with subsection 6b. 241 | * **d)** Convey the object code by offering access from a designated place (gratis or for 242 | a charge), and offer equivalent access to the Corresponding Source in the same way 243 | through the same place at no further charge. You need not require recipients to copy 244 | the Corresponding Source along with the object code. If the place to copy the object 245 | code is a network server, the Corresponding Source may be on a different server 246 | (operated by you or a third party) that supports equivalent copying facilities, 247 | provided you maintain clear directions next to the object code saying where to find 248 | the Corresponding Source. Regardless of what server hosts the Corresponding Source, 249 | you remain obligated to ensure that it is available for as long as needed to satisfy 250 | these requirements. 251 | * **e)** Convey the object code using peer-to-peer transmission, provided you inform 252 | other peers where the object code and Corresponding Source of the work are being 253 | offered to the general public at no charge under subsection 6d. 254 | 255 | A separable portion of the object code, whose source code is excluded from the 256 | Corresponding Source as a System Library, need not be included in conveying the 257 | object code work. 258 | 259 | A “User Product” is either **(1)** a “consumer product”, which 260 | means any tangible personal property which is normally used for personal, family, or 261 | household purposes, or **(2)** anything designed or sold for incorporation into a 262 | dwelling. In determining whether a product is a consumer product, doubtful cases 263 | shall be resolved in favor of coverage. For a particular product received by a 264 | particular user, “normally used” refers to a typical or common use of 265 | that class of product, regardless of the status of the particular user or of the way 266 | in which the particular user actually uses, or expects or is expected to use, the 267 | product. A product is a consumer product regardless of whether the product has 268 | substantial commercial, industrial or non-consumer uses, unless such uses represent 269 | the only significant mode of use of the product. 270 | 271 | “Installation Information” for a User Product means any methods, 272 | procedures, authorization keys, or other information required to install and execute 273 | modified versions of a covered work in that User Product from a modified version of 274 | its Corresponding Source. The information must suffice to ensure that the continued 275 | functioning of the modified object code is in no case prevented or interfered with 276 | solely because modification has been made. 277 | 278 | If you convey an object code work under this section in, or with, or specifically for 279 | use in, a User Product, and the conveying occurs as part of a transaction in which 280 | the right of possession and use of the User Product is transferred to the recipient 281 | in perpetuity or for a fixed term (regardless of how the transaction is 282 | characterized), the Corresponding Source conveyed under this section must be 283 | accompanied by the Installation Information. But this requirement does not apply if 284 | neither you nor any third party retains the ability to install modified object code 285 | on the User Product (for example, the work has been installed in ROM). 286 | 287 | The requirement to provide Installation Information does not include a requirement to 288 | continue to provide support service, warranty, or updates for a work that has been 289 | modified or installed by the recipient, or for the User Product in which it has been 290 | modified or installed. Access to a network may be denied when the modification itself 291 | materially and adversely affects the operation of the network or violates the rules 292 | and protocols for communication across the network. 293 | 294 | Corresponding Source conveyed, and Installation Information provided, in accord with 295 | this section must be in a format that is publicly documented (and with an 296 | implementation available to the public in source code form), and must require no 297 | special password or key for unpacking, reading or copying. 298 | 299 | ### 7. Additional Terms 300 | 301 | “Additional permissions” are terms that supplement the terms of this 302 | License by making exceptions from one or more of its conditions. Additional 303 | permissions that are applicable to the entire Program shall be treated as though they 304 | were included in this License, to the extent that they are valid under applicable 305 | law. If additional permissions apply only to part of the Program, that part may be 306 | used separately under those permissions, but the entire Program remains governed by 307 | this License without regard to the additional permissions. 308 | 309 | When you convey a copy of a covered work, you may at your option remove any 310 | additional permissions from that copy, or from any part of it. (Additional 311 | permissions may be written to require their own removal in certain cases when you 312 | modify the work.) You may place additional permissions on material, added by you to a 313 | covered work, for which you have or can give appropriate copyright permission. 314 | 315 | Notwithstanding any other provision of this License, for material you add to a 316 | covered work, you may (if authorized by the copyright holders of that material) 317 | supplement the terms of this License with terms: 318 | 319 | * **a)** Disclaiming warranty or limiting liability differently from the terms of 320 | sections 15 and 16 of this License; or 321 | * **b)** Requiring preservation of specified reasonable legal notices or author 322 | attributions in that material or in the Appropriate Legal Notices displayed by works 323 | containing it; or 324 | * **c)** Prohibiting misrepresentation of the origin of that material, or requiring that 325 | modified versions of such material be marked in reasonable ways as different from the 326 | original version; or 327 | * **d)** Limiting the use for publicity purposes of names of licensors or authors of the 328 | material; or 329 | * **e)** Declining to grant rights under trademark law for use of some trade names, 330 | trademarks, or service marks; or 331 | * **f)** Requiring indemnification of licensors and authors of that material by anyone 332 | who conveys the material (or modified versions of it) with contractual assumptions of 333 | liability to the recipient, for any liability that these contractual assumptions 334 | directly impose on those licensors and authors. 335 | 336 | All other non-permissive additional terms are considered “further 337 | restrictions” within the meaning of section 10. If the Program as you received 338 | it, or any part of it, contains a notice stating that it is governed by this License 339 | along with a term that is a further restriction, you may remove that term. If a 340 | license document contains a further restriction but permits relicensing or conveying 341 | under this License, you may add to a covered work material governed by the terms of 342 | that license document, provided that the further restriction does not survive such 343 | relicensing or conveying. 344 | 345 | If you add terms to a covered work in accord with this section, you must place, in 346 | the relevant source files, a statement of the additional terms that apply to those 347 | files, or a notice indicating where to find the applicable terms. 348 | 349 | Additional terms, permissive or non-permissive, may be stated in the form of a 350 | separately written license, or stated as exceptions; the above requirements apply 351 | either way. 352 | 353 | ### 8. Termination 354 | 355 | You may not propagate or modify a covered work except as expressly provided under 356 | this License. Any attempt otherwise to propagate or modify it is void, and will 357 | automatically terminate your rights under this License (including any patent licenses 358 | granted under the third paragraph of section 11). 359 | 360 | However, if you cease all violation of this License, then your license from a 361 | particular copyright holder is reinstated **(a)** provisionally, unless and until the 362 | copyright holder explicitly and finally terminates your license, and **(b)** permanently, 363 | if the copyright holder fails to notify you of the violation by some reasonable means 364 | prior to 60 days after the cessation. 365 | 366 | Moreover, your license from a particular copyright holder is reinstated permanently 367 | if the copyright holder notifies you of the violation by some reasonable means, this 368 | is the first time you have received notice of violation of this License (for any 369 | work) from that copyright holder, and you cure the violation prior to 30 days after 370 | your receipt of the notice. 371 | 372 | Termination of your rights under this section does not terminate the licenses of 373 | parties who have received copies or rights from you under this License. If your 374 | rights have been terminated and not permanently reinstated, you do not qualify to 375 | receive new licenses for the same material under section 10. 376 | 377 | ### 9. Acceptance Not Required for Having Copies 378 | 379 | You are not required to accept this License in order to receive or run a copy of the 380 | Program. Ancillary propagation of a covered work occurring solely as a consequence of 381 | using peer-to-peer transmission to receive a copy likewise does not require 382 | acceptance. However, nothing other than this License grants you permission to 383 | propagate or modify any covered work. These actions infringe copyright if you do not 384 | accept this License. Therefore, by modifying or propagating a covered work, you 385 | indicate your acceptance of this License to do so. 386 | 387 | ### 10. Automatic Licensing of Downstream Recipients 388 | 389 | Each time you convey a covered work, the recipient automatically receives a license 390 | from the original licensors, to run, modify and propagate that work, subject to this 391 | License. You are not responsible for enforcing compliance by third parties with this 392 | License. 393 | 394 | An “entity transaction” is a transaction transferring control of an 395 | organization, or substantially all assets of one, or subdividing an organization, or 396 | merging organizations. If propagation of a covered work results from an entity 397 | transaction, each party to that transaction who receives a copy of the work also 398 | receives whatever licenses to the work the party's predecessor in interest had or 399 | could give under the previous paragraph, plus a right to possession of the 400 | Corresponding Source of the work from the predecessor in interest, if the predecessor 401 | has it or can get it with reasonable efforts. 402 | 403 | You may not impose any further restrictions on the exercise of the rights granted or 404 | affirmed under this License. For example, you may not impose a license fee, royalty, 405 | or other charge for exercise of rights granted under this License, and you may not 406 | initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging 407 | that any patent claim is infringed by making, using, selling, offering for sale, or 408 | importing the Program or any portion of it. 409 | 410 | ### 11. Patents 411 | 412 | A “contributor” is a copyright holder who authorizes use under this 413 | License of the Program or a work on which the Program is based. The work thus 414 | licensed is called the contributor's “contributor version”. 415 | 416 | A contributor's “essential patent claims” are all patent claims owned or 417 | controlled by the contributor, whether already acquired or hereafter acquired, that 418 | would be infringed by some manner, permitted by this License, of making, using, or 419 | selling its contributor version, but do not include claims that would be infringed 420 | only as a consequence of further modification of the contributor version. For 421 | purposes of this definition, “control” includes the right to grant patent 422 | sublicenses in a manner consistent with the requirements of this License. 423 | 424 | Each contributor grants you a non-exclusive, worldwide, royalty-free patent license 425 | under the contributor's essential patent claims, to make, use, sell, offer for sale, 426 | import and otherwise run, modify and propagate the contents of its contributor 427 | version. 428 | 429 | In the following three paragraphs, a “patent license” is any express 430 | agreement or commitment, however denominated, not to enforce a patent (such as an 431 | express permission to practice a patent or covenant not to sue for patent 432 | infringement). To “grant” such a patent license to a party means to make 433 | such an agreement or commitment not to enforce a patent against the party. 434 | 435 | If you convey a covered work, knowingly relying on a patent license, and the 436 | Corresponding Source of the work is not available for anyone to copy, free of charge 437 | and under the terms of this License, through a publicly available network server or 438 | other readily accessible means, then you must either **(1)** cause the Corresponding 439 | Source to be so available, or **(2)** arrange to deprive yourself of the benefit of the 440 | patent license for this particular work, or **(3)** arrange, in a manner consistent with 441 | the requirements of this License, to extend the patent license to downstream 442 | recipients. “Knowingly relying” means you have actual knowledge that, but 443 | for the patent license, your conveying the covered work in a country, or your 444 | recipient's use of the covered work in a country, would infringe one or more 445 | identifiable patents in that country that you have reason to believe are valid. 446 | 447 | If, pursuant to or in connection with a single transaction or arrangement, you 448 | convey, or propagate by procuring conveyance of, a covered work, and grant a patent 449 | license to some of the parties receiving the covered work authorizing them to use, 450 | propagate, modify or convey a specific copy of the covered work, then the patent 451 | license you grant is automatically extended to all recipients of the covered work and 452 | works based on it. 453 | 454 | A patent license is “discriminatory” if it does not include within the 455 | scope of its coverage, prohibits the exercise of, or is conditioned on the 456 | non-exercise of one or more of the rights that are specifically granted under this 457 | License. You may not convey a covered work if you are a party to an arrangement with 458 | a third party that is in the business of distributing software, under which you make 459 | payment to the third party based on the extent of your activity of conveying the 460 | work, and under which the third party grants, to any of the parties who would receive 461 | the covered work from you, a discriminatory patent license **(a)** in connection with 462 | copies of the covered work conveyed by you (or copies made from those copies), or **(b)** 463 | primarily for and in connection with specific products or compilations that contain 464 | the covered work, unless you entered into that arrangement, or that patent license 465 | was granted, prior to 28 March 2007. 466 | 467 | Nothing in this License shall be construed as excluding or limiting any implied 468 | license or other defenses to infringement that may otherwise be available to you 469 | under applicable patent law. 470 | 471 | ### 12. No Surrender of Others' Freedom 472 | 473 | If conditions are imposed on you (whether by court order, agreement or otherwise) 474 | that contradict the conditions of this License, they do not excuse you from the 475 | conditions of this License. If you cannot convey a covered work so as to satisfy 476 | simultaneously your obligations under this License and any other pertinent 477 | obligations, then as a consequence you may not convey it at all. For example, if you 478 | agree to terms that obligate you to collect a royalty for further conveying from 479 | those to whom you convey the Program, the only way you could satisfy both those terms 480 | and this License would be to refrain entirely from conveying the Program. 481 | 482 | ### 13. Use with the GNU Affero General Public License 483 | 484 | Notwithstanding any other provision of this License, you have permission to link or 485 | combine any covered work with a work licensed under version 3 of the GNU Affero 486 | General Public License into a single combined work, and to convey the resulting work. 487 | The terms of this License will continue to apply to the part which is the covered 488 | work, but the special requirements of the GNU Affero General Public License, section 489 | 13, concerning interaction through a network will apply to the combination as such. 490 | 491 | ### 14. Revised Versions of this License 492 | 493 | The Free Software Foundation may publish revised and/or new versions of the GNU 494 | General Public License from time to time. Such new versions will be similar in spirit 495 | to the present version, but may differ in detail to address new problems or concerns. 496 | 497 | Each version is given a distinguishing version number. If the Program specifies that 498 | a certain numbered version of the GNU General Public License “or any later 499 | version” applies to it, you have the option of following the terms and 500 | conditions either of that numbered version or of any later version published by the 501 | Free Software Foundation. If the Program does not specify a version number of the GNU 502 | General Public License, you may choose any version ever published by the Free 503 | Software Foundation. 504 | 505 | If the Program specifies that a proxy can decide which future versions of the GNU 506 | General Public License can be used, that proxy's public statement of acceptance of a 507 | version permanently authorizes you to choose that version for the Program. 508 | 509 | Later license versions may give you additional or different permissions. However, no 510 | additional obligations are imposed on any author or copyright holder as a result of 511 | your choosing to follow a later version. 512 | 513 | ### 15. Disclaimer of Warranty 514 | 515 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. 516 | EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 517 | PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER 518 | EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 519 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE 520 | QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE 521 | DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 522 | 523 | ### 16. Limitation of Liability 524 | 525 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY 526 | COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS 527 | PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, 528 | INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE 529 | PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE 530 | OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE 531 | WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 532 | POSSIBILITY OF SUCH DAMAGES. 533 | 534 | ### 17. Interpretation of Sections 15 and 16 535 | 536 | If the disclaimer of warranty and limitation of liability provided above cannot be 537 | given local legal effect according to their terms, reviewing courts shall apply local 538 | law that most closely approximates an absolute waiver of all civil liability in 539 | connection with the Program, unless a warranty or assumption of liability accompanies 540 | a copy of the Program in return for a fee. 541 | 542 | _END OF TERMS AND CONDITIONS_ 543 | 544 | ## How to Apply These Terms to Your New Programs 545 | 546 | If you develop a new program, and you want it to be of the greatest possible use to 547 | the public, the best way to achieve this is to make it free software which everyone 548 | can redistribute and change under these terms. 549 | 550 | To do so, attach the following notices to the program. It is safest to attach them 551 | to the start of each source file to most effectively state the exclusion of warranty; 552 | and each file should have at least the “copyright” line and a pointer to 553 | where the full notice is found. 554 | 555 | 556 | Copyright (C) 557 | 558 | This program is free software: you can redistribute it and/or modify 559 | it under the terms of the GNU General Public License as published by 560 | the Free Software Foundation, either version 3 of the License, or 561 | (at your option) any later version. 562 | 563 | This program is distributed in the hope that it will be useful, 564 | but WITHOUT ANY WARRANTY; without even the implied warranty of 565 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 566 | GNU General Public License for more details. 567 | 568 | You should have received a copy of the GNU General Public License 569 | along with this program. If not, see . 570 | 571 | Also add information on how to contact you by electronic and paper mail. 572 | 573 | If the program does terminal interaction, make it output a short notice like this 574 | when it starts in an interactive mode: 575 | 576 | Copyright (C) 577 | This program comes with ABSOLUTELY NO WARRANTY; for details type 'show w'. 578 | This is free software, and you are welcome to redistribute it 579 | under certain conditions; type 'show c' for details. 580 | 581 | The hypothetical commands `show w` and `show c` should show the appropriate parts of 582 | the General Public License. Of course, your program's commands might be different; 583 | for a GUI interface, you would use an “about box”. 584 | 585 | You should also get your employer (if you work as a programmer) or school, if any, to 586 | sign a “copyright disclaimer” for the program, if necessary. For more 587 | information on this, and how to apply and follow the GNU GPL, see 588 | <>. 589 | 590 | The GNU General Public License does not permit incorporating your program into 591 | proprietary programs. If your program is a subroutine library, you may consider it 592 | more useful to permit linking proprietary applications with the library. If this is 593 | what you want to do, use the GNU Lesser General Public License instead of this 594 | License. But first, please read 595 | <>. 596 | --------------------------------------------------------------------------------