Pre-release packaging improvements for Dash for R

dash/development/_r_components_generation.py

@@ -18,16 +18,18 @@
 # code below
 r_component_string = """{funcname} <- function({default_argtext}{wildcards}) {{
     {wildcard_declaration}
+    props <- list({default_paramtext}{wildcards})
+    if (length(props) > 0) {{
+        props <- props[!vapply(props, is.null, logical(1))]
+    }}
     component <- list(
-        props = list({default_paramtext}{wildcards}),
+        props = props,
         type = '{name}',
         namespace = '{project_shortname}',
         propNames = c({prop_names}{wildcard_names}),
         package = '{package_name}'
         )
 
-    component$props <- filter_null(component$props)
-
     structure(component, class = c('dash_component', 'list'))
 }}
 """  # noqa:E501
@@ -83,15 +85,15 @@
 Authors @R: as.person(c({package_author}))
 Description: {package_description}
 Depends: R (>= 3.0.2){package_depends}
-Imports: dash{package_imports}
+Imports: {package_imports}
 Suggests: {package_suggests}
 License: {package_license}
 URL: {package_url}
 BugReports: {package_issues}
 Encoding: UTF-8
 LazyData: true
 Author: {package_author_no_email}
-Maintainer: {package_author}
+Maintainer: {maintainer}
 """
 
 rbuild_ignore_string = r"""# ignore JS config files/folders
@@ -103,6 +105,11 @@
 .builderrc
 .eslintrc
 .npmignore
+.editorconfig
+.eslintignore
+.prettierrc
+.circleci
+.github
 
 # demo folder has special meaning in R
 # this should hopefully make it still
@@ -129,22 +136,34 @@
 \\docType{{package}}
 \\name{{{package_name}-package}}
 \\alias{{{package_name}}}
-\\title{{{pkg_help_header}}}
+\\title{{{pkg_help_title}}}
 \\description{{
-{pkg_help_desc}
-}}
-\\seealso{{
-Useful links:
-\\itemize{{
-  \\item \\url{{https://github.com/plotly/{lib_name}}}
-  \\item Report bugs at \\url{{https://github.com/plotly/{lib_name}/issues}}
-}}
+{pkg_help_description}
 }}
 \\author{{
-\\strong{{Maintainer}}: {package_author}
+\\strong{{Maintainer}}: {maintainer}
 }}
 """
 
+component_helpers = """
+dash_assert_valid_wildcards <- function (attrib = list("data", "aria"), ...)
+{
+    args <- list(...)
+    validation_results <- lapply(names(args), function(x) {
+        grepl(paste0("^", attrib, "-[a-zA-Z0-9]{1,}$", collapse = "|"),
+            x)
+    })
+    if (FALSE %in% validation_results) {
+        stop(sprintf("The following wildcards are not currently valid in Dash: '%s'",
+            paste(names(args)[grepl(FALSE, unlist(validation_results))],
+                collapse = ", ")), call. = FALSE)
+    }
+    else {
+        return(args)
+    }
+}
+"""    # noqa:E501
+
 
 # pylint: disable=R0914
 def generate_class_string(name, props, project_shortname, prefix):
@@ -159,35 +178,25 @@ def generate_class_string(name, props, project_shortname, prefix):
     wildcards = ""
     wildcard_declaration = ""
     wildcard_names = ""
+    default_paramtext = ""
+    default_argtext = ""
+    accepted_wildcards = ""
 
     if any("-*" in key for key in prop_keys):
+        accepted_wildcards = get_wildcards_r(prop_keys)
         wildcards = ", ..."
-        wildcard_declaration = (
-            "\n    wildcard_names = names(assert_valid_wildcards(...))\n"
-        )
+        wildcard_declaration = """
+    wildcard_names = names(dash_assert_valid_wildcards(attrib = list({}), ...))
+""".format(accepted_wildcards.replace("-*", ""))       # noqa:E501
         wildcard_names = ", wildcard_names"
 
-    default_paramtext = ""
-    default_argtext = ""
-    default_wildcards = ""
-
     # Produce a string with all property names other than WCs
     prop_names = ", ".join(
         "'{}'".format(p)
         for p in prop_keys
         if "*" not in p and p not in ["setProps"]
     )
 
-    # in R, we set parameters with no defaults to NULL
-    # Here we'll do that if no default value exists
-    default_wildcards += ", ".join("'{}'".format(p)
-                                   for p in prop_keys if "*" in p)
-
-    if default_wildcards == "":
-        default_wildcards = "NULL"
-    else:
-        default_wildcards = "c({})".format(default_wildcards)
-
     # Filter props to remove those we don't want to expose
     for item in prop_keys[:]:
         if item.endswith("-*") or item in r_keywords or item == "setProps":
@@ -278,10 +287,10 @@ def generate_js_metadata(pkg_data, project_shortname):
     elif len(alldist) == 1:
         rpp = alldist[0]["relative_package_path"]
         if "css" in rpp:
-            css_name = rpp
+            css_name = "'{}'".format(rpp)
             script_name = "NULL"
         else:
-            script_name = rpp
+            script_name = "'{}'".format(rpp)
             css_name = "NULL"
         function_frame_body = frame_body_template.format(
             project_shortname=project_shortname,
@@ -321,7 +330,10 @@ def write_help_file(name, props, description, prefix):
 
     prop_keys = list(props.keys())
 
-    has_wildcards = any("-*" in key for key in prop_keys)
+    has_wildcards = any(key.endswith("-*") for key in prop_keys)
+
+    if has_wildcards:
+        wildcards = get_wildcards_r(prop_keys)
 
     # Filter props to remove those we don't want to expose
     for item in prop_keys[:]:
@@ -340,20 +352,21 @@ def write_help_file(name, props, description, prefix):
     )
 
     if has_wildcards:
-        item_text += '\n\n\\item{...}{wildcards: `data-*` or `aria-*`}'
         default_argtext += ', ...'
+        item_text += """
+\n\n\\item{{...}}{{wildcards allowed have the form: `{}`}}
+""".format(wildcards)
 
     # in R, the online help viewer does not properly wrap lines for
     # the usage string -- we will hard wrap at 80 characters using
     # textwrap.fill, starting from the beginning of the usage string
-    argtext = prefix + name + "({})".format(default_argtext)
 
     file_path = os.path.join('man', file_name)
     with open(file_path, 'w') as f:
         f.write(help_string.format(
             funcname=format_fn_name(prefix, name),
             name=name,
-            default_argtext=textwrap.fill(argtext,
+            default_argtext=textwrap.fill(default_argtext,
                                           width=80,
                                           break_long_words=False),
             item_text=item_text,
@@ -425,6 +438,7 @@ def write_js_metadata(pkg_data, project_shortname):
     file_path = os.path.join("R", file_name)
     with open(file_path, "w") as f:
         f.write(function_string)
+        f.write(component_helpers)
 
     # now copy over all JS dependencies from the (Python) components dir
     # the inst/lib directory for the package won't exist on first call
@@ -445,6 +459,7 @@ def write_js_metadata(pkg_data, project_shortname):
 # pylint: disable=R0914, R0913, R0912, R0915
 def generate_rpkg(
         pkg_data,
+        rpkg_data,
         project_shortname,
         export_string,
         package_depends,
@@ -457,8 +472,12 @@ def generate_rpkg(
     Parameters
     ----------
     pkg_data
+    rpkg_data
     project_shortname
     export_string
+    package_depends
+    package_imports
+    package_suggests
 
     Returns
     -------
@@ -478,7 +497,7 @@ def generate_rpkg(
         package_depends = ", " + package_depends.strip(",").lstrip()
 
     if package_imports:
-        package_imports = ", " + package_imports.strip(",").lstrip()
+        package_imports = package_imports.strip(",").lstrip()
 
     if package_suggests:
         package_suggests = package_suggests.strip(",").lstrip()
@@ -506,6 +525,8 @@ def generate_rpkg(
 
     package_author_no_email = package_author.split(" <")[0] + " [aut]"
 
+    maintainer = pkg_data.get("maintainer", pkg_data.get("author"))
+
     if not (os.path.isfile("LICENSE") or os.path.isfile("LICENSE.txt")):
         package_license = pkg_data.get("license", "")
     else:
@@ -531,36 +552,14 @@ def generate_rpkg(
     # this avoids having to generate an RData file from within Python.
     write_js_metadata(pkg_data=pkg_data, project_shortname=project_shortname)
 
-    with open("NAMESPACE", "w") as f:
+    with open("NAMESPACE", "w+") as f:
         f.write(import_string)
         f.write(export_string)
         f.write(packages_string)
 
-    with open(".Rbuildignore", "w") as f2:
+    with open(".Rbuildignore", "w+") as f2:
         f2.write(rbuild_ignore_string)
 
-    # Write package stub files for R online help, generate if
-    # dashHtmlComponents or dashCoreComponents; makes it easy
-    # for R users to bring up main package help page
-    pkg_help_header = ""
-
-    if package_name in ["dashHtmlComponents"]:
-        pkg_help_header = "Vanilla HTML Components for Dash"
-        pkg_help_desc = "Dash is a web application framework that\n\
-provides pure Python and R abstraction around HTML, CSS, and\n\
-JavaScript. Instead of writing HTML or using an HTML\n\
-templating engine, you compose your layout using R\n\
-functions within the dashHtmlComponents package. The\n\
-source for this package is on GitHub:\n\
-plotly/dash-html-components."
-    if package_name in ["dashCoreComponents"]:
-        pkg_help_header = "Core Interactive UI Components for Dash"
-        pkg_help_desc = "Dash ships with supercharged components for\n\
-interactive user interfaces. A core set of components,\n\
-written and maintained by the Dash team, is available in\n\
-the dashCoreComponents package. The source for this package\n\
-is on GitHub: plotly/dash-core-components."
-
     description_string = description_template.format(
         package_name=package_name,
         package_description=package_description,
@@ -573,18 +572,19 @@ def generate_rpkg(
         package_url=package_url,
         package_issues=package_issues,
         package_author_no_email=package_author_no_email,
+        maintainer=maintainer,
     )
 
-    with open("DESCRIPTION", "w") as f3:
+    with open("DESCRIPTION", "w+") as f3:
         f3.write(description_string)
 
-    if pkg_help_header != "":
+    if rpkg_data.get("pkg_help_description"):
         pkghelp = pkghelp_stub.format(
             package_name=package_name,
-            pkg_help_header=pkg_help_header,
-            pkg_help_desc=pkg_help_desc,
+            pkg_help_title=rpkg_data.get("pkg_help_title"),
+            pkg_help_description=rpkg_data.get("pkg_help_description"),
             lib_name=lib_name,
-            package_author=package_author,
+            maintainer=maintainer,
         )
         with open(pkghelp_stub_path, "w") as f4:
             f4.write(pkghelp)
@@ -614,6 +614,7 @@ def generate_exports(
         components,
         metadata,
         pkg_data,
+        rpkg_data,
         prefix,
         package_depends,
         package_imports,
@@ -664,6 +665,7 @@ def generate_exports(
     # locally or directly from GitHub
     generate_rpkg(
         pkg_data,
+        rpkg_data,
         project_shortname,
         export_string,
         package_depends,
@@ -821,3 +823,13 @@ def create_prop_docstring_r(prop_name, type_object, required, description,
                    ': {}'.format(description) if description != '' else ''
                ),
                is_required='required' if required else 'optional')
+
+
+def get_wildcards_r(prop_keys):
+    wildcards = ""
+    wildcards += ", ".join("'{}'".format(p)
+                           for p in prop_keys if p.endswith("-*"))
+
+    if wildcards == "":
+        wildcards = "NULL"
+    return wildcards

dash/development/component_generator.py

@@ -2,6 +2,7 @@
 from collections import OrderedDict
 
 import json
+import yaml
 import sys
 import subprocess
 import shlex
@@ -103,6 +104,14 @@ def generate_components(
             os.makedirs('man')
         if not os.path.exists('R'):
             os.makedirs('R')
+        if os.path.isfile("dash-info.yaml"):
+            yamldata = open("dash-info.yaml", 'r')
+        else:
+            print(
+                "Error: dash-info.yaml missing; R package metadata not loaded",
+                file=sys.stderr
+            )
+            sys.exit(1)
         generator_methods.append(
             functools.partial(write_class_file, prefix=prefix))
 
@@ -120,21 +129,24 @@ def generate_components(
     if rprefix is not None:
         with open('package.json', 'r') as f:
             jsondata_unicode = json.load(f, object_pairs_hook=OrderedDict)
+            rpkg_data = yaml.safe_load(yamldata)
             if sys.version_info[0] >= 3:
                 pkg_data = jsondata_unicode
             else:
                 pkg_data = byteify(jsondata_unicode)
-
         generate_exports(
             project_shortname,
             components,
             metadata,
             pkg_data,
+            rpkg_data,
             prefix,
             rdepends,
             rimports,
             rsuggests,
-        )
+        ) 
+    else:
+        rpkgdata = None
 
 
 def cli():