Fixes to address unintended props reshuffling behaviour

.gitignore

@@ -20,3 +20,4 @@ dist
 npm-debug*
 /.tox
 .idea
+package-lock.json

dash/development/_r_components_generation.py

@@ -14,20 +14,21 @@
 # Declaring longer string templates as globals to improve
 # readability, make method logic clearer to anyone inspecting
 # code below
-r_component_string = '''{prefix}{name} <- function(..., {default_argtext}) {{
+r_component_string = '''{prefix}{name} <- function({default_argtext}, ...) {{
 
+    wildcard_names = names(list(...))
+
     component <- list(
-        props = list({default_paramtext}),
+        props = list({default_paramtext}, ...),
         type = '{name}',
         namespace = '{project_shortname}',
-        propNames = c({prop_names}),
+        propNames = c({prop_names}, wildcard_names),
         package = '{package_name}'
         )
 
     component$props <- filter_null(component$props)
-    component <- append_wildcard_props(component, wildcards = {default_wildcards}, ...)
-
-    structure(component, class = c('dash_component', 'list'))
+
+    structure(component, class = c('dash_component', 'list'))    
 }}'''  # noqa:E501
 
 # the following strings represent all the elements in an object
@@ -38,14 +39,14 @@
 
 frame_element_template = '''`{dep_name}` = structure(list(name = "{dep_name}",
 version = "{project_ver}", src = list(href = NULL,
-file = "lib/"), meta = NULL,
+file = "deps/"), meta = NULL,
 script = "{dep_rpp}",
 stylesheet = NULL, head = NULL, attachment = NULL, package = "{rpkgname}",
 all_files = FALSE), class = "html_dependency")'''
 
 frame_body_template = '''`{project_shortname}` = structure(list(name = "{project_shortname}",
 version = "{project_ver}", src = list(href = NULL,
-file = "lib/"), meta = NULL,
+file = "deps/"), meta = NULL,
 script = "{dep_rpp}",
 stylesheet = NULL, head = NULL, attachment = NULL, package = "{rpkgname}",
 all_files = FALSE), class = "html_dependency")'''  # noqa:E501
@@ -56,14 +57,19 @@
 
 help_string = '''% Auto-generated: do not edit by hand
 \\name{{{prefix}{name}}}
+
 \\alias{{{prefix}{name}}}
+
 \\title{{{name} component}}
+
 \\description{{
 {description}
 }}
+
 \\usage{{
-{prefix}{name}(..., {default_argtext})
+{prefix}{name}({default_argtext}, ...)
 }}
+
 \\arguments{{
 {item_text}
 }}
@@ -74,6 +80,7 @@
 Version: {package_version}
 Authors @R: as.person(c({package_author}))
 Description: {package_description}
+Depends: R (>= 3.5.0)
 Suggests: testthat, roxygen2
 License: {package_license}
 URL: {package_url}
@@ -97,9 +104,9 @@
 # demo folder has special meaning in R
 # this should hopefully make it still
 # allow for the possibility to make R demos
-demo/*.js
-demo/*.html
-demo/*.css
+demo/.*\.js
+demo/.*\.html
+demo/.*\.css
 
 # ignore python files/folders
 setup.py
@@ -116,42 +123,14 @@
 '''
 
 
-# This is an initial attempt at resolving type inconsistencies
-# between R and JSON.
-def props_to_r_type(current_prop):
-    object_type = current_prop['type']['name']
-    if 'defaultValue' in current_prop and object_type == 'string':
-        if "\"" in current_prop['defaultValue']['value']:
-            argument = current_prop['defaultValue']['value']
-        else:
-            argument = "{}".format(current_prop['defaultValue']['value'])
-    elif object_type == 'custom' and 'raw' in current_prop['type']:
-        argument = current_prop['defaultValue'].get('value', 'numeric()')
-    elif object_type == 'enum':
-        argument = current_prop.get('defaultValue', {}).get('value', 'NULL')
-    elif 'defaultValue' in current_prop and object_type == 'object':
-        argument = 'list()'
-    elif 'defaultValue' in current_prop and \
-            current_prop['defaultValue']['value'] == '[]':
-        argument = 'list()'
-    elif object_type == 'number':
-        argument = current_prop['defaultValue'].get('value', 'NULL')
-    elif object_type == 'bool':
-        argument = current_prop['defaultValue'].get('value')
-        if argument:
-            argument = 'TRUE'
-        else:
-            argument = 'logical()'
-    else:
-        argument = 'NULL'
-    return argument
-
-
 # pylint: disable=R0914
 def generate_class_string(name, props, project_shortname, prefix):
     # Here we convert from snake case to camel case
     package_name = snake_case_to_camel_case(project_shortname)
 
+    # Ensure props are ordered with children first
+    props = reorder_props(props=props)
+
     prop_keys = props.keys()
 
     default_paramtext = ''
@@ -180,15 +159,13 @@ def generate_class_string(name, props, project_shortname, prefix):
         default_wildcards = 'c({})'.format(default_wildcards)
 
     # Filter props to remove those we don't want to expose
-    for p in prop_keys:
-        if p.endswith("-*") \
-                or p in r_keywords \
-                or p in ['setProps', 'dashEvents', 'fireEvent']:
-            prop_keys.remove(p)
+    for item in prop_keys[:]:
+        if item.endswith('-*') \
+                or item in r_keywords \
+                or item in ['setProps']:
+            prop_keys.remove(item)
 
     default_argtext += ", ".join(
-        '{}={}'.format(p, props_to_r_type(props[p]))
-        if 'defaultValue' in props[p] else
         '{}=NULL'.format(p)
         for p in prop_keys
     )
@@ -197,18 +174,18 @@ def generate_class_string(name, props, project_shortname, prefix):
     default_paramtext += ", ".join(
         '{}={}'.format(p, p)
         if p != "children" else
-        '{}=c(children, assert_valid_children(..., wildcards = {}))'
-        .format(p, default_wildcards)
+        '{}=children'
+        .format(p)
         for p in prop_keys
     )
+
     return r_component_string.format(prefix=prefix,
                                      name=name,
                                      default_argtext=default_argtext,
                                      default_paramtext=default_paramtext,
                                      project_shortname=project_shortname,
                                      prop_names=prop_names,
-                                     package_name=package_name,
-                                     default_wildcards=default_wildcards)
+                                     package_name=package_name)
 
 
 # pylint: disable=R0914
@@ -309,8 +286,6 @@ def write_help_file(name, props, description, prefix):
             prop_keys.remove(p)
 
     default_argtext += ", ".join(
-        '{}={}'.format(p, props_to_r_type(props[p]))
-        if 'defaultValue' in props[p] else
         '{}=NULL'.format(p)
         for p in prop_keys
     )
@@ -320,6 +295,8 @@ def write_help_file(name, props, description, prefix):
         for p in prop_keys
     )
 
+    item_text += '\n\n\\item{...}{wildcards of the form: `data-*` or `aria-*`}'
+
     file_path = os.path.join('man', file_name)
     with open(file_path, 'w') as f:
         f.write(help_string.format(
@@ -336,6 +313,8 @@ def write_class_file(name,
                      description,
                      project_shortname,
                      prefix=None):
+    props = reorder_props(props=props)
+
     import_string =\
         "# AUTO GENERATED FILE - DO NOT EDIT\n\n"
     class_string = generate_class_string(
@@ -397,14 +376,17 @@ def write_js_metadata(project_shortname):
     # now copy over all JS dependencies from the (Python) components dir
     # the inst/lib directory for the package won't exist on first call
     # create this directory if it is missing
-    if not os.path.exists('inst/lib'):
-        os.makedirs('inst/lib')
+    if not os.path.exists('inst/deps'):
+        os.makedirs('inst/deps')
 
     for javascript in glob.glob('{}/*.js'.format(project_shortname)):
-        shutil.copy(javascript, 'inst/lib/')
+        shutil.copy(javascript, 'inst/deps/')
 
     for css in glob.glob('{}/*.css'.format(project_shortname)):
-        shutil.copy(css, 'inst/lib/')
+        shutil.copy(css, 'inst/deps/')
+
+    for sourcemap in glob.glob('{}/*.map'.format(project_shortname)):
+        shutil.copy(sourcemap, 'inst/deps/')
 
 
 # pylint: disable=R0914

dash/development/component_generator.py

@@ -1,4 +1,5 @@
 from __future__ import print_function
+from collections import OrderedDict
 
 import json
 import sys
@@ -64,7 +65,7 @@ def generate_components(components_source, project_shortname,
             file=sys.stderr)
         sys.exit(1)
 
-    metadata = json.loads(out.decode())
+    metadata = json.loads(out.decode(), object_pairs_hook=OrderedDict)
     generator_methods = [generate_class_file]
 
     if rprefix:
@@ -82,13 +83,13 @@ def generate_components(components_source, project_shortname,
     )
 
     with open(os.path.join(project_shortname, 'metadata.json'), 'w') as f:
-        json.dump(metadata, f)
+        json.dump(metadata, f, sort_keys=True)
 
     generate_imports(project_shortname, components)
 
     if rprefix:
         with open('package.json', 'r') as f:
-            pkg_data = json.load(f)
+            pkg_data = json.load(f, object_pairs_hook=OrderedDict)
 
         generate_exports(
             project_shortname, components, metadata, pkg_data, prefix