tests/generate_test_standards.R

In rkward-community/rkwarddev: A Collection of Tools for RKWard Plugin Development

## this function can be used to generate a list of XiMpLe nodes as testing standards
require(rkwarddev)

# returns the list if file=NULL
XMLTestNodes <- function(file=NULL, compress="xz", compression_level=-9){
    about <- rk.XML.about(
        name="Square the circle",
        author=c(
            person(given="E.A.", family="Dölle",
                email="doelle@eternalwondermaths.example.org", role="aut"),
            person(given="A.", family="Assistant",
                email="alterego@eternalwondermaths.example.org", role=c("cre","ctb"))
            ),
        about=list(
            desc="Squares the circle using Heisenberg compensation.",
            version="0.1-3",
            date=as.Date("2014-12-12"),
            url="http://eternalwondermaths.example.org/23/stc.html",
            license="GPL",
            category="Geometry")
    )
    attribute <- rk.XML.attribute(
        id="testID",
        label="an attribute label",
        value="checked"
    )
    browser <- rk.XML.browser(
        label="a browser label",
        type="dir",
        initial="/tmp/initial",
        filter=c("*initial", "*csv"),
        required=TRUE,
        i18n=list(context="context info here")
    )
    checkbox <- rk.XML.cbox(
        label="a checbox label",
        value="checked",
        chk=TRUE,
        un.value="unchecked",
        i18n=list(context="context info here")
    )
    code <- rk.XML.code(
        file="some_file.js"
    )
    col <- rk.XML.col(
        rk.XML.cbox(label="a column label")
    )
    component <- rk.XML.component(
        label="a component label",
        file="plugins/MyGUIdialog.xml",
        i18n=list(context="context info here")
    )
    components <- rk.XML.components(
        rk.XML.component(
            label="a components label",
            file="plugins/MyOtherGUIdialog.xml"
        )
    )
    connect <- rk.XML.connect(
        governor="myGovernor",
        client="myCLient",
        get="visible",
        set="string",
        not=TRUE,
        reconcile=TRUE
    )
    context <- rk.XML.context(
        rk.XML.menu("Analysis", 
            rk.XML.entry(
                rk.XML.component(
                    label="a context label",
                    file="plugins/MyOtherGUIdialog.xml"
                )
            )
        )
    )
    convert <- rk.XML.convert(
        sources=list(text=rk.XML.input("a convert label")),
        mode=c(equals="myValue"),
        required=TRUE
    )
    copy <- rk.XML.copy(
        id="aCopyID",
        as="page"
    )
    dependencies <- rk.XML.dependencies(
        dependencies=list(
            rkward.min="0.6.3",
            rkward.max="0.6.5",
            R.min="3.1",
            R.max="3.2"),
        package=list(
            c(name="heisenberg", min="0.11-2", max="0.14-1",
                repository="http://hsb.example.org"),
            c(name="DreamsOfPi", min="0.2", max="3.1", repository="http://dop.example.org")),
        pluginmap=list(
            c(name="heisenberg.pluginmap", url="http://eternalwondermaths.example.org/hsb"))
    )
    dependency_check <- rk.XML.dependency_check(
        id.name="dependency",
        dependencies=list(
            rkward.min="0.6.3",
            rkward.max="0.6.5",
            R.min="3.1",
            R.max="3.2"),
        package=list(
            c(name="heisenberg", min="0.11-2", max="0.14-1",
                repository="http://hsb.example.org"),
            c(name="DreamsOfPi", min="0.2", max="3.1", repository="http://dop.example.org")),
        pluginmap=list(
            c(name="heisenberg.pluginmap", url="http://eternalwondermaths.example.org/hsb"))
    )
    dialog <- rk.XML.dialog(
        rk.XML.col(
            rk.XML.cbox(label="a dialog column label")
        ),
        label="a dialog label",
        recommended=TRUE,
        i18n=list(context="context info here")
    )
    dropdown <- rk.XML.dropdown(
        label="a dropdown label",
        options=list(
            "First Option"=c(val="val1"),
            rk.XML.option(
                "Second Option", val="val2", id.name="auto",
                i18n=list(context="context info1 here")
            ),
            "Third Option"=c(val="val3", chk=TRUE)
        ),
        i18n=list(context="context info2 here")
    )
    embed <- rk.XML.embed(
        component="componentID",
        button=TRUE,
        label="an embed label",
        i18n=list(context="context info here")
    )
    entry <- rk.XML.entry(
        component=rk.XML.component(
            label="an entry component label",
            file="plugins/MyOtherGUIdialog.xml"
        ),
        index=3
    )
    external <- rk.XML.external(
        id="externalID",
        default="none"
    )
    formula <- rk.XML.formula(
        fixed=rk.XML.varslot("Fixed factors", source=test.varselector <- rk.XML.varselector("Select some vars")),
        dependent=rk.XML.varslot("Dependent variables", source=test.varselector)
    )
    frame <- rk.XML.frame(
        rk.XML.row(
            rk.XML.cbox(label="a frame row label")
        ),
        label="a frame label",
        checkable=TRUE,
        chk=FALSE,
        i18n=list(context="context info here")
    )
    help <- rk.XML.help(
        "help_file.rkh"
    )
    hierarchy <- rk.XML.hierarchy(
        rk.XML.menu("Analysis", 
            rk.XML.entry(
                rk.XML.component(
                    label="a hierarchy label",
                    file="plugins/MyOtherGUIdialog.xml"
                )
            )
        )
    )
    i18n <- rk.XML.i18n(
      label="an i18n label"
    )
    include <- rk.XML.include(
        "../include_file.xml"
    )
    input <- rk.XML.input(
        label="an input label",
        initial="init",
        size="small",
        required=TRUE,
        i18n=list(context="context info here")
    )
    # insert: see below
    logic=rk.XML.logic(
        rk.XML.connect(
            governor="myGovernor",
            client="myCLient"
        )
    )
    matrix <- rk.XML.matrix(
        label="a matrix label",
        mode="integer",
        rows=3,
        columns=3,
        min=0,
        max=100,
        allow_missings=TRUE,
        allow_user_resize_columns=FALSE,
        allow_user_resize_rows=FALSE,
        fixed_width=TRUE,
        fixed_height=TRUE,
        horiz_headers=c("hone", "htwo", "hthree"),
        vert_headers=c("vone", "vtwo", "vthree"),
        i18n=list(context="context info here")
    )
    menu <- rk.XML.menu(
        "Analysis",
        rk.XML.entry(
            rk.XML.component(
                label="a hierarchy label",
                file="plugins/MyOtherGUIdialog.xml"
            )
        ),
        index=3,
        i18n=list(context="context info here")
    )
    optioncolumn <- rk.XML.optioncolumn(
        connect=rk.XML.input(label="an optioncolumn label"),
        modifier="text",
        label=TRUE,
        external=TRUE,
        default="rarely useful",
        i18n=list(context="context info here")
    )
    optiondisplay <- rk.XML.optiondisplay(
        index=FALSE
    )
    option <- rk.XML.option(  
        label="an option label",
        val="value",
        chk=TRUE,
        i18n=list(context="context info here")
    )
    optionset <- rk.XML.optionset(
        content=list(
            rk.XML.row(
                rk.XML.cbox(label="a content row label")
            )
        ),
        optioncolumn=list(
                rk.XML.optioncolumn("an optioncolumn")
            ),
            min_rows=1,
            min_rows_if_any=1,
            max_rows=5,
            keycolumn="myKey",
            logic=rk.XML.logic(
                rk.XML.connect(
                    governor="myGovernor",
                    client="myCLient"
                )
            ),
            optiondisplay=TRUE
        )
    page <- rk.XML.page(
        rk.XML.text("a page text")
    )
    # pluginmap: see below
    # plugin: see below
    preview <- rk.XML.preview(
        label="a perview label",
        i18n=list(context="context info here")
    )
    radio <- rk.XML.radio(
        label="a radio label",
        options=list(
            value1=c(val="value1", chk=FALSE, i18n=list(context="value1 context info here")),
            value2=option
        ),
        i18n=list(context="context info here")
    )
    require <- rk.XML.require(
        file="your.pluginmap"
#        map="rkward::yourID"
    )
    row <- rk.XML.row(
        preview
    )
    saveobj <- rk.XML.saveobj(
        label="a saveobj label",
        chk=TRUE,
        checkable=TRUE,
        initial="my.RData",
        required=TRUE,
        i18n=list(context="context info here")
    )
    select <- rk.XML.select(
        label="a select label",
        options=list(
            value1=option,
            value2=c(val="value2", chk=FALSE, i18n=list(context="value1 context info here"))
        ),
        single=TRUE,
        i18n=list(context="context info here")
    )
    set <- rk.XML.set(
        id=input,
        set="required",
        to=TRUE
    )
    snippet <- rk.XML.snippet(
        rk.XML.vars(
            "Variables",
            "Fixed",
            formula.dependent="Dependent"
        )
    )
    snippets <- rk.XML.snippets(
        snippet,
        include
    )
    spinbox <- rk.XML.spinbox(
        label="a spinbox label",
        min=0,
        max=23,
        initial=17,
        real=TRUE,
        precision=1,
        max.precision=5,
        i18n=list(context="context info here")
    )
    stretch <- rk.XML.stretch(
        before=rk.XML.text("a stretch text"),
        after=rk.XML.text("more text")
    )
    XMLswitch <- rk.XML.switch(
        rk.XML.cbox("foo"),
        cases=list(
            true=list(fixed_value="foo"),
            false=list(fixed_value="bar")
        )
    )
    tabbook <- rk.XML.tabbook("My Tabbook",
        tabs=list(
            "First Tab"=rk.XML.col(
                rk.XML.cbox(label="foo", val="foo1", chk=TRUE)
            ),
            "Second Tab"=rk.XML.col(
                rk.XML.cbox(label="bar", val="bar2")
            )
        ),
        i18n=list(context="context info here")
    )
    text <- rk.XML.text(
        "wow, cool text!",
        type="warning",
        i18n=list(context="context info here")
    )
    valueselector <- rk.XML.valueselector(
        label="a valueselector label",
        options=list(
            value1=option,
            value2=c(val="value2", chk=FALSE, i18n=list(context="value1 context info here"))
        ),
        i18n=list(context="context info here")
    )
    valueslot <- rk.XML.valueslot(
        label="a valueslot label",
        source=valueselector,
        required=TRUE,
        duplicates=TRUE,
        min=2,
        any=3,
        max=10,
        i18n=list(context="context info here")
    )
    values <- rk.XML.values(
        label="a values label",
        slot.text="some slot text",
        options=list(
            value1=option,
            value2=c(val="value2", chk=FALSE, i18n=list(context="value1 context info here"))
        ),
        required=TRUE,
        duplicates=TRUE,
        min=2,
        any=3,
        max=10,
        horiz=FALSE,
        add.nodes=rk.XML.text("more text"),
        frame.label="this is a frame"
    )
    varselector <- rk.XML.varselector(
        label="a varselector label",
        i18n=list(context="context info here")
    )
    varslot <- rk.XML.varslot(
        label="a varslot label",
        source=varselector,
        required=TRUE,
        duplicates=TRUE,
        min=3,
        any=5,
        max=20,
        dim=1,
        min.len=2,
        max.len=6,
        classes=c("matrix"),
        types=c("numeric"),
        i18n=list(context="context info here")
    )
    vars <- rk.XML.vars(
        label="a vars label",
        slot.text="some more text",
        required=TRUE,
        duplicates=TRUE,
        min=3,
        any=5,
        max=20,
        dim=1,
        min.len=2,
        max.len=6,
        classes=c("matrix"),
        types=c("numeric"),
        horiz=TRUE,
        add.nodes=list(rk.XML.text("more text")),
        frame.label="this is a frame",
        formula.dependent="formulate some",
        dep.options=list(min=3)
    )
    wizard <- rk.XML.wizard(
        rk.XML.text("a wizard text"),
        label="a wizard label",
        recommended=TRUE,
        i18n=list(context="context info here")
    )

    ## this is "below" ;-)
    # re-using some previously defined objects
    insert <- rk.XML.insert(
        snippet=snippet
    )
    pluginmap <- rk.XML.pluginmap(
        name="pluginName",
        about=about,
        components=components,
        hierarchy=hierarchy,
        require=require,
        x11.context=context,
        import.context=NULL,
        clean.name=TRUE,
        hints=FALSE,
        gen.info=TRUE,
        dependencies=dependencies,
        priority="medium"
    )
    plugin <- rk.XML.plugin(
        name="testPlugin",
        dialog=dialog,
        wizard=wizard,
        logic=logic,
        snippets=snippets,
        help=TRUE,
        include="../include_another_file.xml",
        label="a plugin label",
        clean.name=TRUE,
        about=about,
        dependencies=dependencies,
        gen.info=TRUE,
        i18n=list(context="context info here")
    )

## missing tests:
#     echo <- echo(
#    )
#     i18n <- i18n(
#    )
#     id <- id(
#    )
#     ite <- ite(
#    )
#     join <- join(
#    )
#     qp <- qp(
#    )
#     tf <- tf(
#    )
#    R.comment <- R.comment(
#    )
#     rk.build.plugin <- rk.build.plugin(
#    )
#     rk.comment <- rk.comment(
#    )
#     rk.get.comp <- rk.get.comp(
#    )
#     rk.get.rkh.prompter <- rk.get.rkh.prompter(
#    )
#     rk.i18n.comment <- rk.i18n.comment(
#    )
#     rk.JS.array <- rk.JS.array(
#    )
#     rk.JS.doc <- rk.JS.doc(
#    )
#     rk.JS.header <- rk.JS.header(
#    )
#     rk.JS.optionset <- rk.JS.optionset(
#    )
#     rk.JS.options <- rk.JS.options(
#    )
#     rk.JS.saveobj <- rk.JS.saveobj(
#    )
#     rk.JS.scan <- rk.JS.scan(
#    )
#     rk.JS.vars <- rk.JS.vars(
#    )
#     rk.paste.JS.graph <- rk.paste.JS.graph(
#    )
#     rk.paste.JS <- rk.paste.JS(
#    )
#     rk.plotOptions <- rk.plotOptions(
#    )
#     rk.plugin.component <- rk.plugin.component(
#    )
#     rk.plugin.skeleton <- rk.plugin.skeleton(
#    )
#     rk.rkh.caption <- rk.rkh.caption(
#    )
#     rk.rkh.doc <- rk.rkh.doc(
#    )
#     rk.rkh.label(
#    )
#     rk.rkh.link <- rk.rkh.link(
#    )
#     rk.rkh.related <- rk.rkh.related(
#    )
#     rk.rkh.scan <- rk.rkh.scan(
#    )
#     rk.rkh.section <- rk.rkh.section(
#    )
#     rk.rkh.setting <- rk.rkh.setting(
#    )
#     rk.rkh.settings <- rk.rkh.settings(
#    )
#     rk.rkh.summary <- rk.rkh.summary(
#    )
#     rk.rkh.technical <- rk.rkh.technical(
#    )
#     rk.rkh.title <- rk.rkh.title(
#    )
#     rk.rkh.usage <- rk.rkh.usage(
#    )
#     rk.set.comp <- rk.set.comp(
#    )
#     rk.set.rkh.prompter <- rk.set.rkh.prompter(
#    )
#     rk.testsuite.doc <- rk.testsuite.doc(
#    )
#     rk.uniqueIDs <- rk.uniqueIDs(
#    )
#     rkwarddev.required <- rkwarddev.required(
#    )
    
    XML_test_standards <- list(
        about=about,
        attribute=attribute,
        browser=browser,
        checkbox=checkbox,
        code=code,
        col=col,
        component=component,
        components=components,
        connect=connect,
        context=context,
        convert=convert,
        copy=copy,
        dependencies=dependencies,
        dependency_check=dependency_check,
        dialog=dialog,
        dropdown=dropdown,
        embed=embed,
        entry=entry,
        external=external,
        formula=formula,
        frame=frame,
        help=help,
        hierarchy=hierarchy,
        i18n=i18n,
        include=include,
        input=input,
        insert=insert,
        logic=logic,
        matrix=matrix,
        menu=menu,
        optioncolumn=optioncolumn,
        optiondisplay=optiondisplay,
        option=option,
        optionset=optionset,
        page=page,
        pluginmap=pluginmap,
        plugin=plugin,
        preview=preview,
        radio=radio,
        require=require,
        row=row,
        saveobj=saveobj,
        select=select,
        set=set,
        snippet=snippet,
        snippets=snippets,
        spinbox=spinbox,
        stretch=stretch,
        switch=XMLswitch,
        tabbook=tabbook,
        text=text,
        valueselector=valueselector,
        valueslot=valueslot,
        values=values,
        varselector=varselector,
        varslot=varslot,
        vars=vars,
        wizard=wizard
  )

  if(is.null(file)){
    return(XML_test_standards)
  } else {
    save(XML_test_standards,
      file=file,
      compress=compress,
      compression_level=compression_level)
    message(paste0("written to file ", file))
    return(invisible(NULL))
  }
}